backend/sdoc: allow spaces, colons, underscores, dashes in the UID and MultipleChoice fields

Related to #2197

Author: stanislaw

strictdoc/backend/sdoc/grammar/grammar.py

@@ -1,4 +1,4 @@
-REGEX_UID = r"([\w]+[\w()\-\/. ]*)"
+REGEX_UID = r"([\w]+[\w()\-\/.: ]*)"
 
 NEGATIVE_MULTILINE_STRING_START = "(?!>>>\n)"
 NEGATIVE_MULTILINE_STRING_END = "(?!^<<<)"

strictdoc/backend/sdoc/validations/sdoc_validator.py

@@ -19,7 +19,7 @@
     RequirementFieldName,
 )
 
-MULTIPLE_CHOICE_FIELD_KW = r"[a-zA-Z0-9\/_]+"
+MULTIPLE_CHOICE_FIELD_KW = r"[a-zA-Z0-9\/\-_ ]+"
 MULTIPLE_CHOICE_FIELD_REGEX = re.compile(
     rf"^{MULTIPLE_CHOICE_FIELD_KW}(, {MULTIPLE_CHOICE_FIELD_KW})*$"
 )

tests/integration/features/document_grammar/type_system/tag/validation/01_invalid_value/input.sdoc

@@ -13,4 +13,4 @@ ELEMENTS:
     REQUIRED: False
 
 [REQUIREMENT]
-TAG_FIELD: A B C
+TAG_FIELD: A#B#C

tests/integration/features/document_grammar/type_system/tag/validation/01_invalid_value/test.itest

@@ -1,6 +1,6 @@
 RUN: %expect_exit 1 %strictdoc export %S --output-dir Output/ | filecheck %s --dump-input=fail
 
 CHECK: error: could not parse file: {{.*}}input.sdoc.
-CHECK: Semantic error: Requirement field of type Tag is invalid: A B C.
+CHECK: Semantic error: Requirement field of type Tag is invalid: A#B#C.
 CHECK: Location: {{.*}}input.sdoc:15:1
 CHECK: Hint: Tag field requires ', '-separated values.

tests/unit/strictdoc/backend/sdoc/test_dsl_passthrough.py

@@ -78,6 +78,18 @@ def test_005_requirement_UID_supports_special_characters(
 [REQUIREMENT]
 UID: FOO/1
 TITLE: Hello
+
+[REQUIREMENT]
+UID: FOO_1
+TITLE: Hello
+
+[REQUIREMENT]
+UID: FOO 1
+TITLE: Hello
+
+[REQUIREMENT]
+UID: FOO::1
+TITLE: Hello
 """.lstrip()
 
     reader = SDReader()
@@ -1011,7 +1023,7 @@ def test_edge_case_03_uid_present_but_empty_with_space_character():
         _ = reader.read(input_sdoc)
 
     assert exc_info.type is TextXSyntaxError
-    assert "Expected '([\\w]+[\\w()\\-\\/. ]*)'" in exc_info.value.args[
+    assert "Expected '([\\w]+[\\w()\\-\\/.: ]*)'" in exc_info.value.args[
         0
     ].decode("utf-8")
 
@@ -1032,7 +1044,7 @@ def test_edge_case_04_uid_present_but_empty_with_two_space_characters():
         _ = reader.read(input_sdoc)
 
     assert exc_info.type is TextXSyntaxError
-    assert "Expected '([\\w]+[\\w()\\-\\/. ]*)'" in exc_info.value.args[
+    assert "Expected '([\\w]+[\\w()\\-\\/.: ]*)'" in exc_info.value.args[
         0
     ].decode("utf-8")
 
@@ -1056,8 +1068,8 @@ def test_edge_case_10_empty_multiline_field():
     assert (
         "Expected '^\\[ANCHOR: ' or '[LINK: ' or "
         "'(?ms)(?!^<<<)(?!\\[LINK: "
-        "([\\w]+[\\w()\\-\\/. ]*))(?!^\\[ANCHOR: "
-        "([\\w]+[\\w()\\-\\/. ]*)).'" in exc_info.value.args[0].decode("utf-8")
+        "([\\w]+[\\w()\\-\\/.: ]*))(?!^\\[ANCHOR: "
+        "([\\w]+[\\w()\\-\\/.: ]*)).'" in exc_info.value.args[0].decode("utf-8")
     )
 
 

tests/unit/strictdoc/backend/sdoc/test_dsl_passthrough_grammar.py

@@ -71,36 +71,20 @@ def test_151_grammar_single_choice(default_project_config):
   - TITLE: SINGLE_CHOICE_FIELD
     TYPE: SingleChoice(A, B, C)
     REQUIRED: True
-  - TITLE: STATEMENT
-    TYPE: String
-    REQUIRED: False
-
-[LOW_LEVEL_REQUIREMENT]
-SINGLE_CHOICE_FIELD: A
-""".lstrip()
-
-    expected_sdoc = """
-[DOCUMENT]
-TITLE: Test Doc
-
-[GRAMMAR]
-ELEMENTS:
-- TAG: TEXT
-  FIELDS:
-  - TITLE: STATEMENT
-    TYPE: String
+  - TITLE: SINGLE_CHOICE_FIELD_2
+    TYPE: SingleChoice(Test/Hardware, Test/Software)
     REQUIRED: True
-- TAG: LOW_LEVEL_REQUIREMENT
-  FIELDS:
-  - TITLE: SINGLE_CHOICE_FIELD
-    TYPE: SingleChoice(A, B, C)
+  - TITLE: SINGLE_CHOICE_FIELD_3
+    TYPE: SingleChoice(Hardware test, Software test)
     REQUIRED: True
   - TITLE: STATEMENT
     TYPE: String
     REQUIRED: False
 
 [LOW_LEVEL_REQUIREMENT]
 SINGLE_CHOICE_FIELD: A
+SINGLE_CHOICE_FIELD: Test/Hardware
+SINGLE_CHOICE_FIELD: Hardware test
 """.lstrip()
 
     reader = SDReader()
@@ -111,7 +95,7 @@ def test_151_grammar_single_choice(default_project_config):
     writer = SDWriter(default_project_config)
     output = writer.write(document)
 
-    assert expected_sdoc == output
+    assert input_sdoc == output
 
 
 def test_152_grammar_multiple_choice(default_project_config):
@@ -134,13 +118,25 @@ def test_152_grammar_multiple_choice(default_project_config):
   - TITLE: MULTIPLE_CHOICE_FIELD_2
     TYPE: MultipleChoice(Review, Test/Hardware)
     REQUIRED: True
+  - TITLE: MULTIPLE_CHOICE_FIELD_3
+    TYPE: MultipleChoice(Review of design, Hardware test)
+    REQUIRED: True
+  - TITLE: MULTIPLE_CHOICE_FIELD_4
+    TYPE: MultipleChoice(review_of_design, hardware_test)
+    REQUIRED: True
+  - TITLE: MULTIPLE_CHOICE_FIELD_5
+    TYPE: MultipleChoice(review-of-design, hardware-test)
+    REQUIRED: True
   - TITLE: STATEMENT
     TYPE: String
     REQUIRED: False
 
 [LOW_LEVEL_REQUIREMENT]
 MULTIPLE_CHOICE_FIELD: A, C
 MULTIPLE_CHOICE_FIELD_2: Review, Test/Hardware
+MULTIPLE_CHOICE_FIELD_3: Review of design, Hardware test
+MULTIPLE_CHOICE_FIELD_4: review_of_design, hardware_test
+MULTIPLE_CHOICE_FIELD_5: review-of-design, hardware-test
 """
 
     reader = SDReader()