Improvement: Add filter to safety plans in folder templates

MODULE.bazel

@@ -53,9 +53,9 @@ bazel_dep(name = "buildifier_prebuilt", version = "8.2.0.2")
 bazel_dep(name = "aspect_rules_lint", version = "1.4.4")
 
 # Provides, pytest & venv
-bazel_dep(name = "score_python_basics", version = "0.3.2")
+bazel_dep(name = "score_python_basics", version = "0.3.3")
 
 # Checker rule for CopyRight checks/fixes
-bazel_dep(name = "score_cr_checker", version = "0.2.2")
+bazel_dep(name = "score_cr_checker", version = "0.3.1")
 bazel_dep(name = "score_format_checker", version = "0.1.1")
 bazel_dep(name = "score_docs_as_code", version = "0.4.4")

process/folder_templates/features/feature_name/safety_analysis/dfa.rst

@@ -13,8 +13,8 @@
    # *******************************************************************************
 
 
-Dependent Failure Analysis
-==========================
+DFA (Dependent Failure Analysis)
+================================
 
 .. document:: [Your Feature Name] DFA
    :id: doc__feature_name_dfa
@@ -23,6 +23,8 @@ Dependent Failure Analysis
    :realizes: wp__feature_dfa
    :tags: template
 
+.. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram.
+
 .. attention::
     The above directive must be updated according to your Feature.
 
@@ -31,23 +33,25 @@ Dependent Failure Analysis
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs
 
-Dependent Failure Intitiators
------------------------------
+Dependent Failure Initiators
+----------------------------
 
 .. code-block:: rst
 
-   .. feat_saf_dfa:: <Element descriptor>
-      :id: feat_saf_DFA__<Feature>__<Element descriptor>
-      :violation_id: <ID from Dependent Failure Initiators list :need:`gd_guidl__dfi`>
-      :violation_effect: <Effect caused by the initiator (leading to a violation of a safety goal)>
-      :verifies: <ID from Feature Architecture>
-      :mitigated_by: < NONE|ID from Feature Requirement>
-      :sufficient: <yes|no>
-      :argument: <text to argument why measure is sufficient>
-      :status: <valid|invalid>
+    .. feat_saf_dfa:: <Title>
+       :violates: <Feature architecture>
+       :id: feat_saf_DFA__<Feature>__<Element descriptor>
+       :failure_id: <ID from DFA failure initiators :need:`gd_guidl__dfa_failure_initiators`>
+       :failure_effect: "description of failure effect of the failure initiator on the element"
+       :mitigated_by: <ID from Feature Requirement | ID from AoU Feature Requirement>
+       :mitigation_issue: <ID from Issue Tracker>
+       :sufficient: <yes|no>
+       :status: <valid|invalid>
+
+ .. note::   argument is inside the 'content'. Therefore content is mandatory
 
 .. attention::
     The above directive must be updated according to your feature DFA.
 
-    - Remove the ``code-block``
+    - The above "code-block" directive must be updated
     - Fill in all the needed information in the <brackets>

process/folder_templates/features/feature_name/safety_analysis/fmea.rst

@@ -13,16 +13,18 @@
    # *******************************************************************************
 
 
-Safety Analysis : FMEA
-======================
+FMEA (Failure Modes and Effects Analysis)
+=========================================
 
 .. document:: [Your Feature Name] FMEA
    :id: doc__feature_name_fmea
    :status: draft
    :safety: ASIL_B
-   :realizes: wp__feature_safety_analysis
+   :realizes: wp__feature_fmea
    :tags: template
 
+.. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram.
+
 .. attention::
     The above directive must be updated according to your Feature.
 
@@ -36,18 +38,21 @@ Failure Mode List
 
 .. code-block:: rst
 
-   .. feat_saf_fmea:: <Element descriptor>
-      :id: feat_saf_FMEA__<Feature>__<Element descriptor>
-      :failure_mode: <ID from fault model :need:`gd_guidl__fault_models`>
-      :failure_effect: <Effect caused by the failure (leading to a violation of a safety goal)>
-      :verifies: <ID from Feature Architecture>
-      :mitigated_by: < NONE|ID from Feature Requirement>
-      :sufficient: <yes|no>
-      :argument: <text to argument why measure is sufficient>
-      :status: <valid|invalid>
+
+    .. feat_saf_fmea:: <Title>
+       :violates: <Feature architecture>
+       :id: feat_saf_fmea__<Feature>__<Element descriptor>
+       :fault_id: <ID from fault model :need:`gd_guidl__fault_models`>
+       :failure_effect: "description of failure effect of the fault model on the element"
+       :mitigated_by: <ID from Feature Requirement | ID from AoU Feature Requirement>
+       :mitigation_issue: <ID from Issue Tracker>
+       :sufficient: <yes|no>
+       :status: <valid|invalid>
+
+ .. note::   argument is inside the 'content'. Therefore content is mandatory
 
 .. attention::
     The above directive must be updated according to your feature FMEA.
 
-    - Remove the ``code-block``
+    - The above "code-block" directive must be updated
     - Fill in all the needed information in the <brackets>

process/folder_templates/features/feature_name/safety_planning/index.rst

@@ -70,7 +70,7 @@ Feature Safety Planning
       - :need:`doc__feature_name_architecture`
       - doc :ndf:`copy('status', need_id='doc__feature_name_architecture')` & WP below
 
-    * - :need:`wp__feature_safety_analysis`
+    * - :need:`wp__feature_fmea`
       - <link to process>
       - <automated>
       - <link to issue>
@@ -111,10 +111,12 @@ Feature Safety Planning
     - Create and link the issues to plan the work products (according to :need:`gd_guidl__saf_plan_definitions`)
     - Fill the work producs links and add their status (also possible below) to create the safety package (according to :need:`gd_guidl__saf_package`)
 
+
 Feature Requirements Status
 ---------------------------
 
 .. needtable::
+   :filter: "feature_name" in docname and "requirements" in docname and docname is not None
    :style: table
    :types: feat_req
    :tags: feature_name
@@ -126,6 +128,7 @@ Feature AoU Status
 ------------------
 
 .. needtable::
+   :filter: "feature_name" in docname and "requirements" in docname and docname is not None
    :style: table
    :types: aou_req
    :tags: feature_name
@@ -137,9 +140,16 @@ Feature Architecture Status
 ---------------------------
 
 .. needtable::
+   :filter: "feature_name" in docname and "requirements" in docname and docname is not None
    :style: table
    :types: feat_arc_sta; feat_arc_dyn
    :tags: feature_name
    :columns: id;status
    :colwidths: 25,25
    :sort: title
+
+
+.. attention::
+    The above tables must be updated according to your feature safety planning.
+
+    - Modify the filter ``feature_name`` to be your Feature Name

process/folder_templates/modules/module_name/component_name/docs/safety_analysis/dfa.rst

@@ -13,8 +13,8 @@
    # *******************************************************************************
 
 
-Dependent Failure Analysis
-==========================
+DFA (Dependent Failure Analysis)
+================================
 
 .. document:: [Your Component Name] DFA
    :id: doc__component_name_dfa
@@ -23,6 +23,8 @@ Dependent Failure Analysis
    :realizes: wp__sw_component_dfa
    :tags: template
 
+.. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram.
+
 .. attention::
     The above directive must be updated according to your Component.
 
@@ -31,23 +33,25 @@ Dependent Failure Analysis
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs
 
-Dependent Failure Intitiators
------------------------------
+Dependent Failure Initiators
+----------------------------
 
 .. code-block:: rst
 
-   .. comp_saf_dfa:: <Element descriptor>
-      :id: comp_saf_DFA__<Component>__<Element descriptor>
-      :violation_id: <ID from Dependent Failure Initiators list :need:`gd_guidl__dfi`>
-      :violation_effect: <Effect caused by the initiator (leading to a violation of a safety goal)>
-      :verifies: <ID from Component Architecture>
-      :mitigated_by: < NONE|ID from Component Requirement>
-      :sufficient: <yes|no>
-      :argument: <text to argument why measure is sufficient>
-      :status: <valid|invalid>
+    .. comp_saf_dfa:: <Title>
+       :violates: <Component architecture>
+       :id: comp_saf_DFA__<Component>__<Element descriptor>
+       :failure_id: <ID from DFA failure initiators :need:`gd_guidl__dfa_failure_initiators`>
+       :failure_effect: "description of failure effect of the failure initiator on the element"
+       :mitigated_by: <ID from Component Requirement | ID from AoU Component Requirement>
+       :mitigation_issue: <ID from Issue Tracker>
+       :sufficient: <yes|no>
+       :status: <valid|invalid>
+
+.. note::   argument is inside the 'content'. Therefore content is mandatory
 
 .. attention::
     The above directive must be updated according to your component DFA.
 
-    - Remove the ``code-block``
+    - The above "code-block" directive must be updated
     - Fill in all the needed information in the <brackets>

process/folder_templates/modules/module_name/component_name/docs/safety_analysis/fmea.rst

@@ -13,16 +13,18 @@
    # *******************************************************************************
 
 
-Safety Analysis : FMEA
-======================
+FMEA (Failure Modes and Effects Analysis)
+=========================================
 
 .. document:: [Your Component Name] FMEA
    :id: doc__component_name_fmea
    :status: draft
    :safety: ASIL_B
-   :realizes: wp__sw_component_safety_analysis
+   :realizes: wp__sw_component_fmea
    :tags: template
 
+.. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram.
+
 .. attention::
     The above directive must be updated according to your Component.
 
@@ -36,18 +38,20 @@ Failure Mode List
 
 .. code-block:: rst
 
-   .. comp_saf_fmea:: <Element descriptor>
-      :id: comp_saf_FMEA__<Component>__<Element descriptor>
-      :failure_mode: <ID from fault model :need:`gd_guidl__fault_models`>
-      :failure_effect: <Effect caused by the failure (leading to a violation of a safety goal)>
-      :verifies: <ID from Component Architecture>
-      :mitigated_by: < NONE|ID from Component Requirement>
-      :sufficient: <yes|no>
-      :argument: <text to argument why measure is sufficient>
-      :status: <valid|invalid>
+    .. comp_saf_fmea:: <Title>
+       :violates: <Component architecture>
+       :id: comp_saf_fmea__<Component>__<Element descriptor>
+       :fault_id: <ID from fault model :need:`gd_guidl__fault_models`>
+       :failure_effect: "description of failure effect of the fault model on the element"
+       :mitigated_by: <ID from Component Requirement | ID from AoU Component Requirement>
+       :mitigation_issue: <ID from Issue Tracker>
+       :sufficient: <yes|no>
+       :status: <valid|invalid>
+
+.. note::   argument is inside the 'content'. Therefore content is mandatory
 
 .. attention::
     The above directive must be updated according to your component FMEA.
 
-    - Remove the ``code-block``
+    - The above "code-block" directive must be updated
     - Fill in all the needed information in the <brackets>

process/folder_templates/modules/module_name/docs/safety_mgt/module_safety_plan.rst

@@ -197,7 +197,7 @@ Component <name> Workproducts List
           - Checklist used in Pull Request Review
           - n/a
 
-        * - :need:`wp__sw_component_safety_analysis`
+        * - :need:`wp__sw_component_fmea`
           - <Link to process>
           - <automated>
           - <Link to issue>
@@ -281,7 +281,7 @@ If the OSS element is classified as a
           - <Link to issue>
           - <Reasoning for tailoring, needed for example in case of deficits in process Id 3&4 and complexity Ids 1&4>
 
-        * - :need:`wp__sw_component_safety_analysis`
+        * - :need:`wp__sw_component_fmea`
           - <Link to issue>
           - <Reasoning for tailoring, could help arguing too high cyclomatic complexity covered by safety mechanisms>
 
@@ -316,6 +316,7 @@ Component Requirements Status
 -----------------------------
 
 .. needtable::
+   :filter: "feature_name" in docname and "requirements" in docname and docname is not None
    :style: table
    :types: comp_req
    :tags: component_name
@@ -327,6 +328,7 @@ Component AoU Status
 --------------------
 
 .. needtable::
+   :filter: "feature_name" in docname and "requirements" in docname and docname is not None
    :style: table
    :types: aou_req
    :tags: component_name
@@ -338,9 +340,16 @@ Component Architecture Status
 -----------------------------
 
 .. needtable::
+   :filter: "feature_name" in docname and "requirements" in docname and docname is not None
    :style: table
    :types: comp_arc_sta; comp_arc_dyn
    :tags: component_name
    :columns: id;status;tags
    :colwidths: 25,25,25
    :sort: title
+
+
+.. attention::
+    The above tables must be updated according to your feature safety planning.
+
+    - Modify the filter ``feature_name`` to be your Feature Name