README_tests.md

Unsafe Unit Tests for stratisd

A collection of tests intended to test the different layers of stratis

Running the tests

It is possible to run many tests using loopbacked devices to simulate real devices. It is also possible to run these tests using real devices specified in a configuration file. Both sorts of tests require root permissions and make changes to your storage configuration. It is recommended that you run these tests only on a dedicated test machine. Running these tests requires that the user can sudo as root.

To run the loopbacked devices tests (in root of source tree):

 $ make test-loop

This runs all the tests that are enabled for loopbacked devices using the Rust integration test framework.

To run the real device backed tests:

First, set up the configuration file to specify your set of scratch devices.

The contents of the tests/test_config.json file should be a JSON array of paths to the scratch devices. For example:

{
    "ok_to_destroy_dev_array_key": [
    				   "/dev/vdb",
    				   "/dev/vdc",
				   "/dev/vdd",
				   "/dev/vde"
    ]
}

JSON requires commas between list items, but make sure to omit the comma after the last list item.

Then (in root of source tree):

$ make test-real

To inspect a test stack after running a test, run the test command with the environment variable NO_TEST_CLEAN_UP=1. This will disable stack clean up after the test completes.