⚠️ This is the documentation for an old userver version. Click here to switch to the latest version.
Asyncio userver client, typically retrieved from plugins.service_client.service_client fixture.
Compatible with werkzeug interface.
Inheritance diagram for pytest_userver.client.Client: Collaboration diagram for pytest_userver.client.Client:Public Member Functions | |
| run_periodic_task (self, name) | |
| None | suspend_periodic_tasks (self, typing.List[str] names) |
| None | resume_periodic_tasks (self, typing.List[str] names) |
| None | resume_all_periodic_tasks (self) |
| None | write_cache_dumps (self, typing.List[str] names, *testsuite_skip_prepare=False) |
| None | read_cache_dumps (self, typing.List[str] names, *testsuite_skip_prepare=False) |
| None | run_task (self, str name) |
| None | run_distlock_task (self, str name) |
| None | reset_metrics (self) |
Calls ResetMetric(metric); for each metric that has such C++ function. | |
| typing.Dict[str, typing.List[typing.Dict[str, str]]] | metrics_portability (self, *typing.Optional[str] prefix=None) |
| Reports metrics related issues that could be encountered on different monitoring systems. | |
| typing.List[str] | list_tasks (self) |
| spawn_task (self, str name) | |
| capture_logs (self, *str log_level='DEBUG', bool testsuite_skip_prepare=False) | |
| Captures logs from the service. | |
| log_flush (self, typing.Optional[str] logger_name=None) | |
| Flush service logs. | |
| None | invalidate_caches (self, *bool clean_update=True, typing.Optional[typing.List[str]] cache_names=None, bool testsuite_skip_prepare=False) |
| Send request to service to update caches. | |
| typing.Dict[str, typing.Any] | tests_control (self, *args, **kwargs) |
| None | update_server_state (self) |
| Update service-side state through http call to 'tests/control': | |
| None | enable_testpoints (self, *args, **kwargs) |
| Send list of handled testpoint pats to service. | |
| typing.Dict[str, typing.Any] | get_dynamic_config_defaults (self) |
| Public Member Functions inherited from pytest_userver.client.ClientWrapper | |
| __init__ (self, client) | |
| http.ClientResponse | post (self, str path, annotations.JsonAnyOptional json=None, typing.Any data=None, typing.Optional[typing.Dict[str, str]] params=None, typing.Optional[str] bearer=None, typing.Optional[str] x_real_ip=None, typing.Optional[typing.Dict[str, str]] headers=None, **kwargs) |
| Make a HTTP POST request. | |
| http.ClientResponse | put (self, path, annotations.JsonAnyOptional json=None, typing.Any data=None, typing.Optional[typing.Dict[str, str]] params=None, typing.Optional[str] bearer=None, typing.Optional[str] x_real_ip=None, typing.Optional[typing.Dict[str, str]] headers=None, **kwargs) |
| Make a HTTP PUT request. | |
| http.ClientResponse | patch (self, path, annotations.JsonAnyOptional json=None, typing.Any data=None, typing.Optional[typing.Dict[str, str]] params=None, typing.Optional[str] bearer=None, typing.Optional[str] x_real_ip=None, typing.Optional[typing.Dict[str, str]] headers=None, **kwargs) |
| Make a HTTP PATCH request. | |
| http.ClientResponse | get (self, str path, typing.Optional[typing.Dict[str, str]] headers=None, typing.Optional[str] bearer=None, typing.Optional[str] x_real_ip=None, **kwargs) |
| Make a HTTP GET request. | |
| http.ClientResponse | delete (self, str path, typing.Optional[typing.Dict[str, str]] headers=None, typing.Optional[str] bearer=None, typing.Optional[str] x_real_ip=None, **kwargs) |
| Make a HTTP DELETE request. | |
| http.ClientResponse | options (self, str path, typing.Optional[typing.Dict[str, str]] headers=None, typing.Optional[str] bearer=None, typing.Optional[str] x_real_ip=None, **kwargs) |
| Make a HTTP OPTIONS request. | |
| http.ClientResponse | request (self, str http_method, str path, **kwargs) |
| Make a HTTP request with the specified method. | |
Protected Member Functions | |
| typing.Awaitable[http.ClientResponse] | _wrap_client_response (self, aiohttp.ClientResponse response) |
Additional Inherited Members | |
| Protected Attributes inherited from pytest_userver.client.ClientWrapper | |
| _client | |
|
protected |
Reimplemented from pytest_userver.client.ClientWrapper.
| pytest_userver.client.Client.capture_logs | ( | self, | |
| *str | log_level = 'DEBUG', | ||
| bool | testsuite_skip_prepare = False ) |
Captures logs from the service.
| log_level | Do not capture logs below this level. |
| None pytest_userver.client.Client.enable_testpoints | ( | self, | |
| * | args, | ||
| ** | kwargs ) |
Send list of handled testpoint pats to service.
For these paths service will no more skip http calls from TESTPOINT(...) macro.
| no_auto_cache_cleanup | prevent automatic cache cleanup. When calling service client first time in scope of current test, client makes additional http call to tests/control to update caches, to get rid of data from previous test. |
| typing.Dict[str, typing.Any] pytest_userver.client.Client.get_dynamic_config_defaults | ( | self | ) |
| None pytest_userver.client.Client.invalidate_caches | ( | self, | |
| *bool | clean_update = True, | ||
| typing.Optional[typing.List[str]] | cache_names = None, | ||
| bool | testsuite_skip_prepare = False ) |
Send request to service to update caches.
| clean_update | if False, service will do a faster incremental update of caches whenever possible. |
| cache_names | which caches specifically should be updated; update all if None. |
| testsuite_skip_prepare | if False, service will automatically do update_server_state(). |
| typing.List[str] pytest_userver.client.Client.list_tasks | ( | self | ) |
| pytest_userver.client.Client.log_flush | ( | self, | |
| typing.Optional[str] | logger_name = None ) |
| typing.Dict[str, typing.List[typing.Dict[str, str]]] pytest_userver.client.Client.metrics_portability | ( | self, | |
| *typing.Optional[str] | prefix = None ) |
| None pytest_userver.client.Client.read_cache_dumps | ( | self, | |
| typing.List[str] | names, | ||
| * | testsuite_skip_prepare = False ) |
| None pytest_userver.client.Client.reset_metrics | ( | self | ) |
| None pytest_userver.client.Client.resume_all_periodic_tasks | ( | self | ) |
| None pytest_userver.client.Client.resume_periodic_tasks | ( | self, | |
| typing.List[str] | names ) |
| None pytest_userver.client.Client.run_distlock_task | ( | self, | |
| str | name ) |
| pytest_userver.client.Client.run_periodic_task | ( | self, | |
| name ) |
| None pytest_userver.client.Client.run_task | ( | self, | |
| str | name ) |
| pytest_userver.client.Client.spawn_task | ( | self, | |
| str | name ) |
| None pytest_userver.client.Client.suspend_periodic_tasks | ( | self, | |
| typing.List[str] | names ) |
| typing.Dict[str, typing.Any] pytest_userver.client.Client.tests_control | ( | self, | |
| * | args, | ||
| ** | kwargs ) |
| None pytest_userver.client.Client.update_server_state | ( | self | ) |
| None pytest_userver.client.Client.write_cache_dumps | ( | self, | |
| typing.List[str] | names, | ||
| * | testsuite_skip_prepare = False ) |
|
static |
|
static |
|
static |
|
static |
|
static |
