fix: skip linking need to itself

Author: cuinixam

sphinxcontrib/test_reports/functions/__init__.py

@@ -8,6 +8,10 @@ def tr_link(app, need, needs, test_option, target_option, *args, **kwargs):
 
     links = []
     for need_target in needs.values():
+        # Skip linking to itself
+        if need_target["id"] == need["id"]:
+            continue
+        
         if target_option not in need_target:
             continue
 

tests/test_tr_link.py

@@ -39,7 +39,7 @@ def test_tr_link_no_target_option_in_needs():
     assert (
         tr_link(
             app=None,
-            need={"a": "1"},
+            need={"id": "1", "a": "1"},
             needs={"x": {"id": "123"}},
             test_option="a",
             target_option="b",
@@ -56,7 +56,7 @@ def test_tr_link_no_match():
     assert (
         tr_link(
             app=None,
-            need={"a": "1"},
+            need={"id": "1", "a": "1"},
             needs={"x": {"b": "2", "id": "123"}},
             test_option="a",
             target_option="b",
@@ -71,7 +71,7 @@ def test_tr_link_match():
     """
     assert tr_link(
         app=None,
-        need={"a": "1"},
+        need={"id": "1", "a": "1"},
         needs={"x": {"b": "1", "id": "123"}},
         test_option="a",
         target_option="b",
@@ -82,7 +82,7 @@ def test_tr_link_none_or_empty():
     """
     'None' and empty string values are not considered as valid matches.
     """
-    need = {"a": None, "b": ""}
+    need = {"id": "1", "a": None, "b": ""}
     needs = {
         "x": {"c": None, "id": "111"},
         "y": {"c": "valid", "id": "222"},
@@ -108,7 +108,7 @@ def test_tr_link_regex_match():
         "y": {"b": "def456", "id": "222"},
         "z": {"b": "ghi789", "id": "333"},
     }
-    need = {"a": "abc.*"}
+    need = {"id": "1", "a": "abc.*"}
     assert tr_link(
         app=None, need=need, needs=needs, test_option="a", target_option="b"
     ) == ["111"]
@@ -120,7 +120,19 @@ def test_tr_link_regex_no_match():
     does not match any target options using regular expression patterns.
     """
     needs = {"x": {"b": "abc123", "id": "111"}, "y": {"b": "def456", "id": "222"}}
-    need = {"a": "xyz.*"}
+    need = {"id": "1", "a": "xyz.*"}
+    assert (
+        tr_link(app=None, need=need, needs=needs, test_option="a", target_option="b")
+        == []
+    )
+
+
+def test_tr_link_skip_linking_to_itself():
+    """
+    Returns an empty list when the need and needs have the same 'id'.
+    """
+    needs = {"x": {"b": "abc123", "id": "111"}, "y": {"b": "def456", "id": "222"}}
+    need = {"id": "111", "a": "abc123"}
     assert (
         tr_link(app=None, need=need, needs=needs, test_option="a", target_option="b")
         == []