add example for auto generated module verification report #166
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,80 +18,119 @@ Verification Report | |
| .. note:: Document header | ||
|
|
||
| .. document:: [Module Name] Verification Report | ||
| :id: doc__mod_temp_verification_report | ||
| :status: draft | ||
| :version: 1 | ||
| :safety: ASIL_B | ||
| :security: NO | ||
| :realizes: wp__verification_module_ver_report | ||
| :tags: template | ||
|
Comment on lines
+21
to
+27
Contributor
There was a problem hiding this comment. Does this even work with this formating?
Contributor
Author
There was a problem hiding this comment. Yes, as long as the indentation is same. |
||
|
|
||
| .. attention:: | ||
| In a module the above directive must be replaced by the following directive. | ||
|
|
||
| .. code-block:: rst | ||
|
|
||
| .. document:: {module pretty name} Module Verification Report | ||
| :id: doc__{module formal name = same as in ..mod}_verification_report | ||
| :post_template: module_verification_report | ||
| :status: valid | ||
| :safety: QM | ||
| :security: NO | ||
| :realizes: wp__verification_module_ver_report | ||
| :version: 1 | ||
|
|
||
| .. attention:: | ||
|
|
||
| The above directive must be updated according to your Module. | ||
|
|
||
| - Modify ``module pretty name`` to be your Module Name | ||
| - Modify ``module formal name`` to be your Module Name in lower case | ||
| - Adjust ``status`` to be ``valid`` | ||
| - Adjust ``safety`` and ``tags`` according to your needs | ||
|
|
||
| .. note:: | ||
|
|
||
| The verification report is generated automatically by the codeblock above by the tools and contains all the needed information for the module verification. The report is based on the module verification plan and workproduct module verification product (:need:`wp__verification_module_ver_report`) and covers all the components of the module. | ||
|
|
||
| The generated report should contain the following parts which bases : | ||
|
|
||
| .. code-block:: rst | ||
|
|
||
| This verification report is based on the :need:`gd_temp__verification_plan`. | ||
| It covers all the components of the above stated module. | ||
|
|
||
| Verification Report contains: | ||
|
|
||
| **1. Verification Coverage** | ||
|
|
||
| **1.1. on Requirements** | ||
| - Lists of component requirements (incl. AoU satisfied by the component) 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) | ||
| - For external component Assumptions of Use: coverage by platform safety manual or | ||
| feature/components incl. test case, passed/failed and completeness verdict | ||
| - This is split in a list of QM requirements tested and a separate list of tests for ASIL | ||
| rated requirements. | ||
| - List of component requirements (ASIL rated) linked to inspection checklist and verdict | ||
| (derived from PR export) | ||
|
|
||
| **1.2. on Architecture** | ||
| - List of component 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 components tested and a separate list of tests for ASIL rated | ||
| components. | ||
| - List of component architecture tags (ASIL rated) linked to inspection checklist and verdict | ||
| (derived from PR export) | ||
|
|
||
| **1.3. on Detailed Design** | ||
| - List of detailed design 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 components tested and a separate list of tests for ASIL rated | ||
| components. | ||
| - List of detailed design tags (ASIL rated) linked to inspection checklist and verdict (derived | ||
| from PR export) | ||
| - The lists may also contain other verification methods like "Analysis" - for example | ||
| by :need:`doc__mod_temp_component_name_impl_inspection` | ||
|
|
||
| **2. DFA Report** | ||
| - List of the performed component DFA, pass/fail with open mitigations | ||
|
|
||
| **3. Safety Analysis Report** | ||
| - List of the performed component Safety Analysis, pass/fail with open mitigations | ||
|
|
||
| **4. Unit Verification Coverage** | ||
|
|
||
| **4.1. Structural Coverage** | ||
| - List of the units with C0(line) and C1(branch) coverage absolute and percentage | ||
| - (this shall be generated by tools and accompanied by progress charts to be usable also for | ||
| project steering) | ||
| - List includes a column for the safety rating of each unit. | ||
|
|
||
| **4.2. Static Code Analysis** | ||
| - List of the units with compiler warning numbers and coding rule violation numbers | ||
| - (this shall be generated by tools and accompanied by progress charts to be usable also for | ||
| project steering) | ||
| - List includes a column for the safety rating of each unit. | ||
|
|
||
| **4.3. Manual Code Inspection** | ||
| - List of components (ASIL rated) linked to inspection checklist and verdict (derived from PR | ||
| export) | ||
|
|
||
| **5. Software component qualification 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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
why touch aspect rules?
Uh oh!
There was an error while loading. Please reload this page.
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.
There was a warning regards to that... If I made a PR I can fix that together.
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.
@copilot which module updated aspect_rules_lint?
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.
aspect_rules_lintwas set directly by this template’sMODULE.bazelin1dd74ec(bazel_dep(..., version = "2.3.0")). The resolved lockfile also showsaspect_tools_telemetry0.2.8 requesting 2.3.0; no separate module update caused it.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.
@copilot yeah, but this was done only to resolve a warning. So what other module did the update?
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.
It was
score_bazel_cpp_toolchains1.0.3. ItsMODULE.bazeldeclaresaspect_rules_lint2.3.0 (alongsidescore_tooling1.1.2), whilescore_tooling1.2.0 itself requests 1.5.3.