diff --git a/google/cloud/ids_v1/gapic_metadata.json b/google/cloud/ids_v1/gapic_metadata.json index 8ae096d..01791cc 100644 --- a/google/cloud/ids_v1/gapic_metadata.json +++ b/google/cloud/ids_v1/gapic_metadata.json @@ -56,6 +56,31 @@ ] } } + }, + "rest": { + "libraryClient": "IDSClient", + "rpcs": { + "CreateEndpoint": { + "methods": [ + "create_endpoint" + ] + }, + "DeleteEndpoint": { + "methods": [ + "delete_endpoint" + ] + }, + "GetEndpoint": { + "methods": [ + "get_endpoint" + ] + }, + "ListEndpoints": { + "methods": [ + "list_endpoints" + ] + } + } } } } diff --git a/google/cloud/ids_v1/services/ids/client.py b/google/cloud/ids_v1/services/ids/client.py index fa84eab..2d5ece3 100644 --- a/google/cloud/ids_v1/services/ids/client.py +++ b/google/cloud/ids_v1/services/ids/client.py @@ -57,6 +57,7 @@ from .transports.base import DEFAULT_CLIENT_INFO, IDSTransport from .transports.grpc import IDSGrpcTransport from .transports.grpc_asyncio import IDSGrpcAsyncIOTransport +from .transports.rest import IDSRestTransport class IDSClientMeta(type): @@ -70,6 +71,7 @@ class IDSClientMeta(type): _transport_registry = OrderedDict() # type: Dict[str, Type[IDSTransport]] _transport_registry["grpc"] = IDSGrpcTransport _transport_registry["grpc_asyncio"] = IDSGrpcAsyncIOTransport + _transport_registry["rest"] = IDSRestTransport def get_transport_class( cls, diff --git a/google/cloud/ids_v1/services/ids/transports/__init__.py b/google/cloud/ids_v1/services/ids/transports/__init__.py index a6aa114..5f0004b 100644 --- a/google/cloud/ids_v1/services/ids/transports/__init__.py +++ b/google/cloud/ids_v1/services/ids/transports/__init__.py @@ -19,14 +19,18 @@ from .base import IDSTransport from .grpc import IDSGrpcTransport from .grpc_asyncio import IDSGrpcAsyncIOTransport +from .rest import IDSRestInterceptor, IDSRestTransport # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[IDSTransport]] _transport_registry["grpc"] = IDSGrpcTransport _transport_registry["grpc_asyncio"] = IDSGrpcAsyncIOTransport +_transport_registry["rest"] = IDSRestTransport __all__ = ( "IDSTransport", "IDSGrpcTransport", "IDSGrpcAsyncIOTransport", + "IDSRestTransport", + "IDSRestInterceptor", ) diff --git a/google/cloud/ids_v1/services/ids/transports/rest.py b/google/cloud/ids_v1/services/ids/transports/rest.py new file mode 100644 index 0000000..1d43ed8 --- /dev/null +++ b/google/cloud/ids_v1/services/ids/transports/rest.py @@ -0,0 +1,718 @@ +# -*- 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 Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import ( + gapic_v1, + operations_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.longrunning import operations_pb2 # type: ignore + +from google.cloud.ids_v1.types import ids + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .base import IDSTransport + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class IDSRestInterceptor: + """Interceptor for IDS. + + 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 IDSRestTransport. + + .. code-block:: python + class MyCustomIDSInterceptor(IDSRestInterceptor): + def pre_create_endpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_endpoint(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_endpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_delete_endpoint(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_endpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_endpoint(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_endpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_endpoints(self, response): + logging.log(f"Received response: {response}") + return response + + transport = IDSRestTransport(interceptor=MyCustomIDSInterceptor()) + client = IDSClient(transport=transport) + + + """ + + def pre_create_endpoint( + self, request: ids.CreateEndpointRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[ids.CreateEndpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_endpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the IDS server. + """ + return request, metadata + + def post_create_endpoint( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for create_endpoint + + Override in a subclass to manipulate the response + after it is returned by the IDS server but before + it is returned to user code. + """ + return response + + def pre_delete_endpoint( + self, request: ids.DeleteEndpointRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[ids.DeleteEndpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_endpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the IDS server. + """ + return request, metadata + + def post_delete_endpoint( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for delete_endpoint + + Override in a subclass to manipulate the response + after it is returned by the IDS server but before + it is returned to user code. + """ + return response + + def pre_get_endpoint( + self, request: ids.GetEndpointRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[ids.GetEndpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_endpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the IDS server. + """ + return request, metadata + + def post_get_endpoint(self, response: ids.Endpoint) -> ids.Endpoint: + """Post-rpc interceptor for get_endpoint + + Override in a subclass to manipulate the response + after it is returned by the IDS server but before + it is returned to user code. + """ + return response + + def pre_list_endpoints( + self, request: ids.ListEndpointsRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[ids.ListEndpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_endpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the IDS server. + """ + return request, metadata + + def post_list_endpoints( + self, response: ids.ListEndpointsResponse + ) -> ids.ListEndpointsResponse: + """Post-rpc interceptor for list_endpoints + + Override in a subclass to manipulate the response + after it is returned by the IDS server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class IDSRestStub: + _session: AuthorizedSession + _host: str + _interceptor: IDSRestInterceptor + + +class IDSRestTransport(IDSTransport): + """REST backend transport for IDS. + + The IDS 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 = "ids.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[IDSRestInterceptor] = 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 + ) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or IDSRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = {} + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + path_prefix="v1", + ) + + self._operations_client = operations_v1.AbstractOperationsClient( + transport=rest_transport + ) + + # Return the client from cache. + return self._operations_client + + class _CreateEndpoint(IDSRestStub): + def __hash__(self): + return hash("CreateEndpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "endpointId": "", + } + + @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: ids.CreateEndpointRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the create endpoint method over HTTP. + + Args: + request (~.ids.CreateEndpointRequest): + The request object. + 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: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*}/endpoints", + "body": "endpoint", + }, + ] + request, metadata = self._interceptor.pre_create_endpoint(request, metadata) + pb_request = ids.CreateEndpointRequest.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 = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_endpoint(resp) + return resp + + class _DeleteEndpoint(IDSRestStub): + def __hash__(self): + return hash("DeleteEndpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @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: ids.DeleteEndpointRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the delete endpoint method over HTTP. + + Args: + request (~.ids.DeleteEndpointRequest): + The request object. + 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: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1/{name=projects/*/locations/*/endpoints/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_endpoint(request, metadata) + pb_request = ids.DeleteEndpointRequest.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 = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_delete_endpoint(resp) + return resp + + class _GetEndpoint(IDSRestStub): + def __hash__(self): + return hash("GetEndpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @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: ids.GetEndpointRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> ids.Endpoint: + r"""Call the get endpoint method over HTTP. + + Args: + request (~.ids.GetEndpointRequest): + The request object. + 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: + ~.ids.Endpoint: + Endpoint describes a single IDS + endpoint. It defines a forwarding rule + to which packets can be sent for IDS + inspection. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/endpoints/*}", + }, + ] + request, metadata = self._interceptor.pre_get_endpoint(request, metadata) + pb_request = ids.GetEndpointRequest.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 = ids.Endpoint() + pb_resp = ids.Endpoint.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_endpoint(resp) + return resp + + class _ListEndpoints(IDSRestStub): + def __hash__(self): + return hash("ListEndpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @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: ids.ListEndpointsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> ids.ListEndpointsResponse: + r"""Call the list endpoints method over HTTP. + + Args: + request (~.ids.ListEndpointsRequest): + The request object. + 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: + ~.ids.ListEndpointsResponse: + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*}/endpoints", + }, + ] + request, metadata = self._interceptor.pre_list_endpoints(request, metadata) + pb_request = ids.ListEndpointsRequest.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 = ids.ListEndpointsResponse() + pb_resp = ids.ListEndpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_endpoints(resp) + return resp + + @property + def create_endpoint( + self, + ) -> Callable[[ids.CreateEndpointRequest], operations_pb2.Operation]: + # 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._CreateEndpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_endpoint( + self, + ) -> Callable[[ids.DeleteEndpointRequest], operations_pb2.Operation]: + # 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._DeleteEndpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_endpoint(self) -> Callable[[ids.GetEndpointRequest], ids.Endpoint]: + # 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._GetEndpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_endpoints( + self, + ) -> Callable[[ids.ListEndpointsRequest], ids.ListEndpointsResponse]: + # 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._ListEndpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("IDSRestTransport",) diff --git a/tests/unit/gapic/ids_v1/test_ids.py b/tests/unit/gapic/ids_v1/test_ids.py index 9320049..25e2b26 100644 --- a/tests/unit/gapic/ids_v1/test_ids.py +++ b/tests/unit/gapic/ids_v1/test_ids.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 ( @@ -42,12 +44,15 @@ from google.longrunning import operations_pb2 from google.oauth2 import service_account from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import json_format from google.protobuf import timestamp_pb2 # type: ignore import grpc from grpc.experimental import aio 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.ids_v1.services.ids import ( IDSAsyncClient, @@ -98,6 +103,7 @@ def test__get_default_mtls_endpoint(): [ (IDSClient, "grpc"), (IDSAsyncClient, "grpc_asyncio"), + (IDSClient, "rest"), ], ) def test_ids_client_from_service_account_info(client_class, transport_name): @@ -111,7 +117,11 @@ def test_ids_client_from_service_account_info(client_class, transport_name): assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("ids.googleapis.com:443") + assert client.transport._host == ( + "ids.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://ids.googleapis.com" + ) @pytest.mark.parametrize( @@ -119,6 +129,7 @@ def test_ids_client_from_service_account_info(client_class, transport_name): [ (transports.IDSGrpcTransport, "grpc"), (transports.IDSGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.IDSRestTransport, "rest"), ], ) def test_ids_client_service_account_always_use_jwt(transport_class, transport_name): @@ -142,6 +153,7 @@ def test_ids_client_service_account_always_use_jwt(transport_class, transport_na [ (IDSClient, "grpc"), (IDSAsyncClient, "grpc_asyncio"), + (IDSClient, "rest"), ], ) def test_ids_client_from_service_account_file(client_class, transport_name): @@ -162,13 +174,18 @@ def test_ids_client_from_service_account_file(client_class, transport_name): assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("ids.googleapis.com:443") + assert client.transport._host == ( + "ids.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://ids.googleapis.com" + ) def test_ids_client_get_transport_class(): transport = IDSClient.get_transport_class() available_transports = [ transports.IDSGrpcTransport, + transports.IDSRestTransport, ] assert transport in available_transports @@ -181,6 +198,7 @@ def test_ids_client_get_transport_class(): [ (IDSClient, transports.IDSGrpcTransport, "grpc"), (IDSAsyncClient, transports.IDSGrpcAsyncIOTransport, "grpc_asyncio"), + (IDSClient, transports.IDSRestTransport, "rest"), ], ) @mock.patch.object(IDSClient, "DEFAULT_ENDPOINT", modify_default_endpoint(IDSClient)) @@ -308,6 +326,8 @@ def test_ids_client_client_options(client_class, transport_class, transport_name (IDSAsyncClient, transports.IDSGrpcAsyncIOTransport, "grpc_asyncio", "true"), (IDSClient, transports.IDSGrpcTransport, "grpc", "false"), (IDSAsyncClient, transports.IDSGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (IDSClient, transports.IDSRestTransport, "rest", "true"), + (IDSClient, transports.IDSRestTransport, "rest", "false"), ], ) @mock.patch.object(IDSClient, "DEFAULT_ENDPOINT", modify_default_endpoint(IDSClient)) @@ -489,6 +509,7 @@ def test_ids_client_get_mtls_endpoint_and_cert_source(client_class): [ (IDSClient, transports.IDSGrpcTransport, "grpc"), (IDSAsyncClient, transports.IDSGrpcAsyncIOTransport, "grpc_asyncio"), + (IDSClient, transports.IDSRestTransport, "rest"), ], ) def test_ids_client_client_options_scopes( @@ -524,6 +545,7 @@ def test_ids_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (IDSClient, transports.IDSRestTransport, "rest", None), ], ) def test_ids_client_client_options_credentials_file( @@ -1781,6 +1803,1199 @@ async def test_delete_endpoint_flattened_error_async(): ) +@pytest.mark.parametrize( + "request_type", + [ + ids.ListEndpointsRequest, + dict, + ], +) +def test_list_endpoints_rest(request_type): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/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 = ids.ListEndpointsResponse( + next_page_token="next_page_token_value", + unreachable=["unreachable_value"], + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = ids.ListEndpointsResponse.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_endpoints(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListEndpointsPager) + assert response.next_page_token == "next_page_token_value" + assert response.unreachable == ["unreachable_value"] + + +def test_list_endpoints_rest_required_fields(request_type=ids.ListEndpointsRequest): + transport_class = transports.IDSRestTransport + + request_init = {} + request_init["parent"] = "" + 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_endpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_endpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "filter", + "order_by", + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = ids.ListEndpointsResponse() + # 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 = ids.ListEndpointsResponse.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_endpoints(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_endpoints_rest_unset_required_fields(): + transport = transports.IDSRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_endpoints._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "filter", + "orderBy", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_endpoints_rest_interceptors(null_interceptor): + transport = transports.IDSRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.IDSRestInterceptor(), + ) + client = IDSClient(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.IDSRestInterceptor, "post_list_endpoints" + ) as post, mock.patch.object( + transports.IDSRestInterceptor, "pre_list_endpoints" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = ids.ListEndpointsRequest.pb(ids.ListEndpointsRequest()) + 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 = ids.ListEndpointsResponse.to_json( + ids.ListEndpointsResponse() + ) + + request = ids.ListEndpointsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = ids.ListEndpointsResponse() + + client.list_endpoints( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_endpoints_rest_bad_request( + transport: str = "rest", request_type=ids.ListEndpointsRequest +): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/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.list_endpoints(request) + + +def test_list_endpoints_rest_flattened(): + client = IDSClient( + 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 = ids.ListEndpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_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 = ids.ListEndpointsResponse.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_endpoints(**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/v1/{parent=projects/*/locations/*}/endpoints" % client.transport._host, + args[1], + ) + + +def test_list_endpoints_rest_flattened_error(transport: str = "rest"): + client = IDSClient( + 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_endpoints( + ids.ListEndpointsRequest(), + parent="parent_value", + ) + + +def test_list_endpoints_rest_pager(transport: str = "rest"): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + ids.ListEndpointsResponse( + endpoints=[ + ids.Endpoint(), + ids.Endpoint(), + ids.Endpoint(), + ], + next_page_token="abc", + ), + ids.ListEndpointsResponse( + endpoints=[], + next_page_token="def", + ), + ids.ListEndpointsResponse( + endpoints=[ + ids.Endpoint(), + ], + next_page_token="ghi", + ), + ids.ListEndpointsResponse( + endpoints=[ + ids.Endpoint(), + ids.Endpoint(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple(ids.ListEndpointsResponse.to_json(x) for x in response) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {"parent": "projects/sample1/locations/sample2"} + + pager = client.list_endpoints(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, ids.Endpoint) for i in results) + + pages = list(client.list_endpoints(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + ids.GetEndpointRequest, + dict, + ], +) +def test_get_endpoint_rest(request_type): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/endpoints/sample3"} + 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 = ids.Endpoint( + name="name_value", + network="network_value", + endpoint_forwarding_rule="endpoint_forwarding_rule_value", + endpoint_ip="endpoint_ip_value", + description="description_value", + severity=ids.Endpoint.Severity.INFORMATIONAL, + state=ids.Endpoint.State.CREATING, + traffic_logs=True, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = ids.Endpoint.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_endpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, ids.Endpoint) + assert response.name == "name_value" + assert response.network == "network_value" + assert response.endpoint_forwarding_rule == "endpoint_forwarding_rule_value" + assert response.endpoint_ip == "endpoint_ip_value" + assert response.description == "description_value" + assert response.severity == ids.Endpoint.Severity.INFORMATIONAL + assert response.state == ids.Endpoint.State.CREATING + assert response.traffic_logs is True + + +def test_get_endpoint_rest_required_fields(request_type=ids.GetEndpointRequest): + transport_class = transports.IDSRestTransport + + request_init = {} + request_init["name"] = "" + 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() + ).get_endpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_endpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = ids.Endpoint() + # 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 = ids.Endpoint.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_endpoint(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_endpoint_rest_unset_required_fields(): + transport = transports.IDSRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_endpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_endpoint_rest_interceptors(null_interceptor): + transport = transports.IDSRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.IDSRestInterceptor(), + ) + client = IDSClient(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.IDSRestInterceptor, "post_get_endpoint" + ) as post, mock.patch.object( + transports.IDSRestInterceptor, "pre_get_endpoint" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = ids.GetEndpointRequest.pb(ids.GetEndpointRequest()) + 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 = ids.Endpoint.to_json(ids.Endpoint()) + + request = ids.GetEndpointRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = ids.Endpoint() + + client.get_endpoint( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_endpoint_rest_bad_request( + transport: str = "rest", request_type=ids.GetEndpointRequest +): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/endpoints/sample3"} + 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.get_endpoint(request) + + +def test_get_endpoint_rest_flattened(): + client = IDSClient( + 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 = ids.Endpoint() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/endpoints/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_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 = ids.Endpoint.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_endpoint(**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/v1/{name=projects/*/locations/*/endpoints/*}" % client.transport._host, + args[1], + ) + + +def test_get_endpoint_rest_flattened_error(transport: str = "rest"): + client = IDSClient( + 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_endpoint( + ids.GetEndpointRequest(), + name="name_value", + ) + + +def test_get_endpoint_rest_error(): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + ids.CreateEndpointRequest, + dict, + ], +) +def test_create_endpoint_rest(request_type): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["endpoint"] = { + "name": "name_value", + "create_time": {"seconds": 751, "nanos": 543}, + "update_time": {}, + "labels": {}, + "network": "network_value", + "endpoint_forwarding_rule": "endpoint_forwarding_rule_value", + "endpoint_ip": "endpoint_ip_value", + "description": "description_value", + "severity": 1, + "state": 1, + "traffic_logs": True, + } + 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 = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.create_endpoint(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_create_endpoint_rest_required_fields(request_type=ids.CreateEndpointRequest): + transport_class = transports.IDSRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["endpoint_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 + assert "endpointId" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_endpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "endpointId" in jsonified_request + assert jsonified_request["endpointId"] == request_init["endpoint_id"] + + jsonified_request["parent"] = "parent_value" + jsonified_request["endpointId"] = "endpoint_id_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_endpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "endpoint_id", + "request_id", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + assert "endpointId" in jsonified_request + assert jsonified_request["endpointId"] == "endpoint_id_value" + + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # 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 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.create_endpoint(request) + + expected_params = [ + ( + "endpointId", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_endpoint_rest_unset_required_fields(): + transport = transports.IDSRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_endpoint._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "endpointId", + "requestId", + ) + ) + & set( + ( + "parent", + "endpointId", + "endpoint", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_endpoint_rest_interceptors(null_interceptor): + transport = transports.IDSRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.IDSRestInterceptor(), + ) + client = IDSClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.IDSRestInterceptor, "post_create_endpoint" + ) as post, mock.patch.object( + transports.IDSRestInterceptor, "pre_create_endpoint" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = ids.CreateEndpointRequest.pb(ids.CreateEndpointRequest()) + 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 = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = ids.CreateEndpointRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.create_endpoint( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_endpoint_rest_bad_request( + transport: str = "rest", request_type=ids.CreateEndpointRequest +): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["endpoint"] = { + "name": "name_value", + "create_time": {"seconds": 751, "nanos": 543}, + "update_time": {}, + "labels": {}, + "network": "network_value", + "endpoint_forwarding_rule": "endpoint_forwarding_rule_value", + "endpoint_ip": "endpoint_ip_value", + "description": "description_value", + "severity": 1, + "state": 1, + "traffic_logs": True, + } + 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.create_endpoint(request) + + +def test_create_endpoint_rest_flattened(): + client = IDSClient( + 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 = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + endpoint=ids.Endpoint(name="name_value"), + endpoint_id="endpoint_id_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 = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.create_endpoint(**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/v1/{parent=projects/*/locations/*}/endpoints" % client.transport._host, + args[1], + ) + + +def test_create_endpoint_rest_flattened_error(transport: str = "rest"): + client = IDSClient( + 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.create_endpoint( + ids.CreateEndpointRequest(), + parent="parent_value", + endpoint=ids.Endpoint(name="name_value"), + endpoint_id="endpoint_id_value", + ) + + +def test_create_endpoint_rest_error(): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + ids.DeleteEndpointRequest, + dict, + ], +) +def test_delete_endpoint_rest(request_type): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/endpoints/sample3"} + 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 = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_endpoint(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_delete_endpoint_rest_required_fields(request_type=ids.DeleteEndpointRequest): + transport_class = transports.IDSRestTransport + + request_init = {} + request_init["name"] = "" + 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() + ).delete_endpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_endpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("request_id",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # 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 = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_endpoint(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_endpoint_rest_unset_required_fields(): + transport = transports.IDSRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_endpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("requestId",)) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_endpoint_rest_interceptors(null_interceptor): + transport = transports.IDSRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.IDSRestInterceptor(), + ) + client = IDSClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.IDSRestInterceptor, "post_delete_endpoint" + ) as post, mock.patch.object( + transports.IDSRestInterceptor, "pre_delete_endpoint" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = ids.DeleteEndpointRequest.pb(ids.DeleteEndpointRequest()) + 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 = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = ids.DeleteEndpointRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.delete_endpoint( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_delete_endpoint_rest_bad_request( + transport: str = "rest", request_type=ids.DeleteEndpointRequest +): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/endpoints/sample3"} + 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_endpoint(request) + + +def test_delete_endpoint_rest_flattened(): + client = IDSClient( + 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 = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/endpoints/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_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 = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_endpoint(**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/v1/{name=projects/*/locations/*/endpoints/*}" % client.transport._host, + args[1], + ) + + +def test_delete_endpoint_rest_flattened_error(transport: str = "rest"): + client = IDSClient( + 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_endpoint( + ids.DeleteEndpointRequest(), + name="name_value", + ) + + +def test_delete_endpoint_rest_error(): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.IDSGrpcTransport( @@ -1862,6 +3077,7 @@ def test_transport_get_channel(): [ transports.IDSGrpcTransport, transports.IDSGrpcAsyncIOTransport, + transports.IDSRestTransport, ], ) def test_transport_adc(transport_class): @@ -1876,6 +3092,7 @@ def test_transport_adc(transport_class): "transport_name", [ "grpc", + "rest", ], ) def test_transport_kind(transport_name): @@ -2013,6 +3230,7 @@ def test_ids_transport_auth_adc(transport_class): [ transports.IDSGrpcTransport, transports.IDSGrpcAsyncIOTransport, + transports.IDSRestTransport, ], ) def test_ids_transport_auth_gdch_credentials(transport_class): @@ -2106,11 +3324,40 @@ def test_ids_grpc_transport_client_cert_source_for_mtls(transport_class): ) +def test_ids_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.IDSRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_ids_rest_lro_client(): + client = IDSClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_ids_host_no_port(transport_name): @@ -2119,7 +3366,11 @@ def test_ids_host_no_port(transport_name): client_options=client_options.ClientOptions(api_endpoint="ids.googleapis.com"), transport=transport_name, ) - assert client.transport._host == ("ids.googleapis.com:443") + assert client.transport._host == ( + "ids.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://ids.googleapis.com" + ) @pytest.mark.parametrize( @@ -2127,6 +3378,7 @@ def test_ids_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_ids_host_with_port(transport_name): @@ -2137,7 +3389,42 @@ def test_ids_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("ids.googleapis.com:8000") + assert client.transport._host == ( + "ids.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://ids.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_ids_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = IDSClient( + credentials=creds1, + transport=transport_name, + ) + client2 = IDSClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.list_endpoints._session + session2 = client2.transport.list_endpoints._session + assert session1 != session2 + session1 = client1.transport.get_endpoint._session + session2 = client2.transport.get_endpoint._session + assert session1 != session2 + session1 = client1.transport.create_endpoint._session + session2 = client2.transport.create_endpoint._session + assert session1 != session2 + session1 = client1.transport.delete_endpoint._session + session2 = client2.transport.delete_endpoint._session + assert session1 != session2 def test_ids_grpc_transport_channel(): @@ -2454,6 +3741,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -2471,6 +3759,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: