Reliable BitTorrent Validation

This is the validation component for the Reliable BitTorrent group project (UBC CPSC 416 2022W2). The peer(baseline provider) repository can be found here, and the tracker repository can be found here.

Prerequisite

1. The setup is only guaranteed to work on macOS with M1 or newer chips (the ones used by all our development members). It should work on other architectures/OSs with potential minor changes, but due to development limitation, no guarantee can be given.

2. Please make sure your Golang is installed with version >= 1.20. You can verify it through entering the following to your command line:

   go version

3. Please make sure you have at least 10GB of free space on your device, as some tests involve transfer of large files (don't worry, they are just temporary files that are generated and cleared before and after each test).

4. This repository should be cloned as a sibling to the client and tracker repository in your local file system, like the following:

   parent_directory
   ├- cpsc416_GroupProject_ReliableBT
   ├- reliableBT-tracker
   └- reliableBT-validation
   
   

5. Please make sure all repositories in the point above are up-to-date - you can fetch from upstream if necessary.

Setup

1. To setup, simply run the test file ./tests/setup_test.go:

   go test test/setup_test.go -v
   

   It runs some tests to check your local repositories have been set up correctly according to the prerequisites above.
2. Please run go build inside both the peer (baseline provider) repository and the tracker repository and make sure it works. You might need to go mod tidy if there are dependency issues.

Test Execution

As tracker operations are not automated by the tests, script has been provided inside this repository to restart the tracker.

We recommend to use the VSCode extension, as some tests require restarting the tracker (so it can wipe stored information caused by previous tests). Having the Golang extension installed and clicking each test icon is the easier way to handle it. Please see FAQ if you run into timeout issues about some tests.

To restart the tracker between each test, simply run:

bash restartTracker.sh

And you should see some message such as "started trakx!" indicating the tracker is ready to go again.

FAQ

1. Q: I am using VSCode. I ran a test through the UI (instead of terminal) which indicated that the test timed out after 30 seconds. Is this expected?

   A: That is indeed expected! Some of our tests are expected to run for a long time, since performance is a criteria we want to measure. Running the test through the UI simply adds a flag to time out with the 30 seconds by default of the Go VSCode extension.

   To work around it, go to settings.json of your VSCode (you can use the command palette and search for "Preference: Open Settings (UI)"). Then simply find the setting corresponding to the test timeout (it has a setting ID of go.testTimeout which you can type in the search bar to filter) and adjust its value, which we recommend to be 300s.