Skip to content

Commit e97c6dd

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: add always_use_jwt_access (#88)
... chore: update gapic-generator-ruby to the latest commit chore: release gapic-generator-typescript 1.5.0 Committer: @miraleung PiperOrigin-RevId: 380641501 Source-Link: googleapis/googleapis@076f7e9 Source-Link: googleapis/googleapis-gen@27e4c88
1 parent 4873330 commit e97c6dd

6 files changed

Lines changed: 38 additions & 126 deletions

File tree

‎packages/google-cloud-bigquery-connection/.coveragerc‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
branch = True
33

44
[report]
5-
fail_under = 100
65
show_missing = True
76
omit =
87
google/cloud/bigquery_connection/__init__.py

‎packages/google-cloud-bigquery-connection/google/cloud/bigquery_connection_v1/services/connection_service/transports/base.py‎

Lines changed: 14 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
from google.api_core import gapic_v1 # type: ignore
2525
from google.api_core import retry as retries # type: ignore
2626
from google.auth import credentials as ga_credentials # type: ignore
27+
from google.oauth2 import service_account # type: ignore
2728

2829
from google.cloud.bigquery_connection_v1.types import connection
2930
from google.cloud.bigquery_connection_v1.types import connection as gcbc_connection
@@ -49,8 +50,6 @@
4950
except pkg_resources.DistributionNotFound: # pragma: NO COVER
5051
_GOOGLE_AUTH_VERSION = None
5152

52-
_API_CORE_VERSION = google.api_core.__version__
53-
5453

5554
class ConnectionServiceTransport(abc.ABC):
5655
"""Abstract transport class for ConnectionService."""
@@ -71,6 +70,7 @@ def __init__(
7170
scopes: Optional[Sequence[str]] = None,
7271
quota_project_id: Optional[str] = None,
7372
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
73+
always_use_jwt_access: Optional[bool] = False,
7474
**kwargs,
7575
) -> None:
7676
"""Instantiate the transport.
@@ -94,6 +94,8 @@ def __init__(
9494
API requests. If ``None``, then default info will be used.
9595
Generally, you only need to set this if you're developing
9696
your own client library.
97+
always_use_jwt_access (Optional[bool]): Whether self signed JWT should
98+
be used for service account credentials.
9799
"""
98100
# Save the hostname. Default to port 443 (HTTPS) if none is specified.
99101
if ":" not in host:
@@ -122,13 +124,20 @@ def __init__(
122124
**scopes_kwargs, quota_project_id=quota_project_id
123125
)
124126

127+
# If the credentials is service account credentials, then always try to use self signed JWT.
128+
if (
129+
always_use_jwt_access
130+
and isinstance(credentials, service_account.Credentials)
131+
and hasattr(service_account.Credentials, "with_always_use_jwt_access")
132+
):
133+
credentials = credentials.with_always_use_jwt_access(True)
134+
125135
# Save the credentials.
126136
self._credentials = credentials
127137

128-
# TODO(busunkim): These two class methods are in the base transport
138+
# TODO(busunkim): This method is in the base transport
129139
# to avoid duplicating code across the transport classes. These functions
130-
# should be deleted once the minimum required versions of google-api-core
131-
# and google-auth are increased.
140+
# should be deleted once the minimum required versions of google-auth is increased.
132141

133142
# TODO: Remove this function once google-auth >= 1.25.0 is required
134143
@classmethod
@@ -149,27 +158,6 @@ def _get_scopes_kwargs(
149158

150159
return scopes_kwargs
151160

152-
# TODO: Remove this function once google-api-core >= 1.26.0 is required
153-
@classmethod
154-
def _get_self_signed_jwt_kwargs(
155-
cls, host: str, scopes: Optional[Sequence[str]]
156-
) -> Dict[str, Union[Optional[Sequence[str]], str]]:
157-
"""Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version"""
158-
159-
self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {}
160-
161-
if _API_CORE_VERSION and (
162-
packaging.version.parse(_API_CORE_VERSION)
163-
>= packaging.version.parse("1.26.0")
164-
):
165-
self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES
166-
self_signed_jwt_kwargs["scopes"] = scopes
167-
self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST
168-
else:
169-
self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES
170-
171-
return self_signed_jwt_kwargs
172-
173161
def _prep_wrapped_messages(self, client_info):
174162
# Precompute the wrapped methods.
175163
self._wrapped_methods = {

‎packages/google-cloud-bigquery-connection/google/cloud/bigquery_connection_v1/services/connection_service/transports/grpc.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ def __init__(
153153
scopes=scopes,
154154
quota_project_id=quota_project_id,
155155
client_info=client_info,
156+
always_use_jwt_access=True,
156157
)
157158

158159
if not self._grpc_channel:
@@ -208,14 +209,14 @@ def create_channel(
208209
and ``credentials_file`` are passed.
209210
"""
210211

211-
self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes)
212-
213212
return grpc_helpers.create_channel(
214213
host,
215214
credentials=credentials,
216215
credentials_file=credentials_file,
217216
quota_project_id=quota_project_id,
218-
**self_signed_jwt_kwargs,
217+
default_scopes=cls.AUTH_SCOPES,
218+
scopes=scopes,
219+
default_host=cls.DEFAULT_HOST,
219220
**kwargs,
220221
)
221222

‎packages/google-cloud-bigquery-connection/google/cloud/bigquery_connection_v1/services/connection_service/transports/grpc_asyncio.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,14 @@ def create_channel(
8282
aio.Channel: A gRPC AsyncIO channel object.
8383
"""
8484

85-
self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes)
86-
8785
return grpc_helpers_async.create_channel(
8886
host,
8987
credentials=credentials,
9088
credentials_file=credentials_file,
9189
quota_project_id=quota_project_id,
92-
**self_signed_jwt_kwargs,
90+
default_scopes=cls.AUTH_SCOPES,
91+
scopes=scopes,
92+
default_host=cls.DEFAULT_HOST,
9393
**kwargs,
9494
)
9595

@@ -199,6 +199,7 @@ def __init__(
199199
scopes=scopes,
200200
quota_project_id=quota_project_id,
201201
client_info=client_info,
202+
always_use_jwt_access=True,
202203
)
203204

204205
if not self._grpc_channel:

‎packages/google-cloud-bigquery-connection/testing/constraints-3.6.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#
66
# e.g., if setup.py has "foo >= 1.14.0, < 2.0.0dev",
77
# Then this file should have foo==1.14.0
8-
google-api-core==1.22.2
8+
google-api-core==1.26.0
99
proto-plus==1.4.0
1010
grpc-google-iam-v1==0.12.3
1111
packaging==14.3

‎packages/google-cloud-bigquery-connection/tests/unit/gapic/bigquery_connection_v1/test_connection_service.py‎

Lines changed: 15 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,6 @@
3939
)
4040
from google.cloud.bigquery_connection_v1.services.connection_service import pagers
4141
from google.cloud.bigquery_connection_v1.services.connection_service import transports
42-
from google.cloud.bigquery_connection_v1.services.connection_service.transports.base import (
43-
_API_CORE_VERSION,
44-
)
4542
from google.cloud.bigquery_connection_v1.services.connection_service.transports.base import (
4643
_GOOGLE_AUTH_VERSION,
4744
)
@@ -56,8 +53,9 @@
5653
import google.auth
5754

5855

59-
# TODO(busunkim): Once google-api-core >= 1.26.0 is required:
60-
# - Delete all the api-core and auth "less than" test cases
56+
# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively
57+
# through google-api-core:
58+
# - Delete the auth "less than" test cases
6159
# - Delete these pytest markers (Make the "greater than or equal to" tests the default).
6260
requires_google_auth_lt_1_25_0 = pytest.mark.skipif(
6361
packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"),
@@ -68,16 +66,6 @@
6866
reason="This test requires google-auth >= 1.25.0",
6967
)
7068

71-
requires_api_core_lt_1_26_0 = pytest.mark.skipif(
72-
packaging.version.parse(_API_CORE_VERSION) >= packaging.version.parse("1.26.0"),
73-
reason="This test requires google-api-core < 1.26.0",
74-
)
75-
76-
requires_api_core_gte_1_26_0 = pytest.mark.skipif(
77-
packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"),
78-
reason="This test requires google-api-core >= 1.26.0",
79-
)
80-
8169

8270
def client_cert_source_callback():
8371
return b"cert bytes", b"key bytes"
@@ -141,6 +129,18 @@ def test_connection_service_client_from_service_account_info(client_class):
141129
assert client.transport._host == "bigqueryconnection.googleapis.com:443"
142130

143131

132+
@pytest.mark.parametrize(
133+
"client_class", [ConnectionServiceClient, ConnectionServiceAsyncClient,]
134+
)
135+
def test_connection_service_client_service_account_always_use_jwt(client_class):
136+
with mock.patch.object(
137+
service_account.Credentials, "with_always_use_jwt_access", create=True
138+
) as use_jwt:
139+
creds = service_account.Credentials(None, None, None)
140+
client = client_class(credentials=creds)
141+
use_jwt.assert_called_with(True)
142+
143+
144144
@pytest.mark.parametrize(
145145
"client_class", [ConnectionServiceClient, ConnectionServiceAsyncClient,]
146146
)
@@ -2729,7 +2729,6 @@ def test_connection_service_transport_auth_adc_old_google_auth(transport_class):
27292729
(transports.ConnectionServiceGrpcAsyncIOTransport, grpc_helpers_async),
27302730
],
27312731
)
2732-
@requires_api_core_gte_1_26_0
27332732
def test_connection_service_transport_create_channel(transport_class, grpc_helpers):
27342733
# If credentials and host are not provided, the transport class should use
27352734
# ADC credentials.
@@ -2761,82 +2760,6 @@ def test_connection_service_transport_create_channel(transport_class, grpc_helpe
27612760
)
27622761

27632762

2764-
@pytest.mark.parametrize(
2765-
"transport_class,grpc_helpers",
2766-
[
2767-
(transports.ConnectionServiceGrpcTransport, grpc_helpers),
2768-
(transports.ConnectionServiceGrpcAsyncIOTransport, grpc_helpers_async),
2769-
],
2770-
)
2771-
@requires_api_core_lt_1_26_0
2772-
def test_connection_service_transport_create_channel_old_api_core(
2773-
transport_class, grpc_helpers
2774-
):
2775-
# If credentials and host are not provided, the transport class should use
2776-
# ADC credentials.
2777-
with mock.patch.object(
2778-
google.auth, "default", autospec=True
2779-
) as adc, mock.patch.object(
2780-
grpc_helpers, "create_channel", autospec=True
2781-
) as create_channel:
2782-
creds = ga_credentials.AnonymousCredentials()
2783-
adc.return_value = (creds, None)
2784-
transport_class(quota_project_id="octopus")
2785-
2786-
create_channel.assert_called_with(
2787-
"bigqueryconnection.googleapis.com:443",
2788-
credentials=creds,
2789-
credentials_file=None,
2790-
quota_project_id="octopus",
2791-
scopes=(
2792-
"https://www.googleapis.com/auth/bigquery",
2793-
"https://www.googleapis.com/auth/cloud-platform",
2794-
),
2795-
ssl_credentials=None,
2796-
options=[
2797-
("grpc.max_send_message_length", -1),
2798-
("grpc.max_receive_message_length", -1),
2799-
],
2800-
)
2801-
2802-
2803-
@pytest.mark.parametrize(
2804-
"transport_class,grpc_helpers",
2805-
[
2806-
(transports.ConnectionServiceGrpcTransport, grpc_helpers),
2807-
(transports.ConnectionServiceGrpcAsyncIOTransport, grpc_helpers_async),
2808-
],
2809-
)
2810-
@requires_api_core_lt_1_26_0
2811-
def test_connection_service_transport_create_channel_user_scopes(
2812-
transport_class, grpc_helpers
2813-
):
2814-
# If credentials and host are not provided, the transport class should use
2815-
# ADC credentials.
2816-
with mock.patch.object(
2817-
google.auth, "default", autospec=True
2818-
) as adc, mock.patch.object(
2819-
grpc_helpers, "create_channel", autospec=True
2820-
) as create_channel:
2821-
creds = ga_credentials.AnonymousCredentials()
2822-
adc.return_value = (creds, None)
2823-
2824-
transport_class(quota_project_id="octopus", scopes=["1", "2"])
2825-
2826-
create_channel.assert_called_with(
2827-
"bigqueryconnection.googleapis.com:443",
2828-
credentials=creds,
2829-
credentials_file=None,
2830-
quota_project_id="octopus",
2831-
scopes=["1", "2"],
2832-
ssl_credentials=None,
2833-
options=[
2834-
("grpc.max_send_message_length", -1),
2835-
("grpc.max_receive_message_length", -1),
2836-
],
2837-
)
2838-
2839-
28402763
@pytest.mark.parametrize(
28412764
"transport_class",
28422765
[

0 commit comments

Comments
 (0)