summaryrefslogtreecommitdiffhomepage
path: root/test/README.md
diff options
context:
space:
mode:
authorFabricio Voznika <fvoznika@google.com>2019-10-18 16:13:04 -0700
committergVisor bot <gvisor-bot@google.com>2019-10-18 16:18:52 -0700
commit74044f2cca498ed3144baccc5d3b7af534829966 (patch)
treef00ee3917c93db767b62a44fea4a4f7674719b18 /test/README.md
parent51538c973e4044308833d55641e57da0e1a14b62 (diff)
Add more instructions to test/README.md
PiperOrigin-RevId: 275565958
Diffstat (limited to 'test/README.md')
-rw-r--r--test/README.md28
1 files changed, 25 insertions, 3 deletions
diff --git a/test/README.md b/test/README.md
index 09c36b461..97fe7ea04 100644
--- a/test/README.md
+++ b/test/README.md
@@ -10,9 +10,31 @@ they may need extra setup in the test machine and extra configuration to run.
functionality.
- **image:** basic end to end test for popular images. These require the same
setup as integration tests.
-- **root:** tests that require to be run as root.
+- **root:** tests that require to be run as root. These require the same setup
+ as integration tests.
- **util:** utilities library to support the tests.
For the above noted cases, the relevant runtime must be installed via `runsc
-install` before running. This is handled automatically by the test scripts in
-the `kokoro` directory.
+install` before running. Just note that they require specific configuration to
+work. This is handled automatically by the test scripts in the `scripts`
+directory and they can be used to run tests locally on your machine. They are
+also used to run these tests in `kokoro`.
+
+**Example:**
+
+To run image and integration tests, run:
+
+`./scripts/docker_test.sh`
+
+To run root tests, run:
+
+`./scripts/root_test.sh`
+
+There are a few other interesting variations for image and integration tests:
+
+* overlay: sets writable overlay inside the sentry
+* hostnet: configures host network pass-thru, instead of netstack
+* kvm: runsc the test using the KVM platform, instead of ptrace
+
+The test will build runsc, configure it with your local docker, restart
+`dockerd`, and run tests. The location for runsc logs is printed to the output.