Fix patterns filter for empty multitest

Author: dteo00

doc/newsfragments/3561_changed.patterns_filter_will_run_empty_multitest.rst

@@ -0,0 +1 @@
+The ``--patterns`` filter will run a Multitest as long as the test name matches even if the Multitest is empty.

testplan/testing/filtering.py

@@ -48,6 +48,9 @@ class BaseFilter:
     def map(self, f):
         raise NotImplementedError
 
+    def filter_test(self, test) -> bool:
+        raise NotImplementedError
+
     def filter(self, test, suite, case) -> bool:
         raise NotImplementedError
 
@@ -169,6 +172,9 @@ class Or(MetaFilter):
 
     operator_str = "|"
 
+    def filter_test(self, test):
+        return any(f.filter_test(test) for f in self.filters)
+
     def composed_filter(self, test, suite, case):
         return any(f.filter(test, suite, case) for f in self.filters)
 
@@ -180,6 +186,9 @@ class And(MetaFilter):
 
     operator_str = "&"
 
+    def filter_test(self, test):
+        return all(f.filter_test(test) for f in self.filters)
+
     def composed_filter(self, test, suite, case):
         return all(f.filter(test, suite, case) for f in self.filters)
 
@@ -204,6 +213,9 @@ def map(self, f):
         self.filter_obj = f(self.filter_obj)
         return self
 
+    def filter_test(self, test):
+        return not self.filter_obj.filter_test(test)
+
     def filter(self, test, suite, case):
         return not self.filter_obj.filter(test, suite, case)
 

testplan/testing/multitest/base.py

@@ -626,8 +626,14 @@ def add_main_batch_steps(self):
     def should_run(self):
         """
         MultiTest filters are applied in `get_test_context`
-        so we just check if `test_context` is not empty."""
-        return bool(self.test_context)
+        so we check if `test_context` is not empty.
+        If there's no parts, MultiTest should still be ran even if it is empty, add a filter just for the test
+        """
+        if self.cfg.part:
+            return bool(self.test_context)
+        return bool(self.test_context) or self.cfg.test_filter.filter_test(
+            self
+        )
 
     def aborting(self):
         """Suppressing not implemented debug log from parent class."""

tests/functional/testplan/testing/test_filtering.py

@@ -195,6 +195,30 @@ def test_programmatic_filtering(filter_obj, report_ctx):
     check_report_context(test_report, report_ctx)
 
 
+def test_programmatic_filtering_empty_multitest():
+    """MultiTest with no suites should still run if pattern matches test name."""
+    multitest_x = MultiTest(name="XXX", suites=[])
+
+    plan = TestplanMock(name="plan", test_filter=filtering.Pattern("XXX"))
+    plan.add(multitest_x)
+    plan.run()
+
+    test_report = plan.report
+    check_report_context(test_report, [("XXX", [])])
+
+
+def test_programmatic_filtering_empty_multitest_no_match():
+    """MultiTest with no suites should not run if pattern doesn't match."""
+    multitest_x = MultiTest(name="XXX", suites=[])
+
+    plan = TestplanMock(name="plan", test_filter=filtering.Pattern("YYY"))
+    plan.add(multitest_x)
+    plan.run()
+
+    test_report = plan.report
+    check_report_context(test_report, [])
+
+
 @pytest.mark.parametrize(
     "filter_obj, report_ctx",
     (

tests/unit/testplan/testing/multitest/test_multitest.py

@@ -664,3 +664,44 @@ def test_skip_steps():
         )
     )
     assert "_start_resource" not in mt.result.step_results
+
+
+@pytest.mark.parametrize(
+    "pattern, name, expected",
+    (
+        ("Test", "Test", True),
+        ("T*", "Test", True),
+        ("Test1", "Test", False),
+        ("*", "Test", True),
+        ("*:*:*", "Test", True),
+        ("Test:Suite:case", "Test", True),
+        ("Test1:Suite:case", "Test", False),
+    ),
+)
+def test_should_run_with_pattern_filter(pattern, name, expected):
+    mt = multitest.MultiTest(
+        name=name,
+        suites=[Suite()],
+        **{**MTEST_DEFAULT_PARAMS, "test_filter": filtering.Pattern(pattern)},
+    )
+    assert mt.should_run() == expected
+
+
+def test_should_run_with_no_suites():
+    """should_run returns True if filter matches even with no suites."""
+    mt = multitest.MultiTest(
+        name="Test",
+        suites=[],
+        **{**MTEST_DEFAULT_PARAMS, "test_filter": filtering.Pattern("Test")},
+    )
+    assert mt.should_run() is True
+
+
+def test_should_run_with_no_suites_no_match():
+    """should_run returns False if filter doesn't match and no suites."""
+    mt = multitest.MultiTest(
+        name="Test",
+        suites=[],
+        **{**MTEST_DEFAULT_PARAMS, "test_filter": filtering.Pattern("Test1")},
+    )
+    assert mt.should_run() is False