ReportTestStep

class ReportTestStep
AddRevalComment(author, comment, revaluation=None)

Add a revaluation comment to the test step.

Parameters:
author : str

author of the comment

comment : str

text of the comment. Must be at least 10 characters

revaluation : str

“NONE”, “SUCCESS”, “INCONCLUSIVE”, “FAILED” or “ERROR”; None to just add a comment without changing the result

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:

ReportTestStep

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

GetAbsoluteTime()

Returns the content of the ‘Time (absolute)’ column.

Returns:

Content of the ‘Time (absolute)’ column

Return type:

float

GetComment()

Returns the content of the ‘Comment’ column.

Returns:

Content of the ‘Comment’ column

Return type:

str

GetEntities()

Returns a list of all entities.

Returns:

a list of all entity objects

Return type:

list[Entity]

GetExpectedValue()

Returns the content of the ‘Expected value’ column. :return: Content of the ‘Expected value’ column :rtype: 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

GetMappingTargets()

Returns a list with the contents of the ‘Mapping target’ column.

Returns:

Content of the ‘Mapping target’ column

Return type:

list[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

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

GetRelativeRealTime()

Returns the content of the ‘Time [s] (relative)’ column.

Returns:

Content of the ‘Time [s] (relative)’ column

Return type:

float

GetRelativeTestTime()

Returns the content of the ‘Test time [s]’ column.

Returns:

Content of the ‘Test time [s]’ column

Return type:

float

GetResult()

Returns the content of the ‘Evaluation’ column.

Returns:

Content of the ‘Evaluation’ column

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]

GetTestSteps()

Returns all direct child test steps of the test step. If the test step is no container an empty list will be returned.

Returns:

List of test step results

Return type:

list[ReportTestStep]

GetTextEntities()

Returns all text entities associated with this report entry.

Returns:

text entities

Return type:

list[list[str]]

GetTimeDiffToPreviousTeststep()

Returns the time difference in seconds between the previous test step and this test step. :return: The time difference in seconds :rtype: float

GetUserDefinedReportDetails()

Returns a list of all report details defined by the user during test execution. Each item in the list is a tuple, representing a line within the report details. The header line displayed in the report is not included in the returned list.

Returns:

A list of tuples, each inner list representing a line within the report details

Return type:

list[list[str]]

GetValue()

Returns the content of the ‘Value’ column.

Returns:

Content of the ‘Value’ column

Return type:

str

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