testing_report.md

Tests

I have tested on windows and all tests passed. However if you are running on unix, you need to change 'python' to suitable python version e.g. 'python3' in 'test\test_utils.py'.

def start(self, sleep=0):
    self.startup_sequence = ["python",
                             self.program_file_path,
                             self.config_path,
                             str(self.i)]
    self.process = Popen(self.startup_sequence)
    self.pid = self.process.pid
    time.sleep(sleep)

To run the tests, run the below command from the base project directory i.e. /project-mars-1

pytest

To tun a particular test file

pytest rest_client_test.py

To run a particular test

pytest message_queue_test.py::test_create_topic

I have written the below tests for unit testing the code:

1. rest_client.py
   Tests rest client methods i.e. get, post and put methods.

2. leader_election_test.py
   Tests 'election/vote' endpoint and 'initiate_leader_election()' method which triggers the election

3. log_replication_test.py
   Tests '/logs/append' method and 'append_entries()' method called by leader node to send log entries to follower nodes.

4. message_queue_server_test.py
   Tests the below rest endpoints. It starts a single node to test the functionalities.

   GET '/topic'
   PUT '/topic'
   GET '/message/'
   PUT '/message'
   GET '/status'
   

5. The below 3 swarm tests are taken from https://github.com/mpcs-52040/2021-project-tests
   election_test.py
   replication_test.py
   message_queue_test.py