TsInfoBlock

class TsInfoBlock

Returned by

AddTag(tag)

Add a specific tag to this step.

Parameters:
tag : str

The tag to be set

AllowBlockAbort(allow=True)

Sets whether the block can be aborted. If True, the dialog will contain a button to abort the block.

Parameters:
allow : boolean

Whether a block can be aborted

AllowTestAbort(allow=True)

Sets whether the whole test can be aborted. If True, the dialog will contain a button to abort the test.

Parameters:
allow : boolean

Whether the whole test can be aborted

AppendTestStep(testStep)

Adds a test step at the end of the container.

Parameters:
testStep

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

TsInfoBlock

DeactivateTimeOutExpression()

Deactivates the timeout option.

DeleteTranslatedCommentText(language)

Deletes a comment for the test step in the given language.

Parameters:
language : str

Language of the text (‘en_US’, ‘de_DE’, ‘zh_CN’)

DisableReporting(disable=True)

Disables or enables the reporting this test step.

Parameters:
disable : boolean

If True the result of this test step will not be reported (optional)

DisableReportingFor(results)

Sets for which results reporting of the test step is disabled.

Parameters:
results : list[str]

List of results for which the test step will not be reported. Valid results are: u’NONE’, u’SUCCESS’, u’INCONCLUSIVE’, u’FAILED’, u’ERROR’

GetActionColumnText()

Returns the text value of the “action” column.

Returns:

Action column text

Return type:

str

GetBlockAbortTimeOutExpression()

Returns the timeout expression that defines that maximum user input time in seconds. If the user exceeds this time the test step will be aborted.

Returns:

Time out expression

Return type:

str

GetComment()

Returns the comment of the test step in the current test case language.

Returns:

Comment text as shown in the comment tab

Return type:

str

GetCommentColumnText()

Returns the text value of the “comment” column.

Returns:

Comment column text

Return type:

str

GetDialogHeightExpression()

Returns the height expression of the dialog which defines the height.

Returns:

Height expression

Return type:

str

GetDialogWidthExpression()

Returns the width expression of the dialog.

Returns:

Width expression

Return type:

str

GetDisplayText()

Returns the display text of the dialog.

Returns:

Display text

Return type:

str

GetError()

Returns a list of errors. Note that the error messages depend on the program language ecu.test is set to. Because of that we do not recommend to check against exact error messages, unless you are certain about the respective program language.

Returns:

List of errors

Return type:

list[str]

GetIndex()

Returns the zero based index in the parent.

Returns:

Zero based index

Return type:

integer

GetLineNo()

Returns the test steps line number within its test case.

Returns:

Line number

Return type:

int

GetName()

Returns the name of the info block dialog.

Returns:

Name of the dialog

Return type:

str

GetParameterColumnText()

Returns the text value of the “parameter” column.

Returns:

Parameter column text

Return type:

str

GetParent()

Returns the parent test step.

Returns:

The parent test step or None if it is a top level test step.

Return type:

TestStep

GetReportDisablingResults()

Returns for which results reporting of the test step is disabled.

Returns:

List of results for which the test step will not be reported

Return type:

list[str]

GetTags()

Returns the tags set for this step.

Returns:

A (sorted) list of tags

Return type:

list[str]

GetTestManagementId()

Returns the test management id of the test step.

Returns:

Test step id.

Return type:

str

GetTestStepId()

Returns the test step id.

Returns:

test step id

Return type:

str

GetTestSteps(skipDisabledSteps=True, recursive=False, whiteList=None, blackList=None)

Returns the children of the test step.

Parameters:
skipDisabledSteps : boolean

Defines whether disabled test steps should be excluded.

recursive : boolean

Specifies whether only the direct children of the test step or recursively all test steps from the complete test step tree should be returned.

whiteList : list[str]

If specified, only those test steps whose class name is on this list are returned.

blackList : list[str]

If specified, only those test steps whose class name is not on this list are returned.

Returns:

List with all children test steps

Return type:

list[TestStep]

GetTranslatedCommentText(language)

Returns the text value of the “comment” column in the given language.

Parameters:
language : str

Language of the requested text (‘en_US’, ‘de_DE’, ‘zh_CN’)

Returns:

Comment column text

Return type:

str

GetType()

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

  • “TsPreconditionBlock”

  • “TsWait”

  • “TsIfThenElse”

  • “TsSwitchCase”

  • “TsCaseNode”

Returns:

Type (class name) of the test step

Return type:

str

GetValueColumnText()

Returns the text value of the “value” column in your current test case language.

Returns:

Value column text

Return type:

str

InsertTestStep(testStep, position)

Adds a test step at a certain position of the container.

Parameters:
testStep

Test step to be added

position : integer

Target index of child beginning with 0

IsBlockAbortAllowed()

Returns whether the block can be aborted. If True, the dialog will contain a button to abort the block.

Returns:

Whether a block can be aborted.

Return type:

boolean

IsBreakpoint()

Checks whether the test step is a break point.

Returns:

True if test step is a break point, else False

Return type:

boolean

IsContainer()

Returns True, if the test step supports calling GetChildren as well as manipulating the structure of its children. (e. g. via inserting or deleting sub test steps).

Returns:

True if it can contain test steps, else False

Return type:

boolean

IsEnabled()

Returns the state of the test step.

Returns:

True if test step is enabled, otherwise False

Return type:

bool

IsInPostcondition()

Returns True if the test step is located in a postcondition

Returns:

True if the test step is located in a postcondition, else Flase

Return type:

bool

IsInPrecondition()

Returns True if the test step is located in a precondition

Returns:

True if the test step is located in a precondition, else False

Return type:

bool

IsMaximizeEnabled()

Returns whether the dialog will be maximized or not.

Returns:

Whether the dialog is maximized or not

Return type:

boolean

IsOk()

Returns the internal state of correctness of the test step.

Returns:

True if no problems were found, else False

Return type:

boolean

IsReportingDisabled()

Returns whether reporting of this test step is disabled.

Returns:

True if reporting is disabled

Return type:

boolean

IsTestAbortAllowed()

Returns whether the whole test can be aborted.If True, the dialog will contain a button to abort the test.

Returns:

Whether the whole test can be aborted

Return type:

boolean

IsVisible()

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

Returns:

True if test 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

RemoveTestStep(testStep)

Removes a test step from the container.

Parameters:
testStep

Test step to be removed

Raises:

ApiError:

  • When the test step is not a direct child of the container

  • When the test step is not editable

SetBlockAbortTimeOutExpression(timeoutExpr)

Sets the timeout expression that defines the maximum user input time in seconds. If the user exceeds this time the test step will be aborted. This option will not have any effect if block abort is not allowed.

Parameters:
timeoutExpr : str

Time out expression

SetBreakpoint(enable)

Sets or unsets the test step to act as a break point.

Parameters:
enable : boolean

True if test step is a break point, else False

SetComment(comment)

Sets a comment for the test step in the current test case language.

Parameters:
comment : str

Text to be displayed in the comment tab

SetDialogHeightExpression(newHeightExpr)

Sets the height expression of the dialog.

Parameters:
newHeightExpr : str

Height expression

SetDialogWidthExpression(newWidthExpr)

Sets the width expression of the dialog.

Parameters:
newWidthExpr : str

Width expression

SetDisplayText(text)

Sets the display text of the dialog.

Parameters:
text : str

Display text

SetEnabled(state=True)

Enable or disable the test step.

Parameters:
state : bool

True (Default) to enable, False to disable the test step.

SetMaximize(maximize=True)

Sets whether the dialog will be maximized or not. If True, the values set with SetDialogWidthExpression and SetDialogHeightExpression won’t have any effect.

Parameters:
maximize : boolean

Whether the dialog is maximized (Default = True)

SetName(name)

Sets the name of the info block dialog.

Parameters:
name : str

Name of the dialog

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

SetTestManagementId(testManagementId)

Sets the test management id of the test step.

Parameters:
testManagementId : str

Test management id of the test step

SetTranslatedCommentText(comment, language)

Sets a comment for the test step in the given language.

Parameters:
comment : str

Text to be displayed

language : str

Language of the text (‘en_US’, ‘de_DE’, ‘zh_CN’)