client.py

"""
Python module that provides clients for functional tests with
testsuite; see
@ref scripts/docs/en/userver/functional_testing.md for an introduction.
 
@ingroup userver_testsuite
"""
 
# pylint: disable=too-many-lines
 
from __future__ import annotations
 
from collections.abc import Awaitable
from collections.abc import Iterator
import contextlib
import copy
import dataclasses
import json
import logging
import typing
from typing import Any
from typing import TypeAlias
import warnings
 
import aiohttp
 
from testsuite import logcapture
from testsuite import utils
from testsuite.daemons import service_client
from testsuite.utils import approx
from testsuite.utils import http
 
from pytest_userver import userver_warnings
import pytest_userver.metrics  # pylint: disable=import-error
from pytest_userver.plugins import caches
 
# @cond
logger = logging.getLogger(__name__)
# @endcond
 
JsonAny: TypeAlias = int | float | str | list | dict
JsonAnyOptional: TypeAlias = JsonAny | None
 
_UNKNOWN_STATE = '__UNKNOWN__'
 
CACHE_INVALIDATION_MESSAGE = (
    'Direct cache invalidation is deprecated.\n'
    '\n'
    ' - Use client.update_server_state() to synchronize service state\n'
    ' - Explicitly pass cache names to invalidate, e.g.: '
    'invalidate_caches(cache_names=[...]).'
)
 
 
class BaseError(Exception):
    """Base class for exceptions of this module."""
 
 
class TestsuiteActionFailed(BaseError):
    pass
 
 
class TestsuiteTaskError(BaseError):
    pass
 
 
class TestsuiteTaskNotFound(TestsuiteTaskError):
    pass
 
 
class TestsuiteTaskConflict(TestsuiteTaskError):
    pass
 
 
class ConfigurationError(BaseError):
    pass
 
 
class PeriodicTaskFailed(BaseError):
    pass
 
 
class PeriodicTasksState:
    def __init__(self) -> None:
        self.suspended_tasks: set[str] = set()
        self.tasks_to_suspend: set[str] = set()
 
 
class TestsuiteTaskFailed(TestsuiteTaskError):
    def __init__(self, name, reason):
        self.name = name
        self.reason = reason
        super().__init__(f'Testsuite task {name!r} failed: {reason}')
 
 
@dataclasses.dataclass(frozen=True)
class TestsuiteClientConfig:
    testsuite_action_path: str | None = None
    server_monitor_path: str | None = None
 
 
Metric: TypeAlias = pytest_userver.metrics.Metric
 
 
class ClientWrapper:
    """
    Base asyncio userver client that implements HTTP requests to service.
 
    Compatible with werkzeug interface.
 
    @ingroup userver_testsuite
    """
 
    def __init__(self, client):
        self._client = client
 
    async def post(
        self,
        path: str,
        # pylint: disable=redefined-outer-name
        json: JsonAnyOptional = None,
        data: Any = None,
        params: dict[str, str] | None = None,
        bearer: str | None = None,
        x_real_ip: str | None = None,
        headers: dict[str, str] | None = None,
        **kwargs,
    ) -> http.ClientResponse:
        """
        Make a HTTP POST request
        """
        response = await self._client.post(
            path,
            json=json,
            data=data,
            params=params,
            headers=headers,
            bearer=bearer,
            x_real_ip=x_real_ip,
            **kwargs,
        )
        return await self._wrap_client_response(response)
 
    async def put(
        self,
        path,
        # pylint: disable=redefined-outer-name
        json: JsonAnyOptional = None,
        data: Any = None,
        params: dict[str, str] | None = None,
        bearer: str | None = None,
        x_real_ip: str | None = None,
        headers: dict[str, str] | None = None,
        **kwargs,
    ) -> http.ClientResponse:
        """
        Make a HTTP PUT request
        """
        response = await self._client.put(
            path,
            json=json,
            data=data,
            params=params,
            headers=headers,
            bearer=bearer,
            x_real_ip=x_real_ip,
            **kwargs,
        )
        return await self._wrap_client_response(response)
 
    async def patch(
        self,
        path,
        # pylint: disable=redefined-outer-name
        json: JsonAnyOptional = None,
        data: Any = None,
        params: dict[str, str] | None = None,
        bearer: str | None = None,
        x_real_ip: str | None = None,
        headers: dict[str, str] | None = None,
        **kwargs,
    ) -> http.ClientResponse:
        """
        Make a HTTP PATCH request
        """
        response = await self._client.patch(
            path,
            json=json,
            data=data,
            params=params,
            headers=headers,
            bearer=bearer,
            x_real_ip=x_real_ip,
            **kwargs,
        )
        return await self._wrap_client_response(response)
 
    async def get(
        self,
        path: str,
        headers: dict[str, str] | None = None,
        bearer: str | None = None,
        x_real_ip: str | None = None,
        **kwargs,
    ) -> http.ClientResponse:
        """
        Make a HTTP GET request
        """
        response = await self._client.get(
            path,
            headers=headers,
            bearer=bearer,
            x_real_ip=x_real_ip,
            **kwargs,
        )
        return await self._wrap_client_response(response)
 
    async def delete(
        self,
        path: str,
        headers: dict[str, str] | None = None,
        bearer: str | None = None,
        x_real_ip: str | None = None,
        **kwargs,
    ) -> http.ClientResponse:
        """
        Make a HTTP DELETE request
        """
        response = await self._client.delete(
            path,
            headers=headers,
            bearer=bearer,
            x_real_ip=x_real_ip,
            **kwargs,
        )
        return await self._wrap_client_response(response)
 
    async def options(
        self,
        path: str,
        headers: dict[str, str] | None = None,
        bearer: str | None = None,
        x_real_ip: str | None = None,
        **kwargs,
    ) -> http.ClientResponse:
        """
        Make a HTTP OPTIONS request
        """
        response = await self._client.options(
            path,
            headers=headers,
            bearer=bearer,
            x_real_ip=x_real_ip,
            **kwargs,
        )
        return await self._wrap_client_response(response)
 
    async def request(
        self,
        http_method: str,
        path: str,
        **kwargs,
    ) -> http.ClientResponse:
        """
        Make a HTTP request with the specified method
        """
        response = await self._client.request(http_method, path, **kwargs)
        return await self._wrap_client_response(response)
 
    @property
    def raw_aiohttp_client(self):
        """
        @deprecated Use pytest_userver.client.Client directly instead.
        """
        return self._client
 
    def _wrap_client_response(self, response: aiohttp.ClientResponse) -> Awaitable[http.ClientResponse]:
        return http.wrap_client_response(response)
 
 
# @cond
 
 
def _wrap_client_error(func):
    async def _wrapper(*args, **kwargs):
        try:
            return await func(*args, **kwargs)
        except aiohttp.client_exceptions.ClientResponseError as exc:
            raise http.HttpResponseError(
                url=exc.request_info.url,
                status=exc.status,
            )
 
    return _wrapper
 
 
class AiohttpClientMonitor(service_client.AiohttpClient):
    _config: TestsuiteClientConfig
 
    def __init__(self, base_url, *, config: TestsuiteClientConfig, **kwargs):
        super().__init__(base_url, **kwargs)
        self._config = config
 
    async def get_metrics(self, prefix=None):
        if not self._config.server_monitor_path:
            raise ConfigurationError(
                'handler-server-monitor component is not configured',
            )
        params = {'format': 'internal'}
        if prefix is not None:
            params['prefix'] = prefix
        response = await self.get(
            self._config.server_monitor_path,
            params=params,
        )
        async with response:
            response.raise_for_status()
            return await response.json(content_type=None)
 
    async def get_metric(self, metric_name):
        metrics = await self.get_metrics(metric_name)
        assert metric_name in metrics, (
            f'No metric with name {metric_name!r}. Use "single_metric" function instead of "get_metric"'
        )
        return metrics[metric_name]
 
    async def metrics_raw(
        self,
        output_format,
        *,
        path: str = None,
        prefix: str = None,
        labels: dict[str, str] | None = None,
    ) -> str:
        if not self._config.server_monitor_path:
            raise ConfigurationError(
                'handler-server-monitor component is not configured',
            )
 
        params = {'format': output_format}
        if prefix:
            params['prefix'] = prefix
 
        if path:
            params['path'] = path
 
        if labels:
            params['labels'] = json.dumps(labels)
 
        response = await self.get(
            self._config.server_monitor_path,
            params=params,
        )
        async with response:
            response.raise_for_status()
            return await response.text()
 
    async def metrics(
        self,
        *,
        path: str = None,
        prefix: str = None,
        labels: dict[str, str] | None = None,
    ) -> pytest_userver.metrics.MetricsSnapshot:
        response = await self.metrics_raw(
            output_format='json',
            path=path,
            prefix=prefix,
            labels=labels,
        )
        return pytest_userver.metrics.MetricsSnapshot.from_json(str(response))
 
    async def single_metric_optional(
        self,
        path: str,
        *,
        labels: dict[str, str] | None = None,
    ) -> pytest_userver.metrics.Metric | None:
        response = await self.metrics(path=path, labels=labels)
        metrics_list = response.get(path, [])
 
        assert len(metrics_list) <= 1, (f'More than one metric found for path {path} and labels {labels}: {response}',)
 
        if not metrics_list:
            return None
 
        return next(iter(metrics_list))
 
    async def single_metric(
        self,
        path: str,
        *,
        labels: dict[str, str] | None = None,
    ) -> pytest_userver.metrics.Metric:
        value = await self.single_metric_optional(path, labels=labels)
        assert value is not None, (f'No metric was found for path {path} and labels {labels}',)
        return value
 
 
# @endcond
 
 
class ClientMonitor(ClientWrapper):
    """
    Asyncio userver client for monitor listeners, typically retrieved from
    plugins.service_client.monitor_client fixture.
 
    Compatible with werkzeug interface.
 
    @ingroup userver_testsuite
    """
 
    def metrics_diff(
        self,
        *,
        path: str | None = None,
        prefix: str | None = None,
        labels: dict[str, str] | None = None,
        diff_gauge: bool = False,
    ) -> MetricsDiffer:
        """
        Creates a `MetricsDiffer` that fetches metrics using this client.
        It's recommended to use this method over `metrics` to make sure
        the tests don't affect each other.
 
        With `diff_gauge` off, only `RATE` metrics are differentiated.
        With `diff_gauge` on, `GAUGE` metrics are differentiated as well,
        which may lead to nonsensical results for those.
 
        @param path Optional full metric path
        @param prefix Optional prefix on which the metric paths should start
        @param labels Optional dictionary of labels that must be in the metric
        @param diff_gauge Whether to differentiate GAUGE metrics
 
        @snippet samples/testsuite-support/tests/test_metrics.py metrics diff
        """
        return MetricsDiffer(
            _client=self,
            _path=path,
            _prefix=prefix,
            _labels=labels,
            _diff_gauge=diff_gauge,
        )
 
    @_wrap_client_error
    async def metrics(
        self,
        *,
        path: str | None = None,
        prefix: str | None = None,
        labels: dict[str, str] | None = None,
    ) -> pytest_userver.metrics.MetricsSnapshot:
        """
        Returns a dict of metric names to Metric.
 
        @param path Optional full metric path
        @param prefix Optional prefix on which the metric paths should start
        @param labels Optional dictionary of labels that must be in the metric
 
        @snippet samples/testsuite-support/tests/test_metrics.py metrics metrics
        """
        return await self._client.metrics(
            path=path,
            prefix=prefix,
            labels=labels,
        )
 
    @_wrap_client_error
    async def single_metric_optional(
        self,
        path: str,
        *,
        labels: dict[str, str] | None = None,
    ) -> pytest_userver.metrics.Metric | None:
        """
        Either return a pytest_userver.metrics.Metric or None if there's no such metric.
 
        @param path Full metric path
        @param labels Optional dictionary of labels that must be in the metric
 
        @throws AssertionError if more than one metric returned
 
        @snippet samples/testsuite-support/tests/test_metrics.py metrics single_metric_optional
        """
        return await self._client.single_metric_optional(path, labels=labels)
 
    @_wrap_client_error
    async def single_metric(
        self,
        path: str,
        *,
        labels: dict[str, str] | None = None,
    ) -> pytest_userver.metrics.Metric | None:
        """
        Returns the pytest_userver.metrics.Metric.
 
        @param path Full metric path
        @param labels Optional dictionary of labels that must be in the metric
 
        @throws AssertionError if more than one metric or no metric found
 
        @snippet samples/testsuite-support/tests/test_metrics.py metrics single_metric
        """
        return await self._client.single_metric(path, labels=labels)
 
    @_wrap_client_error
    async def metrics_raw(
        self,
        output_format: str,
        *,
        path: str | None = None,
        prefix: str | None = None,
        labels: dict[str, str] | None = None,
    ) -> dict[str, pytest_userver.metrics.Metric]:
        """
        Low level function that returns metrics in a specific format.
        Use `metrics` and `single_metric` instead if possible.
 
        @param output_format pytest_userver.metrics.Metric output format. See
               @ref server::handlers::ServerMonitor for a list of supported formats.
        @param path Optional full metric path
        @param prefix Optional prefix on which the metric paths should start
        @param labels Optional dictionary of labels that must be in the metric
        """
        return await self._client.metrics_raw(
            output_format=output_format,
            path=path,
            prefix=prefix,
            labels=labels,
        )
 
    @_wrap_client_error
    async def get_metrics(self, prefix=None):
        """
        @deprecated Use metrics() or single_metric() instead
        """
        return await self._client.get_metrics(prefix=prefix)
 
    @_wrap_client_error
    async def get_metric(self, metric_name):
        """
        @deprecated Use metrics() or single_metric() instead
        """
        return await self._client.get_metric(metric_name)
 
    @_wrap_client_error
    async def fired_alerts(self):
        response = await self._client.get('/service/fired-alerts')
        assert response.status == 200
        return (await response.json())['alerts']
 
 
class MetricsDiffer:
    """
    A helper class for computing metric differences.
 
    @see ClientMonitor.metrics_diff
 
    Example with @ref pytest_userver.client.ClientMonitor.metrics_diff "await monitor_client.metrics_diff()":
    @snippet samples/testsuite-support/tests/test_metrics.py metrics diff
 
    @ingroup userver_testsuite
    """
 
    # @cond
    def __init__(
        self,
        _client: ClientMonitor,
        _path: str | None,
        _prefix: str | None,
        _labels: dict[str, str] | None,
        _diff_gauge: bool,
    ):
        self._client = _client
        self._path = _path
        self._prefix = _prefix
        self._labels = _labels
        self._diff_gauge = _diff_gauge
        self._baseline: pytest_userver.metrics.MetricsSnapshot | None = None
        self._current: pytest_userver.metrics.MetricsSnapshot | None = None
        self._diff: pytest_userver.metrics.MetricsSnapshot | None = None
 
    # @endcond
 
    @property
    def baseline(self) -> pytest_userver.metrics.MetricsSnapshot:
        assert self._baseline is not None
        return self._baseline
 
    @baseline.setter
    def baseline(self, value: pytest_userver.metrics.MetricsSnapshot) -> None:
        self._baseline = value
        if self._current is not None:
            self._diff = _subtract_metrics_snapshots(
                self._current,
                self._baseline,
                self._diff_gauge,
            )
 
    @property
    def current(self) -> pytest_userver.metrics.MetricsSnapshot:
        assert self._current is not None, 'Set self.current first'
        return self._current
 
    @current.setter
    def current(self, value: pytest_userver.metrics.MetricsSnapshot) -> None:
        self._current = value
        assert self._baseline is not None, 'Set self.baseline first'
        self._diff = _subtract_metrics_snapshots(
            self._current,
            self._baseline,
            self._diff_gauge,
        )
 
    @property
    def diff(self) -> pytest_userver.metrics.MetricsSnapshot:
        assert self._diff is not None, 'Set self.current first'
        return self._diff
 
    def value_at(
        self,
        subpath: str | None = None,
        add_labels: dict[str, str] | None = None,
        *,
        default: float | None = None,
    ) -> pytest_userver.metrics.MetricValue:
        """
        Returns a single metric value at the specified path, prepending
        the path provided at construction. If a dict of labels is provided,
        does en exact match of labels, prepending the labels provided at construction.
 
        @param subpath Suffix of the metric path; the path provided at construction is prepended
        @param add_labels Labels that the metric must have in addition to the labels provided at construction
        @param default An optional default value in case the metric is missing
        @throws AssertionError if not one metric by path
        """
        base_path = self._path or self._prefix
        if base_path and subpath:
            path = f'{base_path}.{subpath}'
        else:
            assert base_path or subpath, 'No path provided'
            path = base_path or subpath or ''
        labels: dict | None = None
        if self._labels is not None or add_labels is not None:
            labels = {**(self._labels or {}), **(add_labels or {})}
        return self.diff.value_at(path, labels, default=default)
 
    async def fetch(self) -> pytest_userver.metrics.MetricsSnapshot:
        """
        Fetches metric values from the service.
        """
        return await self._client.metrics(
            path=self._path,
            prefix=self._prefix,
            labels=self._labels,
        )
 
    async def __aenter__(self) -> MetricsDiffer:
        self._baseline = await self.fetch()
        self._current = None
        return self
 
    async def __aexit__(self, exc_type, exc, exc_tb) -> None:
        self.current = await self.fetch()
 
 
# @cond
 
 
def _subtract_metrics_snapshots(
    current: pytest_userver.metrics.MetricsSnapshot,
    initial: pytest_userver.metrics.MetricsSnapshot,
    diff_gauge: bool,
) -> pytest_userver.metrics.MetricsSnapshot:
    return pytest_userver.metrics.MetricsSnapshot({
        path: {_subtract_metrics(path, current_metric, initial, diff_gauge) for current_metric in current_group}
        for path, current_group in current.items()
    })
 
 
def _subtract_metrics(
    path: str,
    current_metric: pytest_userver.metrics.Metric,
    initial: pytest_userver.metrics.MetricsSnapshot,
    diff_gauge: bool,
) -> pytest_userver.metrics.Metric:
    initial_group = initial.get(path, None)
    if initial_group is None:
        return current_metric
    initial_metric = next(
        (x for x in initial_group if x.labels == current_metric.labels),
        None,
    )
    if initial_metric is None:
        return current_metric
 
    return pytest_userver.metrics.Metric(
        labels=current_metric.labels,
        value=_subtract_metric_values(
            current=current_metric,
            initial=initial_metric,
            diff_gauge=diff_gauge,
        ),
        _type=current_metric.type(),
    )
 
 
def _subtract_metric_values(
    current: pytest_userver.metrics.Metric,
    initial: pytest_userver.metrics.Metric,
    diff_gauge: bool,
) -> pytest_userver.metrics.MetricValue:
    assert current.type() is not pytest_userver.metrics.MetricType.UNSPECIFIED
    assert initial.type() is not pytest_userver.metrics.MetricType.UNSPECIFIED
    assert current.type() == initial.type()
 
    if isinstance(current.value, pytest_userver.metrics.Histogram):
        assert isinstance(initial.value, pytest_userver.metrics.Histogram)
        return _subtract_metric_values_hist(current=current, initial=initial)
    else:
        assert not isinstance(initial.value, pytest_userver.metrics.Histogram)
        return _subtract_metric_values_num(
            current=current,
            initial=initial,
            diff_gauge=diff_gauge,
        )
 
 
def _subtract_metric_values_num(
    current: pytest_userver.metrics.Metric,
    initial: pytest_userver.metrics.Metric,
    diff_gauge: bool,
) -> float:
    current_value = typing.cast(float, current.value)
    initial_value = typing.cast(float, initial.value)
    should_diff = (
        current.type() is pytest_userver.metrics.MetricType.RATE
        or initial.type() is pytest_userver.metrics.MetricType.RATE
        or diff_gauge
    )
    return current_value - initial_value if should_diff else current_value
 
 
def _subtract_metric_values_hist(
    current: pytest_userver.metrics.Metric,
    initial: pytest_userver.metrics.Metric,
) -> pytest_userver.metrics.Histogram:
    current_value = typing.cast(pytest_userver.metrics.Histogram, current.value)
    initial_value = typing.cast(pytest_userver.metrics.Histogram, initial.value)
    assert current_value.bounds == initial_value.bounds
    return pytest_userver.metrics.Histogram(
        bounds=current_value.bounds,
        buckets=[t[0] - t[1] for t in zip(current_value.buckets, initial_value.buckets, strict=True)],
        inf=current_value.inf - initial_value.inf,
    )
 
 
class AiohttpClient(service_client.AiohttpClient):
    PeriodicTaskFailed = PeriodicTaskFailed
    TestsuiteActionFailed = TestsuiteActionFailed
    TestsuiteTaskNotFound = TestsuiteTaskNotFound
    TestsuiteTaskConflict = TestsuiteTaskConflict
    TestsuiteTaskFailed = TestsuiteTaskFailed
 
    def __init__(
        self,
        base_url: str,
        *,
        config: TestsuiteClientConfig,
        mocked_time,
        log_capture_fixture: logcapture.CaptureServer,
        testpoint,
        testpoint_control,
        cache_invalidation_state,
        span_id_header=None,
        api_coverage_report=None,
        periodic_tasks_state: PeriodicTasksState | None = None,
        allow_all_caches_invalidation: bool = True,
        cache_control: caches.CacheControl | None = None,
        asyncexc_check=None,
        **kwargs,
    ):
        super().__init__(base_url, span_id_header=span_id_header, **kwargs)
        self._config = config
        self._periodic_tasks = periodic_tasks_state
        self._testpoint = testpoint
        self._log_capture_fixture = log_capture_fixture
        self._state_manager = _StateManager(
            mocked_time=mocked_time,
            testpoint=self._testpoint,
            testpoint_control=testpoint_control,
            invalidation_state=cache_invalidation_state,
            cache_control=cache_control,
        )
        self._api_coverage_report = api_coverage_report
        self._allow_all_caches_invalidation = allow_all_caches_invalidation
        self._asyncexc_check = asyncexc_check
 
    async def run_periodic(self, name) -> None:
        await self.run_task(f'periodic/{name}')
 
    async def run_periodic_task(self, name):
        warnings.warn(userver_warnings.WARN_PERIODIC_DEPRECATION, DeprecationWarning)
        response = await self._testsuite_action('run_periodic_task', name=name)
        if not response['status']:
            raise self.PeriodicTaskFailed(f'Periodic task {name} failed')
 
    async def suspend_periodic_tasks(self, names: list[str]) -> None:
        if not self._periodic_tasks:
            raise ConfigurationError('No periodic_tasks_state given')
        self._periodic_tasks.tasks_to_suspend.update(names)
        await self._suspend_periodic_tasks()
 
    async def resume_periodic_tasks(self, names: list[str]) -> None:
        warnings.warn(userver_warnings.WARN_PERIODIC_DEPRECATION, DeprecationWarning)
        if not self._periodic_tasks:
            raise ConfigurationError('No periodic_tasks_state given')
        self._periodic_tasks.tasks_to_suspend.difference_update(names)
        await self._suspend_periodic_tasks()
 
    async def resume_all_periodic_tasks(self) -> None:
        if not self._periodic_tasks:
            raise ConfigurationError('No periodic_tasks_state given')
        self._periodic_tasks.tasks_to_suspend.clear()
        await self._suspend_periodic_tasks()
 
    async def write_cache_dumps(
        self,
        names: list[str],
        *,
        testsuite_skip_prepare=False,
    ) -> None:
        await self._testsuite_action(
            'write_cache_dumps',
            names=names,
            testsuite_skip_prepare=testsuite_skip_prepare,
        )
 
    async def read_cache_dumps(
        self,
        names: list[str],
        *,
        testsuite_skip_prepare=False,
    ) -> None:
        await self._testsuite_action(
            'read_cache_dumps',
            names=names,
            testsuite_skip_prepare=testsuite_skip_prepare,
        )
 
    async def run_distlock_task(self, name: str) -> None:
        await self.run_task(f'distlock/{name}')
 
    async def reset_metrics(self) -> None:
        await self._testsuite_action('reset_metrics')
 
    async def metrics_portability(
        self,
        *,
        prefix: str | None = None,
    ) -> dict[str, list[dict[str, str]]]:
        return await self._testsuite_action(
            'metrics_portability',
            prefix=prefix,
        )
 
    async def list_tasks(self) -> list[str]:
        response = await self._do_testsuite_action('tasks_list')
        async with response:
            response.raise_for_status()
            body = await response.json(content_type=None)
            return body['tasks']
 
    async def run_task(self, name: str) -> None:
        response = await self._do_testsuite_action(
            'task_run',
            json={'name': name},
        )
        await _task_check_response(name, response)
 
    @contextlib.asynccontextmanager
    async def spawn_task(self, name: str):
        task_id = await self._task_spawn(name)
        try:
            yield
        finally:
            await self._task_stop_spawned(task_id)
 
    async def _task_spawn(self, name: str) -> str:
        response = await self._do_testsuite_action(
            'task_spawn',
            json={'name': name},
        )
        data = await _task_check_response(name, response)
        return data['task_id']
 
    async def _task_stop_spawned(self, task_id: str) -> None:
        response = await self._do_testsuite_action(
            'task_stop',
            json={'task_id': task_id},
        )
        await _task_check_response(task_id, response)
 
    async def http_allowed_urls_extra(
        self,
        http_allowed_urls_extra: list[str],
    ) -> None:
        await self._do_testsuite_action(
            'http_allowed_urls_extra',
            json={'allowed_urls_extra': http_allowed_urls_extra},
            testsuite_skip_prepare=True,
        )
 
    @contextlib.asynccontextmanager
    async def capture_logs(
        self,
        *,
        log_level: str = 'DEBUG',
        testsuite_skip_prepare: bool = False,
    ):
        async with self._log_capture_fixture.capture(
            log_level=logcapture.LogLevel.from_string(log_level),
        ) as capture:
            logger.debug('Starting logcapture')
            await self._testsuite_action(
                'log_capture',
                log_level=log_level,
                socket_logging_duplication=True,
                testsuite_skip_prepare=testsuite_skip_prepare,
            )
 
            try:
                await self._log_capture_fixture.wait_for_client()
                yield capture
            finally:
                await self._testsuite_action(
                    'log_capture',
                    log_level=self._log_capture_fixture.default_log_level.name,
                    socket_logging_duplication=False,
                    testsuite_skip_prepare=testsuite_skip_prepare,
                )
 
    async def log_flush(self, logger_name: str | None = None):
        await self._testsuite_action(
            'log_flush',
            logger_name=logger_name,
            testsuite_skip_prepare=True,
        )
 
    async def invalidate_caches(
        self,
        *,
        clean_update: bool = True,
        cache_names: list[str] | None = None,
        testsuite_skip_prepare: bool = False,
    ) -> None:
        if cache_names is None and clean_update:
            if self._allow_all_caches_invalidation:
                warnings.warn(CACHE_INVALIDATION_MESSAGE, DeprecationWarning, stacklevel=2)
            else:
                __tracebackhide__ = True
                raise RuntimeError(CACHE_INVALIDATION_MESSAGE)
 
        if testsuite_skip_prepare:
            await self._tests_control({
                'invalidate_caches': {
                    'update_type': ('full' if clean_update else 'incremental'),
                    **({'names': cache_names} if cache_names else {}),
                },
            })
        else:
            await self.tests_control(
                invalidate_caches=True,
                clean_update=clean_update,
                cache_names=cache_names,
            )
 
    async def tests_control(
        self,
        *,
        invalidate_caches: bool = True,
        clean_update: bool = True,
        cache_names: list[str] | None = None,
        http_allowed_urls_extra: list[str] | None = None,
    ) -> dict[str, Any]:
        body: dict[str, Any] = self._state_manager.get_pending_update()
 
        if 'invalidate_caches' in body and invalidate_caches:
            if not clean_update or cache_names:
                logger.warning(
                    'Manual cache invalidation leads to indirect initial full cache invalidation',
                )
                await self._prepare()
                body = {}
 
        if invalidate_caches:
            body['invalidate_caches'] = {
                'update_type': ('full' if clean_update else 'incremental'),
            }
            if cache_names:
                body['invalidate_caches']['names'] = cache_names
 
        if http_allowed_urls_extra is not None:
            await self.http_allowed_urls_extra(http_allowed_urls_extra)
 
        return await self._tests_control(body)
 
    async def update_server_state(self) -> None:
        await self._prepare()
 
    async def enable_testpoints(self, *, no_auto_cache_cleanup=False) -> None:
        if not self._testpoint:
            return
        if no_auto_cache_cleanup:
            await self._tests_control({
                'testpoints': sorted(self._testpoint.keys()),
            })
        else:
            await self.update_server_state()
 
    async def get_dynamic_config_defaults(
        self,
    ) -> dict[str, Any]:
        return await self._testsuite_action(
            'get_dynamic_config_defaults',
            testsuite_skip_prepare=True,
        )
 
    async def _tests_control(self, body: dict) -> dict[str, Any]:
        with self._state_manager.updating_state(body):
            async with await self._do_testsuite_action(
                'control',
                json=body,
                testsuite_skip_prepare=True,
            ) as response:
                if response.status == 404:
                    raise ConfigurationError(
                        'It seems that testsuite support is not enabled for your service',
                    )
                response.raise_for_status()
                return await response.json(content_type=None)
 
    async def _suspend_periodic_tasks(self):
        if self._periodic_tasks.tasks_to_suspend != self._periodic_tasks.suspended_tasks:
            await self._testsuite_action(
                'suspend_periodic_tasks',
                names=sorted(self._periodic_tasks.tasks_to_suspend),
            )
            self._periodic_tasks.suspended_tasks = set(
                self._periodic_tasks.tasks_to_suspend,
            )
 
    def _do_testsuite_action(self, action, **kwargs):
        if not self._config.testsuite_action_path:
            raise ConfigurationError(
                'tests-control component is not properly configured',
            )
        path = self._config.testsuite_action_path.format(action=action)
        return self.post(path, **kwargs)
 
    async def _testsuite_action(
        self,
        action,
        *,
        testsuite_skip_prepare=False,
        **kwargs,
    ):
        async with await self._do_testsuite_action(
            action,
            json=kwargs,
            testsuite_skip_prepare=testsuite_skip_prepare,
        ) as response:
            if response.status == 500:
                raise TestsuiteActionFailed
            response.raise_for_status()
            return await response.json(content_type=None)
 
    async def _prepare(self) -> None:
        with self._state_manager.cache_control_update() as pending_update:
            if pending_update:
                await self._tests_control(pending_update)
 
    async def _request(  # pylint: disable=arguments-differ
        self,
        http_method: str,
        path: str,
        headers: dict[str, str] | None = None,
        bearer: str | None = None,
        x_real_ip: str | None = None,
        *,
        testsuite_skip_prepare: bool = False,
        **kwargs,
    ) -> aiohttp.ClientResponse:
        if self._asyncexc_check:
            # Check for pending background exceptions before call.
            self._asyncexc_check()
 
        if not testsuite_skip_prepare:
            await self._prepare()
 
        response = await super()._request(
            http_method,
            path,
            headers,
            bearer,
            x_real_ip,
            **kwargs,
        )
        if self._api_coverage_report:
            self._api_coverage_report.update_usage_stat(
                path,
                http_method,
                response.status,
                response.content_type,
            )
 
        if self._asyncexc_check:
            # Check for pending background exceptions after call.
            self._asyncexc_check()
 
        return response
 
 
# @endcond
 
 
class Client(ClientWrapper):
    """
    Asyncio userver client, typically retrieved from
    @ref service_client "plugins.service_client.service_client"
    fixture.
 
    Compatible with werkzeug interface.
 
    @ingroup userver_testsuite
    """
 
    PeriodicTaskFailed = PeriodicTaskFailed
    TestsuiteActionFailed = TestsuiteActionFailed
    TestsuiteTaskNotFound = TestsuiteTaskNotFound
    TestsuiteTaskConflict = TestsuiteTaskConflict
    TestsuiteTaskFailed = TestsuiteTaskFailed
 
    def _wrap_client_response(self, response: aiohttp.ClientResponse) -> Awaitable[http.ClientResponse]:
        return http.wrap_client_response(
            response,
            json_loads=approx.json_loads,
        )
 
    @_wrap_client_error
    async def run_periodic(self, name) -> None:
        await self._client.run_periodic(name)
 
    @_wrap_client_error
    async def run_periodic_task(self, name):
        warnings.warn(userver_warnings.WARN_PERIODIC_DEPRECATION, DeprecationWarning)
        await self._client.run_periodic_task(name)
 
    @_wrap_client_error
    async def suspend_periodic_tasks(self, names: list[str]) -> None:
        await self._client.suspend_periodic_tasks(names)
 
    @_wrap_client_error
    async def resume_periodic_tasks(self, names: list[str]) -> None:
        warnings.warn(userver_warnings.WARN_PERIODIC_DEPRECATION, DeprecationWarning)
        await self._client.resume_periodic_tasks(names)
 
    @_wrap_client_error
    async def resume_all_periodic_tasks(self) -> None:
        await self._client.resume_all_periodic_tasks()
 
    @_wrap_client_error
    async def write_cache_dumps(
        self,
        names: list[str],
        *,
        testsuite_skip_prepare=False,
    ) -> None:
        await self._client.write_cache_dumps(
            names=names,
            testsuite_skip_prepare=testsuite_skip_prepare,
        )
 
    @_wrap_client_error
    async def read_cache_dumps(
        self,
        names: list[str],
        *,
        testsuite_skip_prepare=False,
    ) -> None:
        await self._client.read_cache_dumps(
            names=names,
            testsuite_skip_prepare=testsuite_skip_prepare,
        )
 
    async def run_task(self, name: str) -> None:
        await self._client.run_task(name)
 
    async def run_distlock_task(self, name: str) -> None:
        await self._client.run_distlock_task(name)
 
    async def reset_metrics(self) -> None:
        """
        Calls `ResetMetric(metric);` for each metric that has such C++ function.
 
        Note that using `reset_metrics()` is discouraged, prefer using a more reliable
        @ref pytest_userver.client.ClientMonitor.metrics_diff "await monitor_client.metrics_diff()".
 
        @snippet samples/testsuite-support/tests/test_metrics.py metrics reset
        """
        await self._client.reset_metrics()
 
    async def metrics_portability(
        self,
        *,
        prefix: str | None = None,
    ) -> dict[str, list[dict[str, str]]]:
        """
        Reports metrics related issues that could be encountered on
        different monitoring systems.
 
        @sa @ref utils::statistics::GetPortabilityWarnings
        """
        return await self._client.metrics_portability(prefix=prefix)
 
    def list_tasks(self) -> list[str]:
        return self._client.list_tasks()
 
    def spawn_task(self, name: str):
        return self._client.spawn_task(name)
 
    def capture_logs(
        self,
        *,
        log_level: str = 'DEBUG',
        testsuite_skip_prepare: bool = False,
    ):
        """
        Captures logs from the service.
 
        @param log_level Do not capture logs below this level.
        @param testsuite_skip_prepare An advanced parameter to skip auto-`update_server_state`.
 
        @see @ref testsuite_logs_capture
        """
        return self._client.capture_logs(
            log_level=log_level,
            testsuite_skip_prepare=testsuite_skip_prepare,
        )
 
    def log_flush(self, logger_name: str | None = None):
        """
        Flush service logs.
        """
        return self._client.log_flush(logger_name=logger_name)
 
    @_wrap_client_error
    async def invalidate_caches(
        self,
        *,
        clean_update: bool = True,
        cache_names: list[str] | None = None,
        testsuite_skip_prepare: bool = False,
    ) -> None:
        """
        Send request to service to update caches.
 
        @param clean_update if False, service will do a faster incremental
               update of caches whenever possible.
        @param cache_names which caches specifically should be updated;
               update all if None.
        @param testsuite_skip_prepare if False, service will automatically do
               update_server_state().
        """
        __tracebackhide__ = True
        await self._client.invalidate_caches(
            clean_update=clean_update,
            cache_names=cache_names,
            testsuite_skip_prepare=testsuite_skip_prepare,
        )
 
    @_wrap_client_error
    async def tests_control(
        self,
        invalidate_caches: bool = True,
        clean_update: bool = True,
        cache_names: list[str] | None = None,
        http_allowed_urls_extra: list[str] | None = None,
    ) -> dict[str, Any]:
        return await self._client.tests_control(
            invalidate_caches=invalidate_caches,
            clean_update=clean_update,
            cache_names=cache_names,
            http_allowed_urls_extra=http_allowed_urls_extra,
        )
 
    @_wrap_client_error
    async def update_server_state(self) -> None:
        """
        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.
        """
        await self._client.update_server_state()
 
    @_wrap_client_error
    async def enable_testpoints(self, no_auto_cache_cleanup: bool = False) -> None:
        """
        Send list of handled testpoint pats to service. For these paths service
        will no more skip http calls from TESTPOINT(...) macro.
 
        @param 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.
        """
        await self._client.enable_testpoints(no_auto_cache_cleanup=no_auto_cache_cleanup)
 
    @_wrap_client_error
    async def get_dynamic_config_defaults(
        self,
    ) -> dict[str, Any]:
        return await self._client.get_dynamic_config_defaults()
 
 
@dataclasses.dataclass
class _State:
    """Reflects the (supposed) current service state."""
 
    invalidation_state: caches.InvalidationState
    now: str | None = _UNKNOWN_STATE
    testpoints: frozenset[str] = frozenset([_UNKNOWN_STATE])
 
 
class _StateManager:
    """
    Used for computing the requests that we need to automatically align
    the service state with the test fixtures state.
    """
 
    def __init__(
        self,
        *,
        mocked_time,
        testpoint,
        testpoint_control,
        invalidation_state: caches.InvalidationState,
        cache_control: caches.CacheControl | None,
    ):
        self._state = _State(
            invalidation_state=copy.deepcopy(invalidation_state),
        )
        self._mocked_time = mocked_time
        self._testpoint = testpoint
        self._testpoint_control = testpoint_control
        self._invalidation_state = invalidation_state
        self._cache_control = cache_control
 
    @contextlib.contextmanager
    def updating_state(self, body: dict[str, Any]):
        """
        Whenever `tests_control` handler is invoked
        (by the client itself during `prepare` or manually by the user),
        we need to synchronize `_state` with the (supposed) service state.
        The state update is decoded from the request body.
        """
        saved_state = copy.deepcopy(self._state)
        try:
            self._update_state(body)
            self._apply_new_state()
            yield
        except Exception:  # noqa
            self._state = saved_state
            self._apply_new_state()
            raise
 
    def get_pending_update(self) -> dict[str, Any]:
        """
        Compose the body of the `tests_control` request required to completely
        synchronize the service state with the state of test fixtures.
        """
        body: dict[str, Any] = {}
 
        if self._invalidation_state.has_caches_to_update:
            body['invalidate_caches'] = {'update_type': 'full'}
            if not self._invalidation_state.should_update_all_caches:
                body['invalidate_caches']['names'] = list(
                    self._invalidation_state.caches_to_update,
                )
 
        desired_testpoints = self._testpoint.keys()
        if self._state.testpoints != frozenset(desired_testpoints):
            body['testpoints'] = sorted(desired_testpoints)
 
        desired_now = self._get_desired_now()
        if self._state.now != desired_now:
            body['mock_now'] = desired_now
 
        return body
 
    @contextlib.contextmanager
    def cache_control_update(self) -> Iterator[dict[Any, Any]]:
        pending_update = self.get_pending_update()
        invalidate_caches = pending_update.get('invalidate_caches')
        if not invalidate_caches or not self._cache_control:
            yield pending_update
        else:
            cache_names = invalidate_caches.get('names')
            staged, actions = self._cache_control.query_caches(cache_names)
            self._apply_cache_control_actions(invalidate_caches, actions)
            yield pending_update
            self._cache_control.commit_staged(staged)
 
    @staticmethod
    def _apply_cache_control_actions(
        invalidate_caches: dict[Any, Any],
        actions: list[tuple[str, caches.CacheControlAction]],
    ) -> None:
        cache_names = invalidate_caches.get('names')
        exclude_names = invalidate_caches.setdefault('exclude_names', [])
        force_incremental_names = invalidate_caches.setdefault(
            'force_incremental_names',
            [],
        )
        for cache_name, action in actions:
            match action:
                case caches.CacheControlAction.FULL:
                    pass
                case caches.CacheControlAction.INCREMENTAL:
                    force_incremental_names.append(cache_name)
                case caches.CacheControlAction.EXCLUDE:
                    if cache_names is not None:
                        cache_names.remove(cache_name)
                    else:
                        exclude_names.append(cache_name)
 
    def _update_state(self, body: dict[str, Any]) -> None:
        body_invalidate_caches = body.get('invalidate_caches', {})
        update_type = body_invalidate_caches.get('update_type', 'full')
        body_cache_names = body_invalidate_caches.get('names', None)
        # An incremental update is considered insufficient to bring a cache
        # to a known state.
        if body_invalidate_caches and update_type == 'full':
            if body_cache_names is None:
                self._state.invalidation_state.on_all_caches_updated()
            else:
                self._state.invalidation_state.on_caches_updated(
                    body_cache_names,
                )
 
        if 'mock_now' in body:
            self._state.now = body['mock_now']
 
        testpoints: list[str] | None = body.get('testpoints')
        if testpoints is not None:
            self._state.testpoints = frozenset(testpoints)
 
    def _apply_new_state(self):
        """Apply new state to related components."""
        self._testpoint_control.enabled_testpoints = self._state.testpoints
        self._invalidation_state.assign_copy(self._state.invalidation_state)
 
    def _get_desired_now(self) -> str | None:
        if self._mocked_time.is_enabled:
            return utils.timestring(self._mocked_time.now())
        return None
 
 
async def _task_check_response(name: str, response) -> dict:
    async with response:
        if response.status == 404:
            raise TestsuiteTaskNotFound(f'Testsuite task {name!r} not found')
        if response.status == 409:
            raise TestsuiteTaskConflict(f'Testsuite task {name!r} conflict')
        assert response.status == 200
        data = await response.json()
        if not data.get('status', True):
            raise TestsuiteTaskFailed(name, data['reason'])
        return data