refactor(secretmanager): align with new _observability helpers and sharpen type hints

Author: chalmerlowe

packages/google-cloud-secret-manager/google/cloud/secretmanager_v1/services/secret_manager_service/client.py

@@ -35,7 +35,7 @@
 )
 
 import google.protobuf
-from google.api_core import _feature_gating_helpers, _otel_helpers, gapic_v1
+from google.api_core import _feature_gating_helpers, _observability, gapic_v1
 from google.api_core import client_options as client_options_lib
 from google.api_core import exceptions as core_exceptions
 from google.api_core import retry as retries
@@ -764,9 +764,9 @@ def __init__(
             # pass the channel to transport_init. When the Transport finds an existing
             # channel it will use that, otherwise it will create one lazily. 
             if transport_init is SecretManagerServiceGrpcTransport:
-                if _otel_helpers.is_otel_capabilities_enabled(self._client_options):
+                if _observability.is_otel_capabilities_enabled(self._client_options):
                     # Eagerly create the channel using the Transport's classmethod
-                    raw_channel = transport_init.create_channel(
+                    raw_channel = SecretManagerServiceGrpcTransport.create_channel(
                         self._api_endpoint,
                         credentials=credentials,
                         credentials_file=self._client_options.credentials_file,
@@ -775,7 +775,7 @@ def __init__(
                     )
 
                     # Apply OTel capabilities to the channel
-                    wrapped_channel = _otel_helpers.apply_otel_capabilities_to_channel(
+                    wrapped_channel = _observability.apply_otel_capabilities_to_channel(
                         raw_channel, self._client_options
                     )
 

packages/google-cloud-secret-manager/google/cloud/secretmanager_v1/services/secret_manager_service/transports/grpc.py

@@ -44,6 +44,13 @@
 
 _LOGGER = std_logging.getLogger(__name__)
 
+ClientInterceptor = Union[
+    grpc.UnaryUnaryClientInterceptor,
+    grpc.UnaryStreamClientInterceptor,
+    grpc.StreamUnaryClientInterceptor,
+    grpc.StreamStreamClientInterceptor,
+]
+
 
 class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor):  # pragma: NO COVER
     def intercept_unary_unary(self, continuation, client_call_details, request):
@@ -147,7 +154,7 @@ def __init__(
         client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
         always_use_jwt_access: Optional[bool] = False,
         api_audience: Optional[str] = None,
-        interceptors: Optional[Sequence[grpc.ClientInterceptor]] = None,
+        interceptors: Optional[Sequence[ClientInterceptor]] = None,
     ) -> None:
         """Instantiate the transport.
 
@@ -198,7 +205,7 @@ def __init__(
                 to the service that will be set when using certain 3rd party
                 authentication flows. Audience is typically a resource identifier.
                 If not set, the host value will be used as a default.
-            interceptors (Optional[Sequence[grpc.ClientInterceptor]]):
+            interceptors (Optional[Sequence[ClientInterceptor]]):
                 Additional interceptors to be injected into the gRPC channel pipeline.
                 These are executed in order.
 

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

@@ -367,6 +367,14 @@ def system(session):
         )
 
 
+@nox.session(python=DEFAULT_PYTHON_VERSION)
+def integration(session):
+    """Run integration tests with OpenTelemetry."""
+    session.install("-e", ".")
+    session.install("pytest", "opentelemetry-sdk", "opentelemetry-instrumentation-grpc")
+    session.run("py.test", "tests/integration", *session.posargs)
+
+
 @nox.session(python=DEFAULT_PYTHON_VERSION)
 def cover(session):
     """Run the final coverage report.

packages/google-cloud-secret-manager/tests/unit/gapic/secretmanager_v1/test_secret_manager_service.py

@@ -774,56 +774,64 @@ def test_secret_manager_service_client_otel_eager_channel_injection():
     mock_raw_channel = mock.Mock()
     mock_wrapped_channel = mock.Mock()
 
-    with mock.patch(
-        "google.cloud.secretmanager_v1.services.secret_manager_service.client._otel_helpers.is_otel_capabilities_enabled",
-        return_value=True,
-    ) as mock_is_enabled:
-        with mock.patch(
-            "google.cloud.secretmanager_v1.services.secret_manager_service.client._otel_helpers.apply_otel_capabilities_to_channel",
+    # We use parenthesized context managers (Python 3.10+) to flatten the mocks.
+    # This prevents deep indentation while ensuring all mocks are active during
+    # Client instantiation.
+    with (
+        mock.patch(
+            "google.cloud.secretmanager_v1.services.secret_manager_service.client._observability.is_otel_capabilities_enabled",
+            return_value=True,
+        ) as mock_is_enabled,
+        mock.patch(
+            "google.cloud.secretmanager_v1.services.secret_manager_service.client._observability.apply_otel_capabilities_to_channel",
             return_value=mock_wrapped_channel,
-        ) as mock_apply_otel:
-            with mock.patch.object(
-                transports.SecretManagerServiceGrpcTransport,
-                "create_channel",
-                return_value=mock_raw_channel,
-            ) as mock_create_channel:
-                with mock.patch.object(
-                    transports.SecretManagerServiceGrpcTransport, "__init__"
-                ) as patched_transport_init:
-                    patched_transport_init.return_value = None
+        ) as mock_apply_otel,
+        mock.patch.object(
+            transports.SecretManagerServiceGrpcTransport,
+            "create_channel",
+            return_value=mock_raw_channel,
+        ) as mock_create_channel,
+        mock.patch.object(
+            transports.SecretManagerServiceGrpcTransport, "__init__", return_value=None
+        ) as patched_transport_init,
+    ):
+        client = SecretManagerServiceClient(transport="grpc")
 
-                    client = SecretManagerServiceClient(transport="grpc")
 
-                    mock_is_enabled.assert_called_once()
-                    mock_create_channel.assert_called_once()
-                    mock_apply_otel.assert_called_once_with(mock_raw_channel, mock.ANY)
+        mock_is_enabled.assert_called_once()
+        mock_create_channel.assert_called_once()
+        mock_apply_otel.assert_called_once_with(mock_raw_channel, mock.ANY)
 
-                    called_kwargs = patched_transport_init.call_args.kwargs
-                    assert "channel" in called_kwargs
-                    assert called_kwargs["channel"] == mock_wrapped_channel
+        called_kwargs = patched_transport_init.call_args.kwargs
+        assert "channel" in called_kwargs
+        assert called_kwargs["channel"] == mock_wrapped_channel
 
 
 def test_secret_manager_service_client_otel_eager_channel_injection_disabled():
     # Simulate OTel being disabled
-    with mock.patch(
-        "google.cloud.secretmanager_v1.services.secret_manager_service.client._otel_helpers.is_otel_capabilities_enabled",
-        return_value=False,
-    ) as mock_is_enabled:
-        with mock.patch.object(
+    # We use parenthesized context managers (Python 3.10+) to flatten the mocks.
+    # This prevents deep indentation while ensuring all mocks are active during
+    # Client instantiation.
+    with (
+        mock.patch(
+            "google.cloud.secretmanager_v1.services.secret_manager_service.client._observability.is_otel_capabilities_enabled",
+            return_value=False,
+        ) as mock_is_enabled,
+        mock.patch.object(
             transports.SecretManagerServiceGrpcTransport, "create_channel"
-        ) as mock_create_channel:
-            with mock.patch.object(
-                transports.SecretManagerServiceGrpcTransport, "__init__"
-            ) as patched_transport_init:
-                patched_transport_init.return_value = None
+        ) as mock_create_channel,
+        mock.patch.object(
+            transports.SecretManagerServiceGrpcTransport, "__init__", return_value=None
+        ) as patched_transport_init,
+    ):
+        client = SecretManagerServiceClient(transport="grpc")
 
-                client = SecretManagerServiceClient(transport="grpc")
+        mock_is_enabled.assert_called_once()
+        mock_create_channel.assert_not_called()
 
-                mock_is_enabled.assert_called_once()
-                mock_create_channel.assert_not_called()
+        called_kwargs = patched_transport_init.call_args.kwargs
+        assert "channel" not in called_kwargs
 
-                called_kwargs = patched_transport_init.call_args.kwargs
-                assert "channel" not in called_kwargs
 
 
 @pytest.mark.parametrize(