Skip to content

chore: clean up HAS_GRPC_GCP #892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vchudnov-g merged 1 commit into from
Feb 10, 2026
+36 −100
Merged

chore: clean up HAS_GRPC_GCP #892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions google/api_core/grpc_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@

from google.api_core import exceptions, general_helpers

HAS_GRPC_GCP = False


# The list of gRPC Callable interfaces that return iterators.
_STREAM_WRAP_CLASSES = (grpc.UnaryStreamMultiCallable, grpc.StreamStreamMultiCallable)
Expand Down
134 changes: 36 additions & 98 deletions tests/unit/test_grpc_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,16 +404,9 @@ def test_create_channel_implicit(

google_auth_default.assert_called_once_with(scopes=None, default_scopes=None)

if grpc_helpers.HAS_GRPC_GCP: # pragma: NO COVER
# The original target is the expected target
expected_target = target
grpc_secure_channel.assert_called_once_with(
expected_target, composite_creds, None
)
else:
grpc_secure_channel.assert_called_once_with(
expected_target, composite_creds, compression=grpc.Compression.Gzip
)
grpc_secure_channel.assert_called_once_with(
expected_target, composite_creds, compression=grpc.Compression.Gzip
)


@pytest.mark.parametrize(
Expand Down Expand Up @@ -463,16 +456,9 @@ def test_create_channel_implicit_with_default_host(
mock.sentinel.credentials, mock.sentinel.Request, default_host=default_host
)

if grpc_helpers.HAS_GRPC_GCP: # pragma: NO COVER
# The original target is the expected target
expected_target = target
grpc_secure_channel.assert_called_once_with(
expected_target, composite_creds, None
)
else:
grpc_secure_channel.assert_called_once_with(
expected_target, composite_creds, compression=None
)
grpc_secure_channel.assert_called_once_with(
expected_target, composite_creds, compression=None
)


@pytest.mark.parametrize(
Expand Down Expand Up @@ -505,12 +491,9 @@ def test_create_channel_implicit_with_ssl_creds(
composite_creds_call.assert_called_once_with(ssl_creds, mock.ANY)
composite_creds = composite_creds_call.return_value

if grpc_helpers.HAS_GRPC_GCP: # pragma: NO COVER
grpc_secure_channel.assert_called_once_with(target, composite_creds, None)
else:
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)


def test_create_channel_implicit_with_ssl_creds_attempt_direct_path_true():
Expand Down Expand Up @@ -543,12 +526,9 @@ def test_create_channel_implicit_with_scopes(

default.assert_called_once_with(scopes=["one", "two"], default_scopes=None)

if grpc_helpers.HAS_GRPC_GCP: # pragma: NO COVER
grpc_secure_channel.assert_called_once_with(target, composite_creds, None)
else:
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)


@mock.patch("grpc.compute_engine_channel_credentials")
Expand All @@ -570,12 +550,9 @@ def test_create_channel_implicit_with_default_scopes(

default.assert_called_once_with(scopes=None, default_scopes=["three", "four"])

if grpc_helpers.HAS_GRPC_GCP: # pragma: NO COVER
grpc_secure_channel.assert_called_once_with(target, composite_creds, None)
else:
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)


def test_create_channel_explicit_with_duplicate_credentials():
Expand Down Expand Up @@ -605,12 +582,9 @@ def test_create_channel_explicit(grpc_secure_channel, auth_creds, composite_cred

assert channel is grpc_secure_channel.return_value

if grpc_helpers.HAS_GRPC_GCP: # pragma: NO COVER
grpc_secure_channel.assert_called_once_with(target, composite_creds, None)
else:
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)


@mock.patch("grpc.compute_engine_channel_credentials")
Expand All @@ -631,12 +605,9 @@ def test_create_channel_explicit_scoped(grpc_secure_channel, composite_creds_cal

assert channel is grpc_secure_channel.return_value

if grpc_helpers.HAS_GRPC_GCP: # pragma: NO COVER
grpc_secure_channel.assert_called_once_with(target, composite_creds, None)
else:
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)


@mock.patch("grpc.compute_engine_channel_credentials")
Expand All @@ -661,12 +632,9 @@ def test_create_channel_explicit_default_scopes(

assert channel is grpc_secure_channel.return_value

if grpc_helpers.HAS_GRPC_GCP: # pragma: NO COVER
grpc_secure_channel.assert_called_once_with(target, composite_creds, None)
else:
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)


@mock.patch("grpc.compute_engine_channel_credentials")
Expand All @@ -689,12 +657,9 @@ def test_create_channel_explicit_with_quota_project(

assert channel is grpc_secure_channel.return_value

if grpc_helpers.HAS_GRPC_GCP: # pragma: NO COVER
grpc_secure_channel.assert_called_once_with(target, composite_creds, None)
else:
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)


@mock.patch("grpc.compute_engine_channel_credentials")
Expand All @@ -721,12 +686,9 @@ def test_create_channel_with_credentials_file(

assert channel is grpc_secure_channel.return_value

if grpc_helpers.HAS_GRPC_GCP: # pragma: NO COVER
grpc_secure_channel.assert_called_once_with(target, composite_creds, None)
else:
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)


@mock.patch("grpc.compute_engine_channel_credentials")
Expand Down Expand Up @@ -756,12 +718,9 @@ def test_create_channel_with_credentials_file_and_scopes(

assert channel is grpc_secure_channel.return_value

if grpc_helpers.HAS_GRPC_GCP: # pragma: NO COVER
grpc_secure_channel.assert_called_once_with(target, composite_creds, None)
else:
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)


@mock.patch("grpc.compute_engine_channel_credentials")
Expand Down Expand Up @@ -791,32 +750,11 @@ def test_create_channel_with_credentials_file_and_default_scopes(

assert channel is grpc_secure_channel.return_value

if grpc_helpers.HAS_GRPC_GCP: # pragma: NO COVER
grpc_secure_channel.assert_called_once_with(target, composite_creds, None)
else:
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)


@pytest.mark.skipif(
not grpc_helpers.HAS_GRPC_GCP, reason="grpc_gcp module not available"
)
@mock.patch("grpc_gcp.secure_channel")
def test_create_channel_with_grpc_gcp(grpc_gcp_secure_channel): # pragma: NO COVER
target = "example.com:443"
scopes = ["test_scope"]

credentials = mock.create_autospec(google.auth.credentials.Scoped, instance=True)
credentials.requires_scopes = True

grpc_helpers.create_channel(target, credentials=credentials, scopes=scopes)
grpc_gcp_secure_channel.assert_called()

credentials.with_scopes.assert_called_once_with(scopes, default_scopes=None)
grpc_secure_channel.assert_called_once_with(
target, composite_creds, compression=None
)


@pytest.mark.skipif(grpc_helpers.HAS_GRPC_GCP, reason="grpc_gcp module not available")
@mock.patch("grpc.secure_channel")
def test_create_channel_without_grpc_gcp(grpc_secure_channel):
target = "example.com:443"
Expand Down
Loading