chore(known_good): bump score_docs_as_code to preview the stakeholder requirements report by antonkri · Pull Request #377 · eclipse-score/reference_integration

antonkri · 2026-09-29T12:23:07Z

What

Bumps score_docs_as_code in known_good.json to latest on main (47f686dcc802cfb89e6472c5fa9f05bfae5d550b), so the new Stakeholder Requirements chapter of the platform verification report can be seen in a real build, and adds/restructures the platform integration tests that feed testlinks into that chapter.

Companion PR: eclipse-score/docs-as-code#875 (merged)

Effect on the rendered docs

docs/verification_report/platform_verification_report.rst instantiates the template with :report_version: v1.0, so the new chapter appears above Features and is version-scoped to v1.0 stakeholder requirements. It renders two pie charts (status, test coverage) and a folded requirements table with the same columns as the per-feature requirements table.

Platform integration tests

Added platform_integration_tests/, driving each //showcases demo application on the deployed target image (Docker on linux-x86_64, QEMU on QNX x86_64) through the showcase entrypoint /showcases/bin/cli, and asserting it runs to completion.
Each showcase test is annotated with @add_test_properties(partially_verifies=[...]) pointing at the stakeholder requirement it demonstrates (communication, logging, execution model, health management, vehicle time). The decorator comes from ITF's own attribute_plugin wrapper (@score_itf//score/itf/plugins:attribute_plugin), matching the pattern in itf's own test_attribute_plugin.py, rather than wiring the score_tooling library in directly with a manual -p attribute_plugin flag.
Every showcase test lives in its own platform_integration_tests/<module> package (communication/, logging/, kyron/, lifecycle/, time/), each with a dedicated BUILD and py_itf_test target. //platform_integration_tests:pit is a test_suite collecting all five; the shared showcase-driving helper (showcase_runner.py) is a py_library used by all of them.
Run //platform_integration_tests:pit in the test_and_docs workflow, before the documentation build, so the source code linker picks up the testlinks from bazel-testlogs and the platform verification report shows the coverage.
Removed test_run_all_showcases from feature_integration_tests/itf/test_showcases.py: it ran every showcase via /showcases/bin/cli --examples=all, which is now redundant with (and duplicated the execution of) the per-module tests above.

Process steps followed

Ran python3 scripts/known_good/update_module_from_known_good.py after editing known_good.json; it regenerated bazel_common/score_modules_tooling.MODULE.bazel, which is committed here as well.
Ran bazel mod deps --lockfile_mode=update. It produced no diff for this bump, and MODULE.bazel.lock contains no score_docs_as_code entry or commit hash at all, so no lockfile change is expected for this bump.

Note on scope

The previously pinned hash a26274882b0ff41187e502c7bcdd26bbf5858232 was the pre-merge commit of the companion docs-as-code PR; it has since been merged to main as 47f686dcc802cfb89e6472c5fa9f05bfae5d550b, which is what's pinned now.

github-actions · 2026-09-29T12:55:05Z

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

…ments report Pins score_docs_as_code to a26274882b0ff41187e502c7bcdd26bbf5858232, which adds the "Stakeholder Requirements" chapter to the platform verification report template (eclipse-score/docs-as-code#875). main pins score_docs_as_code to the released version 8.3.0, but that release does not yet contain the stakeholder requirements chapter (the pinned commit is two commits ahead of v8.3.0). Until a release containing it exists, this overrides to the git commit via git_override instead of single_version_override. Regenerated bazel_common/score_modules_tooling.MODULE.bazel accordingly and updated MODULE.bazel.lock via `bazel mod tidy` to drop the score_docs_as_code 8.3.0 registry entries that no longer apply under the git_override.

Stakeholder requirements are platform-level and should be verified by platform-level tests, not by the feature integration tests (which verify individual `feat_req`). The `//showcases` demo applications are exactly such platform-level scenarios, so reference them as platform integration tests instead of rewriting them: * Add `platform_integration_tests/` with a `py_itf_test` that drives each showcase on the deployed target image (Docker on linux-x86_64) through the showcase entrypoint `/showcases/bin/cli` and asserts it runs to completion. * Annotate each test with `@add_test_properties(partially_verifies=[...])` pointing at the stakeholder requirement the showcase demonstrates (communication, logging, execution model, health management, vehicle time). `py_itf_test` does not register `attribute_plugin` (unlike `score_py_pytest`), so it is wired up in the BUILD file. * Run `//platform_integration_tests:pit` in the `test_and_docs` workflow, before the documentation build, so the source code linker picks up the testlinks from `bazel-testlogs` and the platform verification report shows the coverage.

PiotrKorkus

Blocking till DaC commit will be merged - eclipse-score/docs-as-code#875

PiotrKorkus · 2026-09-30T08:32:50Z

            "score_docs_as_code": {
                "repo": "https://github.com/eclipse-score/docs-as-code.git",
-                "version": "8.3.0"
+                "hash": "a26274882b0ff41187e502c7bcdd26bbf5858232"


lets keep unmerged commits away from ref_int.

AlexanderLanin · 2026-09-30T08:51:56Z

please keep DAC on official releases only

PiotrKorkus · 2026-09-30T08:50:06Z

+        "manual",
+    ],
+    deps = [
+        "@score_tooling//python_basics/score_pytest:attribute_plugin",


it should use ITF attrbute plugin https://github.com/eclipse-score/itf/blob/main/test/integration/test_attribute_plugin.py

PiotrKorkus · 2026-09-30T08:50:40Z

+_CLI = "/showcases/bin/cli"
+
+
+def _run_showcases(target, *names: str) -> None:


make it a helper function in separate file

PiotrKorkus · 2026-09-30T08:51:48Z

+    test_type="interface-test",
+    derivation_technique="requirements-analysis",
+)
+def test_communication_showcase(target):


For better maintenance, I would suggest to create a separate file for each Module - communcation, logging etc. Then it is easily expandable.

PiotrKorkus · 2026-09-30T08:53:50Z

+    deps = [
+        "@score_tooling//python_basics/score_pytest:attribute_plugin",
+    ],
+)


once all Modules are splitted across files - create separate py_itf target as well. Finally collect all in single PIT test_suite

antonkri · 2026-09-30T09:03:54Z

reopend as draft

…odule packages - Move each showcase test into its own platform_integration_tests/<module> folder with a dedicated BUILD and py_itf_test target. - Turn platform_integration_tests:pit into a test_suite collecting the per-module targets; showcase_runner becomes a shared py_library. - Widen images/linux_x86_64:image_load visibility to __subpackages__. - Remove the duplicated test_run_all_showcases from feature_integration_tests/itf, now redundant with platform_integration_tests.

PiotrKorkus

test part looks good, @AlexanderLanin please check DaC version

antonkri · 2026-09-30T12:23:53Z

@AlexanderLanin

we now use "the official" commit from main. If it is ok, please approve. If you want us to use a real release, please create a new version in docs-as-code. Thank you!

antonkri requested review from AlexanderLanin, FScholPer, MaximilianSoerenPollak, PiotrKorkus, dcalavrezo-qorix, lurtz, nradakovic, opajonk and pawelrutkaq as code owners September 29, 2026 12:23

antonkri force-pushed the feat/platform-report-stakeholder-requirements branch 2 times, most recently from 4be00d8 to bb5b695 Compare September 29, 2026 15:23

antonkri marked this pull request as draft September 30, 2026 06:14

antonkri force-pushed the feat/platform-report-stakeholder-requirements branch 3 times, most recently from dfd3c08 to 891860c Compare September 30, 2026 07:25

antonkri added 2 commits September 30, 2026 08:02

antonkri force-pushed the feat/platform-report-stakeholder-requirements branch from 891860c to 4442ada Compare September 30, 2026 08:02

PiotrKorkus requested changes Sep 30, 2026

View reviewed changes

AlexanderLanin closed this Sep 30, 2026

PiotrKorkus reviewed Sep 30, 2026

View reviewed changes

antonkri reopened this Sep 30, 2026

antonkri added 3 commits September 30, 2026 11:02

refactor pits

aaca40f

chore(known_good): bump score_docs_as_code to the merged main commit

12d2179

PiotrKorkus approved these changes Sep 30, 2026

View reviewed changes

antonkri marked this pull request as ready for review September 30, 2026 13:28

Navigation Menu

chore(known_good): bump score_docs_as_code to preview the stakeholder requirements report - #377

chore(known_good): bump score_docs_as_code to preview the stakeholder requirements report#377
antonkri wants to merge 5 commits into
mainfrom
feat/platform-report-stakeholder-requirements

antonkri commented Sep 29, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Sep 29, 2026

Uh oh!

PiotrKorkus left a comment

Uh oh!

PiotrKorkus Sep 30, 2026

Uh oh!

AlexanderLanin commented Sep 30, 2026

Uh oh!

PiotrKorkus Sep 30, 2026

Uh oh!

PiotrKorkus Sep 30, 2026

Uh oh!

PiotrKorkus Sep 30, 2026

Uh oh!

PiotrKorkus Sep 30, 2026

Uh oh!

antonkri commented Sep 30, 2026

Uh oh!

PiotrKorkus left a comment

Uh oh!

antonkri commented Sep 30, 2026

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		_CLI = "/showcases/bin/cli"


		def _run_showcases(target, *names: str) -> None:

Conversation

antonkri commented Sep 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Effect on the rendered docs

Platform integration tests

Process steps followed

Note on scope

Uh oh!

github-actions Bot commented Sep 29, 2026

Uh oh!

PiotrKorkus left a comment

Choose a reason for hiding this comment

Uh oh!

PiotrKorkus Sep 30, 2026

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin commented Sep 30, 2026

Uh oh!

PiotrKorkus Sep 30, 2026

Choose a reason for hiding this comment

Uh oh!

PiotrKorkus Sep 30, 2026

Choose a reason for hiding this comment

Uh oh!

PiotrKorkus Sep 30, 2026

Choose a reason for hiding this comment

Uh oh!

PiotrKorkus Sep 30, 2026

Choose a reason for hiding this comment

Uh oh!

antonkri commented Sep 30, 2026

Uh oh!

PiotrKorkus left a comment

Choose a reason for hiding this comment

Uh oh!

antonkri commented Sep 30, 2026

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

antonkri commented Sep 29, 2026 •

edited

Loading