TsParallelPackageCall¶
- class TsParallelPackageCall¶
Returned by
- 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:
- 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 of this test step.
- Parameters:
- disable : boolean¶
If True the result of this test step will not be reported (optional)
- DisableReportingFor(results)¶
Sets results for which reporting of the test step is to be 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’.
- GetAbsolutePath()¶
Returns the absolute file path of the referenced package.
- Returns:
Absolute file path of the package to be called. None if there is no path to a referenced package.
- Return type:
str
- GetActionColumnText()¶
Returns the text value of the “action” column.
- Returns:
Action column text
- 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
- 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]
- GetInboxBindings()¶
Returns the inbox bindings for this parallel package call. The keys of the returned dict are the inboxes of the called package, the values are the outboxes of the calling package. :return: dict with items of the form (calleeInbox: callerOutbox) :rtype: dict[str, str]
- GetIndex()¶
Returns the zero based index in the parent.
- Returns:
Zero based index
- Return type:
integer
- GetLineNo()¶
Returns the line number of the test step inside the test case.
- Returns:
Line number of the test step
- Return type:
int
- GetOutboxBindings()¶
Returns the outbox bindings for this parallel package call. The keys of the returned dict are the outboxes of the called package, the values are the inboxes of the calling package. :return: dict with items of the form (calleeOutbox: callerInbox) :rtype: dict[str, str]
- GetPackageParameter(paramName)¶
Retrieves the expression assigned to a package parameter.
- Parameters:
- paramName : str¶
Name of the parameter
- Returns:
Expression assigned to the parameter
- Return type:
str
- Raises:
ApiError – If paramName does not exist.
- GetPackageParameters()¶
Retrieves all package parameters with its expressions.
- Returns:
Dictionary of <parameter name, expression> items
- Return type:
dict[str, str]
- GetPackageReturn(varInternal)¶
Retrieves the variable name assigned to a package return variable name of the referenced package.
- Parameters:
- varInternal : str¶
Name of the return variable of the referenced package
- Returns:
Assigned variable of the calling package. Empty string if there is not any variable assigned.
- Return type:
str
- GetPackageReturns()¶
Retrieves all return variable assignments.
- Returns:
Dictionary of <return variable name of the referenced package, variable name of the calling package> items
- Return type:
dict[str, 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:
- GetPath()¶
Returns the path of the package referenced in the package mapping item used for this package call. For local packages and packages in referenced library workspaces this path has ‘<namespace.packages>’ notation. For generic package calls this path is ‘PACKAGE’. Any other calls are regarded to be external - the absolute package path is returned.
- Returns:
Target path of the package to be called. None if there is no path to a referenced package.
- Return type:
str
- Raises:
ApiError – If there is no local package mapping in the package
- GetReferencedPackage()¶
Returns the referenced package. If the path contains global constants, their current values are used.
- Returns:
The referenced package. None if there is no path to a referenced package.
- Return type:
- Raises:
ApiError – If the referenced package does not exist.
- GetReferencedPackageMappingName()¶
Returns the reference name of the package mapping item used by this test step. For the mapping items used by the called package, see
GetMappingNames().- Returns:
Reference name of the used mapping item.
- Return type:
str
- GetReportDisablingResults()¶
Returns all results for which 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
- 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
- IsReportingDisabled()¶
Returns whether reporting of this test step is disabled.
- Returns:
True if reporting is disabled
- 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
- 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.
- SetInboxBindings(bindings)¶
Sets the inbox bindings for this parallel package call. The keys of the bindings dict are the inboxes of the called package, the values are the outboxes of the calling package.
- Parameters:
- bindings : dict[str, str]¶
dict with items of the form (calleeInbox: callerOutbox)
- SetOutboxBindings(bindings)¶
Sets the outbox bindings for this parallel package call. The keys of the bindings dict are the outboxes of the called package, the values are the inboxes of the calling package.
- Parameters:
- bindings : dict[str, str]¶
dict with items of the form (calleeOutbox: callerInbox)
- SetPackageParameter(paramName, paramValue)¶
Assigns a value to a package parameter. If there is no parameter with the given name yet, an additional entry is added.
- SetPackageParameters(paramDict)¶
Replaces all package parameters by the given paramDict.
- Parameters:
- paramDict : dict[str, str]¶
Dictionary of <parameter name, expression> items
- SetPackageReturn(varInternal, varExternal)¶
Assigns a variable name of the calling package to a return variable name of the referenced package.
- SetPackageReturns(returnDict)¶
Replaces package returns by the given returnDict.
- Parameters:
- returnDict : dict[str, str]¶
Dictionary of <return variable name of the referenced package, variable name of the calling package> items
- SetTags(tags)¶
Set the list of tags for this step. The list of tags will be sorted and stored.
- Parameters:
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.
- UnsetPackageReturn(varInternal)¶
Removes an assignment of a variable name of the calling package to a return variable name of the referenced package.
- Parameters:
- varInternal : str¶
Return variable name of the referenced package