diff --git a/MODULE.bazel b/MODULE.bazel index 5b82fcaa..21a768ff 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -76,6 +76,10 @@ bazel_dep(name = "buildifier_prebuilt", version = "8.5.1.2", dev_dependency = Tr bazel_dep(name = "score_docs_as_code", version = "8.1.2") bazel_dep(name = "score_process_description", version = "2.1.2") +# Local override for testing PR #661 + #682 (inspection record need types) +# To test locally, run: bazel build --override_module=score_docs_as_code=/workspaces/docs-as-code-demo //:docs +# Remove this comment when ready to test against main or a merged PR. + # grpc-java 1.66.0 imports a grpc extension repo removed in newer grpc versions. # Force a compatible grpc-java version until upstream dependencies converge. single_version_override( diff --git a/docs/verification_report/module_verification_report.rst b/docs/verification_report/module_verification_report.rst index 8bcfea1d..1f9a1a0f 100644 --- a/docs/verification_report/module_verification_report.rst +++ b/docs/verification_report/module_verification_report.rst @@ -125,12 +125,106 @@ Verification Report - Contains the needed verification results if for some components a qualification of pre-developed SW is performed. - **6. Test results** - - Test result per test case with status passed/failed/not_run - - **7. Test logs** - - Test log per test case with status passed/failed/not_run - - **Note1:** The verification report is valid for the module version tagged together with the report - - **Note2:** All the above lists are generated automatically + **6. Test results** + - Test result per test case with status passed/failed/not_run + + **7. Test logs** + - Test log per test case with status passed/failed/not_run + + **Note1:** The verification report is valid for the module version tagged together with the report + + **Note2:** All the above lists are generated automatically + +.. note:: Showcase: Inspection Records (PR #661 + #682) + + The following example demonstrates the ``mod_insp`` (inspection record) and + ``mod_insp_report`` (inspection report aggregator with completeness check) need + types from PRs #661 and #682. These are **not** part of the template yet — they + are shown here to test whether the feature works before proposing it upstream. + +.. mod:: Showcase Module + :id: mod__showcase_inspection_module + :security: YES + :safety: ASIL_B + :status: valid + +.. comp_req:: Sample Component Requirement 1 + :id: comp_req__showcase_sample_01 + :reqtype: Functional + :security: YES + :safety: ASIL_B + :status: valid + +.. comp_req:: Sample Component Requirement 2 + :id: comp_req__showcase_sample_02 + :reqtype: Functional + :security: YES + :safety: ASIL_B + :status: valid + +.. comp_arc_sta:: Sample Component Architecture 1 + :id: comp_arc_sta__showcase_sample_01 + :security: YES + :safety: ASIL_B + :status: valid + +.. mod_insp:: Approved Requirements Inspection (Record #1) + :id: mod_insp__showcase_req_01 + :safety: ASIL_B + :security: YES + :status: valid + :inspection_type: requirements + :inspection_state: approved + :checklist_ref: gd_chklst__req_inspection + :reviewers: reviewer_a, reviewer_b + :belongs_to: mod__showcase_inspection_module + :inspects: comp_req__showcase_sample_01 + +.. mod_insp:: Approved Requirements Inspection (Record #2) + :id: mod_insp__showcase_req_02 + :safety: ASIL_B + :security: YES + :status: valid + :inspection_type: requirements + :inspection_state: approved + :checklist_ref: gd_chklst__req_inspection + :reviewers: reviewer_c + :belongs_to: mod__showcase_inspection_module + :inspects: comp_req__showcase_sample_02 + +.. mod_insp:: Approved Architecture Inspection + :id: mod_insp__showcase_arc_01 + :safety: ASIL_B + :security: YES + :status: valid + :inspection_type: architecture + :inspection_state: approved + :checklist_ref: gd_chklst__arc_inspection + :reviewers: reviewer_a + :belongs_to: mod__showcase_inspection_module + :inspects: comp_arc_sta__showcase_sample_01 + +.. mod_insp_report:: Complete Inspection Report + :id: mod_ispr__showcase_complete + :safety: ASIL_B + :security: YES + :status: valid + :expected_inspections: requirements,architecture + :belongs_to: mod__showcase_inspection_module + :contains: mod_insp__showcase_req_01,mod_insp__showcase_req_02,mod_insp__showcase_arc_01 + +.. note:: The above report passes the completeness check — all expected inspection + types (requirements, architecture) are covered by approved records. + +.. mod_insp_report:: Incomplete Inspection Report (Demo Warning) + :id: mod_ispr__showcase_incomplete + :safety: ASIL_B + :security: YES + :status: valid + :expected_inspections: requirements,architecture,implementation + :belongs_to: mod__showcase_inspection_module + :contains: mod_insp__showcase_req_01 + +.. note:: The above report triggers a warning: "Inspection report is missing + approved inspection(s) for: architecture, implementation" — demonstrating the + completeness check from PR #682.