-
Notifications
You must be signed in to change notification settings - Fork 102
Align logging platform level docu with module #3189
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
Open
aschemmel-tech
wants to merge
1
commit into
main
Choose a base branch
from
aschemmel-tech-logging-documentation-fixes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
182 changes: 182 additions & 0 deletions
182
docs/features/log_trace/logging/requirements/chklst_req_inspection.rst
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 |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2025 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 | ||
| # ******************************************************************************* | ||
|
|
||
|
|
||
| .. document:: Logging Requirements Inspection Checklist | ||
| :id: doc__logging_req_inspection | ||
| :status: draft | ||
| :version: 1 | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :realizes: wp__requirements_inspect[version==1] | ||
|
|
||
|
|
||
| Requirement Inspection Checklist | ||
| ================================ | ||
|
|
||
| Purpose | ||
| ------- | ||
|
|
||
| The purpose of this requirement inspection checklist is to collect the topics to be checked during requirements inspection. | ||
|
|
||
| Conduct | ||
| ------- | ||
|
|
||
| As described in the concept :need:`doc_concept__wp_inspections` the following "inspection roles" are expected to be filled: | ||
|
|
||
| - content responsible (author): <contributor/committer explicitly named here, who is the main author, as can be seen in config mgt tooling> | ||
| - reviewer: <contributor/committer explicitly named here, who is the main content reviewer, must be different from content responsible> | ||
| - moderator: <committer explicitly named here, who is is the safety manager, security manager or quality manager initiating the inspection> | ||
| - test expert: <one of the reviewers explicitly named here, to cover REQ_08_01 as described> | ||
|
|
||
| Checklist | ||
| --------- | ||
|
|
||
| It is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additionally to add in the remarks why it is passed or not passed. | ||
| In case of "no" an issue link to the issue tracking system has to be added in the last column (if not solved in the same issue). | ||
| See also :need:`doc_concept__wp_inspections` for further information about reviews in general and inspection in particular. | ||
|
|
||
| .. list-table:: Feature Requirement Inspection Checklist | ||
| :header-rows: 1 | ||
| :widths: 10,30,50,6,6,8 | ||
|
|
||
| * - Review ID | ||
| - Acceptance Criteria | ||
| - Guidance | ||
| - Passed | ||
| - Remarks | ||
| - Issue link | ||
| * - REQ_01_01 | ||
| - Is the requirement formulation template used? | ||
| - see :need:`gd_temp__req_formulation`, this includes the use of "shall". | ||
| - | ||
| - | ||
| - | ||
| * - REQ_02_01 | ||
| - Is the requirement description *comprehensible* ? | ||
| - If you think the requirement is hard to understand, comment here. | ||
| - | ||
| - | ||
| - | ||
| * - REQ_02_02 | ||
| - Is the requirement description *unambiguous* ? | ||
| - Especially search for "weak words" like "about", "etc.", "relevant" and others (see the internet documentation on this). This check shall be supported by tooling. | ||
| - | ||
| - | ||
| - | ||
| * - REQ_02_03 | ||
| - Is the requirement description *atomic* ? | ||
| - A good way to think about this is to consider if the requirement may be tested by one (positive) test case or needs more of these. The requirement formulation template should also avoid being non-atomic already. Note that there are cases where also non-atomic requirements are the better ones, for example if those are better understandable. | ||
| - | ||
| - | ||
| - | ||
| * - REQ_02_04 | ||
| - Is the requirement description *feasible* ? | ||
| - If at the time of the inspection the requirement has already some implementation, the answer is yes. This can be checked via traces, but also :need:`gd_req__req_attr_impl` shows this. In case the requirement has no implementation at the time of inspection (i.e. not implemented at least as "proof-of-concept"), a development expert should be invited to the Pull-Request review to explicitly check this item. | ||
| - | ||
| - | ||
| - | ||
| * - REQ_02_05 | ||
| - Is the requirement description *independent from implementation* ? | ||
| - This checkpoint should improve requirements definition in the sense that the "what" is described and not the "how" - the latter should be described in architecture/design derived from the requirement. But there can also be a good reason for this, for example we would require using a file format like JSON and even specify the formatting standard already on stakeholder requirement level because we want to be compatible. A finding in this checkpoint does not mean there is a safety problem in the requirement. | ||
| - | ||
| - | ||
| - | ||
| * - REQ_03_01 | ||
| - Is the *linkage to the parent requirement* correct? | ||
| - Linkage to correct levels and ASIL attributes is checked automatically, but it needs checking if the child requirement implements (at least) a part of the parent requirement. | ||
| - | ||
| - | ||
| - | ||
| * - REQ_04_01 | ||
| - Is the requirement *internally and externally consistent*? | ||
| - Does the requirement contradict other requirements within the same or higher levels? One may restrict the search to the feature for component requirements, for features to other features using same components. Is the description of the requirement consistent with all its attributes (if not already part of another check, e.g. does the title fit?). | ||
| - | ||
| - | ||
| - | ||
| * - REQ_05_01 | ||
| - Do the software requirements consider *timing constraints*? | ||
| - This checkpoint encourages to think about timing constraints even if those are not explicitly mentioned in the parent requirement. If the reviewer of a requirement already knows or suspects that the code execution will be consuming a lot of time, one should think of the expectation of a "user". | ||
| - | ||
| - | ||
| - | ||
| * - REQ_06_01 | ||
| - Does the requirement consider *external interfaces*? | ||
| - The SW platform's external interfaces (to the user) are defined in the Feature Architecture, so the Feature and Component Requirements should determine the input data use and setting of output data for these interfaces. Are all output values defined? | ||
| - | ||
| - | ||
| - | ||
| * - REQ_07_01 | ||
| - Is the *safety* attribute set correctly? | ||
| - Derived requirements are checked automatically, see :need:`gd_req__req_linkage_safety`. But for the top level requirements (and also all AoU) this needs to be checked manually for correctness. | ||
| - | ||
| - | ||
| - | ||
| * - REQ_07_02 | ||
| - Is the *security* attribute set correctly? | ||
| - For feature requirements this checklist item is supported by automated check: "Every requirement which is derived from a stakeholder requirement with security attribute set to YES inherits this". But the feature requirements/architecture may additionally also be subject to a :need:`wp__feature_security_analysis` | ||
| - | ||
| - | ||
| - | ||
| * - REQ_08_01 | ||
| - Is the requirement *verifiable*? | ||
| - If at the time of the inspection already tests are created for the requirement, the answer is yes. This can be checked via traces, but also :need:`gd_req__req_attr_test_covered` shows this. In case the requirement is not sufficiently traced to test cases already, a test expert is invited to the inspection to give their opinion whether the requirement is formulated in a way that supports test development and the available test infrastructure is sufficient to perform the test. | ||
| - | ||
| - | ||
| - | ||
| * - REQ_08_02 | ||
| - Is the requirement verifiable by design or code review in case it is not feasibly testable? | ||
| - In very rare cases a requirement may not be verifiable by test cases, for example a specific non-functional requirement. In this case a requirement analysis verifies the requirement by design/code review. If such a requirement is in scope of this inspection, please check this here and link to the respective review record. A test expert is invited to the inspection to confirm their opinion that the requirement is not testable. | ||
| - | ||
| - | ||
| - | ||
| * - REQ_09_01 | ||
| - Do the feature requirements defining a safety mechanism contain the error reaction leading to a safe state? | ||
| - Alternatively to the safe state there could also be "repair" mechanisms. Also do not forget to consider REQ_05_01 for these. | ||
| - | ||
| - | ||
| - | ||
| * - REQ_10_01 | ||
| - Is the requirement description *complete* ? | ||
| - For every requirement in the inspection, follow to its parent (stakeholder) requirement(s) and then check if this/these are fulfilled completely by its/their linked children (feature requirements, including those which are not in scope of the inspection). | ||
| - | ||
| - | ||
| - | ||
|
|
||
| .. attention:: | ||
| The above checklist entries must be filled according to your component requirements in scope. | ||
|
|
||
| Note: If a Review ID is not applicable for your requirement, then state ""n/a" in status and comment accordingly in remarks. | ||
|
|
||
| The following requirements in "valid" state and with "inspected" tag set are in the scope of this inspection: | ||
|
|
||
| .. needtable:: | ||
| :filter: "logging" in docname and "requirements" in docname and docname is not None and status == "valid" | ||
| :style: table | ||
| :types: feat_req | ||
| :tags: logging | ||
| :columns: id;status;tags | ||
| :colwidths: 25,25,25 | ||
| :sort: title | ||
|
|
||
| And also the following AoUs in "valid" state and with "inspected" tag set (for these please answer the questions above as if the AoUs are requirements, except question REQ_03_01): | ||
|
|
||
| .. needtable:: | ||
| :filter: "logging" in docname and "requirements" in docname and docname is not None and status == "valid" | ||
| :style: table | ||
| :types: aou_req | ||
| :tags: logging | ||
| :columns: id;status;tags | ||
| :colwidths: 25,25,25 | ||
| :sort: title | ||
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
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 was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
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.
A lot of these could be automated. I dont understand why should this be a manual check?
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 is actually explained already in the "Guidance" column (one line below): "Linkage to correct levels and ASIL attributes is checked automatically, but it needs checking if the child requirement implements (at least) a part of the parent requirement." - so for this a manual check has to be done.
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.
And for the others which may be automated in the future: as soon as we have the check implemented the checkpoint will be removed.