diff --git a/google/cloud/debugger_v2/gapic_metadata.json b/google/cloud/debugger_v2/gapic_metadata.json index fce739c..f0d8a90 100644 --- a/google/cloud/debugger_v2/gapic_metadata.json +++ b/google/cloud/debugger_v2/gapic_metadata.json @@ -46,6 +46,26 @@ ] } } + }, + "rest": { + "libraryClient": "Controller2Client", + "rpcs": { + "ListActiveBreakpoints": { + "methods": [ + "list_active_breakpoints" + ] + }, + "RegisterDebuggee": { + "methods": [ + "register_debuggee" + ] + }, + "UpdateActiveBreakpoint": { + "methods": [ + "update_active_breakpoint" + ] + } + } } } }, @@ -110,6 +130,36 @@ ] } } + }, + "rest": { + "libraryClient": "Debugger2Client", + "rpcs": { + "DeleteBreakpoint": { + "methods": [ + "delete_breakpoint" + ] + }, + "GetBreakpoint": { + "methods": [ + "get_breakpoint" + ] + }, + "ListBreakpoints": { + "methods": [ + "list_breakpoints" + ] + }, + "ListDebuggees": { + "methods": [ + "list_debuggees" + ] + }, + "SetBreakpoint": { + "methods": [ + "set_breakpoint" + ] + } + } } } } diff --git a/google/cloud/debugger_v2/services/controller2/async_client.py b/google/cloud/debugger_v2/services/controller2/async_client.py index ded2c03..c73834c 100644 --- a/google/cloud/debugger_v2/services/controller2/async_client.py +++ b/google/cloud/debugger_v2/services/controller2/async_client.py @@ -594,7 +594,7 @@ async def sample_update_active_breakpoint(): # Done; return the response. return response - async def __aenter__(self): + async def __aenter__(self) -> "Controller2AsyncClient": return self async def __aexit__(self, exc_type, exc, tb): diff --git a/google/cloud/debugger_v2/services/controller2/client.py b/google/cloud/debugger_v2/services/controller2/client.py index 1fcfd80..5bfcf46 100644 --- a/google/cloud/debugger_v2/services/controller2/client.py +++ b/google/cloud/debugger_v2/services/controller2/client.py @@ -51,6 +51,7 @@ from .transports.base import DEFAULT_CLIENT_INFO, Controller2Transport from .transports.grpc import Controller2GrpcTransport from .transports.grpc_asyncio import Controller2GrpcAsyncIOTransport +from .transports.rest import Controller2RestTransport class Controller2ClientMeta(type): @@ -64,6 +65,7 @@ class Controller2ClientMeta(type): _transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] _transport_registry["grpc"] = Controller2GrpcTransport _transport_registry["grpc_asyncio"] = Controller2GrpcAsyncIOTransport + _transport_registry["rest"] = Controller2RestTransport def get_transport_class( cls, diff --git a/google/cloud/debugger_v2/services/controller2/transports/__init__.py b/google/cloud/debugger_v2/services/controller2/transports/__init__.py index 437c215..5b7d44b 100644 --- a/google/cloud/debugger_v2/services/controller2/transports/__init__.py +++ b/google/cloud/debugger_v2/services/controller2/transports/__init__.py @@ -19,14 +19,18 @@ from .base import Controller2Transport from .grpc import Controller2GrpcTransport from .grpc_asyncio import Controller2GrpcAsyncIOTransport +from .rest import Controller2RestInterceptor, Controller2RestTransport # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] _transport_registry["grpc"] = Controller2GrpcTransport _transport_registry["grpc_asyncio"] = Controller2GrpcAsyncIOTransport +_transport_registry["rest"] = Controller2RestTransport __all__ = ( "Controller2Transport", "Controller2GrpcTransport", "Controller2GrpcAsyncIOTransport", + "Controller2RestTransport", + "Controller2RestInterceptor", ) diff --git a/google/cloud/debugger_v2/services/controller2/transports/rest.py b/google/cloud/debugger_v2/services/controller2/transports/rest.py new file mode 100644 index 0000000..8ad8203 --- /dev/null +++ b/google/cloud/debugger_v2/services/controller2/transports/rest.py @@ -0,0 +1,611 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import dataclasses +import json # type: ignore +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, path_template, rest_helpers, rest_streaming +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore +from google.protobuf import json_format +import grpc # type: ignore +from requests import __version__ as requests_version + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.debugger_v2.types import controller + +from .base import Controller2Transport +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class Controller2RestInterceptor: + """Interceptor for Controller2. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the Controller2RestTransport. + + .. code-block:: python + class MyCustomController2Interceptor(Controller2RestInterceptor): + def pre_list_active_breakpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_active_breakpoints(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_register_debuggee(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_register_debuggee(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_active_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_active_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + transport = Controller2RestTransport(interceptor=MyCustomController2Interceptor()) + client = Controller2Client(transport=transport) + + + """ + + def pre_list_active_breakpoints( + self, + request: controller.ListActiveBreakpointsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[controller.ListActiveBreakpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_active_breakpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_list_active_breakpoints( + self, response: controller.ListActiveBreakpointsResponse + ) -> controller.ListActiveBreakpointsResponse: + """Post-rpc interceptor for list_active_breakpoints + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + + def pre_register_debuggee( + self, + request: controller.RegisterDebuggeeRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[controller.RegisterDebuggeeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for register_debuggee + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_register_debuggee( + self, response: controller.RegisterDebuggeeResponse + ) -> controller.RegisterDebuggeeResponse: + """Post-rpc interceptor for register_debuggee + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + + def pre_update_active_breakpoint( + self, + request: controller.UpdateActiveBreakpointRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[controller.UpdateActiveBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_active_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_update_active_breakpoint( + self, response: controller.UpdateActiveBreakpointResponse + ) -> controller.UpdateActiveBreakpointResponse: + """Post-rpc interceptor for update_active_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class Controller2RestStub: + _session: AuthorizedSession + _host: str + _interceptor: Controller2RestInterceptor + + +class Controller2RestTransport(Controller2Transport): + """REST backend transport for Controller2. + + The Controller service provides the API for orchestrating a + collection of debugger agents to perform debugging tasks. These + agents are each attached to a process of an application which may + include one or more replicas. + + The debugger agents register with the Controller to identify the + application being debugged, the Debuggee. All agents that register + with the same data, represent the same Debuggee, and are assigned + the same ``debuggee_id``. + + The debugger agents call the Controller to retrieve the list of + active Breakpoints. Agents with the same ``debuggee_id`` get the + same breakpoints list. An agent that can fulfill the breakpoint + request updates the Controller with the breakpoint result. The + controller selects the first result received and discards the rest + of the results. Agents that poll again for active breakpoints will + no longer have the completed breakpoint in the list and should + remove that breakpoint from their attached process. + + The Controller service does not provide a way to retrieve the + results of a completed breakpoint. This functionality is available + using the Debugger service. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__( + self, + *, + host: str = "clouddebugger.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[Controller2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or Controller2RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _ListActiveBreakpoints(Controller2RestStub): + def __hash__(self): + return hash("ListActiveBreakpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: controller.ListActiveBreakpointsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> controller.ListActiveBreakpointsResponse: + r"""Call the list active breakpoints method over HTTP. + + Args: + request (~.controller.ListActiveBreakpointsRequest): + The request object. Request to list active breakpoints. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.controller.ListActiveBreakpointsResponse: + Response for listing active + breakpoints. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v2/controller/debuggees/{debuggee_id}/breakpoints", + }, + ] + request, metadata = self._interceptor.pre_list_active_breakpoints( + request, metadata + ) + pb_request = controller.ListActiveBreakpointsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.ListActiveBreakpointsResponse() + pb_resp = controller.ListActiveBreakpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_active_breakpoints(resp) + return resp + + class _RegisterDebuggee(Controller2RestStub): + def __hash__(self): + return hash("RegisterDebuggee") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: controller.RegisterDebuggeeRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> controller.RegisterDebuggeeResponse: + r"""Call the register debuggee method over HTTP. + + Args: + request (~.controller.RegisterDebuggeeRequest): + The request object. Request to register a debuggee. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.controller.RegisterDebuggeeResponse: + Response for registering a debuggee. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v2/controller/debuggees/register", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_register_debuggee( + request, metadata + ) + pb_request = controller.RegisterDebuggeeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.RegisterDebuggeeResponse() + pb_resp = controller.RegisterDebuggeeResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_register_debuggee(resp) + return resp + + class _UpdateActiveBreakpoint(Controller2RestStub): + def __hash__(self): + return hash("UpdateActiveBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: controller.UpdateActiveBreakpointRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> controller.UpdateActiveBreakpointResponse: + r"""Call the update active breakpoint method over HTTP. + + Args: + request (~.controller.UpdateActiveBreakpointRequest): + The request object. Request to update an active + breakpoint. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.controller.UpdateActiveBreakpointResponse: + Response for updating an active + breakpoint. The message is defined to + allow future extensions. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "put", + "uri": "/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_update_active_breakpoint( + request, metadata + ) + pb_request = controller.UpdateActiveBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.UpdateActiveBreakpointResponse() + pb_resp = controller.UpdateActiveBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_active_breakpoint(resp) + return resp + + @property + def list_active_breakpoints( + self, + ) -> Callable[ + [controller.ListActiveBreakpointsRequest], + controller.ListActiveBreakpointsResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListActiveBreakpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def register_debuggee( + self, + ) -> Callable[ + [controller.RegisterDebuggeeRequest], controller.RegisterDebuggeeResponse + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RegisterDebuggee(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_active_breakpoint( + self, + ) -> Callable[ + [controller.UpdateActiveBreakpointRequest], + controller.UpdateActiveBreakpointResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateActiveBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("Controller2RestTransport",) diff --git a/google/cloud/debugger_v2/services/debugger2/async_client.py b/google/cloud/debugger_v2/services/debugger2/async_client.py index 0288d5e..ab1ce7c 100644 --- a/google/cloud/debugger_v2/services/debugger2/async_client.py +++ b/google/cloud/debugger_v2/services/debugger2/async_client.py @@ -846,7 +846,7 @@ async def sample_list_debuggees(): # Done; return the response. return response - async def __aenter__(self): + async def __aenter__(self) -> "Debugger2AsyncClient": return self async def __aexit__(self, exc_type, exc, tb): diff --git a/google/cloud/debugger_v2/services/debugger2/client.py b/google/cloud/debugger_v2/services/debugger2/client.py index b220ba8..b4a1c66 100644 --- a/google/cloud/debugger_v2/services/debugger2/client.py +++ b/google/cloud/debugger_v2/services/debugger2/client.py @@ -51,6 +51,7 @@ from .transports.base import DEFAULT_CLIENT_INFO, Debugger2Transport from .transports.grpc import Debugger2GrpcTransport from .transports.grpc_asyncio import Debugger2GrpcAsyncIOTransport +from .transports.rest import Debugger2RestTransport class Debugger2ClientMeta(type): @@ -64,6 +65,7 @@ class Debugger2ClientMeta(type): _transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] _transport_registry["grpc"] = Debugger2GrpcTransport _transport_registry["grpc_asyncio"] = Debugger2GrpcAsyncIOTransport + _transport_registry["rest"] = Debugger2RestTransport def get_transport_class( cls, diff --git a/google/cloud/debugger_v2/services/debugger2/transports/__init__.py b/google/cloud/debugger_v2/services/debugger2/transports/__init__.py index 2668575..7506d8f 100644 --- a/google/cloud/debugger_v2/services/debugger2/transports/__init__.py +++ b/google/cloud/debugger_v2/services/debugger2/transports/__init__.py @@ -19,14 +19,18 @@ from .base import Debugger2Transport from .grpc import Debugger2GrpcTransport from .grpc_asyncio import Debugger2GrpcAsyncIOTransport +from .rest import Debugger2RestInterceptor, Debugger2RestTransport # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] _transport_registry["grpc"] = Debugger2GrpcTransport _transport_registry["grpc_asyncio"] = Debugger2GrpcAsyncIOTransport +_transport_registry["rest"] = Debugger2RestTransport __all__ = ( "Debugger2Transport", "Debugger2GrpcTransport", "Debugger2GrpcAsyncIOTransport", + "Debugger2RestTransport", + "Debugger2RestInterceptor", ) diff --git a/google/cloud/debugger_v2/services/debugger2/transports/rest.py b/google/cloud/debugger_v2/services/debugger2/transports/rest.py new file mode 100644 index 0000000..02216ea --- /dev/null +++ b/google/cloud/debugger_v2/services/debugger2/transports/rest.py @@ -0,0 +1,817 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import dataclasses +import json # type: ignore +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, path_template, rest_helpers, rest_streaming +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore +from google.protobuf import json_format +import grpc # type: ignore +from requests import __version__ as requests_version + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.protobuf import empty_pb2 # type: ignore + +from google.cloud.debugger_v2.types import debugger + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .base import Debugger2Transport + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class Debugger2RestInterceptor: + """Interceptor for Debugger2. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the Debugger2RestTransport. + + .. code-block:: python + class MyCustomDebugger2Interceptor(Debugger2RestInterceptor): + def pre_delete_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_breakpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_breakpoints(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_debuggees(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_debuggees(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_set_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_set_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + transport = Debugger2RestTransport(interceptor=MyCustomDebugger2Interceptor()) + client = Debugger2Client(transport=transport) + + + """ + + def pre_delete_breakpoint( + self, + request: debugger.DeleteBreakpointRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[debugger.DeleteBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def pre_get_breakpoint( + self, + request: debugger.GetBreakpointRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[debugger.GetBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_get_breakpoint( + self, response: debugger.GetBreakpointResponse + ) -> debugger.GetBreakpointResponse: + """Post-rpc interceptor for get_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + + def pre_list_breakpoints( + self, + request: debugger.ListBreakpointsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[debugger.ListBreakpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_breakpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_list_breakpoints( + self, response: debugger.ListBreakpointsResponse + ) -> debugger.ListBreakpointsResponse: + """Post-rpc interceptor for list_breakpoints + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + + def pre_list_debuggees( + self, + request: debugger.ListDebuggeesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[debugger.ListDebuggeesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_debuggees + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_list_debuggees( + self, response: debugger.ListDebuggeesResponse + ) -> debugger.ListDebuggeesResponse: + """Post-rpc interceptor for list_debuggees + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + + def pre_set_breakpoint( + self, + request: debugger.SetBreakpointRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[debugger.SetBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for set_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_set_breakpoint( + self, response: debugger.SetBreakpointResponse + ) -> debugger.SetBreakpointResponse: + """Post-rpc interceptor for set_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class Debugger2RestStub: + _session: AuthorizedSession + _host: str + _interceptor: Debugger2RestInterceptor + + +class Debugger2RestTransport(Debugger2Transport): + """REST backend transport for Debugger2. + + The Debugger service provides the API that allows users to + collect run-time information from a running application, without + stopping or slowing it down and without modifying its state. An + application may include one or more replicated processes + performing the same work. + A debugged application is represented using the Debuggee + concept. The Debugger service provides a way to query for + available debuggees, but does not provide a way to create one. + A debuggee is created using the Controller service, usually by + running a debugger agent with the application. + The Debugger service enables the client to set one or more + Breakpoints on a Debuggee and collect the results of the set + Breakpoints. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__( + self, + *, + host: str = "clouddebugger.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[Debugger2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or Debugger2RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _DeleteBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("DeleteBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion": "", + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: debugger.DeleteBreakpointRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete breakpoint method over HTTP. + + Args: + request (~.debugger.DeleteBreakpointRequest): + The request object. Request to delete a breakpoint. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}", + }, + ] + request, metadata = self._interceptor.pre_delete_breakpoint( + request, metadata + ) + pb_request = debugger.DeleteBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("GetBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion": "", + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: debugger.GetBreakpointRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Call the get breakpoint method over HTTP. + + Args: + request (~.debugger.GetBreakpointRequest): + The request object. Request to get breakpoint + information. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.debugger.GetBreakpointResponse: + Response for getting breakpoint + information. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}", + }, + ] + request, metadata = self._interceptor.pre_get_breakpoint(request, metadata) + pb_request = debugger.GetBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.GetBreakpointResponse() + pb_resp = debugger.GetBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_breakpoint(resp) + return resp + + class _ListBreakpoints(Debugger2RestStub): + def __hash__(self): + return hash("ListBreakpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion": "", + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: debugger.ListBreakpointsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Call the list breakpoints method over HTTP. + + Args: + request (~.debugger.ListBreakpointsRequest): + The request object. Request to list breakpoints. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.debugger.ListBreakpointsResponse: + Response for listing breakpoints. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v2/debugger/debuggees/{debuggee_id}/breakpoints", + }, + ] + request, metadata = self._interceptor.pre_list_breakpoints( + request, metadata + ) + pb_request = debugger.ListBreakpointsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.ListBreakpointsResponse() + pb_resp = debugger.ListBreakpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_breakpoints(resp) + return resp + + class _ListDebuggees(Debugger2RestStub): + def __hash__(self): + return hash("ListDebuggees") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "project": "", + "clientVersion": "", + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: debugger.ListDebuggeesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Call the list debuggees method over HTTP. + + Args: + request (~.debugger.ListDebuggeesRequest): + The request object. Request to list debuggees. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.debugger.ListDebuggeesResponse: + Response for listing debuggees. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v2/debugger/debuggees", + }, + ] + request, metadata = self._interceptor.pre_list_debuggees(request, metadata) + pb_request = debugger.ListDebuggeesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.ListDebuggeesResponse() + pb_resp = debugger.ListDebuggeesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_debuggees(resp) + return resp + + class _SetBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("SetBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "breakpoint": {}, + "clientVersion": "", + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: debugger.SetBreakpointRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Call the set breakpoint method over HTTP. + + Args: + request (~.debugger.SetBreakpointRequest): + The request object. Request to set a breakpoint + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.debugger.SetBreakpointResponse: + Response for setting a breakpoint. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v2/debugger/debuggees/{debuggee_id}/breakpoints/set", + "body": "breakpoint_", + }, + ] + request, metadata = self._interceptor.pre_set_breakpoint(request, metadata) + pb_request = debugger.SetBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.SetBreakpointResponse() + pb_resp = debugger.SetBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_set_breakpoint(resp) + return resp + + @property + def delete_breakpoint( + self, + ) -> Callable[[debugger.DeleteBreakpointRequest], empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_breakpoint( + self, + ) -> Callable[[debugger.GetBreakpointRequest], debugger.GetBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_breakpoints( + self, + ) -> Callable[[debugger.ListBreakpointsRequest], debugger.ListBreakpointsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListBreakpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_debuggees( + self, + ) -> Callable[[debugger.ListDebuggeesRequest], debugger.ListDebuggeesResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListDebuggees(self._session, self._host, self._interceptor) # type: ignore + + @property + def set_breakpoint( + self, + ) -> Callable[[debugger.SetBreakpointRequest], debugger.SetBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._SetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("Debugger2RestTransport",) diff --git a/google/cloud/debugger_v2/types/controller.py b/google/cloud/debugger_v2/types/controller.py index 6740f2f..0b1880c 100644 --- a/google/cloud/debugger_v2/types/controller.py +++ b/google/cloud/debugger_v2/types/controller.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/debugger_v2/types/data.py b/google/cloud/debugger_v2/types/data.py index 7887bfc..4118ed0 100644 --- a/google/cloud/debugger_v2/types/data.py +++ b/google/cloud/debugger_v2/types/data.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence from google.cloud.source_context_v1.types import ( diff --git a/google/cloud/debugger_v2/types/debugger.py b/google/cloud/debugger_v2/types/debugger.py index d63fcde..7711a81 100644 --- a/google/cloud/debugger_v2/types/debugger.py +++ b/google/cloud/debugger_v2/types/debugger.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/tests/unit/gapic/debugger_v2/test_controller2.py b/tests/unit/gapic/debugger_v2/test_controller2.py index 69aebc2..9a21e91 100644 --- a/tests/unit/gapic/debugger_v2/test_controller2.py +++ b/tests/unit/gapic/debugger_v2/test_controller2.py @@ -22,6 +22,8 @@ except ImportError: # pragma: NO COVER import mock +from collections.abc import Iterable +import json import math from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template @@ -34,6 +36,7 @@ source_context as source_context_pb2, ) # type: ignore from google.oauth2 import service_account +from google.protobuf import json_format from google.protobuf import timestamp_pb2 # type: ignore from google.protobuf import wrappers_pb2 # type: ignore import grpc @@ -41,6 +44,8 @@ from proto.marshal.rules import wrappers from proto.marshal.rules.dates import DurationRule, TimestampRule import pytest +from requests import PreparedRequest, Request, Response +from requests.sessions import Session from google.cloud.debugger_v2.services.controller2 import ( Controller2AsyncClient, @@ -96,6 +101,7 @@ def test__get_default_mtls_endpoint(): [ (Controller2Client, "grpc"), (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), ], ) def test_controller2_client_from_service_account_info(client_class, transport_name): @@ -109,7 +115,11 @@ def test_controller2_client_from_service_account_info(client_class, transport_na assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("clouddebugger.googleapis.com:443") + assert client.transport._host == ( + "clouddebugger.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com" + ) @pytest.mark.parametrize( @@ -117,6 +127,7 @@ def test_controller2_client_from_service_account_info(client_class, transport_na [ (transports.Controller2GrpcTransport, "grpc"), (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Controller2RestTransport, "rest"), ], ) def test_controller2_client_service_account_always_use_jwt( @@ -142,6 +153,7 @@ def test_controller2_client_service_account_always_use_jwt( [ (Controller2Client, "grpc"), (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), ], ) def test_controller2_client_from_service_account_file(client_class, transport_name): @@ -162,13 +174,18 @@ def test_controller2_client_from_service_account_file(client_class, transport_na assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("clouddebugger.googleapis.com:443") + assert client.transport._host == ( + "clouddebugger.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com" + ) def test_controller2_client_get_transport_class(): transport = Controller2Client.get_transport_class() available_transports = [ transports.Controller2GrpcTransport, + transports.Controller2RestTransport, ] assert transport in available_transports @@ -185,6 +202,7 @@ def test_controller2_client_get_transport_class(): transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", ), + (Controller2Client, transports.Controller2RestTransport, "rest"), ], ) @mock.patch.object( @@ -328,6 +346,8 @@ def test_controller2_client_client_options( "grpc_asyncio", "false", ), + (Controller2Client, transports.Controller2RestTransport, "rest", "true"), + (Controller2Client, transports.Controller2RestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -521,6 +541,7 @@ def test_controller2_client_get_mtls_endpoint_and_cert_source(client_class): transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", ), + (Controller2Client, transports.Controller2RestTransport, "rest"), ], ) def test_controller2_client_client_options_scopes( @@ -556,6 +577,7 @@ def test_controller2_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (Controller2Client, transports.Controller2RestTransport, "rest", None), ], ) def test_controller2_client_client_options_credentials_file( @@ -1343,6 +1365,826 @@ async def test_update_active_breakpoint_flattened_error_async(): ) +@pytest.mark.parametrize( + "request_type", + [ + controller.RegisterDebuggeeRequest, + dict, + ], +) +def test_register_debuggee_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.register_debuggee(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.RegisterDebuggeeResponse) + + +def test_register_debuggee_rest_required_fields( + request_type=controller.RegisterDebuggeeRequest, +): + transport_class = transports.Controller2RestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.register_debuggee(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_register_debuggee_rest_unset_required_fields(): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.register_debuggee._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("debuggee",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_register_debuggee_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Controller2RestInterceptor, "post_register_debuggee" + ) as post, mock.patch.object( + transports.Controller2RestInterceptor, "pre_register_debuggee" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.RegisterDebuggeeRequest.pb( + controller.RegisterDebuggeeRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.RegisterDebuggeeResponse.to_json( + controller.RegisterDebuggeeResponse() + ) + + request = controller.RegisterDebuggeeRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.RegisterDebuggeeResponse() + + client.register_debuggee( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_register_debuggee_rest_bad_request( + transport: str = "rest", request_type=controller.RegisterDebuggeeRequest +): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.register_debuggee(request) + + +def test_register_debuggee_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + debuggee=data.Debuggee(id="id_value"), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.register_debuggee(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/controller/debuggees/register" % client.transport._host, args[1] + ) + + +def test_register_debuggee_rest_flattened_error(transport: str = "rest"): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.register_debuggee( + controller.RegisterDebuggeeRequest(), + debuggee=data.Debuggee(id="id_value"), + ) + + +def test_register_debuggee_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + controller.ListActiveBreakpointsRequest, + dict, + ], +) +def test_list_active_breakpoints_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse( + next_wait_token="next_wait_token_value", + wait_expired=True, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_active_breakpoints(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.ListActiveBreakpointsResponse) + assert response.next_wait_token == "next_wait_token_value" + assert response.wait_expired is True + + +def test_list_active_breakpoints_rest_required_fields( + request_type=controller.ListActiveBreakpointsRequest, +): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_active_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = "debuggee_id_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_active_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "success_on_timeout", + "wait_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == "debuggee_id_value" + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_active_breakpoints(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_active_breakpoints_rest_unset_required_fields(): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_active_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "successOnTimeout", + "waitToken", + ) + ) + & set(("debuggeeId",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_active_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Controller2RestInterceptor, "post_list_active_breakpoints" + ) as post, mock.patch.object( + transports.Controller2RestInterceptor, "pre_list_active_breakpoints" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.ListActiveBreakpointsRequest.pb( + controller.ListActiveBreakpointsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.ListActiveBreakpointsResponse.to_json( + controller.ListActiveBreakpointsResponse() + ) + + request = controller.ListActiveBreakpointsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.ListActiveBreakpointsResponse() + + client.list_active_breakpoints( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_active_breakpoints_rest_bad_request( + transport: str = "rest", request_type=controller.ListActiveBreakpointsRequest +): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_active_breakpoints(request) + + +def test_list_active_breakpoints_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"debuggee_id": "sample1"} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id="debuggee_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_active_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/controller/debuggees/{debuggee_id}/breakpoints" + % client.transport._host, + args[1], + ) + + +def test_list_active_breakpoints_rest_flattened_error(transport: str = "rest"): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_active_breakpoints( + controller.ListActiveBreakpointsRequest(), + debuggee_id="debuggee_id_value", + ) + + +def test_list_active_breakpoints_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + controller.UpdateActiveBreakpointRequest, + dict, + ], +) +def test_update_active_breakpoint_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1", "breakpoint_": {"id": "sample2"}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.update_active_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.UpdateActiveBreakpointResponse) + + +def test_update_active_breakpoint_rest_required_fields( + request_type=controller.UpdateActiveBreakpointRequest, +): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = "debuggee_id_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == "debuggee_id_value" + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "put", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.update_active_breakpoint(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_active_breakpoint_rest_unset_required_fields(): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_active_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "debuggeeId", + "breakpoint", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_active_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Controller2RestInterceptor, "post_update_active_breakpoint" + ) as post, mock.patch.object( + transports.Controller2RestInterceptor, "pre_update_active_breakpoint" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.UpdateActiveBreakpointRequest.pb( + controller.UpdateActiveBreakpointRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.UpdateActiveBreakpointResponse.to_json( + controller.UpdateActiveBreakpointResponse() + ) + + request = controller.UpdateActiveBreakpointRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.UpdateActiveBreakpointResponse() + + client.update_active_breakpoint( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_active_breakpoint_rest_bad_request( + transport: str = "rest", request_type=controller.UpdateActiveBreakpointRequest +): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1", "breakpoint_": {"id": "sample2"}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_active_breakpoint(request) + + +def test_update_active_breakpoint_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"debuggee_id": "sample1", "breakpoint_": {"id": "sample2"}} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id="debuggee_id_value", + breakpoint_=data.Breakpoint(id="id_value"), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.update_active_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}" + % client.transport._host, + args[1], + ) + + +def test_update_active_breakpoint_rest_flattened_error(transport: str = "rest"): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_active_breakpoint( + controller.UpdateActiveBreakpointRequest(), + debuggee_id="debuggee_id_value", + breakpoint_=data.Breakpoint(id="id_value"), + ) + + +def test_update_active_breakpoint_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.Controller2GrpcTransport( @@ -1424,6 +2266,7 @@ def test_transport_get_channel(): [ transports.Controller2GrpcTransport, transports.Controller2GrpcAsyncIOTransport, + transports.Controller2RestTransport, ], ) def test_transport_adc(transport_class): @@ -1438,6 +2281,7 @@ def test_transport_adc(transport_class): "transport_name", [ "grpc", + "rest", ], ) def test_transport_kind(transport_name): @@ -1578,6 +2422,7 @@ def test_controller2_transport_auth_adc(transport_class): [ transports.Controller2GrpcTransport, transports.Controller2GrpcAsyncIOTransport, + transports.Controller2RestTransport, ], ) def test_controller2_transport_auth_gdch_credentials(transport_class): @@ -1675,11 +2520,23 @@ def test_controller2_grpc_transport_client_cert_source_for_mtls(transport_class) ) +def test_controller2_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.Controller2RestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_controller2_host_no_port(transport_name): @@ -1690,7 +2547,11 @@ def test_controller2_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("clouddebugger.googleapis.com:443") + assert client.transport._host == ( + "clouddebugger.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com" + ) @pytest.mark.parametrize( @@ -1698,6 +2559,7 @@ def test_controller2_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_controller2_host_with_port(transport_name): @@ -1708,7 +2570,39 @@ def test_controller2_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("clouddebugger.googleapis.com:8000") + assert client.transport._host == ( + "clouddebugger.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_controller2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Controller2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Controller2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.register_debuggee._session + session2 = client2.transport.register_debuggee._session + assert session1 != session2 + session1 = client1.transport.list_active_breakpoints._session + session2 = client2.transport.list_active_breakpoints._session + assert session1 != session2 + session1 = client1.transport.update_active_breakpoint._session + session2 = client2.transport.update_active_breakpoint._session + assert session1 != session2 def test_controller2_grpc_transport_channel(): @@ -1971,6 +2865,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -1988,6 +2883,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/tests/unit/gapic/debugger_v2/test_debugger2.py b/tests/unit/gapic/debugger_v2/test_debugger2.py index 0ad86df..329180d 100644 --- a/tests/unit/gapic/debugger_v2/test_debugger2.py +++ b/tests/unit/gapic/debugger_v2/test_debugger2.py @@ -22,6 +22,8 @@ except ImportError: # pragma: NO COVER import mock +from collections.abc import Iterable +import json import math from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template @@ -31,6 +33,7 @@ from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError from google.oauth2 import service_account +from google.protobuf import json_format from google.protobuf import timestamp_pb2 # type: ignore from google.protobuf import wrappers_pb2 # type: ignore import grpc @@ -38,6 +41,8 @@ from proto.marshal.rules import wrappers from proto.marshal.rules.dates import DurationRule, TimestampRule import pytest +from requests import PreparedRequest, Request, Response +from requests.sessions import Session from google.cloud.debugger_v2.services.debugger2 import ( Debugger2AsyncClient, @@ -91,6 +96,7 @@ def test__get_default_mtls_endpoint(): [ (Debugger2Client, "grpc"), (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), ], ) def test_debugger2_client_from_service_account_info(client_class, transport_name): @@ -104,7 +110,11 @@ def test_debugger2_client_from_service_account_info(client_class, transport_name assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("clouddebugger.googleapis.com:443") + assert client.transport._host == ( + "clouddebugger.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com" + ) @pytest.mark.parametrize( @@ -112,6 +122,7 @@ def test_debugger2_client_from_service_account_info(client_class, transport_name [ (transports.Debugger2GrpcTransport, "grpc"), (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Debugger2RestTransport, "rest"), ], ) def test_debugger2_client_service_account_always_use_jwt( @@ -137,6 +148,7 @@ def test_debugger2_client_service_account_always_use_jwt( [ (Debugger2Client, "grpc"), (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), ], ) def test_debugger2_client_from_service_account_file(client_class, transport_name): @@ -157,13 +169,18 @@ def test_debugger2_client_from_service_account_file(client_class, transport_name assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("clouddebugger.googleapis.com:443") + assert client.transport._host == ( + "clouddebugger.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com" + ) def test_debugger2_client_get_transport_class(): transport = Debugger2Client.get_transport_class() available_transports = [ transports.Debugger2GrpcTransport, + transports.Debugger2RestTransport, ] assert transport in available_transports @@ -180,6 +197,7 @@ def test_debugger2_client_get_transport_class(): transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", ), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), ], ) @mock.patch.object( @@ -321,6 +339,8 @@ def test_debugger2_client_client_options(client_class, transport_class, transpor "grpc_asyncio", "false", ), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "true"), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -514,6 +534,7 @@ def test_debugger2_client_get_mtls_endpoint_and_cert_source(client_class): transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", ), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), ], ) def test_debugger2_client_client_options_scopes( @@ -549,6 +570,7 @@ def test_debugger2_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (Debugger2Client, transports.Debugger2RestTransport, "rest", None), ], ) def test_debugger2_client_client_options_credentials_file( @@ -1824,191 +1846,1763 @@ async def test_list_debuggees_flattened_error_async(): ) -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.Debugger2GrpcTransport( +@pytest.mark.parametrize( + "request_type", + [ + debugger.SetBreakpointRequest, + dict, + ], +) +def test_set_breakpoint_rest(request_type): + client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - with pytest.raises(ValueError): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - # It is an error to provide a credentials file and a transport instance. - transport = transports.Debugger2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1"} + request_init["breakpoint_"] = { + "id": "id_value", + "action": 1, + "location": {"path": "path_value", "line": 424, "column": 654}, + "condition": "condition_value", + "expressions": ["expressions_value1", "expressions_value2"], + "log_message_format": "log_message_format_value", + "log_level": 1, + "is_final_state": True, + "create_time": {"seconds": 751, "nanos": 543}, + "final_time": {}, + "user_email": "user_email_value", + "status": { + "is_error": True, + "refers_to": 3, + "description": { + "format_": "format__value", + "parameters": ["parameters_value1", "parameters_value2"], + }, + }, + "stack_frames": [ + { + "function": "function_value", + "location": {}, + "arguments": [ + { + "name": "name_value", + "value": "value_value", + "type_": "type__value", + "members": {}, + "var_table_index": {"value": 541}, + "status": {}, + } + ], + "locals_": {}, + } + ], + "evaluated_expressions": {}, + "variable_table": {}, + "labels": {}, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.set_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.SetBreakpointResponse) + + +def test_set_breakpoint_rest_required_fields( + request_type=debugger.SetBreakpointRequest, +): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) ) - with pytest.raises(ValueError): - client = Debugger2Client( - client_options={"credentials_file": "credentials.json"}, - transport=transport, + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).set_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = "debuggee_id_value" + jsonified_request["clientVersion"] = "client_version_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).set_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "breakpoint_", + "client_version", ) + ) + jsonified_request.update(unset_fields) - # It is an error to provide an api_key and a transport instance. - transport = transports.Debugger2GrpcTransport( + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == "debuggee_id_value" + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == "client_version_value" + + client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.set_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_set_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = Debugger2Client( - client_options=options, - transport=transport, - ) - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = Debugger2Client( - client_options=options, credentials=ga_credentials.AnonymousCredentials() + unset_fields = transport.set_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "breakpoint", + "clientVersion", + ) + ) + & set( + ( + "debuggeeId", + "breakpoint", + "clientVersion", + ) ) + ) - # It is an error to provide scopes and a transport instance. - transport = transports.Debugger2GrpcTransport( + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_set_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), ) - with pytest.raises(ValueError): - client = Debugger2Client( - client_options={"scopes": ["1", "2"]}, - transport=transport, + client = Debugger2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Debugger2RestInterceptor, "post_set_breakpoint" + ) as post, mock.patch.object( + transports.Debugger2RestInterceptor, "pre_set_breakpoint" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.SetBreakpointRequest.pb(debugger.SetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.SetBreakpointResponse.to_json( + debugger.SetBreakpointResponse() ) + request = debugger.SetBreakpointRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.SetBreakpointResponse() -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.Debugger2GrpcTransport( + client.set_breakpoint( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_set_breakpoint_rest_bad_request( + transport: str = "rest", request_type=debugger.SetBreakpointRequest +): + client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - client = Debugger2Client(transport=transport) - assert client.transport is transport + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1"} + request_init["breakpoint_"] = { + "id": "id_value", + "action": 1, + "location": {"path": "path_value", "line": 424, "column": 654}, + "condition": "condition_value", + "expressions": ["expressions_value1", "expressions_value2"], + "log_message_format": "log_message_format_value", + "log_level": 1, + "is_final_state": True, + "create_time": {"seconds": 751, "nanos": 543}, + "final_time": {}, + "user_email": "user_email_value", + "status": { + "is_error": True, + "refers_to": 3, + "description": { + "format_": "format__value", + "parameters": ["parameters_value1", "parameters_value2"], + }, + }, + "stack_frames": [ + { + "function": "function_value", + "location": {}, + "arguments": [ + { + "name": "name_value", + "value": "value_value", + "type_": "type__value", + "members": {}, + "var_table_index": {"value": 541}, + "status": {}, + } + ], + "locals_": {}, + } + ], + "evaluated_expressions": {}, + "variable_table": {}, + "labels": {}, + } + request = request_type(**request_init) -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.Debugger2GrpcTransport( + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.set_breakpoint(request) + + +def test_set_breakpoint_rest_flattened(): + client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - channel = transport.grpc_channel - assert channel - transport = transports.Debugger2GrpcAsyncIOTransport( + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"debuggee_id": "sample1"} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id="debuggee_id_value", + breakpoint_=data.Breakpoint(id="id_value"), + client_version="client_version_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.set_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/set" + % client.transport._host, + args[1], + ) + + +def test_set_breakpoint_rest_flattened_error(transport: str = "rest"): + client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.set_breakpoint( + debugger.SetBreakpointRequest(), + debuggee_id="debuggee_id_value", + breakpoint_=data.Breakpoint(id="id_value"), + client_version="client_version_value", + ) -@pytest.mark.parametrize( - "transport_class", - [ - transports.Debugger2GrpcTransport, - transports.Debugger2GrpcAsyncIOTransport, - ], -) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, "default") as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() +def test_set_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) @pytest.mark.parametrize( - "transport_name", + "request_type", [ - "grpc", + debugger.GetBreakpointRequest, + dict, ], ) -def test_transport_kind(transport_name): - transport = Debugger2Client.get_transport_class(transport_name)( +def test_get_breakpoint_rest(request_type): + client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - assert transport.kind == transport_name + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1", "breakpoint_id": "sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.get_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.GetBreakpointResponse) + + +def test_get_breakpoint_rest_required_fields( + request_type=debugger.GetBreakpointRequest, +): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = "debuggee_id_value" + jsonified_request["breakpointId"] = "breakpoint_id_value" + jsonified_request["clientVersion"] = "client_version_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == "debuggee_id_value" + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == "breakpoint_id_value" + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == "client_version_value" -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - assert isinstance( - client.transport, - transports.Debugger2GrpcTransport, + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.get_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials ) + unset_fields = transport.get_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("clientVersion",)) + & set( + ( + "debuggeeId", + "breakpointId", + "clientVersion", + ) + ) + ) -def test_debugger2_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.Debugger2Transport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json", + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Debugger2RestInterceptor, "post_get_breakpoint" + ) as post, mock.patch.object( + transports.Debugger2RestInterceptor, "pre_get_breakpoint" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.GetBreakpointRequest.pb(debugger.GetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.GetBreakpointResponse.to_json( + debugger.GetBreakpointResponse() ) + request = debugger.GetBreakpointRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.GetBreakpointResponse() -def test_debugger2_base_transport(): - # Instantiate the base transport. - with mock.patch( - "google.cloud.debugger_v2.services.debugger2.transports.Debugger2Transport.__init__" - ) as Transport: - Transport.return_value = None - transport = transports.Debugger2Transport( - credentials=ga_credentials.AnonymousCredentials(), + client.get_breakpoint( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], ) - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - "set_breakpoint", - "get_breakpoint", - "delete_breakpoint", - "list_breakpoints", - "list_debuggees", + pre.assert_called_once() + post.assert_called_once() + + +def test_get_breakpoint_rest_bad_request( + transport: str = "rest", request_type=debugger.GetBreakpointRequest +): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - with pytest.raises(NotImplementedError): - transport.close() + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1", "breakpoint_id": "sample2"} + request = request_type(**request_init) - # Catch all for all remaining methods and properties - remainder = [ - "kind", - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_breakpoint(request) -def test_debugger2_base_transport_with_credentials_file(): - # Instantiate the base transport with a credentials file - with mock.patch.object( - google.auth, "load_credentials_from_file", autospec=True - ) as load_creds, mock.patch( - "google.cloud.debugger_v2.services.debugger2.transports.Debugger2Transport._prep_wrapped_messages" - ) as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.Debugger2Transport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with( - "credentials.json", - scopes=None, - default_scopes=( - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud_debugger", - ), - quota_project_id="octopus", - ) +def test_get_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() -def test_debugger2_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. + # get arguments that satisfy an http rule for this method + sample_request = {"debuggee_id": "sample1", "breakpoint_id": "sample2"} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.get_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" + % client.transport._host, + args[1], + ) + + +def test_get_breakpoint_rest_flattened_error(transport: str = "rest"): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_breakpoint( + debugger.GetBreakpointRequest(), + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + +def test_get_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + debugger.DeleteBreakpointRequest, + dict, + ], +) +def test_delete_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1", "breakpoint_id": "sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_breakpoint(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_breakpoint_rest_required_fields( + request_type=debugger.DeleteBreakpointRequest, +): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = "debuggee_id_value" + jsonified_request["breakpointId"] = "breakpoint_id_value" + jsonified_request["clientVersion"] = "client_version_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == "debuggee_id_value" + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == "breakpoint_id_value" + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == "client_version_value" + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("clientVersion",)) + & set( + ( + "debuggeeId", + "breakpointId", + "clientVersion", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Debugger2RestInterceptor, "pre_delete_breakpoint" + ) as pre: + pre.assert_not_called() + pb_message = debugger.DeleteBreakpointRequest.pb( + debugger.DeleteBreakpointRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = debugger.DeleteBreakpointRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_breakpoint( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_breakpoint_rest_bad_request( + transport: str = "rest", request_type=debugger.DeleteBreakpointRequest +): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1", "breakpoint_id": "sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_breakpoint(request) + + +def test_delete_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {"debuggee_id": "sample1", "breakpoint_id": "sample2"} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" + % client.transport._host, + args[1], + ) + + +def test_delete_breakpoint_rest_flattened_error(transport: str = "rest"): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_breakpoint( + debugger.DeleteBreakpointRequest(), + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + +def test_delete_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + debugger.ListBreakpointsRequest, + dict, + ], +) +def test_list_breakpoints_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse( + next_wait_token="next_wait_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_breakpoints(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.ListBreakpointsResponse) + assert response.next_wait_token == "next_wait_token_value" + + +def test_list_breakpoints_rest_required_fields( + request_type=debugger.ListBreakpointsRequest, +): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = "debuggee_id_value" + jsonified_request["clientVersion"] = "client_version_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "action", + "client_version", + "include_all_users", + "include_inactive", + "strip_results", + "wait_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == "debuggee_id_value" + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == "client_version_value" + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_breakpoints(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_breakpoints_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "action", + "clientVersion", + "includeAllUsers", + "includeInactive", + "stripResults", + "waitToken", + ) + ) + & set( + ( + "debuggeeId", + "clientVersion", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Debugger2RestInterceptor, "post_list_breakpoints" + ) as post, mock.patch.object( + transports.Debugger2RestInterceptor, "pre_list_breakpoints" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListBreakpointsRequest.pb( + debugger.ListBreakpointsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListBreakpointsResponse.to_json( + debugger.ListBreakpointsResponse() + ) + + request = debugger.ListBreakpointsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListBreakpointsResponse() + + client.list_breakpoints( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_breakpoints_rest_bad_request( + transport: str = "rest", request_type=debugger.ListBreakpointsRequest +): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_breakpoints(request) + + +def test_list_breakpoints_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"debuggee_id": "sample1"} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/debugger/debuggees/{debuggee_id}/breakpoints" + % client.transport._host, + args[1], + ) + + +def test_list_breakpoints_rest_flattened_error(transport: str = "rest"): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_breakpoints( + debugger.ListBreakpointsRequest(), + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + +def test_list_breakpoints_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + debugger.ListDebuggeesRequest, + dict, + ], +) +def test_list_debuggees_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_debuggees(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.ListDebuggeesResponse) + + +def test_list_debuggees_rest_required_fields( + request_type=debugger.ListDebuggeesRequest, +): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["project"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + assert "project" not in jsonified_request + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_debuggees._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "project" in jsonified_request + assert jsonified_request["project"] == request_init["project"] + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["project"] = "project_value" + jsonified_request["clientVersion"] = "client_version_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_debuggees._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "client_version", + "include_inactive", + "project", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "project" in jsonified_request + assert jsonified_request["project"] == "project_value" + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == "client_version_value" + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_debuggees(request) + + expected_params = [ + ( + "project", + "", + ), + ( + "clientVersion", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_debuggees_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_debuggees._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "clientVersion", + "includeInactive", + "project", + ) + ) + & set( + ( + "project", + "clientVersion", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_debuggees_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Debugger2RestInterceptor, "post_list_debuggees" + ) as post, mock.patch.object( + transports.Debugger2RestInterceptor, "pre_list_debuggees" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListDebuggeesRequest.pb(debugger.ListDebuggeesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListDebuggeesResponse.to_json( + debugger.ListDebuggeesResponse() + ) + + request = debugger.ListDebuggeesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListDebuggeesResponse() + + client.list_debuggees( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_debuggees_rest_bad_request( + transport: str = "rest", request_type=debugger.ListDebuggeesRequest +): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_debuggees(request) + + +def test_list_debuggees_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + project="project_value", + client_version="client_version_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_debuggees(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/debugger/debuggees" % client.transport._host, args[1] + ) + + +def test_list_debuggees_rest_flattened_error(transport: str = "rest"): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_debuggees( + debugger.ListDebuggeesRequest(), + project="project_value", + client_version="client_version_value", + ) + + +def test_list_debuggees_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.Debugger2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.Debugger2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = Debugger2Client( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.Debugger2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = Debugger2Client( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = Debugger2Client( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.Debugger2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = Debugger2Client( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.Debugger2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = Debugger2Client(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.Debugger2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.Debugger2GrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.Debugger2GrpcTransport, + transports.Debugger2GrpcAsyncIOTransport, + transports.Debugger2RestTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "rest", + ], +) +def test_transport_kind(transport_name): + transport = Debugger2Client.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.Debugger2GrpcTransport, + ) + + +def test_debugger2_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.Debugger2Transport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_debugger2_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.debugger_v2.services.debugger2.transports.Debugger2Transport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.Debugger2Transport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "set_breakpoint", + "get_breakpoint", + "delete_breakpoint", + "list_breakpoints", + "list_debuggees", + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_debugger2_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.cloud.debugger_v2.services.debugger2.transports.Debugger2Transport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.Debugger2Transport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=( + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_debugger", + ), + quota_project_id="octopus", + ) + + +def test_debugger2_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( "google.cloud.debugger_v2.services.debugger2.transports.Debugger2Transport._prep_wrapped_messages" ) as Transport: @@ -2061,6 +3655,7 @@ def test_debugger2_transport_auth_adc(transport_class): [ transports.Debugger2GrpcTransport, transports.Debugger2GrpcAsyncIOTransport, + transports.Debugger2RestTransport, ], ) def test_debugger2_transport_auth_gdch_credentials(transport_class): @@ -2158,11 +3753,23 @@ def test_debugger2_grpc_transport_client_cert_source_for_mtls(transport_class): ) +def test_debugger2_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.Debugger2RestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_debugger2_host_no_port(transport_name): @@ -2173,7 +3780,11 @@ def test_debugger2_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("clouddebugger.googleapis.com:443") + assert client.transport._host == ( + "clouddebugger.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com" + ) @pytest.mark.parametrize( @@ -2181,6 +3792,7 @@ def test_debugger2_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_debugger2_host_with_port(transport_name): @@ -2191,7 +3803,45 @@ def test_debugger2_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("clouddebugger.googleapis.com:8000") + assert client.transport._host == ( + "clouddebugger.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_debugger2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Debugger2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Debugger2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.set_breakpoint._session + session2 = client2.transport.set_breakpoint._session + assert session1 != session2 + session1 = client1.transport.get_breakpoint._session + session2 = client2.transport.get_breakpoint._session + assert session1 != session2 + session1 = client1.transport.delete_breakpoint._session + session2 = client2.transport.delete_breakpoint._session + assert session1 != session2 + session1 = client1.transport.list_breakpoints._session + session2 = client2.transport.list_breakpoints._session + assert session1 != session2 + session1 = client1.transport.list_debuggees._session + session2 = client2.transport.list_debuggees._session + assert session1 != session2 def test_debugger2_grpc_transport_channel(): @@ -2454,6 +4104,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -2471,6 +4122,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: