"""

@relation(SDOC-SRS-147, scope=file)

"""

# The tests in this file has strings with whitespace that must not be linted.

# ruff: noqa: W291,W293

from typing import List

import pytest

from strictdoc.backend.sdoc.error_handling import StrictDocSemanticError

from strictdoc.backend.sdoc_source_code.models.language import LanguageItem

from strictdoc.backend.sdoc_source_code.models.range_marker import RangeMarker

from strictdoc.backend.sdoc_source_code.models.source_file_info import (

    SourceFileTraceabilityInfo,

)

from strictdoc.backend.sdoc_source_code.reader_python import (

    SourceFileTraceabilityReader_Python,

)

def test_00_empty_file():

    input_string = b""""""

    reader = SourceFileTraceabilityReader_Python()

    info = reader.read(input_string)

    assert isinstance(info, SourceFileTraceabilityInfo)

    assert len(info.markers) == 0

def test_01_single_string():

    input_string = b"""\

# Hello

"""

    reader = SourceFileTraceabilityReader_Python()

    info = reader.read(input_string)

    assert isinstance(info, SourceFileTraceabilityInfo)

    assert len(info.functions) == 0

    assert len(info.markers) == 0

def test_02_functions():

    input_string = b"""\

def hello_1():

    print("1")

    def hello_1_1():

        print("1_1")

        def hello_1_1_1():

            print("1_1_1")

            print("1_1_1 E")

        print("1_1 E")

    print("1 E")

def hello_2():

    print("2")

    def hello_2_1():

        print("2_1")

        def hello_2_1_1():

            print("2_1_1")

            print("2_1_1 E")

        print("2_1 E")

    print("2 E")

def hello_3():

    print("3")

    def hello_3_1():

        print("3_1")

        def hello_3_1_1():

            print("3_1_1")

            print("3_1_1 E")

        print("3_1 E")

    print("3 E")

"""

    reader = SourceFileTraceabilityReader_Python()

    info: SourceFileTraceabilityInfo = reader.read(input_string)

    assert isinstance(info, SourceFileTraceabilityInfo)

    assert len(info.functions) == 9

    function_1 = info.functions[0]

    assert isinstance(function_1, LanguageItem)

    assert function_1.name == "hello_1"

    assert len(function_1.child_functions) == 1

    function_1_1 = function_1.child_functions[0]

    assert isinstance(function_1_1, LanguageItem)

    assert function_1_1.name == "hello_1.hello_1_1"

    assert len(function_1_1.child_functions) == 1

    function_1_1_1 = function_1_1.child_functions[0]

    assert isinstance(function_1_1_1, LanguageItem)

    assert function_1_1_1.name == "hello_1.hello_1_1.hello_1_1_1"

    assert len(function_1_1_1.child_functions) == 0

    function_2 = info.functions[3]

    assert isinstance(function_2, LanguageItem)

    assert function_2.name == "hello_2"

    assert len(function_2.child_functions) == 1

    function_2_1 = function_2.child_functions[0]

    assert isinstance(function_2_1, LanguageItem)

    assert function_2_1.name == "hello_2.hello_2_1"

    assert len(function_2_1.child_functions) == 1

    function_2_1_1 = function_2_1.child_functions[0]

    assert isinstance(function_2_1_1, LanguageItem)

    assert function_2_1_1.name == "hello_2.hello_2_1.hello_2_1_1"

    assert len(function_2_1_1.child_functions) == 0

    function_3 = info.functions[6]

    assert isinstance(function_3, LanguageItem)

    assert function_3.name == "hello_3"

    assert len(function_3.child_functions) == 1

    function_3_1 = function_3.child_functions[0]

    assert isinstance(function_3_1, LanguageItem)

    assert function_3_1.name == "hello_3.hello_3_1"

    assert len(function_3_1.child_functions) == 1

    function_3_1_1 = function_3_1.child_functions[0]

    assert isinstance(function_3_1_1, LanguageItem)

    assert function_3_1_1.name == "hello_3.hello_3_1.hello_3_1_1"

    assert len(function_3_1_1.child_functions) == 0

def test_02_nested_sibling_functions():

    input_string = b"""\

def outer():

    def wrapper():

        def first():

            pass

        def second():

            pass

        def third():

            pass

"""

    reader = SourceFileTraceabilityReader_Python()

    info: SourceFileTraceabilityInfo = reader.read(input_string)

    assert isinstance(info, SourceFileTraceabilityInfo)

    assert len(info.functions) == 5

    outer_function = info.functions[0]

    assert outer_function.name == "outer"

    assert len(outer_function.child_functions) == 1

    wrapper_function = outer_function.child_functions[0]

    assert wrapper_function.name == "outer.wrapper"

    assert len(wrapper_function.child_functions) == 3

    assert wrapper_function.child_functions[0].name == "outer.wrapper.first"

    assert wrapper_function.child_functions[1].name == "outer.wrapper.second"

    assert wrapper_function.child_functions[2].name == "outer.wrapper.third"

def test_001_one_range_marker():

    source_input = b"""\

# @relation(REQ-001, REQ-002, REQ-003, scope=range_start)

print("Hello world")

# @relation(REQ-001, REQ-002, REQ-003, scope=range_end)

""".lstrip()

    reader = SourceFileTraceabilityReader_Python()

    info: SourceFileTraceabilityInfo = reader.read(source_input)

    markers = info.markers

    assert markers[0].reqs == ["REQ-001", "REQ-002", "REQ-003"]

    assert markers[0].is_begin()

    assert markers[0].ng_source_line_begin == 1

    assert markers[0].ng_source_column_begin == 3

    assert markers[0].ng_range_line_begin == 1

    assert markers[0].ng_range_line_end == 3

    assert markers[1].reqs == ["REQ-001", "REQ-002", "REQ-003"]

    assert markers[1].is_end()

    assert markers[1].ng_source_line_begin == 3

    assert markers[1].ng_source_column_begin == 3

    assert markers[1].ng_range_line_begin == 1

    assert markers[1].ng_range_line_end == 3

def test_002_two_range_markers():

    source_input = b"""

# @relation(REQ-001, scope=range_start)

CONTENT 1

CONTENT 2

CONTENT 3

# @relation(REQ-001, scope=range_end)

# @relation(REQ-002, scope=range_start)

CONTENT 4

CONTENT 5

CONTENT 6

# @relation(REQ-002, scope=range_end)

""".lstrip()

    reader = SourceFileTraceabilityReader_Python()

    document = reader.read(source_input)

    markers = document.markers

    assert len(markers) == 4

    marker_1 = markers[0]

    marker_2 = markers[1]

    marker_3 = markers[2]

    marker_4 = markers[3]

    assert marker_1.reqs == ["REQ-001"]

    assert marker_2.reqs == ["REQ-001"]

    assert marker_3.reqs == ["REQ-002"]

    assert marker_4.reqs == ["REQ-002"]

    assert marker_1.ng_source_line_begin == 1

    assert marker_2.ng_source_line_begin == 5

    assert marker_3.ng_source_line_begin == 6

    assert marker_4.ng_source_line_begin == 10

    assert marker_1.ng_range_line_begin == 1

    assert marker_2.ng_range_line_begin == 1

    assert marker_3.ng_range_line_begin == 6

    assert marker_4.ng_range_line_begin == 6

def test_003_one_range_marker_with_offset():

    source_input = b"""\

    #

    # @relation(REQ-001, REQ-002, REQ-003, scope=range_start)

    print("Hello world")

    # @relation(REQ-001, REQ-002, REQ-003, scope=range_end)

    #

"""

    reader = SourceFileTraceabilityReader_Python()

    info: SourceFileTraceabilityInfo = reader.read(source_input)

    markers = info.markers

    assert markers[0].reqs == ["REQ-001", "REQ-002", "REQ-003"]

    assert markers[0].is_begin()

    assert markers[0].ng_source_line_begin == 4

    assert markers[0].ng_range_line_begin == 4

    assert markers[0].ng_range_line_end == 6

    assert markers[1].reqs == ["REQ-001", "REQ-002", "REQ-003"]

    assert markers[1].is_end()

    assert markers[1].ng_source_line_begin == 6

    assert markers[1].ng_range_line_begin == 4

    assert markers[1].ng_range_line_end == 6

def test_008_three_nested_range_markers():

    source_input = b"""

CONTENT 1

# @relation(REQ-001, scope=range_start)

CONTENT 2

# @relation(REQ-002, scope=range_start)

CONTENT 3

# @relation(REQ-003, scope=range_start)

CONTENT 4

# @relation(REQ-003, scope=range_end)

CONTENT 5

# @relation(REQ-002, scope=range_end)

CONTENT 6

# @relation(REQ-001, scope=range_end)

CONTENT 7

# @relation(REQ-001, scope=range_start)

CONTENT 8

# @relation(REQ-001, scope=range_end)

CONTENT 9

""".lstrip()

    reader = SourceFileTraceabilityReader_Python()

    document = reader.read(source_input)

    markers = document.markers

    assert len(markers) == 8

    marker_1 = markers[0]

    marker_2 = markers[1]

    marker_3 = markers[2]

    marker_4 = markers[3]

    marker_5 = markers[4]

    marker_6 = markers[5]

    marker_7 = markers[6]

    marker_8 = markers[7]

    assert marker_1.reqs == ["REQ-001"]

    assert marker_2.reqs == ["REQ-002"]

    assert marker_3.reqs == ["REQ-003"]

    assert marker_4.reqs == ["REQ-003"]

    assert marker_5.reqs == ["REQ-002"]

    assert marker_6.reqs == ["REQ-001"]

    assert marker_7.reqs == ["REQ-001"]

    assert marker_8.reqs == ["REQ-001"]

    assert marker_1.ng_source_line_begin == 2

    assert marker_2.ng_source_line_begin == 4

    assert marker_3.ng_source_line_begin == 6

    assert marker_4.ng_source_line_begin == 8

    assert marker_5.ng_source_line_begin == 10

    assert marker_6.ng_source_line_begin == 12

    assert marker_7.ng_source_line_begin == 14

    assert marker_8.ng_source_line_begin == 16

    assert marker_1.ng_range_line_begin == 2

    assert marker_2.ng_range_line_begin == 4

    assert marker_3.ng_range_line_begin == 6

    assert marker_4.ng_range_line_begin == 6

    assert marker_5.ng_range_line_begin == 4

    assert marker_6.ng_range_line_begin == 2

    assert marker_7.ng_range_line_begin == 14

    assert marker_8.ng_range_line_begin == 14

def test_010_relation_skip_keyword():

    source_input = b"""

# @relation(skip, scope=range_start)

# @relation(REQ-001, scope=range_start)

CONTENT 1

CONTENT 2

CONTENT 3

# @relation(REQ-001, scope=range_end)

# @relation(skip, scope=range_end)

""".lstrip()

    reader = SourceFileTraceabilityReader_Python()

    document = reader.read(source_input)

    assert len(document.markers) == 0

def test_011_relation_skip_keyword_then_normal_marker():

    source_input = b"""

# @relation(skip, scope=range_start)

# @relation(REQ-001, scope=range_start)

CONTENT 1

CONTENT 2

CONTENT 3

# @relation(REQ-001, scope=range_end)

# @relation(skip, scope=range_end)

# @relation(REQ-001, scope=range_start)

CONTENT 1

CONTENT 2

CONTENT 3

# @relation(REQ-001, scope=range_end)

""".lstrip()

    reader = SourceFileTraceabilityReader_Python()

    document = reader.read(source_input)

    assert len(document.markers) == 2

def test_011_relation_skip_keyword_then_normal_marker_4spaces_indent():

    source_input = b"""

    # @relation(skip, scope=range_start)

    # @relation(REQ-001, scope=range_start)

    CONTENT 1

    CONTENT 2

    CONTENT 3

    # @relation(REQ-001, scope=range_end)

    # @relation(skip, scope=range_end)

    # @relation(REQ-001, scope=range_start)

    CONTENT 1

    CONTENT 2

    CONTENT 3

    # @relation(REQ-001, scope=range_end)

""".lstrip()

    reader = SourceFileTraceabilityReader_Python()

    document = reader.read(source_input)

    assert len(document.markers) == 2

def test_011_relation_skip_file():

    source_input = b"""

\"\"\"

@relation(skip, scope=file)

\"\"\"

# @relation(REQ-001, scope=range_start)

CONTENT 1

CONTENT 2

CONTENT 3

# @relation(REQ-001, scope=range_end)

""".lstrip()

    reader = SourceFileTraceabilityReader_Python()

    document = reader.read(source_input)

    assert len(document.markers) == 0

# Testing that correct line location is assigned when the marker is not on the

# first line.

def test_012_marker_not_first_line():

    source_input = b"""

# @relation(REQ-001, scope=range_start)

# CONTENT 1

# CONTENT 2

# CONTENT 3

# @relation(REQ-001, scope=range_end)

"""

    reader = SourceFileTraceabilityReader_Python()

    document = reader.read(source_input)

    markers: List[RangeMarker] = document.markers

    assert markers[0].reqs == ["REQ-001"]

    assert markers[0].is_begin()

    assert markers[0].ng_source_line_begin == 4

    assert markers[0].ng_range_line_begin == 4

    assert markers[0].ng_range_line_end == 8

    assert markers[1].reqs == ["REQ-001"]

    assert markers[1].is_end()

    assert markers[1].ng_source_line_begin == 8

    assert markers[1].ng_range_line_begin == 4

    assert markers[1].ng_range_line_end == 8

#

# LINE markers.

#

def test_050_line_marker():

    source_input = b"""

# @relation(REQ-001, scope=line)

CONTENT 1

# @relation(REQ-002, scope=line)

CONTENT 2

# @relation(REQ-003, scope=line)

CONTENT 3

""".lstrip()

    reader = SourceFileTraceabilityReader_Python()

    document = reader.read(source_input)

    markers = document.markers

    assert markers[0].reqs == ["REQ-001"]

    assert markers[0].ng_source_line_begin == 1

    assert markers[0].ng_range_line_begin == 1

    assert markers[0].ng_range_line_end == 2

    assert markers[1].reqs == ["REQ-002"]

    assert markers[1].ng_source_line_begin == 3

    assert markers[1].ng_range_line_begin == 3

    assert markers[1].ng_range_line_end == 4

    assert markers[2].reqs == ["REQ-003"]

    assert markers[2].ng_source_line_begin == 5

    assert markers[2].ng_range_line_begin == 5

    assert markers[2].ng_range_line_end == 6

def test_070_function_marker():

    source_input = b"""\

# Some offset...

# Some offset...

def function_1():

    \"\"\"

    @relation(REQ-001, scope=function)

    \"\"\"

    pass

"""

    reader = SourceFileTraceabilityReader_Python()

    document = reader.read(source_input)

    markers = document.markers

    assert markers[0].reqs == ["REQ-001"]

    assert markers[0].ng_source_line_begin == 5

    assert markers[0].ng_range_line_begin == 3

    assert markers[0].ng_range_line_end == 7

    assert markers[0].reqs_objs[0].ng_source_line == 5

    assert markers[0].reqs_objs[0].ng_source_column == 15

def test_071_function_marker_multiline():

    source_input = b"""\

# Some offset...

# Some offset...

def function_1():

    \"\"\"

    @relation(

        REQ-1A,

        REQ-1B,

        scope=function

    )

    @relation(

        REQ-2A,

        REQ-2B,

        scope=function

    )    

    \"\"\"

    pass

"""

    reader = SourceFileTraceabilityReader_Python()

    document = reader.read(source_input)

    markers = document.markers

    marker = markers[0]

    assert marker.reqs == ["REQ-1A", "REQ-1B"]

    assert marker.ng_source_line_begin == 5

    assert marker.ng_range_line_begin == 3

    assert marker.ng_range_line_end == 16

    assert marker.reqs_objs[0].ng_source_line == 6

    assert marker.reqs_objs[0].ng_source_column == 9

    assert marker.reqs_objs[1].ng_source_line == 7

    assert marker.reqs_objs[1].ng_source_column == 9

    marker = markers[1]

    assert marker.reqs == ["REQ-2A", "REQ-2B"]

    assert marker.ng_source_line_begin == 10

    assert marker.ng_range_line_begin == 3

    assert marker.ng_range_line_end == 16

    assert marker.reqs_objs[0].ng_source_line == 11

    assert marker.reqs_objs[0].ng_source_column == 9

    assert marker.reqs_objs[1].ng_source_line == 12

    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)

CONTENT 1

CONTENT 2

CONTENT 3

# @relation(REQ-002, scope=range_end)

""".lstrip()

    reader = SourceFileTraceabilityReader_Python()

    with pytest.raises(Exception) as exc_info:

        _ = reader.read(source_input)

    assert exc_info.type is StrictDocSemanticError

    assert (

        exc_info.value.args[0]

        == "STRICTDOC RANGE: BEGIN and END requirements mismatch"

    )

def test_validation_02_one_range_marker_end_without_begin():

    source_input = b"""

# @relation(REQ-002, scope=range_end)

""".lstrip()

    reader = SourceFileTraceabilityReader_Python()

    with pytest.raises(Exception) as exc_info:

        _ = reader.read(source_input)

    assert exc_info.type is StrictDocSemanticError

    assert (

        exc_info.value.args[0]

        == "STRICTDOC RANGE: END marker without preceding BEGIN marker"

    )

def test_validation_03_range_start_without_range_end():

    source_input = b"""

# @relation(REQ-001, scope=range_start)

# @relation(REQ-002, scope=range_start)

CONTENT 1

CONTENT 2

CONTENT 3

""".lstrip()

    reader = SourceFileTraceabilityReader_Python()

    with pytest.raises(Exception) as exc_info:

        _ = reader.read(source_input)

    assert exc_info.type is StrictDocSemanticError

    assert (

        exc_info.value.args[0]

        == "Unmatched @relation keyword found in source file."

    )

    assert (

        exc_info.value.args[1]

        == "The @relation keywords are also unmatched on lines: [(2, 3)]."

    )