feat: add always_use_jwt_access (#96)

... 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

Author: gcf-owl-bot[bot]

.coveragerc

@@ -2,7 +2,6 @@
 branch = True
 
 [report]
-fail_under = 100
 show_missing = True
 omit =
  google/cloud/trace/__init__.py

google/cloud/trace_v1/services/trace_service/transports/base.py

@@ -24,6 +24,7 @@
 from google.api_core import gapic_v1 # type: ignore
 from google.api_core import retry as retries # type: ignore
 from google.auth import credentials as ga_credentials # type: ignore
+from google.oauth2 import service_account # type: ignore
 
 from google.cloud.trace_v1.types import trace
 from google.protobuf import empty_pb2 # type: ignore
@@ -44,8 +45,6 @@
  except pkg_resources.DistributionNotFound: # pragma: NO COVER
  _GOOGLE_AUTH_VERSION = None
 
-_API_CORE_VERSION = google.api_core.__version__
-
 
 class TraceServiceTransport(abc.ABC):
  """Abstract transport class for TraceService."""
@@ -67,6 +66,7 @@ def __init__(
  scopes: Optional[Sequence[str]] = None,
  quota_project_id: Optional[str] = None,
  client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+ always_use_jwt_access: Optional[bool] = False,
  **kwargs,
  ) -> None:
  """Instantiate the transport.
@@ -90,6 +90,8 @@ def __init__(
  API requests. If ``None``, then default info will be used.
  Generally, you only need to set this if you're developing
  your own client library.
+ always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+ be used for service account credentials.
  """
  # Save the hostname. Default to port 443 (HTTPS) if none is specified.
  if ":" not in host:
@@ -118,13 +120,20 @@ def __init__(
  **scopes_kwargs, quota_project_id=quota_project_id
  )
 
+ # If the credentials is service account credentials, then always try to use self signed JWT.
+ if (
+ always_use_jwt_access
+ and isinstance(credentials, service_account.Credentials)
+ and hasattr(service_account.Credentials, "with_always_use_jwt_access")
+ ):
+ credentials = credentials.with_always_use_jwt_access(True)
+
  # Save the credentials.
  self._credentials = credentials
 
- # TODO(busunkim): These two class methods are in the base transport
+ # TODO(busunkim): This method is in the base transport
  # to avoid duplicating code across the transport classes. These functions
- # should be deleted once the minimum required versions of google-api-core
- # and google-auth are increased.
+ # should be deleted once the minimum required versions of google-auth is increased.
 
  # TODO: Remove this function once google-auth >= 1.25.0 is required
  @classmethod
@@ -145,27 +154,6 @@ def _get_scopes_kwargs(
 
  return scopes_kwargs
 
- # TODO: Remove this function once google-api-core >= 1.26.0 is required
- @classmethod
- def _get_self_signed_jwt_kwargs(
- cls, host: str, scopes: Optional[Sequence[str]]
- ) -> Dict[str, Union[Optional[Sequence[str]], str]]:
- """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version"""
-
- self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {}
-
- if _API_CORE_VERSION and (
- packaging.version.parse(_API_CORE_VERSION)
- >= packaging.version.parse("1.26.0")
- ):
- self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES
- self_signed_jwt_kwargs["scopes"] = scopes
- self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST
- else:
- self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES
-
- return self_signed_jwt_kwargs
-
  def _prep_wrapped_messages(self, client_info):
  # Precompute the wrapped methods.
  self._wrapped_methods = {

google/cloud/trace_v1/services/trace_service/transports/grpc.py

@@ -155,6 +155,7 @@ def __init__(
  scopes=scopes,
  quota_project_id=quota_project_id,
  client_info=client_info,
+ always_use_jwt_access=True,
  )
 
  if not self._grpc_channel:
@@ -210,14 +211,14 @@ def create_channel(
  and ``credentials_file`` are passed.
  """
 
- self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes)
-
  return grpc_helpers.create_channel(
  host,
  credentials=credentials,
  credentials_file=credentials_file,
  quota_project_id=quota_project_id,
- **self_signed_jwt_kwargs,
+ default_scopes=cls.AUTH_SCOPES,
+ scopes=scopes,
+ default_host=cls.DEFAULT_HOST,
  **kwargs,
  )
 

google/cloud/trace_v1/services/trace_service/transports/grpc_asyncio.py

@@ -84,14 +84,14 @@ def create_channel(
  aio.Channel: A gRPC AsyncIO channel object.
  """
 
- self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes)
-
  return grpc_helpers_async.create_channel(
  host,
  credentials=credentials,
  credentials_file=credentials_file,
  quota_project_id=quota_project_id,
- **self_signed_jwt_kwargs,
+ default_scopes=cls.AUTH_SCOPES,
+ scopes=scopes,
+ default_host=cls.DEFAULT_HOST,
  **kwargs,
  )
 
@@ -201,6 +201,7 @@ def __init__(
  scopes=scopes,
  quota_project_id=quota_project_id,
  client_info=client_info,
+ always_use_jwt_access=True,
  )
 
  if not self._grpc_channel:

google/cloud/trace_v2/services/trace_service/transports/base.py

@@ -24,6 +24,7 @@
 from google.api_core import gapic_v1 # type: ignore
 from google.api_core import retry as retries # type: ignore
 from google.auth import credentials as ga_credentials # type: ignore
+from google.oauth2 import service_account # type: ignore
 
 from google.cloud.trace_v2.types import trace
 from google.cloud.trace_v2.types import tracing
@@ -45,8 +46,6 @@
  except pkg_resources.DistributionNotFound: # pragma: NO COVER
  _GOOGLE_AUTH_VERSION = None
 
-_API_CORE_VERSION = google.api_core.__version__
-
 
 class TraceServiceTransport(abc.ABC):
  """Abstract transport class for TraceService."""
@@ -67,6 +66,7 @@ def __init__(
  scopes: Optional[Sequence[str]] = None,
  quota_project_id: Optional[str] = None,
  client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+ always_use_jwt_access: Optional[bool] = False,
  **kwargs,
  ) -> None:
  """Instantiate the transport.
@@ -90,6 +90,8 @@ def __init__(
  API requests. If ``None``, then default info will be used.
  Generally, you only need to set this if you're developing
  your own client library.
+ always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+ be used for service account credentials.
  """
  # Save the hostname. Default to port 443 (HTTPS) if none is specified.
  if ":" not in host:
@@ -118,13 +120,20 @@ def __init__(
  **scopes_kwargs, quota_project_id=quota_project_id
  )
 
+ # If the credentials is service account credentials, then always try to use self signed JWT.
+ if (
+ always_use_jwt_access
+ and isinstance(credentials, service_account.Credentials)
+ and hasattr(service_account.Credentials, "with_always_use_jwt_access")
+ ):
+ credentials = credentials.with_always_use_jwt_access(True)
+
  # Save the credentials.
  self._credentials = credentials
 
- # TODO(busunkim): These two class methods are in the base transport
+ # TODO(busunkim): This method is in the base transport
  # to avoid duplicating code across the transport classes. These functions
- # should be deleted once the minimum required versions of google-api-core
- # and google-auth are increased.
+ # should be deleted once the minimum required versions of google-auth is increased.
 
  # TODO: Remove this function once google-auth >= 1.25.0 is required
  @classmethod
@@ -145,27 +154,6 @@ def _get_scopes_kwargs(
 
  return scopes_kwargs
 
- # TODO: Remove this function once google-api-core >= 1.26.0 is required
- @classmethod
- def _get_self_signed_jwt_kwargs(
- cls, host: str, scopes: Optional[Sequence[str]]
- ) -> Dict[str, Union[Optional[Sequence[str]], str]]:
- """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version"""
-
- self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {}
-
- if _API_CORE_VERSION and (
- packaging.version.parse(_API_CORE_VERSION)
- >= packaging.version.parse("1.26.0")
- ):
- self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES
- self_signed_jwt_kwargs["scopes"] = scopes
- self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST
- else:
- self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES
-
- return self_signed_jwt_kwargs
-
  def _prep_wrapped_messages(self, client_info):
  # Precompute the wrapped methods.
  self._wrapped_methods = {

google/cloud/trace_v2/services/trace_service/transports/grpc.py

@@ -156,6 +156,7 @@ def __init__(
  scopes=scopes,
  quota_project_id=quota_project_id,
  client_info=client_info,
+ always_use_jwt_access=True,
  )
 
  if not self._grpc_channel:
@@ -211,14 +212,14 @@ def create_channel(
  and ``credentials_file`` are passed.
  """
 
- self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes)
-
  return grpc_helpers.create_channel(
  host,
  credentials=credentials,
  credentials_file=credentials_file,
  quota_project_id=quota_project_id,
- **self_signed_jwt_kwargs,
+ default_scopes=cls.AUTH_SCOPES,
+ scopes=scopes,
+ default_host=cls.DEFAULT_HOST,
  **kwargs,
  )
 

google/cloud/trace_v2/services/trace_service/transports/grpc_asyncio.py

@@ -85,14 +85,14 @@ def create_channel(
  aio.Channel: A gRPC AsyncIO channel object.
  """
 
- self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes)
-
  return grpc_helpers_async.create_channel(
  host,
  credentials=credentials,
  credentials_file=credentials_file,
  quota_project_id=quota_project_id,
- **self_signed_jwt_kwargs,
+ default_scopes=cls.AUTH_SCOPES,
+ scopes=scopes,
+ default_host=cls.DEFAULT_HOST,
  **kwargs,
  )
 
@@ -202,6 +202,7 @@ def __init__(
  scopes=scopes,
  quota_project_id=quota_project_id,
  client_info=client_info,
+ always_use_jwt_access=True,
  )
 
  if not self._grpc_channel:

setup.py

@@ -29,7 +29,7 @@
 # 'Development Status :: 5 - Production/Stable'
 release_status = "Development Status :: 5 - Production/Stable"
 dependencies = [
- "google-api-core[grpc] >= 1.22.2, < 2.0.0dev",
+ "google-api-core[grpc] >= 1.26.0, <2.0.0dev",
  "proto-plus >= 1.4.0",
  "packaging >= 14.3",
 ]

testing/constraints-3.6.txt

@@ -5,7 +5,7 @@
 #
 # e.g., if setup.py has "foo >= 1.14.0, < 2.0.0dev",
 # Then this file should have foo==1.14.0
-google-api-core==1.22.2
+google-api-core==1.26.0
 proto-plus==1.4.0
 packaging==14.3
 google-auth==1.24.0 # TODO: remove when google-auth>=1.25.0 si transitively required through google-api-core