Skip to content

Commit 46cfe04

Browse files
authored
feat: remove satisfies for feat_req/comp_req (#616)
1 parent e90055a commit 46cfe04

4 files changed

Lines changed: 18 additions & 12 deletions

File tree

src/extensions/score_metamodel/metamodel.yaml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -294,9 +294,7 @@ needs_types:
294294
content: ^[\s\S]+$
295295
optional_links:
296296
# req-Id: tool_req__docs_req_link_satisfies_allowed
297-
# TODO: make derived_from mandatory once downstream repos migrate from satisfies
298297
derived_from: stkh_req
299-
satisfies: stkh_req # for backward compatibility - remove once downstream repos migrate to derived_from
300298
belongs_to: feat # for evaluation
301299
satisfied_by: feat # new preferred name for belongs_to
302300
# req-Id: tool_req__docs_req_link_covers_aou
@@ -331,9 +329,7 @@ needs_types:
331329
content: ^[\s\S]+$
332330
optional_links:
333331
# req-Id: tool_req__docs_req_link_satisfies_allowed
334-
# TODO: make derived_from mandatory once downstream repos migrate from satisfies
335332
derived_from: feat_req
336-
satisfies: feat_req # for backward compatibility - remove once downstream repos migrate to derived_from
337333
belongs_to: comp # for backward compatibility
338334
satisfied_by: comp # new preferred name for belongs_to
339335
# TODO: make satisfied_by mandatory once downstream repos migrate from belongs_to
@@ -1014,8 +1010,7 @@ needs_extra_links:
10141010
incoming: satisfies
10151011
outgoing: satisfied by
10161012

1017-
# TODO: hard-deprecate satisfies in a follow-up PR once score + module_template migrate to
1018-
# derived_from. Tracked in https://github.com/eclipse-score/docs-as-code/issues/594
1013+
# kept for backward compatibility - still used by tool_req and gd_req
10191014
satisfies:
10201015
incoming: satisfied by
10211016
outgoing: satisfies
@@ -1085,7 +1080,6 @@ graph_checks:
10851080
condition: safety == QM
10861081
check:
10871082
derived_from: safety == QM
1088-
satisfies: safety == QM
10891083
explanation: QM requirements cannot be derived from ASIL requirements.
10901084

10911085
# req-Id: tool_req__docs_arch_link_qm_to_safety_req

src/extensions/score_metamodel/tests/rst/options/test_need_extends.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737

3838
.. feat_req:: Test Linkage Override
3939
:id: feat_req__test__linkage_override
40-
:satisfies: stkh_req__test__need_extends_1
40+
:derived_from: stkh_req__test__need_extends_1
4141

4242

4343
.. Replacing of options that are already set is not allowed.
@@ -59,7 +59,7 @@
5959

6060

6161
.. needextend:: feat_req__test__linkage_override
62-
:satisfies: stkh_req__test__need_extends_abc
62+
:derived_from: stkh_req__test__need_extends_abc
6363
:expect: Error when extending need: feat_req__test__linkage_override. Replace or Delete action is not allowed via needextends.
6464

6565

src/extensions/score_metamodel/tests/rst/options/test_options_extra_option.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,15 @@
3636
.. std_wp:: This is a test
3737
:id: std_wp__test__abce
3838
:expect_not: has these extra options
39+
40+
41+
.. stkh_req:: Test Stakeholder Requirement
42+
:id: stkh_req__test__abcd
43+
44+
45+
.. `satisfies` is hard-deprecated for feat_req (issue #594) — only `derived_from` is allowed now
46+
47+
.. feat_req:: Hard-deprecated satisfies test
48+
:id: feat_req__test__satisfies_deprecated
49+
:satisfies: stkh_req__test__abcd
50+
:expect: feat_req__test__satisfies_deprecated: has these extra options: `satisfies`.

src/extensions/score_metamodel/tests/rst/options/test_options_options.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@
3939

4040

4141

42-
.. Required link `satisfies` refers to wrong requirement type
42+
.. Required link `derived_from` refers to wrong requirement type
4343
4444
.. feat_req:: Child requirement
4545
:id: feat_req__abce
46-
:satisfies: std_wp__test_options__abce
47-
:expect: feat_req__abce: references 'std_wp__test_options__abce' as 'satisfies', but it must reference Stakeholder Requirement (stkh_req).
46+
:derived_from: std_wp__test_options__abce
47+
:expect: feat_req__abce: references 'std_wp__test_options__abce' as 'derived_from', but it must reference Stakeholder Requirement (stkh_req).
4848

4949

5050

0 commit comments

Comments
 (0)