Testing

A majority of the code in the Elixxir codebase is tested. Node operators can run the tests on any Elixxir or xx network public repository themselves using the instructions in this section.

Running tests in Go for most Elixxir and xx network repositories is a straightforward process. But first, make sure to follow the Go Environment Set Up. Then, to run a test, download a repository and use go test.

1. Go to the Elixxir or xx network GitLab page and select a repository to download. Alternatively, select one from the following list of public repositories:

   • elixxir/primitives
   • elixxir/crypto
   • elixxir/comms
   • elixxir/gpumathsgo
   • elixxir/server
   • elixxir/gateway
   • elixxir/client
   • elixxir/user-discovery-bot
   • elixxir/LocalEnvironment
   • elixxir/integration
   • elixxir/wrapper
   • xx_network/primitives
   • xx_network/crypto
   • xx_network/comms

2. Use git clone or any other method to download the repository.

   $ git clone -b master https://gitlab.com/[repository name from step 1].git
   

   In the following steps, Primitives will be used as an example.

   $ git clone -b master https://gitlab.com/elixxir/primitives.git
   

3. Change directories to the root of the downloaded repository.

   $ cd primitives/
   

4. To compile and run all the tests for this repository, use the following command.

   $ go test ./...
   

   The first time the code is compiled, all of the dependencies will download first.

   Running the tests can take a while, but once they are finished, a summary of the tests and their elapsed time will be printed out. If any tests fail, those errors will be printed too.

   ok      gitlab.com/elixxir/primitives/current   0.016s
   ok      gitlab.com/elixxir/primitives/format    0.025s
   ok      gitlab.com/elixxir/primitives/id        0.023s
   ok      gitlab.com/elixxir/primitives/id/idf    0.134s
   ok      gitlab.com/elixxir/primitives/ndf       0.031s
   ok      gitlab.com/elixxir/primitives/rateLimiting      113.118s
   ok      gitlab.com/elixxir/primitives/ring      0.020s
   ok      gitlab.com/elixxir/primitives/states    0.017s
   ok      gitlab.com/elixxir/primitives/switchboard       4.344s
   ok      gitlab.com/elixxir/primitives/utils     0.093s
   ok      gitlab.com/elixxir/primitives/version   0.008s
   

5. To run tests located in a specific directory, include the directory name. Also, including the -v flag will print more details about which test is being run and the debug logs.

   $ go test -v ./utils
   

   The result will be a list of the tests run and their elapsed time. At the bottom is the total time for all the tests.

   ==== RUN   TestUnmarshal_DataLengthError
   --- PASS: TestUnmarshal_DataLengthError (0.00s)
   === RUN   TestType_String
   --- PASS: TestType_String (0.00s)
   === RUN   TestType_String_Error
   --- PASS: TestType_String_Error (0.00s)
   PASS
   ok      gitlab.com/elixxir/primitives/id        0.065s
   

6. To run only one test or multiple tests matching a regular expression, use the -run flag.

   $ go test -run [test name or regex]