Bugfix external_prefix regex check

Remove defined external 'id_prefixes' from to be checked links.
Added another example to have an rst file inside a folder as well.
Added some explanation to descriptions of needs

Author: MaximilianSoerenPollak

MODULE.bazel

@@ -92,7 +92,7 @@ bazel_dep(name = "score_python_basics", version = "0.3.1")
 bazel_dep(name = "score_cr_checker", version = "0.2.2")
 
 # This is only needed to build the examples.
-bazel_dep(name = "score_platform", version = "0.1.0")
+bazel_dep(name = "score_platform", version = "0.1.1")
 
 # Grab dash
 bazel_dep(name = "score_dash_license_checker", version = "0.1.1")

examples/linking-both/index.rst

@@ -12,19 +12,41 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   testing/test
+
+
 Hello World
 =================
 This is a simple example of a documentation page using the `docs` tool.
 
 .. stkh_req:: TestTitle
-   :id: stkh_req__docs__test_requirement
+   :id: stkh_req__index__test_requirement
    :status: valid
    :safety: QM
    :rationale: A simple requirement we need to enable a documentation build
    :reqtype: Functional
 
    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_gd_req__req__attr_safety`
    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>`_
 
+
+
+.. feat_req:: Some Title
+   :id: feat_req__index__some_title
+   :reqtype: Process
+   :security: YES
+   :safety: ASIL_D
+   :satisfies: SCORE_stkh_req__overall_goals__reuse_of_app_soft
+   :status: invalid
+   
+   With this requirement we can check if the removal of the prefix is working correctly. 
+   It should remove id_prefix (SCORE _) as it's defined inside the BUILD file and remove it before it checks the leftover value
+   against the allowed defined regex in the metamodel
+

examples/linking-both/testing/test.rst

@@ -0,0 +1,43 @@
+..
+   # *******************************************************************************
+   # Copyright (c) 2024 Contributors to the Eclipse Foundation
+   #
+   # See the NOTICE file(s) distributed with this work for additional
+   # information regarding copyright ownership.
+   #
+   # This program and the accompanying materials are made available under the
+   # terms of the Apache License Version 2.0 which is available at
+   # https://www.apache.org/licenses/LICENSE-2.0
+   #
+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+Inside a folder
+=================
+This example will help catch things and bugs when rst's are defined inside a folder.
+
+.. stkh_req:: TestTitle
+   :id: stkh_req__testing__test_requirement
+   :status: valid
+   :safety: QM
+   :rationale: A simple requirement we need to enable a documentation build
+   :reqtype: Functional
+
+   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`
+   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>`_
+
+
+.. feat_req:: Some Title
+   :id: feat_req__testing__some_title
+   :reqtype: Process
+   :security: YES
+   :safety: ASIL_D
+   :satisfies: SCORE_stkh_req__overall_goals__reuse_of_app_soft
+   :status: invalid 
+
+   With this requirement we can check if the removal of the prefix is working correctly. 
+   It should remove id_prefix (SCORE _) as it's defined inside the BUILD file and remove it before it checks the leftover value
+   against the 'allowed' defined regex in the metamodel
+

src/extensions/score_metamodel/__init__.py

@@ -279,10 +279,13 @@ def parse_external_needs_sources(app: Sphinx, config):
                     if "json_path" in a.keys():
                         a["json_path"] = r + a["json_path"]
         app.config.needs_external_needs = x
+        # Making the prefixes uppercase here to match sphinx_needs, as it does this internally too.
+        app.config.allowed_external_prefixes = [z["id_prefix"].upper() for z in x]
 
 
 def setup(app: Sphinx) -> dict[str, str | bool]:
     app.add_config_value("external_needs_source", "", rebuild="env")
+    app.add_config_value("allowed_external_prefixes", [], rebuild="env")
     app.config.needs_id_required = True
     app.config.needs_id_regex = "^[A-Za-z0-9_-]{6,}"
 

src/extensions/score_metamodel/checks/check_options.py

@@ -15,6 +15,7 @@
 from sphinx.application import Sphinx
 from sphinx_needs.config import NeedType
 from sphinx_needs.data import NeedsInfoType
+from collections.abc import Generator
 
 from score_metamodel import (
     CheckLogger,
@@ -40,6 +41,7 @@ def validate_fields(
     fields: dict[str, str],
     required: bool,
     field_type: str,
+    allowed_prefixes: list[str],
 ):
     """
     Validates that fields (options or links) in a need match their expected patterns.
@@ -50,9 +52,18 @@ def validate_fields(
     :param required: Whether the fields are required (True) or optional (False).
     :param field_type: A string indicating the field type ('option' or 'link').
     """
+
+    def remove_prefix(values: list[str], prefixes: list[str]) -> Generator[str, None,None]:
+        # Memory and allocation wise better to use a generator here.
+        # Removes any prefix allowed by configuration, if prefix is there.
+        return (
+            next((text.removeprefix(p) for p in prefixes if text.startswith(p)), text) for text in values
+        )
+
+        
     for field, pattern in fields.items():
-        raw_value: str | list[str] | None = need.get(field, None)
 
+        raw_value: str | list[str] | None = need.get(field, None)
         if raw_value in [None, [], ""]:
             if required:
                 log.warning_for_need(
@@ -69,6 +80,10 @@ def validate_fields(
         else:
             values = [str(raw_value)]
 
+        # The filter ensures that the function is only called when needed.
+        if field_type == "link" and allowed_prefixes:
+            values = list(remove_prefix(values,allowed_prefixes))
+
         for value in values:
             try:
                 if not re.match(pattern, value):
@@ -123,6 +138,9 @@ def check_options(
         ],
     }
 
+    # If undefined this is an empty list
+    allowed_prefixes = app.config.allowed_external_prefixes
+   
     for field_type, check_fields in checking_dict.items():
         for field_values, is_required in check_fields:
             validate_fields(
@@ -131,6 +149,7 @@ def check_options(
                 field_values,
                 required=is_required,
                 field_type=field_type,
+                allowed_prefixes=allowed_prefixes
             )
 
 

src/extensions/score_metamodel/checks/id_contains_feature.py

@@ -37,8 +37,13 @@ def id_contains_feature(app: Sphinx, need: NeedsInfoType, log: CheckLogger):
 
     # Get the part of the string after the first two underscores: the path
     feature = parts[1]
+   
+    dir_docname = os.path.dirname(str(need.get("docname", "")))
+
+    # If the 'rst' file is not in a directory, the above expression will be "". 
+    # Even if the need itself has a docname. That's why we have this logic here.
+    docname = dir_docname if dir_docname else need.get("docname", "")
 
-    docname = os.path.dirname(str(need.get("docname", "")))
     if feature not in docname:
         log.warning_for_option(
             need, "id", f"Feature '{feature}' not in path '{docname}'."