ReportAnalysisEpisode¶
- class ReportAnalysisEpisode¶
-
AddRevalComment(author, comment, revaluation=
None)¶ Add a revaluation comment to the test step.
- Clone()¶
Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.
- Returns:
A copy of this object
- Return type:
- GetAbortCode()¶
Returns the abort code of the report item.
- Returns:
Abort code
- Return type:
str
- GetAbortComment()¶
Returns the abort comment of the report item.
- Returns:
Abort comment
- Return type:
str
- GetActivity()¶
Returns the content of the ‘Name’.
- Returns:
Content of the Name column
- Return type:
str
- GetDescription()¶
Returns the content of the ‘Description’ column.
- Returns:
Content of the ‘Description’ column
- Return type:
str
- GetDuration()¶
Returns the execution duration.
- Returns:
Excecution duration in seconds
- Return type:
float
- GetEntities()¶
Returns a list of all entities.
- Returns:
a list of all entity objects
- Return type:
list[
Entity]
- GetErrorMessage()¶
Returns the episode’s error message.
- Returns:
The error message if existing, else an empty string
- Return type:
str
- GetId()¶
Returns the Id of the report item.
- Returns:
Id of the report item
- Return type:
int
- GetLabel()¶
Returns the content of the ‘Activity/Name’ column for test steps. Returns the content of the ‘Name’ column for trace steps.
- Returns:
Content of the ‘Activity/Name’ column for test steps and content of the ‘Name’ column for trace steps
- Return type:
str
- GetName()¶
Returns the content of the ‘Generic signals’ column.
- Returns:
Content of the ‘Generic signals’ column
- Return type:
str
- GetNestingLevel()¶
Returns the nesting depth.
- Returns:
Nesting depth
- Return type:
int
- GetOriginalResult()¶
Returns the content of the ‘Original evaluation’ column.
- Returns:
Content of the ‘Original evaluation’ column
- Return type:
str
- GetParameter()¶
Returns the content of the ‘Parameter’ column.
- Returns:
Content of the ‘Parameter’ column
- Return type:
str
- GetParentId()¶
Returns the Id of the parent report item.
- Returns:
Id of the parent report item
- Return type:
int
- GetPosition()¶
Returns the position of the step within the test case / trace analysis. Example 1: “3” is returned for the step which is at position 3 in the top level Package. Example 2: “5.13” is returned for the 13th step of the subpackage which is at position 5 in the top level Package.
- Returns:
position within the test case / trace analysis
- Return type:
str
- GetResult()¶
Returns the content of the ‘Evaluation’ column.
- Returns:
Content of the ‘Evaluation’ column
- Return type:
str
- GetResultText()¶
Returns text illustrated in the trace step’s report details below ‘result’.
- Returns:
The result text if existing, else an empty string
- Return type:
str
- GetRevalComments()¶
Returns all revaluation comments of the test step.
- Returns:
List of revaluation comments
- Return type:
list[
RevaluationComment]
- GetTags()¶
Returns all tags associated with this report entry.
- Returns:
Tags
- Return type:
list[str]
- GetTextEntities()¶
Returns all text entities associated with this report entry.
- Returns:
text entities
- Return type:
list[list[str]]
-
GetTraceSteps(recursive=
False)¶ Returns direct/all children trace steps of this step. If the trace step is no container an empty list will be returned.
- Parameters:
- recursive : boolean¶
Defines whether children of children are included, defaults to False.
- Returns:
List of trace steps
- Return type:
list[
ReportAnalysisStep]
- HasTag(tagName)¶
Returns whether this report item has set the specified tag.
- Parameters:
- tagName : str¶
The tag to check for
- Returns:
True, if the tag is set, otherwise False
- Return type:
bool
- IsTemplateBasedTraceStep()¶
Returns whether the trace step is based on a template.
- Returns:
True if trace step is based on a template
- Return type:
bool
-
AddRevalComment(author, comment, revaluation=