-
Notifications
You must be signed in to change notification settings - Fork 28
Add module inspection report aggregator with completeness check #682
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: inspection_needs
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1003,6 +1003,32 @@ needs_types: | |
| - inspection | ||
| parts: 3 | ||
|
|
||
| # Aggregates a module's inspection records and gates inspection completeness. | ||
| # req-Id: tool_req__docs_inspection_report_need | ||
| mod_insp_report: | ||
| title: Module Inspection Report | ||
| prefix: mod_ispr__ | ||
| mandatory_options: | ||
| # req-Id: tool_req__docs_common_attr_safety | ||
| safety: ^(QM|ASIL_B)$ | ||
| # req-Id: tool_req__docs_common_attr_security | ||
| security: ^(YES|NO)$ | ||
| # req-Id: tool_req__docs_common_attr_status | ||
| status: ^(valid|invalid)$ | ||
| # req-Id: tool_req__docs_inspection_report_need | ||
| # comma-separated subset of the three checklist categories the module must cover | ||
| expected_inspections: ^(requirements|architecture|implementation)(,(requirements|architecture|implementation))*$ | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So you want to select which inspection types are needed because we may tailor this for some modules? So the template would have ":expected_inspections: requirements, architecture, implementation" pre-filled? |
||
| mandatory_links: | ||
| # req-Id: tool_req__docs_inspection_report_need | ||
| belongs_to: mod | ||
| contains: mod_insp | ||
| optional_links: | ||
| # req-Id: tool_req__docs_inspection_report_need | ||
| evidence: ANY | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. evidence for what should this be? |
||
| tags: | ||
| - inspection | ||
| parts: 3 | ||
|
|
||
| # https://eclipse-score.github.io/process_description/main/permalink.html?id=gd_temp__change_decision_record | ||
| dec_rec: | ||
| title: Decision Record | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
|
|
||
| .. mod:: Inspection Report Graph Module | ||
| :id: mod__inspection_report_graph_module | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
|
|
||
| .. comp_req:: Inspection Report Graph Requirement | ||
| :id: comp_req__inspection_report_graph__sample | ||
| :reqtype: Functional | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
|
|
||
| .. mod_insp:: Approved Requirements Inspection | ||
| :id: mod_insp__inspection_report_graph__requirements | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :status: valid | ||
| :inspection_type: requirements | ||
| :inspection_state: approved | ||
| :checklist_ref: gd_chklst__req_inspection | ||
| :reviewers: reviewer_a | ||
| :belongs_to: mod__inspection_report_graph_module | ||
| :inspects: comp_req__inspection_report_graph__sample | ||
|
|
||
| #EXPECT[+2]: Inspection report is missing approved inspection(s) for: architecture | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This PR is using an outdated method for file-based tests. See https://eclipse-score.github.io/docs-as-code/main/internals/extensions/rst_filebased_testing.html
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yeah I will fix.. |
||
|
|
||
| .. mod_insp_report:: Incomplete Inspection Report | ||
| :id: mod_ispr__inspection_report_graph__incomplete | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :status: valid | ||
| :expected_inspections: requirements,architecture | ||
| :belongs_to: mod__inspection_report_graph_module | ||
| :contains: mod_insp__inspection_report_graph__requirements | ||
|
|
||
| #EXPECT-NOT[+2]: Inspection report is missing approved inspection(s) | ||
|
|
||
| .. mod_insp_report:: Complete Inspection Report | ||
| :id: mod_ispr__inspection_report_graph__complete | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :status: valid | ||
| :expected_inspections: requirements | ||
| :belongs_to: mod__inspection_report_graph_module | ||
| :contains: mod_insp__inspection_report_graph__requirements | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
|
|
||
| #CHECK: check_options | ||
|
|
||
| .. mod:: Inspection Report Module | ||
| :id: mod__inspection_report_module | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
|
|
||
| .. comp_req:: Inspection Report Requirement | ||
| :id: comp_req__inspection_report__sample | ||
| :reqtype: Functional | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
|
|
||
| .. mod_insp:: Inspection Report Record | ||
| :id: mod_insp__inspection_report__requirements | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :status: valid | ||
| :inspection_type: requirements | ||
| :inspection_state: approved | ||
| :checklist_ref: gd_chklst__req_inspection | ||
| :reviewers: reviewer_a | ||
| :belongs_to: mod__inspection_report_module | ||
| :inspects: comp_req__inspection_report__sample | ||
|
|
||
| #EXPECT-NOT[+2]: Inspection report is missing approved inspection(s) | ||
|
|
||
| .. mod_insp_report:: Inspection Report Valid | ||
| :id: mod_ispr__inspection_report__valid | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :status: valid | ||
| :expected_inspections: requirements | ||
| :belongs_to: mod__inspection_report_module | ||
| :contains: mod_insp__inspection_report__requirements | ||
|
|
||
| # Invalid expected_inspections value | ||
| #EXPECT[+2]: mod_ispr__inspection_report__invalid.expected_inspections (requirements,security): does not follow pattern | ||
|
|
||
| .. mod_insp_report:: Inspection Report Invalid Expected Inspections | ||
| :id: mod_ispr__inspection_report__invalid | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :status: invalid | ||
| :expected_inspections: requirements,security | ||
| :belongs_to: mod__inspection_report_module | ||
| :contains: mod_insp__inspection_report__requirements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does this make sense to have? This would only cover completeness (for requirements) if you have only one component in the module, for architecture it is never complete because you have feature and component architecture inspections ... So rather you need to do this check with the knowledge of what documents (or even better workproduct) needs you created. Every inspected needs workproduct should have a "inspected" tag or status according to our process.