TsCANoeTestModuleRunner

class TsCANoeTestModuleRunner

Api- of the break test step.

Returned by

AddTag(tag)

Add a specific tag to this step.

Parameters:
tag : str

The tag to be set

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:

TsCANoeTestModuleRunner

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’)

GetActionColumnText()

Returns the text value of the “action” column.

Returns:

Action column text

Return type:

str

GetAvailableTestEnvironments()

Returns a list of avaibale test environments.

Prerequisite: Tooladapter CANoeCANalyzer is configured and connected.

Returns:

list of avaibale test environments

Return type:

list[unicode]

GetAvailableTestModules(testEnvironment=None)

Returns a list of available test modules in the chosen test environment.

Parameters:
testEnvironment : unicode

Name of the test environment (without quotes). None for the currently chosen one (see SetTestEnvironmentExpression() and GetTestEnvironmentExpression())

Returns:

list of available test modules in the chosen test environment

Return type:

list[unicode]

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

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

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

GetTags()

Returns the tags set for this step.

Returns:

A (sorted) list of tags

Return type:

list[str]

GetTestEnvironmentExpression()

Returns the expression that defines the test environment

Returns:

test environment expression

Return type:

unicode

GetTestManagementId()

Returns the test management id of the test step.

Returns:

Test step id.

Return type:

str

GetTestModules()

If the test modules are chosen statically, this methods returns a list of selected test module names.

Otherwise, it returns None.

Returns:

statically selected test modules

Return type:

list[unicode]

GetTestModulesExpression()

Returns the expression that defines the test modules list.

This might be a fixed list of strings, if the test modules are chosen statically.

None if the option to run all test modules is checked.

Returns:

test modules expression

Return type:

unicode

GetTestStepId()

Returns the test step id.

Returns:

test step id

Return type:

str

GetTimeoutExpression()

Returns the expression that defines the timeout per test module.

None if no timeout is set

Returns:

timeout expression

Return type:

unicode

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

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

IsCopyIndividualReports()

Returns whether the individual reports of the test modules are to be copied.

Returns:

whether the individual reports of the test modules are to be copied

Return type:

boolean

IsCopySummaryReport()

Returns whether the summary report is to be copied.

Returns:

whether the summary report is to be copied

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

IsOk()

Returns the internal state of correctness of the test step.

Returns:

True if no problems were found, else False

Return type:

boolean

IsRunAllTestModules()

Returns whether the option to run all test modules is checked.

Returns:

whether the option to run all test modules is checked

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

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

SetCopyIndividualReports(doCopy=True)

Sets whether the individual reports of the test modules are to be copied.

Parameters:
doCopy : boolean

whether the individual reports of the test modules are to be copied

SetCopySummaryReport(doCopy=True)

Sets whether the summary report is to be copied.

Parameters:
doCopy : boolean

whether the summary report is to be copied

SetEnabled(state=True)

Enable or disable the test step.

Parameters:
state : bool

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

SetExecuteAllTestModules()

Sets the option to execute all test modules of the test environment

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

SetTestEnvironmentExpression(testEnvironment)

Sets the expression for the test environment.

To set a fixed test environment, enclose it in an additional pair of quotes, or use repr.

Parameters:
testEnvironment : unicode

expression for the test environment

SetTestManagementId(testManagementId)

Sets the test management id of the test step.

Parameters:
testManagementId : str

Test management id of the test step

SetTestModules(testModules)

Sets a fixed list of test modules to be executed

Parameters:
testModules : list[unicode]

list of test modules to be executed

SetTestModulesExpression(testModulesExpression)

Sets the expression for the test modules to be executed

Parameters:
testModulesExpression : unicode

expression for the test modules to be executed

SetTimeoutExpression(timeoutExpression)

Set the expression that defines the timeout per test module.

Set the expression to None to disable the timeout.

Parameters:
timeoutExpression : unicode

timeout expression

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’)