summaryrefslogtreecommitdiffhomepage
path: root/runsc/test/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'runsc/test/README.md')
-rw-r--r--runsc/test/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/runsc/test/README.md b/runsc/test/README.md
new file mode 100644
index 000000000..5929cbeb6
--- /dev/null
+++ b/runsc/test/README.md
@@ -0,0 +1,26 @@
+# Tests
+
+The tests defined under this path are verifying functionality beyond what unit
+tests can cover, e.g. integration and end to end tests. Due to their nature,
+they may need extra setup in the test machine and extra configuration to run.
+
+- **integration:** defines integration tests that uses `docker run` to test
+ functionality.
+- **image:** basic end to end test for popular images.
+- **root:** tests that require to be run as root.
+- **testutil:** utilities library to support the tests.
+
+The following setup steps are required in order to run these tests:
+
+
+ `./runsc/test/install.sh [--runtime <name>]`
+
+The tests expect the runtime name to be provided in the `RUNSC_RUNTIME`
+environment variable (default: `runsc-test`). To run the tests execute:
+
+
+```
+bazel test --test_env=RUNSC_RUNTIME=runsc-test \
+ //runsc/test/image:image_test \
+ //runsc/test/integration:integration_test
+```