ecap5_treq.main module

ecap5_treq.main.cmd_gen_report(config: dict[str, str]) → None

Handles the gen_report command.

The gen_report command generates a markdown test and traceability report.

Parameters:

config (dict[str, str]) – a configuration dictionnary providing path to input files

ecap5_treq.main.cmd_gen_test_result_badge(config: dict[str, str]) → None

Handles the gen_test_result_badge command.

The gen_test_result_badge command generates a json for configuring the generation of an svg badge by img.shields.io for the test results

Parameters:

config (dict[str, str]) – a configuration dictionnary providing path to input files

ecap5_treq.main.cmd_gen_traceability_result_badge(config: dict[str, str]) → None

Handles the gen_traceability_result_badge command.

The gen_traceability_result_badge command generates a json for configuring the generation of an svg badge by img.shields.io for the traceability results

Parameters:

config (dict[str, str]) – a configuration dictionnary providing path to input files

ecap5_treq.main.cmd_prepare_matrix(config: dict[str, str]) → None

Handles the prepare_matrix command.

The prepare matrix command generates an updated traceability matrix with an up-to-date list of checks.

Parameters:

config (dict[str, str]) – a configuration dictionnary providing path to input files

ecap5_treq.main.cmd_print_checks(config: dict[str, str]) → None

Handles the print_checks command.

The print_checks command prints a list of the checks from the tests which path is given in config

Parameters:

config (dict[str, str]) – a configuration dictionnary providing path to input files

ecap5_treq.main.cmd_print_reqs(config: dict[str, str]) → None

Handles the print_reqs command.

The print_reqs command prints a list of the requirements from the specification which path is given in config

Parameters:

config (dict[str, str]) – a configuration dictionnary providing path to input files

ecap5_treq.main.cmd_print_testdata(config: dict[str, str]) → None

Handles the print_testdata command.

The print_testdata command prints a list of checks including their status from the testdata which path is given in config

Parameters:

config (dict[str, str]) – a configuration dictionnary providing path to input files

ecap5_treq.main.main()

Entry point to ECAP5-TREQ