feat: add context manager support in client (#131)

gcf-owl-bot[bot] · web-flow · commit eb9fc8b1a324 · 2021-10-07T00:42:12.000Z
- [ ] Regenerate this pull request now. chore: fix docstring for first attribute of protos committer: @busunkim96 PiperOrigin-RevId: 401271153 Source-Link: googleapis/googleapis@787f8c9 Source-Link: https://github.com/googleapis/googleapis-gen/commit/81decffe9fc72396a8153e756d1d67a6eecfd620 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODFkZWNmZmU5ZmM3MjM5NmE4MTUzZTc1NmQxZDY3YTZlZWNmZDYyMCJ9
diff --git a/google/cloud/security/privateca_v1/services/certificate_authority_service/async_client.py b/google/cloud/security/privateca_v1/services/certificate_authority_service/async_client.py
@@ -2789,6 +2789,12 @@ async def update_certificate_template(
         # Done; return the response.
         return response
 
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, exc_type, exc, tb):
+        await self.transport.close()
+
 
 try:
     DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
diff --git a/google/cloud/security/privateca_v1/services/certificate_authority_service/client.py b/google/cloud/security/privateca_v1/services/certificate_authority_service/client.py
@@ -450,10 +450,7 @@ def __init__(
                 client_cert_source_for_mtls=client_cert_source_func,
                 quota_project_id=client_options.quota_project_id,
                 client_info=client_info,
-                always_use_jwt_access=(
-                    Transport == type(self).get_transport_class("grpc")
-                    or Transport == type(self).get_transport_class("grpc_asyncio")
-                ),
+                always_use_jwt_access=True,
             )
 
     def create_certificate(
@@ -3075,6 +3072,19 @@ def update_certificate_template(
         # Done; return the response.
         return response
 
+    def __enter__(self):
+        return self
+
+    def __exit__(self, type, value, traceback):
+        """Releases underlying transport's resources.
+
+        .. warning::
+            ONLY use as a context manager if the transport is NOT shared
+            with other clients! Exiting the with block will CLOSE the transport
+            and may cause errors in other clients!
+        """
+        self.transport.close()
+
 
 try:
     DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
diff --git a/google/cloud/security/privateca_v1/services/certificate_authority_service/transports/base.py b/google/cloud/security/privateca_v1/services/certificate_authority_service/transports/base.py
@@ -282,6 +282,15 @@ def _prep_wrapped_messages(self, client_info):
             ),
         }
 
+    def close(self):
+        """Closes resources associated with the transport.
+
+       .. warning::
+            Only call this method if the transport is NOT shared
+            with other clients - this may cause errors in other clients!
+        """
+        raise NotImplementedError()
+
     @property
     def operations_client(self) -> operations_v1.OperationsClient:
         """Return the client designed to process long-running operations."""
diff --git a/google/cloud/security/privateca_v1/services/certificate_authority_service/transports/grpc.py b/google/cloud/security/privateca_v1/services/certificate_authority_service/transports/grpc.py
@@ -1103,5 +1103,8 @@ def update_certificate_template(
             )
         return self._stubs["update_certificate_template"]
 
+    def close(self):
+        self.grpc_channel.close()
+
 
 __all__ = ("CertificateAuthorityServiceGrpcTransport",)
diff --git a/google/cloud/security/privateca_v1/services/certificate_authority_service/transports/grpc_asyncio.py b/google/cloud/security/privateca_v1/services/certificate_authority_service/transports/grpc_asyncio.py
@@ -1128,5 +1128,8 @@ def update_certificate_template(
             )
         return self._stubs["update_certificate_template"]
 
+    def close(self):
+        return self.grpc_channel.close()
+
 
 __all__ = ("CertificateAuthorityServiceGrpcAsyncIOTransport",)
diff --git a/google/cloud/security/privateca_v1/types/resources.py b/google/cloud/security/privateca_v1/types/resources.py
@@ -904,6 +904,7 @@ class X509Parameters(proto.Message):
 
     class CaOptions(proto.Message):
         r"""Describes values that are relevant in a CA certificate.
+
         Attributes:
             is_ca (bool):
                 Optional. Refers to the "CA" X.509 extension,
@@ -1141,6 +1142,7 @@ class KeyId(proto.Message):
 
     class CertificateFingerprint(proto.Message):
         r"""A group of fingerprints for the x509 certificate.
+
         Attributes:
             sha256_hash (str):
                 The SHA 256 hash, encoded in hexadecimal, of
diff --git a/google/cloud/security/privateca_v1/types/service.py b/google/cloud/security/privateca_v1/types/service.py
@@ -872,6 +872,7 @@ class FetchCaCertsResponse(proto.Message):
 
     class CertChain(proto.Message):
         r"""
+
         Attributes:
             certificates (Sequence[str]):
                 The certificates that form the CA chain, from
@@ -1290,6 +1291,7 @@ class UpdateCertificateTemplateRequest(proto.Message):
 
 class OperationMetadata(proto.Message):
     r"""Represents the metadata of the long-running operation.
+
     Attributes:
         create_time (google.protobuf.timestamp_pb2.Timestamp):
             Output only. The time the operation was
diff --git a/google/cloud/security/privateca_v1beta1/services/certificate_authority_service/async_client.py b/google/cloud/security/privateca_v1beta1/services/certificate_authority_service/async_client.py
@@ -1943,6 +1943,12 @@ async def list_reusable_configs(
         # Done; return the response.
         return response
 
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, exc_type, exc, tb):
+        await self.transport.close()
+
 
 try:
     DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
diff --git a/google/cloud/security/privateca_v1beta1/services/certificate_authority_service/client.py b/google/cloud/security/privateca_v1beta1/services/certificate_authority_service/client.py
@@ -426,10 +426,7 @@ def __init__(
                 client_cert_source_for_mtls=client_cert_source_func,
                 quota_project_id=client_options.quota_project_id,
                 client_info=client_info,
-                always_use_jwt_access=(
-                    Transport == type(self).get_transport_class("grpc")
-                    or Transport == type(self).get_transport_class("grpc_asyncio")
-                ),
+                always_use_jwt_access=True,
             )
 
     def create_certificate(
@@ -2202,6 +2199,19 @@ def list_reusable_configs(
         # Done; return the response.
         return response
 
+    def __enter__(self):
+        return self
+
+    def __exit__(self, type, value, traceback):
+        """Releases underlying transport's resources.
+
+        .. warning::
+            ONLY use as a context manager if the transport is NOT shared
+            with other clients! Exiting the with block will CLOSE the transport
+            and may cause errors in other clients!
+        """
+        self.transport.close()
+
 
 try:
     DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
diff --git a/google/cloud/security/privateca_v1beta1/services/certificate_authority_service/transports/base.py b/google/cloud/security/privateca_v1beta1/services/certificate_authority_service/transports/base.py
@@ -247,6 +247,15 @@ def _prep_wrapped_messages(self, client_info):
             ),
         }
 
+    def close(self):
+        """Closes resources associated with the transport.
+
+       .. warning::
+            Only call this method if the transport is NOT shared
+            with other clients - this may cause errors in other clients!
+        """
+        raise NotImplementedError()
+
     @property
     def operations_client(self) -> operations_v1.OperationsClient:
         """Return the client designed to process long-running operations."""
diff --git a/google/cloud/security/privateca_v1beta1/services/certificate_authority_service/transports/grpc.py b/google/cloud/security/privateca_v1beta1/services/certificate_authority_service/transports/grpc.py
@@ -863,5 +863,8 @@ def list_reusable_configs(
             )
         return self._stubs["list_reusable_configs"]
 
+    def close(self):
+        self.grpc_channel.close()
+
 
 __all__ = ("CertificateAuthorityServiceGrpcTransport",)
diff --git a/google/cloud/security/privateca_v1beta1/services/certificate_authority_service/transports/grpc_asyncio.py b/google/cloud/security/privateca_v1beta1/services/certificate_authority_service/transports/grpc_asyncio.py
@@ -881,5 +881,8 @@ def list_reusable_configs(
             )
         return self._stubs["list_reusable_configs"]
 
+    def close(self):
+        return self.grpc_channel.close()
+
 
 __all__ = ("CertificateAuthorityServiceGrpcAsyncIOTransport",)
diff --git a/google/cloud/security/privateca_v1beta1/types/resources.py b/google/cloud/security/privateca_v1beta1/types/resources.py
@@ -319,6 +319,7 @@ class CertificateAuthorityPolicy(proto.Message):
 
         class AllowedConfigList(proto.Message):
             r"""
+
             Attributes:
                 allowed_config_values (Sequence[google.cloud.security.privateca_v1beta1.types.ReusableConfigWrapper]):
                     Required. All
@@ -770,6 +771,7 @@ class ReusableConfigValues(proto.Message):
 
     class CaOptions(proto.Message):
         r"""Describes values that are relevant in a CA certificate.
+
         Attributes:
             is_ca (google.protobuf.wrappers_pb2.BoolValue):
                 Optional. Refers to the "CA" X.509 extension,
@@ -1038,6 +1040,7 @@ class KeyId(proto.Message):
 
     class CertificateFingerprint(proto.Message):
         r"""A group of fingerprints for the x509 certificate.
+
         Attributes:
             sha256_hash (str):
                 The SHA 256 hash, encoded in hexadecimal, of
diff --git a/google/cloud/security/privateca_v1beta1/types/service.py b/google/cloud/security/privateca_v1beta1/types/service.py
@@ -857,6 +857,7 @@ def raw_page(self):
 
 class OperationMetadata(proto.Message):
     r"""Represents the metadata of the long-running operation.
+
     Attributes:
         create_time (google.protobuf.timestamp_pb2.Timestamp):
             Output only. The time the operation was
diff --git a/tests/unit/gapic/privateca_v1/test_certificate_authority_service.py b/tests/unit/gapic/privateca_v1/test_certificate_authority_service.py
@@ -32,6 +32,7 @@
 from google.api_core import grpc_helpers_async
 from google.api_core import operation_async  # type: ignore
 from google.api_core import operations_v1
+from google.api_core import path_template
 from google.auth import credentials as ga_credentials
 from google.auth.exceptions import MutualTLSChannelError
 from google.cloud.security.privateca_v1.services.certificate_authority_service import (
@@ -8208,6 +8209,9 @@ def test_certificate_authority_service_base_transport():
         with pytest.raises(NotImplementedError):
             getattr(transport, method)(request=object())
 
+    with pytest.raises(NotImplementedError):
+        transport.close()
+
     # Additionally, the LRO client (a property) should
     # also raise NotImplementedError
     with pytest.raises(NotImplementedError):
@@ -8855,3 +8859,49 @@ def test_client_withDEFAULT_CLIENT_INFO():
             credentials=ga_credentials.AnonymousCredentials(), client_info=client_info,
         )
         prep.assert_called_once_with(client_info)
+
+
+@pytest.mark.asyncio
+async def test_transport_close_async():
+    client = CertificateAuthorityServiceAsyncClient(
+        credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio",
+    )
+    with mock.patch.object(
+        type(getattr(client.transport, "grpc_channel")), "close"
+    ) as close:
+        async with client:
+            close.assert_not_called()
+        close.assert_called_once()
+
+
+def test_transport_close():
+    transports = {
+        "grpc": "_grpc_channel",
+    }
+
+    for transport, close_name in transports.items():
+        client = CertificateAuthorityServiceClient(
+            credentials=ga_credentials.AnonymousCredentials(), transport=transport
+        )
+        with mock.patch.object(
+            type(getattr(client.transport, close_name)), "close"
+        ) as close:
+            with client:
+                close.assert_not_called()
+            close.assert_called_once()
+
+
+def test_client_ctx():
+    transports = [
+        "grpc",
+    ]
+    for transport in transports:
+        client = CertificateAuthorityServiceClient(
+            credentials=ga_credentials.AnonymousCredentials(), transport=transport
+        )
+        # Test client calls underlying transport.
+        with mock.patch.object(type(client.transport), "close") as close:
+            close.assert_not_called()
+            with client:
+                pass
+            close.assert_called()
diff --git a/tests/unit/gapic/privateca_v1beta1/test_certificate_authority_service.py b/tests/unit/gapic/privateca_v1beta1/test_certificate_authority_service.py
@@ -32,6 +32,7 @@
 from google.api_core import grpc_helpers_async
 from google.api_core import operation_async  # type: ignore
 from google.api_core import operations_v1
+from google.api_core import path_template
 from google.auth import credentials as ga_credentials
 from google.auth.exceptions import MutualTLSChannelError
 from google.cloud.security.privateca_v1beta1.services.certificate_authority_service import (
@@ -6029,6 +6030,9 @@ def test_certificate_authority_service_base_transport():
         with pytest.raises(NotImplementedError):
             getattr(transport, method)(request=object())
 
+    with pytest.raises(NotImplementedError):
+        transport.close()
+
     # Additionally, the LRO client (a property) should
     # also raise NotImplementedError
     with pytest.raises(NotImplementedError):
@@ -6647,3 +6651,49 @@ def test_client_withDEFAULT_CLIENT_INFO():
             credentials=ga_credentials.AnonymousCredentials(), client_info=client_info,
         )
         prep.assert_called_once_with(client_info)
+
+
+@pytest.mark.asyncio
+async def test_transport_close_async():
+    client = CertificateAuthorityServiceAsyncClient(
+        credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio",
+    )
+    with mock.patch.object(
+        type(getattr(client.transport, "grpc_channel")), "close"
+    ) as close:
+        async with client:
+            close.assert_not_called()
+        close.assert_called_once()
+
+
+def test_transport_close():
+    transports = {
+        "grpc": "_grpc_channel",
+    }
+
+    for transport, close_name in transports.items():
+        client = CertificateAuthorityServiceClient(
+            credentials=ga_credentials.AnonymousCredentials(), transport=transport
+        )
+        with mock.patch.object(
+            type(getattr(client.transport, close_name)), "close"
+        ) as close:
+            with client:
+                close.assert_not_called()
+            close.assert_called_once()
+
+
+def test_client_ctx():
+    transports = [
+        "grpc",
+    ]
+    for transport in transports:
+        client = CertificateAuthorityServiceClient(
+            credentials=ga_credentials.AnonymousCredentials(), transport=transport
+        )
+        # Test client calls underlying transport.
+        with mock.patch.object(type(client.transport), "close") as close:
+            close.assert_not_called()
+            with client:
+                pass
+            close.assert_called()

Original file line number	Diff line number	Diff line change
`@@ -1103,5 +1103,8 @@ def update_certificate_template(`
`1103`	`1103`	`)`
`1104`	`1104`	`return self._stubs["update_certificate_template"]`
`1105`	`1105`
	`1106`	`+ def close(self):`
	`1107`	`+ self.grpc_channel.close()`
	`1108`	`+`
`1106`	`1109`
`1107`	`1110`	`__all__ = ("CertificateAuthorityServiceGrpcTransport",)`
Original file line number	Diff line number	Diff line change
`@@ -1128,5 +1128,8 @@ def update_certificate_template(`
`1128`	`1128`	`)`
`1129`	`1129`	`return self._stubs["update_certificate_template"]`
`1130`	`1130`
	`1131`	`+ def close(self):`
	`1132`	`+ return self.grpc_channel.close()`
	`1133`	`+`
`1131`	`1134`
`1132`	`1135`	`__all__ = ("CertificateAuthorityServiceGrpcAsyncIOTransport",)`