[doc] Add instruction for running cirque tests (#4140)

* [doc] Add instruction for running cirque tests

* Restyled by prettier-markdown

* Add instruction for running single test

* Move doc to src/test_driver/linux-cirque/cirque.md

* Fix doxygen

* Restyled by prettier-markdown

Co-authored-by: Restyled.io <commits@restyled.io>

docs/Doxyfile

@@ -843,7 +843,8 @@ INPUT                  = README.md \
                          src/platform \
                          src/setup_payload \
                          src/system \
-                         src/transport
+                         src/transport \
+                         src/test_driver/linux-cirque/README.md
 
 USE_MDFILE_AS_MAINPAGE = README.md
 

docs/README.md

@@ -4,6 +4,9 @@
 
 -   Documentation about building from the command line can be found in
     [the build guide](./BUILDING.md)
+-   Documentation about running [cirque](https://github.com/openweave/cirque)
+    tests can be found in
+    [the cirque test guide](src/test_driver/linux-cirque/README.md)
 -   Documentation about standard build & development flows using
     [Visual Studio Code](https://code.visualstudio.com/) can be found in
     [the development guide](./VSCODE_DEVELOPMENT.md)

scripts/tests/cirque_tests.sh

@@ -115,6 +115,7 @@ function cirquetest_run_test() {
         docker container prune -f >/dev/null 2>&1
         docker network prune -f >/dev/null 2>&1
     fi
+    echo "Test log can be found at $DEVICE_LOG_DIR"
     return "$exitcode"
 }
 

src/test_driver/linux-cirque/README.md

@@ -0,0 +1,79 @@
+# The cirque testing suite
+
+Cirque simulates complex network topologies based upon docker nodes. On a single
+Linux machine, it can create multiple nodes with network stacks that are
+independent from each other. Some nodes may be connected to simulated Thread
+networks, others may connect to simulated BLE or WiFi.
+
+In Project CHIP, cirque is used for tntegration tests.
+
+There is a script for running cirque tests, you can find it at
+`scripts/tests/cirque_tests.sh`
+
+## Setting up cirque environment
+
+After checkout, in your local project chip directory, run:
+
+```
+scripts/tests/cirque_tests.sh bootstrap
+```
+
+It will:
+
+1. Install necessary packages required by cirque,
+
+2. Build `chip-cirque-device-base` docker image for running devices,
+
+3. Build openthread for simulating thread network.
+
+> Note: Suggest using a clean checkout before running this.
+
+## Run tests
+
+You can run the tests by:
+
+```
+scripts/tests/cirque_tests.sh run_all_tests
+```
+
+You can get more infomation from the terminal output (like the location of
+logs).
+
+> Note: The container (as well as the networks) will be preserved for debugging.
+> You may need to clean it by yourself.
+
+## Run specific test
+
+You can run a single cirque test by:
+
+```
+scripts/tests/cirque_tests.sh run_test <test name>
+```
+
+The test name is the script (`.sh`) file in `src/test_driver/linux-cirque`, like
+`OnOffClusterTest`.
+
+For example, you can run `OnOffClusterTest` by:
+
+```
+scripts/tests/cirque_tests.sh run_test OnOffClusterTest
+```
+
+The output of the test will be written to `stdout` and `stderr`.
+
+## Specify log directory
+
+To specify log directory, simplily set `LOG_DIR` variable.
+
+```
+export LOG_DIR=/some/log/directory
+scripts/tests/cirque_tests.sh run_all_tests
+scripts/tests/cirque_tests.sh run_test OnOffClusterTest
+```
+
+Or
+
+```
+LOG_DIR=/some/log/directory scripts/tests/cirque_tests.sh run_all_tests
+LOG_DIR=/some/log/directory scripts/tests/cirque_tests.sh run_test OnOffClusterTest
+```