Update tr_link to support pattern matching

Author: cuinixam

sphinxcontrib/test_reports/functions/__init__.py

@@ -1,16 +1,24 @@
+import re
+
+
 def tr_link(app, need, needs, test_option, target_option, *args, **kwargs):
     if test_option not in need:
         return ""
-    test_opt = need[test_option]
+    test_option_value = need[test_option]
 
     links = []
     for need_target in needs.values():
         if target_option not in need_target:
             continue
 
-        if (
-            test_opt == need_target[target_option] and test_opt is not None and len(test_opt) > 0  # fmt: skip
-        ):
-            links.append(need_target["id"])
+        if test_option_value is not None and len(test_option_value) > 0:
+            target_option_value = need_target[target_option]
+            if target_option_value is not None and len(target_option_value) > 0:
+                if test_option_value == target_option_value:
+                    links.append(need_target["id"])
+                # if the test option value has a *, use regex matching
+                elif "*" in test_option_value:
+                    if re.match(test_option_value, target_option_value):
+                        links.append(need_target["id"])
 
     return links

tests/test_tr_link.py

@@ -1,35 +1,127 @@
-from sphinxcontrib.test_reports.functions import tr_link
+from pathlib import Path
+
+import importlib.util
+import sys
+
+
+def import_from_path(path, name):
+    spec = importlib.util.spec_from_file_location(name, path)
+    module = importlib.util.module_from_spec(spec)
+    sys.modules[name] = module
+    spec.loader.exec_module(module)
+    return module
+
+
+# (!) We need to import the 'tr_link' method from the local module,
+# otherwise the method from the installed 'sphinxcontrib' package will be used.
+local_functions_module = import_from_path(
+    Path(__file__).parent.parent.joinpath(
+        "sphinxcontrib/test_reports/functions/__init__.py"
+    ),
+    "functions",
+)
+tr_link = local_functions_module.tr_link
 
 
 def test_tr_link_option_not_in_need():
     """
     Return an empty string when the specified test option is missing from the need.
     """
-    assert tr_link(app=None, need={}, needs={}, test_option="a", target_option="b") == ""
+    assert (
+        tr_link(app=None, need={}, needs={}, test_option="a", target_option="b") == ""
+    )
+
 
 def test_tr_link_no_target_option_in_needs():
     """
     Return an empty list when the target option is missing in all items of needs.
     """
-    assert tr_link(app=None, need={"a": "1"}, needs={"x": {"id": "123"}}, test_option="a", target_option="b") == []
+    assert (
+        tr_link(
+            app=None,
+            need={"a": "1"},
+            needs={"x": {"id": "123"}},
+            test_option="a",
+            target_option="b",
+        )
+        == []
+    )
+
 
 def test_tr_link_no_match():
     """
-    Returns an empty list when no matching value for the test option is found in any of the target options within needs.
+    Returns an empty list when no matching value for the test option is found
+    in any of the target options within needs.
     """
-    assert tr_link(app=None, need={"a": "1"}, needs={"x": {"b": "2", "id": "123"}}, test_option="a", target_option="b") == []
+    assert (
+        tr_link(
+            app=None,
+            need={"a": "1"},
+            needs={"x": {"b": "2", "id": "123"}},
+            test_option="a",
+            target_option="b",
+        )
+        == []
+    )
+
 
 def test_tr_link_match():
     """
     Returns a list of ids when there is a matching value in both need and needs.
     """
-    assert tr_link(app=None, need={"a": "1"}, needs={"x": {"b": "1", "id": "123"}}, test_option="a", target_option="b") == ["123"]
+    assert tr_link(
+        app=None,
+        need={"a": "1"},
+        needs={"x": {"b": "1", "id": "123"}},
+        test_option="a",
+        target_option="b",
+    ) == ["123"]
+
 
 def test_tr_link_none_or_empty():
     """
     'None' and empty string values are not considered as valid matches.
     """
     need = {"a": None, "b": ""}
-    needs = {"x": {"c": None, "id": "111"}, "y": {"c": "valid", "id": "222"}, "z": {"c": "", "id": "333"}}
-    assert tr_link(app=None, need=need, needs=needs, test_option="b", target_option="c") == []
-    assert tr_link(app=None, need=need, needs=needs, test_option="a", target_option="c") == []
+    needs = {
+        "x": {"c": None, "id": "111"},
+        "y": {"c": "valid", "id": "222"},
+        "z": {"c": "", "id": "333"},
+    }
+    assert (
+        tr_link(app=None, need=need, needs=needs, test_option="b", target_option="c")
+        == []
+    )
+    assert (
+        tr_link(app=None, need=need, needs=needs, test_option="a", target_option="c")
+        == []
+    )
+
+
+def test_tr_link_regex_match():
+    """
+    Returns a list of ids when the test option value containing an asterisk (*)
+    correctly matches target options using regular expression patterns.
+    """
+    needs = {
+        "x": {"b": "abc123", "id": "111"},
+        "y": {"b": "def456", "id": "222"},
+        "z": {"b": "ghi789", "id": "333"},
+    }
+    need = {"a": "abc.*"}
+    assert tr_link(
+        app=None, need=need, needs=needs, test_option="a", target_option="b"
+    ) == ["111"]
+
+
+def test_tr_link_regex_no_match():
+    """
+    Returns an empty list when the test option value containing an asterisk (*)
+    does not match any target options using regular expression patterns.
+    """
+    needs = {"x": {"b": "abc123", "id": "111"}, "y": {"b": "def456", "id": "222"}}
+    need = {"a": "xyz.*"}
+    assert (
+        tr_link(app=None, need=need, needs=needs, test_option="a", target_option="b")
+        == []
+    )