Report Manager

ReportTable

TableReport Generate a Table based on TestResult.

report_all

report_all(manager: ResultManager, 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:

manager: A ResultManager instance.
title: Title for the report. Defaults to 'All tests results'.

Returns:

Type	Description
A fully populated rich `Table`

Source code in anta/reporter/__init__.py

def report_all(self, manager: ResultManager, 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:
    ----
        manager: A ResultManager instance.
        title: Title for the report. Defaults to 'All tests results'.

    Returns
    -------
        A fully populated rich `Table`

    """
    table = Table(title=title, show_lines=True)
    headers = ["Device", "Test Name", "Test Status", "Message(s)", "Test description", "Test category"]
    table = self._build_headers(headers=headers, table=table)

    def add_line(result: TestResult) -> None:
        state = self._color_result(result.result)
        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)

    for result in manager.results:
        add_line(result)
    return table

report_summary_devices

report_summary_devices(manager: ResultManager, devices: list[str] | None = None, title: str = 'Summary per device') -> Table

Create a table report with result aggregated per device.

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

Args:

manager: A ResultManager instance.
devices: List of device names to include. None to select all devices.
title: Title of the report.

Returns:

Type	Description
A fully populated rich `Table`.

Source code in anta/reporter/__init__.py

def report_summary_devices(
    self,
    manager: ResultManager,
    devices: list[str] | None = None,
    title: str = "Summary per device",
) -> Table:
    """Create a table report with result aggregated per device.

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

    Args:
    ----
        manager: A ResultManager instance.
        devices: List of device names to include. None to select all devices.
        title: Title of the report.

    Returns
    -------
        A fully populated rich `Table`.
    """
    table = Table(title=title, show_lines=True)
    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 device in manager.get_devices():
        if devices is None or device in devices:
            results = manager.filter_by_devices({device}).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 = [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(
                device,
                str(nb_success),
                str(nb_skipped),
                str(nb_failure),
                str(nb_error),
                str(list_failure),
            )
    return table

report_summary_tests

report_summary_tests(manager: ResultManager, tests: list[str] | None = None, title: str = 'Summary per test') -> Table

Create a table report with result aggregated 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:

manager: A ResultManager instance.
tests: List of test names to include. None to select all tests.
title: Title of the report.

Returns:

Type	Description
A fully populated rich `Table`.

Source code in anta/reporter/__init__.py

def report_summary_tests(
    self,
    manager: ResultManager,
    tests: list[str] | None = None,
    title: str = "Summary per test",
) -> Table:
    """Create a table report with result aggregated 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:
    ----
        manager: A ResultManager instance.
        tests: List of test names to include. None to select all tests.
        title: Title of the report.

    Returns
    -------
        A fully populated rich `Table`.
    """
    table = Table(title=title, show_lines=True)
    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 test in manager.get_tests():
        if tests is None or test in tests:
            results = manager.filter_by_tests({test}).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 = [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(
                test,
                str(nb_success),
                str(nb_skipped),
                str(nb_failure),
                str(nb_error),
                str(list_failure),
            )
    return table