frostfs-testlib/reporter/interfaces.py
Vladimir Domnich d3e5ee2231 Implement basic version of ssh shell
Signed-off-by: Vladimir Domnich <v.domnich@yadro.com>
2022-09-09 17:53:36 +03:00

28 lines
802 B
Python

from abc import ABC, abstractmethod
from contextlib import AbstractContextManager
from typing import Any
class Reporter(ABC):
"""
Interface that supports storage of test artifacts in some reporting tool.
"""
@abstractmethod
def step(self, name: str) -> AbstractContextManager:
"""
Register a new step in test execution.
:param str name: Name of the step
:return: step context
"""
@abstractmethod
def attach(self, content: Any, file_name: str) -> None:
"""
Attach specified content with given file name to the test report.
:param any content: content to attach. If content value is not a string, it will be
converted to a string.
:param str file_name: file name of attachment.
"""