Skip to content

docs: add Unit Test work product for mw::log backend - #376

Draft
Y-Vaishnavi wants to merge 1 commit into
eclipse-score:mainfrom
Y-Vaishnavi:vy/log-backend-unit-test-traceability
Draft

Y-Vaishnavi wants to merge 1 commit into
eclipse-score:mainfrom
Y-Vaishnavi:vy/log-backend-unit-test-traceability

Conversation

@Y-Vaishnavi

Copy link
Copy Markdown
Contributor

What

Completes the Unit Test work product (wp__verification_sw_unit_test) for the log_backend component by adding a formal .. document:: page that :realizes: wp__verification_sw_unit_test.

Why

The module safety plan's work-product table had a placeholder <Link to WP> for wp__verification_sw_unit_test. The gTest unit tests already exist under score/mw/log/ (detail/common, syslog, slog, data_router, file_recorder, wait_free_producer_queue, signal_handling, backend, legacy_non_verbose_api, test), but there was no formal documentation page tying them to the work product.

Changes

  • Added docs/components/mw_log/detailed_design/unit_test.rst: new document:: page (doc__mw_log_backend_unit_test) describing and linking all unit test suite locations for the component.
  • Added it to the detailed_design toctree.
  • Replaced the <Link to WP> placeholder in docs/module/safety_mgt/module_safety_plan.rst with a reference to the new doc.

Validation

  • bazel run //:docs — build succeeds.
  • bazel run //:docs_check — passes with only 4 pre-existing, unrelated warnings (architecture fulfils linkage in a different file).
  • Verified the rendered page in browser: sidebar entry appears under Component Documentation → mw::log Backend → Detailed Design → Unit Test, and the safety plan table now resolves the link correctly.

Fixes #231

Adds a formal document:: page realizing wp__verification_sw_unit_test
for the log_backend component, linking the existing gTest unit test
suites under score/mw/log/ to the work product. Replaces the
placeholder '<Link to WP>' entry in the module safety plan with a
reference to the new doc.

Fixes eclipse-score#231
@github-actions

Copy link
Copy Markdown
Contributor

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: 7dc0702b-8e90-43be-88cb-6c22c5b30cba
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 4 packages loaded
DEBUG: /home/runner/.bazel/external/score_docs_as_code+/docs.bzl:716:14: INFO: ⚠️ DEPRECATED: Passing a Needs inventory through docs(data = [...]) is deprecated!!! Move it to external_needs = [...] instead.
WARNING: Target pattern parsing failed.
ERROR: Skipping '//:license-check': no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/logging/logging/BUILD
ERROR: no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/logging/logging/BUILD
INFO: Elapsed time: 15.532s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

:need:`gd_guidl__verification_guide`, and are integrated into the CI build so
that they run on every change.

Unit Test Suites

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not ideal to list every test target here again. I would suggest to provide a landing page that navigates to all in one link. Otherwise its a maintenance effort!

@rmaddikery rmaddikery left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This branch is waiting to be deployed

1 waiting deployment
workflow-approval — bd72678c Waiting Oct 26, 2026 by Y-Vaishnavi via qnx-build (arm64-qnx) / approval #1262
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

[comp log_backend] Unit Test completion

2 participants