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

- [ ] 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

Author: gcf-owl-bot[bot]

google/cloud/devtools/cloudbuild_v1/services/cloud_build/async_client.py

@@ -1904,6 +1904,12 @@ async def list_worker_pools(
         # 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(

google/cloud/devtools/cloudbuild_v1/services/cloud_build/client.py

@@ -469,10 +469,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_build(
@@ -2123,6 +2120,19 @@ def list_worker_pools(
         # 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(

google/cloud/devtools/cloudbuild_v1/services/cloud_build/transports/base.py

@@ -303,6 +303,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."""

google/cloud/devtools/cloudbuild_v1/services/cloud_build/transports/grpc.py

@@ -777,5 +777,8 @@ def list_worker_pools(
             )
         return self._stubs["list_worker_pools"]
 
+    def close(self):
+        self.grpc_channel.close()
+
 
 __all__ = ("CloudBuildGrpcTransport",)

google/cloud/devtools/cloudbuild_v1/services/cloud_build/transports/grpc_asyncio.py

@@ -804,5 +804,8 @@ def list_worker_pools(
             )
         return self._stubs["list_worker_pools"]
 
+    def close(self):
+        return self.grpc_channel.close()
+
 
 __all__ = ("CloudBuildGrpcAsyncIOTransport",)

google/cloud/devtools/cloudbuild_v1/types/cloudbuild.py

@@ -1739,7 +1739,8 @@ class ReceiveTriggerWebhookRequest(proto.Message):
 class ReceiveTriggerWebhookResponse(proto.Message):
     r"""ReceiveTriggerWebhookResponse [Experimental] is the response object
     for the ReceiveTriggerWebhook method.
-        """
+
+    """
 
 
 class WorkerPool(proto.Message):
@@ -1852,6 +1853,7 @@ class WorkerConfig(proto.Message):
 
     class NetworkConfig(proto.Message):
         r"""Defines the network configuration for the pool.
+
         Attributes:
             peered_network (str):
                 Required. Immutable. The network definition that the workers

tests/unit/gapic/cloudbuild_v1/test_cloud_build.py

@@ -33,6 +33,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.devtools.cloudbuild_v1.services.cloud_build import (
@@ -4386,6 +4387,9 @@ def test_cloud_build_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):
@@ -5060,3 +5064,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 = CloudBuildAsyncClient(
+        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 = CloudBuildClient(
+            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 = CloudBuildClient(
+            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()