ecap5_treq.report module

ecap5_treq.report.gen_result_badge(result: float) → str

Generates a badge containing the result pourcentage, which color is dependant on the result

Parameters:

result (float) – the result to be included in the badge

Returns:

a badge containing the result pourcentage, which color is dependant on the result

Return type:

str

ecap5_treq.report.generate_report_footer() → str

Generates a string containing the report footer

ecap5_treq.report.generate_report_summary(analysis: Analysis) → str

Generates a string containing the summary section of the report

Parameters:

analysis (Analysis) – the analysis from which data shall be used

Returns:

a string containing the summary section of the report

Return type:

str

ecap5_treq.report.generate_report_warning_section() → str

Generates a string containing messages logged in this tool during the report generation

Returns:

a string containing messages logged in this tool during the report generation

Return type:

str

ecap5_treq.report.generate_test_report(analysis: Analysis) → str

Generates a string containing the test section of the report

Parameters:

analysis (Analysis) – the analysis from which data shall be used

Returns:

a string containing the test section of the report

Return type:

str

ecap5_treq.report.generate_test_result_badge(analysis: Analysis) → str

Generate badge data indicating the test result, which color changes on the result

Parameters:

analysis (Analysis) – the analysis from which data shall be used

Returns:

a json string containing the badge data

Return type:

str

ecap5_treq.report.generate_traceability_report(analysis: Analysis) → str

Generates a string containing the traceability section of the report

Parameters:

analysis (Analysis) – the analysis from which data shall be used

Returns:

a string containing the traceability section of the report

Return type:

str

ecap5_treq.report.generate_traceability_result_badge(analysis: Analysis) → str

Generate badge data indicating the traceability result, which color changes on the result

Parameters:

analysis (Analysis) – the analysis from which data shall be used

Returns:

a json string containing the badge data

Return type:

str

ecap5_treq.report.latex_to_html(content: str) → str

Converts a latex string to html formating

Parameters:

content (str) – the latex string to convert

Returns:

the content string converted to html formatting

Return type:

str

ecap5_treq.report.req_list_to_table_rows(analysis: Analysis, reqs: list[Req]) → str

Converts a list of reqs into html table rows

Parameters:

• analysis (Analysis) – the analysis from which data shall be used

• reqs (list[Req]) – the list of reqs to convert

• enable_allocation (bool) – enable the allocation column

Returns:

html table rows containing the list of reqs

Return type:

str

ecap5_treq.report.surround_with_link_if(cond: bool, href: str, content: str) → str

Returns the content string surrounded by a link to href if cond is true

Parameters:

• cond (bool) – condition boolean indicating if the content shall be surrounded

• href (str) – path used for the link

• content (str) – the content to be surrounded

Returns:

the content string surrounded by a link to href if cond is true

Return type:

str