Report Manager module

ReportTable

ReportTable()

TableReport Generate a Table based on TestResult.

Source code in anta/reporter/__init__.py

def __init__(self) -> None:
    """
    __init__ Class constructor
    """
    self.colors = []
    self.colors.append(ColorManager(level="success", color=RICH_COLOR_PALETTE.SUCCESS))
    self.colors.append(ColorManager(level="failure", color=RICH_COLOR_PALETTE.FAILURE))
    self.colors.append(ColorManager(level="error", color=RICH_COLOR_PALETTE.ERROR))
    self.colors.append(ColorManager(level="skipped", color=RICH_COLOR_PALETTE.SKIPPED))

report_all

report_all(result_manager: ResultManager, host: Optional[str] = None, testcase: Optional[str] = None, title: str = 'All tests results') -> Table

Create a table report with all tests for one or all devices.

Create table with full output: Host / Test / Status / Message

Parameters:

Name	Type	Description	Default
result_manager	ResultManager	A manager with a list of tests.	required
host	str	IP Address of a host to search for. Defaults to None.	None
testcase	str	A test name to search for. Defaults to None.	None
title	str	Title for the report. Defaults to ‘All tests results’.	'All tests results'

Returns:

Name	Type	Description
Table	Table	A fully populated rich Table

Source code in anta/reporter/__init__.py

def report_all(
    self,
    result_manager: ResultManager,
    host: Optional[str] = None,
    testcase: Optional[str] = None,
    title: str = "All tests results",
) -> Table:
    """
    Create a table report with all tests for one or all devices.

    Create table with full output: Host / Test / Status / Message

    Args:
        result_manager (ResultManager): A manager with a list of tests.
        host (str, optional): IP Address of a host to search for. Defaults to None.
        testcase (str, optional): A test name to search for. Defaults to None.
        title (str, optional): Title for the report. Defaults to 'All tests results'.

    Returns:
        Table: A fully populated rich Table
    """
    table = Table(title=title)
    headers = ["Device", "Test Name", "Test Status", "Message(s)", "Test description", "Test category"]
    table = self._build_headers(headers=headers, table=table)

    for result in result_manager.get_results(output_format="list"):
        # pylint: disable=R0916
        if (host is None and testcase is None) or (host is not None and str(result.name) == host) or (testcase is not None and testcase == str(result.test)):
            state = self._color_result(status=str(result.result), output_type="str")
            message = self._split_list_to_txt_list(result.messages) if len(result.messages) > 0 else ""
            categories = ", ".join(result.categories)
            table.add_row(str(result.name), result.test, state, message, result.description, categories)
    return table

report_summary_hosts

report_summary_hosts(result_manager: ResultManager, host: Optional[str] = None, title: str = 'Summary per host') -> Table

Create a table report with result agregated per host.

Create table with full output: Host / Number of success / Number of failure / Number of error / List of nodes in error or failure

Parameters:

Name	Type	Description	Default
result_manager	ResultManager	A manager with a list of tests.	required
host	str	IP Address of a host to search for. Defaults to None.	None
title	str	Title for the report. Defaults to ‘All tests results’.	'Summary per host'

Returns:

Name	Type	Description
Table	Table	A fully populated rich Table

Source code in anta/reporter/__init__.py

def report_summary_hosts(
    self,
    result_manager: ResultManager,
    host: Optional[str] = None,
    title: str = "Summary per host",
) -> Table:
    """
    Create a table report with result agregated per host.

    Create table with full output: Host / Number of success / Number of failure / Number of error / List of nodes in error or failure

    Args:
        result_manager (ResultManager): A manager with a list of tests.
        host (str, optional): IP Address of a host to search for. Defaults to None.
        title (str, optional): Title for the report. Defaults to 'All tests results'.

    Returns:
        Table: A fully populated rich Table
    """
    table = Table(title=title)
    headers = [
        "Device",
        "# of success",
        "# of skipped",
        "# of failure",
        "# of errors",
        "List of failed or error test cases",
    ]
    table = self._build_headers(headers=headers, table=table)
    for host_read in result_manager.get_hosts():
        if host is None or str(host_read) == host:
            results = result_manager.get_result_by_host(host_read)
            logger.debug("data to use for computation")
            logger.debug(f"{host}: {results}")
            nb_failure = len([result for result in results if result.result == "failure"])
            nb_error = len([result for result in results if result.result == "error"])
            list_failure = [str(result.test) for result in results if result.result in ["failure", "error"]]
            nb_success = len([result for result in results if result.result == "success"])
            nb_skipped = len([result for result in results if result.result == "skipped"])
            table.add_row(
                str(host_read),
                str(nb_success),
                str(nb_skipped),
                str(nb_failure),
                str(nb_error),
                str(list_failure),
            )
    return table

report_summary_tests

report_summary_tests(result_manager: ResultManager, testcase: Optional[str] = None, title: str = 'Summary per test case') -> Table

Create a table report with result agregated per test.

Create table with full output: Test / Number of success / Number of failure / Number of error / List of nodes in error or failure

Parameters:

Name	Type	Description	Default
result_manager	ResultManager	A manager with a list of tests.	required
testcase	str	A test name to search for. Defaults to None.	None
title	str	Title for the report. Defaults to ‘All tests results’.	'Summary per test case'

Returns:

Name	Type	Description
Table	Table	A fully populated rich Table

Source code in anta/reporter/__init__.py

def report_summary_tests(
    self,
    result_manager: ResultManager,
    testcase: Optional[str] = None,
    title: str = "Summary per test case",
) -> Table:
    """
    Create a table report with result agregated per test.

    Create table with full output: Test / Number of success / Number of failure / Number of error / List of nodes in error or failure

    Args:
        result_manager (ResultManager): A manager with a list of tests.
        testcase (str, optional): A test name to search for. Defaults to None.
        title (str, optional): Title for the report. Defaults to 'All tests results'.

    Returns:
        Table: A fully populated rich Table
    """
    # sourcery skip: class-extract-method
    table = Table(title=title)
    headers = [
        "Test Case",
        "# of success",
        "# of skipped",
        "# of failure",
        "# of errors",
        "List of failed or error nodes",
    ]
    table = self._build_headers(headers=headers, table=table)
    for testcase_read in result_manager.get_testcases():
        if testcase is None or str(testcase_read) == testcase:
            results = result_manager.get_result_by_test(testcase_read)
            nb_failure = len([result for result in results if result.result == "failure"])
            nb_error = len([result for result in results if result.result == "error"])
            list_failure = [str(result.name) for result in results if result.result in ["failure", "error"]]
            nb_success = len([result for result in results if result.result == "success"])
            nb_skipped = len([result for result in results if result.result == "skipped"])
            table.add_row(
                testcase_read,
                str(nb_success),
                str(nb_skipped),
                str(nb_failure),
                str(nb_error),
                str(list_failure),
            )
    return table

---

Last update: August 18, 2023