Result Manager models

Test Result model¶

UML Diagram¶

TestResult ¶

Bases: BaseModel

Describe the result of a test from a single device.

Attributes:

Name	Type	Description
`name`	`str`	Device name where the test has run.
`test`	`str`	Test name runs on the device.
`categories`	`List[str]`	List of categories the TestResult belongs to, by default the AntaTest categories.
`description`	`str`	TestResult description, by default the AntaTest description.
`results`	`str`	Result of the test. Can be one of [“unset”, “success”, “failure”, “error”, “skipped”].
`message`	`str`	Message to report after the test if any.
`error`	`Optional[Exception]`	Exception object if the test result is “error” and an Exception occured
`custom_field`	`Optional[str]`	Custom field to store a string for flexibility in integrating with ANTA

is_error ¶

is_error(message: str | None = None, exception: Exception | None = None) -> None

Helper to set status to error

Parameters:

Name	Type	Description	Default
`exception`	`Exception \| None`	Optional Exception objet related to the error	`None`

Source code in anta/result_manager/models.py

def is_error(self, message: str | None = None, exception: Exception | None = None) -> None:
    """
    Helper to set status to error

    Args:
        exception: Optional Exception objet related to the error
    """
    self._set_status("error", message)
    self.error = exception

is_failure ¶

is_failure(message: str | None = None) -> None

Helper to set status to failure

Parameters:

Name	Type	Description	Default
`message`	`str \| None`	Optional message related to the test	`None`

Source code in anta/result_manager/models.py

def is_failure(self, message: str | None = None) -> None:
    """
    Helper to set status to failure

    Args:
        message: Optional message related to the test
    """
    self._set_status("failure", message)

is_skipped ¶

is_skipped(message: str | None = None) -> None

Helper to set status to skipped

Parameters:

Name	Type	Description	Default
`message`	`str \| None`	Optional message related to the test	`None`

Source code in anta/result_manager/models.py

def is_skipped(self, message: str | None = None) -> None:
    """
    Helper to set status to skipped

    Args:
        message: Optional message related to the test
    """
    self._set_status("skipped", message)

is_success ¶

is_success(message: str | None = None) -> None

Helper to set status to success

Parameters:

Name	Type	Description	Default
`message`	`str \| None`	Optional message related to the test	`None`

Source code in anta/result_manager/models.py

def is_success(self, message: str | None = None) -> None:
    """
    Helper to set status to success

    Args:
        message: Optional message related to the test
    """
    self._set_status("success", message)

Last update: October 27, 2023