cafe.engine package

cafe.engine.behaviors module

class cafe.engine.behaviors.BaseBehavior[source]

Bases: object

exception cafe.engine.behaviors.RequiredClientNotDefinedError[source]

Bases: exceptions.Exception

Raised when a behavior method call can’t find a required client

cafe.engine.behaviors.behavior(*required_clients)[source]

Decorator that tags method as a behavior, and optionally adds required client objects to an internal attribute. Causes calls to this method to throw RequiredClientNotDefinedError exception if the containing class does not have the proper client instances defined.

cafe.engine.config module

class cafe.engine.config.EngineConfig(config_file_path=None)[source]

Bases: cafe.engine.models.data_interfaces.ConfigSectionInterface

SECTION_NAME = 'OPENCAFE_ENGINE'
config_directory

Provided as the default location for test config files.

data_directory

Provided as the default location for data required by tests.

default_test_repo

Provided as the default name of the python package containing tests to be run. This package must be in your python path under the name provided here.

log_directory

Provided as the default location for logs. It is recommended that the default log directory be used as a root directory for subdirectories of logs.

logging_verbosity

Used by the engine to determine which loggers to add handlers to by default

master_log_file_name

Used by the engine logger as the default name for the file written to by the handler on the root python log (since the root python logger doesn’t have a name by default).

temp_directory

Provided as the default location for temp files and other temporary output generated by tests (not for logs).

cafe.engine.provider module

class cafe.engine.provider.BaseProvider[source]

Bases: object