From 352f15e4ef744c9ae799a567970f3efa3816c5f9 Mon Sep 17 00:00:00 2001 From: Andreas Zwinkau Date: Fri, 19 Jun 2026 10:59:55 +0200 Subject: [PATCH 1/3] feat: render traceability on a page --- docs/internals/requirements/index.rst | 3 ++ .../requirements/requirement_coverage.rst | 53 +++++++++++++++++++ 2 files changed, 56 insertions(+) create mode 100644 docs/internals/requirements/requirement_coverage.rst diff --git a/docs/internals/requirements/index.rst b/docs/internals/requirements/index.rst index 0a7513742..01ccf2655 100644 --- a/docs/internals/requirements/index.rst +++ b/docs/internals/requirements/index.rst @@ -30,6 +30,8 @@ Pages - ``tooling_verification`` describes verification evidence for the tooling itself, including test results and testcase metadata. +- ``requirement_coverage`` shows per-requirement test and code linkage, + using the same metrics as CI quality gates. .. toctree:: :maxdepth: 1 @@ -37,4 +39,5 @@ Pages capabilities process_overview requirements + requirement_coverage tooling_verification diff --git a/docs/internals/requirements/requirement_coverage.rst b/docs/internals/requirements/requirement_coverage.rst new file mode 100644 index 000000000..675b037ba --- /dev/null +++ b/docs/internals/requirements/requirement_coverage.rst @@ -0,0 +1,53 @@ +.. + # ******************************************************************************* + # Copyright (c) 2026 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License Version 2.0 which is available at + # https://www.apache.org/licenses/LICENSE-2.0 + # + # SPDX-License-Identifier: Apache-2.0 + # ******************************************************************************* + +.. _docs_requirement_coverage: + +Requirement Test Coverage +========================= + +This page shows which requirements are linked to tests and which have code +links. +The numbers shown here come from the same ``score_metrics`` calculations used +by CI quality gates — they will always match. + +Overall Coverage +---------------- + +.. needpie:: Overall Requirement Coverage + :labels: Remaining (no selected links), With Test Link, With Code Link, Fully Linked + :colors: #4E79A7, #F28E2B, #59A14F, #B07AA1 + :filter-func: score_metrics.sphinx_filters.get_metrics_with_first_value_total(overall_metrics:total,overall_metrics:with_test_link,overall_metrics:with_code_link,overall_metrics:fully_linked) + +.. needpie:: Test Linkages + :labels: Tests Linked, Tests Not Linked + :colors: #59A14F, #4E79A7 + :filter-func: score_metrics.sphinx_filters.get_metrics_with_first_value_total(tests:total,tests:linked_to_requirements) + +Requirement → Test Traceability +------------------------------- + +.. needtable:: All tool_req with Linkage Status + :types: tool_req + :columns: id;testlink;source_code_link;implemented + :style: table + +Test → Requirement Traceability +------------------------------- + +.. needtable:: All Testcases with Covered Requirements + :types: testcase + :filter: result == "passed" + :columns: name as "Testcase";fully_verifies;partially_verifies;test_type;derivation_technique + :style: table From 053b045097d113ee83382f96cf5f80e0fb1bc694 Mon Sep 17 00:00:00 2001 From: Andreas Zwinkau Date: Fri, 19 Jun 2026 12:05:38 +0200 Subject: [PATCH 2/3] fix: swapped labels --- docs/internals/requirements/requirement_coverage.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/internals/requirements/requirement_coverage.rst b/docs/internals/requirements/requirement_coverage.rst index 675b037ba..b801347bb 100644 --- a/docs/internals/requirements/requirement_coverage.rst +++ b/docs/internals/requirements/requirement_coverage.rst @@ -31,7 +31,7 @@ Overall Coverage :filter-func: score_metrics.sphinx_filters.get_metrics_with_first_value_total(overall_metrics:total,overall_metrics:with_test_link,overall_metrics:with_code_link,overall_metrics:fully_linked) .. needpie:: Test Linkages - :labels: Tests Linked, Tests Not Linked + :labels: Tests Not Linked, Tests Linked :colors: #59A14F, #4E79A7 :filter-func: score_metrics.sphinx_filters.get_metrics_with_first_value_total(tests:total,tests:linked_to_requirements) From c63f13ac90692b319d5794617817bdf9ff5fecea Mon Sep 17 00:00:00 2001 From: Andreas Zwinkau Date: Fri, 19 Jun 2026 12:13:59 +0200 Subject: [PATCH 3/3] fix: needpie colors Roughly red=bad and green=good --- docs/internals/requirements/requirement_coverage.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/internals/requirements/requirement_coverage.rst b/docs/internals/requirements/requirement_coverage.rst index b801347bb..d150be78d 100644 --- a/docs/internals/requirements/requirement_coverage.rst +++ b/docs/internals/requirements/requirement_coverage.rst @@ -27,12 +27,12 @@ Overall Coverage .. needpie:: Overall Requirement Coverage :labels: Remaining (no selected links), With Test Link, With Code Link, Fully Linked - :colors: #4E79A7, #F28E2B, #59A14F, #B07AA1 + :colors: #ca2828, #009ad2, #d26403, #37a12d :filter-func: score_metrics.sphinx_filters.get_metrics_with_first_value_total(overall_metrics:total,overall_metrics:with_test_link,overall_metrics:with_code_link,overall_metrics:fully_linked) .. needpie:: Test Linkages :labels: Tests Not Linked, Tests Linked - :colors: #59A14F, #4E79A7 + :colors: #ca2828, #37a12d :filter-func: score_metrics.sphinx_filters.get_metrics_with_first_value_total(tests:total,tests:linked_to_requirements) Requirement → Test Traceability