Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/internals/requirements/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1227,6 +1227,37 @@ Testing

Docs-As-Code shall enforce that every Safety Analysis has a short description of the failure effect (e.g. failure lead to an unintended actuation of the analysed element)

----------------------------------------------------------------
Safety Analysis (DFA + FMEA) Process to Tool Requirement Mapping
----------------------------------------------------------------

.. tool_req:: Safety Analysis Safety Relevant Attribute
:id: tool_req__docs_saf_attrs_safety_relevant
:implemented: YES
:tags: Safety Analysis
:version: 1
:satisfies: gd_req__saf_attr_safety_relevant
:parent_covered: YES

Docs-As-Code shall allow needs of type :need:`tool_req__docs_saf_types` and
``plat_saf_dfa`` to have an optional ``safety_relevant`` attribute. The
allowed values are:

* yes
* no


.. tool_req:: FMEA: Root Cause Attribute
:id: tool_req__docs_saf_attrs_root_cause
:implemented: YES
:tags: Safety Analysis
:version: 1
:satisfies: gd_req__saf_attr_failure_root_cause
:parent_covered: YES

Docs-As-Code shall allow FMEA needs (``feat_saf_fmea``, ``comp_saf_fmea``)
to have an optional ``root_cause`` attribute with non-empty content.


πŸ”’ Security Analysis
#####################
Expand Down
14 changes: 13 additions & 1 deletion src/extensions/score_metamodel/metamodel.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -698,6 +698,7 @@ needs_types:
mandatory_links:
violates: feat_arc_sta
optional_options:
safety_relevant: ^(yes|no)$
mitigation_issue: ^https://github\.com/[^/]+/[^/]+/issues/\d+$
optional_links:
mitigated_by: stkh_req, aou_req
Expand All @@ -721,7 +722,9 @@ needs_types:
violates: feat_arc_sta
optional_options:
# req-Id: tool_req__docs_saf_attrs_mitigation_issue
safety_relevant: ^(yes|no)$
mitigation_issue: ^https://github\.com/[^/]+/[^/]+/issues/\d+$

optional_links:
# req-Id: tool_req__docs_saf_attrs_mitigated_by
# (only mandatory once valid status == valid)
Expand All @@ -745,6 +748,7 @@ needs_types:
content: ^[\s\S]+$
optional_options:
# req-Id: tool_req__docs_saf_attrs_mitigation_issue
safety_relevant: ^(yes|no)$
mitigation_issue: ^https://github\.com/[^/]+/[^/]+/issues/\d+$
mandatory_links:
# req-Id: tool_req__docs_saf_attrs_violates
Expand Down Expand Up @@ -773,6 +777,10 @@ needs_types:
content: ^[\s\S]+$
optional_options:
# req-Id: tool_req__docs_saf_attrs_mitigation_issue
# req-Id: tool_req__docs_saf_attrs_safety_relevant
safety_relevant: ^(yes|no)$
# req-Id: tool_req__docs_saf_attrs_root_cause
root_cause: ^[\s\S]+$
mitigation_issue: ^https://github\.com/[^/]+/[^/]+/issues/\d+$
mandatory_links:
# req-Id: tool_req__docs_saf_attrs_violates
Expand Down Expand Up @@ -800,6 +808,8 @@ needs_types:
content: ^[\s\S]+$
optional_options:
# req-Id: tool_req__docs_saf_attrs_mitigation_issue
safety_relevant: ^(yes|no)$
root_cause: ^[\s\S]+$
mitigation_issue: ^https://github\.com/[^/]+/[^/]+/issues/\d+$
mandatory_links:
# req-Id: tool_req__docs_saf_attrs_violates
Expand Down Expand Up @@ -1047,7 +1057,7 @@ needs_extra_links:
outgoing: included by

mitigated_by:
incoming: mititages
incoming: mitigates
outgoing: mitigated_by

violates:
Expand All @@ -1061,6 +1071,8 @@ needs_extra_links:
partially_verifies:
incoming: partially_verified_by
outgoing: partially_verifies


##############################################################
# Graph Checks
# The graph checks focus on the relation of the needs and their attributes.
Expand Down
Loading