analysis/tracing: add canary requirement and test links by Nikhil2206 · Pull Request #581 · eclipse-score/baselibs

Nikhil2206 · 2026-09-11T08:07:14Z

Summary

#554
Author the missing analysis/tracing component requirement and link all 24 canary wrapper tests to it.

The requirement covers canary-protected data integrity: wrapping arbitrary data with configurable canaries, detecting corruption at either boundary, and reporting corrupted data as unavailable.

Changes

Added comp_req__analysis_tracing__canary_protected_data_integrity.
Added the analysis/tracing documentation bundle and root component wiring.
Added required RecordProperty metadata to all 24 canary wrapper tests.
Covered nominal construction/access, 32-bit and 64-bit canaries, layout, copy/move state propagation, and injected start/end/both-canary corruption.

Traceability

All tests use PartiallyVerifies, Description, TestType, and DerivationTechnique. Deliberately corrupted canary tests use fault-injection; boundary-validity cases use boundary-values.

The requirement derives from feat_req__com__data_corruption[version==1], which requires protection against corruption of data consumed by higher-criticality partners.

Remove the newly authored comp_req__analysis_tracing__canary_integrity and its requirements/index.rst; this PR should not introduce a new component requirement. Keep the architecture doc and docs bundle wiring in place, and leave the tests' RecordProperty traceability metadata (including the PartiallyVerifies reference) untouched for a future PR to properly connect once the requirement is authored.

Add score/analysis:docs bundle (mount_at baselibs/components/analysis) so score/analysis/tracing:docs has a valid attach point, matching the score/language parent/child mount pattern. This fixes the docs-verify CI failure (mounts.attach_to_missing / toc.not_included). Restore comp_req__analysis_tracing__canary_integrity and its requirements/index.rst, which a prior commit deleted while leaving all 24 canary_wrapper_test.cpp PartiallyVerifies links pointing at it. Per the requirements-management skill, linked tests must point at an existing comp_req.

github-actions · 2026-09-28T06:39:40Z

Documentation preview for this pull request is available at:
pr-581: https://eclipse-score.github.io/baselibs/pr-581/

Copilot

Copilot review overview

🟡 Changes recommended

The normative requirement overstates configurability, and the PR’s requirement ID, metadata claims, and linked issue are inconsistent with the changes.

Review effort: Balanced
Findings: 1 · 3

Open (4)

Canary values are not configurable as required · New
Linked issue does not match the affected analysis/tracing scope · New
Boundary-validity metadata does not match the PR description · New
Requirement ID differs between PR description and test links · New

What changed in this PR

Adds requirements traceability and documentation integration for the Analysis Tracing canary wrapper.

Changes:

Defines the canary-integrity component requirement and architecture.
Links 24 canary tests with verification metadata.
Wires Analysis Tracing documentation into the root bundle.

File	Description
`score/analysis/tracing/docs/requirements/index.rst`	Defines the canary requirement.
`score/analysis/tracing/docs/index.rst`	Adds the component documentation entry point.
`score/analysis/tracing/docs/architecture/index.rst`	Defines the architecture component.
`score/analysis/tracing/common/canary_wrapper/test/canary_wrapper_test.cpp`	Adds requirement metadata to 24 tests.
`score/analysis/tracing/BUILD`	Creates the tracing documentation bundle.
`score/analysis/docs/index.rst`	Adds the analysis documentation root.
`score/analysis/BUILD`	Creates the analysis documentation bundle.
`docs/baselibs/components/index.rst`	Lists Analysis Tracing in the component overview.
`BUILD`	Mounts the new documentation bundles.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

+   :tags: inspected
+   :satisfied_by: comp__baselibs_analysis_tracing[version==1]
+
+   The Analysis Tracing component shall wrap arbitrary data with configurable start and end canary values, detect corruption of either canary during data access, and report corrupted data as unavailable.


+            "bundle": "//score/analysis:docs",
+            "mount_at": "baselibs/components/analysis",


+    RecordProperty("Description",
+                   "Check that corrupting only the start canary is rejected while the end canary remains valid.");
+    RecordProperty("TestType", "fault-injection");
+    RecordProperty("DerivationTechnique", "equivalence-classes");


+=======================
+
+.. comp_req:: Canary-Protected Data Integrity
+   :id: comp_req__analysis_tracing__canary_integrity


4og · 2026-09-28T09:02:19Z

+   :reqtype: Functional
+   :security: YES
+   :safety: ASIL_B
+   :derived_from: feat_req__com__data_corruption[version==1]


Introducing a component requirement for analysis/tracing is fine, but it's not fine to link to some feature requirement of communication. I think we should introduce a proper feature requirement in baselibs.
@hoppe-and-dreams, what's your opinion?

Yes, the Tracing topic is a bit scattered (it has parts in baselibs, parts in com and parts in logging). But since we defined clear APIs/work splits the requriments should also be split along those lines.

Looping in @andreapefe what's the status of bringing the tracing requirements?

Bringing the full tracing requirements into SCORE has been postponed until Jan 2027.
We could think of bringing in the baselibs subset which only concerns the public API earlier if necessary.
In any case, the requirements here are not really matching my expectation in terms of content.

@4og and @Nikhil2206 we can sync on what exactly you need when and see what we can provide, then create a specific task out of it.

- Narrow the canary requirement wording to the supported 32-bit/64-bit widths instead of claiming configurable canary values (values are fixed private constants in canary_wrapper.h). - Correct DerivationTechnique to boundary-values for the three boundary-validity tests (single-canary and both-canary edge cases). - Remove :tags: inspected per review request.

anmittag · 2026-09-30T11:32:38Z

@Nikhil2206 please check the review findings

Nikhil2206 · 2026-10-01T06:46:40Z

Closing per discussion with @anmittag and @andreapf853 — the canary wrapper isn't part of the public interface anymore and is slated for removal, so a standalone requirement for it isn't the right path forward. Proper feature + component requirements for analysis/tracing (treating the baselibs portion as a single component, modeled on mw/log's requirements) will be authored separately, targeting end of November for S-CORE 1.0. Happy to pick this back up once that structure lands.

analysis tracing: add canary requirements and test links

b5fa196

Nikhil2206 requested review from 4og, antonkri, arkjedrz, aschemmel-tech, fbaeuerle and pawelrutkaq as code owners September 11, 2026 08:07

github-project-automation Bot added this to BAS - Baselibs FT Sep 11, 2026

github-project-automation Bot moved this to In Progress in BAS - Baselibs FT Sep 11, 2026

Nikhil2206 requested a deployment to workflow-approval September 11, 2026 08:07 — with GitHub Actions Waiting

github-actions Bot added documentation Improvements or additions to documentation comp-tracing Related to score/analysis c++ C++ code bazel Bazel and Starlark build files labels Sep 11, 2026

Nikhil2206 closed this Sep 11, 2026

github-project-automation Bot moved this from In Progress to Done in BAS - Baselibs FT Sep 11, 2026

Nikhil2206 reopened this Sep 11, 2026

Nikhil2206 requested a deployment to workflow-approval September 11, 2026 08:23 — with GitHub Actions Waiting

Nikhil2206 closed this Sep 11, 2026

Nikhil2206 reopened this Sep 11, 2026

Nikhil2206 requested a deployment to workflow-approval September 11, 2026 08:23 — with GitHub Actions Waiting

Nikhil2206 requested a deployment to workflow-approval September 24, 2026 10:48 — with GitHub Actions Waiting

Nikhil2206 marked this pull request as ready for review September 25, 2026 08:26

Merge branch 'main' into nk-analysis-tracing-test-req-trace

355150d

Nikhil2206 requested a deployment to workflow-approval September 25, 2026 08:27 — with GitHub Actions Waiting

Nikhil2206 deployed to workflow-approval September 28, 2026 06:25 — with GitHub Actions Active

4og requested a balanced review from Copilot September 28, 2026 08:57

Copilot started reviewing on behalf of 4og September 28, 2026 08:57 View session

Copilot AI reviewed Sep 28, 2026

View reviewed changes

4og requested changes Sep 28, 2026

View reviewed changes

Nikhil2206 requested a deployment to workflow-approval September 30, 2026 08:55 — with GitHub Actions Waiting

Merge upstream/main into nk-analysis-tracing-test-req-trace

4c10ecb

Nikhil2206 requested a deployment to workflow-approval September 30, 2026 09:34 — with GitHub Actions Waiting

Navigation Menu

analysis/tracing: add canary requirement and test links - #581

analysis/tracing: add canary requirement and test links#581
Nikhil2206 wants to merge 11 commits into
eclipse-score:mainfrom
Nikhil2206:nk-analysis-tracing-test-req-trace

Nikhil2206 commented Sep 11, 2026 •

edited by 4og

Loading

Uh oh!

github-actions Bot commented Sep 28, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

4og Sep 28, 2026

Uh oh!

hoppe-and-dreams Sep 28, 2026

Uh oh!

andreapefe Sep 29, 2026

Uh oh!

anmittag commented Sep 30, 2026

Uh oh!

Nikhil2206 commented Oct 1, 2026

Uh oh!

This branch is waiting to be deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

		"bundle": "//score/analysis:docs",
		"mount_at": "baselibs/components/analysis",

Conversation

Nikhil2206 commented Sep 11, 2026 • edited by 4og Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Traceability

Uh oh!

github-actions Bot commented Sep 28, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

4og Sep 28, 2026

Choose a reason for hiding this comment

Uh oh!

hoppe-and-dreams Sep 28, 2026

Choose a reason for hiding this comment

Uh oh!

andreapefe Sep 29, 2026

Choose a reason for hiding this comment

Uh oh!

anmittag commented Sep 30, 2026

Uh oh!

Nikhil2206 commented Oct 1, 2026

Uh oh!

This branch is waiting to be deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Nikhil2206 commented Sep 11, 2026 •

edited by 4og

Loading