diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1/gapic_metadata.json b/packages/google-cloud-recommender/google/cloud/recommender_v1/gapic_metadata.json index 8f770bc156c6..022ebef594ee 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1/gapic_metadata.json +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1/gapic_metadata.json @@ -136,6 +136,71 @@ ] } } + }, + "rest": { + "libraryClient": "RecommenderClient", + "rpcs": { + "GetInsight": { + "methods": [ + "get_insight" + ] + }, + "GetInsightTypeConfig": { + "methods": [ + "get_insight_type_config" + ] + }, + "GetRecommendation": { + "methods": [ + "get_recommendation" + ] + }, + "GetRecommenderConfig": { + "methods": [ + "get_recommender_config" + ] + }, + "ListInsights": { + "methods": [ + "list_insights" + ] + }, + "ListRecommendations": { + "methods": [ + "list_recommendations" + ] + }, + "MarkInsightAccepted": { + "methods": [ + "mark_insight_accepted" + ] + }, + "MarkRecommendationClaimed": { + "methods": [ + "mark_recommendation_claimed" + ] + }, + "MarkRecommendationFailed": { + "methods": [ + "mark_recommendation_failed" + ] + }, + "MarkRecommendationSucceeded": { + "methods": [ + "mark_recommendation_succeeded" + ] + }, + "UpdateInsightTypeConfig": { + "methods": [ + "update_insight_type_config" + ] + }, + "UpdateRecommenderConfig": { + "methods": [ + "update_recommender_config" + ] + } + } } } } diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/client.py b/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/client.py index 1dade1ccac9a..4cc33cbcd4d6 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/client.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/client.py @@ -67,6 +67,7 @@ from .transports.base import DEFAULT_CLIENT_INFO, RecommenderTransport from .transports.grpc import RecommenderGrpcTransport from .transports.grpc_asyncio import RecommenderGrpcAsyncIOTransport +from .transports.rest import RecommenderRestTransport class RecommenderClientMeta(type): @@ -80,6 +81,7 @@ class RecommenderClientMeta(type): _transport_registry = OrderedDict() # type: Dict[str, Type[RecommenderTransport]] _transport_registry["grpc"] = RecommenderGrpcTransport _transport_registry["grpc_asyncio"] = RecommenderGrpcAsyncIOTransport + _transport_registry["rest"] = RecommenderRestTransport def get_transport_class( cls, diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/transports/__init__.py b/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/transports/__init__.py index d13734288c03..5d37b945ae30 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/transports/__init__.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/transports/__init__.py @@ -19,14 +19,18 @@ from .base import RecommenderTransport from .grpc import RecommenderGrpcTransport from .grpc_asyncio import RecommenderGrpcAsyncIOTransport +from .rest import RecommenderRestInterceptor, RecommenderRestTransport # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[RecommenderTransport]] _transport_registry["grpc"] = RecommenderGrpcTransport _transport_registry["grpc_asyncio"] = RecommenderGrpcAsyncIOTransport +_transport_registry["rest"] = RecommenderRestTransport __all__ = ( "RecommenderTransport", "RecommenderGrpcTransport", "RecommenderGrpcAsyncIOTransport", + "RecommenderRestTransport", + "RecommenderRestInterceptor", ) diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/transports/rest.py b/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/transports/rest.py new file mode 100644 index 000000000000..3dab705bb557 --- /dev/null +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1/services/recommender/transports/rest.py @@ -0,0 +1,1967 @@ +# -*- 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.recommender_v1.types import ( + insight_type_config as gcr_insight_type_config, +) +from google.cloud.recommender_v1.types import ( + recommender_config as gcr_recommender_config, +) +from google.cloud.recommender_v1.types import insight +from google.cloud.recommender_v1.types import insight_type_config +from google.cloud.recommender_v1.types import recommendation +from google.cloud.recommender_v1.types import recommender_config +from google.cloud.recommender_v1.types import recommender_service + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .base import RecommenderTransport + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class RecommenderRestInterceptor: + """Interceptor for Recommender. + + 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 RecommenderRestTransport. + + .. code-block:: python + class MyCustomRecommenderInterceptor(RecommenderRestInterceptor): + def pre_get_insight(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_insight(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_insight_type_config(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_insight_type_config(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_recommendation(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_recommendation(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_recommender_config(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_recommender_config(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_insights(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_insights(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_recommendations(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_recommendations(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_mark_insight_accepted(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_mark_insight_accepted(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_mark_recommendation_claimed(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_mark_recommendation_claimed(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_mark_recommendation_failed(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_mark_recommendation_failed(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_mark_recommendation_succeeded(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_mark_recommendation_succeeded(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_insight_type_config(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_insight_type_config(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_recommender_config(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_recommender_config(self, response): + logging.log(f"Received response: {response}") + return response + + transport = RecommenderRestTransport(interceptor=MyCustomRecommenderInterceptor()) + client = RecommenderClient(transport=transport) + + + """ + + def pre_get_insight( + self, + request: recommender_service.GetInsightRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[recommender_service.GetInsightRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_insight + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_get_insight(self, response: insight.Insight) -> insight.Insight: + """Post-rpc interceptor for get_insight + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_get_insight_type_config( + self, + request: recommender_service.GetInsightTypeConfigRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.GetInsightTypeConfigRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for get_insight_type_config + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_get_insight_type_config( + self, response: insight_type_config.InsightTypeConfig + ) -> insight_type_config.InsightTypeConfig: + """Post-rpc interceptor for get_insight_type_config + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_get_recommendation( + self, + request: recommender_service.GetRecommendationRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[recommender_service.GetRecommendationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_recommendation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_get_recommendation( + self, response: recommendation.Recommendation + ) -> recommendation.Recommendation: + """Post-rpc interceptor for get_recommendation + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_get_recommender_config( + self, + request: recommender_service.GetRecommenderConfigRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.GetRecommenderConfigRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for get_recommender_config + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_get_recommender_config( + self, response: recommender_config.RecommenderConfig + ) -> recommender_config.RecommenderConfig: + """Post-rpc interceptor for get_recommender_config + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_list_insights( + self, + request: recommender_service.ListInsightsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[recommender_service.ListInsightsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_insights + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_list_insights( + self, response: recommender_service.ListInsightsResponse + ) -> recommender_service.ListInsightsResponse: + """Post-rpc interceptor for list_insights + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_list_recommendations( + self, + request: recommender_service.ListRecommendationsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.ListRecommendationsRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for list_recommendations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_list_recommendations( + self, response: recommender_service.ListRecommendationsResponse + ) -> recommender_service.ListRecommendationsResponse: + """Post-rpc interceptor for list_recommendations + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_mark_insight_accepted( + self, + request: recommender_service.MarkInsightAcceptedRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.MarkInsightAcceptedRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for mark_insight_accepted + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_mark_insight_accepted(self, response: insight.Insight) -> insight.Insight: + """Post-rpc interceptor for mark_insight_accepted + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_mark_recommendation_claimed( + self, + request: recommender_service.MarkRecommendationClaimedRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.MarkRecommendationClaimedRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for mark_recommendation_claimed + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_mark_recommendation_claimed( + self, response: recommendation.Recommendation + ) -> recommendation.Recommendation: + """Post-rpc interceptor for mark_recommendation_claimed + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_mark_recommendation_failed( + self, + request: recommender_service.MarkRecommendationFailedRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.MarkRecommendationFailedRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for mark_recommendation_failed + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_mark_recommendation_failed( + self, response: recommendation.Recommendation + ) -> recommendation.Recommendation: + """Post-rpc interceptor for mark_recommendation_failed + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_mark_recommendation_succeeded( + self, + request: recommender_service.MarkRecommendationSucceededRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.MarkRecommendationSucceededRequest, + Sequence[Tuple[str, str]], + ]: + """Pre-rpc interceptor for mark_recommendation_succeeded + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_mark_recommendation_succeeded( + self, response: recommendation.Recommendation + ) -> recommendation.Recommendation: + """Post-rpc interceptor for mark_recommendation_succeeded + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_update_insight_type_config( + self, + request: recommender_service.UpdateInsightTypeConfigRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.UpdateInsightTypeConfigRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for update_insight_type_config + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_update_insight_type_config( + self, response: gcr_insight_type_config.InsightTypeConfig + ) -> gcr_insight_type_config.InsightTypeConfig: + """Post-rpc interceptor for update_insight_type_config + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_update_recommender_config( + self, + request: recommender_service.UpdateRecommenderConfigRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.UpdateRecommenderConfigRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for update_recommender_config + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_update_recommender_config( + self, response: gcr_recommender_config.RecommenderConfig + ) -> gcr_recommender_config.RecommenderConfig: + """Post-rpc interceptor for update_recommender_config + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class RecommenderRestStub: + _session: AuthorizedSession + _host: str + _interceptor: RecommenderRestInterceptor + + +class RecommenderRestTransport(RecommenderTransport): + """REST backend transport for Recommender. + + Provides insights and recommendations for cloud customers for + various categories like performance optimization, cost savings, + reliability, feature discovery, etc. Insights and + recommendations are generated automatically based on analysis of + user resources, configuration and monitoring metrics. + + 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 = "recommender.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[RecommenderRestInterceptor] = 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 RecommenderRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _GetInsight(RecommenderRestStub): + def __hash__(self): + return hash("GetInsight") + + __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: recommender_service.GetInsightRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight.Insight: + r"""Call the get insight method over HTTP. + + Args: + request (~.recommender_service.GetInsightRequest): + The request object. Request to the ``GetInsight`` method. + 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: + ~.insight.Insight: + An insight along with the information + used to derive the insight. The insight + may have associated recomendations as + well. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/insightTypes/*/insights/*}", + }, + { + "method": "get", + "uri": "/v1/{name=billingAccounts/*/locations/*/insightTypes/*/insights/*}", + }, + { + "method": "get", + "uri": "/v1/{name=folders/*/locations/*/insightTypes/*/insights/*}", + }, + { + "method": "get", + "uri": "/v1/{name=organizations/*/locations/*/insightTypes/*/insights/*}", + }, + ] + request, metadata = self._interceptor.pre_get_insight(request, metadata) + pb_request = recommender_service.GetInsightRequest.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 = insight.Insight() + pb_resp = insight.Insight.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_insight(resp) + return resp + + class _GetInsightTypeConfig(RecommenderRestStub): + def __hash__(self): + return hash("GetInsightTypeConfig") + + __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: recommender_service.GetInsightTypeConfigRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight_type_config.InsightTypeConfig: + r"""Call the get insight type config method over HTTP. + + Args: + request (~.recommender_service.GetInsightTypeConfigRequest): + The request object. Request for the GetInsightTypeConfig\` method. + 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: + ~.insight_type_config.InsightTypeConfig: + Configuration for an InsightType. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/insightTypes/*/config}", + }, + { + "method": "get", + "uri": "/v1/{name=organizations/*/locations/*/insightTypes/*/config}", + }, + ] + request, metadata = self._interceptor.pre_get_insight_type_config( + request, metadata + ) + pb_request = recommender_service.GetInsightTypeConfigRequest.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 = insight_type_config.InsightTypeConfig() + pb_resp = insight_type_config.InsightTypeConfig.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_insight_type_config(resp) + return resp + + class _GetRecommendation(RecommenderRestStub): + def __hash__(self): + return hash("GetRecommendation") + + __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: recommender_service.GetRecommendationRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Call the get recommendation method over HTTP. + + Args: + request (~.recommender_service.GetRecommendationRequest): + The request object. Request to the ``GetRecommendation`` method. + 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: + ~.recommendation.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/recommenders/*/recommendations/*}", + }, + { + "method": "get", + "uri": "/v1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}", + }, + { + "method": "get", + "uri": "/v1/{name=folders/*/locations/*/recommenders/*/recommendations/*}", + }, + { + "method": "get", + "uri": "/v1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}", + }, + ] + request, metadata = self._interceptor.pre_get_recommendation( + request, metadata + ) + pb_request = recommender_service.GetRecommendationRequest.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 = recommendation.Recommendation() + pb_resp = recommendation.Recommendation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_recommendation(resp) + return resp + + class _GetRecommenderConfig(RecommenderRestStub): + def __hash__(self): + return hash("GetRecommenderConfig") + + __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: recommender_service.GetRecommenderConfigRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommender_config.RecommenderConfig: + r"""Call the get recommender config method over HTTP. + + Args: + request (~.recommender_service.GetRecommenderConfigRequest): + The request object. Request for the GetRecommenderConfig\` method. + 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: + ~.recommender_config.RecommenderConfig: + Configuration for a Recommender. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/recommenders/*/config}", + }, + { + "method": "get", + "uri": "/v1/{name=organizations/*/locations/*/recommenders/*/config}", + }, + ] + request, metadata = self._interceptor.pre_get_recommender_config( + request, metadata + ) + pb_request = recommender_service.GetRecommenderConfigRequest.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 = recommender_config.RecommenderConfig() + pb_resp = recommender_config.RecommenderConfig.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_recommender_config(resp) + return resp + + class _ListInsights(RecommenderRestStub): + def __hash__(self): + return hash("ListInsights") + + __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: recommender_service.ListInsightsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommender_service.ListInsightsResponse: + r"""Call the list insights method over HTTP. + + Args: + request (~.recommender_service.ListInsightsRequest): + The request object. Request for the ``ListInsights`` method. + 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: + ~.recommender_service.ListInsightsResponse: + Response to the ``ListInsights`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*/insightTypes/*}/insights", + }, + { + "method": "get", + "uri": "/v1/{parent=billingAccounts/*/locations/*/insightTypes/*}/insights", + }, + { + "method": "get", + "uri": "/v1/{parent=folders/*/locations/*/insightTypes/*}/insights", + }, + { + "method": "get", + "uri": "/v1/{parent=organizations/*/locations/*/insightTypes/*}/insights", + }, + ] + request, metadata = self._interceptor.pre_list_insights(request, metadata) + pb_request = recommender_service.ListInsightsRequest.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 = recommender_service.ListInsightsResponse() + pb_resp = recommender_service.ListInsightsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_insights(resp) + return resp + + class _ListRecommendations(RecommenderRestStub): + def __hash__(self): + return hash("ListRecommendations") + + __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: recommender_service.ListRecommendationsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommender_service.ListRecommendationsResponse: + r"""Call the list recommendations method over HTTP. + + Args: + request (~.recommender_service.ListRecommendationsRequest): + The request object. Request for the ``ListRecommendations`` method. + 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: + ~.recommender_service.ListRecommendationsResponse: + Response to the ``ListRecommendations`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*/recommenders/*}/recommendations", + }, + { + "method": "get", + "uri": "/v1/{parent=billingAccounts/*/locations/*/recommenders/*}/recommendations", + }, + { + "method": "get", + "uri": "/v1/{parent=folders/*/locations/*/recommenders/*}/recommendations", + }, + { + "method": "get", + "uri": "/v1/{parent=organizations/*/locations/*/recommenders/*}/recommendations", + }, + ] + request, metadata = self._interceptor.pre_list_recommendations( + request, metadata + ) + pb_request = recommender_service.ListRecommendationsRequest.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 = recommender_service.ListRecommendationsResponse() + pb_resp = recommender_service.ListRecommendationsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_recommendations(resp) + return resp + + class _MarkInsightAccepted(RecommenderRestStub): + def __hash__(self): + return hash("MarkInsightAccepted") + + __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: recommender_service.MarkInsightAcceptedRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight.Insight: + r"""Call the mark insight accepted method over HTTP. + + Args: + request (~.recommender_service.MarkInsightAcceptedRequest): + The request object. Request for the ``MarkInsightAccepted`` method. + 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: + ~.insight.Insight: + An insight along with the information + used to derive the insight. The insight + may have associated recomendations as + well. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{name=projects/*/locations/*/insightTypes/*/insights/*}:markAccepted", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=billingAccounts/*/locations/*/insightTypes/*/insights/*}:markAccepted", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=folders/*/locations/*/insightTypes/*/insights/*}:markAccepted", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=organizations/*/locations/*/insightTypes/*/insights/*}:markAccepted", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_mark_insight_accepted( + request, metadata + ) + pb_request = recommender_service.MarkInsightAcceptedRequest.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 = insight.Insight() + pb_resp = insight.Insight.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_mark_insight_accepted(resp) + return resp + + class _MarkRecommendationClaimed(RecommenderRestStub): + def __hash__(self): + return hash("MarkRecommendationClaimed") + + __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: recommender_service.MarkRecommendationClaimedRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Call the mark recommendation + claimed method over HTTP. + + Args: + request (~.recommender_service.MarkRecommendationClaimedRequest): + The request object. Request for the ``MarkRecommendationClaimed`` Method. + 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: + ~.recommendation.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markClaimed", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markClaimed", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markClaimed", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markClaimed", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_mark_recommendation_claimed( + request, metadata + ) + pb_request = recommender_service.MarkRecommendationClaimedRequest.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 = recommendation.Recommendation() + pb_resp = recommendation.Recommendation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_mark_recommendation_claimed(resp) + return resp + + class _MarkRecommendationFailed(RecommenderRestStub): + def __hash__(self): + return hash("MarkRecommendationFailed") + + __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: recommender_service.MarkRecommendationFailedRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Call the mark recommendation + failed method over HTTP. + + Args: + request (~.recommender_service.MarkRecommendationFailedRequest): + The request object. Request for the ``MarkRecommendationFailed`` Method. + 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: + ~.recommendation.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markFailed", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markFailed", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markFailed", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markFailed", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_mark_recommendation_failed( + request, metadata + ) + pb_request = recommender_service.MarkRecommendationFailedRequest.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 = recommendation.Recommendation() + pb_resp = recommendation.Recommendation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_mark_recommendation_failed(resp) + return resp + + class _MarkRecommendationSucceeded(RecommenderRestStub): + def __hash__(self): + return hash("MarkRecommendationSucceeded") + + __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: recommender_service.MarkRecommendationSucceededRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Call the mark recommendation + succeeded method over HTTP. + + Args: + request (~.recommender_service.MarkRecommendationSucceededRequest): + The request object. Request for the ``MarkRecommendationSucceeded`` Method. + 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: + ~.recommendation.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markSucceeded", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markSucceeded", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markSucceeded", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markSucceeded", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_mark_recommendation_succeeded( + request, metadata + ) + pb_request = recommender_service.MarkRecommendationSucceededRequest.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 = recommendation.Recommendation() + pb_resp = recommendation.Recommendation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_mark_recommendation_succeeded(resp) + return resp + + class _UpdateInsightTypeConfig(RecommenderRestStub): + def __hash__(self): + return hash("UpdateInsightTypeConfig") + + __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: recommender_service.UpdateInsightTypeConfigRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcr_insight_type_config.InsightTypeConfig: + r"""Call the update insight type + config method over HTTP. + + Args: + request (~.recommender_service.UpdateInsightTypeConfigRequest): + The request object. Request for the ``UpdateInsightTypeConfig`` method. + 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: + ~.gcr_insight_type_config.InsightTypeConfig: + Configuration for an InsightType. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1/{insight_type_config.name=projects/*/locations/*/insightTypes/*/config}", + "body": "insight_type_config", + }, + { + "method": "patch", + "uri": "/v1/{insight_type_config.name=organizations/*/locations/*/insightTypes/*/config}", + "body": "insight_type_config", + }, + ] + request, metadata = self._interceptor.pre_update_insight_type_config( + request, metadata + ) + pb_request = recommender_service.UpdateInsightTypeConfigRequest.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 = gcr_insight_type_config.InsightTypeConfig() + pb_resp = gcr_insight_type_config.InsightTypeConfig.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_insight_type_config(resp) + return resp + + class _UpdateRecommenderConfig(RecommenderRestStub): + def __hash__(self): + return hash("UpdateRecommenderConfig") + + __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: recommender_service.UpdateRecommenderConfigRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcr_recommender_config.RecommenderConfig: + r"""Call the update recommender config method over HTTP. + + Args: + request (~.recommender_service.UpdateRecommenderConfigRequest): + The request object. Request for the ``UpdateRecommenderConfig`` method. + 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: + ~.gcr_recommender_config.RecommenderConfig: + Configuration for a Recommender. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1/{recommender_config.name=projects/*/locations/*/recommenders/*/config}", + "body": "recommender_config", + }, + { + "method": "patch", + "uri": "/v1/{recommender_config.name=organizations/*/locations/*/recommenders/*/config}", + "body": "recommender_config", + }, + ] + request, metadata = self._interceptor.pre_update_recommender_config( + request, metadata + ) + pb_request = recommender_service.UpdateRecommenderConfigRequest.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 = gcr_recommender_config.RecommenderConfig() + pb_resp = gcr_recommender_config.RecommenderConfig.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_recommender_config(resp) + return resp + + @property + def get_insight( + self, + ) -> Callable[[recommender_service.GetInsightRequest], insight.Insight]: + # 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._GetInsight(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_insight_type_config( + self, + ) -> Callable[ + [recommender_service.GetInsightTypeConfigRequest], + insight_type_config.InsightTypeConfig, + ]: + # 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._GetInsightTypeConfig(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_recommendation( + self, + ) -> Callable[ + [recommender_service.GetRecommendationRequest], recommendation.Recommendation + ]: + # 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._GetRecommendation(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_recommender_config( + self, + ) -> Callable[ + [recommender_service.GetRecommenderConfigRequest], + recommender_config.RecommenderConfig, + ]: + # 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._GetRecommenderConfig(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_insights( + self, + ) -> Callable[ + [recommender_service.ListInsightsRequest], + recommender_service.ListInsightsResponse, + ]: + # 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._ListInsights(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_recommendations( + self, + ) -> Callable[ + [recommender_service.ListRecommendationsRequest], + recommender_service.ListRecommendationsResponse, + ]: + # 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._ListRecommendations(self._session, self._host, self._interceptor) # type: ignore + + @property + def mark_insight_accepted( + self, + ) -> Callable[[recommender_service.MarkInsightAcceptedRequest], insight.Insight]: + # 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._MarkInsightAccepted(self._session, self._host, self._interceptor) # type: ignore + + @property + def mark_recommendation_claimed( + self, + ) -> Callable[ + [recommender_service.MarkRecommendationClaimedRequest], + recommendation.Recommendation, + ]: + # 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._MarkRecommendationClaimed(self._session, self._host, self._interceptor) # type: ignore + + @property + def mark_recommendation_failed( + self, + ) -> Callable[ + [recommender_service.MarkRecommendationFailedRequest], + recommendation.Recommendation, + ]: + # 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._MarkRecommendationFailed(self._session, self._host, self._interceptor) # type: ignore + + @property + def mark_recommendation_succeeded( + self, + ) -> Callable[ + [recommender_service.MarkRecommendationSucceededRequest], + recommendation.Recommendation, + ]: + # 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._MarkRecommendationSucceeded(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_insight_type_config( + self, + ) -> Callable[ + [recommender_service.UpdateInsightTypeConfigRequest], + gcr_insight_type_config.InsightTypeConfig, + ]: + # 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._UpdateInsightTypeConfig(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_recommender_config( + self, + ) -> Callable[ + [recommender_service.UpdateRecommenderConfigRequest], + gcr_recommender_config.RecommenderConfig, + ]: + # 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._UpdateRecommenderConfig(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("RecommenderRestTransport",) diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1/types/insight.py b/packages/google-cloud-recommender/google/cloud/recommender_v1/types/insight.py index 30349fa20f30..177daf9e6327 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1/types/insight.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1/types/insight.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.protobuf import duration_pb2 # type: ignore diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1/types/insight_type_config.py b/packages/google-cloud-recommender/google/cloud/recommender_v1/types/insight_type_config.py index d1a40f60bf42..2ed8334a8adc 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1/types/insight_type_config.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1/types/insight_type_config.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.protobuf import struct_pb2 # type: ignore diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1/types/recommendation.py b/packages/google-cloud-recommender/google/cloud/recommender_v1/types/recommendation.py index f92c97c7f3d9..3977922ffc4a 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1/types/recommendation.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1/types/recommendation.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.protobuf import duration_pb2 # type: ignore diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1/types/recommender_config.py b/packages/google-cloud-recommender/google/cloud/recommender_v1/types/recommender_config.py index 1191d69bee8d..6cd1be4ae7fd 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1/types/recommender_config.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1/types/recommender_config.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.protobuf import struct_pb2 # type: ignore diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1/types/recommender_service.py b/packages/google-cloud-recommender/google/cloud/recommender_v1/types/recommender_service.py index 64ffedc4a1b6..47ce4b688918 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1/types/recommender_service.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1/types/recommender_service.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.protobuf import field_mask_pb2 # type: ignore diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/gapic_metadata.json b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/gapic_metadata.json index be00c4123e21..667c3e4766f4 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/gapic_metadata.json +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/gapic_metadata.json @@ -136,6 +136,71 @@ ] } } + }, + "rest": { + "libraryClient": "RecommenderClient", + "rpcs": { + "GetInsight": { + "methods": [ + "get_insight" + ] + }, + "GetInsightTypeConfig": { + "methods": [ + "get_insight_type_config" + ] + }, + "GetRecommendation": { + "methods": [ + "get_recommendation" + ] + }, + "GetRecommenderConfig": { + "methods": [ + "get_recommender_config" + ] + }, + "ListInsights": { + "methods": [ + "list_insights" + ] + }, + "ListRecommendations": { + "methods": [ + "list_recommendations" + ] + }, + "MarkInsightAccepted": { + "methods": [ + "mark_insight_accepted" + ] + }, + "MarkRecommendationClaimed": { + "methods": [ + "mark_recommendation_claimed" + ] + }, + "MarkRecommendationFailed": { + "methods": [ + "mark_recommendation_failed" + ] + }, + "MarkRecommendationSucceeded": { + "methods": [ + "mark_recommendation_succeeded" + ] + }, + "UpdateInsightTypeConfig": { + "methods": [ + "update_insight_type_config" + ] + }, + "UpdateRecommenderConfig": { + "methods": [ + "update_recommender_config" + ] + } + } } } } diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/client.py b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/client.py index 9574cb362cfb..c7604ed472a5 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/client.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/client.py @@ -67,6 +67,7 @@ from .transports.base import DEFAULT_CLIENT_INFO, RecommenderTransport from .transports.grpc import RecommenderGrpcTransport from .transports.grpc_asyncio import RecommenderGrpcAsyncIOTransport +from .transports.rest import RecommenderRestTransport class RecommenderClientMeta(type): @@ -80,6 +81,7 @@ class RecommenderClientMeta(type): _transport_registry = OrderedDict() # type: Dict[str, Type[RecommenderTransport]] _transport_registry["grpc"] = RecommenderGrpcTransport _transport_registry["grpc_asyncio"] = RecommenderGrpcAsyncIOTransport + _transport_registry["rest"] = RecommenderRestTransport def get_transport_class( cls, diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/transports/__init__.py b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/transports/__init__.py index d13734288c03..5d37b945ae30 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/transports/__init__.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/transports/__init__.py @@ -19,14 +19,18 @@ from .base import RecommenderTransport from .grpc import RecommenderGrpcTransport from .grpc_asyncio import RecommenderGrpcAsyncIOTransport +from .rest import RecommenderRestInterceptor, RecommenderRestTransport # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[RecommenderTransport]] _transport_registry["grpc"] = RecommenderGrpcTransport _transport_registry["grpc_asyncio"] = RecommenderGrpcAsyncIOTransport +_transport_registry["rest"] = RecommenderRestTransport __all__ = ( "RecommenderTransport", "RecommenderGrpcTransport", "RecommenderGrpcAsyncIOTransport", + "RecommenderRestTransport", + "RecommenderRestInterceptor", ) diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/transports/rest.py b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/transports/rest.py new file mode 100644 index 000000000000..416a14c6b52f --- /dev/null +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/services/recommender/transports/rest.py @@ -0,0 +1,1967 @@ +# -*- 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.recommender_v1beta1.types import ( + insight_type_config as gcr_insight_type_config, +) +from google.cloud.recommender_v1beta1.types import ( + recommender_config as gcr_recommender_config, +) +from google.cloud.recommender_v1beta1.types import insight +from google.cloud.recommender_v1beta1.types import insight_type_config +from google.cloud.recommender_v1beta1.types import recommendation +from google.cloud.recommender_v1beta1.types import recommender_config +from google.cloud.recommender_v1beta1.types import recommender_service + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .base import RecommenderTransport + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class RecommenderRestInterceptor: + """Interceptor for Recommender. + + 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 RecommenderRestTransport. + + .. code-block:: python + class MyCustomRecommenderInterceptor(RecommenderRestInterceptor): + def pre_get_insight(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_insight(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_insight_type_config(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_insight_type_config(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_recommendation(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_recommendation(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_recommender_config(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_recommender_config(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_insights(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_insights(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_recommendations(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_recommendations(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_mark_insight_accepted(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_mark_insight_accepted(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_mark_recommendation_claimed(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_mark_recommendation_claimed(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_mark_recommendation_failed(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_mark_recommendation_failed(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_mark_recommendation_succeeded(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_mark_recommendation_succeeded(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_insight_type_config(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_insight_type_config(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_recommender_config(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_recommender_config(self, response): + logging.log(f"Received response: {response}") + return response + + transport = RecommenderRestTransport(interceptor=MyCustomRecommenderInterceptor()) + client = RecommenderClient(transport=transport) + + + """ + + def pre_get_insight( + self, + request: recommender_service.GetInsightRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[recommender_service.GetInsightRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_insight + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_get_insight(self, response: insight.Insight) -> insight.Insight: + """Post-rpc interceptor for get_insight + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_get_insight_type_config( + self, + request: recommender_service.GetInsightTypeConfigRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.GetInsightTypeConfigRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for get_insight_type_config + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_get_insight_type_config( + self, response: insight_type_config.InsightTypeConfig + ) -> insight_type_config.InsightTypeConfig: + """Post-rpc interceptor for get_insight_type_config + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_get_recommendation( + self, + request: recommender_service.GetRecommendationRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[recommender_service.GetRecommendationRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_recommendation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_get_recommendation( + self, response: recommendation.Recommendation + ) -> recommendation.Recommendation: + """Post-rpc interceptor for get_recommendation + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_get_recommender_config( + self, + request: recommender_service.GetRecommenderConfigRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.GetRecommenderConfigRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for get_recommender_config + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_get_recommender_config( + self, response: recommender_config.RecommenderConfig + ) -> recommender_config.RecommenderConfig: + """Post-rpc interceptor for get_recommender_config + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_list_insights( + self, + request: recommender_service.ListInsightsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[recommender_service.ListInsightsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_insights + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_list_insights( + self, response: recommender_service.ListInsightsResponse + ) -> recommender_service.ListInsightsResponse: + """Post-rpc interceptor for list_insights + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_list_recommendations( + self, + request: recommender_service.ListRecommendationsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.ListRecommendationsRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for list_recommendations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_list_recommendations( + self, response: recommender_service.ListRecommendationsResponse + ) -> recommender_service.ListRecommendationsResponse: + """Post-rpc interceptor for list_recommendations + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_mark_insight_accepted( + self, + request: recommender_service.MarkInsightAcceptedRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.MarkInsightAcceptedRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for mark_insight_accepted + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_mark_insight_accepted(self, response: insight.Insight) -> insight.Insight: + """Post-rpc interceptor for mark_insight_accepted + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_mark_recommendation_claimed( + self, + request: recommender_service.MarkRecommendationClaimedRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.MarkRecommendationClaimedRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for mark_recommendation_claimed + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_mark_recommendation_claimed( + self, response: recommendation.Recommendation + ) -> recommendation.Recommendation: + """Post-rpc interceptor for mark_recommendation_claimed + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_mark_recommendation_failed( + self, + request: recommender_service.MarkRecommendationFailedRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.MarkRecommendationFailedRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for mark_recommendation_failed + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_mark_recommendation_failed( + self, response: recommendation.Recommendation + ) -> recommendation.Recommendation: + """Post-rpc interceptor for mark_recommendation_failed + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_mark_recommendation_succeeded( + self, + request: recommender_service.MarkRecommendationSucceededRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.MarkRecommendationSucceededRequest, + Sequence[Tuple[str, str]], + ]: + """Pre-rpc interceptor for mark_recommendation_succeeded + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_mark_recommendation_succeeded( + self, response: recommendation.Recommendation + ) -> recommendation.Recommendation: + """Post-rpc interceptor for mark_recommendation_succeeded + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_update_insight_type_config( + self, + request: recommender_service.UpdateInsightTypeConfigRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.UpdateInsightTypeConfigRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for update_insight_type_config + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_update_insight_type_config( + self, response: gcr_insight_type_config.InsightTypeConfig + ) -> gcr_insight_type_config.InsightTypeConfig: + """Post-rpc interceptor for update_insight_type_config + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + def pre_update_recommender_config( + self, + request: recommender_service.UpdateRecommenderConfigRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + recommender_service.UpdateRecommenderConfigRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for update_recommender_config + + Override in a subclass to manipulate the request or metadata + before they are sent to the Recommender server. + """ + return request, metadata + + def post_update_recommender_config( + self, response: gcr_recommender_config.RecommenderConfig + ) -> gcr_recommender_config.RecommenderConfig: + """Post-rpc interceptor for update_recommender_config + + Override in a subclass to manipulate the response + after it is returned by the Recommender server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class RecommenderRestStub: + _session: AuthorizedSession + _host: str + _interceptor: RecommenderRestInterceptor + + +class RecommenderRestTransport(RecommenderTransport): + """REST backend transport for Recommender. + + Provides insights and recommendations for cloud customers for + various categories like performance optimization, cost savings, + reliability, feature discovery, etc. Insights and + recommendations are generated automatically based on analysis of + user resources, configuration and monitoring metrics. + + 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 = "recommender.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[RecommenderRestInterceptor] = 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 RecommenderRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _GetInsight(RecommenderRestStub): + def __hash__(self): + return hash("GetInsight") + + __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: recommender_service.GetInsightRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight.Insight: + r"""Call the get insight method over HTTP. + + Args: + request (~.recommender_service.GetInsightRequest): + The request object. Request to the ``GetInsight`` method. + 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: + ~.insight.Insight: + An insight along with the information + used to derive the insight. The insight + may have associated recomendations as + well. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/{name=projects/*/locations/*/insightTypes/*/insights/*}", + }, + { + "method": "get", + "uri": "/v1beta1/{name=billingAccounts/*/locations/*/insightTypes/*/insights/*}", + }, + { + "method": "get", + "uri": "/v1beta1/{name=folders/*/locations/*/insightTypes/*/insights/*}", + }, + { + "method": "get", + "uri": "/v1beta1/{name=organizations/*/locations/*/insightTypes/*/insights/*}", + }, + ] + request, metadata = self._interceptor.pre_get_insight(request, metadata) + pb_request = recommender_service.GetInsightRequest.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 = insight.Insight() + pb_resp = insight.Insight.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_insight(resp) + return resp + + class _GetInsightTypeConfig(RecommenderRestStub): + def __hash__(self): + return hash("GetInsightTypeConfig") + + __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: recommender_service.GetInsightTypeConfigRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight_type_config.InsightTypeConfig: + r"""Call the get insight type config method over HTTP. + + Args: + request (~.recommender_service.GetInsightTypeConfigRequest): + The request object. Request for the GetInsightTypeConfig\` method. + 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: + ~.insight_type_config.InsightTypeConfig: + Configuration for an InsightType. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/{name=projects/*/locations/*/insightTypes/*/config}", + }, + { + "method": "get", + "uri": "/v1beta1/{name=organizations/*/locations/*/insightTypes/*/config}", + }, + ] + request, metadata = self._interceptor.pre_get_insight_type_config( + request, metadata + ) + pb_request = recommender_service.GetInsightTypeConfigRequest.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 = insight_type_config.InsightTypeConfig() + pb_resp = insight_type_config.InsightTypeConfig.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_insight_type_config(resp) + return resp + + class _GetRecommendation(RecommenderRestStub): + def __hash__(self): + return hash("GetRecommendation") + + __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: recommender_service.GetRecommendationRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Call the get recommendation method over HTTP. + + Args: + request (~.recommender_service.GetRecommendationRequest): + The request object. Request to the ``GetRecommendation`` method. + 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: + ~.recommendation.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}", + }, + { + "method": "get", + "uri": "/v1beta1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}", + }, + { + "method": "get", + "uri": "/v1beta1/{name=folders/*/locations/*/recommenders/*/recommendations/*}", + }, + { + "method": "get", + "uri": "/v1beta1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}", + }, + ] + request, metadata = self._interceptor.pre_get_recommendation( + request, metadata + ) + pb_request = recommender_service.GetRecommendationRequest.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 = recommendation.Recommendation() + pb_resp = recommendation.Recommendation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_recommendation(resp) + return resp + + class _GetRecommenderConfig(RecommenderRestStub): + def __hash__(self): + return hash("GetRecommenderConfig") + + __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: recommender_service.GetRecommenderConfigRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommender_config.RecommenderConfig: + r"""Call the get recommender config method over HTTP. + + Args: + request (~.recommender_service.GetRecommenderConfigRequest): + The request object. Request for the GetRecommenderConfig\` method. + 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: + ~.recommender_config.RecommenderConfig: + Configuration for a Recommender. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/{name=projects/*/locations/*/recommenders/*/config}", + }, + { + "method": "get", + "uri": "/v1beta1/{name=organizations/*/locations/*/recommenders/*/config}", + }, + ] + request, metadata = self._interceptor.pre_get_recommender_config( + request, metadata + ) + pb_request = recommender_service.GetRecommenderConfigRequest.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 = recommender_config.RecommenderConfig() + pb_resp = recommender_config.RecommenderConfig.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_recommender_config(resp) + return resp + + class _ListInsights(RecommenderRestStub): + def __hash__(self): + return hash("ListInsights") + + __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: recommender_service.ListInsightsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommender_service.ListInsightsResponse: + r"""Call the list insights method over HTTP. + + Args: + request (~.recommender_service.ListInsightsRequest): + The request object. Request for the ``ListInsights`` method. + 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: + ~.recommender_service.ListInsightsResponse: + Response to the ``ListInsights`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/{parent=projects/*/locations/*/insightTypes/*}/insights", + }, + { + "method": "get", + "uri": "/v1beta1/{parent=billingAccounts/*/locations/*/insightTypes/*}/insights", + }, + { + "method": "get", + "uri": "/v1beta1/{parent=folders/*/locations/*/insightTypes/*}/insights", + }, + { + "method": "get", + "uri": "/v1beta1/{parent=organizations/*/locations/*/insightTypes/*}/insights", + }, + ] + request, metadata = self._interceptor.pre_list_insights(request, metadata) + pb_request = recommender_service.ListInsightsRequest.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 = recommender_service.ListInsightsResponse() + pb_resp = recommender_service.ListInsightsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_insights(resp) + return resp + + class _ListRecommendations(RecommenderRestStub): + def __hash__(self): + return hash("ListRecommendations") + + __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: recommender_service.ListRecommendationsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommender_service.ListRecommendationsResponse: + r"""Call the list recommendations method over HTTP. + + Args: + request (~.recommender_service.ListRecommendationsRequest): + The request object. Request for the ``ListRecommendations`` method. + 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: + ~.recommender_service.ListRecommendationsResponse: + Response to the ``ListRecommendations`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/{parent=projects/*/locations/*/recommenders/*}/recommendations", + }, + { + "method": "get", + "uri": "/v1beta1/{parent=billingAccounts/*/locations/*/recommenders/*}/recommendations", + }, + { + "method": "get", + "uri": "/v1beta1/{parent=folders/*/locations/*/recommenders/*}/recommendations", + }, + { + "method": "get", + "uri": "/v1beta1/{parent=organizations/*/locations/*/recommenders/*}/recommendations", + }, + ] + request, metadata = self._interceptor.pre_list_recommendations( + request, metadata + ) + pb_request = recommender_service.ListRecommendationsRequest.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 = recommender_service.ListRecommendationsResponse() + pb_resp = recommender_service.ListRecommendationsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_recommendations(resp) + return resp + + class _MarkInsightAccepted(RecommenderRestStub): + def __hash__(self): + return hash("MarkInsightAccepted") + + __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: recommender_service.MarkInsightAcceptedRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> insight.Insight: + r"""Call the mark insight accepted method over HTTP. + + Args: + request (~.recommender_service.MarkInsightAcceptedRequest): + The request object. Request for the ``MarkInsightAccepted`` method. + 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: + ~.insight.Insight: + An insight along with the information + used to derive the insight. The insight + may have associated recomendations as + well. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1beta1/{name=projects/*/locations/*/insightTypes/*/insights/*}:markAccepted", + "body": "*", + }, + { + "method": "post", + "uri": "/v1beta1/{name=billingAccounts/*/locations/*/insightTypes/*/insights/*}:markAccepted", + "body": "*", + }, + { + "method": "post", + "uri": "/v1beta1/{name=folders/*/locations/*/insightTypes/*/insights/*}:markAccepted", + "body": "*", + }, + { + "method": "post", + "uri": "/v1beta1/{name=organizations/*/locations/*/insightTypes/*/insights/*}:markAccepted", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_mark_insight_accepted( + request, metadata + ) + pb_request = recommender_service.MarkInsightAcceptedRequest.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 = insight.Insight() + pb_resp = insight.Insight.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_mark_insight_accepted(resp) + return resp + + class _MarkRecommendationClaimed(RecommenderRestStub): + def __hash__(self): + return hash("MarkRecommendationClaimed") + + __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: recommender_service.MarkRecommendationClaimedRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Call the mark recommendation + claimed method over HTTP. + + Args: + request (~.recommender_service.MarkRecommendationClaimedRequest): + The request object. Request for the ``MarkRecommendationClaimed`` Method. + 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: + ~.recommendation.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markClaimed", + "body": "*", + }, + { + "method": "post", + "uri": "/v1beta1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markClaimed", + "body": "*", + }, + { + "method": "post", + "uri": "/v1beta1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markClaimed", + "body": "*", + }, + { + "method": "post", + "uri": "/v1beta1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markClaimed", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_mark_recommendation_claimed( + request, metadata + ) + pb_request = recommender_service.MarkRecommendationClaimedRequest.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 = recommendation.Recommendation() + pb_resp = recommendation.Recommendation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_mark_recommendation_claimed(resp) + return resp + + class _MarkRecommendationFailed(RecommenderRestStub): + def __hash__(self): + return hash("MarkRecommendationFailed") + + __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: recommender_service.MarkRecommendationFailedRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Call the mark recommendation + failed method over HTTP. + + Args: + request (~.recommender_service.MarkRecommendationFailedRequest): + The request object. Request for the ``MarkRecommendationFailed`` Method. + 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: + ~.recommendation.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markFailed", + "body": "*", + }, + { + "method": "post", + "uri": "/v1beta1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markFailed", + "body": "*", + }, + { + "method": "post", + "uri": "/v1beta1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markFailed", + "body": "*", + }, + { + "method": "post", + "uri": "/v1beta1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markFailed", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_mark_recommendation_failed( + request, metadata + ) + pb_request = recommender_service.MarkRecommendationFailedRequest.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 = recommendation.Recommendation() + pb_resp = recommendation.Recommendation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_mark_recommendation_failed(resp) + return resp + + class _MarkRecommendationSucceeded(RecommenderRestStub): + def __hash__(self): + return hash("MarkRecommendationSucceeded") + + __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: recommender_service.MarkRecommendationSucceededRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> recommendation.Recommendation: + r"""Call the mark recommendation + succeeded method over HTTP. + + Args: + request (~.recommender_service.MarkRecommendationSucceededRequest): + The request object. Request for the ``MarkRecommendationSucceeded`` Method. + 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: + ~.recommendation.Recommendation: + A recommendation along with a + suggested action. E.g., a rightsizing + recommendation for an underutilized VM, + IAM role recommendations, etc + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markSucceeded", + "body": "*", + }, + { + "method": "post", + "uri": "/v1beta1/{name=billingAccounts/*/locations/*/recommenders/*/recommendations/*}:markSucceeded", + "body": "*", + }, + { + "method": "post", + "uri": "/v1beta1/{name=folders/*/locations/*/recommenders/*/recommendations/*}:markSucceeded", + "body": "*", + }, + { + "method": "post", + "uri": "/v1beta1/{name=organizations/*/locations/*/recommenders/*/recommendations/*}:markSucceeded", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_mark_recommendation_succeeded( + request, metadata + ) + pb_request = recommender_service.MarkRecommendationSucceededRequest.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 = recommendation.Recommendation() + pb_resp = recommendation.Recommendation.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_mark_recommendation_succeeded(resp) + return resp + + class _UpdateInsightTypeConfig(RecommenderRestStub): + def __hash__(self): + return hash("UpdateInsightTypeConfig") + + __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: recommender_service.UpdateInsightTypeConfigRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcr_insight_type_config.InsightTypeConfig: + r"""Call the update insight type + config method over HTTP. + + Args: + request (~.recommender_service.UpdateInsightTypeConfigRequest): + The request object. Request for the ``UpdateInsightTypeConfig`` method. + 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: + ~.gcr_insight_type_config.InsightTypeConfig: + Configuration for an InsightType. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1beta1/{insight_type_config.name=projects/*/locations/*/insightTypes/*/config}", + "body": "insight_type_config", + }, + { + "method": "post", + "uri": "/v1beta1/{insight_type_config.name=organizations/*/locations/*/insightTypes/*/config}", + "body": "insight_type_config", + }, + ] + request, metadata = self._interceptor.pre_update_insight_type_config( + request, metadata + ) + pb_request = recommender_service.UpdateInsightTypeConfigRequest.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 = gcr_insight_type_config.InsightTypeConfig() + pb_resp = gcr_insight_type_config.InsightTypeConfig.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_insight_type_config(resp) + return resp + + class _UpdateRecommenderConfig(RecommenderRestStub): + def __hash__(self): + return hash("UpdateRecommenderConfig") + + __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: recommender_service.UpdateRecommenderConfigRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcr_recommender_config.RecommenderConfig: + r"""Call the update recommender config method over HTTP. + + Args: + request (~.recommender_service.UpdateRecommenderConfigRequest): + The request object. Request for the ``UpdateRecommenderConfig`` method. + 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: + ~.gcr_recommender_config.RecommenderConfig: + Configuration for a Recommender. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1beta1/{recommender_config.name=projects/*/locations/*/recommenders/*/config}", + "body": "recommender_config", + }, + { + "method": "post", + "uri": "/v1beta1/{recommender_config.name=organizations/*/locations/*/recommenders/*/config}", + "body": "recommender_config", + }, + ] + request, metadata = self._interceptor.pre_update_recommender_config( + request, metadata + ) + pb_request = recommender_service.UpdateRecommenderConfigRequest.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 = gcr_recommender_config.RecommenderConfig() + pb_resp = gcr_recommender_config.RecommenderConfig.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_recommender_config(resp) + return resp + + @property + def get_insight( + self, + ) -> Callable[[recommender_service.GetInsightRequest], insight.Insight]: + # 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._GetInsight(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_insight_type_config( + self, + ) -> Callable[ + [recommender_service.GetInsightTypeConfigRequest], + insight_type_config.InsightTypeConfig, + ]: + # 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._GetInsightTypeConfig(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_recommendation( + self, + ) -> Callable[ + [recommender_service.GetRecommendationRequest], recommendation.Recommendation + ]: + # 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._GetRecommendation(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_recommender_config( + self, + ) -> Callable[ + [recommender_service.GetRecommenderConfigRequest], + recommender_config.RecommenderConfig, + ]: + # 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._GetRecommenderConfig(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_insights( + self, + ) -> Callable[ + [recommender_service.ListInsightsRequest], + recommender_service.ListInsightsResponse, + ]: + # 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._ListInsights(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_recommendations( + self, + ) -> Callable[ + [recommender_service.ListRecommendationsRequest], + recommender_service.ListRecommendationsResponse, + ]: + # 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._ListRecommendations(self._session, self._host, self._interceptor) # type: ignore + + @property + def mark_insight_accepted( + self, + ) -> Callable[[recommender_service.MarkInsightAcceptedRequest], insight.Insight]: + # 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._MarkInsightAccepted(self._session, self._host, self._interceptor) # type: ignore + + @property + def mark_recommendation_claimed( + self, + ) -> Callable[ + [recommender_service.MarkRecommendationClaimedRequest], + recommendation.Recommendation, + ]: + # 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._MarkRecommendationClaimed(self._session, self._host, self._interceptor) # type: ignore + + @property + def mark_recommendation_failed( + self, + ) -> Callable[ + [recommender_service.MarkRecommendationFailedRequest], + recommendation.Recommendation, + ]: + # 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._MarkRecommendationFailed(self._session, self._host, self._interceptor) # type: ignore + + @property + def mark_recommendation_succeeded( + self, + ) -> Callable[ + [recommender_service.MarkRecommendationSucceededRequest], + recommendation.Recommendation, + ]: + # 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._MarkRecommendationSucceeded(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_insight_type_config( + self, + ) -> Callable[ + [recommender_service.UpdateInsightTypeConfigRequest], + gcr_insight_type_config.InsightTypeConfig, + ]: + # 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._UpdateInsightTypeConfig(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_recommender_config( + self, + ) -> Callable[ + [recommender_service.UpdateRecommenderConfigRequest], + gcr_recommender_config.RecommenderConfig, + ]: + # 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._UpdateRecommenderConfig(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("RecommenderRestTransport",) diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/insight.py b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/insight.py index a40a7173b857..5ba95d65a360 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/insight.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/insight.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.protobuf import duration_pb2 # type: ignore diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/insight_type_config.py b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/insight_type_config.py index 941f5be24909..ee8b2a1d7e8a 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/insight_type_config.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/insight_type_config.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.protobuf import struct_pb2 # type: ignore diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/recommendation.py b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/recommendation.py index 291d0963434e..467260788b88 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/recommendation.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/recommendation.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.protobuf import duration_pb2 # type: ignore diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/recommender_config.py b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/recommender_config.py index a7777e2c7f67..095ffef501b4 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/recommender_config.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/recommender_config.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.protobuf import struct_pb2 # type: ignore diff --git a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/recommender_service.py b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/recommender_service.py index 4120550e68d4..75d65bee6cec 100644 --- a/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/recommender_service.py +++ b/packages/google-cloud-recommender/google/cloud/recommender_v1beta1/types/recommender_service.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.protobuf import field_mask_pb2 # type: ignore diff --git a/packages/google-cloud-recommender/tests/unit/gapic/recommender_v1/test_recommender.py b/packages/google-cloud-recommender/tests/unit/gapic/recommender_v1/test_recommender.py index c3217ee18b24..177aa85ce501 100644 --- a/packages/google-cloud-recommender/tests/unit/gapic/recommender_v1/test_recommender.py +++ b/packages/google-cloud-recommender/tests/unit/gapic/recommender_v1/test_recommender.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 @@ -33,6 +35,7 @@ from google.oauth2 import service_account from google.protobuf import duration_pb2 # type: ignore from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import json_format from google.protobuf import struct_pb2 # type: ignore from google.protobuf import timestamp_pb2 # type: ignore import grpc @@ -40,6 +43,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.recommender_v1.services.recommender import ( RecommenderAsyncClient, @@ -106,6 +111,7 @@ def test__get_default_mtls_endpoint(): [ (RecommenderClient, "grpc"), (RecommenderAsyncClient, "grpc_asyncio"), + (RecommenderClient, "rest"), ], ) def test_recommender_client_from_service_account_info(client_class, transport_name): @@ -119,7 +125,11 @@ def test_recommender_client_from_service_account_info(client_class, transport_na assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("recommender.googleapis.com:443") + assert client.transport._host == ( + "recommender.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommender.googleapis.com" + ) @pytest.mark.parametrize( @@ -127,6 +137,7 @@ def test_recommender_client_from_service_account_info(client_class, transport_na [ (transports.RecommenderGrpcTransport, "grpc"), (transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.RecommenderRestTransport, "rest"), ], ) def test_recommender_client_service_account_always_use_jwt( @@ -152,6 +163,7 @@ def test_recommender_client_service_account_always_use_jwt( [ (RecommenderClient, "grpc"), (RecommenderAsyncClient, "grpc_asyncio"), + (RecommenderClient, "rest"), ], ) def test_recommender_client_from_service_account_file(client_class, transport_name): @@ -172,13 +184,18 @@ def test_recommender_client_from_service_account_file(client_class, transport_na assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("recommender.googleapis.com:443") + assert client.transport._host == ( + "recommender.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommender.googleapis.com" + ) def test_recommender_client_get_transport_class(): transport = RecommenderClient.get_transport_class() available_transports = [ transports.RecommenderGrpcTransport, + transports.RecommenderRestTransport, ] assert transport in available_transports @@ -195,6 +212,7 @@ def test_recommender_client_get_transport_class(): transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio", ), + (RecommenderClient, transports.RecommenderRestTransport, "rest"), ], ) @mock.patch.object( @@ -338,6 +356,8 @@ def test_recommender_client_client_options( "grpc_asyncio", "false", ), + (RecommenderClient, transports.RecommenderRestTransport, "rest", "true"), + (RecommenderClient, transports.RecommenderRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -531,6 +551,7 @@ def test_recommender_client_get_mtls_endpoint_and_cert_source(client_class): transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio", ), + (RecommenderClient, transports.RecommenderRestTransport, "rest"), ], ) def test_recommender_client_client_options_scopes( @@ -566,6 +587,7 @@ def test_recommender_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (RecommenderClient, transports.RecommenderRestTransport, "rest", None), ], ) def test_recommender_client_client_options_credentials_file( @@ -4284,142 +4306,3829 @@ async def test_update_insight_type_config_flattened_error_async(): ) -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.RecommenderGrpcTransport( +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.ListInsightsRequest, + dict, + ], +) +def test_list_insights_rest(request_type): + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - with pytest.raises(ValueError): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/insightTypes/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 = recommender_service.ListInsightsResponse( + next_page_token="next_page_token_value", ) - # It is an error to provide a credentials file and a transport instance. - transport = transports.RecommenderGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommender_service.ListInsightsResponse.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_insights(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListInsightsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_insights_rest_required_fields( + request_type=recommender_service.ListInsightsRequest, +): + transport_class = transports.RecommenderRestTransport + + 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, + ) ) - with pytest.raises(ValueError): - client = RecommenderClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_insights._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_insights._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "filter", + "page_size", + "page_token", ) + ) + jsonified_request.update(unset_fields) - # It is an error to provide an api_key and a transport instance. - transport = transports.RecommenderGrpcTransport( + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommender_service.ListInsightsResponse() + # 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 = recommender_service.ListInsightsResponse.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_insights(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_insights_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_insights._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "filter", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = RecommenderClient( - client_options=options, - transport=transport, + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_insights_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_list_insights" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_list_insights" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.ListInsightsRequest.pb( + recommender_service.ListInsightsRequest() + ) + 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 = recommender_service.ListInsightsResponse.to_json( + recommender_service.ListInsightsResponse() ) - # 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 = RecommenderClient( - client_options=options, credentials=ga_credentials.AnonymousCredentials() + request = recommender_service.ListInsightsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommender_service.ListInsightsResponse() + + client.list_insights( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], ) - # It is an error to provide scopes and a transport instance. - transport = transports.RecommenderGrpcTransport( + pre.assert_called_once() + post.assert_called_once() + + +def test_list_insights_rest_bad_request( + transport: str = "rest", request_type=recommender_service.ListInsightsRequest +): + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - with pytest.raises(ValueError): - client = RecommenderClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/insightTypes/sample3"} + request = request_type(**request_init) -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.RecommenderGrpcTransport( + # 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_insights(request) + + +def test_list_insights_rest_flattened(): + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - client = RecommenderClient(transport=transport) - assert client.transport is transport + # 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 = recommender_service.ListInsightsResponse() -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.RecommenderGrpcTransport( + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/insightTypes/sample3" + } + + # 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 = recommender_service.ListInsightsResponse.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_insights(**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/*/insightTypes/*}/insights" + % client.transport._host, + args[1], + ) + + +def test_list_insights_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel - transport = transports.RecommenderGrpcAsyncIOTransport( + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_insights( + recommender_service.ListInsightsRequest(), + parent="parent_value", + ) + + +def test_list_insights_rest_pager(transport: str = "rest"): + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel + # 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 = ( + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + insight.Insight(), + ], + next_page_token="abc", + ), + recommender_service.ListInsightsResponse( + insights=[], + next_page_token="def", + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + ], + next_page_token="ghi", + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + ], + ), + ) + # Two responses for two calls + response = response + response -@pytest.mark.parametrize( - "transport_class", - [ - transports.RecommenderGrpcTransport, - transports.RecommenderGrpcAsyncIOTransport, - ], -) -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() + # Wrap the values into proper Response objs + response = tuple( + recommender_service.ListInsightsResponse.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/insightTypes/sample3" + } + + pager = client.list_insights(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, insight.Insight) for i in results) + + pages = list(client.list_insights(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token @pytest.mark.parametrize( - "transport_name", + "request_type", [ - "grpc", + recommender_service.GetInsightRequest, + dict, ], ) -def test_transport_kind(transport_name): - transport = RecommenderClient.get_transport_class(transport_name)( +def test_get_insight_rest(request_type): + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - assert transport.kind == transport_name + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/insights/sample4" + } + 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 = insight.Insight( + name="name_value", + description="description_value", + target_resources=["target_resources_value"], + insight_subtype="insight_subtype_value", + category=insight.Insight.Category.COST, + severity=insight.Insight.Severity.LOW, + etag="etag_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = insight.Insight.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_insight(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, insight.Insight) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.target_resources == ["target_resources_value"] + assert response.insight_subtype == "insight_subtype_value" + assert response.category == insight.Insight.Category.COST + assert response.severity == insight.Insight.Severity.LOW + assert response.etag == "etag_value" + + +def test_get_insight_rest_required_fields( + request_type=recommender_service.GetInsightRequest, +): + transport_class = transports.RecommenderRestTransport + + 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_insight._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_insight._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" -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - assert isinstance( - client.transport, - transports.RecommenderGrpcTransport, + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = insight.Insight() + # 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 = insight.Insight.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_insight(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_insight_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials ) + unset_fields = transport.get_insight._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) -def test_recommender_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.RecommenderTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json", - ) +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_insight_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_get_insight" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_get_insight" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.GetInsightRequest.pb( + recommender_service.GetInsightRequest() + ) + 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 = insight.Insight.to_json(insight.Insight()) + + request = recommender_service.GetInsightRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = insight.Insight() -def test_recommender_base_transport(): - # Instantiate the base transport. - with mock.patch( - "google.cloud.recommender_v1.services.recommender.transports.RecommenderTransport.__init__" - ) as Transport: - Transport.return_value = None - transport = transports.RecommenderTransport( - credentials=ga_credentials.AnonymousCredentials(), + client.get_insight( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], ) - # Every method on the transport should just blindly - # raise NotImplementedError. + pre.assert_called_once() + post.assert_called_once() + + +def test_get_insight_rest_bad_request( + transport: str = "rest", request_type=recommender_service.GetInsightRequest +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/insights/sample4" + } + 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_insight(request) + + +def test_get_insight_rest_flattened(): + client = RecommenderClient( + 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 = insight.Insight() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/insights/sample4" + } + + # 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 = insight.Insight.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_insight(**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/*/insightTypes/*/insights/*}" + % client.transport._host, + args[1], + ) + + +def test_get_insight_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_insight( + recommender_service.GetInsightRequest(), + name="name_value", + ) + + +def test_get_insight_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.MarkInsightAcceptedRequest, + dict, + ], +) +def test_mark_insight_accepted_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/insights/sample4" + } + 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 = insight.Insight( + name="name_value", + description="description_value", + target_resources=["target_resources_value"], + insight_subtype="insight_subtype_value", + category=insight.Insight.Category.COST, + severity=insight.Insight.Severity.LOW, + etag="etag_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = insight.Insight.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.mark_insight_accepted(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, insight.Insight) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.target_resources == ["target_resources_value"] + assert response.insight_subtype == "insight_subtype_value" + assert response.category == insight.Insight.Category.COST + assert response.severity == insight.Insight.Severity.LOW + assert response.etag == "etag_value" + + +def test_mark_insight_accepted_rest_required_fields( + request_type=recommender_service.MarkInsightAcceptedRequest, +): + transport_class = transports.RecommenderRestTransport + + request_init = {} + request_init["name"] = "" + request_init["etag"] = "" + 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() + ).mark_insight_accepted._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" + jsonified_request["etag"] = "etag_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).mark_insight_accepted._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" + assert "etag" in jsonified_request + assert jsonified_request["etag"] == "etag_value" + + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = insight.Insight() + # 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 = insight.Insight.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.mark_insight_accepted(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_mark_insight_accepted_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.mark_insight_accepted._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "etag", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_mark_insight_accepted_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_mark_insight_accepted" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_mark_insight_accepted" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.MarkInsightAcceptedRequest.pb( + recommender_service.MarkInsightAcceptedRequest() + ) + 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 = insight.Insight.to_json(insight.Insight()) + + request = recommender_service.MarkInsightAcceptedRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = insight.Insight() + + client.mark_insight_accepted( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_mark_insight_accepted_rest_bad_request( + transport: str = "rest", request_type=recommender_service.MarkInsightAcceptedRequest +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/insights/sample4" + } + 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.mark_insight_accepted(request) + + +def test_mark_insight_accepted_rest_flattened(): + client = RecommenderClient( + 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 = insight.Insight() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/insights/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_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 = insight.Insight.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.mark_insight_accepted(**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/*/insightTypes/*/insights/*}:markAccepted" + % client.transport._host, + args[1], + ) + + +def test_mark_insight_accepted_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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.mark_insight_accepted( + recommender_service.MarkInsightAcceptedRequest(), + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_value", + ) + + +def test_mark_insight_accepted_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.ListRecommendationsRequest, + dict, + ], +) +def test_list_recommendations_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/recommenders/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 = recommender_service.ListRecommendationsResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommender_service.ListRecommendationsResponse.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_recommendations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRecommendationsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_recommendations_rest_required_fields( + request_type=recommender_service.ListRecommendationsRequest, +): + transport_class = transports.RecommenderRestTransport + + 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_recommendations._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_recommendations._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "filter", + "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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommender_service.ListRecommendationsResponse() + # 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 = recommender_service.ListRecommendationsResponse.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_recommendations(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_recommendations_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_recommendations._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "filter", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_recommendations_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_list_recommendations" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_list_recommendations" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.ListRecommendationsRequest.pb( + recommender_service.ListRecommendationsRequest() + ) + 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 = ( + recommender_service.ListRecommendationsResponse.to_json( + recommender_service.ListRecommendationsResponse() + ) + ) + + request = recommender_service.ListRecommendationsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommender_service.ListRecommendationsResponse() + + client.list_recommendations( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_recommendations_rest_bad_request( + transport: str = "rest", request_type=recommender_service.ListRecommendationsRequest +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/recommenders/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.list_recommendations(request) + + +def test_list_recommendations_rest_flattened(): + client = RecommenderClient( + 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 = recommender_service.ListRecommendationsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/recommenders/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + filter="filter_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 = recommender_service.ListRecommendationsResponse.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_recommendations(**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/*/recommenders/*}/recommendations" + % client.transport._host, + args[1], + ) + + +def test_list_recommendations_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_recommendations( + recommender_service.ListRecommendationsRequest(), + parent="parent_value", + filter="filter_value", + ) + + +def test_list_recommendations_rest_pager(transport: str = "rest"): + client = RecommenderClient( + 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 = ( + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + next_page_token="abc", + ), + recommender_service.ListRecommendationsResponse( + recommendations=[], + next_page_token="def", + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + ], + next_page_token="ghi", + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + recommender_service.ListRecommendationsResponse.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/recommenders/sample3" + } + + pager = client.list_recommendations(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, recommendation.Recommendation) for i in results) + + pages = list(client.list_recommendations(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", + [ + recommender_service.GetRecommendationRequest, + dict, + ], +) +def test_get_recommendation_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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 = recommendation.Recommendation( + name="name_value", + description="description_value", + recommender_subtype="recommender_subtype_value", + priority=recommendation.Recommendation.Priority.P4, + etag="etag_value", + xor_group_id="xor_group_id_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommendation.Recommendation.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_recommendation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.recommender_subtype == "recommender_subtype_value" + assert response.priority == recommendation.Recommendation.Priority.P4 + assert response.etag == "etag_value" + assert response.xor_group_id == "xor_group_id_value" + + +def test_get_recommendation_rest_required_fields( + request_type=recommender_service.GetRecommendationRequest, +): + transport_class = transports.RecommenderRestTransport + + 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_recommendation._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_recommendation._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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommendation.Recommendation() + # 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 = recommendation.Recommendation.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_recommendation(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_recommendation_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_recommendation._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_recommendation_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_get_recommendation" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_get_recommendation" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.GetRecommendationRequest.pb( + recommender_service.GetRecommendationRequest() + ) + 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 = recommendation.Recommendation.to_json( + recommendation.Recommendation() + ) + + request = recommender_service.GetRecommendationRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommendation.Recommendation() + + client.get_recommendation( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_recommendation_rest_bad_request( + transport: str = "rest", request_type=recommender_service.GetRecommendationRequest +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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_recommendation(request) + + +def test_get_recommendation_rest_flattened(): + client = RecommenderClient( + 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 = recommendation.Recommendation() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + + # 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 = recommendation.Recommendation.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_recommendation(**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/*/recommenders/*/recommendations/*}" + % client.transport._host, + args[1], + ) + + +def test_get_recommendation_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_recommendation( + recommender_service.GetRecommendationRequest(), + name="name_value", + ) + + +def test_get_recommendation_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.MarkRecommendationClaimedRequest, + dict, + ], +) +def test_mark_recommendation_claimed_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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 = recommendation.Recommendation( + name="name_value", + description="description_value", + recommender_subtype="recommender_subtype_value", + priority=recommendation.Recommendation.Priority.P4, + etag="etag_value", + xor_group_id="xor_group_id_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommendation.Recommendation.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.mark_recommendation_claimed(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.recommender_subtype == "recommender_subtype_value" + assert response.priority == recommendation.Recommendation.Priority.P4 + assert response.etag == "etag_value" + assert response.xor_group_id == "xor_group_id_value" + + +def test_mark_recommendation_claimed_rest_required_fields( + request_type=recommender_service.MarkRecommendationClaimedRequest, +): + transport_class = transports.RecommenderRestTransport + + request_init = {} + request_init["name"] = "" + request_init["etag"] = "" + 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() + ).mark_recommendation_claimed._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" + jsonified_request["etag"] = "etag_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).mark_recommendation_claimed._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" + assert "etag" in jsonified_request + assert jsonified_request["etag"] == "etag_value" + + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommendation.Recommendation() + # 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 = recommendation.Recommendation.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.mark_recommendation_claimed(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_mark_recommendation_claimed_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.mark_recommendation_claimed._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "etag", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_mark_recommendation_claimed_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_mark_recommendation_claimed" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_mark_recommendation_claimed" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.MarkRecommendationClaimedRequest.pb( + recommender_service.MarkRecommendationClaimedRequest() + ) + 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 = recommendation.Recommendation.to_json( + recommendation.Recommendation() + ) + + request = recommender_service.MarkRecommendationClaimedRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommendation.Recommendation() + + client.mark_recommendation_claimed( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_mark_recommendation_claimed_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.MarkRecommendationClaimedRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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.mark_recommendation_claimed(request) + + +def test_mark_recommendation_claimed_rest_flattened(): + client = RecommenderClient( + 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 = recommendation.Recommendation() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_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 = recommendation.Recommendation.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.mark_recommendation_claimed(**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/*/recommenders/*/recommendations/*}:markClaimed" + % client.transport._host, + args[1], + ) + + +def test_mark_recommendation_claimed_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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.mark_recommendation_claimed( + recommender_service.MarkRecommendationClaimedRequest(), + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_value", + ) + + +def test_mark_recommendation_claimed_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.MarkRecommendationSucceededRequest, + dict, + ], +) +def test_mark_recommendation_succeeded_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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 = recommendation.Recommendation( + name="name_value", + description="description_value", + recommender_subtype="recommender_subtype_value", + priority=recommendation.Recommendation.Priority.P4, + etag="etag_value", + xor_group_id="xor_group_id_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommendation.Recommendation.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.mark_recommendation_succeeded(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.recommender_subtype == "recommender_subtype_value" + assert response.priority == recommendation.Recommendation.Priority.P4 + assert response.etag == "etag_value" + assert response.xor_group_id == "xor_group_id_value" + + +def test_mark_recommendation_succeeded_rest_required_fields( + request_type=recommender_service.MarkRecommendationSucceededRequest, +): + transport_class = transports.RecommenderRestTransport + + request_init = {} + request_init["name"] = "" + request_init["etag"] = "" + 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() + ).mark_recommendation_succeeded._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" + jsonified_request["etag"] = "etag_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).mark_recommendation_succeeded._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" + assert "etag" in jsonified_request + assert jsonified_request["etag"] == "etag_value" + + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommendation.Recommendation() + # 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 = recommendation.Recommendation.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.mark_recommendation_succeeded(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_mark_recommendation_succeeded_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.mark_recommendation_succeeded._get_unset_required_fields( + {} + ) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "etag", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_mark_recommendation_succeeded_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_mark_recommendation_succeeded" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_mark_recommendation_succeeded" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.MarkRecommendationSucceededRequest.pb( + recommender_service.MarkRecommendationSucceededRequest() + ) + 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 = recommendation.Recommendation.to_json( + recommendation.Recommendation() + ) + + request = recommender_service.MarkRecommendationSucceededRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommendation.Recommendation() + + client.mark_recommendation_succeeded( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_mark_recommendation_succeeded_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.MarkRecommendationSucceededRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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.mark_recommendation_succeeded(request) + + +def test_mark_recommendation_succeeded_rest_flattened(): + client = RecommenderClient( + 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 = recommendation.Recommendation() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_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 = recommendation.Recommendation.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.mark_recommendation_succeeded(**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/*/recommenders/*/recommendations/*}:markSucceeded" + % client.transport._host, + args[1], + ) + + +def test_mark_recommendation_succeeded_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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.mark_recommendation_succeeded( + recommender_service.MarkRecommendationSucceededRequest(), + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_value", + ) + + +def test_mark_recommendation_succeeded_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.MarkRecommendationFailedRequest, + dict, + ], +) +def test_mark_recommendation_failed_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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 = recommendation.Recommendation( + name="name_value", + description="description_value", + recommender_subtype="recommender_subtype_value", + priority=recommendation.Recommendation.Priority.P4, + etag="etag_value", + xor_group_id="xor_group_id_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommendation.Recommendation.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.mark_recommendation_failed(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.recommender_subtype == "recommender_subtype_value" + assert response.priority == recommendation.Recommendation.Priority.P4 + assert response.etag == "etag_value" + assert response.xor_group_id == "xor_group_id_value" + + +def test_mark_recommendation_failed_rest_required_fields( + request_type=recommender_service.MarkRecommendationFailedRequest, +): + transport_class = transports.RecommenderRestTransport + + request_init = {} + request_init["name"] = "" + request_init["etag"] = "" + 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() + ).mark_recommendation_failed._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" + jsonified_request["etag"] = "etag_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).mark_recommendation_failed._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" + assert "etag" in jsonified_request + assert jsonified_request["etag"] == "etag_value" + + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommendation.Recommendation() + # 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 = recommendation.Recommendation.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.mark_recommendation_failed(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_mark_recommendation_failed_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.mark_recommendation_failed._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "etag", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_mark_recommendation_failed_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_mark_recommendation_failed" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_mark_recommendation_failed" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.MarkRecommendationFailedRequest.pb( + recommender_service.MarkRecommendationFailedRequest() + ) + 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 = recommendation.Recommendation.to_json( + recommendation.Recommendation() + ) + + request = recommender_service.MarkRecommendationFailedRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommendation.Recommendation() + + client.mark_recommendation_failed( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_mark_recommendation_failed_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.MarkRecommendationFailedRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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.mark_recommendation_failed(request) + + +def test_mark_recommendation_failed_rest_flattened(): + client = RecommenderClient( + 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 = recommendation.Recommendation() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_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 = recommendation.Recommendation.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.mark_recommendation_failed(**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/*/recommenders/*/recommendations/*}:markFailed" + % client.transport._host, + args[1], + ) + + +def test_mark_recommendation_failed_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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.mark_recommendation_failed( + recommender_service.MarkRecommendationFailedRequest(), + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_value", + ) + + +def test_mark_recommendation_failed_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.GetRecommenderConfigRequest, + dict, + ], +) +def test_get_recommender_config_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config" + } + 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 = recommender_config.RecommenderConfig( + name="name_value", + etag="etag_value", + revision_id="revision_id_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommender_config.RecommenderConfig.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_recommender_config(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, recommender_config.RecommenderConfig) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.revision_id == "revision_id_value" + assert response.display_name == "display_name_value" + + +def test_get_recommender_config_rest_required_fields( + request_type=recommender_service.GetRecommenderConfigRequest, +): + transport_class = transports.RecommenderRestTransport + + 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_recommender_config._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_recommender_config._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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommender_config.RecommenderConfig() + # 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 = recommender_config.RecommenderConfig.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_recommender_config(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_recommender_config_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_recommender_config._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_recommender_config_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_get_recommender_config" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_get_recommender_config" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.GetRecommenderConfigRequest.pb( + recommender_service.GetRecommenderConfigRequest() + ) + 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 = recommender_config.RecommenderConfig.to_json( + recommender_config.RecommenderConfig() + ) + + request = recommender_service.GetRecommenderConfigRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommender_config.RecommenderConfig() + + client.get_recommender_config( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_recommender_config_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.GetRecommenderConfigRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config" + } + 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_recommender_config(request) + + +def test_get_recommender_config_rest_flattened(): + client = RecommenderClient( + 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 = recommender_config.RecommenderConfig() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config" + } + + # 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 = recommender_config.RecommenderConfig.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_recommender_config(**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/*/recommenders/*/config}" + % client.transport._host, + args[1], + ) + + +def test_get_recommender_config_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_recommender_config( + recommender_service.GetRecommenderConfigRequest(), + name="name_value", + ) + + +def test_get_recommender_config_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.UpdateRecommenderConfigRequest, + dict, + ], +) +def test_update_recommender_config_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "recommender_config": { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config" + } + } + request_init["recommender_config"] = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config", + "recommender_generation_config": {"params": {"fields": {}}}, + "etag": "etag_value", + "update_time": {"seconds": 751, "nanos": 543}, + "revision_id": "revision_id_value", + "annotations": {}, + "display_name": "display_name_value", + } + 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 = gcr_recommender_config.RecommenderConfig( + name="name_value", + etag="etag_value", + revision_id="revision_id_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = gcr_recommender_config.RecommenderConfig.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_recommender_config(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, gcr_recommender_config.RecommenderConfig) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.revision_id == "revision_id_value" + assert response.display_name == "display_name_value" + + +def test_update_recommender_config_rest_required_fields( + request_type=recommender_service.UpdateRecommenderConfigRequest, +): + transport_class = transports.RecommenderRestTransport + + 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() + ).update_recommender_config._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() + ).update_recommender_config._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "update_mask", + "validate_only", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = gcr_recommender_config.RecommenderConfig() + # 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": "patch", + "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 = gcr_recommender_config.RecommenderConfig.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_recommender_config(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_recommender_config_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_recommender_config._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "updateMask", + "validateOnly", + ) + ) + & set(("recommenderConfig",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_recommender_config_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_update_recommender_config" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_update_recommender_config" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.UpdateRecommenderConfigRequest.pb( + recommender_service.UpdateRecommenderConfigRequest() + ) + 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 = gcr_recommender_config.RecommenderConfig.to_json( + gcr_recommender_config.RecommenderConfig() + ) + + request = recommender_service.UpdateRecommenderConfigRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = gcr_recommender_config.RecommenderConfig() + + client.update_recommender_config( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_recommender_config_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.UpdateRecommenderConfigRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "recommender_config": { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config" + } + } + request_init["recommender_config"] = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config", + "recommender_generation_config": {"params": {"fields": {}}}, + "etag": "etag_value", + "update_time": {"seconds": 751, "nanos": 543}, + "revision_id": "revision_id_value", + "annotations": {}, + "display_name": "display_name_value", + } + 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_recommender_config(request) + + +def test_update_recommender_config_rest_flattened(): + client = RecommenderClient( + 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 = gcr_recommender_config.RecommenderConfig() + + # get arguments that satisfy an http rule for this method + sample_request = { + "recommender_config": { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config" + } + } + + # get truthy value for each flattened field + mock_args = dict( + recommender_config=gcr_recommender_config.RecommenderConfig( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_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 = gcr_recommender_config.RecommenderConfig.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_recommender_config(**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/{recommender_config.name=projects/*/locations/*/recommenders/*/config}" + % client.transport._host, + args[1], + ) + + +def test_update_recommender_config_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_recommender_config( + recommender_service.UpdateRecommenderConfigRequest(), + recommender_config=gcr_recommender_config.RecommenderConfig( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_recommender_config_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.GetInsightTypeConfigRequest, + dict, + ], +) +def test_get_insight_type_config_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config" + } + 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 = insight_type_config.InsightTypeConfig( + name="name_value", + etag="etag_value", + revision_id="revision_id_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = insight_type_config.InsightTypeConfig.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_insight_type_config(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, insight_type_config.InsightTypeConfig) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.revision_id == "revision_id_value" + assert response.display_name == "display_name_value" + + +def test_get_insight_type_config_rest_required_fields( + request_type=recommender_service.GetInsightTypeConfigRequest, +): + transport_class = transports.RecommenderRestTransport + + 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_insight_type_config._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_insight_type_config._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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = insight_type_config.InsightTypeConfig() + # 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 = insight_type_config.InsightTypeConfig.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_insight_type_config(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_insight_type_config_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_insight_type_config._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_insight_type_config_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_get_insight_type_config" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_get_insight_type_config" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.GetInsightTypeConfigRequest.pb( + recommender_service.GetInsightTypeConfigRequest() + ) + 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 = insight_type_config.InsightTypeConfig.to_json( + insight_type_config.InsightTypeConfig() + ) + + request = recommender_service.GetInsightTypeConfigRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = insight_type_config.InsightTypeConfig() + + client.get_insight_type_config( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_insight_type_config_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.GetInsightTypeConfigRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config" + } + 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_insight_type_config(request) + + +def test_get_insight_type_config_rest_flattened(): + client = RecommenderClient( + 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 = insight_type_config.InsightTypeConfig() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config" + } + + # 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 = insight_type_config.InsightTypeConfig.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_insight_type_config(**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/*/insightTypes/*/config}" + % client.transport._host, + args[1], + ) + + +def test_get_insight_type_config_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_insight_type_config( + recommender_service.GetInsightTypeConfigRequest(), + name="name_value", + ) + + +def test_get_insight_type_config_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.UpdateInsightTypeConfigRequest, + dict, + ], +) +def test_update_insight_type_config_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "insight_type_config": { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config" + } + } + request_init["insight_type_config"] = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config", + "insight_type_generation_config": {"params": {"fields": {}}}, + "etag": "etag_value", + "update_time": {"seconds": 751, "nanos": 543}, + "revision_id": "revision_id_value", + "annotations": {}, + "display_name": "display_name_value", + } + 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 = gcr_insight_type_config.InsightTypeConfig( + name="name_value", + etag="etag_value", + revision_id="revision_id_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = gcr_insight_type_config.InsightTypeConfig.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_insight_type_config(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, gcr_insight_type_config.InsightTypeConfig) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.revision_id == "revision_id_value" + assert response.display_name == "display_name_value" + + +def test_update_insight_type_config_rest_required_fields( + request_type=recommender_service.UpdateInsightTypeConfigRequest, +): + transport_class = transports.RecommenderRestTransport + + 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() + ).update_insight_type_config._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() + ).update_insight_type_config._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "update_mask", + "validate_only", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = gcr_insight_type_config.InsightTypeConfig() + # 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": "patch", + "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 = gcr_insight_type_config.InsightTypeConfig.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_insight_type_config(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_insight_type_config_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_insight_type_config._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "updateMask", + "validateOnly", + ) + ) + & set(("insightTypeConfig",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_insight_type_config_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_update_insight_type_config" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_update_insight_type_config" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.UpdateInsightTypeConfigRequest.pb( + recommender_service.UpdateInsightTypeConfigRequest() + ) + 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 = gcr_insight_type_config.InsightTypeConfig.to_json( + gcr_insight_type_config.InsightTypeConfig() + ) + + request = recommender_service.UpdateInsightTypeConfigRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = gcr_insight_type_config.InsightTypeConfig() + + client.update_insight_type_config( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_insight_type_config_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.UpdateInsightTypeConfigRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "insight_type_config": { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config" + } + } + request_init["insight_type_config"] = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config", + "insight_type_generation_config": {"params": {"fields": {}}}, + "etag": "etag_value", + "update_time": {"seconds": 751, "nanos": 543}, + "revision_id": "revision_id_value", + "annotations": {}, + "display_name": "display_name_value", + } + 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_insight_type_config(request) + + +def test_update_insight_type_config_rest_flattened(): + client = RecommenderClient( + 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 = gcr_insight_type_config.InsightTypeConfig() + + # get arguments that satisfy an http rule for this method + sample_request = { + "insight_type_config": { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config" + } + } + + # get truthy value for each flattened field + mock_args = dict( + insight_type_config=gcr_insight_type_config.InsightTypeConfig( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_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 = gcr_insight_type_config.InsightTypeConfig.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_insight_type_config(**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/{insight_type_config.name=projects/*/locations/*/insightTypes/*/config}" + % client.transport._host, + args[1], + ) + + +def test_update_insight_type_config_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_insight_type_config( + recommender_service.UpdateInsightTypeConfigRequest(), + insight_type_config=gcr_insight_type_config.InsightTypeConfig( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_insight_type_config_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecommenderClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = RecommenderClient( + 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 = RecommenderClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecommenderClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = RecommenderClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.RecommenderGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.RecommenderGrpcTransport, + transports.RecommenderGrpcAsyncIOTransport, + transports.RecommenderRestTransport, + ], +) +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 = RecommenderClient.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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.RecommenderGrpcTransport, + ) + + +def test_recommender_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.RecommenderTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_recommender_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.recommender_v1.services.recommender.transports.RecommenderTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.RecommenderTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. methods = ( "list_insights", "get_insight", @@ -4519,6 +8228,7 @@ def test_recommender_transport_auth_adc(transport_class): [ transports.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport, + transports.RecommenderRestTransport, ], ) def test_recommender_transport_auth_gdch_credentials(transport_class): @@ -4613,11 +8323,23 @@ def test_recommender_grpc_transport_client_cert_source_for_mtls(transport_class) ) +def test_recommender_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.RecommenderRestTransport( + 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_recommender_host_no_port(transport_name): @@ -4628,7 +8350,11 @@ def test_recommender_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("recommender.googleapis.com:443") + assert client.transport._host == ( + "recommender.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommender.googleapis.com" + ) @pytest.mark.parametrize( @@ -4636,6 +8362,7 @@ def test_recommender_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_recommender_host_with_port(transport_name): @@ -4646,7 +8373,66 @@ def test_recommender_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("recommender.googleapis.com:8000") + assert client.transport._host == ( + "recommender.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommender.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_recommender_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = RecommenderClient( + credentials=creds1, + transport=transport_name, + ) + client2 = RecommenderClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.list_insights._session + session2 = client2.transport.list_insights._session + assert session1 != session2 + session1 = client1.transport.get_insight._session + session2 = client2.transport.get_insight._session + assert session1 != session2 + session1 = client1.transport.mark_insight_accepted._session + session2 = client2.transport.mark_insight_accepted._session + assert session1 != session2 + session1 = client1.transport.list_recommendations._session + session2 = client2.transport.list_recommendations._session + assert session1 != session2 + session1 = client1.transport.get_recommendation._session + session2 = client2.transport.get_recommendation._session + assert session1 != session2 + session1 = client1.transport.mark_recommendation_claimed._session + session2 = client2.transport.mark_recommendation_claimed._session + assert session1 != session2 + session1 = client1.transport.mark_recommendation_succeeded._session + session2 = client2.transport.mark_recommendation_succeeded._session + assert session1 != session2 + session1 = client1.transport.mark_recommendation_failed._session + session2 = client2.transport.mark_recommendation_failed._session + assert session1 != session2 + session1 = client1.transport.get_recommender_config._session + session2 = client2.transport.get_recommender_config._session + assert session1 != session2 + session1 = client1.transport.update_recommender_config._session + session2 = client2.transport.update_recommender_config._session + assert session1 != session2 + session1 = client1.transport.get_insight_type_config._session + session2 = client2.transport.get_insight_type_config._session + assert session1 != session2 + session1 = client1.transport.update_insight_type_config._session + session2 = client2.transport.update_insight_type_config._session + assert session1 != session2 def test_recommender_grpc_transport_channel(): @@ -5077,6 +8863,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -5094,6 +8881,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/packages/google-cloud-recommender/tests/unit/gapic/recommender_v1beta1/test_recommender.py b/packages/google-cloud-recommender/tests/unit/gapic/recommender_v1beta1/test_recommender.py index 50e044c346b4..77e64ecbe062 100644 --- a/packages/google-cloud-recommender/tests/unit/gapic/recommender_v1beta1/test_recommender.py +++ b/packages/google-cloud-recommender/tests/unit/gapic/recommender_v1beta1/test_recommender.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 @@ -33,6 +35,7 @@ from google.oauth2 import service_account from google.protobuf import duration_pb2 # type: ignore from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import json_format from google.protobuf import struct_pb2 # type: ignore from google.protobuf import timestamp_pb2 # type: ignore import grpc @@ -40,6 +43,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.recommender_v1beta1.services.recommender import ( RecommenderAsyncClient, @@ -106,6 +111,7 @@ def test__get_default_mtls_endpoint(): [ (RecommenderClient, "grpc"), (RecommenderAsyncClient, "grpc_asyncio"), + (RecommenderClient, "rest"), ], ) def test_recommender_client_from_service_account_info(client_class, transport_name): @@ -119,7 +125,11 @@ def test_recommender_client_from_service_account_info(client_class, transport_na assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("recommender.googleapis.com:443") + assert client.transport._host == ( + "recommender.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommender.googleapis.com" + ) @pytest.mark.parametrize( @@ -127,6 +137,7 @@ def test_recommender_client_from_service_account_info(client_class, transport_na [ (transports.RecommenderGrpcTransport, "grpc"), (transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.RecommenderRestTransport, "rest"), ], ) def test_recommender_client_service_account_always_use_jwt( @@ -152,6 +163,7 @@ def test_recommender_client_service_account_always_use_jwt( [ (RecommenderClient, "grpc"), (RecommenderAsyncClient, "grpc_asyncio"), + (RecommenderClient, "rest"), ], ) def test_recommender_client_from_service_account_file(client_class, transport_name): @@ -172,13 +184,18 @@ def test_recommender_client_from_service_account_file(client_class, transport_na assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("recommender.googleapis.com:443") + assert client.transport._host == ( + "recommender.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommender.googleapis.com" + ) def test_recommender_client_get_transport_class(): transport = RecommenderClient.get_transport_class() available_transports = [ transports.RecommenderGrpcTransport, + transports.RecommenderRestTransport, ] assert transport in available_transports @@ -195,6 +212,7 @@ def test_recommender_client_get_transport_class(): transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio", ), + (RecommenderClient, transports.RecommenderRestTransport, "rest"), ], ) @mock.patch.object( @@ -338,6 +356,8 @@ def test_recommender_client_client_options( "grpc_asyncio", "false", ), + (RecommenderClient, transports.RecommenderRestTransport, "rest", "true"), + (RecommenderClient, transports.RecommenderRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -531,6 +551,7 @@ def test_recommender_client_get_mtls_endpoint_and_cert_source(client_class): transports.RecommenderGrpcAsyncIOTransport, "grpc_asyncio", ), + (RecommenderClient, transports.RecommenderRestTransport, "rest"), ], ) def test_recommender_client_client_options_scopes( @@ -566,6 +587,7 @@ def test_recommender_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (RecommenderClient, transports.RecommenderRestTransport, "rest", None), ], ) def test_recommender_client_client_options_credentials_file( @@ -4284,142 +4306,3829 @@ async def test_update_insight_type_config_flattened_error_async(): ) -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.RecommenderGrpcTransport( +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.ListInsightsRequest, + dict, + ], +) +def test_list_insights_rest(request_type): + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - with pytest.raises(ValueError): - client = RecommenderClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/insightTypes/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 = recommender_service.ListInsightsResponse( + next_page_token="next_page_token_value", ) - # It is an error to provide a credentials file and a transport instance. - transport = transports.RecommenderGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommender_service.ListInsightsResponse.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_insights(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListInsightsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_insights_rest_required_fields( + request_type=recommender_service.ListInsightsRequest, +): + transport_class = transports.RecommenderRestTransport + + 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, + ) ) - with pytest.raises(ValueError): - client = RecommenderClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_insights._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_insights._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "filter", + "page_size", + "page_token", ) + ) + jsonified_request.update(unset_fields) - # It is an error to provide an api_key and a transport instance. - transport = transports.RecommenderGrpcTransport( + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommender_service.ListInsightsResponse() + # 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 = recommender_service.ListInsightsResponse.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_insights(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_insights_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_insights._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "filter", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = RecommenderClient( - client_options=options, - transport=transport, + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_insights_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_list_insights" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_list_insights" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.ListInsightsRequest.pb( + recommender_service.ListInsightsRequest() + ) + 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 = recommender_service.ListInsightsResponse.to_json( + recommender_service.ListInsightsResponse() ) - # 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 = RecommenderClient( - client_options=options, credentials=ga_credentials.AnonymousCredentials() + request = recommender_service.ListInsightsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommender_service.ListInsightsResponse() + + client.list_insights( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], ) - # It is an error to provide scopes and a transport instance. - transport = transports.RecommenderGrpcTransport( + pre.assert_called_once() + post.assert_called_once() + + +def test_list_insights_rest_bad_request( + transport: str = "rest", request_type=recommender_service.ListInsightsRequest +): + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - with pytest.raises(ValueError): - client = RecommenderClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/insightTypes/sample3"} + request = request_type(**request_init) -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.RecommenderGrpcTransport( + # 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_insights(request) + + +def test_list_insights_rest_flattened(): + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - client = RecommenderClient(transport=transport) - assert client.transport is transport + # 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 = recommender_service.ListInsightsResponse() -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.RecommenderGrpcTransport( + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/insightTypes/sample3" + } + + # 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 = recommender_service.ListInsightsResponse.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_insights(**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/v1beta1/{parent=projects/*/locations/*/insightTypes/*}/insights" + % client.transport._host, + args[1], + ) + + +def test_list_insights_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel - transport = transports.RecommenderGrpcAsyncIOTransport( + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_insights( + recommender_service.ListInsightsRequest(), + parent="parent_value", + ) + + +def test_list_insights_rest_pager(transport: str = "rest"): + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel + # 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 = ( + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + insight.Insight(), + ], + next_page_token="abc", + ), + recommender_service.ListInsightsResponse( + insights=[], + next_page_token="def", + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + ], + next_page_token="ghi", + ), + recommender_service.ListInsightsResponse( + insights=[ + insight.Insight(), + insight.Insight(), + ], + ), + ) + # Two responses for two calls + response = response + response -@pytest.mark.parametrize( - "transport_class", - [ - transports.RecommenderGrpcTransport, - transports.RecommenderGrpcAsyncIOTransport, - ], -) -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() + # Wrap the values into proper Response objs + response = tuple( + recommender_service.ListInsightsResponse.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/insightTypes/sample3" + } + + pager = client.list_insights(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, insight.Insight) for i in results) + + pages = list(client.list_insights(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token @pytest.mark.parametrize( - "transport_name", + "request_type", [ - "grpc", + recommender_service.GetInsightRequest, + dict, ], ) -def test_transport_kind(transport_name): - transport = RecommenderClient.get_transport_class(transport_name)( +def test_get_insight_rest(request_type): + client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - assert transport.kind == transport_name + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/insights/sample4" + } + 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 = insight.Insight( + name="name_value", + description="description_value", + target_resources=["target_resources_value"], + insight_subtype="insight_subtype_value", + category=insight.Insight.Category.COST, + severity=insight.Insight.Severity.LOW, + etag="etag_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = insight.Insight.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_insight(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, insight.Insight) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.target_resources == ["target_resources_value"] + assert response.insight_subtype == "insight_subtype_value" + assert response.category == insight.Insight.Category.COST + assert response.severity == insight.Insight.Severity.LOW + assert response.etag == "etag_value" + + +def test_get_insight_rest_required_fields( + request_type=recommender_service.GetInsightRequest, +): + transport_class = transports.RecommenderRestTransport + + 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_insight._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_insight._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" -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. client = RecommenderClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - assert isinstance( - client.transport, - transports.RecommenderGrpcTransport, + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = insight.Insight() + # 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 = insight.Insight.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_insight(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_insight_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials ) + unset_fields = transport.get_insight._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) -def test_recommender_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.RecommenderTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json", - ) +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_insight_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_get_insight" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_get_insight" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.GetInsightRequest.pb( + recommender_service.GetInsightRequest() + ) + 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 = insight.Insight.to_json(insight.Insight()) + + request = recommender_service.GetInsightRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = insight.Insight() -def test_recommender_base_transport(): - # Instantiate the base transport. - with mock.patch( - "google.cloud.recommender_v1beta1.services.recommender.transports.RecommenderTransport.__init__" - ) as Transport: - Transport.return_value = None - transport = transports.RecommenderTransport( - credentials=ga_credentials.AnonymousCredentials(), + client.get_insight( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], ) - # Every method on the transport should just blindly - # raise NotImplementedError. + pre.assert_called_once() + post.assert_called_once() + + +def test_get_insight_rest_bad_request( + transport: str = "rest", request_type=recommender_service.GetInsightRequest +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/insights/sample4" + } + 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_insight(request) + + +def test_get_insight_rest_flattened(): + client = RecommenderClient( + 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 = insight.Insight() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/insights/sample4" + } + + # 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 = insight.Insight.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_insight(**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/v1beta1/{name=projects/*/locations/*/insightTypes/*/insights/*}" + % client.transport._host, + args[1], + ) + + +def test_get_insight_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_insight( + recommender_service.GetInsightRequest(), + name="name_value", + ) + + +def test_get_insight_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.MarkInsightAcceptedRequest, + dict, + ], +) +def test_mark_insight_accepted_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/insights/sample4" + } + 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 = insight.Insight( + name="name_value", + description="description_value", + target_resources=["target_resources_value"], + insight_subtype="insight_subtype_value", + category=insight.Insight.Category.COST, + severity=insight.Insight.Severity.LOW, + etag="etag_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = insight.Insight.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.mark_insight_accepted(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, insight.Insight) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.target_resources == ["target_resources_value"] + assert response.insight_subtype == "insight_subtype_value" + assert response.category == insight.Insight.Category.COST + assert response.severity == insight.Insight.Severity.LOW + assert response.etag == "etag_value" + + +def test_mark_insight_accepted_rest_required_fields( + request_type=recommender_service.MarkInsightAcceptedRequest, +): + transport_class = transports.RecommenderRestTransport + + request_init = {} + request_init["name"] = "" + request_init["etag"] = "" + 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() + ).mark_insight_accepted._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" + jsonified_request["etag"] = "etag_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).mark_insight_accepted._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" + assert "etag" in jsonified_request + assert jsonified_request["etag"] == "etag_value" + + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = insight.Insight() + # 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 = insight.Insight.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.mark_insight_accepted(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_mark_insight_accepted_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.mark_insight_accepted._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "etag", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_mark_insight_accepted_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_mark_insight_accepted" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_mark_insight_accepted" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.MarkInsightAcceptedRequest.pb( + recommender_service.MarkInsightAcceptedRequest() + ) + 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 = insight.Insight.to_json(insight.Insight()) + + request = recommender_service.MarkInsightAcceptedRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = insight.Insight() + + client.mark_insight_accepted( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_mark_insight_accepted_rest_bad_request( + transport: str = "rest", request_type=recommender_service.MarkInsightAcceptedRequest +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/insights/sample4" + } + 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.mark_insight_accepted(request) + + +def test_mark_insight_accepted_rest_flattened(): + client = RecommenderClient( + 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 = insight.Insight() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/insights/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_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 = insight.Insight.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.mark_insight_accepted(**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/v1beta1/{name=projects/*/locations/*/insightTypes/*/insights/*}:markAccepted" + % client.transport._host, + args[1], + ) + + +def test_mark_insight_accepted_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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.mark_insight_accepted( + recommender_service.MarkInsightAcceptedRequest(), + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_value", + ) + + +def test_mark_insight_accepted_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.ListRecommendationsRequest, + dict, + ], +) +def test_list_recommendations_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/recommenders/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 = recommender_service.ListRecommendationsResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommender_service.ListRecommendationsResponse.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_recommendations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRecommendationsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_recommendations_rest_required_fields( + request_type=recommender_service.ListRecommendationsRequest, +): + transport_class = transports.RecommenderRestTransport + + 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_recommendations._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_recommendations._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "filter", + "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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommender_service.ListRecommendationsResponse() + # 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 = recommender_service.ListRecommendationsResponse.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_recommendations(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_recommendations_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_recommendations._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "filter", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_recommendations_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_list_recommendations" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_list_recommendations" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.ListRecommendationsRequest.pb( + recommender_service.ListRecommendationsRequest() + ) + 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 = ( + recommender_service.ListRecommendationsResponse.to_json( + recommender_service.ListRecommendationsResponse() + ) + ) + + request = recommender_service.ListRecommendationsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommender_service.ListRecommendationsResponse() + + client.list_recommendations( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_recommendations_rest_bad_request( + transport: str = "rest", request_type=recommender_service.ListRecommendationsRequest +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/recommenders/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.list_recommendations(request) + + +def test_list_recommendations_rest_flattened(): + client = RecommenderClient( + 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 = recommender_service.ListRecommendationsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/recommenders/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + filter="filter_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 = recommender_service.ListRecommendationsResponse.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_recommendations(**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/v1beta1/{parent=projects/*/locations/*/recommenders/*}/recommendations" + % client.transport._host, + args[1], + ) + + +def test_list_recommendations_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_recommendations( + recommender_service.ListRecommendationsRequest(), + parent="parent_value", + filter="filter_value", + ) + + +def test_list_recommendations_rest_pager(transport: str = "rest"): + client = RecommenderClient( + 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 = ( + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + next_page_token="abc", + ), + recommender_service.ListRecommendationsResponse( + recommendations=[], + next_page_token="def", + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + ], + next_page_token="ghi", + ), + recommender_service.ListRecommendationsResponse( + recommendations=[ + recommendation.Recommendation(), + recommendation.Recommendation(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + recommender_service.ListRecommendationsResponse.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/recommenders/sample3" + } + + pager = client.list_recommendations(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, recommendation.Recommendation) for i in results) + + pages = list(client.list_recommendations(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", + [ + recommender_service.GetRecommendationRequest, + dict, + ], +) +def test_get_recommendation_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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 = recommendation.Recommendation( + name="name_value", + description="description_value", + recommender_subtype="recommender_subtype_value", + priority=recommendation.Recommendation.Priority.P4, + etag="etag_value", + xor_group_id="xor_group_id_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommendation.Recommendation.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_recommendation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.recommender_subtype == "recommender_subtype_value" + assert response.priority == recommendation.Recommendation.Priority.P4 + assert response.etag == "etag_value" + assert response.xor_group_id == "xor_group_id_value" + + +def test_get_recommendation_rest_required_fields( + request_type=recommender_service.GetRecommendationRequest, +): + transport_class = transports.RecommenderRestTransport + + 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_recommendation._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_recommendation._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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommendation.Recommendation() + # 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 = recommendation.Recommendation.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_recommendation(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_recommendation_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_recommendation._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_recommendation_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_get_recommendation" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_get_recommendation" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.GetRecommendationRequest.pb( + recommender_service.GetRecommendationRequest() + ) + 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 = recommendation.Recommendation.to_json( + recommendation.Recommendation() + ) + + request = recommender_service.GetRecommendationRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommendation.Recommendation() + + client.get_recommendation( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_recommendation_rest_bad_request( + transport: str = "rest", request_type=recommender_service.GetRecommendationRequest +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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_recommendation(request) + + +def test_get_recommendation_rest_flattened(): + client = RecommenderClient( + 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 = recommendation.Recommendation() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + + # 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 = recommendation.Recommendation.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_recommendation(**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/v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}" + % client.transport._host, + args[1], + ) + + +def test_get_recommendation_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_recommendation( + recommender_service.GetRecommendationRequest(), + name="name_value", + ) + + +def test_get_recommendation_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.MarkRecommendationClaimedRequest, + dict, + ], +) +def test_mark_recommendation_claimed_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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 = recommendation.Recommendation( + name="name_value", + description="description_value", + recommender_subtype="recommender_subtype_value", + priority=recommendation.Recommendation.Priority.P4, + etag="etag_value", + xor_group_id="xor_group_id_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommendation.Recommendation.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.mark_recommendation_claimed(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.recommender_subtype == "recommender_subtype_value" + assert response.priority == recommendation.Recommendation.Priority.P4 + assert response.etag == "etag_value" + assert response.xor_group_id == "xor_group_id_value" + + +def test_mark_recommendation_claimed_rest_required_fields( + request_type=recommender_service.MarkRecommendationClaimedRequest, +): + transport_class = transports.RecommenderRestTransport + + request_init = {} + request_init["name"] = "" + request_init["etag"] = "" + 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() + ).mark_recommendation_claimed._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" + jsonified_request["etag"] = "etag_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).mark_recommendation_claimed._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" + assert "etag" in jsonified_request + assert jsonified_request["etag"] == "etag_value" + + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommendation.Recommendation() + # 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 = recommendation.Recommendation.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.mark_recommendation_claimed(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_mark_recommendation_claimed_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.mark_recommendation_claimed._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "etag", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_mark_recommendation_claimed_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_mark_recommendation_claimed" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_mark_recommendation_claimed" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.MarkRecommendationClaimedRequest.pb( + recommender_service.MarkRecommendationClaimedRequest() + ) + 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 = recommendation.Recommendation.to_json( + recommendation.Recommendation() + ) + + request = recommender_service.MarkRecommendationClaimedRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommendation.Recommendation() + + client.mark_recommendation_claimed( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_mark_recommendation_claimed_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.MarkRecommendationClaimedRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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.mark_recommendation_claimed(request) + + +def test_mark_recommendation_claimed_rest_flattened(): + client = RecommenderClient( + 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 = recommendation.Recommendation() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_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 = recommendation.Recommendation.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.mark_recommendation_claimed(**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/v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markClaimed" + % client.transport._host, + args[1], + ) + + +def test_mark_recommendation_claimed_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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.mark_recommendation_claimed( + recommender_service.MarkRecommendationClaimedRequest(), + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_value", + ) + + +def test_mark_recommendation_claimed_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.MarkRecommendationSucceededRequest, + dict, + ], +) +def test_mark_recommendation_succeeded_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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 = recommendation.Recommendation( + name="name_value", + description="description_value", + recommender_subtype="recommender_subtype_value", + priority=recommendation.Recommendation.Priority.P4, + etag="etag_value", + xor_group_id="xor_group_id_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommendation.Recommendation.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.mark_recommendation_succeeded(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.recommender_subtype == "recommender_subtype_value" + assert response.priority == recommendation.Recommendation.Priority.P4 + assert response.etag == "etag_value" + assert response.xor_group_id == "xor_group_id_value" + + +def test_mark_recommendation_succeeded_rest_required_fields( + request_type=recommender_service.MarkRecommendationSucceededRequest, +): + transport_class = transports.RecommenderRestTransport + + request_init = {} + request_init["name"] = "" + request_init["etag"] = "" + 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() + ).mark_recommendation_succeeded._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" + jsonified_request["etag"] = "etag_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).mark_recommendation_succeeded._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" + assert "etag" in jsonified_request + assert jsonified_request["etag"] == "etag_value" + + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommendation.Recommendation() + # 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 = recommendation.Recommendation.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.mark_recommendation_succeeded(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_mark_recommendation_succeeded_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.mark_recommendation_succeeded._get_unset_required_fields( + {} + ) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "etag", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_mark_recommendation_succeeded_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_mark_recommendation_succeeded" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_mark_recommendation_succeeded" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.MarkRecommendationSucceededRequest.pb( + recommender_service.MarkRecommendationSucceededRequest() + ) + 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 = recommendation.Recommendation.to_json( + recommendation.Recommendation() + ) + + request = recommender_service.MarkRecommendationSucceededRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommendation.Recommendation() + + client.mark_recommendation_succeeded( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_mark_recommendation_succeeded_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.MarkRecommendationSucceededRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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.mark_recommendation_succeeded(request) + + +def test_mark_recommendation_succeeded_rest_flattened(): + client = RecommenderClient( + 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 = recommendation.Recommendation() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_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 = recommendation.Recommendation.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.mark_recommendation_succeeded(**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/v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markSucceeded" + % client.transport._host, + args[1], + ) + + +def test_mark_recommendation_succeeded_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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.mark_recommendation_succeeded( + recommender_service.MarkRecommendationSucceededRequest(), + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_value", + ) + + +def test_mark_recommendation_succeeded_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.MarkRecommendationFailedRequest, + dict, + ], +) +def test_mark_recommendation_failed_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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 = recommendation.Recommendation( + name="name_value", + description="description_value", + recommender_subtype="recommender_subtype_value", + priority=recommendation.Recommendation.Priority.P4, + etag="etag_value", + xor_group_id="xor_group_id_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommendation.Recommendation.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.mark_recommendation_failed(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, recommendation.Recommendation) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.recommender_subtype == "recommender_subtype_value" + assert response.priority == recommendation.Recommendation.Priority.P4 + assert response.etag == "etag_value" + assert response.xor_group_id == "xor_group_id_value" + + +def test_mark_recommendation_failed_rest_required_fields( + request_type=recommender_service.MarkRecommendationFailedRequest, +): + transport_class = transports.RecommenderRestTransport + + request_init = {} + request_init["name"] = "" + request_init["etag"] = "" + 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() + ).mark_recommendation_failed._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" + jsonified_request["etag"] = "etag_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).mark_recommendation_failed._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" + assert "etag" in jsonified_request + assert jsonified_request["etag"] == "etag_value" + + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommendation.Recommendation() + # 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 = recommendation.Recommendation.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.mark_recommendation_failed(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_mark_recommendation_failed_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.mark_recommendation_failed._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "etag", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_mark_recommendation_failed_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_mark_recommendation_failed" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_mark_recommendation_failed" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.MarkRecommendationFailedRequest.pb( + recommender_service.MarkRecommendationFailedRequest() + ) + 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 = recommendation.Recommendation.to_json( + recommendation.Recommendation() + ) + + request = recommender_service.MarkRecommendationFailedRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommendation.Recommendation() + + client.mark_recommendation_failed( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_mark_recommendation_failed_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.MarkRecommendationFailedRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + 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.mark_recommendation_failed(request) + + +def test_mark_recommendation_failed_rest_flattened(): + client = RecommenderClient( + 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 = recommendation.Recommendation() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/recommendations/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_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 = recommendation.Recommendation.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.mark_recommendation_failed(**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/v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markFailed" + % client.transport._host, + args[1], + ) + + +def test_mark_recommendation_failed_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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.mark_recommendation_failed( + recommender_service.MarkRecommendationFailedRequest(), + name="name_value", + state_metadata={"key_value": "value_value"}, + etag="etag_value", + ) + + +def test_mark_recommendation_failed_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.GetRecommenderConfigRequest, + dict, + ], +) +def test_get_recommender_config_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config" + } + 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 = recommender_config.RecommenderConfig( + name="name_value", + etag="etag_value", + revision_id="revision_id_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = recommender_config.RecommenderConfig.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_recommender_config(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, recommender_config.RecommenderConfig) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.revision_id == "revision_id_value" + assert response.display_name == "display_name_value" + + +def test_get_recommender_config_rest_required_fields( + request_type=recommender_service.GetRecommenderConfigRequest, +): + transport_class = transports.RecommenderRestTransport + + 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_recommender_config._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_recommender_config._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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = recommender_config.RecommenderConfig() + # 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 = recommender_config.RecommenderConfig.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_recommender_config(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_recommender_config_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_recommender_config._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_recommender_config_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_get_recommender_config" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_get_recommender_config" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.GetRecommenderConfigRequest.pb( + recommender_service.GetRecommenderConfigRequest() + ) + 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 = recommender_config.RecommenderConfig.to_json( + recommender_config.RecommenderConfig() + ) + + request = recommender_service.GetRecommenderConfigRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = recommender_config.RecommenderConfig() + + client.get_recommender_config( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_recommender_config_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.GetRecommenderConfigRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config" + } + 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_recommender_config(request) + + +def test_get_recommender_config_rest_flattened(): + client = RecommenderClient( + 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 = recommender_config.RecommenderConfig() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config" + } + + # 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 = recommender_config.RecommenderConfig.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_recommender_config(**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/v1beta1/{name=projects/*/locations/*/recommenders/*/config}" + % client.transport._host, + args[1], + ) + + +def test_get_recommender_config_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_recommender_config( + recommender_service.GetRecommenderConfigRequest(), + name="name_value", + ) + + +def test_get_recommender_config_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.UpdateRecommenderConfigRequest, + dict, + ], +) +def test_update_recommender_config_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "recommender_config": { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config" + } + } + request_init["recommender_config"] = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config", + "recommender_generation_config": {"params": {"fields": {}}}, + "etag": "etag_value", + "update_time": {"seconds": 751, "nanos": 543}, + "revision_id": "revision_id_value", + "annotations": {}, + "display_name": "display_name_value", + } + 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 = gcr_recommender_config.RecommenderConfig( + name="name_value", + etag="etag_value", + revision_id="revision_id_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = gcr_recommender_config.RecommenderConfig.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_recommender_config(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, gcr_recommender_config.RecommenderConfig) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.revision_id == "revision_id_value" + assert response.display_name == "display_name_value" + + +def test_update_recommender_config_rest_required_fields( + request_type=recommender_service.UpdateRecommenderConfigRequest, +): + transport_class = transports.RecommenderRestTransport + + 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() + ).update_recommender_config._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() + ).update_recommender_config._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "update_mask", + "validate_only", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = gcr_recommender_config.RecommenderConfig() + # 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": "patch", + "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 = gcr_recommender_config.RecommenderConfig.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_recommender_config(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_recommender_config_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_recommender_config._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "updateMask", + "validateOnly", + ) + ) + & set(("recommenderConfig",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_recommender_config_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_update_recommender_config" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_update_recommender_config" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.UpdateRecommenderConfigRequest.pb( + recommender_service.UpdateRecommenderConfigRequest() + ) + 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 = gcr_recommender_config.RecommenderConfig.to_json( + gcr_recommender_config.RecommenderConfig() + ) + + request = recommender_service.UpdateRecommenderConfigRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = gcr_recommender_config.RecommenderConfig() + + client.update_recommender_config( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_recommender_config_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.UpdateRecommenderConfigRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "recommender_config": { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config" + } + } + request_init["recommender_config"] = { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config", + "recommender_generation_config": {"params": {"fields": {}}}, + "etag": "etag_value", + "update_time": {"seconds": 751, "nanos": 543}, + "revision_id": "revision_id_value", + "annotations": {}, + "display_name": "display_name_value", + } + 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_recommender_config(request) + + +def test_update_recommender_config_rest_flattened(): + client = RecommenderClient( + 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 = gcr_recommender_config.RecommenderConfig() + + # get arguments that satisfy an http rule for this method + sample_request = { + "recommender_config": { + "name": "projects/sample1/locations/sample2/recommenders/sample3/config" + } + } + + # get truthy value for each flattened field + mock_args = dict( + recommender_config=gcr_recommender_config.RecommenderConfig( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_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 = gcr_recommender_config.RecommenderConfig.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_recommender_config(**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/v1beta1/{recommender_config.name=projects/*/locations/*/recommenders/*/config}" + % client.transport._host, + args[1], + ) + + +def test_update_recommender_config_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_recommender_config( + recommender_service.UpdateRecommenderConfigRequest(), + recommender_config=gcr_recommender_config.RecommenderConfig( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_recommender_config_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.GetInsightTypeConfigRequest, + dict, + ], +) +def test_get_insight_type_config_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config" + } + 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 = insight_type_config.InsightTypeConfig( + name="name_value", + etag="etag_value", + revision_id="revision_id_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = insight_type_config.InsightTypeConfig.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_insight_type_config(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, insight_type_config.InsightTypeConfig) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.revision_id == "revision_id_value" + assert response.display_name == "display_name_value" + + +def test_get_insight_type_config_rest_required_fields( + request_type=recommender_service.GetInsightTypeConfigRequest, +): + transport_class = transports.RecommenderRestTransport + + 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_insight_type_config._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_insight_type_config._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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = insight_type_config.InsightTypeConfig() + # 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 = insight_type_config.InsightTypeConfig.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_insight_type_config(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_insight_type_config_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_insight_type_config._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_insight_type_config_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_get_insight_type_config" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_get_insight_type_config" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.GetInsightTypeConfigRequest.pb( + recommender_service.GetInsightTypeConfigRequest() + ) + 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 = insight_type_config.InsightTypeConfig.to_json( + insight_type_config.InsightTypeConfig() + ) + + request = recommender_service.GetInsightTypeConfigRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = insight_type_config.InsightTypeConfig() + + client.get_insight_type_config( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_insight_type_config_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.GetInsightTypeConfigRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config" + } + 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_insight_type_config(request) + + +def test_get_insight_type_config_rest_flattened(): + client = RecommenderClient( + 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 = insight_type_config.InsightTypeConfig() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config" + } + + # 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 = insight_type_config.InsightTypeConfig.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_insight_type_config(**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/v1beta1/{name=projects/*/locations/*/insightTypes/*/config}" + % client.transport._host, + args[1], + ) + + +def test_get_insight_type_config_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_insight_type_config( + recommender_service.GetInsightTypeConfigRequest(), + name="name_value", + ) + + +def test_get_insight_type_config_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + recommender_service.UpdateInsightTypeConfigRequest, + dict, + ], +) +def test_update_insight_type_config_rest(request_type): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "insight_type_config": { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config" + } + } + request_init["insight_type_config"] = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config", + "insight_type_generation_config": {"params": {"fields": {}}}, + "etag": "etag_value", + "update_time": {"seconds": 751, "nanos": 543}, + "revision_id": "revision_id_value", + "annotations": {}, + "display_name": "display_name_value", + } + 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 = gcr_insight_type_config.InsightTypeConfig( + name="name_value", + etag="etag_value", + revision_id="revision_id_value", + display_name="display_name_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = gcr_insight_type_config.InsightTypeConfig.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_insight_type_config(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, gcr_insight_type_config.InsightTypeConfig) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.revision_id == "revision_id_value" + assert response.display_name == "display_name_value" + + +def test_update_insight_type_config_rest_required_fields( + request_type=recommender_service.UpdateInsightTypeConfigRequest, +): + transport_class = transports.RecommenderRestTransport + + 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() + ).update_insight_type_config._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() + ).update_insight_type_config._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "update_mask", + "validate_only", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = gcr_insight_type_config.InsightTypeConfig() + # 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": "patch", + "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 = gcr_insight_type_config.InsightTypeConfig.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_insight_type_config(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_insight_type_config_rest_unset_required_fields(): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_insight_type_config._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "updateMask", + "validateOnly", + ) + ) + & set(("insightTypeConfig",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_insight_type_config_rest_interceptors(null_interceptor): + transport = transports.RecommenderRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.RecommenderRestInterceptor(), + ) + client = RecommenderClient(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.RecommenderRestInterceptor, "post_update_insight_type_config" + ) as post, mock.patch.object( + transports.RecommenderRestInterceptor, "pre_update_insight_type_config" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = recommender_service.UpdateInsightTypeConfigRequest.pb( + recommender_service.UpdateInsightTypeConfigRequest() + ) + 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 = gcr_insight_type_config.InsightTypeConfig.to_json( + gcr_insight_type_config.InsightTypeConfig() + ) + + request = recommender_service.UpdateInsightTypeConfigRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = gcr_insight_type_config.InsightTypeConfig() + + client.update_insight_type_config( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_insight_type_config_rest_bad_request( + transport: str = "rest", + request_type=recommender_service.UpdateInsightTypeConfigRequest, +): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "insight_type_config": { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config" + } + } + request_init["insight_type_config"] = { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config", + "insight_type_generation_config": {"params": {"fields": {}}}, + "etag": "etag_value", + "update_time": {"seconds": 751, "nanos": 543}, + "revision_id": "revision_id_value", + "annotations": {}, + "display_name": "display_name_value", + } + 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_insight_type_config(request) + + +def test_update_insight_type_config_rest_flattened(): + client = RecommenderClient( + 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 = gcr_insight_type_config.InsightTypeConfig() + + # get arguments that satisfy an http rule for this method + sample_request = { + "insight_type_config": { + "name": "projects/sample1/locations/sample2/insightTypes/sample3/config" + } + } + + # get truthy value for each flattened field + mock_args = dict( + insight_type_config=gcr_insight_type_config.InsightTypeConfig( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_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 = gcr_insight_type_config.InsightTypeConfig.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_insight_type_config(**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/v1beta1/{insight_type_config.name=projects/*/locations/*/insightTypes/*/config}" + % client.transport._host, + args[1], + ) + + +def test_update_insight_type_config_rest_flattened_error(transport: str = "rest"): + client = RecommenderClient( + 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_insight_type_config( + recommender_service.UpdateInsightTypeConfigRequest(), + insight_type_config=gcr_insight_type_config.InsightTypeConfig( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_insight_type_config_rest_error(): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecommenderClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = RecommenderClient( + 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 = RecommenderClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = RecommenderClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = RecommenderClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.RecommenderGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.RecommenderGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.RecommenderGrpcTransport, + transports.RecommenderGrpcAsyncIOTransport, + transports.RecommenderRestTransport, + ], +) +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 = RecommenderClient.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 = RecommenderClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.RecommenderGrpcTransport, + ) + + +def test_recommender_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.RecommenderTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_recommender_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.recommender_v1beta1.services.recommender.transports.RecommenderTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.RecommenderTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. methods = ( "list_insights", "get_insight", @@ -4519,6 +8228,7 @@ def test_recommender_transport_auth_adc(transport_class): [ transports.RecommenderGrpcTransport, transports.RecommenderGrpcAsyncIOTransport, + transports.RecommenderRestTransport, ], ) def test_recommender_transport_auth_gdch_credentials(transport_class): @@ -4613,11 +8323,23 @@ def test_recommender_grpc_transport_client_cert_source_for_mtls(transport_class) ) +def test_recommender_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.RecommenderRestTransport( + 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_recommender_host_no_port(transport_name): @@ -4628,7 +8350,11 @@ def test_recommender_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("recommender.googleapis.com:443") + assert client.transport._host == ( + "recommender.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommender.googleapis.com" + ) @pytest.mark.parametrize( @@ -4636,6 +8362,7 @@ def test_recommender_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_recommender_host_with_port(transport_name): @@ -4646,7 +8373,66 @@ def test_recommender_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("recommender.googleapis.com:8000") + assert client.transport._host == ( + "recommender.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommender.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_recommender_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = RecommenderClient( + credentials=creds1, + transport=transport_name, + ) + client2 = RecommenderClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.list_insights._session + session2 = client2.transport.list_insights._session + assert session1 != session2 + session1 = client1.transport.get_insight._session + session2 = client2.transport.get_insight._session + assert session1 != session2 + session1 = client1.transport.mark_insight_accepted._session + session2 = client2.transport.mark_insight_accepted._session + assert session1 != session2 + session1 = client1.transport.list_recommendations._session + session2 = client2.transport.list_recommendations._session + assert session1 != session2 + session1 = client1.transport.get_recommendation._session + session2 = client2.transport.get_recommendation._session + assert session1 != session2 + session1 = client1.transport.mark_recommendation_claimed._session + session2 = client2.transport.mark_recommendation_claimed._session + assert session1 != session2 + session1 = client1.transport.mark_recommendation_succeeded._session + session2 = client2.transport.mark_recommendation_succeeded._session + assert session1 != session2 + session1 = client1.transport.mark_recommendation_failed._session + session2 = client2.transport.mark_recommendation_failed._session + assert session1 != session2 + session1 = client1.transport.get_recommender_config._session + session2 = client2.transport.get_recommender_config._session + assert session1 != session2 + session1 = client1.transport.update_recommender_config._session + session2 = client2.transport.update_recommender_config._session + assert session1 != session2 + session1 = client1.transport.get_insight_type_config._session + session2 = client2.transport.get_insight_type_config._session + assert session1 != session2 + session1 = client1.transport.update_insight_type_config._session + session2 = client2.transport.update_insight_type_config._session + assert session1 != session2 def test_recommender_grpc_transport_channel(): @@ -5077,6 +8863,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -5094,6 +8881,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: