Github   Telegram
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
pytest_userver.client.Client Class Reference

Asyncio userver client, typically retrieved from plugins.service_client.service_client fixture. More...

+ Inheritance diagram for pytest_userver.client.Client:
+ Collaboration diagram for pytest_userver.client.Client:

Public Member Functions

def 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)
 
None read_cache_dumps (self, typing.List[str] names)
 
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. More...
 
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. More...
 
typing.List[str] list_tasks (self)
 
def spawn_task (self, str name)
 
def capture_logs (self)
 
None invalidate_caches (self, *bool clean_update=True, typing.Optional[typing.List[str]] cache_names=None)
 Send request to service to update caches. More...
 
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': More...
 
None enable_testpoints (self, *args, **kwargs)
 Send list of handled testpoint pats to service. More...
 
- Public Member Functions inherited from pytest_userver.client.ClientWrapper
def __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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
http.ClientResponse request (self, str http_method, str path, **kwargs)
 Make a HTTP request with the specified method. More...
 

Static Public Attributes

 PeriodicTaskFailed = PeriodicTaskFailed
 
 TestsuiteActionFailed = TestsuiteActionFailed
 
 TestsuiteTaskNotFound = TestsuiteTaskNotFound
 
 TestsuiteTaskConflict = TestsuiteTaskConflict
 
 TestsuiteTaskFailed = TestsuiteTaskFailed
 

Detailed Description

Asyncio userver client, typically retrieved from plugins.service_client.service_client fixture.

Compatible with werkzeug interface.

Definition at line 737 of file client.py.

Member Function Documentation

◆ capture_logs()

def pytest_userver.client.Client.capture_logs (   self)

Definition at line 814 of file client.py.

◆ enable_testpoints()

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.

Parameters
no_auto_cache_cleanupprevent 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.

Definition at line 855 of file client.py.

◆ invalidate_caches()

None pytest_userver.client.Client.invalidate_caches (   self,
*bool   clean_update = True,
typing.Optional[typing.List[str]]   cache_names = None 
)

Send request to service to update caches.

Parameters
clean_updateif False, service will do a faster incremental update of caches whenever possible.
cache_nameswhich caches specifically should be updated; update all if None.

Definition at line 818 of file client.py.

◆ list_tasks()

typing.List[str] pytest_userver.client.Client.list_tasks (   self)

Definition at line 808 of file client.py.

◆ metrics_portability()

typing.Dict[str, typing.List[typing.Dict[str, str]]] pytest_userver.client.Client.metrics_portability (   self,
*typing.Optional[str]   prefix = None 
)

Reports metrics related issues that could be encountered on different monitoring systems.

See also
utils::statistics::GetPortabilityInfo

Definition at line 797 of file client.py.

◆ read_cache_dumps()

None pytest_userver.client.Client.read_cache_dumps (   self,
typing.List[str]  names 
)

Definition at line 782 of file client.py.

◆ reset_metrics()

None pytest_userver.client.Client.reset_metrics (   self)

Calls ResetMetric(metric); for each metric that has such C++ function.

Definition at line 791 of file client.py.

◆ resume_all_periodic_tasks()

None pytest_userver.client.Client.resume_all_periodic_tasks (   self)

Definition at line 774 of file client.py.

◆ resume_periodic_tasks()

None pytest_userver.client.Client.resume_periodic_tasks (   self,
typing.List[str]  names 
)

Definition at line 770 of file client.py.

◆ run_distlock_task()

None pytest_userver.client.Client.run_distlock_task (   self,
str  name 
)

Definition at line 788 of file client.py.

◆ run_periodic_task()

def pytest_userver.client.Client.run_periodic_task (   self,
  name 
)

Definition at line 762 of file client.py.

◆ run_task()

None pytest_userver.client.Client.run_task (   self,
str  name 
)

Definition at line 785 of file client.py.

◆ spawn_task()

def pytest_userver.client.Client.spawn_task (   self,
str  name 
)

Definition at line 811 of file client.py.

◆ suspend_periodic_tasks()

None pytest_userver.client.Client.suspend_periodic_tasks (   self,
typing.List[str]  names 
)

Definition at line 766 of file client.py.

◆ tests_control()

typing.Dict[str, typing.Any] pytest_userver.client.Client.tests_control (   self,
args,
**  kwargs 
)

Definition at line 837 of file client.py.

◆ update_server_state()

None pytest_userver.client.Client.update_server_state (   self)

Update service-side state through http call to 'tests/control':

  • clear dirty (from other tests) caches
  • set service-side mocked time,
  • resume / suspend periodic tasks
  • enable testpoints If service is up-to-date, does nothing.

Definition at line 843 of file client.py.

◆ write_cache_dumps()

None pytest_userver.client.Client.write_cache_dumps (   self,
typing.List[str]  names 
)

Definition at line 778 of file client.py.

Member Data Documentation

◆ PeriodicTaskFailed

pytest_userver.client.Client.PeriodicTaskFailed = PeriodicTaskFailed
static

Definition at line 748 of file client.py.

◆ TestsuiteActionFailed

pytest_userver.client.Client.TestsuiteActionFailed = TestsuiteActionFailed
static

Definition at line 749 of file client.py.

◆ TestsuiteTaskConflict

pytest_userver.client.Client.TestsuiteTaskConflict = TestsuiteTaskConflict
static

Definition at line 751 of file client.py.

◆ TestsuiteTaskFailed

pytest_userver.client.Client.TestsuiteTaskFailed = TestsuiteTaskFailed
static

Definition at line 752 of file client.py.

◆ TestsuiteTaskNotFound

pytest_userver.client.Client.TestsuiteTaskNotFound = TestsuiteTaskNotFound
static

Definition at line 750 of file client.py.


The documentation for this class was generated from the following file: