Update Rules_Py & Consolidate internal structure #378

MaximilianSoerenPollak · 2026-02-02T17:25:45Z

📌 Description

This PR achieves two main things.

It enables the upgrade of rules_py > 1.5
It removes 'find_runfiles' and moves the needed logic into the more appropriate helper_lib

The solution to the upgrade of the Runfiles was based on the work from @NEOatNHNG and his commit here
And also done with the help of @PiotrKorkus

🚨 Impact Analysis

This change does not violate any tool requirements and is covered by existing tool requirements
This change does not violate any design decisions
Otherwise I have created a ticket for new tool qualification

✅ Checklist

Added/updated documentation for new or changed features
Added/updated tests to cover the changes
Followed project coding standards and guidelines

github-actions · 2026-02-02T17:26:28Z

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //src:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.3.0) and connecting to it...
INFO: Invocation ID: 5295372c-e920-4d91-a592-5c227db31671
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
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 (66 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (69 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (76 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (128 packages loaded, 1802 targets configured)

Analyzing: target //src:license-check (132 packages loaded, 2516 targets configured)

Analyzing: target //src:license-check (140 packages loaded, 2576 targets configured)

Analyzing: target //src:license-check (140 packages loaded, 2576 targets configured)

Analyzing: target //src:license-check (140 packages loaded, 2576 targets configured)

INFO: Analyzed target //src:license-check (145 packages loaded, 4715 targets configured).
[1 / 1] no actions running
[13 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox
[14 / 16] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
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: 23.675s, Critical Path: 2.70s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/src/license.check.license_check src/formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

RolandJentschETAS · 2026-02-03T06:17:43Z

src/helper_lib/__init__.py

+#     )
+
+
+def get_runfiles_dir(start_path: Path | None = None):


Why is the function get_runfiles_dir defined and implemented in two different files ?

This should not be the case.
I have made a new commit where the old commented out one is deleted. Thanks for seeing that.

AlexanderLanin · 2026-02-04T09:24:52Z

@MaximilianSoerenPollak please update/rebase/merge, we should get more reasonable test feedback then due to other merged PRs

Change all 'os.getenv[RUNFILES]' to now use the find_runfiles file. This is in preperation for the rules_python upgrade which changes this implementation again.

AlexanderLanin · 2026-02-04T09:50:06Z

src/extensions/score_metamodel/external_needs.py

+    json_file_raw = f"{e.bazel_module}+/{e.target}/_build/needs/needs.json"
+    r = get_runfiles_dir()
+    json_file = r / json_file_raw
+    logger.debug(f"Fixed JSON file path: {json_file_raw} -> {json_file}")


Suggested change

json_file_raw = f"{e.bazel_module}+/{e.target}/_build/needs/needs.json"

r = get_runfiles_dir()

json_file = r / json_file_raw

logger.debug(f"Fixed JSON file path: {json_file_raw} -> {json_file}")

json_file = get_runfiles_dir() / f"{e.bazel_module}+" / e.target / "_build/needs/needs.json"

logger.debug(f"External needs.json: {json_file}")

Fixed in newest commit.

AlexanderLanin · 2026-02-04T09:51:17Z

src/extensions/score_metamodel/external_needs.py

-    else:
+    r = get_runfiles_dir()
+    if "ide_support.runfiles" in str(r):
        logger.error("Combo builds are currently only supported with Bazel.")


we need to add reference integration to consumer tests

We should yes.

github-actions · 2026-02-04T09:51:42Z

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

src/helper_lib/__init__.py

AlexanderLanin · 2026-02-04T09:53:51Z

src/helper_lib/test_helper_lib.py

+    os.environ["RUNFILES_DIR"] = str(runfiles_dir)
+    with pytest.raises(SystemExit) as e:
+        get_runfiles_dir()
+    assert "Could not find runfiles_dir" in str(e.value)


Oh thanks! I did now know I can keep the e for further asserts

Copilot

Pull request overview

This PR upgrades Bazel Python tooling (rules_python / score_tooling) and consolidates Bazel runfiles discovery by removing find_runfiles and moving the needed logic into helper_lib.

Changes:

Upgraded Bazel module deps (rules_python and score_tooling) and refreshed parts of the Python lockfile.
Removed src/find_runfiles and rewired extensions to use src.helper_lib.get_runfiles_dir.
Added new unit tests covering runfiles directory resolution behavior.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
`MODULE.bazel`	Upgrades `rules_python` and `score_tooling` to enable newer rules_python usage.
`src/requirements.in`	Adjusts Sphinx version constraint and minor formatting.
`src/requirements.txt`	Updates several pinned packages/hashes as part of dependency refresh.
`src/helper_lib/__init__.py`	Adds centralized `get_runfiles_dir()` using `python.runfiles.Runfiles`.
`src/helper_lib/test_helper_lib.py`	Adds tests for runfiles-dir discovery and fallback behavior.
`src/helper_lib/BUILD`	Adds `@rules_python//python/runfiles` dependency for the new helper logic.
`src/extensions/score_plantuml.py`	Switches PlantUML extension to use `helper_lib.get_runfiles_dir`.
`src/extensions/BUILD`	Adds `helper_lib` as a dep for the PlantUML extension target.
`src/extensions/score_metamodel/external_needs.py`	Switches external-needs path logic to use `helper_lib.get_runfiles_dir`.
`src/extensions/score_metamodel/BUILD`	Ensures `helper_lib` is available to the metamodel extension target.
`src/extensions/score_sphinx_bundle/BUILD`	Removes dependency on deleted `find_runfiles`, keeps `helper_lib`.
`src/BUILD`	Removes `find_runfiles` sources from aggregation; leaves a stale commented dep.
`src/find_runfiles/__init__.py`	Deleted (logic migrated to `helper_lib`).
`src/find_runfiles/test_find_runfiles.py`	Deleted (tests replaced by `helper_lib` tests).
`src/find_runfiles/BUILD`	Deleted (package removed).

src/requirements.txt

src/helper_lib/__init__.py

src/helper_lib/test_helper_lib.py

src/helper_lib/__init__.py

src/requirements.txt

src/BUILD

src/helper_lib/test_helper_lib.py

github-project-automation bot added this to INF - Infrastructure Community Feb 2, 2026

github-project-automation bot moved this to Draft in INF - Infrastructure Community Feb 2, 2026

RolandJentschETAS reviewed Feb 3, 2026

View reviewed changes

MaximilianSoerenPollak force-pushed the MSP_update_rules_py branch 2 times, most recently from 9441a7c to 6aaa96c Compare February 3, 2026 14:33

MaximilianSoerenPollak marked this pull request as ready for review February 3, 2026 14:42

MaximilianSoerenPollak requested review from AlexanderLanin, dcalavrezo-qorix and nradakovic as code owners February 3, 2026 14:42

MaximilianSoerenPollak added 11 commits February 4, 2026 10:36

Make everyone use find_runfiles

fedf49d

Change all 'os.getenv[RUNFILES]' to now use the find_runfiles file. This is in preperation for the rules_python upgrade which changes this implementation again.

Formatting

e6974cf

Pre-Rebase commit

c78ede9

Fix tests & git finder

6ed49d9

Testing Commit for Git Override

e0f12e4

Merging new main

4f916a4

Remove find_runfiles

d37ab5e

Add runfiles helper func to helper lib

b0bfe9f

Fix for esbonio

31648ae

Formatting & Cleanup

b3cb600

Cleanup

735a8fd

MaximilianSoerenPollak force-pushed the MSP_update_rules_py branch from 6aaa96c to 735a8fd Compare February 4, 2026 09:45

This was referenced Feb 4, 2026

Msp testing rules py upgrade #372

Closed

Fix compatibility with rules_python >= 1.5.0 #337

Closed

AlexanderLanin reviewed Feb 4, 2026

View reviewed changes

src/helper_lib/__init__.py Outdated Show resolved Hide resolved

AlexanderLanin reviewed Feb 4, 2026

View reviewed changes

AlexanderLanin requested a review from Copilot February 4, 2026 09:56

Copilot started reviewing on behalf of AlexanderLanin February 4, 2026 09:56 View session

Copilot AI reviewed Feb 4, 2026

View reviewed changes

MaximilianSoerenPollak added 2 commits February 4, 2026 11:22

Addressing PR comments

ca7b858

Fixing logging statement

8262414

AlexanderLanin approved these changes Feb 4, 2026

View reviewed changes

MaximilianSoerenPollak merged commit b0b3bc8 into eclipse-score:main Feb 4, 2026
13 of 14 checks passed

github-project-automation bot moved this from Draft to Done in INF - Infrastructure Community Feb 4, 2026

MaximilianSoerenPollak mentioned this pull request Feb 4, 2026

Build failed with updated dependency rules_python >= 1.5.0 #295

Closed

This was referenced Feb 10, 2026

Bug: sanitizers_functional_test.sh influences globally bazel build //:docs eclipse-score/communication#146

Closed

Communication's exports break ide_support eclipse-score/tooling#103

Closed

Update Rules_Py & Consolidate internal structure #378

Update Rules_Py & Consolidate internal structure #378

Uh oh!

Conversation

MaximilianSoerenPollak commented Feb 2, 2026

📌 Description

🚨 Impact Analysis

✅ Checklist

Uh oh!

github-actions bot commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

RolandJentschETAS Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

MaximilianSoerenPollak Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin commented Feb 4, 2026

Uh oh!

AlexanderLanin Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

MaximilianSoerenPollak Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

MaximilianSoerenPollak Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 4, 2026

Uh oh!

Uh oh!

AlexanderLanin Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Feb 2, 2026 •

edited

Loading