Report¶
- class Report¶
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:
- Close()¶
Closes the report. After closing the report it can not be modified/accessed anymore.
- GetArtifacts()¶
Returns all artifacts that are referenced by any package in the report.
- Returns:
A list of all artifacts.
- Return type:
list[
Artifact]
- GetAuthor()¶
Returns the test author.
- Returns:
Test author
- Return type:
str
- GetDuration()¶
Returns the duration of the test execution.
- Returns:
Execution duration in seconds
- Return type:
float
- GetExecutionTime()¶
Returns the test execution date and time as string representation.
- Returns:
Test execution date and time
- Return type:
str
- GetKeywordCatalog()¶
Returns the name of the keyword catalog used during test execution.
- Returns:
The catalog name or an empty string if no catalog was present at test execution.
- Return type:
str
- GetMainProject()¶
Returns the main project. Raises an ApiError if the report is not the result of a project execution.
- Returns:
List of direct project sub components
- Return type:
- GetProjectExecutionPath()¶
Returns the execution path in relation to the calling project if executed as separate subproject or the name of the project, if not not executed separately.
- Returns:
Path in the project execution stack
- Return type:
str
- GetProjectName()¶
Returns the name of the root project if it is a project report, otherwise empty string.
- Returns:
Name of the project
- Return type:
str
- GetResult()¶
Returns the total test result.
- Returns:
Total test result
- Return type:
str
- GetTestManagementId()¶
Returns the corresponding test management ID of the root level project.
- Returns:
Test management ID or an empty string if no ID defined. If no project was executed None will be returned.
- Return type:
str
- GetTeststand()¶
Returns the computer name where the test was executed.
- Returns:
Name of the computer
- Return type:
str
- GetTimeZoneUTCOffset()¶
Returns the offset from UTC in seconds based on the time zone in which the test report was generated. If no time zone is set in the report, None will be returned.
- Returns:
Offset from UTC in seconds, or None
- Return type:
int
- GetTopLevelPackages()¶
Convenience method for the test management synchronization.
On a package report one package report will be returned. On a project report all package reports will be returned in a flat list regardless of directories. Packages of subprojects will be ignored.
- Returns:
List of package objects
- Return type:
list[
ReportPackage]
- GetVersion()¶
Returns the ecu.test Version which created this report.
- Returns:
Version of ecu.test
- Return type:
str
- IsProjectReport()¶
Checks if the report is from a project execution or not.
- Returns:
True if the report is the result of a project execution, otherwise False
- Return type:
bool