feat userver/testsuite: publish PreCallClientInterceptor

commit_hash:8059a020621a6c99cb964c5e6b52572932130c39

Author: Anton3

.mapping.json

@@ -4929,6 +4929,7 @@
   "testsuite/pytest_plugins/pytest_userver/client.py":"taxi/uservices/userver/testsuite/pytest_plugins/pytest_userver/client.py",
   "testsuite/pytest_plugins/pytest_userver/dynconf.py":"taxi/uservices/userver/testsuite/pytest_plugins/pytest_userver/dynconf.py",
   "testsuite/pytest_plugins/pytest_userver/grpc/__init__.py":"taxi/uservices/userver/testsuite/pytest_plugins/pytest_userver/grpc/__init__.py",
+  "testsuite/pytest_plugins/pytest_userver/grpc/_client.py":"taxi/uservices/userver/testsuite/pytest_plugins/pytest_userver/grpc/_client.py",
   "testsuite/pytest_plugins/pytest_userver/grpc/_mocked_errors.py":"taxi/uservices/userver/testsuite/pytest_plugins/pytest_userver/grpc/_mocked_errors.py",
   "testsuite/pytest_plugins/pytest_userver/grpc/_reflection.py":"taxi/uservices/userver/testsuite/pytest_plugins/pytest_userver/grpc/_reflection.py",
   "testsuite/pytest_plugins/pytest_userver/grpc/_servicer_mock.py":"taxi/uservices/userver/testsuite/pytest_plugins/pytest_userver/grpc/_servicer_mock.py",

testsuite/pytest_plugins/pytest_userver/grpc/__init__.py

@@ -1,5 +1,5 @@
 """
-Mocks for the gRPC servers, a.k.a. `pytest_userver.grpc.
+Mocks for the gRPC servers, a.k.a. `pytest_userver.grpc`.
 
 @sa @ref scripts/docs/en/userver/tutorial/grpc_service.md
 @sa @ref pytest_userver.plugins.grpc.mockserver
@@ -22,6 +22,7 @@
 
 import testsuite.utils.callinfo
 
+from ._client import PreCallClientInterceptor  # noqa: F401
 from ._mocked_errors import MockedError  # noqa: F401
 from ._mocked_errors import NetworkError  # noqa: F401
 from ._mocked_errors import TimeoutError  # noqa: F401

testsuite/pytest_plugins/pytest_userver/grpc/_client.py

@@ -0,0 +1,69 @@
+import abc
+from collections.abc import AsyncIterator
+from collections.abc import Awaitable
+from collections.abc import Callable
+from typing import Any
+
+import grpc.aio
+
+
+class PreCallClientInterceptor(
+    grpc.aio.UnaryUnaryClientInterceptor,
+    grpc.aio.UnaryStreamClientInterceptor,
+    grpc.aio.StreamUnaryClientInterceptor,
+    grpc.aio.StreamStreamClientInterceptor,
+    abc.ABC,
+):
+    """
+    @brief A simple generic interceptor that allows to insert some code before each RPC is initiated.
+
+    To use, inherit from this class and pass an instance to
+    @ref pytest_userver.plugins.grpc._hookspec.pytest_grpc_client_interceptors "pytest_grpc_client_interceptors".
+
+    @note Exported as `pytest_userver.grpc.PreCallClientInterceptor`.
+    @ingroup userver_testsuite
+    """
+
+    @abc.abstractmethod
+    async def pre_call_hook(self, client_call_details: grpc.aio.ClientCallDetails) -> None:
+        """
+        Runs before the RPC is initiated. `client_call_details` can be observed or modified as needed.
+        """
+
+    async def intercept_unary_unary(
+        self,
+        continuation: Callable[[grpc.aio.ClientCallDetails, Any], Awaitable[grpc.aio.UnaryUnaryCall]],
+        client_call_details: grpc.aio.ClientCallDetails,
+        request: Any,
+    ) -> grpc.aio.UnaryUnaryCall:
+        await self.pre_call_hook(client_call_details)
+        return await continuation(client_call_details, request)
+
+    # Note: full type of this function is Callable[[...], Awaitable[AsyncIterator[Any]]]
+    async def intercept_unary_stream(
+        self,
+        continuation: Callable[[grpc.aio.ClientCallDetails, Any], grpc.aio.UnaryStreamCall],
+        client_call_details: grpc.aio.ClientCallDetails,
+        request: Any,
+    ) -> AsyncIterator[Any]:
+        await self.pre_call_hook(client_call_details)
+        return await continuation(client_call_details, request)
+
+    async def intercept_stream_unary(
+        self,
+        continuation: Callable[[grpc.aio.ClientCallDetails, AsyncIterator[Any]], Awaitable[grpc.aio.StreamUnaryCall]],
+        client_call_details: grpc.aio.ClientCallDetails,
+        request_iterator: AsyncIterator[Any],
+    ) -> grpc.aio.StreamUnaryCall:
+        await self.pre_call_hook(client_call_details)
+        return await continuation(client_call_details, request_iterator)
+
+    # Note: full type of this function is Callable[[...], Awaitable[AsyncIterator[Any]]]
+    async def intercept_stream_stream(
+        self,
+        continuation: Callable[[grpc.aio.ClientCallDetails, AsyncIterator[Any]], grpc.aio.StreamStreamCall],
+        client_call_details: grpc.aio.ClientCallDetails,
+        request_iterator: AsyncIterator[Any],
+    ) -> AsyncIterator[Any]:
+        await self.pre_call_hook(client_call_details)
+        return await continuation(client_call_details, request_iterator)

testsuite/pytest_plugins/pytest_userver/plugins/grpc/_hookspec.py

@@ -14,6 +14,6 @@ def pytest_grpc_client_interceptors(request: pytest.FixtureRequest) -> Sequence[
     Interceptors are accomulated over all implementations of this hook from all plugins.
 
     @see @ref scripts/docs/en/userver/grpc/grpc.md
-    @ingroup userver_testsuite_fixtures
+    @ingroup userver_testsuite
     """
     raise NotImplementedError()

testsuite/pytest_plugins/pytest_userver/plugins/grpc/client.py

@@ -20,8 +20,10 @@
 import grpc
 import grpc.aio
 import pytest
+from typing_extensions import override
 
 import pytest_userver.client
+import pytest_userver.grpc
 from . import _hookspec
 
 DEFAULT_TIMEOUT = 15.0
@@ -194,41 +196,37 @@ def pytest_addhooks(pluginmanager: pytest.PytestPluginManager):
     pluginmanager.add_hookspecs(_hookspec)
 
 
-class _UpdateServerStateInterceptor(
+class _AsyncExcCheckInterceptor(
     grpc.aio.UnaryUnaryClientInterceptor,
     grpc.aio.UnaryStreamClientInterceptor,
     grpc.aio.StreamUnaryClientInterceptor,
     grpc.aio.StreamStreamClientInterceptor,
 ):
-    def __init__(self, service_client: pytest_userver.client.Client, asyncexc_check: _AsyncExcCheck):
-        self._service_client = service_client
+    def __init__(self, asyncexc_check: _AsyncExcCheck):
         self._asyncexc_check = asyncexc_check
 
-    async def _before_call_hook(self) -> None:
-        self._asyncexc_check()
-        if hasattr(self._service_client, 'update_server_state'):
-            await self._service_client.update_server_state()
-
+    @override
     async def intercept_unary_unary(
         self,
         continuation: Callable[[grpc.aio.ClientCallDetails, Any], Awaitable[grpc.aio.UnaryUnaryCall]],
         client_call_details: grpc.aio.ClientCallDetails,
         request: Any,
     ) -> grpc.aio.UnaryUnaryCall:
-        await self._before_call_hook()
+        self._asyncexc_check()
         try:
             return await continuation(client_call_details, request)
         finally:
             self._asyncexc_check()
 
     # Note: full type of this function is Callable[[...], Awaitable[AsyncIterator[Any]]]
+    @override
     async def intercept_unary_stream(
         self,
         continuation: Callable[[grpc.aio.ClientCallDetails, Any], grpc.aio.UnaryStreamCall],
         client_call_details: grpc.aio.ClientCallDetails,
         request: Any,
     ) -> AsyncIterator[Any]:
-        await self._before_call_hook()
+        self._asyncexc_check()
         call = await continuation(client_call_details, request)
 
         async def response_stream() -> AsyncIterator[Any]:
@@ -240,27 +238,28 @@ async def response_stream() -> AsyncIterator[Any]:
 
         return response_stream()
 
+    @override
     async def intercept_stream_unary(
         self,
         continuation: Callable[[grpc.aio.ClientCallDetails, AsyncIterator[Any]], Awaitable[grpc.aio.StreamUnaryCall]],
         client_call_details: grpc.aio.ClientCallDetails,
         request_iterator: AsyncIterator[Any],
     ) -> grpc.aio.StreamUnaryCall:
-        await self._before_call_hook()
+        self._asyncexc_check()
         try:
             return await continuation(client_call_details, request_iterator)
         finally:
             self._asyncexc_check()
 
     # Note: full type of this function is Callable[[...], Awaitable[AsyncIterator[Any]]]
+    @override
     async def intercept_stream_stream(
         self,
         continuation: Callable[[grpc.aio.ClientCallDetails, AsyncIterator[Any]], grpc.aio.StreamStreamCall],
         client_call_details: grpc.aio.ClientCallDetails,
         request_iterator: AsyncIterator[Any],
     ) -> AsyncIterator[Any]:
         self._asyncexc_check()
-        await self._before_call_hook()
         call = await continuation(client_call_details, request_iterator)
 
         async def response_stream() -> AsyncIterator[Any]:
@@ -273,12 +272,20 @@ async def response_stream() -> AsyncIterator[Any]:
         return response_stream()
 
 
+class _UpdateServerStateInterceptor(pytest_userver.grpc.PreCallClientInterceptor):
+    def __init__(self, service_client: pytest_userver.client.Client):
+        self._service_client = service_client
+
+    @override
+    async def pre_call_hook(self, client_call_details: grpc.aio.ClientCallDetails) -> None:
+        if hasattr(self._service_client, 'update_server_state'):
+            await self._service_client.update_server_state()
+
+
 def pytest_grpc_client_interceptors(request: pytest.FixtureRequest) -> Sequence[grpc.aio.ClientInterceptor]:
     return [
-        _UpdateServerStateInterceptor(
-            request.getfixturevalue('service_client'),
-            request.getfixturevalue('asyncexc_check'),
-        ),
+        _AsyncExcCheckInterceptor(request.getfixturevalue('asyncexc_check')),
+        _UpdateServerStateInterceptor(request.getfixturevalue('service_client')),
     ]