Playground/bitmanipulation seooc lobster report - #775
Draft
antonkri wants to merge 5 commits into
Draft
Conversation
Renders a pre-built Lobster traceability JSON report (e.g. from dependable_element()/component()) as an HTML table with real sphinx-needs cross-references to Component Requirement and GoogleTest testcase needs, mirroring score_source_code_linker's disk-scan pattern to avoid Bazel testonly propagation into the docs build.
…oss-references
Previously the lobster-traceability-report directive only rendered the
Component Requirements / Unit Test pools; all other pools (Feature
Requirements, Forwarded AoUs, Architecture, Public API, Failure Modes,
Control Measures, Root Causes) were missing entirely.
- Render every pool ('level') found in the JSON report generically, with
no per-pool hard-coding, so new/renamed pools show up automatically.
- Give every item a stable internal anchor (lobster-item-<sha1(tag)>) and
turn every refs/ref_up/ref_down entry into a clickable link to that
anchor, mirroring the cross-linking already used by
dependable_element's own separately-generated traceability_report.
- Where an item is itself a genuine requirement registered as a real
Sphinx-needs element elsewhere in the docs (feat_req/comp_req/aou_req/
tool_req/stkh_req), link it with :need: instead of a report-local
anchor, same as Component Requirements already did.
antonkri
requested review from
AlexanderLanin,
MaximilianSoerenPollak,
a-zw,
dcalavrezo-qorix and
nradakovic
as code owners
August 31, 2026 06:40
antonkri
marked this pull request as draft
August 31, 2026 06:40
Contributor
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //src:license-checkStatus: Click to expand output |
Adds an alternative producer for test links that reads the *.lobster activity pools emitted by lobster-gtest instead of scanning bazel-testlogs/**/test.xml. This is a drop-in replacement for xml_parser.run_xml_parser: it writes the same two caches (score_testcaseneeds_cache.json, score_xml_parser_cache.json), so the combining/repo-grouping/injection steps stay untouched. Selected via a new docs(testlink_source = "xml"|"lobster"|"none") attribute, wired through TESTLINK_SOURCE / --define=score_testlink_source to a new score_testlink_source Sphinx config value. Known fidelity losses versus the XML producer, both inherent to lobster-gtest itself: failed-test messages are dropped (no result_text), and skipped tests are reported as passed (lobster-gtest only inspects the <failure> element). Verified against the bitmanipulation SEooC PoC in baselibs: both modes produce byte-identical needs.json (503 needs, 0 testlink/source_code_link diffs) and identical testlink caches (43 entries).
Unit test links rendered the generated need id (e.g. testcase__CheckBit__WithUInt64_acmyg) as their link text. Its repeated double underscores sit on the text baseline, where they visually merge with the browsers own link-underline decoration - the links looked like they had several stacked lines under them. _need_ref() now takes an optional display argument, rendering RSTs explicit :need:`text <id>` link-text syntax. Unit test links pass the Lobster reports own name field (e.g. CheckBit:WithUInt64), which is the original colon-separated JUnit suite:case spelling that _unit_test_need_id() only converts to __ form to reconstruct the id. Requirement links (component/feature/AoU/tool/stakeholder) are deliberately left alone: their double underscores are the projects own id naming convention, and no separate human-readable title exists in the Lobster JSON to substitute.
Render the report along the direction of decomposition instead of pool by pool, so it reads like the traceability argument it documents: - New "Feature Requirements <-> Component Requirements" section, placed before "Component Requirements <-> Unit Tests". - Coverage pie charts (inline SVG, no new dependency) for both of those sections and for Architecture, each centered above its table. - All tables wrapped in a <details>/<summary> block, collapsed by default. A small script opens the enclosing <details> when a "#lobster-item-..." anchor is navigated to, so cross-links keep working. - The four FMEA/FTA pools (Public API, Failure Modes, Control Measures, Root Causes) are joined into one "Safety Analysis" table with one row per root cause, since on their own each is just a list of names whose meaning only emerges from the chain. A root cause is linked to its failure mode via the fault tree file they share; items repeated across rows are spelled out once and then shown by name only.
Contributor
|
Mark this as |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📌 Description
🚨 Impact Analysis
✅ Checklist