From dd11a439733fbb895f85da647e414591c7f69eb7 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 9 Feb 2023 11:55:18 -0500 Subject: [PATCH] feat: enable "rest" transport in Python for services supporting numeric enums (#264) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: enable "rest" transport in Python for services supporting numeric enums PiperOrigin-RevId: 508143576 Source-Link: https://github.com/googleapis/googleapis/commit/7a702a989db3b413f39ff8994ca53fb38b6928c2 Source-Link: https://github.com/googleapis/googleapis-gen/commit/6ad1279c0e7aa787ac6b66c9fd4a210692edffcd Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNmFkMTI3OWMwZTdhYTc4N2FjNmI2NmM5ZmQ0YTIxMDY5MmVkZmZjZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot --- .../billing/budgets_v1/gapic_metadata.json | 30 + .../services/budget_service/client.py | 2 + .../budget_service/transports/__init__.py | 4 + .../budget_service/transports/rest.py | 820 +++++++ .../gapic/budgets_v1/test_budget_service.py | 1917 +++++++++++++++-- 5 files changed, 2629 insertions(+), 144 deletions(-) create mode 100644 packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/services/budget_service/transports/rest.py diff --git a/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/gapic_metadata.json b/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/gapic_metadata.json index 38bf83784d93..4c3b69415cbe 100644 --- a/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/gapic_metadata.json +++ b/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/gapic_metadata.json @@ -66,6 +66,36 @@ ] } } + }, + "rest": { + "libraryClient": "BudgetServiceClient", + "rpcs": { + "CreateBudget": { + "methods": [ + "create_budget" + ] + }, + "DeleteBudget": { + "methods": [ + "delete_budget" + ] + }, + "GetBudget": { + "methods": [ + "get_budget" + ] + }, + "ListBudgets": { + "methods": [ + "list_budgets" + ] + }, + "UpdateBudget": { + "methods": [ + "update_budget" + ] + } + } } } } diff --git a/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/services/budget_service/client.py b/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/services/budget_service/client.py index 685d25e50f1e..662ce84348a0 100644 --- a/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/services/budget_service/client.py +++ b/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/services/budget_service/client.py @@ -54,6 +54,7 @@ from .transports.base import DEFAULT_CLIENT_INFO, BudgetServiceTransport from .transports.grpc import BudgetServiceGrpcTransport from .transports.grpc_asyncio import BudgetServiceGrpcAsyncIOTransport +from .transports.rest import BudgetServiceRestTransport class BudgetServiceClientMeta(type): @@ -67,6 +68,7 @@ class BudgetServiceClientMeta(type): _transport_registry = OrderedDict() # type: Dict[str, Type[BudgetServiceTransport]] _transport_registry["grpc"] = BudgetServiceGrpcTransport _transport_registry["grpc_asyncio"] = BudgetServiceGrpcAsyncIOTransport + _transport_registry["rest"] = BudgetServiceRestTransport def get_transport_class( cls, diff --git a/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/services/budget_service/transports/__init__.py b/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/services/budget_service/transports/__init__.py index bf859369e38a..a81e8121630d 100644 --- a/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/services/budget_service/transports/__init__.py +++ b/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/services/budget_service/transports/__init__.py @@ -19,14 +19,18 @@ from .base import BudgetServiceTransport from .grpc import BudgetServiceGrpcTransport from .grpc_asyncio import BudgetServiceGrpcAsyncIOTransport +from .rest import BudgetServiceRestInterceptor, BudgetServiceRestTransport # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[BudgetServiceTransport]] _transport_registry["grpc"] = BudgetServiceGrpcTransport _transport_registry["grpc_asyncio"] = BudgetServiceGrpcAsyncIOTransport +_transport_registry["rest"] = BudgetServiceRestTransport __all__ = ( "BudgetServiceTransport", "BudgetServiceGrpcTransport", "BudgetServiceGrpcAsyncIOTransport", + "BudgetServiceRestTransport", + "BudgetServiceRestInterceptor", ) diff --git a/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/services/budget_service/transports/rest.py b/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/services/budget_service/transports/rest.py new file mode 100644 index 000000000000..4f4ddd5b7fe0 --- /dev/null +++ b/packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/services/budget_service/transports/rest.py @@ -0,0 +1,820 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import dataclasses +import json # type: ignore +import re +from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, path_template, rest_helpers, rest_streaming +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore +from google.protobuf import json_format +import grpc # type: ignore +from requests import __version__ as requests_version + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.protobuf import empty_pb2 # type: ignore + +from google.cloud.billing.budgets_v1.types import budget_model, budget_service + +from .base import BudgetServiceTransport +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class BudgetServiceRestInterceptor: + """Interceptor for BudgetService. + + 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 BudgetServiceRestTransport. + + .. code-block:: python + class MyCustomBudgetServiceInterceptor(BudgetServiceRestInterceptor): + def pre_create_budget(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_budget(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_budget(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_budget(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_budget(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_budgets(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_budgets(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_budget(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_budget(self, response): + logging.log(f"Received response: {response}") + return response + + transport = BudgetServiceRestTransport(interceptor=MyCustomBudgetServiceInterceptor()) + client = BudgetServiceClient(transport=transport) + + + """ + + def pre_create_budget( + self, + request: budget_service.CreateBudgetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[budget_service.CreateBudgetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_budget + + Override in a subclass to manipulate the request or metadata + before they are sent to the BudgetService server. + """ + return request, metadata + + def post_create_budget(self, response: budget_model.Budget) -> budget_model.Budget: + """Post-rpc interceptor for create_budget + + Override in a subclass to manipulate the response + after it is returned by the BudgetService server but before + it is returned to user code. + """ + return response + + def pre_delete_budget( + self, + request: budget_service.DeleteBudgetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[budget_service.DeleteBudgetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_budget + + Override in a subclass to manipulate the request or metadata + before they are sent to the BudgetService server. + """ + return request, metadata + + def pre_get_budget( + self, + request: budget_service.GetBudgetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[budget_service.GetBudgetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_budget + + Override in a subclass to manipulate the request or metadata + before they are sent to the BudgetService server. + """ + return request, metadata + + def post_get_budget(self, response: budget_model.Budget) -> budget_model.Budget: + """Post-rpc interceptor for get_budget + + Override in a subclass to manipulate the response + after it is returned by the BudgetService server but before + it is returned to user code. + """ + return response + + def pre_list_budgets( + self, + request: budget_service.ListBudgetsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[budget_service.ListBudgetsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_budgets + + Override in a subclass to manipulate the request or metadata + before they are sent to the BudgetService server. + """ + return request, metadata + + def post_list_budgets( + self, response: budget_service.ListBudgetsResponse + ) -> budget_service.ListBudgetsResponse: + """Post-rpc interceptor for list_budgets + + Override in a subclass to manipulate the response + after it is returned by the BudgetService server but before + it is returned to user code. + """ + return response + + def pre_update_budget( + self, + request: budget_service.UpdateBudgetRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[budget_service.UpdateBudgetRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_budget + + Override in a subclass to manipulate the request or metadata + before they are sent to the BudgetService server. + """ + return request, metadata + + def post_update_budget(self, response: budget_model.Budget) -> budget_model.Budget: + """Post-rpc interceptor for update_budget + + Override in a subclass to manipulate the response + after it is returned by the BudgetService server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class BudgetServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: BudgetServiceRestInterceptor + + +class BudgetServiceRestTransport(BudgetServiceTransport): + """REST backend transport for BudgetService. + + BudgetService stores Cloud Billing budgets, which define a + budget plan and rules to execute as we track spend against that + plan. + + 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 = "billingbudgets.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[BudgetServiceRestInterceptor] = 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 BudgetServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _CreateBudget(BudgetServiceRestStub): + def __hash__(self): + return hash("CreateBudget") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: budget_service.CreateBudgetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> budget_model.Budget: + r"""Call the create budget method over HTTP. + + Args: + request (~.budget_service.CreateBudgetRequest): + The request object. Request for CreateBudget + 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: + ~.budget_model.Budget: + A budget is a plan that describes + what you expect to spend on Cloud + projects, plus the rules to execute as + spend is tracked against that plan, (for + example, send an alert when 90% of the + target spend is met). The budget time + period is configurable, with options + such as month (default), quarter, year, + or custom time period. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=billingAccounts/*}/budgets", + "body": "budget", + }, + ] + request, metadata = self._interceptor.pre_create_budget(request, metadata) + pb_request = budget_service.CreateBudgetRequest.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 = budget_model.Budget() + pb_resp = budget_model.Budget.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_budget(resp) + return resp + + class _DeleteBudget(BudgetServiceRestStub): + def __hash__(self): + return hash("DeleteBudget") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: budget_service.DeleteBudgetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete budget method over HTTP. + + Args: + request (~.budget_service.DeleteBudgetRequest): + The request object. Request for DeleteBudget + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1/{name=billingAccounts/*/budgets/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_budget(request, metadata) + pb_request = budget_service.DeleteBudgetRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetBudget(BudgetServiceRestStub): + def __hash__(self): + return hash("GetBudget") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: budget_service.GetBudgetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> budget_model.Budget: + r"""Call the get budget method over HTTP. + + Args: + request (~.budget_service.GetBudgetRequest): + The request object. Request for GetBudget + 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: + ~.budget_model.Budget: + A budget is a plan that describes + what you expect to spend on Cloud + projects, plus the rules to execute as + spend is tracked against that plan, (for + example, send an alert when 90% of the + target spend is met). The budget time + period is configurable, with options + such as month (default), quarter, year, + or custom time period. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=billingAccounts/*/budgets/*}", + }, + ] + request, metadata = self._interceptor.pre_get_budget(request, metadata) + pb_request = budget_service.GetBudgetRequest.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 = budget_model.Budget() + pb_resp = budget_model.Budget.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_budget(resp) + return resp + + class _ListBudgets(BudgetServiceRestStub): + def __hash__(self): + return hash("ListBudgets") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: budget_service.ListBudgetsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> budget_service.ListBudgetsResponse: + r"""Call the list budgets method over HTTP. + + Args: + request (~.budget_service.ListBudgetsRequest): + The request object. Request for ListBudgets + 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: + ~.budget_service.ListBudgetsResponse: + Response for ListBudgets + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{parent=billingAccounts/*}/budgets", + }, + ] + request, metadata = self._interceptor.pre_list_budgets(request, metadata) + pb_request = budget_service.ListBudgetsRequest.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 = budget_service.ListBudgetsResponse() + pb_resp = budget_service.ListBudgetsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_budgets(resp) + return resp + + class _UpdateBudget(BudgetServiceRestStub): + def __hash__(self): + return hash("UpdateBudget") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: budget_service.UpdateBudgetRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> budget_model.Budget: + r"""Call the update budget method over HTTP. + + Args: + request (~.budget_service.UpdateBudgetRequest): + The request object. Request for UpdateBudget + 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: + ~.budget_model.Budget: + A budget is a plan that describes + what you expect to spend on Cloud + projects, plus the rules to execute as + spend is tracked against that plan, (for + example, send an alert when 90% of the + target spend is met). The budget time + period is configurable, with options + such as month (default), quarter, year, + or custom time period. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1/{budget.name=billingAccounts/*/budgets/*}", + "body": "budget", + }, + ] + request, metadata = self._interceptor.pre_update_budget(request, metadata) + pb_request = budget_service.UpdateBudgetRequest.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 = budget_model.Budget() + pb_resp = budget_model.Budget.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_budget(resp) + return resp + + @property + def create_budget( + self, + ) -> Callable[[budget_service.CreateBudgetRequest], budget_model.Budget]: + # 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._CreateBudget(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_budget( + self, + ) -> Callable[[budget_service.DeleteBudgetRequest], empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteBudget(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_budget( + self, + ) -> Callable[[budget_service.GetBudgetRequest], budget_model.Budget]: + # 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._GetBudget(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_budgets( + self, + ) -> Callable[ + [budget_service.ListBudgetsRequest], budget_service.ListBudgetsResponse + ]: + # 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._ListBudgets(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_budget( + self, + ) -> Callable[[budget_service.UpdateBudgetRequest], budget_model.Budget]: + # 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._UpdateBudget(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("BudgetServiceRestTransport",) diff --git a/packages/google-cloud-billing-budgets/tests/unit/gapic/budgets_v1/test_budget_service.py b/packages/google-cloud-billing-budgets/tests/unit/gapic/budgets_v1/test_budget_service.py index 2d8aa0f1e462..283eae499385 100644 --- a/packages/google-cloud-billing-budgets/tests/unit/gapic/budgets_v1/test_budget_service.py +++ b/packages/google-cloud-billing-budgets/tests/unit/gapic/budgets_v1/test_budget_service.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 @@ -32,6 +34,7 @@ from google.auth.exceptions import MutualTLSChannelError from google.oauth2 import service_account 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.type import date_pb2 # type: ignore from google.type import money_pb2 # type: ignore @@ -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.billing.budgets_v1.services.budget_service import ( BudgetServiceAsyncClient, @@ -99,6 +104,7 @@ def test__get_default_mtls_endpoint(): [ (BudgetServiceClient, "grpc"), (BudgetServiceAsyncClient, "grpc_asyncio"), + (BudgetServiceClient, "rest"), ], ) def test_budget_service_client_from_service_account_info(client_class, transport_name): @@ -112,7 +118,11 @@ def test_budget_service_client_from_service_account_info(client_class, transport assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("billingbudgets.googleapis.com:443") + assert client.transport._host == ( + "billingbudgets.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://billingbudgets.googleapis.com" + ) @pytest.mark.parametrize( @@ -120,6 +130,7 @@ def test_budget_service_client_from_service_account_info(client_class, transport [ (transports.BudgetServiceGrpcTransport, "grpc"), (transports.BudgetServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.BudgetServiceRestTransport, "rest"), ], ) def test_budget_service_client_service_account_always_use_jwt( @@ -145,6 +156,7 @@ def test_budget_service_client_service_account_always_use_jwt( [ (BudgetServiceClient, "grpc"), (BudgetServiceAsyncClient, "grpc_asyncio"), + (BudgetServiceClient, "rest"), ], ) def test_budget_service_client_from_service_account_file(client_class, transport_name): @@ -165,13 +177,18 @@ def test_budget_service_client_from_service_account_file(client_class, transport assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("billingbudgets.googleapis.com:443") + assert client.transport._host == ( + "billingbudgets.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://billingbudgets.googleapis.com" + ) def test_budget_service_client_get_transport_class(): transport = BudgetServiceClient.get_transport_class() available_transports = [ transports.BudgetServiceGrpcTransport, + transports.BudgetServiceRestTransport, ] assert transport in available_transports @@ -188,6 +205,7 @@ def test_budget_service_client_get_transport_class(): transports.BudgetServiceGrpcAsyncIOTransport, "grpc_asyncio", ), + (BudgetServiceClient, transports.BudgetServiceRestTransport, "rest"), ], ) @mock.patch.object( @@ -333,6 +351,8 @@ def test_budget_service_client_client_options( "grpc_asyncio", "false", ), + (BudgetServiceClient, transports.BudgetServiceRestTransport, "rest", "true"), + (BudgetServiceClient, transports.BudgetServiceRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -532,6 +552,7 @@ def test_budget_service_client_get_mtls_endpoint_and_cert_source(client_class): transports.BudgetServiceGrpcAsyncIOTransport, "grpc_asyncio", ), + (BudgetServiceClient, transports.BudgetServiceRestTransport, "rest"), ], ) def test_budget_service_client_client_options_scopes( @@ -572,6 +593,7 @@ def test_budget_service_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (BudgetServiceClient, transports.BudgetServiceRestTransport, "rest", None), ], ) def test_budget_service_client_client_options_credentials_file( @@ -2055,198 +2077,1747 @@ async def test_delete_budget_flattened_error_async(): ) -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.BudgetServiceGrpcTransport( +@pytest.mark.parametrize( + "request_type", + [ + budget_service.CreateBudgetRequest, + dict, + ], +) +def test_create_budget_rest(request_type): + client = BudgetServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - with pytest.raises(ValueError): - client = BudgetServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + + # send a request that will satisfy transcoding + request_init = {"parent": "billingAccounts/sample1"} + request_init["budget"] = { + "name": "name_value", + "display_name": "display_name_value", + "budget_filter": { + "projects": ["projects_value1", "projects_value2"], + "credit_types": ["credit_types_value1", "credit_types_value2"], + "credit_types_treatment": 1, + "services": ["services_value1", "services_value2"], + "subaccounts": ["subaccounts_value1", "subaccounts_value2"], + "labels": {}, + "calendar_period": 1, + "custom_period": { + "start_date": {"year": 433, "month": 550, "day": 318}, + "end_date": {}, + }, + }, + "amount": { + "specified_amount": { + "currency_code": "currency_code_value", + "units": 563, + "nanos": 543, + }, + "last_period_amount": {}, + }, + "threshold_rules": [{"threshold_percent": 0.1821, "spend_basis": 1}], + "notifications_rule": { + "pubsub_topic": "pubsub_topic_value", + "schema_version": "schema_version_value", + "monitoring_notification_channels": [ + "monitoring_notification_channels_value1", + "monitoring_notification_channels_value2", + ], + "disable_default_iam_recipients": True, + }, + "etag": "etag_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 = budget_model.Budget( + name="name_value", + display_name="display_name_value", + etag="etag_value", ) - # It is an error to provide a credentials file and a transport instance. - transport = transports.BudgetServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = BudgetServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = budget_model.Budget.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.create_budget(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, budget_model.Budget) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.etag == "etag_value" + + +def test_create_budget_rest_required_fields( + request_type=budget_service.CreateBudgetRequest, +): + transport_class = transports.BudgetServiceRestTransport + + 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, ) + ) - # It is an error to provide an api_key and a transport instance. - transport = transports.BudgetServiceGrpcTransport( + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_budget._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() + ).create_budget._get_unset_required_fields(jsonified_request) + 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 = BudgetServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = budget_model.Budget() + # 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 = budget_model.Budget.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.create_budget(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_budget_rest_unset_required_fields(): + transport = transports.BudgetServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = BudgetServiceClient( - 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 = BudgetServiceClient( - client_options=options, credentials=ga_credentials.AnonymousCredentials() + unset_fields = transport.create_budget._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "budget", + ) ) + ) - # It is an error to provide scopes and a transport instance. - transport = transports.BudgetServiceGrpcTransport( + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_budget_rest_interceptors(null_interceptor): + transport = transports.BudgetServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.BudgetServiceRestInterceptor(), ) - with pytest.raises(ValueError): - client = BudgetServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, + client = BudgetServiceClient(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.BudgetServiceRestInterceptor, "post_create_budget" + ) as post, mock.patch.object( + transports.BudgetServiceRestInterceptor, "pre_create_budget" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = budget_service.CreateBudgetRequest.pb( + budget_service.CreateBudgetRequest() + ) + 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 = budget_model.Budget.to_json(budget_model.Budget()) + + request = budget_service.CreateBudgetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = budget_model.Budget() + + client.create_budget( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], ) + pre.assert_called_once() + post.assert_called_once() -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.BudgetServiceGrpcTransport( + +def test_create_budget_rest_bad_request( + transport: str = "rest", request_type=budget_service.CreateBudgetRequest +): + client = BudgetServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - client = BudgetServiceClient(transport=transport) - assert client.transport is transport + # send a request that will satisfy transcoding + request_init = {"parent": "billingAccounts/sample1"} + request_init["budget"] = { + "name": "name_value", + "display_name": "display_name_value", + "budget_filter": { + "projects": ["projects_value1", "projects_value2"], + "credit_types": ["credit_types_value1", "credit_types_value2"], + "credit_types_treatment": 1, + "services": ["services_value1", "services_value2"], + "subaccounts": ["subaccounts_value1", "subaccounts_value2"], + "labels": {}, + "calendar_period": 1, + "custom_period": { + "start_date": {"year": 433, "month": 550, "day": 318}, + "end_date": {}, + }, + }, + "amount": { + "specified_amount": { + "currency_code": "currency_code_value", + "units": 563, + "nanos": 543, + }, + "last_period_amount": {}, + }, + "threshold_rules": [{"threshold_percent": 0.1821, "spend_basis": 1}], + "notifications_rule": { + "pubsub_topic": "pubsub_topic_value", + "schema_version": "schema_version_value", + "monitoring_notification_channels": [ + "monitoring_notification_channels_value1", + "monitoring_notification_channels_value2", + ], + "disable_default_iam_recipients": True, + }, + "etag": "etag_value", + } + request = request_type(**request_init) -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.BudgetServiceGrpcTransport( + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_budget(request) + + +def test_create_budget_rest_flattened(): + client = BudgetServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - channel = transport.grpc_channel - assert channel - transport = transports.BudgetServiceGrpcAsyncIOTransport( + # 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 = budget_model.Budget() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "billingAccounts/sample1"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + budget=budget_model.Budget(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 = budget_model.Budget.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.create_budget(**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=billingAccounts/*}/budgets" % client.transport._host, args[1] + ) + + +def test_create_budget_rest_flattened_error(transport: str = "rest"): + client = BudgetServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_budget( + budget_service.CreateBudgetRequest(), + parent="parent_value", + budget=budget_model.Budget(name="name_value"), + ) -@pytest.mark.parametrize( - "transport_class", - [ - transports.BudgetServiceGrpcTransport, - transports.BudgetServiceGrpcAsyncIOTransport, - ], -) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, "default") as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() +def test_create_budget_rest_error(): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) @pytest.mark.parametrize( - "transport_name", + "request_type", [ - "grpc", + budget_service.UpdateBudgetRequest, + dict, ], ) -def test_transport_kind(transport_name): - transport = BudgetServiceClient.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. +def test_update_budget_rest(request_type): client = BudgetServiceClient( credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.BudgetServiceGrpcTransport, + transport="rest", ) + # send a request that will satisfy transcoding + request_init = {"budget": {"name": "billingAccounts/sample1/budgets/sample2"}} + request_init["budget"] = { + "name": "billingAccounts/sample1/budgets/sample2", + "display_name": "display_name_value", + "budget_filter": { + "projects": ["projects_value1", "projects_value2"], + "credit_types": ["credit_types_value1", "credit_types_value2"], + "credit_types_treatment": 1, + "services": ["services_value1", "services_value2"], + "subaccounts": ["subaccounts_value1", "subaccounts_value2"], + "labels": {}, + "calendar_period": 1, + "custom_period": { + "start_date": {"year": 433, "month": 550, "day": 318}, + "end_date": {}, + }, + }, + "amount": { + "specified_amount": { + "currency_code": "currency_code_value", + "units": 563, + "nanos": 543, + }, + "last_period_amount": {}, + }, + "threshold_rules": [{"threshold_percent": 0.1821, "spend_basis": 1}], + "notifications_rule": { + "pubsub_topic": "pubsub_topic_value", + "schema_version": "schema_version_value", + "monitoring_notification_channels": [ + "monitoring_notification_channels_value1", + "monitoring_notification_channels_value2", + ], + "disable_default_iam_recipients": True, + }, + "etag": "etag_value", + } + request = request_type(**request_init) -def test_budget_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.BudgetServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json", + # 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 = budget_model.Budget( + name="name_value", + display_name="display_name_value", + etag="etag_value", ) + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = budget_model.Budget.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) -def test_budget_service_base_transport(): - # Instantiate the base transport. - with mock.patch( - "google.cloud.billing.budgets_v1.services.budget_service.transports.BudgetServiceTransport.__init__" - ) as Transport: - Transport.return_value = None - transport = transports.BudgetServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.update_budget(request) - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - "create_budget", - "update_budget", - "get_budget", - "list_budgets", - "delete_budget", + # Establish that the response is the type that we expect. + assert isinstance(response, budget_model.Budget) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.etag == "etag_value" + + +def test_update_budget_rest_required_fields( + request_type=budget_service.UpdateBudgetRequest, +): + transport_class = transports.BudgetServiceRestTransport + + 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, + ) ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - with pytest.raises(NotImplementedError): - transport.close() + # verify fields with default values are dropped - # Catch all for all remaining methods and properties - remainder = [ - "kind", - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_budget._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + # verify required fields with default values are now present -def test_budget_service_base_transport_with_credentials_file(): - # Instantiate the base transport with a credentials file + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_budget._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",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = budget_model.Budget() + # 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 = budget_model.Budget.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_budget(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_budget_rest_unset_required_fields(): + transport = transports.BudgetServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_budget._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask",)) & set(("budget",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_budget_rest_interceptors(null_interceptor): + transport = transports.BudgetServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.BudgetServiceRestInterceptor(), + ) + client = BudgetServiceClient(transport=transport) with mock.patch.object( - google.auth, "load_credentials_from_file", autospec=True - ) as load_creds, mock.patch( - "google.cloud.billing.budgets_v1.services.budget_service.transports.BudgetServiceTransport._prep_wrapped_messages" - ) as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.BudgetServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.BudgetServiceRestInterceptor, "post_update_budget" + ) as post, mock.patch.object( + transports.BudgetServiceRestInterceptor, "pre_update_budget" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = budget_service.UpdateBudgetRequest.pb( + budget_service.UpdateBudgetRequest() ) - load_creds.assert_called_once_with( - "credentials.json", - scopes=None, - default_scopes=( - "https://www.googleapis.com/auth/cloud-billing", - "https://www.googleapis.com/auth/cloud-platform", - ), - quota_project_id="octopus", + 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 = budget_model.Budget.to_json(budget_model.Budget()) + + request = budget_service.UpdateBudgetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = budget_model.Budget() + + client.update_budget( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], ) + pre.assert_called_once() + post.assert_called_once() -def test_budget_service_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. - with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( - "google.cloud.billing.budgets_v1.services.budget_service.transports.BudgetServiceTransport._prep_wrapped_messages" - ) as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.BudgetServiceTransport() - adc.assert_called_once() + +def test_update_budget_rest_bad_request( + transport: str = "rest", request_type=budget_service.UpdateBudgetRequest +): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"budget": {"name": "billingAccounts/sample1/budgets/sample2"}} + request_init["budget"] = { + "name": "billingAccounts/sample1/budgets/sample2", + "display_name": "display_name_value", + "budget_filter": { + "projects": ["projects_value1", "projects_value2"], + "credit_types": ["credit_types_value1", "credit_types_value2"], + "credit_types_treatment": 1, + "services": ["services_value1", "services_value2"], + "subaccounts": ["subaccounts_value1", "subaccounts_value2"], + "labels": {}, + "calendar_period": 1, + "custom_period": { + "start_date": {"year": 433, "month": 550, "day": 318}, + "end_date": {}, + }, + }, + "amount": { + "specified_amount": { + "currency_code": "currency_code_value", + "units": 563, + "nanos": 543, + }, + "last_period_amount": {}, + }, + "threshold_rules": [{"threshold_percent": 0.1821, "spend_basis": 1}], + "notifications_rule": { + "pubsub_topic": "pubsub_topic_value", + "schema_version": "schema_version_value", + "monitoring_notification_channels": [ + "monitoring_notification_channels_value1", + "monitoring_notification_channels_value2", + ], + "disable_default_iam_recipients": True, + }, + "etag": "etag_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_budget(request) + + +def test_update_budget_rest_flattened(): + client = BudgetServiceClient( + 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 = budget_model.Budget() + + # get arguments that satisfy an http rule for this method + sample_request = {"budget": {"name": "billingAccounts/sample1/budgets/sample2"}} + + # get truthy value for each flattened field + mock_args = dict( + budget=budget_model.Budget(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 = budget_model.Budget.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_budget(**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/{budget.name=billingAccounts/*/budgets/*}" % client.transport._host, + args[1], + ) + + +def test_update_budget_rest_flattened_error(transport: str = "rest"): + client = BudgetServiceClient( + 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_budget( + budget_service.UpdateBudgetRequest(), + budget=budget_model.Budget(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_budget_rest_error(): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + budget_service.GetBudgetRequest, + dict, + ], +) +def test_get_budget_rest(request_type): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "billingAccounts/sample1/budgets/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = budget_model.Budget( + name="name_value", + display_name="display_name_value", + etag="etag_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = budget_model.Budget.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_budget(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, budget_model.Budget) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.etag == "etag_value" + + +def test_get_budget_rest_required_fields(request_type=budget_service.GetBudgetRequest): + transport_class = transports.BudgetServiceRestTransport + + 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_budget._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_budget._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 = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = budget_model.Budget() + # 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 = budget_model.Budget.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_budget(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_budget_rest_unset_required_fields(): + transport = transports.BudgetServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_budget._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_budget_rest_interceptors(null_interceptor): + transport = transports.BudgetServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.BudgetServiceRestInterceptor(), + ) + client = BudgetServiceClient(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.BudgetServiceRestInterceptor, "post_get_budget" + ) as post, mock.patch.object( + transports.BudgetServiceRestInterceptor, "pre_get_budget" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = budget_service.GetBudgetRequest.pb( + budget_service.GetBudgetRequest() + ) + 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 = budget_model.Budget.to_json(budget_model.Budget()) + + request = budget_service.GetBudgetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = budget_model.Budget() + + client.get_budget( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_budget_rest_bad_request( + transport: str = "rest", request_type=budget_service.GetBudgetRequest +): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "billingAccounts/sample1/budgets/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_budget(request) + + +def test_get_budget_rest_flattened(): + client = BudgetServiceClient( + 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 = budget_model.Budget() + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "billingAccounts/sample1/budgets/sample2"} + + # 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 = budget_model.Budget.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_budget(**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=billingAccounts/*/budgets/*}" % client.transport._host, args[1] + ) + + +def test_get_budget_rest_flattened_error(transport: str = "rest"): + client = BudgetServiceClient( + 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_budget( + budget_service.GetBudgetRequest(), + name="name_value", + ) + + +def test_get_budget_rest_error(): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + budget_service.ListBudgetsRequest, + dict, + ], +) +def test_list_budgets_rest(request_type): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "billingAccounts/sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = budget_service.ListBudgetsResponse( + 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 = budget_service.ListBudgetsResponse.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_budgets(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListBudgetsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_budgets_rest_required_fields( + request_type=budget_service.ListBudgetsRequest, +): + transport_class = transports.BudgetServiceRestTransport + + 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_budgets._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_budgets._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "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 = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = budget_service.ListBudgetsResponse() + # 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 = budget_service.ListBudgetsResponse.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_budgets(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_budgets_rest_unset_required_fields(): + transport = transports.BudgetServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_budgets._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_budgets_rest_interceptors(null_interceptor): + transport = transports.BudgetServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.BudgetServiceRestInterceptor(), + ) + client = BudgetServiceClient(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.BudgetServiceRestInterceptor, "post_list_budgets" + ) as post, mock.patch.object( + transports.BudgetServiceRestInterceptor, "pre_list_budgets" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = budget_service.ListBudgetsRequest.pb( + budget_service.ListBudgetsRequest() + ) + 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 = budget_service.ListBudgetsResponse.to_json( + budget_service.ListBudgetsResponse() + ) + + request = budget_service.ListBudgetsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = budget_service.ListBudgetsResponse() + + client.list_budgets( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_budgets_rest_bad_request( + transport: str = "rest", request_type=budget_service.ListBudgetsRequest +): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "billingAccounts/sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_budgets(request) + + +def test_list_budgets_rest_flattened(): + client = BudgetServiceClient( + 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 = budget_service.ListBudgetsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "billingAccounts/sample1"} + + # 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 = budget_service.ListBudgetsResponse.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_budgets(**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=billingAccounts/*}/budgets" % client.transport._host, args[1] + ) + + +def test_list_budgets_rest_flattened_error(transport: str = "rest"): + client = BudgetServiceClient( + 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_budgets( + budget_service.ListBudgetsRequest(), + parent="parent_value", + ) + + +def test_list_budgets_rest_pager(transport: str = "rest"): + client = BudgetServiceClient( + 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 = ( + budget_service.ListBudgetsResponse( + budgets=[ + budget_model.Budget(), + budget_model.Budget(), + budget_model.Budget(), + ], + next_page_token="abc", + ), + budget_service.ListBudgetsResponse( + budgets=[], + next_page_token="def", + ), + budget_service.ListBudgetsResponse( + budgets=[ + budget_model.Budget(), + ], + next_page_token="ghi", + ), + budget_service.ListBudgetsResponse( + budgets=[ + budget_model.Budget(), + budget_model.Budget(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + budget_service.ListBudgetsResponse.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": "billingAccounts/sample1"} + + pager = client.list_budgets(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, budget_model.Budget) for i in results) + + pages = list(client.list_budgets(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", + [ + budget_service.DeleteBudgetRequest, + dict, + ], +) +def test_delete_budget_rest(request_type): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "billingAccounts/sample1/budgets/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_budget(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_budget_rest_required_fields( + request_type=budget_service.DeleteBudgetRequest, +): + transport_class = transports.BudgetServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_budget._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_budget._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 = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_budget(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_budget_rest_unset_required_fields(): + transport = transports.BudgetServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_budget._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_budget_rest_interceptors(null_interceptor): + transport = transports.BudgetServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.BudgetServiceRestInterceptor(), + ) + client = BudgetServiceClient(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.BudgetServiceRestInterceptor, "pre_delete_budget" + ) as pre: + pre.assert_not_called() + pb_message = budget_service.DeleteBudgetRequest.pb( + budget_service.DeleteBudgetRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = budget_service.DeleteBudgetRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_budget( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_budget_rest_bad_request( + transport: str = "rest", request_type=budget_service.DeleteBudgetRequest +): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "billingAccounts/sample1/budgets/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_budget(request) + + +def test_delete_budget_rest_flattened(): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "billingAccounts/sample1/budgets/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_budget(**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=billingAccounts/*/budgets/*}" % client.transport._host, args[1] + ) + + +def test_delete_budget_rest_flattened_error(transport: str = "rest"): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_budget( + budget_service.DeleteBudgetRequest(), + name="name_value", + ) + + +def test_delete_budget_rest_error(): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.BudgetServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.BudgetServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = BudgetServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.BudgetServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = BudgetServiceClient( + 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 = BudgetServiceClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.BudgetServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = BudgetServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.BudgetServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = BudgetServiceClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.BudgetServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.BudgetServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.BudgetServiceGrpcTransport, + transports.BudgetServiceGrpcAsyncIOTransport, + transports.BudgetServiceRestTransport, + ], +) +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 = BudgetServiceClient.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 = BudgetServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.BudgetServiceGrpcTransport, + ) + + +def test_budget_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.BudgetServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_budget_service_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.billing.budgets_v1.services.budget_service.transports.BudgetServiceTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.BudgetServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "create_budget", + "update_budget", + "get_budget", + "list_budgets", + "delete_budget", + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_budget_service_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.cloud.billing.budgets_v1.services.budget_service.transports.BudgetServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.BudgetServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=( + "https://www.googleapis.com/auth/cloud-billing", + "https://www.googleapis.com/auth/cloud-platform", + ), + quota_project_id="octopus", + ) + + +def test_budget_service_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( + "google.cloud.billing.budgets_v1.services.budget_service.transports.BudgetServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.BudgetServiceTransport() + adc.assert_called_once() def test_budget_service_auth_adc(): @@ -2292,6 +3863,7 @@ def test_budget_service_transport_auth_adc(transport_class): [ transports.BudgetServiceGrpcTransport, transports.BudgetServiceGrpcAsyncIOTransport, + transports.BudgetServiceRestTransport, ], ) def test_budget_service_transport_auth_gdch_credentials(transport_class): @@ -2392,11 +3964,23 @@ def test_budget_service_grpc_transport_client_cert_source_for_mtls(transport_cla ) +def test_budget_service_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.BudgetServiceRestTransport( + 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_budget_service_host_no_port(transport_name): @@ -2407,7 +3991,11 @@ def test_budget_service_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("billingbudgets.googleapis.com:443") + assert client.transport._host == ( + "billingbudgets.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://billingbudgets.googleapis.com" + ) @pytest.mark.parametrize( @@ -2415,6 +4003,7 @@ def test_budget_service_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_budget_service_host_with_port(transport_name): @@ -2425,7 +4014,45 @@ def test_budget_service_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("billingbudgets.googleapis.com:8000") + assert client.transport._host == ( + "billingbudgets.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://billingbudgets.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_budget_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = BudgetServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = BudgetServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_budget._session + session2 = client2.transport.create_budget._session + assert session1 != session2 + session1 = client1.transport.update_budget._session + session2 = client2.transport.update_budget._session + assert session1 != session2 + session1 = client1.transport.get_budget._session + session2 = client2.transport.get_budget._session + assert session1 != session2 + session1 = client1.transport.list_budgets._session + session2 = client2.transport.list_budgets._session + assert session1 != session2 + session1 = client1.transport.delete_budget._session + session2 = client2.transport.delete_budget._session + assert session1 != session2 def test_budget_service_grpc_transport_channel(): @@ -2717,6 +4344,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -2734,6 +4362,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: