tests/integration/features/commands/new/01_create_initial_project/test.itest

Path:

Lines:

Non-empty lines:

Non-empty lines covered with requirements:

39 / 39 (100.0%)

Functions:

Functions covered by requirements:

0 / 0 (0.0%)

1 - 46 | entire file

"4.1.1. Create initial StrictDoc project" (REQUIREMENT)

SDOC-LLR-208

4.1.1. Create initial StrictDoc project

MID:

91644890fd304d86b2d756c5b1d8c9e8

UID:

SDOC-LLR-208

STATUS:

Active

STATEMENT:

The "new" StrictDoc CLI command shall generate a documentation skeleton that
consists of the following artifacts in the provided input directory:

- ``docs/`` folder with the following content:

- ``high_level_requirements.sdoc`` that contains a dummy document with a requirement prefix ``HLR-`` and one high-level requirement with identifier ``HLR-1``.
- ``low_level_requirements.sdoc`` that contains a dummy document with a requirement prefix ``LLR-`` and one low-level requirement with identifier ``LLR-1`` that has a Parent relation to the requirement ``HLR-1``.

- ``src/`` folder with the following content:

- A source file ``main.c`` that contains a C hello world program that is annotated with a C comment that has a ``@relation`` to the ``LLR-1`` requirement.

- ``strictdoc_config.py`` that is configured to read SDoc documents from the
``docs/`` folder and source files from the ``src/`` folder.
- All documents must be configured with ``ENABLE_MID: True``. All nodes must
have valid unique MID identifiers.
- At the end of the execution, the ``new`` command shall print the instructions
for running: 1) StrictDoc's static HTML export and 2) web server.

Example of the "new" command usage:

.. code:: bash

strictdoc new .

RELATIONS (File):

# @relation(SDOC-LLR-208, scope=file)

RUN: %strictdoc new %T/project | filecheck %s --dump-input=fail

CHECK: StrictDoc project skeleton created

CHECK: Next steps:

CHECK: strictdoc export .

CHECK: strictdoc server .

RUN: %check_exists --dir "%T/project/docs"

RUN: %check_exists --file "%T/project/docs/high_level_requirements.sdoc"

RUN: %check_exists --file "%T/project/docs/low_level_requirements.sdoc"

RUN: %check_exists --dir "%T/project/src"

RUN: %check_exists --file "%T/project/src/main.c"

RUN: %check_exists --file "%T/project/strictdoc_config.py"

RUN: %cat %T/project/docs/high_level_requirements.sdoc | filecheck %s --dump-input=fail --check-prefix CHECK-HLR

CHECK-HLR: MID: {{[a-f0-9]{32}}}

CHECK-HLR: PREFIX: HLR-

CHECK-HLR: OPTIONS:

CHECK-HLR: ENABLE_MID: True

CHECK-HLR: MID: {{[a-f0-9]{32}}}

CHECK-HLR: UID: HLR-1

RUN: %cat %T/project/docs/low_level_requirements.sdoc | filecheck %s --dump-input=fail --check-prefix CHECK-LLR

CHECK-LLR: MID: {{[a-f0-9]{32}}}

CHECK-LLR: PREFIX: LLR-

CHECK-LLR: OPTIONS:

CHECK-LLR: ENABLE_MID: True

CHECK-LLR: MID: {{[a-f0-9]{32}}}

CHECK-LLR: UID: LLR-1

CHECK-LLR: - TYPE: Parent

CHECK-LLR: VALUE: HLR-1

RUN: %cat %T/project/src/main.c | filecheck %s --dump-input=fail --check-prefix CHECK-SOURCE

CHECK-SOURCE: {{@}}relation(LLR-1, scope=file)

RUN: %strictdoc export %T/project --output-dir %T/output --no-parallelization | filecheck %s --dump-input=fail --check-prefix CHECK-EXPORT

CHECK-EXPORT: Published: High-Level Requirements

CHECK-EXPORT: Published: Low-Level Requirements

RUN: %check_exists --file "%T/output/html/_source_files/src/main.c.html"

RUN: %cat %T/output/html/project/docs/low_level_requirements.html | filecheck %s --dump-input=fail --check-prefix CHECK-HTML

CHECK-HTML: class="requirement__link-parent" href="{{.*}}#HLR-1"

CHECK-HTML: href="{{.*}}_source_files/src/main.c.html#LLR-1#1#10"

1 - 46 | entire file