summaryrefslogtreecommitdiff
path: root/test/python/docker/compat/README.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2021-03-01 14:20:49 -0800
committerGitHub <noreply@github.com>2021-03-01 14:20:49 -0800
commit8af66806c8042501ca32e66efdeb463cf5346cab (patch)
tree1ed8c48b6187a80b3822cf41431e92972fb0ad20 /test/python/docker/compat/README.md
parent73044b28172fd0df23836052a9061dc41f51f39a (diff)
parent7927fe01f165bb4a3f381601d847036a3a130182 (diff)
downloadpodman-8af66806c8042501ca32e66efdeb463cf5346cab.tar.gz
podman-8af66806c8042501ca32e66efdeb463cf5346cab.tar.bz2
podman-8af66806c8042501ca32e66efdeb463cf5346cab.zip
Merge pull request #9556 from jwhonce/wip/docker
Refactor python tests to run against python3.9
Diffstat (limited to 'test/python/docker/compat/README.md')
-rw-r--r--test/python/docker/compat/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/test/python/docker/compat/README.md b/test/python/docker/compat/README.md
new file mode 100644
index 000000000..50796d66b
--- /dev/null
+++ b/test/python/docker/compat/README.md
@@ -0,0 +1,38 @@
+# Docker regression test
+
+Python test suite to validate Podman endpoints using docker library (aka docker-py).
+See [Docker SDK for Python](https://docker-py.readthedocs.io/en/stable/index.html).
+
+## Running Tests
+
+To run the tests locally in your sandbox (Fedora 32,33):
+
+```shell
+# dnf install python3-docker
+```
+
+### Run the entire test suite
+
+All commands are run from the root of the repository.
+
+```shell
+# python3 -m unittest discover -s test/python/docker
+```
+
+Passing the -v option to your test script will instruct unittest.main() to enable a higher level of verbosity, and produce detailed output:
+
+```shell
+# python3 -m unittest -v discover -s test/python/docker
+```
+
+### Run a specific test class
+
+```shell
+# python3 -m unittest -v test.python.docker.compat.test_images.TestImages
+```
+
+### Run a specific test within the test class
+
+```shell
+# python3 -m unittest test.python.docker.compat.test_images.TestImages.test_tag_valid_image
+```