test/

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

README ¶

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.

syscalls: system call tests use a local runner, and do not require additional configuration in the machine.
integration: defines integration tests that uses docker run to test 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. 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. 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.

Directories ¶

Path	Synopsis
e2e Package integration is empty.	Package integration is empty.
image Package image is empty.	Package image is empty.
iptables Package iptables contains a set of iptables tests implemented as TestCases	Package iptables contains a set of iptables tests implemented as TestCases
runner Package main runs iptables tests from within a docker container.	Package main runs iptables tests from within a docker container.
root Package root is used for tests that requires sysadmin privileges run.	Package root is used for tests that requires sysadmin privileges run.
runtimes Binary runner runs the runtime tests in a Docker container.	Binary runner runs the runtime tests in a Docker container.
images/proctor Binary proctor runs the test for a particular runtime.	Binary proctor runs the test for a particular runtime.
syscalls Binary syscall_test_runner runs the syscall test suites in gVisor containers and on the host platform.	Binary syscall_test_runner runs the syscall test suites in gVisor containers and on the host platform.
gtest Package gtest contains helpers for running google-test tests from Go.	Package gtest contains helpers for running google-test tests from Go.
uds Package uds contains helpers for testing external UDS functionality.	Package uds contains helpers for testing external UDS functionality.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL