fvm.reports module

Warning

Callables that are not documented in the Public API are not intented to be directly used and thus may change between minor versions.

Report generation functions for FVM

fvm.reports.copy_results_to_allure_results(base_dir, dst_dir)

Copy all files in the ‘results’ subfolders of the subdirectories to the allure_results folder in base_dir, overwriting them if they exist. Ignore the allure_results and allure_report folders.

fvm.reports.generate_allure(res_dir, rep_dir, allure_exec, logger)

Generate an Allure report

fvm.reports.generate_html_report(framework, logger)

Generates an Allure report from the framework results

Parameters:

• framework (fvm.framework.FvmFramework) – the FvmFramework object

• logger (loguru._logger.Logger) – the logger object

fvm.reports.generate_text_report(framework, logger)

Generate a Markdown report from the framework results

Parameters:

framework (fvm.framework.FvmFramework) – the FvmFramework object

fvm.reports.generate_xml_report(framework, logger)

Generates output reports

Parameters:

• framework (fvm.framework.FvmFramework) – the FvmFramework object

• logger (loguru._logger.Logger) – the logger object

fvm.reports.get_all_steps(steps, post_steps)

Generate a list of steps including post-steps.

Parameters:

• steps (list of str) – List of main steps.

• post_steps (dict of str to list of str) – Dictionary mapping main steps to their post-steps.

Returns:

List of all steps including post-steps.

Return type:

list of str

fvm.reports.pretty_summary(framework, logger)

Prints the final summary

Parameters:

• framework (fvm.framework.FvmFramework) – the FvmFramework object

• logger (loguru._logger.Logger) – the logger object

fvm.reports.rich_table_to_markdown(rich_table_str)

Convert a rich Table to a Markdown table.

Parameters:

rich_table_str (str) – The string representation of a rich Table.

Returns:

Markdown table as a string.

Return type:

str

fvm.reports.show_allure(directory, allure_exec, logger)

Show an Allure report