test(secretmanager): add OpenTelemetry observability unit tests with local in-memory gRPC server

Author: chalmerlowe

packages/google-api-core/google/api_core/_observability.py

@@ -16,7 +16,6 @@
 
 """OpenTelemetry helpers for resolving and instantiating interceptors."""
 
-import functools
 from typing import TYPE_CHECKING, Any, Callable
 
 from google.api_core import _feature_gating_helpers
@@ -83,7 +82,7 @@ def _get_otel_interceptor(
         tracer_provider = getattr(client_options, _TRACER_PROVIDER, None)
 
     if is_async:
-        return otel_grpc.aio_client_interceptor(tracer_provider=tracer_provider)
+        return otel_grpc.aio_client_interceptors(tracer_provider=tracer_provider)
     return otel_grpc.client_interceptor(tracer_provider=tracer_provider)
 
 
@@ -106,7 +105,11 @@ def get_otel_channel_wrapper(
     import opentelemetry.instrumentation.grpc as otel_grpc  # type: ignore[import-not-found]
 
     interceptor = _get_otel_interceptor(client_options, is_async=False)
-    return functools.partial(otel_grpc.intercept_channel, interceptor=interceptor)
+
+    def channel_wrapper(channel: Any) -> Any:
+        return otel_grpc.intercept_channel(channel, interceptor)
+
+    return channel_wrapper
 
 
 def get_otel_async_interceptor(

packages/google-api-core/tests/unit/test_observability.py

@@ -160,8 +160,8 @@ def test_get_otel_interceptor_async(monkeypatch):
 
     mock_otel = mock.Mock()
     mock_otel_grpc = mock_otel.instrumentation.grpc
-    mock_async_interceptor = mock.Mock()
-    mock_otel_grpc.aio_client_interceptor.return_value = mock_async_interceptor
+    mock_async_interceptors = [mock.Mock()]
+    mock_otel_grpc.aio_client_interceptors.return_value = mock_async_interceptors
 
     monkeypatch.setitem(sys.modules, "opentelemetry", mock_otel)
     monkeypatch.setitem(
@@ -172,8 +172,8 @@ def test_get_otel_interceptor_async(monkeypatch):
     )
 
     result = _observability._get_otel_interceptor(client_options=options, is_async=True)
-    assert result is mock_async_interceptor
-    mock_otel_grpc.aio_client_interceptor.assert_called_once_with(
+    assert result is mock_async_interceptors
+    mock_otel_grpc.aio_client_interceptors.assert_called_once_with(
         tracer_provider=mock_tracer_provider
     )
 
@@ -222,7 +222,7 @@ def test_get_otel_channel_wrapper_enabled(monkeypatch):
     result = wrapper(mock_raw_channel)
     assert result is mock_wrapped_channel
     mock_otel_grpc.intercept_channel.assert_called_once_with(
-        mock_raw_channel, interceptor=mock_interceptor
+        mock_raw_channel, mock_interceptor
     )
 
 
@@ -261,7 +261,7 @@ def test_get_otel_channel_wrapper_with_apply_channel_wrappers(monkeypatch):
     )
     assert result is mock_wrapped_channel
     mock_otel_grpc.intercept_channel.assert_called_once_with(
-        mock_raw_channel, interceptor=mock_interceptor
+        mock_raw_channel, mock_interceptor
     )
 
 
@@ -281,11 +281,11 @@ def test_get_otel_async_interceptor_enabled(monkeypatch):
     mock_tracer_provider = object()
     options = ClientOptions(tracer_provider=mock_tracer_provider)
 
-    mock_async_interceptor = mock.Mock(name="otel_async_interceptor")
+    mock_async_interceptors = [mock.Mock(name="otel_async_interceptor")]
 
     mock_otel = mock.Mock()
     mock_otel_grpc = mock_otel.instrumentation.grpc
-    mock_otel_grpc.aio_client_interceptor.return_value = mock_async_interceptor
+    mock_otel_grpc.aio_client_interceptors.return_value = mock_async_interceptors
 
     monkeypatch.setitem(sys.modules, "opentelemetry", mock_otel)
     monkeypatch.setitem(
@@ -296,7 +296,7 @@ def test_get_otel_async_interceptor_enabled(monkeypatch):
     )
 
     result = _observability.get_otel_async_interceptor(client_options=options)
-    assert result is mock_async_interceptor
-    mock_otel_grpc.aio_client_interceptor.assert_called_once_with(
+    assert result is mock_async_interceptors
+    mock_otel_grpc.aio_client_interceptors.assert_called_once_with(
         tracer_provider=mock_tracer_provider
     )

packages/google-cloud-secret-manager/noxfile.py

@@ -72,7 +72,7 @@
 ]
 UNIT_TEST_EXTERNAL_DEPENDENCIES: List[str] = []
 UNIT_TEST_LOCAL_DEPENDENCIES: List[str] = [
-    "../google-api-core[tracing,testing]",
+    "../google-api-core",
 ]
 UNIT_TEST_DEPENDENCIES: List[str] = []
 UNIT_TEST_EXTRAS: List[str] = []
@@ -266,19 +266,27 @@ def install_unittest_dependencies(session, *constraints):
 
 @nox.session(python=ALL_PYTHON)
 @nox.parametrize(
-    "protobuf_implementation",
-    ["python", "upb"],
+    ["protobuf_implementation", "install_otel"],
+    [
+        ("python", True),
+        ("python", False),
+        ("upb", True),
+        ("upb", False),
+    ],
 )
-def unit(session, protobuf_implementation):
+def unit(session, protobuf_implementation, install_otel):
     # Install all test dependencies, then install this package in-place.
 
     constraints_path = str(
         CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt"
     )
+    if install_otel:
+        session.install("../google-api-core[tracing,testing]")
+
     install_unittest_dependencies(session, "-c", constraints_path)
 
     # Run py.test against the unit tests.
-    session.run(
+    pytest_args = [
         "py.test",
         "--quiet",
         f"--junitxml=unit_{session.python}_sponge_log.xml",
@@ -288,8 +296,14 @@ def unit(session, protobuf_implementation):
         "--cov-config=.coveragerc",
         "--cov-report=",
         "--cov-fail-under=0",
-        os.path.join("tests", "unit"),
-        *session.posargs,
+    ]
+    if not session.posargs:
+        pytest_args.append(os.path.join("tests", "unit"))
+    else:
+        pytest_args.extend(session.posargs)
+
+    session.run(
+        *pytest_args,
         env={
             "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation,
         },