Skip to content
This repository was archived by the owner on Sep 14, 2023. It is now read-only.

Commit 9533d55

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: add always_use_jwt_access (#52)
... 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: https://github.com/googleapis/googleapis-gen/commit/27e4c88b4048e5f56508d4e1aa417d60a3380892
1 parent 7d07175 commit 9533d55

7 files changed

Lines changed: 39 additions & 124 deletions

File tree

‎.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/assuredworkloads/__init__.py

‎google/cloud/assuredworkloads_v1beta1/services/assured_workloads_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.assuredworkloads_v1beta1.types import assuredworkloads_v1beta1
3031
from google.longrunning import operations_pb2 # type: ignore
@@ -48,8 +49,6 @@
4849
except pkg_resources.DistributionNotFound: # pragma: NO COVER
4950
_GOOGLE_AUTH_VERSION = None
5051

51-
_API_CORE_VERSION = google.api_core.__version__
52-
5352

5453
class AssuredWorkloadsServiceTransport(abc.ABC):
5554
"""Abstract transport class for AssuredWorkloadsService."""
@@ -67,6 +66,7 @@ def __init__(
6766
scopes: Optional[Sequence[str]] = None,
6867
quota_project_id: Optional[str] = None,
6968
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
69+
always_use_jwt_access: Optional[bool] = False,
7070
**kwargs,
7171
) -> None:
7272
"""Instantiate the transport.
@@ -90,6 +90,8 @@ def __init__(
9090
API requests. If ``None``, then default info will be used.
9191
Generally, you only need to set this if you're developing
9292
your own client library.
93+
always_use_jwt_access (Optional[bool]): Whether self signed JWT should
94+
be used for service account credentials.
9395
"""
9496
# Save the hostname. Default to port 443 (HTTPS) if none is specified.
9597
if ":" not in host:
@@ -118,13 +120,20 @@ def __init__(
118120
**scopes_kwargs, quota_project_id=quota_project_id
119121
)
120122

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

124-
# TODO(busunkim): These two class methods are in the base transport
134+
# TODO(busunkim): This method is in the base transport
125135
# to avoid duplicating code across the transport classes. These functions
126-
# should be deleted once the minimum required versions of google-api-core
127-
# and google-auth are increased.
136+
# should be deleted once the minimum required versions of google-auth is increased.
128137

129138
# TODO: Remove this function once google-auth >= 1.25.0 is required
130139
@classmethod
@@ -145,27 +154,6 @@ def _get_scopes_kwargs(
145154

146155
return scopes_kwargs
147156

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

‎google/cloud/assuredworkloads_v1beta1/services/assured_workloads_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

‎google/cloud/assuredworkloads_v1beta1/services/assured_workloads_service/transports/grpc_asyncio.py‎

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

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

@@ -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:

‎setup.py‎

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

‎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.4.0
1010
packaging==14.3

‎tests/unit/gapic/assuredworkloads_v1beta1/test_assured_workloads_service.py‎

Lines changed: 15 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,6 @@
4646
from google.cloud.assuredworkloads_v1beta1.services.assured_workloads_service import (
4747
transports,
4848
)
49-
from google.cloud.assuredworkloads_v1beta1.services.assured_workloads_service.transports.base import (
50-
_API_CORE_VERSION,
51-
)
5249
from google.cloud.assuredworkloads_v1beta1.services.assured_workloads_service.transports.base import (
5350
_GOOGLE_AUTH_VERSION,
5451
)
@@ -61,8 +58,9 @@
6158
import google.auth
6259

6360

64-
# TODO(busunkim): Once google-api-core >= 1.26.0 is required:
65-
# - Delete all the api-core and auth "less than" test cases
61+
# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively
62+
# through google-api-core:
63+
# - Delete the auth "less than" test cases
6664
# - Delete these pytest markers (Make the "greater than or equal to" tests the default).
6765
requires_google_auth_lt_1_25_0 = pytest.mark.skipif(
6866
packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"),
@@ -73,16 +71,6 @@
7371
reason="This test requires google-auth >= 1.25.0",
7472
)
7573

76-
requires_api_core_lt_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-
81-
requires_api_core_gte_1_26_0 = pytest.mark.skipif(
82-
packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"),
83-
reason="This test requires google-api-core >= 1.26.0",
84-
)
85-
8674

8775
def client_cert_source_callback():
8876
return b"cert bytes", b"key bytes"
@@ -146,6 +134,18 @@ def test_assured_workloads_service_client_from_service_account_info(client_class
146134
assert client.transport._host == "assuredworkloads.googleapis.com:443"
147135

148136

137+
@pytest.mark.parametrize(
138+
"client_class", [AssuredWorkloadsServiceClient, AssuredWorkloadsServiceAsyncClient,]
139+
)
140+
def test_assured_workloads_service_client_service_account_always_use_jwt(client_class):
141+
with mock.patch.object(
142+
service_account.Credentials, "with_always_use_jwt_access", create=True
143+
) as use_jwt:
144+
creds = service_account.Credentials(None, None, None)
145+
client = client_class(credentials=creds)
146+
use_jwt.assert_called_with(True)
147+
148+
149149
@pytest.mark.parametrize(
150150
"client_class", [AssuredWorkloadsServiceClient, AssuredWorkloadsServiceAsyncClient,]
151151
)
@@ -2054,7 +2054,6 @@ def test_assured_workloads_service_transport_auth_adc_old_google_auth(transport_
20542054
(transports.AssuredWorkloadsServiceGrpcAsyncIOTransport, grpc_helpers_async),
20552055
],
20562056
)
2057-
@requires_api_core_gte_1_26_0
20582057
def test_assured_workloads_service_transport_create_channel(
20592058
transport_class, grpc_helpers
20602059
):
@@ -2085,79 +2084,6 @@ def test_assured_workloads_service_transport_create_channel(
20852084
)
20862085

20872086

2088-
@pytest.mark.parametrize(
2089-
"transport_class,grpc_helpers",
2090-
[
2091-
(transports.AssuredWorkloadsServiceGrpcTransport, grpc_helpers),
2092-
(transports.AssuredWorkloadsServiceGrpcAsyncIOTransport, grpc_helpers_async),
2093-
],
2094-
)
2095-
@requires_api_core_lt_1_26_0
2096-
def test_assured_workloads_service_transport_create_channel_old_api_core(
2097-
transport_class, grpc_helpers
2098-
):
2099-
# If credentials and host are not provided, the transport class should use
2100-
# ADC credentials.
2101-
with mock.patch.object(
2102-
google.auth, "default", autospec=True
2103-
) as adc, mock.patch.object(
2104-
grpc_helpers, "create_channel", autospec=True
2105-
) as create_channel:
2106-
creds = ga_credentials.AnonymousCredentials()
2107-
adc.return_value = (creds, None)
2108-
transport_class(quota_project_id="octopus")
2109-
2110-
create_channel.assert_called_with(
2111-
"assuredworkloads.googleapis.com:443",
2112-
credentials=creds,
2113-
credentials_file=None,
2114-
quota_project_id="octopus",
2115-
scopes=("https://www.googleapis.com/auth/cloud-platform",),
2116-
ssl_credentials=None,
2117-
options=[
2118-
("grpc.max_send_message_length", -1),
2119-
("grpc.max_receive_message_length", -1),
2120-
],
2121-
)
2122-
2123-
2124-
@pytest.mark.parametrize(
2125-
"transport_class,grpc_helpers",
2126-
[
2127-
(transports.AssuredWorkloadsServiceGrpcTransport, grpc_helpers),
2128-
(transports.AssuredWorkloadsServiceGrpcAsyncIOTransport, grpc_helpers_async),
2129-
],
2130-
)
2131-
@requires_api_core_lt_1_26_0
2132-
def test_assured_workloads_service_transport_create_channel_user_scopes(
2133-
transport_class, grpc_helpers
2134-
):
2135-
# If credentials and host are not provided, the transport class should use
2136-
# ADC credentials.
2137-
with mock.patch.object(
2138-
google.auth, "default", autospec=True
2139-
) as adc, mock.patch.object(
2140-
grpc_helpers, "create_channel", autospec=True
2141-
) as create_channel:
2142-
creds = ga_credentials.AnonymousCredentials()
2143-
adc.return_value = (creds, None)
2144-
2145-
transport_class(quota_project_id="octopus", scopes=["1", "2"])
2146-
2147-
create_channel.assert_called_with(
2148-
"assuredworkloads.googleapis.com:443",
2149-
credentials=creds,
2150-
credentials_file=None,
2151-
quota_project_id="octopus",
2152-
scopes=["1", "2"],
2153-
ssl_credentials=None,
2154-
options=[
2155-
("grpc.max_send_message_length", -1),
2156-
("grpc.max_receive_message_length", -1),
2157-
],
2158-
)
2159-
2160-
21612087
@pytest.mark.parametrize(
21622088
"transport_class",
21632089
[

0 commit comments

Comments
 (0)