Assertion¶

class Assertion¶

Returned by

TraceAnalysisApi.CreateAssertion

AddTag(tag)¶

Add a specific tag to this step.

Parameters:

tag : str¶: The tag to be set

AppendTraceStep(traceStep)¶

Adds a trace step at the end of its children.

Parameters:

traceStep¶: Trace step to be added

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:: Assertion

GetCheckErrorMessage()¶

Returns whether the error messages are checked for an expression.

Returns:: The error messages are checked
Return type:: boolean

GetCheckExpectedVerdict()¶

Returns whether the verdict is checked for an expected value.

Returns:: The verdict is checked
Return type:: boolean

GetCheckMaxExecutionTime()¶

Returns whether the execution time is checked against a max value.

Returns:: The max execution time is checked
Return type:: boolean

GetCheckMinExecutionTime()¶

Returns whether the execution time is checked against a min value.

Returns:: The min execution time is checked
Return type:: boolean

GetCheckResultText()¶

Returns whether the result text is to be checked.

Returns:: Returns whether the result text is to be checked
Return type:: boolean

GetDescription()¶

Returns the description of the trace analysis element.

Returns:: The description
Return type:: str

GetErrorMessageExpr()¶

Returns the expression for the expected error message.

Returns:: The error message expression
Return type:: str

GetExpectedVerdict()¶

Returns the expected verdict. Possible values are:

‘NONE’
‘SUCCESS’
‘INCONCLUSIVE’
‘FAILED’
‘ERROR’

A list of these values is also possible.

Returns:: The expected verdict
Return type:: str

GetIndex()¶

Returns the zero based index in the parent.

Returns:: Zero based index
Return type:: int

GetLineNo()¶

Returns the trace steps line number within its trace analysis.

Returns:: Line number
Return type:: int

GetMaxExecutionTimeExpr()¶

Returns the max value the execution time is checked against.

Returns:: The max execution time expression
Return type:: str

GetMaxExecutionTimeUnit()¶

Returns the unit for the max execution time. Possible values are:

‘min’
‘s’
‘ms’
‘h’
‘d’

Returns:: The max execution time unit
Return type:: str

GetMinExecutionTimeExpr()¶

Returns the min value the execution time is checked against.

Returns:: The min execution time expression
Return type:: str

GetMinExecutionTimeUnit()¶

Returns the unit for the min execution time. Possible values are:

‘min’
‘s’
‘ms’
‘h’
‘d’

Returns:: The min execution time unit
Return type:: str

GetName()¶

Returns the name of the trace analysis element.

Returns:: The name
Return type:: str

GetResultTextExpr()¶

Returns the expression that describes the expected result text.

Returns:: Expected result text
Return type:: str

GetTags()¶

Returns the tags set for this step.

Returns:: A (sorted) list of tags
Return type:: list[str]

GetTraceSteps(skipDisabledSteps=False, recursive=False)¶

Returns either direct or all children of the trace step.

Parameters:

skipDisabledSteps : boolean¶: Defines whether disabled trace steps should be excluded, defaults to False.
recursive : boolean¶: Defines whether children of children are included, defaults to False.

Returns:

The trace steps as flat list.

Return type:

list[TraceStep]

GetType()¶

Returns the type (class name) of the trace step, e.g.

‘Episode’
‘AnalysisBlock’
‘TriggerBlock’
‘Calculation’
‘TemplateBasedTraceStep’
‘TraceAnalysisReference’
‘TraceAnalysisReferenceDeprecated’

Returns:: Type (class name) of the trace step
Return type:: str

GetUuid()¶

Returns the UUID of the trace step.

Returns:: UUID of the trace step
Return type:: str

InsertTraceStep(traceStep, position)¶

Adds a trace step at a certain line of the trace analysis.

Parameters:

traceStep¶: Trace step to be added
position : integer¶: Target index of child beginning with 0

IsContainer()¶

Checks whether this trace step can contain trace steps.

Returns:: True if it can contain trace steps, else False
Return type:: boolean

IsEnabled()¶

Checks whether the trace step is enabled.

Returns:: True if trace step is enabled, else False
Return type:: boolean

IsOk()¶

Returns the internal state of correctness of the trace step.

Returns:: True if no problems were found, else False
Return type:: boolean

IsVisible()¶

Checks whether the trace step is visible. This depends on the trace step itself or a parent trace step being disabled.

Returns:: True if trace step is visible, else False
Return type:: boolean

RemoveTag(tag)¶

Remove a specific tag from this step.

Parameters:

tag : str¶: The tag to be removed

RemoveTraceStep(traceStep)¶

Removes the given trace step from the trace analysis.

Parameters:

traceStep¶: Trace step to be removed

SetCheckErrorMessage(checkErrorMessage)¶

Sets whether the error messages are checked for an expression.

Parameters:

checkErrorMessage : boolean¶: The error messages are checked

SetCheckExpectedVerdict(checkVerdict)¶

Sets whether the verdict is checked for an expected value.

Parameters:

checkVerdict : boolean¶: The verdict is checked

SetCheckMaxExecutionTime(checkMaxExecutionTime)¶

Sets whether the execution time is checked against a max value.

Parameters:

checkMaxExecutionTime : boolean¶: The max execution time is checked

SetCheckMinExecutionTime(checkMinExecutionTime)¶

Sets whether the execution time is checked against a min value.

Parameters:

checkMinExecutionTime : boolean¶: The min execution time is checked

SetCheckResultText(checkResultText)¶

Sets whether the result text is to be checked.

Parameters:

checkResultText : boolean¶: Specifies whether result text is to be checked

SetDescription(value)¶

Sets the description of the trace analysis element.

Parameters:

value : str¶: The new description

SetEnabled(enable)¶

Enables or disables the trace step (this also affects child trace steps).

Parameters:

enable : boolean¶: If True, enables the trace step, if False, disables the trace step

SetErrorMessageExpr(errorMessageExpr)¶

Sets an expression for an expected error message.

Parameters:

errorMessageExpr : str¶: The error message expression

SetExpectedVerdict(verdict)¶

Sets the expected verdict. Possible values are:

‘NONE’
‘SUCCESS’
‘INCONCLUSIVE’
‘FAILED’
‘ERROR’

A list of these values is also valid.

Parameters:

verdict : str¶: The expected verdict

SetMaxExecutionTimeExpr(maxExecutionTimeExpr)¶

Sets the max value the execution time is checked against.

Parameters:

maxExecutionTimeExpr : str¶: The max execution time expression

SetMaxExecutionTimeUnit(maxExecutionTimeUnit)¶

Sets the unit for the max execution time. Possible values are:

‘min’
‘s’
‘ms’
‘h’
‘d’

Parameters:

maxExecutionTimeUnit : str¶: The max execution time unit

Raises:

ApiError – If maxExecutionTimeUnit is not a valid unit

SetMinExecutionTimeExpr(minExecutionTimeExpr)¶

Sets the min value the execution time is checked against.

Parameters:

minExecutionTimeExpr : str¶: The min execution time expression

SetMinExecutionTimeUnit(minExecutionTimeUnit)¶

Sets the unit for the min execution time. Possible values are:

‘min’
‘s’
‘ms’
‘h’
‘d’

Parameters:

minExecutionTimeUnit : str¶: The min execution time unit

Raises:

ApiError – If minExecutionTimeUnit is not a valid unit

SetName(value)¶

Sets the name of the trace analysis element.

Parameters:

value : str¶: The new name

SetResultTextExpr(resultTextExpr)¶

Set the expression that describes the expected result text.

Parameters:

resultTextExpr : str¶: Expected result text

SetTags(tags)¶

Set the list of tags for this step. The list of tags will be sorted and stored.

Parameters:

tags : list[str]¶: The list of tags