Skip to content

remove detail design sphinx elements #566

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.

Sign up for GitHub

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
RolandJentschETAS wants to merge 1 commit into
base: main
Choose a base branch
from
Open

remove detail design sphinx elements #566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 0 additions & 47 deletions docs/internals/requirements/requirements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -794,53 +794,6 @@ Architecture Attributes

e.g. gd_req__req_linkage_architecture


.. tool_req:: Static Diagram for Unit Interactions
:id: tool_req__docs_dd_sta
:tags: Detailed Design & Code
:version: 1
:implemented: YES
:parent_covered: YES
:satisfies: gd_req__impl_static_diagram

Provide needs type ``dd_sta`` for static diagrams showing unit interactions as UML.

.. .. tool_req:: Dynamic Diagram for Unit Interactions
.. :id: tool_req__docs_dd_dyn
.. :tags: Detailed Design & Code
.. :implemented: YES
.. :parent_covered: YES
.. :satisfies: gd_req__impl_dynamic_diagram

.. Provide needs type ``dd_dyn`` for dynamic diagrams showing unit interactions as UML.



.. tool_req:: Diagram mandatory safety and status attributes
:id: tool_req__docs_dd_diagram_safety_status
:tags: Detailed Design & Code
:version: 1
:implemented: YES
:satisfies:
gd_req__impl_diagram_safety,
gd_req__impl_diagram_status,

Diagrams (``dd_sta``, ``dd_dyn``) shall have mandatory ``safety`` (``QM`` or ``ASIL_B``) and ``status`` (``valid`` or ``invalid``) attributes.


.. tool_req:: Mandatory description for diagrams, units, and interfaces
:id: tool_req__docs_dd_description
:tags: Detailed Design & Code
:version: 1
:implemented: YES
:satisfies:
gd_req__impl_diagram_description,
gd_req__impl_unit_description,
gd_req__impl_interface_description,

``dd_sta``, ``dd_dyn``, ``sw_unit``, and ``sw_unit_int`` needs shall have non-empty content serving as description.


Testing
#######

Expand Down
65 changes: 0 additions & 65 deletions src/extensions/score_metamodel/metamodel.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -672,71 +672,6 @@ needs_types:
template: ^.*$
parts: 3

# Implementation
# req-Id: tool_req__docs_dd_sta
dd_sta:
title: Static detailed design
color: #FEDCD2
style: card
mandatory_options:
security: ^(YES|NO)$
safety: ^(QM|ASIL_B)$
status: ^(valid|invalid)$
# req-Id: tool_req__docs_dd_description
content: ^[\s\S]+$
mandatory_links:
implements: comp_req
satisfies: comp_arc_sta
optional_links:
belongs_to: comp # TODO: make it mandatory
includes: sw_unit, sw_unit_int
parts: 3

dd_dyn:
title: Dynamic detailed design
color: #FEDCD2
style: card
mandatory_options:
security: ^(YES|NO)$
safety: ^(QM|ASIL_B)$
status: ^(valid|invalid)$
# req-Id: tool_req__docs_dd_description
content: ^[\s\S]+$
mandatory_links:
implements: comp_req
satisfies: comp_arc_sta
optional_links:
belongs_to: comp # TODO: make it mandatory
includes: sw_unit, sw_unit_int
parts: 3

sw_unit:
title: Software unit
mandatory_options:
security: ^(YES|NO)$
safety: ^(QM|ASIL_B)$
status: ^(valid|invalid)$
# req-Id: tool_req__docs_dd_description
content: ^[\s\S]+$
optional_links:
belongs_to: comp # TODO: make it mandatory
parts: 3

sw_unit_int:
title: Software unit interface
color: #FEDCD2
style: card
mandatory_options:
security: ^(YES|NO)$
safety: ^(QM|ASIL_B)$
status: ^(valid|invalid)$
# req-Id: tool_req__docs_dd_description
content: ^[\s\S]+$
optional_links:
belongs_to: comp # TODO: make it mandatory
implements: real_arc_int, real_arc_int_op
parts: 3

# DFA (Dependent Failure Analysis)
# No requirement!!
plat_saf_dfa:
Expand Down
19 changes: 1 addition & 18 deletions src/extensions/score_metamodel/tests/rst/architecture/architecture_tests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Component 1
:status: invalid
:implements: logic_arc_int__test_feature_1__test_interface_1
:uses: logic_arc_int__test_feature_1__test_interface_2
:consists_of: sw_unit__component_1__test_unit_1, comp__test_sub_component_1
:consists_of: comp__test_sub_component_1

.. comp_req:: Test Component 1 Requirement 1
:id: comp_req__test_component_1__requirement_1
Expand All @@ -104,21 +104,12 @@ Component 1

Test Component 1 Requirement

.. sw_unit:: SW Test Unit 1
:id: sw_unit__component_1__test_unit_1
:security: YES
:safety: ASIL_B
:status: invalid

Test unit 1 for component 1.

.. comp:: Test Sub Component 1
:id: comp__test_sub_component_1
:security: YES
:safety: ASIL_B
:status: invalid
:implements: logic_arc_int__test_feature_1__test_interface_1
:consists_of: sw_unit__sub_component_1__test_unit_2

.. comp_arc_sta:: Test Component Architecture Component 1
:id: comp_arc_sta__feature_name__component_name
Expand All @@ -129,14 +120,6 @@ Component 1
:implements: logic_arc_int__test_feature_1__test_interface_1
:belongs_to: comp__test_sub_component_1

.. sw_unit:: SW Test Unit 2
:id: sw_unit__sub_component_1__test_unit_2
:security: YES
:safety: ASIL_B
:status: invalid

Test unit 2 for sub component 1.

Component 1
~~~~~~~~~~~

Expand Down
102 changes: 0 additions & 102 deletions src/extensions/score_metamodel/tests/rst/options/test_options_options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,108 +446,6 @@ Expect no errors related to "violates" field. We need to be generic for expect-n
:safety: ASIL_B


#EXPECT-NOT: does not follow pattern

.. dd_sta:: This is a test
:id: dd_sta__test_good_1
:status: valid
:safety: QM

Some content to satisfy the mandatory description requirement.

#EXPECT-NOT: does not follow pattern

.. dd_sta:: This is a test
:id: dd_sta__test_good_2
:status: valid
:safety: ASIL_B

Some content to satisfy the mandatory description requirement.


#EXPECT-NOT: does not follow pattern

.. dd_dyn:: This is a test
:id: dd_dyn__test_good_1
:status: valid
:safety: QM

Some content to satisfy the mandatory description requirement.

#EXPECT-NOT: does not follow pattern

.. dd_dyn:: This is a test
:id: dd_dyn__test_good_2
:status: valid
:safety: ASIL_B

Some content to satisfy the mandatory description requirement.


#EXPECT: dd_sta__test_no_content: is missing required attribute: `content`.

.. dd_sta:: Missing content
:id: dd_sta__test_no_content
:status: valid
:safety: QM


#EXPECT: sw_unit__test_no_content: is missing required attribute: `content`.

.. sw_unit:: Missing content
:id: sw_unit__test_no_content
:status: valid
:safety: QM


#EXPECT-NOT: does not follow pattern

.. sw_unit:: This is a test
:id: sw_unit__test_good_1
:status: valid
:safety: QM

Some content to satisfy the mandatory description requirement.


#EXPECT-NOT: does not follow pattern

.. sw_unit:: This is a test
:id: sw_unit__test_good_2
:status: valid
:safety: ASIL_B

Some content to satisfy the mandatory description requirement.


#EXPECT-NOT: does not follow pattern

.. sw_unit_int:: This is a test
:id: sw_unit_int__test_good_1
:status: valid
:safety: QM

Some content to satisfy the mandatory description requirement.


#EXPECT-NOT: does not follow pattern

.. sw_unit_int:: This is a test
:id: sw_unit_int__test_good_2
:status: valid
:safety: ASIL_B

Some content to satisfy the mandatory description requirement.


#EXPECT: sw_unit_int__test_no_content: is missing required attribute: `content`.

.. sw_unit_int:: Missing content
:id: sw_unit_int__test_no_content
:status: valid
:safety: QM



..
Ensuring that empty content is detected correctly
Expand Down
Loading