tests/integration/features/source_code_traceability/_RELATION_FIELD/test.itest

Path:

Lines:

Non-empty lines:

Non-empty lines covered with requirements:

14 / 14 (100.0%)

Functions:

Functions covered by requirements:

0 / 0 (0.0%)

1 - 19 | entire file

"7.2.3. Language-aware parsing of Python code" (REQUIREMENT)
"7.6.3. Language element marker" (REQUIREMENT)

SDOC-SRS-147

7.2.3. Language-aware parsing of Python code

MID:

3456080f1358485f9bacdcda063b34bc

UID:

SDOC-SRS-147

STATUS:

Active

STATEMENT:

StrictDoc shall support parsing the Python source files which includes:

- Recognizing Python functions, including nested functions.
- Recognizing Python classes, including nested classes.
- Recognizing decorated functions.

RATIONALE:

Python language has to be handled with a dedicated parser because of this
language's specifics.

RELATIONS (File):

SDOC-SRS-137

7.6.3. Language element marker

MID:

61c23c1b106e4583b2c6d64bf1d296ba

UID:

SDOC-SRS-137

STATUS:

Active

STATEMENT:

StrictDoc shall support relation markers that can be attached to individual
source code elements. StrictDoc shall support an optional scope attribute to
disambiguate the target element where StrictDoc can't infer it solely from the
marker position.

Note: The most basic example of such traceable elements are functions and
classes, but generally supported elements and available scope attributes depend
on the programming language.

RATIONALE:

Source code elements can often be considered as the next level to trace from a
requirement. For example, a low level element is implemented by a function, or a
test case is implemented by a test function.

Sometimes it's also feasible to consider the source code elements as lean
replacement for prose requirement or test-case definitions.

RELATIONS (Parent):

SDOC-SSS-72 Traceability between requirements and source code

RELATIONS (Child):

SDOC-LLR-164 Auto-scoped relation markers in Rust docs

RELATIONS (File):

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

RUN: %strictdoc --debug export %S --output-dir %T | filecheck %s --dump-input=fail

CHECK: Published: Hello world doc

RUN: %check_exists --file "%T/html/_source_files/file.py.html"

RUN: %cat %T/html/%THIS_TEST_FOLDER/input.html | filecheck %s --check-prefix CHECK-HTML

CHECK-HTML: <a{{.*}}href="../_source_files/file.py.html#REQ-1#1#13">

CHECK-HTML: <a{{.*}}href="../_source_files/file.py.html#REQ-1#7#9">

CHECK-HTML: <a{{.*}}href="../_source_files/file.py.html#REQ-1#11#13">

RUN: %cat %T/html/_source_files/file.py.html | filecheck %s --check-prefix CHECK-SOURCE-FILE

CHECK-SOURCE-FILE: 1 - 13 | function hello_world()

CHECK-SOURCE-FILE: 7 - 9 | range

CHECK-SOURCE-FILE: 11 - 13 | range

RUN: %cat %T/html/source_coverage.html | filecheck %s --dump-input=fail --check-prefix CHECK-SOURCE-COVERAGE

CHECK-SOURCE-COVERAGE: 85.7

1 - 19 | entire file