SW Test Cases

This file contains the software test cases for the pyTRLCConverter tool.

General

tc_cli

Attribute Name	Attribute Value
Description	This test case checks whether the tool supports the command line arguments.
Verifies	SwRequirements.sw_req_cli

tc_translation

Attribute Name	Attribute Value
Description	This test case check whether the translation of requirement attributes works.
Verifies	SwRequirements.sw_req_translation

tc_render_configuration

Attribute Name	Attribute Value
Description	This test case check whether the render configuration works.
Verifies	SwRequirements.sw_req_render_configuration

tc_prj_spec

Attribute Name	Attribute Value
Description	This test case check whether a project specific converter can be instantiated.
Verifies	SwRequirements.sw_req_prj_spec SwRequirements.sw_req_prj_spec_file SwRequirements.sw_req_prj_spec_interface

tc_version

Attribute Name	Attribute Value
Description	This test case check whether ‘--version’ shows the correct version format format <program-name> <major>.<minor>.<patch>.
Verifies	SwRequirements.sw_req_version SwRequirements.sw_req_cli_version

tc_process_trlc_symbols_one_file_one_req

Attribute Name	Attribute Value
Description	This test case check whether one single TRLC requirement is printed out of one TRLC file.
Verifies	SwRequirements.sw_req_process_trlc_symbols SwRequirements.sw_req_destination_format SwRequirements.sw_req_cli_source

tc_process_trlc_symbols_two_files_one_req

Attribute Name	Attribute Value
Description	This test case check whether one single TRLC requirement per TRLC file is printed out of two TRLC files.
Verifies	SwRequirements.sw_req_process_trlc_symbols SwRequirements.sw_req_destination_format SwRequirements.sw_req_cli_source

tc_verbose

Attribute Name	Attribute Value
Description	This test case check whether in verbose mode more information is printed out.
Verifies	SwRequirements.sw_req_verbose_mode SwRequirements.sw_req_cli_verbose

tc_error

Attribute Name	Attribute Value
Description	This test case check whether error messages are printed to stderr.
Verifies	SwRequirements.sw_req_error

PlantUML

tc_plantuml

Attribute Name	Attribute Value
Description	This test case checks the conversion of a PlantUML diagram into an image.
Verifies	SwRequirements.sw_req_plantuml

Command Line Arguments

tc_help

Attribute Name	Attribute Value
Description	This test case checks whether the help information is shown with ‘--help’ without project specific converter.
Verifies	SwRequirements.sw_req_cli_help

tc_help_prj_spec

Attribute Name	Attribute Value
Description	This test case checks whether the help information is shown with ‘--help’ with project specific converter.
Verifies	SwRequirements.sw_req_cli_help

tc_cli_exclude

Attribute Name	Attribute Value
Description	This test case checks whether a TRLC file can be excluded from the conversion.
Verifies	SwRequirements.sw_req_cli_exclude

tc_cli_include

Attribute Name	Attribute Value
Description	This test case checks whether a TRLC file can be included as on demand context in the conversion.
Verifies	SwRequirements.sw_req_cli_include

tc_cli_translation

Attribute Name	Attribute Value
Description	This test case checks whether a translation file can be configured via the command line.
Verifies	SwRequirements.sw_req_cli_translation

tc_cli_render_cfg

Attribute Name	Attribute Value
Description	This test case checks whether a render configuration file can be configured via the command line.
Verifies	SwRequirements.sw_req_cli_render_cfg

Markdown

tc_markdown

Attribute Name	Attribute Value
Description	This test case checks whether the conversion to Markdown format works.
Verifies	SwRequirements.sw_req_markdown SwRequirements.sw_req_markdown_record SwRequirements.sw_req_no_prj_spec SwRequirements.sw_req_cli_out SwRequirements.sw_req_markdown_single_doc_mode SwRequirements.sw_req_markdown_out_file_name_default SwRequirements.sw_req_markdown_sd_top_level SwRequirements.sw_req_markdown_top_level_default

tc_markdown_section

Attribute Name	Attribute Value
Description	This test case checks whether the conversion of a TRLC section to a Markdown section works.
Verifies	SwRequirements.sw_req_markdown_section SwRequirements.sw_req_markdown_out_file_name_custom SwRequirements.sw_req_markdown_top_level_custom

tc_markdown_escape

Attribute Name	Attribute Value
Description	This test case checks whether the default Markdown converter can convert strings with Markdown escaping.
Verifies	SwRequirements.sw_req_markdown_escape

tc_markdown_heading

Attribute Name	Attribute Value
Description	This test case checks whether the default Markdown converter provides a function to create valid Markdown headings.
Verifies	SwRequirements.sw_req_markdown_heading

tc_markdown_table

Attribute Name	Attribute Value
Description	This test case checks whether the default Markdown converter provides the functionality to create valid Markdown tables.
Verifies	SwRequirements.sw_req_markdown_table

tc_markdown_list

Attribute Name	Attribute Value
Description	This test case checks whether the default Markdown converter provides a function to create valid Markdown list and a valid HTML list.
Verifies	SwRequirements.sw_req_markdown_list

tc_markdown_link

Attribute Name	Attribute Value
Description	This test case checks whether the default Markdown converter provides a function to create valid Markdown links.
Verifies	SwRequirements.sw_req_markdown_link

tc_markdown_image

Attribute Name	Attribute Value
Description	This test case checks whether the default Markdown converter provides a function to embed images in Markdown.
Verifies	SwRequirements.sw_req_markdown_image

tc_markdown_text_color

Attribute Name	Attribute Value
Description	This test case checks whether the default Markdown converter provides a function to create colored text in Markdown.
Verifies	SwRequirements.sw_req_markdown_text_color

tc_markdown_soft_return

Attribute Name	Attribute Value
Description	This test case checks whether the default Markdown converter provides a function to encode line feeds as Markdown soft returns.
Verifies	SwRequirements.sw_req_markdown_soft_return

tc_markdown_out_folder

Attribute Name	Attribute Value
Description	This test case checks whether the default Markdown converter creates output files in the specified output folder.
Verifies	SwRequirements.sw_req_markdown_out_folder

tc_markdown_multi_doc

Attribute Name	Attribute Value
Description	This test case checks whether the conversion to markdown in multiple document mode creates one output document per TRLC source file and whether the top level heading is created when required.
Verifies	SwRequirements.sw_req_markdown_multiple_doc_mode SwRequirements.sw_req_markdown_md_top_level

tc_markdown_render_md

Attribute Name	Attribute Value
Description	This test case checks whether CommonMark Markdown content in requirement attributes is rendered correctly when the render configuration is set to “md”.
Verifies	SwRequirements.sw_req_markdown_render_md SwRequirements.sw_req_markdown_string_format

tc_markdown_render_gfm

Attribute Name	Attribute Value
Description	This test case checks whether GitHub Flavored Markdown content in requirement attributes is rendered correctly when the render configuration is set to “gfm”.
Verifies	SwRequirements.sw_req_markdown_render_gfm SwRequirements.sw_req_markdown_string_format

tc_markdown_render_plantuml

Attribute Name	Attribute Value
Description	This test case checks whether a fenced ```plantuml``` code block inside a Markdown requirement attribute is replaced by an SVG image reference when --render-plantuml is given, and that the SVG file is written to the output folder.
Verifies	SwRequirements.sw_req_markdown_render_plantuml SwRequirements.sw_req_cli_render_plantuml SwRequirements.sw_req_plantuml

tc_markdown_render_plantuml_error

Attribute Name	Attribute Value
Description	This test case checks whether a fenced ```plantuml``` code block is replaced by a [PlantUML error: ...] paragraph in the Markdown output when --render-plantuml is given but PlantUML is not available.
Verifies	SwRequirements.sw_req_markdown_render_plantuml

reStructuredText

tc_rst

Attribute Name	Attribute Value
Description	This test case checks whether the conversion to reStructuredText format works.
Verifies	SwRequirements.sw_req_rst SwRequirements.sw_req_rst_record SwRequirements.sw_req_no_prj_spec SwRequirements.sw_req_cli_out SwRequirements.sw_req_rst_single_doc_mode SwRequirements.sw_req_rst_out_file_name_default SwRequirements.sw_req_rst_sd_top_level SwRequirements.sw_req_rst_sd_top_level_default

tc_rst_section

Attribute Name	Attribute Value
Description	This test case checks whether the conversion of a TRLC section to a reStructuredText section works.
Verifies	SwRequirements.sw_req_rst_section

tc_rst_escape

Attribute Name	Attribute Value
Description	This test case checks whether the default reStructuredText converter can convert strings with reStructuredText escaping.
Verifies	SwRequirements.sw_req_rst_escape

tc_rst_heading

Attribute Name	Attribute Value
Description	This test case checks whether the default reStructuredText converter provides a function to create valid reStructuredText headings.
Verifies	SwRequirements.sw_req_rst_heading

tc_rst_admonition

Attribute Name	Attribute Value
Description	This test case checks whether the default reStructuredText converter provides a function to create valid reStructuredText admonition.
Verifies	SwRequirements.sw_req_rst_admonition

tc_rst_table

Attribute Name	Attribute Value
Description	This test case checks whether the default reStructuredText converter provides the functionality to create valid reStructuredText tables.
Verifies	SwRequirements.sw_req_rst_table

tc_rst_list

Attribute Name	Attribute Value
Description	This test case checks whether the default reStructuredText converter provides a function to create valid reStructuredText list.
Verifies	SwRequirements.sw_req_rst_list

tc_rst_link

Attribute Name	Attribute Value
Description	This test case checks whether the default reStructuredText converter provides a function to create valid reStructuredText links.
Verifies	SwRequirements.sw_req_rst_link

tc_rst_image

Attribute Name	Attribute Value
Description	This test case checks whether the default reStructuredText converter provides a function to embed images in reStructuredText.
Verifies	SwRequirements.sw_req_rst_image

tc_rst_role

Attribute Name	Attribute Value
Description	This test case checks whether the default reStructuredText converter provides a function to create colored text in reStructuredText.
Verifies	SwRequirements.sw_req_rst_role

tc_rst_out_folder

Attribute Name	Attribute Value
Description	This test case checks whether the default reStructuredText converter creates output files in the specified output folder.
Verifies	SwRequirements.sw_req_rst_out_folder

tc_rst_single_doc_custom

Attribute Name	Attribute Value
Description	This test case checks whether the conversion to reStructuredText in single document mode is customizeable.
Verifies	SwRequirements.sw_req_rst_out_file_name_custom SwRequirements.sw_req_rst_sd_top_level_custom

tc_rst_multi_doc

Attribute Name	Attribute Value
Description	This test case checks whether the conversion to reStructuredText in multiple document mode convers one output document per TRLC source file.
Verifies	SwRequirements.sw_req_rst_multiple_doc_mode

tc_rst_string_format

Attribute Name	Attribute Value
Description	This test case checks that strings already in reStructuredText format are not escaped.
Verifies	SwRequirements.sw_req_rst_string_format

tc_rst_render_md

Attribute Name	Attribute Value
Description	This test case checks whether CommonMark Markdown content in requirement attributes is rendered correctly when the render configuration is set to “md”.
Verifies	SwRequirements.sw_req_rst_render_md

tc_rst_render_gfm

Attribute Name	Attribute Value
Description	This test case checks whether GitHub Flavored Markdown content in requirement attributes is rendered correctly when the render configuration is set to “gfm”.
Verifies	SwRequirements.sw_req_rst_render_gfm

tc_rst_render_plantuml

Attribute Name	Attribute Value
Description	This test case checks whether a fenced ```plantuml``` code block inside a Markdown requirement attribute is rendered as a reStructuredText ``.. image::`` directive referencing an SVG file written to the output folder.
Verifies	SwRequirements.sw_req_rst_render_plantuml SwRequirements.sw_req_plantuml

tc_rst_render_plantuml_error

Attribute Name	Attribute Value
Description	This test case checks whether a fenced ```plantuml``` code block is replaced by a [PlantUML error: ...] paragraph in the generated RST output when the PLANTUML environment variable is not configured, so the conversion does not fail.
Verifies	SwRequirements.sw_req_rst_render_plantuml

ReqIF

tc_reqif

Attribute Name	Attribute Value
Description	This test case checks whether the conversion to ReqIF format works.
Verifies	SwRequirements.sw_req_reqif SwRequirements.sw_req_reqif_record SwRequirements.sw_req_no_prj_spec SwRequirements.sw_req_cli_out SwRequirements.sw_req_reqif_single_doc_mode SwRequirements.sw_req_reqif_out_file_name_default SwRequirements.sw_req_reqif_top_level_default

tc_reqif_section

Attribute Name	Attribute Value
Description	This test case checks whether a TRLC section produces a SPEC-HIERARCHY node referencing the preceding record’s SPEC-OBJECT, and that a warning is emitted when no preceding record exists.
Verifies	SwRequirements.sw_req_reqif_section

tc_reqif_single_doc_custom

Attribute Name	Attribute Value
Description	This test case checks whether the conversion to ReqIF in single document mode is customizable.
Verifies	SwRequirements.sw_req_reqif_out_file_name_custom SwRequirements.sw_req_reqif_top_level_custom

tc_reqif_render_md

Attribute Name	Attribute Value
Description	This test case checks whether CommonMark Markdown content in requirement attributes is rendered correctly when the render configuration is set to “md”.
Verifies	SwRequirements.sw_req_reqif_render_md

tc_reqif_render_gfm

Attribute Name	Attribute Value
Description	This test case checks whether GitHub Flavored Markdown content in requirement attributes is rendered correctly when the render configuration is set to “gfm”.
Verifies	SwRequirements.sw_req_reqif_render_gfm

tc_reqif_render_xhtml

Attribute Name	Attribute Value
Description	This test case checks whether XHTML content in requirement attributes is passed through without modification when the render configuration is set to “xhtml”.
Verifies	SwRequirements.sw_req_reqif_render_xhtml

tc_reqif_render_table_options

Attribute Name	Attribute Value
Description	This test case checks whether GFM table rendering options (`border` and `headingStyle`) from the render configuration are applied to the generated ReqIF XHTML, producing a `<table>` with the configured `style` and `<th>` cells with the configured `style`.
Verifies	SwRequirements.sw_req_reqif_render_table_options

tc_reqif_render_path

Attribute Name	Attribute Value
Description	This test case checks whether a file path attribute is rendered as a ReqIF XHTML <object> element with the correct MIME type and local file reference, and that the referenced file is copied to the output folder.
Verifies	SwRequirements.sw_req_reqif_render_path

tc_reqif_render_path_reqifz

Attribute Name	Attribute Value
Description	This test case checks whether the external file referenced by a path format attribute is included in the .reqifz archive when the --reqifz option is used.
Verifies	SwRequirements.sw_req_reqif_render_path

tc_reqif_render_plantuml

Attribute Name	Attribute Value
Description	This test case checks whether a fenced ```plantuml``` code block inside a Markdown requirement attribute is rendered as an XHTML <object type=”image/svg+xml”> element in the generated ReqIF output and that the referenced SVG file is written to the output folder.
Verifies	SwRequirements.sw_req_reqif_render_plantuml SwRequirements.sw_req_plantuml

tc_reqif_render_plantuml_error

Attribute Name	Attribute Value
Description	This test case checks whether a fenced ```plantuml``` code block is replaced by a [PlantUML error: ...] paragraph in the generated ReqIF output when the PLANTUML environment variable is not configured, so the conversion does not fail.
Verifies	SwRequirements.sw_req_reqif_render_plantuml

tc_reqif_enum

Attribute Name	Attribute Value
Description	This test case checks whether a TRLC enumeration attribute is converted to a DATATYPE-DEFINITION-ENUMERATION with 0-based consecutive ENUM-VALUE keys and emitted as ATTRIBUTE-VALUE-ENUMERATION in the spec-object.
Verifies	SwRequirements.sw_req_reqif_enum SwRequirements.sw_req_reqif_enum_key_order

tc_reqif_enum_null

Attribute Name	Attribute Value
Description	This test case checks whether an optional TRLC enumeration attribute with a null value is omitted from the generated ReqIF spec-object.
Verifies	SwRequirements.sw_req_reqif_enum_null

tc_reqif_relation

Attribute Name	Attribute Value
Description	This test case checks whether TRLC record reference attributes are converted to ReqIF SPEC-RELATION entries, and that array record reference attributes produce one SPEC-RELATION per element.
Verifies	SwRequirements.sw_req_reqif_relation

tc_reqif_reqifz

Attribute Name	Attribute Value
Description	This test case checks whether the ReqIF converter archives the generated output as a .reqifz ZIP file when the --reqifz flag is given.
Verifies	SwRequirements.sw_req_reqif_reqifz

tc_reqif_identifier_store_init

Attribute Name	Attribute Value
Description	This test case checks whether the ReqIF converter creates the JSON identifier store file and stores the generated identifiers on the initial conversion when --id-store points to a non-existing file.
Verifies	SwRequirements.sw_req_reqif_identifier_store_init

tc_reqif_identifier_immutable

Attribute Name	Attribute Value
Description	This test case checks whether the identifiers of the generated ReqIF Identifiable elements stay immutable across two consecutive exports using the same --id-store file.
Verifies	SwRequirements.sw_req_reqif_identifier_immutable

tc_reqif_identifier_store_reuse

Attribute Name	Attribute Value
Description	This test case checks whether the ReqIF converter reuses stored identifiers for known elements and assigns new identifiers to new elements, writing them back to the --id-store file.
Verifies	SwRequirements.sw_req_reqif_identifier_store_reuse

Docx

tc_docx

Attribute Name	Attribute Value
Description	This test case checks whether the conversion to docx format works.
Verifies	SwRequirements.sw_req_docx SwRequirements.sw_req_docx_record

tc_docx_multiple

Attribute Name	Attribute Value
Description	This test case checks whether the conversion of multiple records containing record_references to docx format works.
Verifies	SwRequirements.sw_req_docx_record SwRequirements.sw_req_docx_reference

tc_docx_section

Attribute Name	Attribute Value
Description	This test case checks whether the conversion of a TRLC section to a docx section works.
Verifies	SwRequirements.sw_req_docx_section

tc_docx_file

Attribute Name	Attribute Value
Description	This test case checks whether the conversion to docx combines the results from multiple TRLC files into one docx file
Verifies	SwRequirements.sw_req_docx_file

tc_docx_template

Attribute Name	Attribute Value
Description	This test case checks whether the conversion using a template works correctly.
Verifies	SwRequirements.sw_req_docx_template

tc_docx_render_md

Attribute Name	Attribute Value
Description	this test case checks whether the conversion from CommonMark Markdown strings to docx works correctly.
Verifies	SwRequirements.sw_req_docx_render_md

tc_docx_render_gfm

Attribute Name	Attribute Value
Description	This test case checks whether GitHub Flavored Markdown content in requirement attributes is rendered correctly when the render configuration is set to “gfm”.
Verifies	SwRequirements.sw_req_docx_render_gfm

tc_docx_render_plantuml

Attribute Name	Attribute Value
Description	This test case checks whether a fenced ```plantuml``` code block inside a Markdown requirement attribute is rendered as an embedded PNG image in the docx output, or replaced by a [PlantUML error: ...] paragraph if PlantUML is not available.
Verifies	SwRequirements.sw_req_docx_render_plantuml SwRequirements.sw_req_plantuml

Dump

tc_ascii_conversion

Attribute Name	Attribute Value
Description	This test case checks whether the conversion to ASCII format works.
Verifies	SwRequirements.sw_req_ascii_conversion