Skip to content

Commit 425f2a0

Browse files
stanislawstanislaw
authored
Merge pull request #2517 from strictdoc-project/stanislaw/trace2
 trace: more traces to L2: ReqIF, clone node, delete node, tool identification
2 parents 0ff7825 + af93c44 commit 425f2a0

File tree

52 files changed

+482
-238
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+482
-238
lines changed

‎docs/strictdoc_20_L1_Open_Requirements_Tool.sdoc‎

Lines changed: 191 additions & 182 deletions
Large diffs are not rendered by default.

‎docs/strictdoc_21_L2_StrictDoc_Requirements.sdoc‎

Lines changed: 117 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -737,23 +737,6 @@ RELATIONS:
737737
- TYPE: File
738738
VALUE: strictdoc/server/routers/main_router.py
739739

740-
[REQUIREMENT]
741-
MID: f2fd90ad8a2946e7b085233a9c7a8a75
742-
UID: SDOC-SRS-51
743-
STATUS: Active
744-
TITLE: Export to HTML content to PDF (HTML2PDF)
745-
STATEMENT: >>>
746-
StrictDoc shall allow exporting documents and entire documentation trees to PDF.
747-
<<<
748-
RATIONALE: >>>
749-
As required by the parent requirement, PDF is one of the most common documentation formats.
750-
<<<
751-
RELATIONS:
752-
- TYPE: Parent
753-
VALUE: DO178-5
754-
- TYPE: Parent
755-
VALUE: SDOC-SSS-96
756-
757740
[REQUIREMENT]
758741
MID: 8811f0ef33de4365bc66a602a8c184f6
759742
UID: SDOC-SRS-48
@@ -849,6 +832,18 @@ RELATIONS:
849832
- TYPE: Parent
850833
VALUE: SDOC-SSS-3
851834

835+
[REQUIREMENT]
836+
MID: 9b291b5df5914f13b23fb8c367be0a24
837+
UID: SDOC-SRS-161
838+
STATUS: Active
839+
TITLE: Clone node from existing node
840+
STATEMENT: >>>
841+
StrictDoc shall support cloning nodes from existing nodes.
842+
<<<
843+
RATIONALE: >>>
844+
Simplifies the creation of similar nodes.
845+
<<<
846+
852847
[REQUIREMENT]
853848
MID: 13968ae160744e10ba8979eaee2f4f54
854849
UID: SDOC-SRS-55
@@ -861,6 +856,15 @@ RELATIONS:
861856
- TYPE: Parent
862857
VALUE: SDOC-SSS-4
863858

859+
[REQUIREMENT]
860+
MID: 0ec87f08626a4839b5951d98fef9e0e1
861+
UID: SDOC-SRS-162
862+
STATUS: Active
863+
TITLE: Delete node
864+
STATEMENT: >>>
865+
StrictDoc's Document screen shall support the deletion of document nodes.
866+
<<<
867+
864868
[REQUIREMENT]
865869
MID: b805e36294764e8f8cb5a88ab8fa0467
866870
UID: SDOC-SRS-159
@@ -1043,6 +1047,38 @@ RELATIONS:
10431047

10441048
[[/SECTION]]
10451049

1050+
[[SECTION]]
1051+
MID: 181dfbcbbfac41e18f7fb09af0df8f4e
1052+
TITLE: Screen: HTML2PDF
1053+
1054+
[REQUIREMENT]
1055+
MID: f2fd90ad8a2946e7b085233a9c7a8a75
1056+
UID: SDOC-SRS-51
1057+
STATUS: Active
1058+
TITLE: Export to HTML content to PDF (HTML2PDF)
1059+
STATEMENT: >>>
1060+
StrictDoc shall allow exporting documents and entire documentation trees to PDF.
1061+
<<<
1062+
RATIONALE: >>>
1063+
As required by the parent requirement, PDF is one of the most common documentation formats.
1064+
<<<
1065+
RELATIONS:
1066+
- TYPE: Parent
1067+
VALUE: DO178-5
1068+
- TYPE: Parent
1069+
VALUE: SDOC-SSS-96
1070+
1071+
[REQUIREMENT]
1072+
MID: 6cfcb21b3f1949f49d13af6b00d3d37a
1073+
UID: SDOC-SRS-160
1074+
STATUS: Active
1075+
TITLE: Custom PDF export template
1076+
STATEMENT: >>>
1077+
StrictDoc shall support the customization of the PDF export template.
1078+
<<<
1079+
1080+
[[/SECTION]]
1081+
10461082
[[SECTION]]
10471083
MID: ddf15b3113a54107979752ec192e2ded
10481084
TITLE: Screen: Project statistics
@@ -1118,6 +1154,55 @@ RELATIONS:
11181154

11191155
[[/SECTION]]
11201156

1157+
[[SECTION]]
1158+
MID: 63df985038374acb82e9b4185eff5a7e
1159+
TITLE: Screen: Source coverage
1160+
1161+
[REQUIREMENT]
1162+
MID: 3aeb1eea0dba4041a9161a1a8d291999
1163+
UID: SDOC-SRS-35
1164+
STATUS: Active
1165+
TITLE: Project source code coverage
1166+
STATEMENT: >>>
1167+
StrictDoc shall generate project source code coverage information.
1168+
1169+
NOTE: Source code information can be visualized using both web or CLI interfaces.
1170+
<<<
1171+
RELATIONS:
1172+
- TYPE: Parent
1173+
VALUE: SDOC-SSS-72
1174+
- TYPE: Parent
1175+
VALUE: DO178-13
1176+
- TYPE: File
1177+
FORMAT: Sourcecode
1178+
VALUE: strictdoc/export/html/generators/source_file_coverage.py
1179+
1180+
[[/SECTION]]
1181+
1182+
[[SECTION]]
1183+
MID: 9c19eea544ec4d90bb65fd8fd9b13cc4
1184+
TITLE: Screen: Single source file coverage
1185+
1186+
[REQUIREMENT]
1187+
MID: 56ecfb19152e45b09c0e55de2d1d5f05
1188+
UID: SDOC-SRS-36
1189+
STATUS: Active
1190+
TITLE: Single source file coverage
1191+
STATEMENT: >>>
1192+
StrictDoc shall generate single file traceability information.
1193+
<<<
1194+
RATIONALE: >>>
1195+
With this capability in place, it is possible to focus on a single implementation file's links to requirements which helps in the code reviews and inspections.
1196+
<<<
1197+
RELATIONS:
1198+
- TYPE: Parent
1199+
VALUE: SDOC-SSS-72
1200+
- TYPE: File
1201+
FORMAT: Sourcecode
1202+
VALUE: strictdoc/export/html/generators/source_file_view_generator.py
1203+
1204+
[[/SECTION]]
1205+
11211206
[[SECTION]]
11221207
MID: 14ad600308434e6baaeef02d3e90b720
11231208
TITLE: Screen: Traceability matrix
@@ -1443,43 +1528,6 @@ A reference example: Generating test specifications from the TEST_SPEC nodes whi
14431528

14441529
[[/SECTION]]
14451530

1446-
[REQUIREMENT]
1447-
MID: 3aeb1eea0dba4041a9161a1a8d291999
1448-
UID: SDOC-SRS-35
1449-
STATUS: Active
1450-
TITLE: Generate project source code coverage
1451-
STATEMENT: >>>
1452-
StrictDoc shall generate project source code coverage information.
1453-
1454-
NOTE: Source code information can be visualized using both web or CLI interfaces.
1455-
<<<
1456-
RELATIONS:
1457-
- TYPE: Parent
1458-
VALUE: SDOC-SSS-72
1459-
- TYPE: Parent
1460-
VALUE: DO178-13
1461-
- TYPE: File
1462-
FORMAT: Sourcecode
1463-
VALUE: strictdoc/export/html/generators/source_file_coverage.py
1464-
1465-
[REQUIREMENT]
1466-
MID: 56ecfb19152e45b09c0e55de2d1d5f05
1467-
UID: SDOC-SRS-36
1468-
STATUS: Active
1469-
TITLE: Generate single source file coverage
1470-
STATEMENT: >>>
1471-
StrictDoc shall generate single file traceability information.
1472-
<<<
1473-
RATIONALE: >>>
1474-
With this capability in place, it is possible to focus on a single implementation file's links to requirements which helps in the code reviews and inspections.
1475-
<<<
1476-
RELATIONS:
1477-
- TYPE: Parent
1478-
VALUE: SDOC-SSS-72
1479-
- TYPE: File
1480-
FORMAT: Sourcecode
1481-
VALUE: strictdoc/export/html/generators/source_file_view_generator.py
1482-
14831531
[[/SECTION]]
14841532

14851533
[[SECTION]]
@@ -1753,6 +1801,18 @@ RELATIONS:
17531801
MID: 44eb09d0e5b542d5984d234167e6f337
17541802
TITLE: User experience
17551803

1804+
[REQUIREMENT]
1805+
MID: 2bfb3703b218411b87864733bffb59cf
1806+
UID: SDOC-SRS-163
1807+
STATUS: Active
1808+
TITLE: StrictDoc identification
1809+
STATEMENT: >>>
1810+
StrictDoc shall provide 'about' and 'version' commands that display the project's title, current version, license, and links to the project's web pages.
1811+
<<<
1812+
RELATIONS:
1813+
- TYPE: Parent
1814+
VALUE: SDOC-SSS-97
1815+
17561816
[[SECTION]]
17571817
MID: 821c01118a9643a188a4ecc5b0cec6a5
17581818
UID: SECTION-SSRS-Strict-mode-by-default
@@ -1766,6 +1826,9 @@ TITLE: Warnings are errors
17661826
STATEMENT: >>>
17671827
StrictDoc's default mode of operation shall treat all warnings as errors.
17681828
<<<
1829+
RATIONALE: >>>
1830+
When warnings are treated as errors, the user becomes aware of potential issues as soon as they appear.
1831+
<<<
17691832
RELATIONS:
17701833
- TYPE: Parent
17711834
VALUE: SDOC-SSS-78

‎strictdoc/commands/about_command.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
@relation(SDOC-SRS-163, scope=file)
3+
"""
4+
15
import strictdoc
26

37

‎strictdoc/commands/version_command.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
@relation(SDOC-SRS-163, scope=file)
3+
"""
4+
15
import strictdoc
26

37

‎tests/end2end/project_options/features/02_search_feature_precondition_failed_when_not_activated/test_case.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
@relation(SDOC-SRS-155, scope=file)
3+
"""
4+
15
import os
26

37
from tests.end2end.e2e_case import E2ECase

‎tests/end2end/screens/document/_export_to_pdf/export_to_pdf_basic/test_case.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
@relation(SDOC-SRS-51, scope=file)
3+
"""
4+
15
import os
26
import shutil
37

‎tests/end2end/screens/document/_export_to_pdf/export_to_pdf_with_picture/test_case.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
@relation(SDOC-SRS-51, scope=file)
3+
"""
4+
15
import os
26
import shutil
37

‎tests/end2end/screens/document/clone_requirement/clone_requirement/expected_output/document.sdoc‎ renamed to ‎tests/end2end/screens/document/clone_node/clone_node/expected_output/document.sdoc‎

File renamed without changes.

‎tests/end2end/screens/document/clone_requirement/clone_requirement/expected_output/strictdoc.toml‎ renamed to ‎tests/end2end/screens/document/clone_node/clone_node/expected_output/strictdoc.toml‎

File renamed without changes.

‎tests/end2end/screens/document/clone_requirement/clone_requirement/input/document.sdoc‎ renamed to ‎tests/end2end/screens/document/clone_node/clone_node/input/document.sdoc‎

File renamed without changes.

0 commit comments

Comments
 (0)