Merge pull request #2242 from strictdoc-project/stanislaw/entire_file_issue

export/html: source file view: fix the entire file marker positioning

Author: stanislaw

strictdoc/export/html/generators/source_file_view_generator.py

@@ -232,9 +232,12 @@ def get_pygmented_source_lines(
         )
 
         for marker in coverage_info.markers:
-            marker_line = marker.ng_source_line_begin
+            marker_line = (
+                marker.ng_range_line_begin
+                if marker.is_begin()
+                else marker.ng_range_line_end
+            )
             assert isinstance(marker_line, int)
-
             source_marker_tuple: SourceMarkerTuple
             if isinstance(
                 pygmented_source_file_lines[marker_line - 1], SourceMarkerTuple

tests/integration/features/file_traceability/55_file_marker/file.py renamed to tests/integration/features/file_traceability/_markers/01_basic_file_marker/file.py

@@ -0,0 +1,9 @@
+"""
+@relation(REQ-1, scope=file)
+"""
+from typing import Optional
+
+
+class SDocDocumentContext:
+    def __init__(self) -> None:
+        self.title_number_string: Optional[str] = None

tests/integration/features/file_traceability/55_file_marker/input.sdoc renamed to tests/integration/features/file_traceability/_markers/01_basic_file_marker/input.sdoc

@@ -0,0 +1,7 @@
+[DOCUMENT]
+TITLE: Hello world doc
+
+[REQUIREMENT]
+UID: REQ-1
+TITLE: Requirement Title
+STATEMENT: Requirement Statement

tests/integration/features/file_traceability/55_file_marker/strictdoc.toml renamed to tests/integration/features/file_traceability/_markers/01_basic_file_marker/strictdoc.toml

@@ -0,0 +1,6 @@
+[project]
+
+features = [
+  "REQUIREMENT_TO_SOURCE_TRACEABILITY",
+  "SOURCE_FILE_LANGUAGE_PARSERS",
+]

tests/integration/features/file_traceability/55_file_marker/test.itest renamed to tests/integration/features/file_traceability/_markers/01_basic_file_marker/test.itest

@@ -0,0 +1,15 @@
+REQUIRES: PYTHON_39_OR_HIGHER
+
+# This test ensures that the entire file marker is correctly displayed as
+# covering the file from its first line and until the last line.
+# It fixes this issue:
+# Bug: Source View screen: Entire file marker is one line off #2237
+# https://github.com/strictdoc-project/strictdoc/issues/2237
+
+RUN: %strictdoc export %S --output-dir Output | filecheck %s --dump-input=fail
+CHECK: Published: Hello world doc
+
+RUN: %check_exists --file "%S/Output/html/_source_files/file.py.html"
+
+RUN: %cat %S/Output/html/_source_files/file.py.html | filecheck %s --dump-input=fail --check-prefix CHECK-SOURCE-FILE
+CHECK-SOURCE-FILE: <span class="source__range-definition">1 - 9 | entire file</span>

tests/integration/features/file_traceability/_markers/02_file_marker_regression/file.py

@@ -482,6 +482,35 @@ def function_1():
     assert marker.reqs_objs[1].ng_source_column == 9
 
 
+def test_080_file_marker():
+    """
+    Test a basic file range relation marker.
+    """
+
+    source_input = b"""\
+\"\"\"
+@relation(REQ-1, scope=file)
+\"\"\"
+
+@auto_described
+class SDocDocumentContext:
+    def __init__(self) -> None:
+        self.title_number_string: Optional[str] = None
+"""
+
+    reader = SourceFileTraceabilityReader_Python()
+
+    document = reader.read(source_input)
+    markers = document.markers
+    marker = markers[0]
+    assert marker.reqs == ["REQ-1"]
+    assert marker.ng_source_line_begin == 2
+    assert marker.ng_range_line_begin == 1
+    assert marker.ng_range_line_end == 8
+    assert marker.reqs_objs[0].ng_source_line == 2
+    assert marker.reqs_objs[0].ng_source_column == 11
+
+
 def test_validation_01_one_range_marker_begin_req_not_equal_to_end_req():
     source_input = b"""
 # @relation(REQ-001, scope=range_start)