feat: add logging for existing links and warnings for missing needs in schema validation

Author: arnoox

src/extensions/score_source_code_linker/__init__.py

@@ -318,6 +318,38 @@ def find_need(all_needs: NeedsMutable, id: str) -> NeedItem | None:
     return all_needs.get(id)
 
 
+def _log_needs_with_existing_links(needs: NeedsMutable) -> None:
+    """Log needs that already have source_code_link or testlink set."""
+    if LOGGER.getEffectiveLevel() >= 10:
+        for id, need in needs.items():
+            if need.get("source_code_link"):
+                LOGGER.debug(
+                    f"?? Need {id} already has source_code_link: "
+                    f"{need.get('source_code_link')}"
+                )
+            if need.get("testlink"):
+                LOGGER.debug(
+                    f"?? Need {id} already has testlink: {need.get('testlink')}"
+                )
+
+
+def _warn_missing_need(source_code_links: SourceCodeLinks) -> None:
+    """Log warnings when a need referenced by source/test links is not found."""
+    # TODO: print github annotations as in https://github.com/eclipse-score/bazel_registry/blob/7423b9996a45dd0a9ec868e06a970330ee71cf4f/tools/verify_semver_compatibility_level.py#L126-L129
+    for n in source_code_links.links.CodeLinks:
+        LOGGER.warning(
+            f"{n.file}:{n.line}: Could not find {source_code_links.need} "
+            "in documentation [CODE LINK]",
+            type="score_source_code_linker",
+        )
+    for n in source_code_links.links.TestLinks:
+        LOGGER.warning(
+            f"{n.file}:{n.line}: Could not find {source_code_links.need} "
+            "in documentation [TEST LINK]",
+            type="score_source_code_linker",
+        )
+
+
 # re-qid: gd_req__req__attr_impl
 def inject_links_into_needs(app: Sphinx, env: BuildEnvironment) -> None:
     """
@@ -339,17 +371,7 @@ def inject_links_into_needs(app: Sphinx, env: BuildEnvironment) -> None:
     )  # TODO: why do we create a copy? Can we also needs_copy = needs[:]? copy(needs)?
 
     # Enabled automatically for DEBUGGING
-    if LOGGER.getEffectiveLevel() >= 10:
-        for id, need in needs.items():
-            if need.get("source_code_link"):
-                LOGGER.debug(
-                    f"?? Need {id} already has source_code_link: "
-                    f"{need.get('source_code_link')}"
-                )
-            if need.get("testlink"):
-                LOGGER.debug(
-                    f"?? Need {id} already has testlink: {need.get('testlink')}"
-                )
+    _log_needs_with_existing_links(needs)
 
     source_code_links_by_need = load_source_code_links_combined_json(
         get_cache_filename(app.outdir, "score_scl_grouped_cache.json")
@@ -358,19 +380,7 @@ def inject_links_into_needs(app: Sphinx, env: BuildEnvironment) -> None:
     for source_code_links in source_code_links_by_need:
         need = find_need(needs_copy, source_code_links.need)
         if need is None:
-            # TODO: print github annotations as in https://github.com/eclipse-score/bazel_registry/blob/7423b9996a45dd0a9ec868e06a970330ee71cf4f/tools/verify_semver_compatibility_level.py#L126-L129
-            for n in source_code_links.links.CodeLinks:
-                LOGGER.warning(
-                    f"{n.file}:{n.line}: Could not find {source_code_links.need} "
-                    "in documentation [CODE LINK]",
-                    type="score_source_code_linker",
-                )
-            for n in source_code_links.links.TestLinks:
-                LOGGER.warning(
-                    f"{n.file}:{n.line}: Could not find {source_code_links.need} "
-                    "in documentation [TEST LINK]",
-                    type="score_source_code_linker",
-                )
+            _warn_missing_need(source_code_links)
             continue
 
         need_as_dict = cast(dict[str, object], need)