Source code linker fix #125

MaximilianSoerenPollak · 2025-07-07T09:02:54Z

This is a fix for the source code linker.

It addresses several things especially the #118 .

The README has not yet been fully changed, though this will be done in a future PR.

This has been developed together with @AlexanderLanin

github-actions · 2025-07-07T09:04:03Z

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //src:license-check

Status: ✅ Passed

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server and connecting to it...
INFO: Invocation ID: 287ffd20-cab9-4e2d-8770-7e3ba905393a
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
Loading: 0 packages loaded
    currently loading: src
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //src:license-check (96 packages loaded, 10 targets configured)

Analyzing: target //src:license-check (139 packages loaded, 509 targets configured)

Analyzing: target //src:license-check (150 packages loaded, 1789 targets configured)

Analyzing: target //src:license-check (153 packages loaded, 2652 targets configured)

Analyzing: target //src:license-check (158 packages loaded, 2687 targets configured)

Analyzing: target //src:license-check (162 packages loaded, 4820 targets configured)

INFO: Analyzed target //src:license-check (163 packages loaded, 4946 targets configured).
INFO: Found 1 target...
Target //src:license.check.license_check up-to-date:
  bazel-bin/src/license.check.license_check
  bazel-bin/src/license.check.license_check.jar
INFO: Elapsed time: 15.234s, Critical Path: 0.37s
INFO: 13 processes: 4 disk cache hit, 9 internal.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/src/license.check.license_check src/formatted.txt -review -project automotive.score -repo https://github.com/eclipse-score/docs-as-code -token otyhZ4eaRYK1tKLNNF-Y
[main] INFO Querying Eclipse Foundation for license data for 83 items.
[main] INFO Found 58 items.
[main] INFO Querying ClearlyDefined for license data for 25 items.
[main] INFO Found 25 items.
[main] INFO Vetted license information was found for all content. No further investigation is required.

github-actions · 2025-07-07T09:06:36Z

The created documentation from the pull request is available at: docu-html

Copilot

Pull Request Overview

This PR fixes the source code linker integration (especially issue #118) by standardizing workspace path handling, removing the legacy parser, and rewriting tests to use temporary Git repositories and JSON cache files.

Prepend BUILD_WORKSPACE_DIRECTORY to all source, build, and conf paths in incremental.py
Remove old parse_source_files.py and Bazel aspect; introduce generate_source_code_links_json.py
Refactor tests to initialize real Git repos, generate and compare JSON cache files, and inject links via the new Sphinx extension

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/incremental.py	Prefixes all env-derived paths with workspace, fixes live_preview cache removal
src/extensions/score_source_code_linker/generate_source_code_links_json.py	New module to scan for need tags and emit JSON cache
src/extensions/score_source_code_linker/init.py	Switch to JSON-backed linking in Sphinx setup, remove old inline parser
src/extensions/score_source_code_linker/needlinks.py	Minor tweaks, but functionally unchanged
src/extensions/score_source_code_linker/tests/test_source_link.py	Tests rewritten to spin up Git repos and validate JSON cache
src/extensions/score_source_code_linker/tests/test_requirement_links.py	Expanded fixtures for multiple Git scenarios and JSON encoder/decoder
docs/product/extensions/source_code_linker.md	Updated example snippet
src/extensions/score_source_code_linker/BUILD	Test target now includes JSON data files

Comments suppressed due to low confidence (1)

docs/product/extensions/source_code_linker.md:19

[nitpick] The example snippet is confusing due to the embedded HTML comment. Simplify it to show the actual tag format (e.g., # req-traceability:) without extra markup.

   - Scans input files for template tags (e.g., "#<!-- comment prevents parsing this occurance --> req-traceability:")

Copilot · 2025-07-07T09:14:40Z

src/incremental.py

+        build_dir = Path(get_env("BUILD_DIRECTORY"))
+        (workspace / build_dir / "score_source_code_linker_cache.json").unlink(
+            missing_ok=False
+        )


workspace is a string, so workspace / build_dir will raise a TypeError. Convert workspace to a Path before using / or use Path(workspace) / build_dir.

Copilot · 2025-07-07T09:14:41Z

src/incremental.py

+    # if workspace:
+    #     os.chdir(workspace)
    if workspace:
-        os.chdir(workspace)
+        workspace += "/"
+    else:
+        workspace = ""

    base_arguments = [
-        get_env("SOURCE_DIRECTORY"),
-        get_env("BUILD_DIRECTORY"),
+        workspace + get_env("SOURCE_DIRECTORY"),
+        workspace + get_env("BUILD_DIRECTORY"),
        "-W",  # treat warning as errors
        "--keep-going",  # do not abort after one error
        "-T",  # show details in case of errors in extensions
        "--jobs",
        "auto",
        "--conf-dir",
-        get_env("CONF_DIRECTORY"),
+        workspace + get_env("CONF_DIRECTORY"),


[nitpick] Manually appending a slash is brittle; consider keeping workspace as a Path and using workspace / get_env(...) for joins instead of string concatenation.

Copilot · 2025-07-07T09:14:41Z

src/extensions/score_source_code_linker/__init__.py

+    print(f"DEBUG: Workspace root is {find_ws_root()}")
+    print(f"DEBUG: Current working directory is {Path('.')} = {Path('.').resolve()}")
+    print(f"DEBUG: Git root is {find_git_root()}")


[nitpick] Use LOGGER.debug(...) instead of print(...) for debug output to maintain consistent logging and avoid polluting stdout.

Suggested change

print(f"DEBUG: Workspace root is {find_ws_root()}")

print(f"DEBUG: Current working directory is {Path('.')} = {Path('.').resolve()}")

print(f"DEBUG: Git root is {find_git_root()}")

LOGGER.debug(f"Workspace root is {find_ws_root()}")

LOGGER.debug(f"Current working directory is {Path('.')} = {Path('.').resolve()}")

LOGGER.debug(f"Git root is {find_git_root()}")

Copilot · 2025-07-07T09:14:42Z

src/extensions/score_source_code_linker/__init__.py

        env: Buildenvironment, this is filled automatically
        app: Sphinx app application, this is filled automatically
    """
+    print("inject_links_into_needs!!!!")


[nitpick] Remove or replace this print statement with a debug-level log (LOGGER.debug) to avoid unexpected console output in production.

Suggested change

print("inject_links_into_needs!!!!")

LOGGER.debug("inject_links_into_needs!!!!")

Copilot · 2025-07-07T09:14:42Z

src/extensions/score_source_code_linker/tests/test_source_link.py

+    return [
+        {
+            "TREQ_ID_200": [
+                NeedLink(
+                    file=Path(f"src/bad_implementation.py"),
+                    line=2,
+                    tag="#" + " req-Id:",
+                    need="TREQ_ID_200",
+                    full_line="#" + " req-Id: TREQ_ID_200",
+                )
+            ]
+        }
+    ]


The example_source_link_text_non_existent fixture returns a list, but the test signature expects a dict[str, list[str]]. Update the fixture or the test to match the expected type.

This is more complicated than anticipated

Git root is still an issue. It doesn't behave as needed (for a nice unit test)

Tests were generated boilerplate. Already altered / improved some, but not yet fully looked through. Just wanted a starting point

Fixed tests working. All test pass now

MaximilianSoerenPollak · 2025-07-07T09:23:18Z

I just rebased it to eliminate the Merge issues.

github-project-automation bot added this to INF - Infrastructure Community Jul 7, 2025

github-project-automation bot moved this to Draft in INF - Infrastructure Community Jul 7, 2025

MaximilianSoerenPollak requested review from Aymen-Soussi-01, dcalavrezo-qorix and nicu1989 July 7, 2025 09:03

dcalavrezo-qorix approved these changes Jul 7, 2025

View reviewed changes

dcalavrezo-qorix requested a review from Copilot July 7, 2025 09:12

Copilot AI reviewed Jul 7, 2025

View reviewed changes

MaximilianSoerenPollak marked this pull request as ready for review July 7, 2025 09:22

MaximilianSoerenPollak requested a review from AlexanderLanin as a code owner July 7, 2025 09:22

AlexanderLanin and others added 15 commits July 7, 2025 11:22

write json

b2ce41d

wip

18e0bbc

wip

31dabde

cleanup, workspace dir

156dbf8

wip

c1db012

wip

30a0eac

Tests Begining to fix

8e6bba2

WIP

431c26b

This is more complicated than anticipated

WIP: Integration test are running

5720712

WIP

805da99

WIP: Git root issue

1861823

Git root is still an issue. It doesn't behave as needed (for a nice unit test)

Added qualifying comment.

40c066c

Tests were generated boilerplate. Already altered / improved some, but not yet fully looked through. Just wanted a starting point

Fixed Tests

bbeb007

Fixed tests working. All test pass now

Formatting & Copyright

53497f4

Change README

ce4e816

MaximilianSoerenPollak force-pushed the wip_simple_scp branch from ff4c5d3 to ce4e816 Compare July 7, 2025 09:23

MaximilianSoerenPollak requested a review from sameer6989 July 7, 2025 09:29

MaximilianSoerenPollak linked an issue Jul 7, 2025 that may be closed by this pull request

v0.4 does not work on score #118

Closed

AlexanderLanin approved these changes Jul 7, 2025

View reviewed changes

MaximilianSoerenPollak merged commit 6a8b18f into main Jul 7, 2025
7 checks passed

MaximilianSoerenPollak deleted the wip_simple_scp branch July 7, 2025 10:13

github-project-automation bot moved this from Draft to Done in INF - Infrastructure Community Jul 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Source code linker fix #125

Source code linker fix #125

Uh oh!

MaximilianSoerenPollak commented Jul 7, 2025 •

edited by AlexanderLanin

Loading

Uh oh!

github-actions bot commented Jul 7, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 7, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 7, 2025

Uh oh!

Copilot AI Jul 7, 2025

Uh oh!

Copilot AI Jul 7, 2025

Uh oh!

Copilot AI Jul 7, 2025

Uh oh!

Copilot AI Jul 7, 2025

Uh oh!

MaximilianSoerenPollak commented Jul 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	print("inject_links_into_needs!!!!")
	LOGGER.debug("inject_links_into_needs!!!!")

Source code linker fix #125

Source code linker fix #125

Uh oh!

Conversation

MaximilianSoerenPollak commented Jul 7, 2025 • edited by AlexanderLanin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions bot commented Jul 7, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

MaximilianSoerenPollak commented Jul 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MaximilianSoerenPollak commented Jul 7, 2025 •

edited by AlexanderLanin

Loading

github-actions bot commented Jul 7, 2025 •

edited

Loading