[[NODE]] migration: adjust Diff/Changelog, add end-to-end test

Author: stanislaw

strictdoc/core/document_finder.py

@@ -27,6 +27,7 @@
     PathFinder,
 )
 from strictdoc.core.project_config import ProjectConfig
+from strictdoc.helpers.exception import StrictDocException
 from strictdoc.helpers.parallelizer import Parallelizer
 from strictdoc.helpers.paths import SDocRelativePath
 from strictdoc.helpers.textx import drop_textx_meta
@@ -43,13 +44,11 @@ def find_sdoc_content(
         for paths_to_files_or_doc in project_config.input_paths:
             if not os.path.exists(paths_to_files_or_doc):
                 sys.stdout.flush()
-                err = (
+                raise StrictDocException(
                     "error: "
                     "Provided path is neither a single file or a folder: "
                     f"'{paths_to_files_or_doc}'"
                 )
-                print(err)  # noqa: T201
-                sys.exit(1)
 
         with measure_performance("Completed finding SDoc and assets"):
             file_tree, asset_manager = DocumentFinder._build_file_tree(

strictdoc/export/html/templates/components/table_key_value/index.jinja

@@ -12,5 +12,10 @@
   {% else %}
     <div class="sdoc-table_key_value-key">{{ key_value_pair["Key"] }}</div>
   {% endif %}
-  <div class="sdoc-table_key_value-value">{{ key_value_pair["Value"] }}</div>
+  <div
+    class="sdoc-table_key_value-value"
+    data-testid="table-row-value-{{ key_value_pair["Key"].lower().replace(" ", "-") }}"
+  >
+    {{ key_value_pair["Value"] }}
+  </div>
 {% endif %}

strictdoc/export/html/templates/screens/git/diff_content.jinja

@@ -34,11 +34,11 @@
 
             {%- set document_iterator = traceability_index.get_document_iterator(document) -%}
             {%- for section_or_requirement in document_iterator.all_content(print_fragments=True, print_fragments_from_files=False) %}
-              {%- if section_or_requirement.is_requirement() %}
+              {%- if section_or_requirement.is_requirement() and section_or_requirement.node_type != "SECTION" %}
                 {%- set requirement = section_or_requirement %}
                 {% include "screens/git/node/requirement.jinja" %}
 
-              {%- elif section_or_requirement.is_section() %}
+              {%- elif section_or_requirement.is_section() or section_or_requirement.node_type == "SECTION" %}
                 {%- set section = section_or_requirement %}
                 {% include "screens/git/node/section.jinja" %}
               {%- endif %}

strictdoc/export/html/templates/screens/git/fields/section_fields.jinja

@@ -42,10 +42,10 @@
       {%- if section_change.is_paired_change() -%}
         <div class="sdoc_pre_content">{{ section_change.get_colored_title_diff(side) }}</div>
       {%- else -%}
-        <div class="sdoc_pre_content">{{ section.title }}</div>
+        <div class="sdoc_pre_content">{{ section.reserved_title }}</div>
       {%- endif -%}
     {% else %}
-    <div class="sdoc_pre_content">{{ section.title }}</div>
+    <div class="sdoc_pre_content">{{ section.reserved_title }}</div>
     {% endif %}
   </div>
 

strictdoc/export/html/templates/screens/git/form.jinja

@@ -14,6 +14,7 @@
           placeholder="Enter the LHS revision here"
           id="left_revision"
           name="left_revision"
+          data-testid="diff-screen-field-lhs"
         />
         {% include "components/button/diff.jinja" %}
         <input
@@ -26,6 +27,7 @@
           placeholder="Enter the RHS revision here"
           id="right_revision"
           name="right_revision"
+          data-testid="diff-screen-field-rhs"
         />
         <input
           type="hidden"

strictdoc/export/html/templates/screens/git/nav_tabs.jinja

@@ -15,6 +15,7 @@
       {% else %}
       href="changelog.html"
       {% endif %}
+      data-testid="diff-screen-tab-changelog"
     >Changelog</a>
   </div>
 </nav>

strictdoc/export/html/templates/screens/git/node/section.jinja

@@ -13,7 +13,7 @@
     <span>
       {{ section.context.title_number_string if section.context.title_number_string else "&nbsp;"|safe * (section.ng_level * 2 - 1) }}
     </span>
-    <span>{{ section.title }}</span>
+    <span>{{ section.reserved_title }}</span>
     {%- if tab == "diff" -%}
       {%- if section_change is not none -%}
         {%- if section_change.section_token is not none -%}

strictdoc/git/change.py

@@ -95,8 +95,14 @@ def __init__(
 
         if matched_mid is not None or matched_uid is not None:
             change_type = ChangeType.SECTION_MODIFIED
-            assert isinstance(lhs_section, SDocSection), lhs_section
-            assert isinstance(rhs_section, SDocSection), rhs_section
+            assert isinstance(lhs_section, SDocSection) or (
+                isinstance(lhs_section, SDocNode)
+                and lhs_section.node_type == "SECTION"
+            ), lhs_section
+            assert isinstance(rhs_section, SDocSection) or (
+                isinstance(rhs_section, SDocNode)
+                and rhs_section.node_type == "SECTION"
+            ), rhs_section
         elif lhs_section is not None:
             assert rhs_section is None, rhs_section
             change_type = ChangeType.SECTION_REMOVED

strictdoc/git/project_diff_analyzer.py

@@ -422,7 +422,9 @@ def _iterate_one_index(
             for node in document_iterator.all_content(
                 print_fragments=True, print_fragments_from_files=False
             ):
-                if isinstance(node, (SDocSection, SDocDocument)):
+                if isinstance(node, (SDocSection, SDocDocument)) or (
+                    isinstance(node, SDocNode) and node.node_type == "SECTION"
+                ):
                     if node in change_stats.map_nodes_to_changes:
                         continue
 
@@ -455,8 +457,12 @@ def _iterate_one_index(
                                 )
                         # FIXME: This is when a Requirement becomes
                         # a Section with the same UID preserved.
-                        if other_section_or_none is not None and not isinstance(
-                            other_section_or_none, SDocSection
+                        if other_section_or_none is not None and not (
+                            isinstance(other_section_or_none, SDocSection)
+                            or (
+                                isinstance(other_section_or_none, SDocNode)
+                                and other_section_or_none.node_type == "SECTION"
+                            )
                         ):
                             other_section_or_none = None
                             matched_uid = None
@@ -481,19 +487,22 @@ def _iterate_one_index(
                             uid_modified = True
 
                         if other_section_or_none is not None:
-                            if node.title != other_section_or_none.title:
+                            if (
+                                node.reserved_title
+                                != other_section_or_none.reserved_title
+                            ):
                                 title_modified = True
                                 lhs_colored_title_diff = (
                                     get_colored_html_diff_string(
-                                        node.title,
-                                        other_section_or_none.title,
+                                        node.reserved_title,
+                                        other_section_or_none.reserved_title,
                                         "left",
                                     )
                                 )
                                 rhs_colored_title_diff = (
                                     get_colored_html_diff_string(
-                                        node.title,
-                                        other_section_or_none.title,
+                                        node.reserved_title,
+                                        other_section_or_none.reserved_title,
                                         "right",
                                     )
                                 )
@@ -508,8 +517,12 @@ def _iterate_one_index(
                         if other_section_or_none is not None:
                             section_token = MID.create()
 
-                        lhs_section: Optional[Union[SDocSection, SDocDocument]]
-                        rhs_section: Optional[Union[SDocSection, SDocDocument]]
+                        lhs_section: Optional[
+                            Union[SDocSection, SDocDocument, SDocNode]
+                        ]
+                        rhs_section: Optional[
+                            Union[SDocSection, SDocDocument, SDocNode]
+                        ]
                         if side == "left":
                             lhs_section = node
                             rhs_section = other_section_or_none
@@ -536,7 +549,7 @@ def _iterate_one_index(
                             ] = section_change
                         change_stats.add_change(section_change)
 
-                if isinstance(node, SDocNode):
+                if isinstance(node, SDocNode) and node.node_type != "SECTION":
                     #
                     # Step: We check if a requirement was modified at all, or if
                     # it has already been checked before. Skipping the requirement

tests/end2end/helpers/screens/diff/diff.py

@@ -0,0 +1,33 @@
+from tests.end2end.helpers.screens.screen import Screen
+
+
+class Screen_Diff(Screen):  # pylint: disable=invalid-name
+    def do_enter_field_lhs(self, field_value: str):
+        xpath_to_lhs_field = "(//*[@data-testid='diff-screen-field-lhs'])"
+
+        self.do_fill_in_field_value(xpath_to_lhs_field, field_value=field_value)
+
+    def do_enter_field_rhs(self, field_value: str):
+        xpath_to_lhs_field = "(//*[@data-testid='diff-screen-field-rhs'])"
+
+        self.do_fill_in_field_value(xpath_to_lhs_field, field_value=field_value)
+
+    def do_submit(self):
+        self.test_case.click_xpath('//*[@data-testid="form-submit-action"]')
+
+    def do_switch_tab_to_changelog(self):
+        self.test_case.click_xpath(
+            '//*[@data-testid="diff-screen-tab-changelog"]'
+        )
+
+    def assert_documents_modified(self, stats: str) -> None:
+        xpath = '//*[@data-testid="table-row-value-documents-modified"]'
+        self.assert_xpath_contains(xpath, stats)
+
+    def assert_sections_modified(self, stats: str) -> None:
+        xpath = '//*[@data-testid="table-row-value-sections-modified"]'
+        self.assert_xpath_contains(xpath, stats)
+
+    def assert_requirements_modified(self, stats: str) -> None:
+        xpath = '//*[@data-testid="table-row-value-requirements-modified"]'
+        self.assert_xpath_contains(xpath, stats)

tests/end2end/helpers/screens/project_index/screen_project_index.py

@@ -1,6 +1,7 @@
 from selenium.webdriver.common.by import By
 from seleniumbase import BaseCase
 
+from tests.end2end.helpers.screens.diff.diff import Screen_Diff
 from tests.end2end.helpers.screens.document.screen_document import (
     Screen_Document,
 )
@@ -91,6 +92,12 @@ def assert_link_to_search_screen_present(self) -> None:
             by=By.XPATH,
         )
 
+    def assert_link_to_diff_screen_present(self) -> None:
+        self.test_case.assert_element(
+            '//a[@data-testid="project-tree-link-diff"]',
+            by=By.XPATH,
+        )
+
     def do_click_on_first_document(self) -> Screen_Document:
         self.test_case.click_xpath('//*[@data-testid="tree-file-link"]')
         return Screen_Document(self.test_case)
@@ -125,6 +132,14 @@ def do_click_on_search_screen_link(
         )
         return Screen_Search(self.test_case)
 
+    def do_click_on_diff_screen_link(
+        self,
+    ) -> Screen_Diff:
+        self.test_case.click_xpath(
+            '//a[@data-testid="project-tree-link-diff"]',
+        )
+        return Screen_Diff(self.test_case)
+
     def do_click_on_the_document(self, doc_order: int = 1) -> Screen_Document:
         self.test_case.click_xpath(
             f"(//*[@data-testid='tree-file-link'])[{doc_order}]"

tests/end2end/helpers/screens/screen.py

@@ -1,4 +1,5 @@
 from selenium.webdriver.common.by import By
+from selenium.webdriver.support.wait import WebDriverWait
 from seleniumbase import BaseCase
 from typing_extensions import deprecated
 
@@ -132,3 +133,13 @@ def assert_toc_contains_not(self, string: str) -> None:
     def get_collapsible_list(self) -> CollapsibleList:
         CollapsibleList(self.test_case).assert_is_collapsible()
         return CollapsibleList(self.test_case)
+
+    def do_fill_in_field_value(
+        self, field_xpath: str, field_value: str
+    ) -> None:
+        self.test_case.type(field_xpath, f"{field_value}", by=By.XPATH)
+
+        WebDriverWait(self.test_case.driver, timeout=3).until(
+            lambda _: self.test_case.get_value(field_xpath, by=By.XPATH)
+            == field_value
+        )

tests/end2end/screens/diff/01_view_basic_diff/input.sdoc

@@ -0,0 +1,71 @@
+[DOCUMENT]
+TITLE: Test document
+OPTIONS:
+  ENABLE_MID: True
+
+[GRAMMAR]
+ELEMENTS:
+- TAG: SECTION
+  PROPERTIES:
+    IS_COMPOSITE: True
+    VIEW_STYLE: Narrative
+  FIELDS:
+  - TITLE: MID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: TITLE
+    TYPE: String
+    REQUIRED: True
+- TAG: TEXT
+  FIELDS:
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
+- TAG: REQUIREMENT
+  PROPERTIES:
+    VIEW_STYLE: Table
+  FIELDS:
+  - TITLE: MID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATUS
+    TYPE: String
+    REQUIRED: False
+  - TITLE: TITLE
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
+  - TITLE: RATIONALE
+    TYPE: String
+    REQUIRED: False
+  - TITLE: COMMENT
+    TYPE: String
+    REQUIRED: False
+  RELATIONS:
+  - TYPE: Parent
+  - TYPE: File
+
+[[SECTION]]
+MID: 8e4ede877770402b91a59026d31a7020
+TITLE: Section title
+
+[REQUIREMENT]
+MID: c46def916b6f4df692c98888414feebb
+UID: REQ-1
+STATUS: Active
+TITLE: Requirement title
+STATEMENT: Requirement statement.
+RATIONALE: Rationale. TBD
+
+[[/SECTION]]