fix: external needs graph checks & misc fixes (#78)

MaximilianSoerenPollak · web-flow · commit 792f661be32c · 2025-06-05T15:51:46.000+02:00
diff --git a/docs/example/index.rst b/docs/example/index.rst
@@ -30,7 +30,7 @@ This is a rendered example of the 'examples/linking-both' folder using the `docs
 
    Some content to make sure we also can render this
    This is a link to an external need inside the 'score' documentation.
-   :need:`SCORE_gd_req__req__attr_safety`
+   :need:`SCORE_feat_req__kvs__config_file`. 
    Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here <https://github.com/useblocks/sphinx-needs/blob/master/sphinx_needs/external_needs.py#L119>`_
 
 
diff --git a/docs/example/testing/index.rst b/docs/example/testing/index.rst
@@ -25,7 +25,7 @@ This example will help catch things and bugs when rst's are defined inside a fol
 
    Some content to make sure we also can render this. 
    This is a link to an external need inside the 'score' documentation.
-   :need:`SCORE_gd_req__req__attr_safety`
+   :need:`SCORE_feat_req__kvs__config_file`. 
    Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here <https://github.com/useblocks/sphinx-needs/blob/master/sphinx_needs/external_needs.py#L119>`_
 
 
diff --git a/examples/linking-both/index.rst b/examples/linking-both/index.rst
@@ -33,7 +33,7 @@ This is a simple example of a documentation page using the `docs` tool.
 
    Some content to make sure we also can render this
    This is a link to an external need inside the 'score' documentation.
-   :need:`SCORE_gd_req__req__attr_safety`
+   :need:`SCORE_feat_req__kvs__config_file`
    Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here <https://github.com/useblocks/sphinx-needs/blob/master/sphinx_needs/external_needs.py#L119>`_
 
 
diff --git a/examples/linking-both/testing/test.rst b/examples/linking-both/testing/test.rst
@@ -25,7 +25,7 @@ This example will help catch things and bugs when rst's are defined inside a fol
 
    Some content to make sure we also can render this. 
    This is a link to an external need inside the 'score' documentation.
-   :need:`SCORE_gd_req__req__attr_safety`
+   :need:`SCORE_feat_req__kvs__config_file`. 
    Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here <https://github.com/useblocks/sphinx-needs/blob/master/sphinx_needs/external_needs.py#L119>`_
 
 
diff --git a/examples/linking-latest/index.rst b/examples/linking-latest/index.rst
@@ -25,6 +25,6 @@ This is a simple example of a documentation page using the `docs` tool.
 
    Some content to make sure we also can render this
    This is a link to an external need inside the 'score' documentation.
-   :need:`SCORE_gd_req__req__attr_safety`. 
+   :need:`SCORE_feat_req__kvs__config_file`. 
    Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here <https://github.com/useblocks/sphinx-needs/blob/master/sphinx_needs/external_needs.py#L119>`_
 
diff --git a/src/extensions/score_metamodel/__init__.py b/src/extensions/score_metamodel/__init__.py
@@ -22,14 +22,13 @@
 from ruamel.yaml import YAML
 from sphinx.application import Sphinx
 from sphinx_needs import logging
-from sphinx_needs.data import NeedsInfoType, SphinxNeedsData
-
+from sphinx_needs.data import NeedsInfoType, SphinxNeedsData, NeedsView
 from .log import CheckLogger
 
 logger = logging.get_logger(__name__)
 
 local_check_function = Callable[[Sphinx, NeedsInfoType, CheckLogger], None]
-graph_check_function = Callable[[Sphinx, list[NeedsInfoType], CheckLogger], None]
+graph_check_function = Callable[[Sphinx, NeedsView, CheckLogger], None]
 
 local_checks: list[local_check_function] = []
 graph_checks: list[graph_check_function] = []
@@ -78,9 +77,7 @@ def _run_checks(app: Sphinx, exception: Exception | None) -> None:
         return
 
     # Filter out external needs, as checks are only intended to be run on internal needs.
-    needs_all_needs = (
-        SphinxNeedsData(app.env).get_needs_view().filter_is_external(False)
-    )
+    needs_all_needs = SphinxNeedsData(app.env).get_needs_view()
 
     logger.debug(f"Running checks for {len(needs_all_needs)} needs")
 
@@ -95,20 +92,22 @@ def is_check_enabled(check: local_check_function | graph_check_function):
 
     enabled_local_checks = [c for c in local_checks if is_check_enabled(c)]
 
+    needs_local_needs = (
+        SphinxNeedsData(app.env).get_needs_view().filter_is_external(False)
+    )
     # Need-Local checks: checks which can be checked file-local, without a
     # graph of other needs.
-    for need in needs_all_needs.values():
+    for need in needs_local_needs.values():
         for check in enabled_local_checks:
             logger.debug(f"Running local check {check} for need {need['id']}")
             check(app, need, log)
 
     # Graph-Based checks: These warnings require a graph of all other needs to
     # be checked.
 
-    needs = list(needs_all_needs.values())
     for check in [c for c in graph_checks if is_check_enabled(c)]:
         logger.debug(f"Running graph check {check} for all needs")
-        check(app, needs, log)
+        check(app, needs_all_needs, log)
 
     if log.has_warnings:
         log.warning("Some needs have issues. See the log for more information.")
diff --git a/src/extensions/score_metamodel/checks/graph_checks.py b/src/extensions/score_metamodel/checks/graph_checks.py
@@ -15,7 +15,7 @@
 from typing import Any, Literal
 
 from sphinx.application import Sphinx
-from sphinx_needs.data import NeedsInfoType
+from sphinx_needs.data import NeedsInfoType, NeedsView
 
 from score_metamodel import (
     CheckLogger,
@@ -130,19 +130,20 @@ def get_need_selection(
 @graph_check
 def check_metamodel_graph(
     app: Sphinx,
-    all_needs: list[NeedsInfoType],
+    all_needs: NeedsView,
     log: CheckLogger,
 ):
     graph_checks_global = app.config.graph_checks
     # Convert list to dictionary for easy lookup
-    needs_dict = {need["id"]: need for need in all_needs}
+    needs_dict_all = {need["id"]: need for need in all_needs.values()}
+    needs_local = list(all_needs.filter_is_external(False).values())
 
     # Iterate over all graph checks
     for check in graph_checks_global.items():
         apply, eval = check[1].values()
 
         # Get all needs that match the selection criteria
-        selected_needs = get_need_selection(all_needs, apply, log)
+        selected_needs = get_need_selection(needs_local, apply, log)
 
         for need in selected_needs:
             for parent_relation in list(eval.keys()):
@@ -153,7 +154,7 @@ def check_metamodel_graph(
                 parent_ids = need[parent_relation]
 
                 for parent_id in parent_ids:
-                    parent_need = needs_dict.get(parent_id)
+                    parent_need = needs_dict_all.get(parent_id)
                     if parent_need is None:
                         msg = f"Parent need `{parent_id}` not found in needs_dict."
                         log.warning_for_need(need, msg)
diff --git a/src/extensions/score_metamodel/metamodel.yaml b/src/extensions/score_metamodel/metamodel.yaml
@@ -187,9 +187,9 @@ needs_types:
       security: "^(YES|NO)$"
       realizes: "^wp__.+$"
   # The following 3 guidance requirements enforce the requirement structure and attributes:
-  # req-Id: gd_req__req__structure
-  # req-Id: gd_req__requirements_attr_description
-  # req-Id: gd_req__req__linkage
+  # req- Id: gd_req__req__structure
+  # req- Id: gd_req__requirements_attr_description
+  # req- Id: gd_req__req__linkage
   # Requirements
   stkh_req:
     title: "Stakeholder Requirement"
@@ -219,7 +219,7 @@ needs_types:
       safety: "^(QM|ASIL_B|ASIL_D)$"
       status: "^(valid|invalid)$"
     mandatory_links:
-      # req-Id: gd_req__req__linkage_fulfill
+      # req- Id: gd_req__req__linkage_fulfill
       satisfies: "^stkh_req__.*$"
     optional_options:
       codelink: "^.*$"
@@ -560,10 +560,10 @@ needs_extra_links:
 #   - condition: defines the condition that should be checked
 #     - [and / or / xor / not]
 ##############################################################
-# req-Id: gd_req__req__linkage_architecture
-# req-Id: gd_req__req__linkage_safety
+# req- Id: gd_req__req__linkage_architecture
+# req- Id: gd_req__req__linkage_safety
 graph_checks:
-  # req-Id: gd_req__req__linkage_safety
+  # req- Id: gd_req__req__linkage_safety
   req_safety_linkage:
     needs:
       include: "comp_req, feat_req"
@@ -582,7 +582,7 @@ graph_checks:
       condition: "status == valid"
     check:
       satisfies: "status == valid"
-  # req-Id: gd_req__req__linkage_architecture
+  # req- Id: gd_req__req__linkage_architecture
   arch_safety_linkage:
     needs:
       include: "comp_req, feat_req"
diff --git a/src/extensions/score_metamodel/tests/test_rules_file_based.py b/src/extensions/score_metamodel/tests/test_rules_file_based.py
@@ -175,7 +175,7 @@ def test_rst_files(
             "Unable to extract test data from the rst file: "
             f"{rst_file}. Please check the file for the correct format."
         )
-    print(f"RST Data: {rst_data}")
+    # print(f"RST Data: {rst_data}")
     app: SphinxTestApp = sphinx_app_setup(RST_DIR / rst_file)
     os.chdir(app.srcdir)  # Change working directory to the source directory
 
@@ -185,7 +185,7 @@ def test_rst_files(
 
     # Collect the warnings
     warnings = app.warning.getvalue().splitlines()
-    print(f"Warnings: {warnings}")
+    # print(f"Warnings: {warnings}")
 
     # Check if the expected warnings are present
     for warning_info in rst_data.warning_infos:
