forked from TrueCloudLab/frostfs-testlib
[#7] Add contribution guideline with code style
Signed-off-by: Vladimir Domnich <v.domnich@yadro.com>
This commit is contained in:
parent
2112665844
commit
d3f51ee398
23 changed files with 770 additions and 766 deletions
|
@ -4,25 +4,25 @@ from typing import Any
|
|||
|
||||
|
||||
class Reporter(ABC):
|
||||
"""
|
||||
Interface that supports storage of test artifacts in some reporting tool.
|
||||
"""
|
||||
"""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.
|
||||
"""Register a new step in test execution.
|
||||
|
||||
:param str name: Name of the step
|
||||
:return: step context
|
||||
Args:
|
||||
name: Name of the step.
|
||||
|
||||
Returns:
|
||||
Step context.
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def attach(self, content: Any, file_name: str) -> None:
|
||||
"""
|
||||
Attach specified content with given file name to the test report.
|
||||
"""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.
|
||||
Args:
|
||||
content: Content to attach. If content value is not a string, it will be
|
||||
converted to a string.
|
||||
file_name: File name of attachment.
|
||||
"""
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue