Skip to content

Commit 1c2d8a7

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: add always_use_jwt_access (#56)
... 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 6b44cf2 commit 1c2d8a7

7 files changed

Lines changed: 39 additions & 124 deletions

File tree

‎packages/google-cloud-notebooks/.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/notebooks/__init__.py

‎packages/google-cloud-notebooks/google/cloud/notebooks_v1beta1/services/notebook_service/transports/base.py‎

Lines changed: 14 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
from google.api_core import retry as retries # type: ignore
2626
from google.api_core import operations_v1 # type: ignore
2727
from google.auth import credentials as ga_credentials # type: ignore
28+
from google.oauth2 import service_account # type: ignore
2829

2930
from google.cloud.notebooks_v1beta1.types import environment
3031
from google.cloud.notebooks_v1beta1.types import instance
@@ -47,8 +48,6 @@
4748
except pkg_resources.DistributionNotFound: # pragma: NO COVER
4849
_GOOGLE_AUTH_VERSION = None
4950

50-
_API_CORE_VERSION = google.api_core.__version__
51-
5251

5352
class NotebookServiceTransport(abc.ABC):
5453
"""Abstract transport class for NotebookService."""
@@ -66,6 +65,7 @@ def __init__(
6665
scopes: Optional[Sequence[str]] = None,
6766
quota_project_id: Optional[str] = None,
6867
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
68+
always_use_jwt_access: Optional[bool] = False,
6969
**kwargs,
7070
) -> None:
7171
"""Instantiate the transport.
@@ -89,6 +89,8 @@ def __init__(
8989
API requests. If ``None``, then default info will be used.
9090
Generally, you only need to set this if you're developing
9191
your own client library.
92+
always_use_jwt_access (Optional[bool]): Whether self signed JWT should
93+
be used for service account credentials.
9294
"""
9395
# Save the hostname. Default to port 443 (HTTPS) if none is specified.
9496
if ":" not in host:
@@ -117,13 +119,20 @@ def __init__(
117119
**scopes_kwargs, quota_project_id=quota_project_id
118120
)
119121

122+
# If the credentials is service account credentials, then always try to use self signed JWT.
123+
if (
124+
always_use_jwt_access
125+
and isinstance(credentials, service_account.Credentials)
126+
and hasattr(service_account.Credentials, "with_always_use_jwt_access")
127+
):
128+
credentials = credentials.with_always_use_jwt_access(True)
129+
120130
# Save the credentials.
121131
self._credentials = credentials
122132

123-
# TODO(busunkim): These two class methods are in the base transport
133+
# TODO(busunkim): This method is in the base transport
124134
# to avoid duplicating code across the transport classes. These functions
125-
# should be deleted once the minimum required versions of google-api-core
126-
# and google-auth are increased.
135+
# should be deleted once the minimum required versions of google-auth is increased.
127136

128137
# TODO: Remove this function once google-auth >= 1.25.0 is required
129138
@classmethod
@@ -144,27 +153,6 @@ def _get_scopes_kwargs(
144153

145154
return scopes_kwargs
146155

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

‎packages/google-cloud-notebooks/google/cloud/notebooks_v1beta1/services/notebook_service/transports/grpc.py‎

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

159160
if not self._grpc_channel:
@@ -209,14 +210,14 @@ def create_channel(
209210
and ``credentials_file`` are passed.
210211
"""
211212

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

‎packages/google-cloud-notebooks/google/cloud/notebooks_v1beta1/services/notebook_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

@@ -200,6 +200,7 @@ def __init__(
200200
scopes=scopes,
201201
quota_project_id=quota_project_id,
202202
client_info=client_info,
203+
always_use_jwt_access=True,
203204
)
204205

205206
if not self._grpc_channel:

‎packages/google-cloud-notebooks/setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
platforms="Posix; MacOS X; Windows",
4141
include_package_data=True,
4242
install_requires=(
43-
"google-api-core[grpc] >= 1.22.2, < 2.0.0dev",
43+
"google-api-core[grpc] >= 1.26.0, <2.0.0dev",
4444
"proto-plus >= 1.1.0",
4545
"packaging >= 14.3",
4646
),

‎packages/google-cloud-notebooks/testing/constraints-3.6.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
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.1.0
1010
packaging==14.3

‎packages/google-cloud-notebooks/tests/unit/gapic/notebooks_v1beta1/test_notebook_service.py‎

Lines changed: 15 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,6 @@
4242
)
4343
from google.cloud.notebooks_v1beta1.services.notebook_service import pagers
4444
from google.cloud.notebooks_v1beta1.services.notebook_service import transports
45-
from google.cloud.notebooks_v1beta1.services.notebook_service.transports.base import (
46-
_API_CORE_VERSION,
47-
)
4845
from google.cloud.notebooks_v1beta1.services.notebook_service.transports.base import (
4946
_GOOGLE_AUTH_VERSION,
5047
)
@@ -57,8 +54,9 @@
5754
import google.auth
5855

5956

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

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

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

143131

132+
@pytest.mark.parametrize(
133+
"client_class", [NotebookServiceClient, NotebookServiceAsyncClient,]
134+
)
135+
def test_notebook_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", [NotebookServiceClient, NotebookServiceAsyncClient,]
146146
)
@@ -3780,7 +3780,6 @@ def test_notebook_service_transport_auth_adc_old_google_auth(transport_class):
37803780
(transports.NotebookServiceGrpcAsyncIOTransport, grpc_helpers_async),
37813781
],
37823782
)
3783-
@requires_api_core_gte_1_26_0
37843783
def test_notebook_service_transport_create_channel(transport_class, grpc_helpers):
37853784
# If credentials and host are not provided, the transport class should use
37863785
# ADC credentials.
@@ -3809,79 +3808,6 @@ def test_notebook_service_transport_create_channel(transport_class, grpc_helpers
38093808
)
38103809

38113810

3812-
@pytest.mark.parametrize(
3813-
"transport_class,grpc_helpers",
3814-
[
3815-
(transports.NotebookServiceGrpcTransport, grpc_helpers),
3816-
(transports.NotebookServiceGrpcAsyncIOTransport, grpc_helpers_async),
3817-
],
3818-
)
3819-
@requires_api_core_lt_1_26_0
3820-
def test_notebook_service_transport_create_channel_old_api_core(
3821-
transport_class, grpc_helpers
3822-
):
3823-
# If credentials and host are not provided, the transport class should use
3824-
# ADC credentials.
3825-
with mock.patch.object(
3826-
google.auth, "default", autospec=True
3827-
) as adc, mock.patch.object(
3828-
grpc_helpers, "create_channel", autospec=True
3829-
) as create_channel:
3830-
creds = ga_credentials.AnonymousCredentials()
3831-
adc.return_value = (creds, None)
3832-
transport_class(quota_project_id="octopus")
3833-
3834-
create_channel.assert_called_with(
3835-
"notebooks.googleapis.com:443",
3836-
credentials=creds,
3837-
credentials_file=None,
3838-
quota_project_id="octopus",
3839-
scopes=("https://www.googleapis.com/auth/cloud-platform",),
3840-
ssl_credentials=None,
3841-
options=[
3842-
("grpc.max_send_message_length", -1),
3843-
("grpc.max_receive_message_length", -1),
3844-
],
3845-
)
3846-
3847-
3848-
@pytest.mark.parametrize(
3849-
"transport_class,grpc_helpers",
3850-
[
3851-
(transports.NotebookServiceGrpcTransport, grpc_helpers),
3852-
(transports.NotebookServiceGrpcAsyncIOTransport, grpc_helpers_async),
3853-
],
3854-
)
3855-
@requires_api_core_lt_1_26_0
3856-
def test_notebook_service_transport_create_channel_user_scopes(
3857-
transport_class, grpc_helpers
3858-
):
3859-
# If credentials and host are not provided, the transport class should use
3860-
# ADC credentials.
3861-
with mock.patch.object(
3862-
google.auth, "default", autospec=True
3863-
) as adc, mock.patch.object(
3864-
grpc_helpers, "create_channel", autospec=True
3865-
) as create_channel:
3866-
creds = ga_credentials.AnonymousCredentials()
3867-
adc.return_value = (creds, None)
3868-
3869-
transport_class(quota_project_id="octopus", scopes=["1", "2"])
3870-
3871-
create_channel.assert_called_with(
3872-
"notebooks.googleapis.com:443",
3873-
credentials=creds,
3874-
credentials_file=None,
3875-
quota_project_id="octopus",
3876-
scopes=["1", "2"],
3877-
ssl_credentials=None,
3878-
options=[
3879-
("grpc.max_send_message_length", -1),
3880-
("grpc.max_receive_message_length", -1),
3881-
],
3882-
)
3883-
3884-
38853811
@pytest.mark.parametrize(
38863812
"transport_class",
38873813
[

0 commit comments

Comments
 (0)