-
Notifications
You must be signed in to change notification settings - Fork 8
5 REQ review
Provide a way to manually verify requirements and tests, because not everything can be automated.
A review in mantra must be uniquely identified by the name and UTC datetime of the review, because some form of identification is required for a review to be referencable in a traceability report.
Note: It is assumed that a name and UTC datetime is enough to uniquely identify a review.
Every review must contain a list of reviewers that were involved in the review, because this is essential information for a any review.
The origin of a review must be stored in mantra, but the storage format should stay flexible to allow different origin variants. For example, reviews could have local files or URLs as origins.
-
Parents: [
review,changes.track]
It must be possible to alter existing reviews, because typos or mistakes may be detected after data is collected. To keep track of changes, revision numbers must be used with the initial revision number starting at zero and each new revision increments the number by one.
Implementation Details:
To notice changes in a review, the hash over a review content must be stored per revision.
Every review may contain a general description to provide additional context about the review.
-
Parents: [
review,req.id]
It must be possible to manually verify requirements, because some may not be traceable to specific text lines, or some requirements may explicitly require manual verification.
In mantra, requirements may be manually verified in reviews, using the requirement ID to refer to the requirement.
Additional information about the verification must be described in a comment next to the requirement ID(s). This is especially important in safety-critical domains, where such information is needed for qualification.
-
Parents: [
review,testcov.test_case.state]
It must be possible to override the state of a test case stored in mantra, because e.g. during semi-automatic testing, a tester may determine that a test was not passed even though test execution succeeded, or a test that failed during automatic testing passed during manual testing.
A comment must always be mandatory in this case.
-
Parents: [
review,testcov.cov]
It must be possible to override the coverage state of specific code lines, because some defensive code might never be reached.
It must be possible to override the coverage state of specific conditions, because some defensive code might never be reached.
A comment must always be mandatory in this case.
Please create an issue if you found any spelling mistakes.
You may also create an issue if you think the content of this wiki should be improved.
Note: This wiki is managed in its own repository. Any commits made using the edit button will be overwritten.
Note: Issues for the wiki are handled in the mantra repository, but pull requests for the wiki are handled in the mantra-wiki repository.
This wiki is MIT licensed, and works together with mantra.