Skip to content

Commit b243e61

Browse files
committed
Incorparating CoPilot review findings
Signed-off-by: Philipp Ahmann <philipp.ahmann@de.bosch.com>
1 parent 1665175 commit b243e61

4 files changed

Lines changed: 15 additions & 17 deletions

File tree

process/process_areas/verification/guidance/verification_guideline.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,12 @@ execute affected test cases locally upfront using the execution framework of the
100100
following basically the steps the CI does locally.
101101

102102
Tests have to be identifiable by a unique identifier, as described in :need:`gd_guidl__verification_specification`.
103-
They need need to have a clear passed or failed result and a documented configuration to enable proper evaluation of the result.
103+
They need to have a clear pass/fail result and a documented configuration to enable proper evaluation of the result.
104104

105105
Automated tests can also be executed locally, as the sources and binaries are available for re-execution.
106106
Failing test cases during re-execution can be reported following the guide :need:`gd_temp__problem_template`.
107107

108-
During a relase, for any non executed test case, the reason for non-execution has to be documented in the
108+
During a release, for any non-executed test case, the reason for non-execution must be documented in the
109109
:need:`wp__platform_sw_release_note` or :need:`wp__module_sw_release_plan` depending on the level (unit to platform) of the test case.
110110

111111
Execution of manual test cases
@@ -136,20 +136,18 @@ in the :need:`wp__verification_plan`. Due to the high degree of automation, it i
136136
that a pass rate lower 95% is not acceptable. This percentage may increase with the maturity of
137137
the overall platform and the test coverage.
138138

139-
In case an existing test case is failing due to regression in the CI, the respective issue of the
140-
PR in their role as :need:`rl__contributor` is responsible for fixing the test case as part of
141-
respective PR.
139+
In case an existing test case is failing due to regression in the CI, the PR author in their role as
140+
:need:`rl__contributor` is responsible for fixing the test case as part of the respective PR.
142141

143142
Test case results are also documented in the :need:`wp__verification_platform_ver_report` and
144143
:need:`wp__verification_module_ver_report`.
145144

146145
Reporting of not executed or skipped test cases
147146
-----------------------------------------------
148147

149-
In case a test case is not executed or skipped, a rational has to be provided in the release notes
150-
in case they are link against a requirement. A skipped or not executed test case is not counting into
151-
the value for the requirements coverage, as only executed and passed test cases can be counted for the
152-
coverage of a requirement.
148+
In case a test case is not executed or skipped, a rationale has to be provided in the release notes
149+
if the test case is linked to a requirement. A skipped or non-executed test case does not count towards
150+
requirement coverage, as only executed and passed test cases can be counted for the coverage of a requirement.
153151

154152
Skipped or not executed test cases are also documented in the :need:`wp__verification_platform_ver_report` and
155153
:need:`wp__verification_module_ver_report`.

process/process_areas/verification/guidance/verification_process_reqs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Process Requirements
146146
The tool automation shall automatically generate the Verification reports.
147147
These may be independent documents (i.e. not integrated into docs-as-code based repositories).
148148
The content of the reports is specified in :need:`gd_temp__platform_ver_report` and :need:`gd_temp__mod_ver_report`.
149-
The execution results of a test cases are marked with a clear passed of failed result.
149+
The execution results of test cases are marked with a clear pass/fail result.
150150

151151
.. gd_req:: Verification Report Archiving
152152
:id: gd_req__verification_report_archiving

process/process_areas/verification/guidance/verification_specification.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,14 @@ A test specification contains the following attributes.
8383

8484
The implementation of :need:`wp__verification_plan` defines the full list of allowed types and methods.
8585

86-
It is assumed that tests will be written as code (also for manual tests, which are script based)
87-
and each test case will have a unique identifier, by its script, execution call, or function name.
88-
The call used to execute the test marks the uniqueness of the test case and its identification,
89-
e.g. guaranteeing proper traceability and reproducibility.
86+
It is assumed that tests will be written as code (also for manual tests, which are script-based)
87+
and that each test case will have a unique identifier (e.g. its script name, execution call, or function name).
88+
The invocation used to execute the test defines the test case identification, thereby guaranteeing
89+
proper traceability and reproducibility.
9090

91-
As the tests are stored in a repository close to the implementation code, versioning is done by the versioning of the repository.
91+
As the tests are stored in a repository close to the implementation code, versioning is handled by the repository's version control.
9292

93-
Any specification and resulting implementation ends with a clear passed or failed result.
93+
Any specification and resulting implementation ends with a clear pass/fail result.
9494

9595
Test description
9696
----------------

process/process_areas/verification/verification_concept.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ The verification of requirements of types "Process" and "Non-Functional" will be
170170
which is part of the requirement inspection :need:`doc__feature_name_req_inspection` and `Component Requirements Inspection Checklist <https://eclipse-score.github.io/module_template/main/score/component_example/docs/requirements/chklst_req_inspection.html>`__.
171171
Requirements always include Assumptions Of Use.
172172

173-
A more detailed description of how to link code to requirements is available by :need:`gd_req__verification_link_tests`.
173+
A more detailed description of how to link code to requirements is available here: :need:`gd_req__verification_link_tests`.
174174

175175
Another element of traceability for a proper backlink is the unique identification of test cases as described in the
176176
:need:`gd_guidl__verification_specification`.

0 commit comments

Comments
 (0)