clitest

Relay CLI Integration tests

The relay cli integration tests live in this folder. You can run the full suite by running:

go test -mod=readonly -p 4 `go list ./cli_test/...`

To run a single test run:

go test -mod=readonly -p 4 `go list ./cli_test/...` -testify.m TestName

NOTE: While the full suite runs in parallel, some of the tests can take up to a minute to complete

Test Structure

This integration suite uses a thin wrapper over the os/exec package. This allows the integration test to run against built binaries (both relayd and relaycli are used) while being written in golang. This allows tests to take advantage of the various golang code we have for operations like marshal/unmarshal, crypto, etc...

NOTE: The tests will use whatever relayd or relaycli binaries are available in your $GOPATH/bin. You can check which binary will be run by the suite by running which relayd or which relaycli. If you have your $GOPATH properly setup they should be in $GOPATH/bin/relay*. This will ensure that your test uses the latest binary you have built

Tests generally follow this structure:

func (suite *UtilsSuite)  TestMyNewCommand() {
    suite.T().Parallel()
    f := InitFixtures(suite.T())

    // start relayd server
    proc := f.GDStart()
    defer proc.Stop(false)

    // Your test code goes here...

    f.Cleanup()
}

This boilerplate above:

• Ensures the tests run in parallel. Because the tests are calling out to os/exec for many operations these tests can take a long time to run.
• Creates .relayd and .relaycli folders in a new temp folder.
• Uses relaycli to create test account for use in testing: foo
• Creates a genesis file with coins (1000footoken,1000feetoken,150stake) controlled by the foo key
• Generates an initial bonding transaction (gentx) to make the foo key a validator at genesis
• Starts relayd and stops it once the test exits
• Cleans up test state on a successful run

Notes when adding/running tests

• Because the tests run against a built binary, you should make sure you build every time the code changes and you want to test again, otherwise you will be testing against an older version. If you are adding new tests this can easily lead to confusing test results.
• The test_helpers.go file is organized according to the format of relaycli and relayd commands. There are comments with section headers describing the different areas. Helper functions to call CLI functionality are generally named after the command (e.g. relaycli query bestknowndigest would be QueryBestKnownDigest). Try to keep functions grouped by their position in the command tree.
• Test state that is needed by tx and query commands (home, chain_id, etc...) is stored on the Fixtures object. This makes constructing your new tests almost trivial. Each test needs unique Fixture to run in parallel
• Sometimes if you exit a test early there can be still running relayd and relaycli processes that will interrupt subsequent runs. Still running relayd processes will block ports and prevent new tests from spinning up. You can ensure new tests spin up clean by running pkill -9 relayd && pkill -9 relaycli before each test run.
• Most query and tx commands take a variadic flags argument. This pattern allows for the creation of a general function which is easily modified by adding flags.
• Tx* functions follow a general pattern and return (success bool, stdout string, stderr string). This allows for easy testing of multiple different flag configurations.