backend/sdoc: print deprecation warnings when REFS/RELATIONS field is…

… not the last among all fields
strictdoc-project · Oct 20, 2023 · 56c9f21 · 56c9f21
1 parent 727fe7e
commit 56c9f21
Show file tree

Hide file tree

Showing 14 changed files with 76 additions and 9 deletions.
diff --git a/strictdoc/__init__.py b/strictdoc/__init__.py
@@ -1,6 +1,6 @@
 from strictdoc.core.environment import SDocRuntimeEnvironment
 
-__version__ = "0.0.44a16"
+__version__ = "0.0.44a17"
 
 
 environment = SDocRuntimeEnvironment(__file__)
diff --git a/strictdoc/backend/sdoc/models/requirement.py b/strictdoc/backend/sdoc/models/requirement.py
@@ -142,6 +142,24 @@ def __init__(  # pylint: disable=too-many-arguments
             ordered_fields_lookup.setdefault(field.field_name, []).append(field)
 
         if RequirementFieldName.REFS in ordered_fields_lookup:
+            refs_field: RequirementField = ordered_fields_lookup[
+                RequirementFieldName.REFS
+            ][0]
+            if fields.index(refs_field) != (len(fields) - 1):
+                print(  # noqa: T201
+                    "warning: RELATIONS (previously REFS) requirement field "
+                    "should be the last field, after all other fields. "
+                    'See the section "Relations" in the user guide for '
+                    "more details. "
+                    "Correct requirement example:\n"
+                    "[REQUIREMENT]\n"
+                    "UID: REQ-2\n"
+                    "STATEMENT: When Z, the system X shall do Y.\n"
+                    "RELATIONS:\n"
+                    "- TYPE: Parent\n"
+                    "  VALUE: REQ-1"
+                )
+
             references_opt: Optional[List[Reference]] = ordered_fields_lookup[
                 RequirementFieldName.REFS
             ][0].field_value_references

diff --git a/..._requirement_with_relation_and_role_to_existing_requirement/expected_output/document.sdoc b/..._requirement_with_relation_and_role_to_existing_requirement/expected_output/document.sdoc
@@ -29,7 +29,7 @@ TITLE: Requirement #2 title
 STATEMENT: >>>
 Requirement #2 statement.
 <<<
-REFS:
+RELATIONS:
 - TYPE: Parent
   VALUE: REQ-001
   ROLE: Refines
diff --git a/...ns/create_requirement_with_relation_to_existing_requirement/expected_output/document.sdoc b/...ns/create_requirement_with_relation_to_existing_requirement/expected_output/document.sdoc
@@ -12,6 +12,6 @@ TITLE: Requirement #2 title
 STATEMENT: >>>
 Requirement #2 statement.
 <<<
-REFS:
+RELATIONS:
 - TYPE: Parent
   VALUE: REQ-001
diff --git a/..._with_relation_to_existing_requirement_in_another_document/expected_output/document2.sdoc b/..._with_relation_to_existing_requirement_in_another_document/expected_output/document2.sdoc
@@ -24,7 +24,7 @@ TITLE: Requirement #2 title
 STATEMENT: >>>
 Requirement #2 statement.
 <<<
-REFS:
+RELATIONS:
 - TYPE: Parent
   VALUE: REQ-001
   ROLE: Refines
diff --git a/...t_relations/update_requirement_add_one_child_link_with_role/expected_output/document.sdoc b/...t_relations/update_requirement_add_one_child_link_with_role/expected_output/document.sdoc
@@ -35,7 +35,7 @@ TITLE: Requirement title #2
 STATEMENT: >>>
 Requirement statement #2.
 <<<
-REFS:
+RELATIONS:
 - TYPE: Child
   VALUE: REQ-001
   ROLE: Refines
diff --git a/...ment/_requirement_relations/update_requirement_add_one_link/expected_output/document.sdoc b/...ment/_requirement_relations/update_requirement_add_one_link/expected_output/document.sdoc
@@ -18,6 +18,6 @@ TITLE: Requirement title #2
 STATEMENT: >>>
 Requirement statement #2.
 <<<
-REFS:
+RELATIONS:
 - TYPE: Parent
   VALUE: REQ-001
diff --git a/..._relations/update_requirement_add_one_parent_link_with_role/expected_output/document.sdoc b/..._relations/update_requirement_add_one_parent_link_with_role/expected_output/document.sdoc
@@ -35,7 +35,7 @@ TITLE: Requirement title #2
 STATEMENT: >>>
 Requirement statement #2.
 <<<
-REFS:
+RELATIONS:
 - TYPE: Parent
   VALUE: REQ-001
   ROLE: Refines
diff --git a/...t/_requirement_relations/update_requirement_add_three_links/expected_output/document.sdoc b/...t/_requirement_relations/update_requirement_add_three_links/expected_output/document.sdoc
@@ -11,7 +11,7 @@ TITLE: Requirement title #1
 STATEMENT: >>>
 Requirement statement #1.
 <<<
-REFS:
+RELATIONS:
 - TYPE: Parent
   VALUE: REQ-002
 - TYPE: Parent

diff --git a/...update_requirement/_requirement_relations/update_requirement_add_three_links/test_case.py b/...update_requirement/_requirement_relations/update_requirement_add_three_links/test_case.py
@@ -9,7 +9,7 @@
 from tests.end2end.server import SDocTestServer
 
 
-class Test_UC07_G1_T02_AddThreeLinks(E2ECase):
+class Test(E2ECase):
     def test(self):
         test_setup = End2EndTestSetup(path_to_test_file=__file__)
 

diff --git a/...fs_replaced_with_relations/20_show_warning_when_refs_or_relations_are_not_last/input.sdoc b/...fs_replaced_with_relations/20_show_warning_when_refs_or_relations_are_not_last/input.sdoc
@@ -0,0 +1,13 @@
+[DOCUMENT]
+TITLE: Hello world doc
+
+[REQUIREMENT]
+UID: REQ-1
+STATEMENT: Shall do 1.
+
+[REQUIREMENT]
+UID: REQ-2
+REFS:
+- TYPE: Parent
+  VALUE: REQ-1
+STATEMENT: Shall do 1.
diff --git a/...fs_replaced_with_relations/20_show_warning_when_refs_or_relations_are_not_last/test.itest b/...fs_replaced_with_relations/20_show_warning_when_refs_or_relations_are_not_last/test.itest
@@ -0,0 +1,8 @@
+RUN: %strictdoc export %S --output-dir Output | filecheck %s --dump-input=fail
+
+CHECK: warning: RELATIONS (previously REFS) requirement field should be the last field, after all other fields. See the section "Relations" in the user guide for more details. Correct requirement example:
+CHECK: Published: Hello world doc
+
+RUN: %cat %S/Output/html/index.html | filecheck %s --dump-input=fail --check-prefix CHECK-HTML
+CHECK-HTML: Hello world doc
+CHECK-HTML: input.sdoc
diff --git a/...replaced_with_relations/21_do_not_show_warning_when_refs_or_relations_are_last/input.sdoc b/...replaced_with_relations/21_do_not_show_warning_when_refs_or_relations_are_last/input.sdoc
@@ -0,0 +1,20 @@
+[DOCUMENT]
+TITLE: Hello world doc
+
+[REQUIREMENT]
+UID: REQ-1
+STATEMENT: Shall do 1.
+
+[REQUIREMENT]
+UID: REQ-2
+STATEMENT: Shall do 1.
+REFS:
+- TYPE: Parent
+  VALUE: REQ-1
+
+[REQUIREMENT]
+UID: REQ-3
+STATEMENT: Shall do 1.
+RELATIONS:
+- TYPE: Parent
+  VALUE: REQ-1
diff --git a/...replaced_with_relations/21_do_not_show_warning_when_refs_or_relations_are_last/test.itest b/...replaced_with_relations/21_do_not_show_warning_when_refs_or_relations_are_last/test.itest
@@ -0,0 +1,8 @@
+RUN: %strictdoc export %S --output-dir Output | filecheck %s --dump-input=fail
+
+CHECK-NOT: warning: RELATIONS (previously REFS) requirement field should be the last field
+CHECK: Published: Hello world doc
+
+RUN: %cat %S/Output/html/index.html | filecheck %s --dump-input=fail --check-prefix CHECK-HTML
+CHECK-HTML: Hello world doc
+CHECK-HTML: input.sdoc