]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
Update system test runner doc with pytest glue files
authorTom Krizek <tkrizek@isc.org>
Tue, 15 Aug 2023 13:32:45 +0000 (15:32 +0200)
committerTom Krizek <tkrizek@isc.org>
Wed, 20 Sep 2023 12:51:49 +0000 (14:51 +0200)
Document that pytest requires a glue file for each shell tests in order
to detect it.

(cherry picked from commit d050843a303fe2612ac7ac32541865b4e2358f7c)

bin/tests/system/README

index aba1acc56b0808f591dcb78a8622bb5d6a2bace3..00146be307a8377b6feb38b2ed25241dfc03054e 100644 (file)
@@ -325,6 +325,8 @@ setup.sh    Run after prereq.sh, this sets up the preconditions for the tests.
 
 tests.sh    Runs the actual tests.  This file is mandatory.
 
+tests_sh_xyz.py  A glue file for the pytest runner for executing shell tests.
+
 clean.sh    Run at the end to clean up temporary files, but only if the test
             was completed successfully and its running was not inhibited by the
             "-n" switch being passed to "legacy.run.sh".  Otherwise the
@@ -544,6 +546,17 @@ e.  Retain a count of test failures and return this as the exit status from
     the script.
 
 
+tests_sh_xyz.py
+---------------
+This glue file is required by the pytest runner in order to find and execute
+the shell tests in tests.sh.
+
+Replace the "xyz" with the system test name and create the file with the
+following contents.
+
+    def test_xyz(run_tests_sh):
+        run_tests_sh()
+
 clean.sh
 ---
 The inverse of "setup.sh", this is invoked by the framework to clean up the