From a5eb779c9466b3f6efc91bf8ce6960888f032b48 Mon Sep 17 00:00:00 2001 From: Tom Krizek Date: Tue, 15 Aug 2023 15:32:45 +0200 Subject: [PATCH] Update system test runner doc with pytest glue files 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 | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/bin/tests/system/README b/bin/tests/system/README index aba1acc56b..00146be307 100644 --- a/bin/tests/system/README +++ b/bin/tests/system/README @@ -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