feat grpc: enable graceful shutdown headers middleware in gRPC health service

commit_hash:5aa1b221e4906f90169c20a7b7e114dcc09c71d7

Author: lexeyo

.mapping.json

@@ -2387,6 +2387,8 @@
   "grpc/handlers/functional_tests/health/CMakeLists.txt":"taxi/uservices/userver/grpc/handlers/functional_tests/health/CMakeLists.txt",
   "grpc/handlers/functional_tests/health/service.cpp":"taxi/uservices/userver/grpc/handlers/functional_tests/health/service.cpp",
   "grpc/handlers/functional_tests/health/static_config.yaml":"taxi/uservices/userver/grpc/handlers/functional_tests/health/static_config.yaml",
+  "grpc/handlers/functional_tests/health/tests-graceful-shutdown/conftest.py":"taxi/uservices/userver/grpc/handlers/functional_tests/health/tests-graceful-shutdown/conftest.py",
+  "grpc/handlers/functional_tests/health/tests-graceful-shutdown/test_graceful_shutdown.py":"taxi/uservices/userver/grpc/handlers/functional_tests/health/tests-graceful-shutdown/test_graceful_shutdown.py",
   "grpc/handlers/functional_tests/health/tests/conftest.py":"taxi/uservices/userver/grpc/handlers/functional_tests/health/tests/conftest.py",
   "grpc/handlers/functional_tests/health/tests/grpcserver/test_grpcserver.py":"taxi/uservices/userver/grpc/handlers/functional_tests/health/tests/grpcserver/test_grpcserver.py",
   "grpc/handlers/include/userver/ugrpc/server/health/component.hpp":"taxi/uservices/userver/grpc/handlers/include/userver/ugrpc/server/health/component.hpp",

grpc/handlers/functional_tests/health/CMakeLists.txt

@@ -5,4 +5,11 @@ target_link_libraries(${PROJECT_NAME} userver-grpc-handlers)
 
 include(UserverGrpcTargets)
 
-userver_chaos_testsuite_add(PYTHONPATH "${CMAKE_CURRENT_BINARY_DIR}/../../proto")
+userver_chaos_testsuite_add(
+    TESTS_DIRECTORY tests
+    PYTHONPATH "${CMAKE_CURRENT_BINARY_DIR}/../../proto"
+)
+userver_chaos_testsuite_add(
+    TESTS_DIRECTORY tests-graceful-shutdown
+    PYTHONPATH "${CMAKE_CURRENT_BINARY_DIR}/../../proto"
+)

grpc/handlers/functional_tests/health/static_config.yaml

@@ -1,5 +1,7 @@
 # yaml
 components_manager:
+    graceful_shutdown_interval: 10s
+
     components:
         # The required common components
         logging:
@@ -25,6 +27,9 @@ components_manager:
         grpc-health:
             task-processor: main-task-processor
             disable-all-pipeline-middlewares: true
+            middlewares:
+                grpc-server-graceful-shutdown-headers:
+                    enabled: true
 
     default_task_processor: main-task-processor
 

grpc/handlers/functional_tests/health/tests-graceful-shutdown/conftest.py

@@ -0,0 +1,34 @@
+import pytest
+
+try:
+    from src.proto.grpc.health.v1 import health_pb2_grpc
+except ImportError:
+    from health.v1 import health_pb2_grpc
+
+pytest_plugins = ['pytest_userver.plugins.grpc']
+
+
+@pytest.fixture
+def grpc_client(grpc_channel):
+    return health_pb2_grpc.HealthStub(grpc_channel)
+
+
+@pytest.fixture(name='userver_config_testsuite', scope='session')
+def _userver_config_testsuite(userver_config_testsuite):
+    def patch_config(config, config_vars) -> None:
+        userver_config_testsuite(config, config_vars)
+        # Restore the option after it's deleted by the base fixture.
+        # Don't do this in your testsuite tests! For userver tests only.
+        config['components_manager']['graceful_shutdown_interval'] = '3s'
+
+    return patch_config
+
+
+@pytest.fixture(scope='session')
+def graceful_shutdown_headers() -> dict[str, list[str]]:
+    return {'x-envoy-immediate-health-check-fail': ['true']}
+
+
+@pytest.fixture(scope='session')
+def dynamic_config_fallback_patch(graceful_shutdown_headers):
+    return {'GRACEFUL_SHUTDOWN_HEADERS': {'enabled': True, 'headers': graceful_shutdown_headers}}

grpc/handlers/functional_tests/health/tests-graceful-shutdown/test_graceful_shutdown.py

@@ -0,0 +1,44 @@
+from signal import SIGTERM
+
+import pytest
+
+try:
+    from src.proto.grpc.health.v1 import health_pb2
+except ImportError:
+    from health.v1 import health_pb2
+
+
+@pytest.mark.uservice_oneshot
+async def test_graceful_shutdown_headers(service_daemon_instance, grpc_client, graceful_shutdown_headers):
+    service_daemon_instance.process.send_signal(SIGTERM)
+
+    request = health_pb2.HealthCheckRequest()
+    call = grpc_client.Check(request)
+    response = await call
+    assert response.status == health_pb2.HealthCheckResponse.NOT_SERVING
+
+    check_present(await call.initial_metadata(), graceful_shutdown_headers)
+    check_not_present(await call.trailing_metadata(), graceful_shutdown_headers)
+
+    service_daemon_instance.process.wait()
+
+
+def check_present(metadata, headers: dict[str, list[str]]):
+    metadata_dict = to_dict(metadata)
+    for k, v in headers.items():
+        assert k in metadata_dict
+        assert metadata_dict[k] == v
+
+
+def check_not_present(metadata, headers: dict[str, list[str]]):
+    metadata_dict = to_dict(metadata)
+    for k in headers.keys():
+        assert k not in metadata_dict
+
+
+def to_dict(metadata) -> dict[str, list[str]]:
+    result: dict[str, list[str]] = {}
+    for k, v in metadata:
+        result.setdefault(k, []).append(v)
+
+    return result