tempest/doc/source/library/clients.rst
Andrea Frittoli (andreaf) e07579c603 Migrate service_clients to tempest.lib
Migrate the service_clients module to tempest.lib.services.clients.
Migrate related unit tests as well.

The clients module atm imports plugin.py from Tempest which is not
allowed via hacking to avoid cirtular dependencies.
If there is no way around this, I will have to remove the self
registration of the service clients from plugins, and ask the
plugins to do the registration themselves - which is a pity. Ideas?

Change-Id: I40e3478f69af62a7cdc14fa65ed21dcfbbe10e72
2016-08-05 16:23:26 +01:00

856 B

Service Clients Usage

Tests make requests against APIs using service clients. Service clients are specializations of the RestClient class. The service clients that cover the APIs exposed by a service should be grouped in a service clients module. A service clients module is python module where all service clients are defined. If major API versions are available, submodules should be defined, one for each version.

The ClientsFactory class helps initializing all clients of a specific service client module from a set of shared parameters.

The ServiceClients class provides a convenient way to get access to all available service clients initialized with a provided set of credentials.

The clients module

tempest.lib.services.clients