test: add subtest support to testTokenlessCsrfProtection

Make each list driven test case a subtest of its own. Add
pytest-subtest pip module to make this work.

Author: rouilj

.github/workflows/ci-test.yml

@@ -147,9 +147,10 @@ jobs:
         run: python -m pip install --upgrade pip
 
       # note pytest-env is not needed for redis password as there is
-      # no password on CI's redis.
+      # no password on CI's redis. pytest-subtests isn't needed with
+      # pytest 9.0.0+, but 9.0 only supports 3.10+ so include for 3.7+.
       - name: Install pytest and other packages needed for running tests
-        run: pip install flake8 hypothesis mock pytest pytest-cov requests sphinx-tabs
+        run: pip install flake8 hypothesis mock pytest pytest-cov pytest-subtests requests sphinx-tabs
 
       # https://github.com/mxschmitt/action-tmate
       # allow remote ssh into the CI container. I need this to debug

test/requirements.txt

@@ -1,6 +1,18 @@
 # the driving harness
 pytest
 
+# set environment variables for redis password etc. from ini/toml
+# settings files.
+pytest-env
+
+# change order of tests to find dependencies
+pytest-randomly
+
+# allows execution of subtests when a test function tests multiple
+# scenarios.  It is built into pytest 9.0+, but can co-exist with it
+# and is required for older pytest that run on older python versions.
+pytest-subtests
+
 # coverage stats
 coverage
 # fuzz tests

test/test_cgi.py

@@ -219,9 +219,22 @@ def setUp(self):
             re.VERBOSE)
 
     @pytest.fixture(autouse=True)
-    def inject_fixtures(self, caplog, monkeypatch):
+    def inject_fixtures(self, caplog, monkeypatch, subtests):
+        """Used to add pytest test fixtures to unittest based tests
+           because adding the name of a fixture to a method does not
+           make the method available.
+
+           So the decrorator runs with autouse=True to set params on
+           the unittest "self" making the fixtures available for
+           tests.
+
+           If you need another fixture, just add it to the argument list
+           and assign it to self and pytest will make it available.
+        """
+        
         self._caplog = caplog
         self._monkeypatch = monkeypatch
+        self._subtests = subtests
 
     #
     # form label extraction
@@ -1207,10 +1220,13 @@ def hasPermission(s, p, classname=None, d=None, e=None, **kw):
                 cl.db.config['WEB_ALLOWED_API_ORIGINS'] = ""
 
             cl.main()
-            self.assertIn(test['Result'], out[0])
 
-            if "response_code" in test:
-                self.assertEqual(test['response_code'], cl.response_code)
+            # make each case above a subtest
+            with self._subtests.test(entry=entry):
+                self.assertIn(test['Result'], out[0])
+
+                if "response_code" in test:
+                    self.assertEqual(test['response_code'], cl.response_code)
 
             del(out[0])