These are some of the unit test that will be used for grading your Final.
you will need pytest for running these test.
> pip3 install pytestto run them you can copy the test folder in your repository and run from your root repository folder:
> pytestpytest will run all file names starting or ending with test, as in test_example.py or example_test.py.
you can also run a specific file
> pytest message_queue_test.pyyou can also run a specific test
> pytest message_queue_test.py::test_create_topicto create new test make sure that your function name starts with test
test_utils.py has some classes that will manage a node and a group of nodes called swarm. nodes and swarms can be started and stopped. nodes can receive requests with function like get_message, put_message.
message_queue_test.py will test your step 1 of the message queue implementation. all those tests are starting your node in an external process and its relative configuration. test will try to getting/putting messages and topics verifying the expected output.
election_test.py will test your step 2. these test start 1 or 5 nodes and test if the leader is elected, unique and reelected after stopping and restarting nodes.
there is a variable called ELECTION_TIMEOUT that sleeps the test to allow for election to happen. It is currently set to 2 seconds. we will test with that value. you might want to lower it for faster testing. if your implementation need a longer time to pass the tests specify it in the testing_report.md.
replication_test.py will test the ability of your implementation to replicate information between nodes. it will start a swarm, find a leader, send some updates to it then kill it, the new leader should be in the appropriate state.
For any questions ask in slack
During the project, we may update the tests (e.g., to fix bugs). We will notify you of update on Slack.
@pytest.fixture are the functions called by tests before running. in this case we use them to start the nodes, then terminate them when the test is done.
the test has a variable called PROGRAM_FILE_PATH that specifies where the node.py file is. you can change it for your tests but that is the place where the submission file should be. now is "src/node.py" because tests are meant to be run in the repository root folder.
config.json will be created in the root folder
You don't need to start any process or setup a config file. Each test will take care of generating a config.json and pass the right parameters to the node process as arguments (config and id). The test framework then will wait for the processes to startup and do elections if needed and will run one test. The test will be sending http requests to the local port given to the node. Based on the answers test will be passed or failed.