TsEdiabas

class TsEdiabas

Returned by

AddResult(name)

Adds a self defined result to the result list.

Parameters:
name : str

Name of the result

Returns:

Self defined result

Return type:

EdiabasResult

Raises:

ApiError: When the name of the result is already defined.

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:

TsEdiabas

DeactivateSaveAllIn()

Deactivated the save all in variable 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’)

GetActionColumnText()

Returns the text value of the “action” column.

Returns:

Action column text

Return type:

str

GetArguments()

Returns the argument list.

Returns:

List of Ediabas arguments

Return type:

list[EdiabasArgument]

Raises:

ApiError: If the initialization EDIABAS data object fails.

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

GetMappingItemReferenceName()

Returns the unique reference name of the mapping item used by this test step.

Returns:

Reference name of used mapping item

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

GetResponseExpectation()

Returns the expected response from the ECU.

Returns:

Expected response. One of [u’EXPECTED’, u’OPTIONAL’, u’NOT_EXPECTED’]

Return type:

str

GetResults()

Returns the result list.

Returns:

List of results

Return type:

list[EdiabasResult]

GetSaveAllInVariableName()

Returns the save all in variable name.

Returns:

Variable name

Return type:

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

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

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

IsReportAllEnabled()

Returns whether the report all option is enabled.

Returns:

Whether report all is enabled or not.

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

RemoveResult(name)

Removes a self defined result from the result list.

Parameters:
name : str

Name of the result

Raises:

ApiError – If the test step has no self defined result with the given name

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

SetEnabled(state=True)

Enable or disable the test step.

Parameters:
state : bool

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

SetReportAll(reportAll=True)

Sets whether the report all option is enabled.

Parameters:
reportAll : boolean

Whether report all is enabled or not. (optional, defaults to True)

Raises:

ApiError: Is the parameter reportAll is not of type boolean.

SetResponseExpectation(respExp)

Sets the expected response from the ECU.

Parameters:
respExp : str

Expected response. Must be one of [u’EXPECTED’, u’OPTIONAL’, u’NOT_EXPECTED’]

Raises:

ApiError: When the expected response parameter is invalid.

SetSaveAllInVariableName(varName)

Sets the save all in variable name.

Parameters:
varName : str

Variable name

Raises:

ApiError: - If the parameter varName is not of type str - The test step is not added to a package

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