| Andrea Frittoli (andreaf) | e07579c | 2016-08-05 07:27:02 +0100 | [diff] [blame] | 1 | .. _clients: |
| 2 | |
| 3 | Service Clients Usage |
| 4 | ===================== |
| 5 | |
| 6 | Tests make requests against APIs using service clients. Service clients are |
| 7 | specializations of the ``RestClient`` class. The service clients that cover the |
| 8 | APIs exposed by a service should be grouped in a service clients module. |
| Martin Kopec | d76178e | 2024-01-16 20:43:56 +0100 | [diff] [blame] | 9 | A service clients module is a Python module where all service clients are |
| Andrea Frittoli (andreaf) | e07579c | 2016-08-05 07:27:02 +0100 | [diff] [blame] | 10 | defined. If major API versions are available, submodules should be defined, |
| 11 | one for each version. |
| 12 | |
| Martin Kopec | d76178e | 2024-01-16 20:43:56 +0100 | [diff] [blame] | 13 | The ``ClientsFactory`` class helps to initialize all clients of a specific |
| Andrea Frittoli (andreaf) | e07579c | 2016-08-05 07:27:02 +0100 | [diff] [blame] | 14 | service client module from a set of shared parameters. |
| 15 | |
| 16 | The ``ServiceClients`` class provides a convenient way to get access to all |
| 17 | available service clients initialized with a provided set of credentials. |
| 18 | |
| Ken'ichi Ohmichi | aca816d | 2017-01-27 15:12:17 -0800 | [diff] [blame] | 19 | ----------------------------- |
| 20 | The clients management module |
| 21 | ----------------------------- |
| Andrea Frittoli (andreaf) | e07579c | 2016-08-05 07:27:02 +0100 | [diff] [blame] | 22 | |
| 23 | .. automodule:: tempest.lib.services.clients |
| 24 | :members: |
| Ken'ichi Ohmichi | aca816d | 2017-01-27 15:12:17 -0800 | [diff] [blame] | 25 | |
| 26 | ------------------------------ |
| 27 | Compute service client modules |
| 28 | ------------------------------ |
| 29 | |
| 30 | .. toctree:: |
| 31 | :maxdepth: 2 |
| 32 | |
| 33 | service_clients/compute_clients |