test(api-core): [Potentially OBE] Adds integration tests using a local grpc server by chalmerlowe · Pull Request #18118 · googleapis/google-cloud-python · GitHub

Warning

This description is AI generated and is no longer accurate. NEEDS REVISION.

Problem

The previous implementation used standard grpc.intercept_channel which caused a TypeError with modern OpenTelemetry interceptors because they do not satisfy standard grpc interceptor type checks.
Older OpenTelemetry versions relied on pkg_resources, which was removed in setuptools v82+, causing ModuleNotFoundError in modern test environments.
There was a lack of robust tests verifying that spans are actually recorded during a real gRPC call (without relying heavily on mocks).

Solution

Modernized Interception: Switched from grpc.intercept_channel to otel_grpc.intercept_channel helper provided by the OpenTelemetry instrumentation package, which cleanly handles its own interceptor types.
Raised Lower Bounds: Bumped minimum OpenTelemetry versions to modern releases (opentelemetry-api >= 1.44.0, opentelemetry-instrumentation-grpc >= 0.65b0) to eliminate reliance on the deprecated pkg_resources.
New Testing Extra: Added a [testing] extra containing opentelemetry-sdk to facilitate test automation.
Robust Integration Test: Added test_otel_integration_with_fake_endpoint which spins up a local, generic gRPC server (GenericEchoHandler) to verify that spans are recorded during a real request without needing compiled protobuf stubs.

Notes to Reviewers

This PR ensures compatibility with modern setuptools and modern OpenTelemetry practices.
The generic gRPC server approach allows us to test the full plumbing without bloating the PR with compiled _pb2.py files.
We have decoupled the testing SDK from core dependencies while ensuring standard test runners (like Nox) have all they need to run the suite.

Expands upon #18069 (Adds additional integration testing to supplement the unit testing)

Code Review

This pull request introduces OpenTelemetry tracing support for gRPC channels in google-api-core. It adds a tracer_provider option to ClientOptions, integrates OpenTelemetry gRPC client interceptors in grpc_helpers.create_channel when tracing is enabled, and safely discards the tracing configuration in async channels to prevent runtime errors. Additionally, dependencies and tests are updated to support this new functionality. The review feedback suggests improving mock hygiene in the newly added tests by patching the local module import path for grpc.secure_channel instead of patching the global module directly, adhering to the repository's style guide.

According to the Repository Style Guide (Section 4: Unit Testing and Mock Hygiene), we should mock the local module import path instead of patching third-party or global modules directly. This ensures that mocks are isolated and do not leak or cause side effects in other tests.

Suggested change

      
                    mock.patch(
          
                        "grpc.secure_channel", return_value=mock_channel
          
                    ) as mock_secure_channel,
          
                    mock.patch(
          
                        "google.api_core.grpc_helpers.grpc.secure_channel", return_value=mock_channel
          
                    ) as mock_secure_channel,

References

Localized Mocking: When mocking standard functions or filesystem checks, mock the local module import path instead of patching builtins globally, ensuring mocks are isolated. (link)

According to the Repository Style Guide (Section 4: Unit Testing and Mock Hygiene), we should mock the local module import path instead of patching third-party or global modules directly to ensure proper mock isolation.

Suggested change

      
                    mock.patch("grpc.secure_channel", return_value=mock_channel),
          
                    mock.patch("google.api_core.grpc_helpers.grpc.secure_channel", return_value=mock_channel),

References

Localized Mocking: When mocking standard functions or filesystem checks, mock the local module import path instead of patching builtins globally, ensuring mocks are isolated. (link)

According to the Repository Style Guide (Section 4: Unit Testing and Mock Hygiene), we should mock the local module import path instead of patching third-party or global modules directly to ensure proper mock isolation.

Suggested change

      
                monkeypatch.setattr(grpc, "secure_channel", mock_secure)
          
                monkeypatch.setattr("google.api_core.grpc_helpers.grpc.secure_channel", mock_secure)

References

Localized Mocking: When mocking standard functions or filesystem checks, mock the local module import path instead of patching builtins globally, ensuring mocks are isolated. (link)

…ine tests

…rize error tests

gemini-code-assist Bot reviewed Aug 14, 2026

View reviewed changes

chalmerlowe mentioned this pull request Aug 14, 2026

feat(api-core): [Potentially OBE] Opentelemetry tracing support for gRPC transports in google-api-core #18069

Draft

chalmerlowe added this to the [o11y] Tracing milestone Aug 14, 2026

chalmerlowe mentioned this pull request Aug 14, 2026

feat(api-core): lay groundwork for stock OpenTelemetry gRPC tracing #18026

Closed

chalmerlowe changed the base branch from main to feat/otel-tracing-core-infra August 14, 2026 16:02

chalmerlowe force-pushed the feat/otel-tracing-core-infra branch 2 times, most recently from c908003 to 9a9e764 Compare August 17, 2026 11:03

chalmerlowe force-pushed the feat/otel-tracing-robust-tests branch from 1f12f3c to ceb17e5 Compare August 17, 2026 11:38

chalmerlowe added 8 commits August 17, 2026 12:16

test(api-core): add robust grpc server test for otel integration

b263a7a

fix(api-core): use otel_grpc.intercept_channel, raise bounds, and ref…

7c1d1ea

…ine tests

feat: add robust integration tests and sad paths for OTel tracing

069174b

refactor: use fixture for OTel in-memory setup in tests

25d2a61

refactor: extract insecure channel boilerplate to fixture and paramet…

9797137

…rize error tests

refactor: rename fixtures for better self-documentation

6a97352

docs: clean up step labels in integration tests

d6401b3

refactor: remove redundant unit test in favor of integration test

2c110ee

chalmerlowe force-pushed the feat/otel-tracing-robust-tests branch from 5607f9b to 2c110ee Compare August 17, 2026 16:16

parthea assigned chalmerlowe Aug 18, 2026

chalmerlowe changed the title test(api-core): Adds integration tests using a local grpc server test(api-core): [Potentially OBE] Adds integration tests using a local grpc server Aug 18, 2026

test(api-core): [Potentially OBE] Adds integration tests using a local grpc server by chalmerlowe · Pull Request #18118 · googleapis/google-cloud-python · GitHub

Uh oh!

test(api-core): [Potentially OBE] Adds integration tests using a local grpc server - #18118

test(api-core): [Potentially OBE] Adds integration tests using a local grpc server #18118
chalmerlowe wants to merge 8 commits into
feat/otel-tracing-core-infrafrom
feat/otel-tracing-robust-tests

chalmerlowe commented Aug 14, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot Aug 14, 2026

Uh oh!

gemini-code-assist Bot Aug 14, 2026

Uh oh!

gemini-code-assist Bot Aug 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	mock.patch("grpc.secure_channel", return_value=mock_channel),
	mock.patch("google.api_core.grpc_helpers.grpc.secure_channel", return_value=mock_channel),

+                  def mock_secure(*args, **kwargs):
+                      return grpc.insecure_channel(args[0])
+                  monkeypatch.setattr(grpc, "secure_channel", mock_secure)

	monkeypatch.setattr(grpc, "secure_channel", mock_secure)
	monkeypatch.setattr("google.api_core.grpc_helpers.grpc.secure_channel", mock_secure)

test(api-core): [Potentially OBE] Adds integration tests using a local grpc server by chalmerlowe · Pull Request #18118 · googleapis/google-cloud-python · GitHub

Uh oh!

test(api-core): [Potentially OBE] Adds integration tests using a local grpc server - #18118

Conversation

chalmerlowe commented Aug 14, 2026

Problem

Solution

Notes to Reviewers

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant