scenario package¶

scenario package definition.

Package information¶

info¶

Alias of PKG_INFO.

Gives the package information: version, …

Base classes¶

Classes to inherit from in order to describe test scenarios and libraries.

Scenario¶

Alias of ScenarioDefinition.

Base class to inherit from in order to define a test scenario.

Step¶

Alias of StepDefinition.

Base class to inherit from in order to define a test step.

ActionResult¶: Alias of ActionResultDefinition.

Assertions¶

Make verifications on data.

Assertions¶

Alias of Assertions.

Library of static assertion methods.

Can be sub-classes. Scenario and Step inherit from this class.

assertionhelpers¶

Alias of assertionhelpers.

Helper functions and types when you want to write your own assertion routines.

Logging¶

Logging management.

Logger¶

Alias of Logger.

Object with logging capabilities.

Scenario and Step inherit from this class.

logging¶: Main logger instance.

Console¶

Alias of Console.

Console colors.

LogExtraData¶

Alias of LogExtraData.

Logging extra data management.

debug¶

Alias of debugutils.

Helper functions and types for debugging.

Configuration¶

Configuration management.

conf¶: Configuration manager instance.

ConfigNode¶: Alias of ConfigNode.

ConfigKey¶

Alias of ScenarioConfig.Key.

scenario configuration keys.

Launchers¶

Classes to launch the test scenarios and campaigns from custom launcher scripts.

runner¶

Scenario runner instance.

Call from your own scenario launcher script with:

scenario.runner.main()

campaign_runner¶

Campaign runner instance.

Call from your own campaign launcher script with:

scenario.campaign_runner.main()

Args¶

Alias of Args.

Base class for ScenarioArgs and CampaignArgs.

ScenarioArgs¶

Alias of ScenarioArgs.

Inherit from this class in order to extend ScenarioRunner arguments with your own launcher script ones.

CampaignArgs¶

Alias of CampaignArgs.

Inherit from this class in order to extend CampaignRunner arguments with your own launcher script ones.

ErrorCode¶

Alias of ErrorCode.

Error codes returned by the main() methods of ScenarioRunner and CampaignRunner.

Handlers (advanced)¶

Add reactive code.

handlers¶: Handler manager instance.

Event¶: Alias of ScenarioEvent.

EventData¶: Alias of ScenarioEventData.

Execution result classes (advanced)¶

Sometimes, you may need to access information about the test execution itself.

ExecutionStatus¶

Alias of ExecutionStatus.

Describes the final status of a scenario or campaign execution.

ScenarioExecution¶: Alias of ScenarioExecution.

StepExecution¶: Alias of StepExecution.

ActionResultExecution¶: Alias of ActionResultExecution.

TestError¶

Alias of TestError.

Describes an error that occurred during the tests.

ExceptionError¶

Alias of ExceptionError.

Describes an error due to an exception that occurred during the tests.

KnownIssue¶

Alias of KnownIssue.

Describes an error due to an exception that occurred during the tests.

IssueLevel¶

Alias of IssueLevel.

Provides methods to define named issue levels.

TimeStats¶

Alias of TimeStats.

Describes execution time statistics.

ExecTotalStats¶

Alias of ExecTotalStats.

Describes count statistics: number of items executed, out of the total number of items.

stack¶: Scenario stack instance.

Reports (advanced)¶

The following objects give you the opportunity to read and write scenario and campaign reports.

report¶: Scenario report manager.

campaign_report¶: Campaign report manager.

Miscellaneous¶

Path¶: Alias of Path.

AnyPathType¶: Alias of path.AnyPathType.

SubProcess¶

Alias of SubProcess.

Eases the way to prepare a sub-process, execute it, and then retrieve its results.

VarSubProcessType¶: Alias of subprocess.VarSubProcessType.

CodeLocation¶: Alias of CodeLocation.

datetime¶

Alias of datetimeutils.

Date/time utils.

tz¶

Alias of timezoneutils.

Timezone utils.

enum¶

Alias of enumutils.

Enum utils.