Skip to content

docs: link Communication's dependable_element verification reports - #378

Draft
antonkri wants to merge 1 commit into
mainfrom
ankr_integration_comm_report
Draft

antonkri wants to merge 1 commit into
mainfrom
ankr_integration_comm_report

Conversation

@antonkri

Copy link
Copy Markdown
Contributor

What

Links the verification reports that Communication generates for its dependable
elements from the module verification report index.

docs/verification_report/modules/index.rst now has two sections:

  • Reports built into this site — the existing docs-as-code based reports
    (Baselibs, Lifecycle, Logging, Persistency), unchanged.
  • Reports generated outside docs-as-code — a table linking Communication's
    mw_com (LoLa) and message_passing dependable element reports plus their
    L.O.B.S.T.E.R. traceability reports.

Why not mount them?

Communication does not describe its safety case with docs-as-code. It uses the
dependable_element rule from
eclipse-score/tooling, which emits a
self-contained multi-page report (architecture, components, units, assumed system,
LOBSTER traceability over feature requirements / failure modes / control measures /
root causes) and publishes it to Communication's own GitHub Pages site.

Pulling those pages into this site is currently not possible:

  • the generated doc targets are testonly, and a non-testonly docs target cannot
    depend on them;
  • dependable_element only defaults to testonly = True — but setting
    testonly = False does not help, because a dependable element's deps reference
    the <name> target of other dependable elements, and that target is declared as a
    Bazel test rule, which is unconditionally testonly;
  • for message_passing it is moot anyway, since it declares real test dependencies.

Resolving this requires a change in eclipse-score/tooling. Until then, linking is
the pragmatic option; this is called out in a note on the page.

Caveat (also noted on the page)

The links point at Communication's latest docs, which track its main branch —
they are not pinned to the Communication revision in known_good.json.

Verification

All four target URLs return HTTP 200. Docs-only change, no Bazel targets touched.

Communication does not use docs-as-code for its safety case; it generates
self-contained reports (incl. LOBSTER traceability) via the
dependable_element rule from eclipse-score/tooling and publishes them on
its own GitHub Pages site.

Split the module verification report index into reports built into this
site and reports generated outside docs-as-code, and link the mw_com and
message_passing reports in the latter section.

Mounting them is currently not possible: the generated targets are
testonly (deps reference other dependable elements' test rules), so a
non-testonly docs target cannot depend on them.
@github-actions

Copy link
Copy Markdown

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

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant