Skip to content

Commit 33fc49d

Browse files
authored
feat: Satisfy gd_req__impl_ requirements (#559)
* feat: Satisfy gd_req__impl_ requirements * fix: review feedback
1 parent d324000 commit 33fc49d

4 files changed

Lines changed: 144 additions & 46 deletions

File tree

docs/internals/requirements/requirements.rst

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,12 @@ This section provides an overview of current process requirements and their clar
9393
gd_req__arch_attribute_uid,
9494
gd_req__saf_attr_uid,
9595
gd_req__req_check_mandatory,
96+
gd_req__impl_diagram_uid,
97+
gd_req__impl_unit_uid,
98+
gd_req__impl_interface_uid,
9699
:parent_covered: NO: cannot check non-existent "doc__naming_conventions" in gd_req__req_attr_uid
97100

98-
Docs-as-Code shall enforce that Need IDs follow the following naming scheme:
101+
Enforce that Need IDs follow the following naming scheme:
99102

100103
* A prefix indicating the need type (e.g. `feature__`)
101104
* A middle part matching the hierarchical structure of the need:
@@ -117,9 +120,10 @@ This section provides an overview of current process requirements and their clar
117120
:satisfies:
118121
gd_req__req_attr_title,
119122
gd_req__saf_attr_title,
123+
gd_req__impl_diagram_title
120124
:parent_covered: NO: Can not ensure summary
121125

122-
Docs-as-Code shall enforce that all needs have titles and titles do not contain the following words:
126+
Enforce that all needs have titles and titles do not contain the following words:
123127

124128
* shall
125129
* must
@@ -811,6 +815,32 @@ Architecture Attributes
811815
.. Provide needs type ``dd_dyn`` for dynamic diagrams showing unit interactions as UML.
812816
813817
818+
819+
.. tool_req:: Diagram mandatory safety and status attributes
820+
:id: tool_req__docs_dd_diagram_safety_status
821+
:tags: Detailed Design & Code
822+
:version: 1
823+
:implemented: YES
824+
:satisfies:
825+
gd_req__impl_diagram_safety,
826+
gd_req__impl_diagram_status,
827+
828+
Diagrams (``dd_sta``, ``dd_dyn``) shall have mandatory ``safety`` (``QM`` or ``ASIL_B``) and ``status`` (``valid`` or ``invalid``) attributes.
829+
830+
831+
.. tool_req:: Mandatory description for diagrams, units, and interfaces
832+
:id: tool_req__docs_dd_description
833+
:tags: Detailed Design & Code
834+
:version: 1
835+
:implemented: YES
836+
:satisfies:
837+
gd_req__impl_diagram_description,
838+
gd_req__impl_unit_description,
839+
gd_req__impl_interface_description,
840+
841+
``dd_sta``, ``dd_dyn``, ``sw_unit``, and ``sw_unit_int`` needs shall have non-empty content serving as description.
842+
843+
814844
Testing
815845
#######
816846

src/extensions/score_metamodel/metamodel.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -682,6 +682,8 @@ needs_types:
682682
security: ^(YES|NO)$
683683
safety: ^(QM|ASIL_B)$
684684
status: ^(valid|invalid)$
685+
# req-Id: tool_req__docs_dd_description
686+
content: ^[\s\S]+$
685687
mandatory_links:
686688
implements: comp_req
687689
satisfies: comp_arc_sta
@@ -698,6 +700,8 @@ needs_types:
698700
security: ^(YES|NO)$
699701
safety: ^(QM|ASIL_B)$
700702
status: ^(valid|invalid)$
703+
# req-Id: tool_req__docs_dd_description
704+
content: ^[\s\S]+$
701705
mandatory_links:
702706
implements: comp_req
703707
satisfies: comp_arc_sta
@@ -712,6 +716,8 @@ needs_types:
712716
security: ^(YES|NO)$
713717
safety: ^(QM|ASIL_B)$
714718
status: ^(valid|invalid)$
719+
# req-Id: tool_req__docs_dd_description
720+
content: ^[\s\S]+$
715721
optional_links:
716722
belongs_to: comp # TODO: make it mandatory
717723
parts: 3
@@ -724,6 +730,8 @@ needs_types:
724730
security: ^(YES|NO)$
725731
safety: ^(QM|ASIL_B)$
726732
status: ^(valid|invalid)$
733+
# req-Id: tool_req__docs_dd_description
734+
content: ^[\s\S]+$
727735
optional_links:
728736
belongs_to: comp # TODO: make it mandatory
729737
implements: real_arc_int, real_arc_int_op

src/extensions/score_metamodel/tests/rst/architecture/architecture_tests.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,8 @@ Component 1
110110
:safety: ASIL_B
111111
:status: invalid
112112

113+
Test unit 1 for component 1.
114+
113115
.. comp:: Test Sub Component 1
114116
:id: comp__test_sub_component_1
115117
:security: YES
@@ -133,6 +135,8 @@ Component 1
133135
:safety: ASIL_B
134136
:status: invalid
135137

138+
Test unit 2 for sub component 1.
139+
136140
Component 1
137141
~~~~~~~~~~~
138142

0 commit comments

Comments
 (0)