Skip to content

Commit dfa30ee

Browse files
Add failure mode attributes (#517)
Signed-off-by: Adham Negm <NDE3FE@bosch.com> Co-authored-by: Negm Adham (ETAS-ECM/ESY3) <Adham.Negm@etas.com>
1 parent 59d1740 commit dfa30ee

2 files changed

Lines changed: 44 additions & 1 deletion

File tree

docs/internals/requirements/requirements.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1227,6 +1227,37 @@ Testing
12271227

12281228
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)
12291229

1230+
----------------------------------------------------------------
1231+
Safety Analysis (DFA + FMEA) Process to Tool Requirement Mapping
1232+
----------------------------------------------------------------
1233+
1234+
.. tool_req:: Safety Analysis Safety Relevant Attribute
1235+
:id: tool_req__docs_saf_attrs_safety_relevant
1236+
:implemented: YES
1237+
:tags: Safety Analysis
1238+
:version: 1
1239+
:satisfies: gd_req__saf_attr_safety_relevant
1240+
:parent_covered: YES
1241+
1242+
Docs-As-Code shall allow needs of type :need:`tool_req__docs_saf_types` and
1243+
``plat_saf_dfa`` to have an optional ``safety_relevant`` attribute. The
1244+
allowed values are:
1245+
1246+
* yes
1247+
* no
1248+
1249+
1250+
.. tool_req:: FMEA: Root Cause Attribute
1251+
:id: tool_req__docs_saf_attrs_root_cause
1252+
:implemented: YES
1253+
:tags: Safety Analysis
1254+
:version: 1
1255+
:satisfies: gd_req__saf_attr_failure_root_cause
1256+
:parent_covered: YES
1257+
1258+
Docs-As-Code shall allow FMEA needs (``feat_saf_fmea``, ``comp_saf_fmea``)
1259+
to have an optional ``root_cause`` attribute with non-empty content.
1260+
12301261

12311262
🔒 Security Analysis
12321263
#####################

src/extensions/score_metamodel/metamodel.yaml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -698,6 +698,7 @@ needs_types:
698698
mandatory_links:
699699
violates: feat_arc_sta
700700
optional_options:
701+
safety_relevant: ^(yes|no)$
701702
mitigation_issue: ^https://github\.com/[^/]+/[^/]+/issues/\d+$
702703
optional_links:
703704
mitigated_by: stkh_req, aou_req
@@ -721,7 +722,9 @@ needs_types:
721722
violates: feat_arc_sta
722723
optional_options:
723724
# req-Id: tool_req__docs_saf_attrs_mitigation_issue
725+
safety_relevant: ^(yes|no)$
724726
mitigation_issue: ^https://github\.com/[^/]+/[^/]+/issues/\d+$
727+
725728
optional_links:
726729
# req-Id: tool_req__docs_saf_attrs_mitigated_by
727730
# (only mandatory once valid status == valid)
@@ -745,6 +748,7 @@ needs_types:
745748
content: ^[\s\S]+$
746749
optional_options:
747750
# req-Id: tool_req__docs_saf_attrs_mitigation_issue
751+
safety_relevant: ^(yes|no)$
748752
mitigation_issue: ^https://github\.com/[^/]+/[^/]+/issues/\d+$
749753
mandatory_links:
750754
# req-Id: tool_req__docs_saf_attrs_violates
@@ -773,6 +777,10 @@ needs_types:
773777
content: ^[\s\S]+$
774778
optional_options:
775779
# req-Id: tool_req__docs_saf_attrs_mitigation_issue
780+
# req-Id: tool_req__docs_saf_attrs_safety_relevant
781+
safety_relevant: ^(yes|no)$
782+
# req-Id: tool_req__docs_saf_attrs_root_cause
783+
root_cause: ^[\s\S]+$
776784
mitigation_issue: ^https://github\.com/[^/]+/[^/]+/issues/\d+$
777785
mandatory_links:
778786
# req-Id: tool_req__docs_saf_attrs_violates
@@ -800,6 +808,8 @@ needs_types:
800808
content: ^[\s\S]+$
801809
optional_options:
802810
# req-Id: tool_req__docs_saf_attrs_mitigation_issue
811+
safety_relevant: ^(yes|no)$
812+
root_cause: ^[\s\S]+$
803813
mitigation_issue: ^https://github\.com/[^/]+/[^/]+/issues/\d+$
804814
mandatory_links:
805815
# req-Id: tool_req__docs_saf_attrs_violates
@@ -1047,7 +1057,7 @@ needs_extra_links:
10471057
outgoing: included by
10481058

10491059
mitigated_by:
1050-
incoming: mititages
1060+
incoming: mitigates
10511061
outgoing: mitigated_by
10521062

10531063
violates:
@@ -1061,6 +1071,8 @@ needs_extra_links:
10611071
partially_verifies:
10621072
incoming: partially_verified_by
10631073
outgoing: partially_verifies
1074+
1075+
10641076
##############################################################
10651077
# Graph Checks
10661078
# The graph checks focus on the relation of the needs and their attributes.

0 commit comments

Comments
 (0)