Docker: Use pytest as default command

[mirror_frr.git] / tests / topotests / docker / README.md

diff --git a/tests/topotests/docker/README.md b/tests/topotests/docker/README.md
index b506fd6fb16194a40431aeb728c15227d739eed6..25b18da7dc27879af600da30007ae89a95e589b5 100644 (file)
--- a/tests/topotests/docker/README.md
+++ b/tests/topotests/docker/README.md
@@ -1,6 +1,6 @@
 # Topotests in Docker
 
-## Usage
+## Quickstart
 
 If you have Docker installed, you can run the topotests in Docker.
 The easiest way to do this, is to use the `frr-topotests.sh` script
@@ -14,8 +14,35 @@ chmod +x /usr/local/bin/frr-topotests
 
 Once this script is in place, simply run it while you are inside your FRR repository:
 
-```
+```console
 frr-topotests
 ```
 
-It should build FRR inside of the container and run the topotests on it.
+## Advanced Usage
+
+There are several environtment variables which can be used to modify the behavior of
+the image. Those can be listed using `frr-topotests -h`.
+
+For example, a volume is used to cache build artifacts between multiple runs
+of the image. If you need to force a complete recompile, you can set `TOPOTEST_CLEAN`:
+
+```console
+TOPOTEST_CLEAN=1 frr-topotests
+```
+
+By default, `frr-topotests` will execute pytest without any arguments. If you append an
+arguments with the first one starting with `/` or `./`, they will replace the call to
+pytest. If the appended arguments do not match this patttern, they will be provided to
+pytest as arguments.
+
+So, to run a specific test with more verbose logging:
+
+```console
+frr-topotests -vv -s all-protocol-startup/test_all_protocol_startup.py
+```
+
+And to compile FRR but drop into a shell instead of running pytest:
+
+```console
+frr-topotests /bin/bash
+```