Improve check_id_format #192

Aymen-Soussi-01 · 2025-07-31T12:09:39Z

Improve check_id_format by adding parts option in the metamodel and removing the hardcoded need in the check, then adapt tests

close: #145

github-actions · 2025-07-31T12:10:58Z

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]
2025/08/11 10:01:40 Downloading https://releases.bazel.build/8.3.0/release/bazel-8.3.0-linux-x86_64...
Extracting Bazel installation...
Starting local Bazel server (8.3.0) and connecting to it...
INFO: Invocation ID: ace25af9-e89b-4b4b-82d9-d2a4887dcb8b
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
Analyzing: target //src:license-check (1 packages loaded)
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 (69 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (115 packages loaded, 2216 targets configured)

Analyzing: target //src:license-check (126 packages loaded, 2412 targets configured)

INFO: Analyzed target //src:license-check (129 packages loaded, 4428 targets configured).
[7 / 13] Creating runfiles tree bazel-out/k8-opt-exec-ST-d57f47055a04/bin/external/score_dash_license_checker+/tool/formatters/dash_format_converter.runfiles [for tool]; 0s local ... (2 actions, 1 running)
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: 12.807s, Critical Path: 0.38s
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 <args omitted>
[main] INFO Querying Eclipse Foundation for license data for 84 items.
[main] INFO Found 58 items.
[main] INFO Querying ClearlyDefined for license data for 26 items.
[main] ERROR Error response from ClearlyDefined 429

AlexanderLanin · 2025-07-31T17:17:15Z

src/extensions/score_metamodel/checks/attributes_format.py

+    if id_parts_len != expected_parts:
+        if expected_parts == 2:
+            msg = "expected to consist of this format: `<Req Type>__<Abbreviations>`."
+        else:


Suggested change

else:

elif expected_parts == 3:

and some generic else afterwards. Either generic or some error.

Fixed. Please resolve.

MaximilianSoerenPollak · 2025-08-01T07:42:30Z

src/extensions/score_metamodel/checks/attributes_format.py

+
+    if id_parts_len != expected_parts:
+        if expected_parts == 2:
+            msg = "expected to consist of this format: `<Req Type>__<Abbreviations>`."


Think it also would make sense to say it in more plain english as well?
Like:
expected to consist of this format: <Req Type>__<Abbreviations>. Only one '__' is allowed in this need type

Fixed. Please resolve.

MaximilianSoerenPollak · 2025-08-05T07:28:52Z

The list as described in the Metamodel is correct. (Looked through together with Process).

Will now this coming Thursday (7.08) fix errors in Process & Score.

MaximilianSoerenPollak · 2025-08-05T07:29:02Z

/consumer-test

MaximilianSoerenPollak · 2025-08-06T08:03:42Z

/consumer-test

MaximilianSoerenPollak · 2025-08-07T13:44:57Z

@Aymen-Soussi-01 could you maybe put an exception into the 'feature_id' check for example_feature ?
THis is the error I'd like to help

process_areas/architecture_design/architecture_getstrt.rst:225: WARNING: comp_arc_sta__example_feature__component_manual_getstrt.id (comp_arc_sta__example_feature__component_manual_getstrt): Featurepart '['example', 'feature']' not in path 'process_areas/architecture_design' or abbreviation not ok, expected: 'ef'. [score_metamodel]

AlexanderLanin · 2025-08-07T14:00:52Z

Why don't they use comp_arc_sta__architecture_design__component_manual_getstrt_example? Mhh well yeah, that's not a good example :D

Should we exclude "example_feature"? Or even "example_*"? Only in process repo? Only for this one check?

MaximilianSoerenPollak · 2025-08-07T14:08:26Z

Why don't they use comp_arc_sta__architecture_design__component_manual_getstrt_example? Mhh well yeah, that's not a good example :D

Should we exclude "example_feature"? Or even "example_*"? Only in process repo? Only for this one check?

Probably example_*? though not sure.

I guess this needs to be discussed.
I would not make it specific to process only though.

MaximilianSoerenPollak · 2025-08-08T12:15:53Z

@Aymen-Soussi-01 Can you add this to this PR too?

@local_check
def check_id_length(app: Sphinx, need: NeedsInfoType, log: CheckLogger):
    """
    Validates that the requirement ID does not exceed the hard limit of 45 characters.
    While the recommended limit is 30 characters, this check enforces a strict maximum
    of 45 characters.
    If the ID exceeds 45 characters, a warning is logged specifying the actual length.
    Any examples that are required to have 3 parts (2x'__') have an exception, and get 16 extra characters
    to compensate for the lenght of `example_feature` that would be replaced by actually feature names.
    ---
    """
    max_lenght = 45
    parts = need["id"].split("__")
    if parts[1] == "example_feature":
        max_lenght += 15 # '_example_feature_'
    if len(need["id"]) > max_lenght:
        msg = (
            f"exceeds the maximum allowed length of 45 characters "
            f"(current length: {len(need['id'])})."
        )
        log.warning_for_option(need, "id", msg)

this is also in 'id_contains.py' I think

MaximilianSoerenPollak · 2025-08-08T13:20:23Z

src/extensions/score_metamodel/checks/attributes_format.py

+    max_lenght = 45
+    parts = need["id"].split("__")
+    if parts[1] == "example_feature":
+        max_lenght += 15 # '_example_feature_'


Suggested change

max_lenght += 15 # '_example_feature_'

max_lenght += 15 # 'example_feature'

Forgot to change it here too, I only did it in the desc. Sorry

Fixed. Please resolve.

MaximilianSoerenPollak · 2025-08-08T13:21:08Z

src/extensions/score_metamodel/checks/attributes_format.py

+    if len(need["id"]) > max_lenght:
        msg = (
            f"exceeds the maximum allowed length of 45 characters "
            f"(current length: {len(need['id'])})."


Oh and we probably need to also remove the 15 lenghts from the length here if the part[1] is 'example_feature` otherwise in those cases this error will be off by 15.

God, so much missed on my part. Sorry

Fixed. Please resolve.

…emoving the hardcoded need in the check, then adapt tests

github-actions · 2025-08-11T09:11:53Z

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

MaximilianSoerenPollak · 2025-08-11T09:17:16Z

/consumer-test

AlexanderLanin · 2025-08-11T09:27:47Z

src/extensions/score_metamodel/checks/id_contains_feature.py


    # Get the part of the string after the first two underscores: the path
    feature = parts[1]
+    if feature == "example_feature":


Should we add a "note" to the requirements? separate PR

#201 We have to fix many links anyway that are currently scattered everywhere

AlexanderLanin

LGTM except override

MaximilianSoerenPollak · 2025-08-11T10:02:14Z

Tests & Building of Docs passed locally with git override to Process PR.

Should be all fine now I would say.

MaximilianSoerenPollak · 2025-08-11T10:05:46Z

@AlexanderLanin you should be able to approve it.

Aymen-Soussi-01 requested review from AlexanderLanin, MaximilianSoerenPollak and dcalavrezo-qorix as code owners July 31, 2025 12:09

github-project-automation bot added this to Infrastructure Jul 31, 2025

github-project-automation bot moved this to Draft in Infrastructure Jul 31, 2025

Aymen-Soussi-01 requested a review from nicu1989 July 31, 2025 12:10

Aymen-Soussi-01 self-assigned this Jul 31, 2025

AlexanderLanin reviewed Jul 31, 2025

View reviewed changes

MaximilianSoerenPollak reviewed Aug 1, 2025

View reviewed changes

Aymen-Soussi-01 mentioned this pull request Aug 6, 2025

Remove check id format and change it with regex check in the metamode… #186

Closed

MaximilianSoerenPollak mentioned this pull request Aug 7, 2025

Changed ID according to new rules eclipse-score/process_description#146

Merged

MaximilianSoerenPollak reviewed Aug 8, 2025

View reviewed changes

Aymen-Soussi-01 and others added 7 commits August 11, 2025 10:57

Improve check_id_format by adding parts option in the metamodel and r…

d2236b9

…emoving the hardcoded need in the check, then adapt tests

Fix Review comments

01a4830

Fix small spelling issue

dcd9384

handle example_feature case in check_id_length

0b78b91

change example_feature comment

25f063a

clean special cases for check_id_length

8d7aeb5

Adding exceptions for example_feature

b84e9ff

MaximilianSoerenPollak force-pushed the improve-check-id-format branch from 390c2ef to b84e9ff Compare August 11, 2025 08:58

Fixing IDs

41dca31

Formatting

c7ff1f2

AlexanderLanin reviewed Aug 11, 2025

View reviewed changes

Remove git override

1403785

AlexanderLanin reviewed Aug 11, 2025

View reviewed changes

MaximilianSoerenPollak added 2 commits August 11, 2025 11:52

Prep for release

02553e3

Fixing formatting

9cc0388

MaximilianSoerenPollak requested a review from AlexanderLanin August 11, 2025 10:02

AlexanderLanin approved these changes Aug 11, 2025

View reviewed changes

MaximilianSoerenPollak merged commit 9a8eced into eclipse-score:main Aug 11, 2025
4 of 7 checks passed

github-project-automation bot moved this from Draft to Done in Infrastructure Aug 11, 2025

	max_lenght += 15 # '_example_feature_'
	max_lenght += 15 # 'example_feature'

Improve check_id_format #192

Improve check_id_format #192

Uh oh!

Conversation

Aymen-Soussi-01 commented Jul 31, 2025

Uh oh!

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

Uh oh!

License Check Results

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MaximilianSoerenPollak Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MaximilianSoerenPollak commented Aug 5, 2025

Uh oh!

MaximilianSoerenPollak commented Aug 5, 2025

Uh oh!

MaximilianSoerenPollak commented Aug 6, 2025

Uh oh!

MaximilianSoerenPollak commented Aug 7, 2025

Uh oh!

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

Uh oh!

Uh oh!

MaximilianSoerenPollak commented Aug 7, 2025

Uh oh!

MaximilianSoerenPollak commented Aug 8, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 11, 2025

Uh oh!

MaximilianSoerenPollak commented Aug 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin left a comment

Choose a reason for hiding this comment

Uh oh!

MaximilianSoerenPollak commented Aug 11, 2025

Uh oh!

MaximilianSoerenPollak commented Aug 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Jul 31, 2025 •

edited

Loading

AlexanderLanin Jul 31, 2025 •

edited

Loading

MaximilianSoerenPollak Aug 1, 2025 •

edited

Loading

AlexanderLanin commented Aug 7, 2025 •

edited

Loading