feature/add_report_contract #684

process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst

@@ -38,6 +38,40 @@ It covers all the components of the above stated module.
 
 Verification Report contains:
 
+.. note:: Schema synchronization contract
+
+    The following fields define the canonical section keys and descriptions used for
+    machine-readable verification report schema synchronization.
+
+.. list-table:: Verification report section contract fields
+    :header-rows: 1
+    :widths: 1 2 5
+
+    * - section_index
+      - section_key
+      - section_description
+    * - 1
+      - verification_coverage
+      - Coverage on requirements, architecture, and detailed design including test and inspection results.
+    * - 2
+      - dfa_report
+      - Report of component DFA results including verdict and open mitigations.
+    * - 3
+      - safety_analysis_report
+      - Report of component safety analysis results including verdict and open mitigations.
+    * - 4
+      - unit_verification
+      - Unit-level verification coverage including structural coverage, static analysis, and manual inspection.
+    * - 5
+      - software_component_qualification
+      - Verification results for qualification of pre-developed software components.
+    * - 6
+      - test_results
+      - Per-testcase execution result status.
+    * - 7
+      - test_logs
+      - Per-testcase execution logs with pass/fail/not_run status context.
+
 **1. Verification Coverage**
 
 **1.1. on Requirements**

process/folder_templates/platform/docs/verification/platform_verification_report.rst

@@ -1,67 +1,92 @@
-..
-   # *******************************************************************************
-   # Copyright (c) 2025 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
-   # *******************************************************************************
-
-Platform Verification Report
-============================
-
-.. note:: Document header
-
-.. document:: Platform Verification Report
-   :id: doc__platform_verification_report
-   :status: draft
-   :safety: ASIL_B
-   :security: YES
-   :realizes: wp__verification_platform_ver_report
-   :tags: template
-
-.. attention::
-    The above directive must be updated.
-
-    - Adjust ``status`` to be ``valid``
-    - Adjust ``safety`` and ``tags`` according to your needs
-
-This verification report is based on the :need:`wp__verification_plan`.
-It covers all the selected features of the SW platform.
-
-Verification Report contains:
-
-**1. Verification Coverage**
-
-**1.1. on Requirements**
-       - Lists of stakeholder and feature requirements tested by which test case, passed/failed/not_run and completeness verdict
-         (this shall be generated by tools and accompanied by progress charts to be usable also for project steering)
-       - For external component Assumptions of Use: coverage by platform safety manual
-       - This is split in a list of QM requirements tested and a separate list of tests for ASIL rated requirements.
-       - List of stakeholder requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export)
-
-**1.2. on Architecture**
-      - List of feature architecture tags tested by which test case, passed/failed and completeness verdict
-        (this shall be generated by tools and accompanied by progress charts to be usable also for project steering)
-      - This is split in a list of QM features tested and a separate list of tests for ASIL rated features.
-      - List of feature architecture tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export)
-      - The lists may also contain other verification methods
-
-**2. Safety Analyses Report**
-      - List of the performed Platform and Feature Safety Analyses, pass/fail with open mitigations
-
-**3. Test results**
-      - Test result per test case with status passed/failed/not_run for :need:`wp__verification_platform_int_test` and :need:`wp__verification_feat_int_test`
-
-**4. Test logs**
-      - Test log per test case with status passed/failed/not_run for :need:`wp__verification_platform_int_test` and :need:`wp__verification_feat_int_test`
-         with status passed/failed/not_run
-
-**Note1:** The verification report is valid for the platform version tagged together with the report
-
-**Note2:** All the above lists are generated automatically
+..
+   # *******************************************************************************
+   # Copyright (c) 2025 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
+   # *******************************************************************************
+
+Platform Verification Report
+============================
+
+.. note:: Document header
+
+.. document:: Platform Verification Report
+   :id: doc__platform_verification_report
+   :status: draft
+   :safety: ASIL_B
+   :security: YES
+   :realizes: wp__verification_platform_ver_report
+   :tags: template
+
+.. attention::
+    The above directive must be updated.
+
+    - Adjust ``status`` to be ``valid``
+    - Adjust ``safety`` and ``tags`` according to your needs
+
+This verification report is based on the :need:`wp__verification_plan`.
+It covers all the selected features of the SW platform.
+
+Verification Report contains:
+
+.. note:: Schema synchronization contract
+
+    The following fields define the canonical section keys and descriptions used for
+    machine-readable verification report schema synchronization.
+
+.. list-table:: Verification report section contract fields
+    :header-rows: 1
+    :widths: 1 2 5
+
+    * - section_index
+      - section_key
+      - section_description
+    * - 1
+      - verification_coverage
+      - Coverage on requirements and architecture including test and inspection results.
+    * - 2
+      - safety_analysis_report
+      - Report of platform and feature safety analysis results including verdict and open mitigations.
+    * - 3
+      - test_results
+      - Per-testcase execution result status for platform and feature integration tests.
+    * - 4
+      - test_logs
+      - Per-testcase execution logs with pass/fail/not_run status context for integration tests.
+
+**1. Verification Coverage**
+
+**1.1. on Requirements**
+       - Lists of stakeholder and feature requirements tested by which test case, passed/failed/not_run and completeness verdict
+         (this shall be generated by tools and accompanied by progress charts to be usable also for project steering)
+       - For external component Assumptions of Use: coverage by platform safety manual
+       - This is split in a list of QM requirements tested and a separate list of tests for ASIL rated requirements.
+       - List of stakeholder requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export)
+
+**1.2. on Architecture**
+      - List of feature architecture tags tested by which test case, passed/failed and completeness verdict
+        (this shall be generated by tools and accompanied by progress charts to be usable also for project steering)
+      - This is split in a list of QM features tested and a separate list of tests for ASIL rated features.
+      - List of feature architecture tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export)
+      - The lists may also contain other verification methods
+
+**2. Safety Analyses Report**
+      - List of the performed Platform and Feature Safety Analyses, pass/fail with open mitigations
+
+**3. Test results**
+      - Test result per test case with status passed/failed/not_run for :need:`wp__verification_platform_int_test` and :need:`wp__verification_feat_int_test`
+
+**4. Test logs**
+      - Test log per test case with status passed/failed/not_run for :need:`wp__verification_platform_int_test` and :need:`wp__verification_feat_int_test`
+         with status passed/failed/not_run
+
+**Note1:** The verification report is valid for the platform version tagged together with the report
+
+**Note2:** All the above lists are generated automatically