Merge branch 'main' into vohae_saf_analysis

Signed-off-by: Volker Häussler <volker.haeussler@qorix.ai>

Author: PandaeDo

.bazelrc

@@ -10,3 +10,5 @@ build --incompatible_default_to_explicit_init_py
 
 common --registry=https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/
 common --registry=https://bcr.bazel.build
+
+common --incompatible_disallow_empty_glob

docs.bzl

@@ -44,7 +44,6 @@ load("@rules_pkg//pkg:mappings.bzl", "pkg_files")
 load("@rules_pkg//pkg:tar.bzl", "pkg_tar")
 load("@rules_python//sphinxdocs:sphinx.bzl", "sphinx_build_binary", "sphinx_docs")
 load("@rules_python//sphinxdocs:sphinx_docs_library.bzl", "sphinx_docs_library")
-load("@score_docs_as_code//src/extensions/score_source_code_linker:collect_source_files.bzl", "parse_source_files_for_needs_links")
 load("@score_python_basics//:defs.bzl", "score_virtualenv")
 
 sphinx_requirements = all_requirements + [
@@ -58,21 +57,14 @@ sphinx_requirements = all_requirements + [
     "@score_docs_as_code//src/extensions/score_source_code_linker:score_source_code_linker",
 ]
 
-def docs(source_files_to_scan_for_needs_links = None, source_dir = "docs", conf_dir = "docs", build_dir_for_incremental = "_build", docs_targets = []):
+def docs(source_files_to_scan_for_needs_links = None, source_dir = "docs", conf_dir = "docs", build_dir_for_incremental = "_build", docs_targets = [], deps = []):
     """
     Creates all targets related to documentation.
     By using this function, you'll get any and all updates for documentation targets in one place.
     Current restrictions:
     * only callable from 'docs/BUILD'
     """
 
-    # Parse source files for needs links
-    # This needs to be created to generate a target, otherwise it won't execute as dependency for other macros
-    parse_source_files_for_needs_links(
-        name = "score_source_code_parser",
-        srcs_and_deps = source_files_to_scan_for_needs_links if source_files_to_scan_for_needs_links else [],
-    )
-
     # We are iterating over all provided 'targets' in order to allow for automatic generation of them without
     # needing to modify the underlying 'docs.bzl' file.
     for target in docs_targets:
@@ -83,8 +75,8 @@ def docs(source_files_to_scan_for_needs_links = None, source_dir = "docs", conf_
         sphinx_build_binary(
             name = "sphinx_build" + suffix,
             visibility = ["//visibility:public"],
-            data = ["@score_docs_as_code//src:docs_assets", "@score_docs_as_code//src:score_extension_files"] + external_needs_deps,
-            deps = sphinx_requirements,
+            data = ["@score_docs_as_code//src:docs_assets", "@score_docs_as_code//src:docs_as_code_py_modules"] + external_needs_deps,
+            deps = sphinx_requirements + deps,
         )
         _incremental(
             incremental_name = "incremental" + suffix,
@@ -94,6 +86,7 @@ def docs(source_files_to_scan_for_needs_links = None, source_dir = "docs", conf_
             build_dir = build_dir_for_incremental,
             external_needs_deps = external_needs_deps,
             external_needs_def = external_needs_def,
+            extra_dependencies = deps,
         )
         _docs(
             name = "docs" + suffix,
@@ -113,7 +106,7 @@ def docs(source_files_to_scan_for_needs_links = None, source_dir = "docs", conf_
     # Virtual python environment for working on the documentation (esbonio).
     # incl. python support when working on conf.py and sphinx extensions.
     # creates :ide_support target for virtualenv
-    _ide_support()
+    _ide_support(deps)
 
     # creates 'needs.json' build target
 
@@ -136,7 +129,7 @@ def _incremental(incremental_name = "incremental", live_name = "live_preview", s
         srcs = ["@score_docs_as_code//src:incremental.py"],
         deps = dependencies,
         # TODO: Figure out if we need all dependencies as data here or not.
-        data = [":score_source_code_parser", "@score_docs_as_code//src:plantuml", "@score_docs_as_code//src:docs_assets"] + dependencies + external_needs_deps,
+        data = ["@score_docs_as_code//src:plantuml", "@score_docs_as_code//src:docs_assets"] + dependencies + external_needs_deps,
         env = {
             "SOURCE_DIRECTORY": source_dir,
             "CONF_DIRECTORY": conf_dir,
@@ -160,11 +153,11 @@ def _incremental(incremental_name = "incremental", live_name = "live_preview", s
         },
     )
 
-def _ide_support():
+def _ide_support(extra_dependencies):
     score_virtualenv(
         name = "ide_support",
         venv_name = ".venv_docs",
-        reqs = sphinx_requirements,
+        reqs = sphinx_requirements + extra_dependencies,
     )
 
 def _docs(name = "docs", suffix = "", format = "html", external_needs_deps = list(), external_needs_def = list()):
@@ -190,7 +183,7 @@ def _docs(name = "docs", suffix = "", format = "html", external_needs_deps = lis
             "**/*.json",
             "**/*.csv",
             "**/*.inc",
-        ], exclude = ["**/tests/*"]),
+        ], exclude = ["**/tests/*"], allow_empty = True),
         config = ":conf.py",
         extra_opts = [
             "-W",
@@ -204,7 +197,6 @@ def _docs(name = "docs", suffix = "", format = "html", external_needs_deps = lis
             "manual",
         ],
         tools = [
-            ":score_source_code_parser",
             "@score_docs_as_code//src:plantuml",
             "@score_docs_as_code//src:docs_assets",
         ] + external_needs_deps,
@@ -213,7 +205,7 @@ def _docs(name = "docs", suffix = "", format = "html", external_needs_deps = lis
 
     native.filegroup(
         name = "assets" + target_suffix,
-        srcs = native.glob(["_assets/**"]),
+        srcs = native.glob(["_assets/**"], allow_empty = True),
         visibility = ["//visibility:public"],
     )
 

docs/BUILD

@@ -48,7 +48,4 @@ docs(
         },
     ],
     source_dir = "docs",
-    source_files_to_scan_for_needs_links = [
-        "//src:score_extension_files",
-    ],
 )

docs/product/extensions/source_code_linker.md

@@ -16,7 +16,7 @@ The extension uses two main components to integrate with Bazel:
    - Handles dependency tracking for incremental builds
 
 2. `parse_source_files.py`
-   - Scans input files for template tags (e.g., `# req-traceability:`)
+   - Scans input files for template tags (e.g., "#<!-- comment prevents parsing this occurance --> req-traceability:")
    - Retrieves git information (hash, file location)
    - Generates mapping file with requirement IDs and links
 
@@ -37,16 +37,27 @@ The extension uses two main components to integrate with Bazel:
        - Gets current git hash for each file
        - Constructs GitHub URLs with format:
          `{base_url}/{repo}/blob/{hash}/{file}#L{line_nr}`
-        **Note:** The base_url is defined in `parse_source_files.py`. Currently set to: `https://github.com/eclipse-score/score/blob/`  
+        **Note:** The base_url is defined in `parse_source_files.py`. Currently set to: `https://github.com/eclipse-score/score/blob/`
 
 Produces JSON mapping file:
-```json
-{
-    "REQ_ID": [
-        "github_link1",
-        "github_link2"  // If multiple code-links exist
-    ]
-}
+The strings are split here to not enable tracking by the source code linker.
+```python
+[
+    {
+        "file": "src/implementation1.py",
+        "line": 3,
+        "tag":"#" + " req-Id:",
+        "need": "TREQ_ID_1",
+        "full_line": "#"+" req-Id: TREQ_ID_1"
+    },
+    {
+        "file": "src/implementation2.py", 
+        "line": 3,
+        "tag":"#" + " req-Id:",
+        "need": "TREQ_ID_1",
+        "full_line": "#"+" req-Id: TREQ_ID_1"
+    },
+]
 ```
 
 <br>
@@ -86,7 +97,7 @@ The extension hooks into Sphinx's build process. It attaches to the `env-updated
 
 ### Adding Places to Search
 
-You can easily add files to be searched by adding targets / files to the deps inside the 
+You can easily add files to be searched by adding targets / files to the deps inside the
 `collect_source_files_for_score_source_code_linker` in `docs/BUILD`.
 See here:
 
@@ -126,7 +137,7 @@ WARNING: Could not find TREQ_ID_200 in the needs id's. Found in file(s):['_tooli
 
 ### Quickly Finding Source Links
 
-The easiest and quickest way to find source_code_link options is to just search for the option `source_code_link`. It should give you all rst files 
+The easiest and quickest way to find source_code_link options is to just search for the option `source_code_link`. It should give you all rst files
 where the option is not empty.
 
 ### Executing Tests

src/BUILD

@@ -118,21 +118,6 @@ py_library(
     visibility = ["//visibility:public"],
 )
 
-filegroup(
-    name = "score_extension_files",
-    srcs = glob(
-        [
-            "src/**",
-        ],
-        exclude = [
-            "**/test/**",
-            "**/tests/**",
-            "**/__pycache__/**",
-        ],
-    ) + [":docs_as_code_py_modules"],
-    visibility = ["//visibility:public"],
-)
-
 filegroup(
     name = "docs_assets",
     srcs = glob([
@@ -153,17 +138,6 @@ filegroup(
     visibility = ["//visibility:public"],
 )
 
-# Needed for 'test_rules_file_based'
-filegroup(
-    name = "test_rst_files",
-    srcs = glob([
-        "extensions/**/*.rst",
-        "extensions/**/*.py",
-        "conf.py",
-    ]),
-    visibility = ["//visibility:public"],
-)
-
 dash_license_checker(
     src = ":requirements_lock",
     file_type = "requirements",

src/extensions/score_metamodel/BUILD

@@ -33,7 +33,7 @@ score_py_pytest(
     size = "small",
     srcs = glob(["tests/*.py"]),
     # All requirements already in the library so no need to have it double
-    data = ["//src:test_rst_files"] + glob(
+    data = glob(
         ["tests/**/*.rst"],
     ),
     deps = [":score_metamodel"],

src/extensions/score_metamodel/__init__.py

@@ -11,18 +11,17 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 import importlib
-import pkgutil
 import json
 import os
-
+import pkgutil
 from collections.abc import Callable
 from pathlib import Path
 
-
 from ruamel.yaml import YAML
 from sphinx.application import Sphinx
 from sphinx_needs import logging
-from sphinx_needs.data import NeedsInfoType, SphinxNeedsData, NeedsView
+from sphinx_needs.data import NeedsInfoType, NeedsView, SphinxNeedsData
+
 from .log import CheckLogger
 
 logger = logging.get_logger(__name__)
@@ -81,7 +80,9 @@ def _run_checks(app: Sphinx, exception: Exception | None) -> None:
 
     logger.debug(f"Running checks for {len(needs_all_needs)} needs")
 
-    prefix = str(Path(app.srcdir).relative_to(Path.cwd()))
+    ws_root = os.environ.get("BUILD_WORKSPACE_DIRECTORY", None)
+    cwd_or_ws_root = Path(ws_root) if ws_root else Path.cwd()
+    prefix = str(Path(app.srcdir).relative_to(cwd_or_ws_root))
 
     log = CheckLogger(logger, prefix)
 

src/extensions/score_metamodel/checks/id_contains_feature.py

@@ -11,6 +11,7 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 import os
+import re
 
 from sphinx.application import Sphinx
 from sphinx_needs.data import NeedsInfoType
@@ -37,6 +38,7 @@ 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]
+    featureparts = re.split(r"[_-]", feature)
 
     dir_docname = os.path.dirname(str(need.get("docname", "")))
 
@@ -45,7 +47,22 @@ def id_contains_feature(app: Sphinx, need: NeedsInfoType, log: CheckLogger):
     # NOTE: This does not match the process requirements
     docname = dir_docname if dir_docname else need.get("docname", "")
 
-    if feature not in docname:
+    # allow if any feature part is contained in UID
+    foundfeatpart = any(
+        featurepart.lower() in docname.lower()
+        for featurepart in featureparts
+        if featureparts
+    )
+
+    # allow abbreviation of the feature
+    initials = "".join(
+        featurepart[0].lower() for featurepart in featureparts if len(featureparts) > 1
+    )
+    foundinitials = initials in docname.lower()
+
+    if not (foundfeatpart or foundinitials):
         log.warning_for_option(
-            need, "id", f"Feature '{feature}' not in path '{docname}'."
+            need,
+            "id",
+            f"Featurepart '{featureparts}' not in path '{docname}' or abbreviation not ok, expected: '{initials}'.",
         )

src/extensions/score_metamodel/tests/rst/id_contains_feature/test_id_contains_feature.rst

@@ -13,8 +13,9 @@
    # *******************************************************************************
 #CHECK: id_contains_feature
 
-.. Feature is not in the path of the RST file
-#EXPECT: std_wp__test__abcd.id (std_wp__test__abcd): Feature 'test' not in path
+.. Feature is deeper in the path of the RST file
+.. This is now explicitly allowed
+#EXPECT-NOT: std_wp__test__abcd.id (std_wp__test__abcd): Feature 'test' not in path
 
 .. std_wp:: This is a test
    :id: std_wp__test__abcd

src/extensions/score_plantuml.py

@@ -53,7 +53,7 @@ def get_runfiles_dir() -> Path:
         # But we need to find it first.
         logger.debug("Running outside bazel.")
 
-        git_root = Path(__file__).resolve()
+        git_root = Path.cwd().resolve()
         while not (git_root / ".git").exists():
             git_root = git_root.parent
             if git_root == Path("/"):