Skip to contentSkip to conversation

tests/functional: Allow tests to be run individually

PATCH New Fabiano Rosas 1 participant 1 message Jan 2

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 tests/functional: Allow tests to be run individually

The functional tests currently don't allow a single test to be selected for execution by dotted name, e.g:

./build/run tests/functional/ppc64/test_pseries.py PseriesMachine.test_ppc64_linux_boot

                                          ^

The issue is that the testcase.py main function passes the test module's name as the second argument to unittest.main(), which makes it ignore all other positional arguments (presumably because the module is already the superset of all tests).

After commit cac08383f0 ("tests/functional: expose sys.argv to unittest.main"), the situation improves by passing the rest of the argv from the command line invocation into unittest.main(), but it still doesn't fix the issue. The short form options are now accepted, so the -k option could be used to filter for a pattern, which is useful, but not the same as listing the test names.

Fix this by passing the test module name via the "module" argument to unittest.main() and stop touching argv. The ways of invoking tests are now as per unittests documentation (-k still works):

Examples:

    test_pseries.py                           - run default set of tests
    test_pseries.py MyTestSuite               - run suite 'MyTestSuite'
    test_pseries.py MyTestCase.testSomething  - run MyTestCase.testSomething
    test_pseries.py MyTestCase                - run all 'test*' test methods in MyTestCase

Note that ever since we've been programatically passing the module name to unittest.main(), the usage 'test_pseries.py test_pseries' was never valid. It used to "work" just the same as 'test_pseries.py foobar' would. After this patch, that usage results in an error.

Also note that testcase.py:main() pertains to running the test module that invoked it via QemuSystemTest.main(), i.e. module == __main__. So the 'discover' usage of unittest doesn't apply here, the module is already discovered because that's where this code was called from to begin with. This patch could just as well call unittest.main() instead of unittest.main(test_module), but the latter provides nicer error messages prefixed with the module name.

---
v3: rebased over ./build/run changes
v2: added docs

---
 docs/devel/testing/functional.rst      | 15 +++++++++++++++
 tests/functional/qemu_test/testcase.py |  7 +++----
 2 files changed, 18 insertions(+), 4 deletions(-)
docs/devel/testing/functional.rst +15 -0
index 1978f96eba..60a427d175 100644
@@ -60,8 +60,23 @@ Assuming the current working directory is the top level source checkout
 and the build directory is './build'::
 
   $ export QEMU_TEST_QEMU_BINARY=qemu-system-x86_64
+
+Run all tests from a test file::
+
   $ ./build/run tests/functional/x86_64/test_virtio_version.py
 
+Run all tests from a test class::
+
+  $ ./build/run tests/functional/x86_64/test_virtio_version.py VirtioVersionCheck
+
+Or a single test::
+
+  $ ./build/run tests/functional/x86_64/test_virtio_version.py VirtioVersionCheck.test_modern_only_devs
+
+Filtering test names also works::
+
+  $ ./build/run tests/functional/x86_64/test_virtio_version.py -k modern
+
 The test framework will automatically purge any scratch files created during
 the tests. If needing to debug a failed test, it is possible to keep these
 files around on disk by setting ``QEMU_TEST_KEEP_SCRATCH=1`` as an env
tests/functional/qemu_test/testcase.py +3 -4
index 58f2740100..fa100d9632 100644
@@ -249,17 +249,16 @@ def main():
         warnings.simplefilter("default")
         os.environ["PYTHONWARNINGS"] = "default"
 
-        path = os.path.basename(sys.argv[0])[:-3]
+        test_module = os.path.basename(sys.argv[0])[:-3]
 
         cache = os.environ.get("QEMU_TEST_PRECACHE", None)
         if cache is not None:
-            Asset.precache_suites(path, cache)
+            Asset.precache_suites(test_module, cache)
             return
 
         tr = pycotap.TAPTestRunner(message_log = pycotap.LogMode.LogToError,
                                    test_output_log = pycotap.LogMode.LogToError)
-        res = unittest.main(module = None, testRunner = tr, exit = False,
-                            argv=[sys.argv[0], path] + sys.argv[1:])
+        res = unittest.main(test_module, testRunner = tr, exit = False)
         failed = {}
         for (test, _message) in res.result.errors + res.result.failures:
             if hasattr(test, "log_filename") and not test.id() in failed:
Signature · 1 line
2.51.0