summaryrefslogtreecommitdiff
path: root/test
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-07-11 21:35:30 +0200
committerGitHub <noreply@github.com>2019-07-11 21:35:30 +0200
commit24409daa36137406a403ae8e22cf71afa590c746 (patch)
treec0a2b3b3d4bb5fb3b08500919751844edb6df415 /test
parente06561270105a4e801eddce6ffe3d52f8bf23ed6 (diff)
parent1a42123710848c829c39e335a5d3860728234710 (diff)
downloadpodman-24409daa36137406a403ae8e22cf71afa590c746.tar.gz
podman-24409daa36137406a403ae8e22cf71afa590c746.tar.bz2
podman-24409daa36137406a403ae8e22cf71afa590c746.zip
Merge pull request #3470 from QazerLab/docs/system-tests
Update the testing documentation with system tests.
Diffstat (limited to 'test')
-rw-r--r--test/README.md23
1 files changed, 17 insertions, 6 deletions
diff --git a/test/README.md b/test/README.md
index 4e61a0774..9bea679dc 100644
--- a/test/README.md
+++ b/test/README.md
@@ -110,19 +110,30 @@ make shell
This will run a container and give you a shell and you can follow the instructions above.
-# System test
+# System tests
System tests are used for testing the *podman* CLI in the context of a complete system. It
requires that *podman*, all dependencies, and configurations are in place. The intention of
system testing is to match as closely as possible with real-world user/developer use-cases
and environments. The orchestration of the environments and tests is left to external
tooling.
-* `PodmanTestSystem`: System test *struct* as a composite of `PodmanTest`. It will not add any
-options to the command by default. When you run system test, you can set GLOBALOPTIONS,
-PODMAN_SUBCMD_OPTIONS or PODMAN_BINARY in ENV to run the test suite for different test matrices.
+System tests use Bash Automated Testing System (`bats`) as a testing framework.
+Install it via your package manager or get latest stable version
+[directly from the repository](https://github.com/bats-core/bats-core), e.g.:
-## Run system test
-You can run the test with following command:
+```
+mkdir -p ~/tools/bats
+git clone --single-branch --branch v1.1.0 https://github.com/bats-core/bats-core.git ~/tools/bats
+```
+
+Make sure that `bats` binary (`bin/bats` in the repository) is in your `PATH`, if not - add it:
+
+```
+PATH=$PATH:~/tools/bats/bin
+```
+
+## Running system tests
+When `bats` is installed and is in your `PATH`, you can run the test suite with following command:
```
make localsystem