diff --git a/.coveragerc b/.coveragerc index 245b9ab8..75633d09 100644 --- a/.coveragerc +++ b/.coveragerc @@ -5,6 +5,7 @@ branch = True show_missing = True omit = google/cloud/iot/__init__.py + google/cloud/iot/gapic_version.py exclude_lines = # Re-enable the standard pragma pragma: NO COVER diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml index 889f77df..5fc5daa3 100644 --- a/.github/.OwlBot.lock.yaml +++ b/.github/.OwlBot.lock.yaml @@ -13,4 +13,4 @@ # limitations under the License. docker: image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest - digest: sha256:c43f1d918bcf817d337aa29ff833439494a158a0831508fda4ec75dc4c0d0320 + digest: sha256:8555f0e37e6261408f792bfd6635102d2da5ad73f8f09bcb24f25e6afb5fac97 diff --git a/.kokoro/requirements.in b/.kokoro/requirements.in index cbd7e77f..882178ce 100644 --- a/.kokoro/requirements.in +++ b/.kokoro/requirements.in @@ -1,5 +1,5 @@ gcp-docuploader -gcp-releasetool +gcp-releasetool>=1.10.5 # required for compatibility with cryptography>=39.x importlib-metadata typing-extensions twine diff --git a/.kokoro/requirements.txt b/.kokoro/requirements.txt index 05dc4672..fa99c129 100644 --- a/.kokoro/requirements.txt +++ b/.kokoro/requirements.txt @@ -113,33 +113,28 @@ commonmark==0.9.1 \ --hash=sha256:452f9dc859be7f06631ddcb328b6919c67984aca654e5fefb3914d54691aed60 \ --hash=sha256:da2f38c92590f83de410ba1a3cbceafbc74fee9def35f9251ba9a971d6d66fd9 # via rich -cryptography==38.0.3 \ - --hash=sha256:068147f32fa662c81aebab95c74679b401b12b57494872886eb5c1139250ec5d \ - --hash=sha256:06fc3cc7b6f6cca87bd56ec80a580c88f1da5306f505876a71c8cfa7050257dd \ - --hash=sha256:25c1d1f19729fb09d42e06b4bf9895212292cb27bb50229f5aa64d039ab29146 \ - --hash=sha256:402852a0aea73833d982cabb6d0c3bb582c15483d29fb7085ef2c42bfa7e38d7 \ - --hash=sha256:4e269dcd9b102c5a3d72be3c45d8ce20377b8076a43cbed6f660a1afe365e436 \ - --hash=sha256:5419a127426084933076132d317911e3c6eb77568a1ce23c3ac1e12d111e61e0 \ - --hash=sha256:554bec92ee7d1e9d10ded2f7e92a5d70c1f74ba9524947c0ba0c850c7b011828 \ - --hash=sha256:5e89468fbd2fcd733b5899333bc54d0d06c80e04cd23d8c6f3e0542358c6060b \ - --hash=sha256:65535bc550b70bd6271984d9863a37741352b4aad6fb1b3344a54e6950249b55 \ - --hash=sha256:6ab9516b85bebe7aa83f309bacc5f44a61eeb90d0b4ec125d2d003ce41932d36 \ - --hash=sha256:6addc3b6d593cd980989261dc1cce38263c76954d758c3c94de51f1e010c9a50 \ - --hash=sha256:728f2694fa743a996d7784a6194da430f197d5c58e2f4e278612b359f455e4a2 \ - --hash=sha256:785e4056b5a8b28f05a533fab69febf5004458e20dad7e2e13a3120d8ecec75a \ - --hash=sha256:78cf5eefac2b52c10398a42765bfa981ce2372cbc0457e6bf9658f41ec3c41d8 \ - --hash=sha256:7f836217000342d448e1c9a342e9163149e45d5b5eca76a30e84503a5a96cab0 \ - --hash=sha256:8d41a46251bf0634e21fac50ffd643216ccecfaf3701a063257fe0b2be1b6548 \ - --hash=sha256:984fe150f350a3c91e84de405fe49e688aa6092b3525f407a18b9646f6612320 \ - --hash=sha256:9b24bcff7853ed18a63cfb0c2b008936a9554af24af2fb146e16d8e1aed75748 \ - --hash=sha256:b1b35d9d3a65542ed2e9d90115dfd16bbc027b3f07ee3304fc83580f26e43249 \ - --hash=sha256:b1b52c9e5f8aa2b802d48bd693190341fae201ea51c7a167d69fc48b60e8a959 \ - --hash=sha256:bbf203f1a814007ce24bd4d51362991d5cb90ba0c177a9c08825f2cc304d871f \ - --hash=sha256:be243c7e2bfcf6cc4cb350c0d5cdf15ca6383bbcb2a8ef51d3c9411a9d4386f0 \ - --hash=sha256:bfbe6ee19615b07a98b1d2287d6a6073f734735b49ee45b11324d85efc4d5cbd \ - --hash=sha256:c46837ea467ed1efea562bbeb543994c2d1f6e800785bd5a2c98bc096f5cb220 \ - --hash=sha256:dfb4f4dd568de1b6af9f4cda334adf7d72cf5bc052516e1b2608b683375dd95c \ - --hash=sha256:ed7b00096790213e09eb11c97cc6e2b757f15f3d2f85833cd2d3ec3fe37c1722 +cryptography==39.0.1 \ + --hash=sha256:0f8da300b5c8af9f98111ffd512910bc792b4c77392a9523624680f7956a99d4 \ + --hash=sha256:35f7c7d015d474f4011e859e93e789c87d21f6f4880ebdc29896a60403328f1f \ + --hash=sha256:5aa67414fcdfa22cf052e640cb5ddc461924a045cacf325cd164e65312d99502 \ + --hash=sha256:5d2d8b87a490bfcd407ed9d49093793d0f75198a35e6eb1a923ce1ee86c62b41 \ + --hash=sha256:6687ef6d0a6497e2b58e7c5b852b53f62142cfa7cd1555795758934da363a965 \ + --hash=sha256:6f8ba7f0328b79f08bdacc3e4e66fb4d7aab0c3584e0bd41328dce5262e26b2e \ + --hash=sha256:706843b48f9a3f9b9911979761c91541e3d90db1ca905fd63fee540a217698bc \ + --hash=sha256:807ce09d4434881ca3a7594733669bd834f5b2c6d5c7e36f8c00f691887042ad \ + --hash=sha256:83e17b26de248c33f3acffb922748151d71827d6021d98c70e6c1a25ddd78505 \ + --hash=sha256:96f1157a7c08b5b189b16b47bc9db2332269d6680a196341bf30046330d15388 \ + --hash=sha256:aec5a6c9864be7df2240c382740fcf3b96928c46604eaa7f3091f58b878c0bb6 \ + --hash=sha256:b0afd054cd42f3d213bf82c629efb1ee5f22eba35bf0eec88ea9ea7304f511a2 \ + --hash=sha256:ced4e447ae29ca194449a3f1ce132ded8fcab06971ef5f618605aacaa612beac \ + --hash=sha256:d1f6198ee6d9148405e49887803907fe8962a23e6c6f83ea7d98f1c0de375695 \ + --hash=sha256:e124352fd3db36a9d4a21c1aa27fd5d051e621845cb87fb851c08f4f75ce8be6 \ + --hash=sha256:e422abdec8b5fa8462aa016786680720d78bdce7a30c652b7fadf83a4ba35336 \ + --hash=sha256:ef8b72fa70b348724ff1218267e7f7375b8de4e8194d1636ee60510aae104cd0 \ + --hash=sha256:f0c64d1bd842ca2633e74a1a28033d139368ad959872533b1bab8c80e8240a0c \ + --hash=sha256:f24077a3b5298a5a06a8e0536e3ea9ec60e4c7ac486755e5fb6e6ea9b3500106 \ + --hash=sha256:fdd188c8a6ef8769f148f88f859884507b954cc64db6b52f66ef199bb9ad660a \ + --hash=sha256:fe913f20024eb2cb2f323e42a64bdf2911bb9738a15dba7d3cce48151034e3a8 # via # gcp-releasetool # secretstorage @@ -159,9 +154,9 @@ gcp-docuploader==0.6.4 \ --hash=sha256:01486419e24633af78fd0167db74a2763974765ee8078ca6eb6964d0ebd388af \ --hash=sha256:70861190c123d907b3b067da896265ead2eeb9263969d6955c9e0bb091b5ccbf # via -r requirements.in -gcp-releasetool==1.10.0 \ - --hash=sha256:72a38ca91b59c24f7e699e9227c90cbe4dd71b789383cb0164b088abae294c83 \ - --hash=sha256:8c7c99320208383d4bb2b808c6880eb7a81424afe7cdba3c8d84b25f4f0e097d +gcp-releasetool==1.10.5 \ + --hash=sha256:174b7b102d704b254f2a26a3eda2c684fd3543320ec239baf771542a2e58e109 \ + --hash=sha256:e29d29927fe2ca493105a82958c6873bb2b90d503acac56be2c229e74de0eec9 # via -r requirements.in google-api-core==2.10.2 \ --hash=sha256:10c06f7739fe57781f87523375e8e1a3a4674bf6392cd6131a3222182b971320 \ diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 10d53e3a..a3906fc0 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "2.8.1" + ".": "2.9.0" } diff --git a/CHANGELOG.md b/CHANGELOG.md index 31ebb993..cf39bad2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,13 @@ [1]: https://pypi.org/project/google-cloud-iot/#history +## [2.9.0](https://github.com/googleapis/python-iot/compare/v2.8.1...v2.9.0) (2023-02-28) + + +### Features + +* Enable "rest" transport in Python for services supporting numeric enums ([15758ae](https://github.com/googleapis/python-iot/commit/15758aea9839cc5e7509c17ba3f9cb4f98271b20)) + ## [2.8.1](https://github.com/googleapis/python-iot/compare/v2.8.0...v2.8.1) (2023-01-20) diff --git a/google/cloud/iot/gapic_version.py b/google/cloud/iot/gapic_version.py index 15e84ffd..60aeb18d 100644 --- a/google/cloud/iot/gapic_version.py +++ b/google/cloud/iot/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "2.8.1" # {x-release-please-version} +__version__ = "2.9.0" # {x-release-please-version} diff --git a/google/cloud/iot_v1/__init__.py b/google/cloud/iot_v1/__init__.py index a00b9b27..f7d977d2 100644 --- a/google/cloud/iot_v1/__init__.py +++ b/google/cloud/iot_v1/__init__.py @@ -13,7 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -from google.cloud.iot import gapic_version as package_version +from google.cloud.iot_v1 import gapic_version as package_version __version__ = package_version.__version__ diff --git a/google/cloud/iot_v1/gapic_metadata.json b/google/cloud/iot_v1/gapic_metadata.json index 31779910..b06b7059 100644 --- a/google/cloud/iot_v1/gapic_metadata.json +++ b/google/cloud/iot_v1/gapic_metadata.json @@ -206,6 +206,106 @@ ] } } + }, + "rest": { + "libraryClient": "DeviceManagerClient", + "rpcs": { + "BindDeviceToGateway": { + "methods": [ + "bind_device_to_gateway" + ] + }, + "CreateDevice": { + "methods": [ + "create_device" + ] + }, + "CreateDeviceRegistry": { + "methods": [ + "create_device_registry" + ] + }, + "DeleteDevice": { + "methods": [ + "delete_device" + ] + }, + "DeleteDeviceRegistry": { + "methods": [ + "delete_device_registry" + ] + }, + "GetDevice": { + "methods": [ + "get_device" + ] + }, + "GetDeviceRegistry": { + "methods": [ + "get_device_registry" + ] + }, + "GetIamPolicy": { + "methods": [ + "get_iam_policy" + ] + }, + "ListDeviceConfigVersions": { + "methods": [ + "list_device_config_versions" + ] + }, + "ListDeviceRegistries": { + "methods": [ + "list_device_registries" + ] + }, + "ListDeviceStates": { + "methods": [ + "list_device_states" + ] + }, + "ListDevices": { + "methods": [ + "list_devices" + ] + }, + "ModifyCloudToDeviceConfig": { + "methods": [ + "modify_cloud_to_device_config" + ] + }, + "SendCommandToDevice": { + "methods": [ + "send_command_to_device" + ] + }, + "SetIamPolicy": { + "methods": [ + "set_iam_policy" + ] + }, + "TestIamPermissions": { + "methods": [ + "test_iam_permissions" + ] + }, + "UnbindDeviceFromGateway": { + "methods": [ + "unbind_device_from_gateway" + ] + }, + "UpdateDevice": { + "methods": [ + "update_device" + ] + }, + "UpdateDeviceRegistry": { + "methods": [ + "update_device_registry" + ] + } + } } } } diff --git a/google/cloud/iot_v1/gapic_version.py b/google/cloud/iot_v1/gapic_version.py index 15e84ffd..60aeb18d 100644 --- a/google/cloud/iot_v1/gapic_version.py +++ b/google/cloud/iot_v1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "2.8.1" # {x-release-please-version} +__version__ = "2.9.0" # {x-release-please-version} diff --git a/google/cloud/iot_v1/services/device_manager/client.py b/google/cloud/iot_v1/services/device_manager/client.py index a6705f60..5c9769ff 100644 --- a/google/cloud/iot_v1/services/device_manager/client.py +++ b/google/cloud/iot_v1/services/device_manager/client.py @@ -58,6 +58,7 @@ from .transports.base import DEFAULT_CLIENT_INFO, DeviceManagerTransport from .transports.grpc import DeviceManagerGrpcTransport from .transports.grpc_asyncio import DeviceManagerGrpcAsyncIOTransport +from .transports.rest import DeviceManagerRestTransport class DeviceManagerClientMeta(type): @@ -71,6 +72,7 @@ class DeviceManagerClientMeta(type): _transport_registry = OrderedDict() # type: Dict[str, Type[DeviceManagerTransport]] _transport_registry["grpc"] = DeviceManagerGrpcTransport _transport_registry["grpc_asyncio"] = DeviceManagerGrpcAsyncIOTransport + _transport_registry["rest"] = DeviceManagerRestTransport def get_transport_class( cls, diff --git a/google/cloud/iot_v1/services/device_manager/transports/__init__.py b/google/cloud/iot_v1/services/device_manager/transports/__init__.py index 897cc068..ff78b8c0 100644 --- a/google/cloud/iot_v1/services/device_manager/transports/__init__.py +++ b/google/cloud/iot_v1/services/device_manager/transports/__init__.py @@ -19,14 +19,18 @@ from .base import DeviceManagerTransport from .grpc import DeviceManagerGrpcTransport from .grpc_asyncio import DeviceManagerGrpcAsyncIOTransport +from .rest import DeviceManagerRestInterceptor, DeviceManagerRestTransport # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[DeviceManagerTransport]] _transport_registry["grpc"] = DeviceManagerGrpcTransport _transport_registry["grpc_asyncio"] = DeviceManagerGrpcAsyncIOTransport +_transport_registry["rest"] = DeviceManagerRestTransport __all__ = ( "DeviceManagerTransport", "DeviceManagerGrpcTransport", "DeviceManagerGrpcAsyncIOTransport", + "DeviceManagerRestTransport", + "DeviceManagerRestInterceptor", ) diff --git a/google/cloud/iot_v1/services/device_manager/transports/rest.py b/google/cloud/iot_v1/services/device_manager/transports/rest.py new file mode 100644 index 00000000..fb28d2db --- /dev/null +++ b/google/cloud/iot_v1/services/device_manager/transports/rest.py @@ -0,0 +1,2864 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import dataclasses +import json # type: ignore +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, path_template, rest_helpers, rest_streaming +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore +from google.protobuf import json_format +import grpc # type: ignore +from requests import __version__ as requests_version + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.iam.v1 import iam_policy_pb2 # type: ignore +from google.iam.v1 import policy_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore + +from google.cloud.iot_v1.types import device_manager, resources + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .base import DeviceManagerTransport + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class DeviceManagerRestInterceptor: + """Interceptor for DeviceManager. + + 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 DeviceManagerRestTransport. + + .. code-block:: python + class MyCustomDeviceManagerInterceptor(DeviceManagerRestInterceptor): + def pre_bind_device_to_gateway(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_bind_device_to_gateway(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_device(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_device(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_device_registry(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_device_registry(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_device(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_device_registry(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_device(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_device(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_device_registry(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_device_registry(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_iam_policy(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_iam_policy(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_device_config_versions(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_device_config_versions(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_device_registries(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_device_registries(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_devices(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_devices(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_device_states(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_device_states(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_modify_cloud_to_device_config(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_modify_cloud_to_device_config(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_send_command_to_device(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_send_command_to_device(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_set_iam_policy(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_set_iam_policy(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_test_iam_permissions(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_test_iam_permissions(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_unbind_device_from_gateway(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_unbind_device_from_gateway(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_device(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_device(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_device_registry(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_device_registry(self, response): + logging.log(f"Received response: {response}") + return response + + transport = DeviceManagerRestTransport(interceptor=MyCustomDeviceManagerInterceptor()) + client = DeviceManagerClient(transport=transport) + + + """ + + def pre_bind_device_to_gateway( + self, + request: device_manager.BindDeviceToGatewayRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.BindDeviceToGatewayRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for bind_device_to_gateway + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_bind_device_to_gateway( + self, response: device_manager.BindDeviceToGatewayResponse + ) -> device_manager.BindDeviceToGatewayResponse: + """Post-rpc interceptor for bind_device_to_gateway + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_create_device( + self, + request: device_manager.CreateDeviceRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.CreateDeviceRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_device + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_create_device(self, response: resources.Device) -> resources.Device: + """Post-rpc interceptor for create_device + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_create_device_registry( + self, + request: device_manager.CreateDeviceRegistryRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.CreateDeviceRegistryRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_device_registry + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_create_device_registry( + self, response: resources.DeviceRegistry + ) -> resources.DeviceRegistry: + """Post-rpc interceptor for create_device_registry + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_delete_device( + self, + request: device_manager.DeleteDeviceRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.DeleteDeviceRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_device + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def pre_delete_device_registry( + self, + request: device_manager.DeleteDeviceRegistryRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.DeleteDeviceRegistryRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_device_registry + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def pre_get_device( + self, + request: device_manager.GetDeviceRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.GetDeviceRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_device + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_get_device(self, response: resources.Device) -> resources.Device: + """Post-rpc interceptor for get_device + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_get_device_registry( + self, + request: device_manager.GetDeviceRegistryRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.GetDeviceRegistryRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_device_registry + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_get_device_registry( + self, response: resources.DeviceRegistry + ) -> resources.DeviceRegistry: + """Post-rpc interceptor for get_device_registry + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_get_iam_policy( + self, + request: iam_policy_pb2.GetIamPolicyRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[iam_policy_pb2.GetIamPolicyRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_iam_policy + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_get_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: + """Post-rpc interceptor for get_iam_policy + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_list_device_config_versions( + self, + request: device_manager.ListDeviceConfigVersionsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + device_manager.ListDeviceConfigVersionsRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for list_device_config_versions + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_list_device_config_versions( + self, response: device_manager.ListDeviceConfigVersionsResponse + ) -> device_manager.ListDeviceConfigVersionsResponse: + """Post-rpc interceptor for list_device_config_versions + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_list_device_registries( + self, + request: device_manager.ListDeviceRegistriesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.ListDeviceRegistriesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_device_registries + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_list_device_registries( + self, response: device_manager.ListDeviceRegistriesResponse + ) -> device_manager.ListDeviceRegistriesResponse: + """Post-rpc interceptor for list_device_registries + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_list_devices( + self, + request: device_manager.ListDevicesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.ListDevicesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_devices + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_list_devices( + self, response: device_manager.ListDevicesResponse + ) -> device_manager.ListDevicesResponse: + """Post-rpc interceptor for list_devices + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_list_device_states( + self, + request: device_manager.ListDeviceStatesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.ListDeviceStatesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_device_states + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_list_device_states( + self, response: device_manager.ListDeviceStatesResponse + ) -> device_manager.ListDeviceStatesResponse: + """Post-rpc interceptor for list_device_states + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_modify_cloud_to_device_config( + self, + request: device_manager.ModifyCloudToDeviceConfigRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + device_manager.ModifyCloudToDeviceConfigRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for modify_cloud_to_device_config + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_modify_cloud_to_device_config( + self, response: resources.DeviceConfig + ) -> resources.DeviceConfig: + """Post-rpc interceptor for modify_cloud_to_device_config + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_send_command_to_device( + self, + request: device_manager.SendCommandToDeviceRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.SendCommandToDeviceRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for send_command_to_device + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_send_command_to_device( + self, response: device_manager.SendCommandToDeviceResponse + ) -> device_manager.SendCommandToDeviceResponse: + """Post-rpc interceptor for send_command_to_device + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_set_iam_policy( + self, + request: iam_policy_pb2.SetIamPolicyRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[iam_policy_pb2.SetIamPolicyRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for set_iam_policy + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_set_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: + """Post-rpc interceptor for set_iam_policy + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_test_iam_permissions( + self, + request: iam_policy_pb2.TestIamPermissionsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[iam_policy_pb2.TestIamPermissionsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for test_iam_permissions + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_test_iam_permissions( + self, response: iam_policy_pb2.TestIamPermissionsResponse + ) -> iam_policy_pb2.TestIamPermissionsResponse: + """Post-rpc interceptor for test_iam_permissions + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_unbind_device_from_gateway( + self, + request: device_manager.UnbindDeviceFromGatewayRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + device_manager.UnbindDeviceFromGatewayRequest, Sequence[Tuple[str, str]] + ]: + """Pre-rpc interceptor for unbind_device_from_gateway + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_unbind_device_from_gateway( + self, response: device_manager.UnbindDeviceFromGatewayResponse + ) -> device_manager.UnbindDeviceFromGatewayResponse: + """Post-rpc interceptor for unbind_device_from_gateway + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_update_device( + self, + request: device_manager.UpdateDeviceRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.UpdateDeviceRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_device + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_update_device(self, response: resources.Device) -> resources.Device: + """Post-rpc interceptor for update_device + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + def pre_update_device_registry( + self, + request: device_manager.UpdateDeviceRegistryRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[device_manager.UpdateDeviceRegistryRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_device_registry + + Override in a subclass to manipulate the request or metadata + before they are sent to the DeviceManager server. + """ + return request, metadata + + def post_update_device_registry( + self, response: resources.DeviceRegistry + ) -> resources.DeviceRegistry: + """Post-rpc interceptor for update_device_registry + + Override in a subclass to manipulate the response + after it is returned by the DeviceManager server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class DeviceManagerRestStub: + _session: AuthorizedSession + _host: str + _interceptor: DeviceManagerRestInterceptor + + +class DeviceManagerRestTransport(DeviceManagerTransport): + """REST backend transport for DeviceManager. + + Internet of Things (IoT) service. Securely connect and manage + IoT devices. + + 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 = "cloudiot.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[DeviceManagerRestInterceptor] = 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 DeviceManagerRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _BindDeviceToGateway(DeviceManagerRestStub): + def __hash__(self): + return hash("BindDeviceToGateway") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.BindDeviceToGatewayRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> device_manager.BindDeviceToGatewayResponse: + r"""Call the bind device to gateway method over HTTP. + + Args: + request (~.device_manager.BindDeviceToGatewayRequest): + The request object. Request for ``BindDeviceToGateway``. + 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: + ~.device_manager.BindDeviceToGatewayResponse: + Response for ``BindDeviceToGateway``. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*/registries/*}:bindDeviceToGateway", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*/registries/*/groups/*}:bindDeviceToGateway", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_bind_device_to_gateway( + request, metadata + ) + pb_request = device_manager.BindDeviceToGatewayRequest.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 = device_manager.BindDeviceToGatewayResponse() + pb_resp = device_manager.BindDeviceToGatewayResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_bind_device_to_gateway(resp) + return resp + + class _CreateDevice(DeviceManagerRestStub): + def __hash__(self): + return hash("CreateDevice") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.CreateDeviceRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.Device: + r"""Call the create device method over HTTP. + + Args: + request (~.device_manager.CreateDeviceRequest): + The request object. Request for ``CreateDevice``. + 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: + ~.resources.Device: + The device resource. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*/registries/*}/devices", + "body": "device", + }, + ] + request, metadata = self._interceptor.pre_create_device(request, metadata) + pb_request = device_manager.CreateDeviceRequest.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 = resources.Device() + pb_resp = resources.Device.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_device(resp) + return resp + + class _CreateDeviceRegistry(DeviceManagerRestStub): + def __hash__(self): + return hash("CreateDeviceRegistry") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.CreateDeviceRegistryRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.DeviceRegistry: + r"""Call the create device registry method over HTTP. + + Args: + request (~.device_manager.CreateDeviceRegistryRequest): + The request object. Request for ``CreateDeviceRegistry``. + 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: + ~.resources.DeviceRegistry: + A container for a group of devices. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*}/registries", + "body": "device_registry", + }, + ] + request, metadata = self._interceptor.pre_create_device_registry( + request, metadata + ) + pb_request = device_manager.CreateDeviceRegistryRequest.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 = resources.DeviceRegistry() + pb_resp = resources.DeviceRegistry.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_device_registry(resp) + return resp + + class _DeleteDevice(DeviceManagerRestStub): + def __hash__(self): + return hash("DeleteDevice") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.DeleteDeviceRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete device method over HTTP. + + Args: + request (~.device_manager.DeleteDeviceRequest): + The request object. Request for ``DeleteDevice``. + 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=projects/*/locations/*/registries/*/devices/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_device(request, metadata) + pb_request = device_manager.DeleteDeviceRequest.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 _DeleteDeviceRegistry(DeviceManagerRestStub): + def __hash__(self): + return hash("DeleteDeviceRegistry") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.DeleteDeviceRegistryRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete device registry method over HTTP. + + Args: + request (~.device_manager.DeleteDeviceRegistryRequest): + The request object. Request for ``DeleteDeviceRegistry``. + 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=projects/*/locations/*/registries/*}", + }, + ] + request, metadata = self._interceptor.pre_delete_device_registry( + request, metadata + ) + pb_request = device_manager.DeleteDeviceRegistryRequest.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 _GetDevice(DeviceManagerRestStub): + def __hash__(self): + return hash("GetDevice") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.GetDeviceRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.Device: + r"""Call the get device method over HTTP. + + Args: + request (~.device_manager.GetDeviceRequest): + The request object. Request for ``GetDevice``. + 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: + ~.resources.Device: + The device resource. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/registries/*/devices/*}", + }, + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/registries/*/groups/*/devices/*}", + }, + ] + request, metadata = self._interceptor.pre_get_device(request, metadata) + pb_request = device_manager.GetDeviceRequest.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 = resources.Device() + pb_resp = resources.Device.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_device(resp) + return resp + + class _GetDeviceRegistry(DeviceManagerRestStub): + def __hash__(self): + return hash("GetDeviceRegistry") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.GetDeviceRegistryRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.DeviceRegistry: + r"""Call the get device registry method over HTTP. + + Args: + request (~.device_manager.GetDeviceRegistryRequest): + The request object. Request for ``GetDeviceRegistry``. + 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: + ~.resources.DeviceRegistry: + A container for a group of devices. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/registries/*}", + }, + ] + request, metadata = self._interceptor.pre_get_device_registry( + request, metadata + ) + pb_request = device_manager.GetDeviceRegistryRequest.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 = resources.DeviceRegistry() + pb_resp = resources.DeviceRegistry.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_device_registry(resp) + return resp + + class _GetIamPolicy(DeviceManagerRestStub): + def __hash__(self): + return hash("GetIamPolicy") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: iam_policy_pb2.GetIamPolicyRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> policy_pb2.Policy: + r"""Call the get iam policy method over HTTP. + + Args: + request (~.iam_policy_pb2.GetIamPolicyRequest): + The request object. Request message for ``GetIamPolicy`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which + specifies access controls for Google Cloud resources. + + A ``Policy`` is a collection of ``bindings``. A + ``binding`` binds one or more ``members``, or + principals, to a single ``role``. Principals can be user + accounts, service accounts, Google groups, and domains + (such as G Suite). A ``role`` is a named list of + permissions; each ``role`` can be an IAM predefined role + or a user-created custom role. + + For some types of Google Cloud resources, a ``binding`` + can also specify a ``condition``, which is a logical + expression that allows access to a resource only if the + expression evaluates to ``true``. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the `IAM + documentation `__. + + **JSON example:** + + :: + + { + "bindings": [ + { + "role": "roles/resourcemanager.organizationAdmin", + "members": [ + "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + }, + { + "role": "roles/resourcemanager.organizationViewer", + "members": [ + "user:eve@example.com" + ], + "condition": { + "title": "expirable access", + "description": "Does not grant access after Sep 2020", + "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", + } + } + ], + "etag": "BwWWja0YfJA=", + "version": 3 + } + + **YAML example:** + + :: + + bindings: + - members: + - user:mike@example.com + - group:admins@example.com + - domain:google.com + - serviceAccount:my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin + - members: + - user:eve@example.com + role: roles/resourcemanager.organizationViewer + condition: + title: expirable access + description: Does not grant access after Sep 2020 + expression: request.time < timestamp('2020-10-01T00:00:00.000Z') + etag: BwWWja0YfJA= + version: 3 + + For a description of IAM and its features, see the `IAM + documentation `__. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{resource=projects/*/locations/*/registries/*}:getIamPolicy", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{resource=projects/*/locations/*/registries/*/groups/*}:getIamPolicy", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_get_iam_policy(request, metadata) + pb_request = 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 = policy_pb2.Policy() + pb_resp = resp + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_iam_policy(resp) + return resp + + class _ListDeviceConfigVersions(DeviceManagerRestStub): + def __hash__(self): + return hash("ListDeviceConfigVersions") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.ListDeviceConfigVersionsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> device_manager.ListDeviceConfigVersionsResponse: + r"""Call the list device config + versions method over HTTP. + + Args: + request (~.device_manager.ListDeviceConfigVersionsRequest): + The request object. Request for ``ListDeviceConfigVersions``. + 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: + ~.device_manager.ListDeviceConfigVersionsResponse: + Response for ``ListDeviceConfigVersions``. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/registries/*/devices/*}/configVersions", + }, + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/registries/*/groups/*/devices/*}/configVersions", + }, + ] + request, metadata = self._interceptor.pre_list_device_config_versions( + request, metadata + ) + pb_request = device_manager.ListDeviceConfigVersionsRequest.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 = device_manager.ListDeviceConfigVersionsResponse() + pb_resp = device_manager.ListDeviceConfigVersionsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_device_config_versions(resp) + return resp + + class _ListDeviceRegistries(DeviceManagerRestStub): + def __hash__(self): + return hash("ListDeviceRegistries") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.ListDeviceRegistriesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> device_manager.ListDeviceRegistriesResponse: + r"""Call the list device registries method over HTTP. + + Args: + request (~.device_manager.ListDeviceRegistriesRequest): + The request object. Request for ``ListDeviceRegistries``. + 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: + ~.device_manager.ListDeviceRegistriesResponse: + Response for ``ListDeviceRegistries``. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*}/registries", + }, + ] + request, metadata = self._interceptor.pre_list_device_registries( + request, metadata + ) + pb_request = device_manager.ListDeviceRegistriesRequest.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 = device_manager.ListDeviceRegistriesResponse() + pb_resp = device_manager.ListDeviceRegistriesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_device_registries(resp) + return resp + + class _ListDevices(DeviceManagerRestStub): + def __hash__(self): + return hash("ListDevices") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.ListDevicesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> device_manager.ListDevicesResponse: + r"""Call the list devices method over HTTP. + + Args: + request (~.device_manager.ListDevicesRequest): + The request object. Request for ``ListDevices``. + 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: + ~.device_manager.ListDevicesResponse: + Response for ``ListDevices``. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*/registries/*}/devices", + }, + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*/registries/*/groups/*}/devices", + }, + ] + request, metadata = self._interceptor.pre_list_devices(request, metadata) + pb_request = device_manager.ListDevicesRequest.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 = device_manager.ListDevicesResponse() + pb_resp = device_manager.ListDevicesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_devices(resp) + return resp + + class _ListDeviceStates(DeviceManagerRestStub): + def __hash__(self): + return hash("ListDeviceStates") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.ListDeviceStatesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> device_manager.ListDeviceStatesResponse: + r"""Call the list device states method over HTTP. + + Args: + request (~.device_manager.ListDeviceStatesRequest): + The request object. Request for ``ListDeviceStates``. + 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: + ~.device_manager.ListDeviceStatesResponse: + Response for ``ListDeviceStates``. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/registries/*/devices/*}/states", + }, + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/registries/*/groups/*/devices/*}/states", + }, + ] + request, metadata = self._interceptor.pre_list_device_states( + request, metadata + ) + pb_request = device_manager.ListDeviceStatesRequest.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 = device_manager.ListDeviceStatesResponse() + pb_resp = device_manager.ListDeviceStatesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_device_states(resp) + return resp + + class _ModifyCloudToDeviceConfig(DeviceManagerRestStub): + def __hash__(self): + return hash("ModifyCloudToDeviceConfig") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.ModifyCloudToDeviceConfigRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.DeviceConfig: + r"""Call the modify cloud to device + config method over HTTP. + + Args: + request (~.device_manager.ModifyCloudToDeviceConfigRequest): + The request object. Request for ``ModifyCloudToDeviceConfig``. + 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: + ~.resources.DeviceConfig: + The device configuration. Eventually + delivered to devices. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{name=projects/*/locations/*/registries/*/devices/*}:modifyCloudToDeviceConfig", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=projects/*/locations/*/registries/*/groups/*/devices/*}:modifyCloudToDeviceConfig", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_modify_cloud_to_device_config( + request, metadata + ) + pb_request = device_manager.ModifyCloudToDeviceConfigRequest.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 = resources.DeviceConfig() + pb_resp = resources.DeviceConfig.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_modify_cloud_to_device_config(resp) + return resp + + class _SendCommandToDevice(DeviceManagerRestStub): + def __hash__(self): + return hash("SendCommandToDevice") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.SendCommandToDeviceRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> device_manager.SendCommandToDeviceResponse: + r"""Call the send command to device method over HTTP. + + Args: + request (~.device_manager.SendCommandToDeviceRequest): + The request object. Request for ``SendCommandToDevice``. + 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: + ~.device_manager.SendCommandToDeviceResponse: + Response for ``SendCommandToDevice``. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{name=projects/*/locations/*/registries/*/devices/*}:sendCommandToDevice", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{name=projects/*/locations/*/registries/*/groups/*/devices/*}:sendCommandToDevice", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_send_command_to_device( + request, metadata + ) + pb_request = device_manager.SendCommandToDeviceRequest.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 = device_manager.SendCommandToDeviceResponse() + pb_resp = device_manager.SendCommandToDeviceResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_send_command_to_device(resp) + return resp + + class _SetIamPolicy(DeviceManagerRestStub): + def __hash__(self): + return hash("SetIamPolicy") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: iam_policy_pb2.SetIamPolicyRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> policy_pb2.Policy: + r"""Call the set iam policy method over HTTP. + + Args: + request (~.iam_policy_pb2.SetIamPolicyRequest): + The request object. Request message for ``SetIamPolicy`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.policy_pb2.Policy: + An Identity and Access Management (IAM) policy, which + specifies access controls for Google Cloud resources. + + A ``Policy`` is a collection of ``bindings``. A + ``binding`` binds one or more ``members``, or + principals, to a single ``role``. Principals can be user + accounts, service accounts, Google groups, and domains + (such as G Suite). A ``role`` is a named list of + permissions; each ``role`` can be an IAM predefined role + or a user-created custom role. + + For some types of Google Cloud resources, a ``binding`` + can also specify a ``condition``, which is a logical + expression that allows access to a resource only if the + expression evaluates to ``true``. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the `IAM + documentation `__. + + **JSON example:** + + :: + + { + "bindings": [ + { + "role": "roles/resourcemanager.organizationAdmin", + "members": [ + "user:mike@example.com", + "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" + ] + }, + { + "role": "roles/resourcemanager.organizationViewer", + "members": [ + "user:eve@example.com" + ], + "condition": { + "title": "expirable access", + "description": "Does not grant access after Sep 2020", + "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", + } + } + ], + "etag": "BwWWja0YfJA=", + "version": 3 + } + + **YAML example:** + + :: + + bindings: + - members: + - user:mike@example.com + - group:admins@example.com + - domain:google.com + - serviceAccount:my-project-id@appspot.gserviceaccount.com + role: roles/resourcemanager.organizationAdmin + - members: + - user:eve@example.com + role: roles/resourcemanager.organizationViewer + condition: + title: expirable access + description: Does not grant access after Sep 2020 + expression: request.time < timestamp('2020-10-01T00:00:00.000Z') + etag: BwWWja0YfJA= + version: 3 + + For a description of IAM and its features, see the `IAM + documentation `__. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{resource=projects/*/locations/*/registries/*}:setIamPolicy", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{resource=projects/*/locations/*/registries/*/groups/*}:setIamPolicy", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_set_iam_policy(request, metadata) + pb_request = 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 = policy_pb2.Policy() + pb_resp = resp + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_set_iam_policy(resp) + return resp + + class _TestIamPermissions(DeviceManagerRestStub): + def __hash__(self): + return hash("TestIamPermissions") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: iam_policy_pb2.TestIamPermissionsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> iam_policy_pb2.TestIamPermissionsResponse: + r"""Call the test iam permissions method over HTTP. + + Args: + request (~.iam_policy_pb2.TestIamPermissionsRequest): + The request object. Request message for ``TestIamPermissions`` method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.iam_policy_pb2.TestIamPermissionsResponse: + Response message for ``TestIamPermissions`` method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{resource=projects/*/locations/*/registries/*}:testIamPermissions", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{resource=projects/*/locations/*/registries/*/groups/*}:testIamPermissions", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_test_iam_permissions( + request, metadata + ) + pb_request = 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 = iam_policy_pb2.TestIamPermissionsResponse() + pb_resp = resp + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_test_iam_permissions(resp) + return resp + + class _UnbindDeviceFromGateway(DeviceManagerRestStub): + def __hash__(self): + return hash("UnbindDeviceFromGateway") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: device_manager.UnbindDeviceFromGatewayRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> device_manager.UnbindDeviceFromGatewayResponse: + r"""Call the unbind device from + gateway method over HTTP. + + Args: + request (~.device_manager.UnbindDeviceFromGatewayRequest): + The request object. Request for ``UnbindDeviceFromGateway``. + 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: + ~.device_manager.UnbindDeviceFromGatewayResponse: + Response for ``UnbindDeviceFromGateway``. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*/registries/*}:unbindDeviceFromGateway", + "body": "*", + }, + { + "method": "post", + "uri": "/v1/{parent=projects/*/locations/*/registries/*/groups/*}:unbindDeviceFromGateway", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_unbind_device_from_gateway( + request, metadata + ) + pb_request = device_manager.UnbindDeviceFromGatewayRequest.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 = device_manager.UnbindDeviceFromGatewayResponse() + pb_resp = device_manager.UnbindDeviceFromGatewayResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_unbind_device_from_gateway(resp) + return resp + + class _UpdateDevice(DeviceManagerRestStub): + def __hash__(self): + return hash("UpdateDevice") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "updateMask": {}, + } + + @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: device_manager.UpdateDeviceRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.Device: + r"""Call the update device method over HTTP. + + Args: + request (~.device_manager.UpdateDeviceRequest): + The request object. Request for ``UpdateDevice``. + 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: + ~.resources.Device: + The device resource. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1/{device.name=projects/*/locations/*/registries/*/devices/*}", + "body": "device", + }, + { + "method": "patch", + "uri": "/v1/{device.name=projects/*/locations/*/registries/*/groups/*/devices/*}", + "body": "device", + }, + ] + request, metadata = self._interceptor.pre_update_device(request, metadata) + pb_request = device_manager.UpdateDeviceRequest.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 = resources.Device() + pb_resp = resources.Device.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_device(resp) + return resp + + class _UpdateDeviceRegistry(DeviceManagerRestStub): + def __hash__(self): + return hash("UpdateDeviceRegistry") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "updateMask": {}, + } + + @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: device_manager.UpdateDeviceRegistryRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resources.DeviceRegistry: + r"""Call the update device registry method over HTTP. + + Args: + request (~.device_manager.UpdateDeviceRegistryRequest): + The request object. Request for ``UpdateDeviceRegistry``. + 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: + ~.resources.DeviceRegistry: + A container for a group of devices. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1/{device_registry.name=projects/*/locations/*/registries/*}", + "body": "device_registry", + }, + ] + request, metadata = self._interceptor.pre_update_device_registry( + request, metadata + ) + pb_request = device_manager.UpdateDeviceRegistryRequest.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 = resources.DeviceRegistry() + pb_resp = resources.DeviceRegistry.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_device_registry(resp) + return resp + + @property + def bind_device_to_gateway( + self, + ) -> Callable[ + [device_manager.BindDeviceToGatewayRequest], + device_manager.BindDeviceToGatewayResponse, + ]: + # 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._BindDeviceToGateway(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_device( + self, + ) -> Callable[[device_manager.CreateDeviceRequest], resources.Device]: + # 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._CreateDevice(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_device_registry( + self, + ) -> Callable[ + [device_manager.CreateDeviceRegistryRequest], resources.DeviceRegistry + ]: + # 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._CreateDeviceRegistry(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_device( + self, + ) -> Callable[[device_manager.DeleteDeviceRequest], 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._DeleteDevice(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_device_registry( + self, + ) -> Callable[[device_manager.DeleteDeviceRegistryRequest], 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._DeleteDeviceRegistry(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_device( + self, + ) -> Callable[[device_manager.GetDeviceRequest], resources.Device]: + # 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._GetDevice(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_device_registry( + self, + ) -> Callable[[device_manager.GetDeviceRegistryRequest], resources.DeviceRegistry]: + # 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._GetDeviceRegistry(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_iam_policy( + self, + ) -> Callable[[iam_policy_pb2.GetIamPolicyRequest], policy_pb2.Policy]: + # 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._GetIamPolicy(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_device_config_versions( + self, + ) -> Callable[ + [device_manager.ListDeviceConfigVersionsRequest], + device_manager.ListDeviceConfigVersionsResponse, + ]: + # 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._ListDeviceConfigVersions(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_device_registries( + self, + ) -> Callable[ + [device_manager.ListDeviceRegistriesRequest], + device_manager.ListDeviceRegistriesResponse, + ]: + # 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._ListDeviceRegistries(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_devices( + self, + ) -> Callable[ + [device_manager.ListDevicesRequest], device_manager.ListDevicesResponse + ]: + # 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._ListDevices(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_device_states( + self, + ) -> Callable[ + [device_manager.ListDeviceStatesRequest], + device_manager.ListDeviceStatesResponse, + ]: + # 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._ListDeviceStates(self._session, self._host, self._interceptor) # type: ignore + + @property + def modify_cloud_to_device_config( + self, + ) -> Callable[ + [device_manager.ModifyCloudToDeviceConfigRequest], resources.DeviceConfig + ]: + # 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._ModifyCloudToDeviceConfig(self._session, self._host, self._interceptor) # type: ignore + + @property + def send_command_to_device( + self, + ) -> Callable[ + [device_manager.SendCommandToDeviceRequest], + device_manager.SendCommandToDeviceResponse, + ]: + # 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._SendCommandToDevice(self._session, self._host, self._interceptor) # type: ignore + + @property + def set_iam_policy( + self, + ) -> Callable[[iam_policy_pb2.SetIamPolicyRequest], policy_pb2.Policy]: + # 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._SetIamPolicy(self._session, self._host, self._interceptor) # type: ignore + + @property + def test_iam_permissions( + self, + ) -> Callable[ + [iam_policy_pb2.TestIamPermissionsRequest], + iam_policy_pb2.TestIamPermissionsResponse, + ]: + # 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._TestIamPermissions(self._session, self._host, self._interceptor) # type: ignore + + @property + def unbind_device_from_gateway( + self, + ) -> Callable[ + [device_manager.UnbindDeviceFromGatewayRequest], + device_manager.UnbindDeviceFromGatewayResponse, + ]: + # 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._UnbindDeviceFromGateway(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_device( + self, + ) -> Callable[[device_manager.UpdateDeviceRequest], resources.Device]: + # 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._UpdateDevice(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_device_registry( + self, + ) -> Callable[ + [device_manager.UpdateDeviceRegistryRequest], resources.DeviceRegistry + ]: + # 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._UpdateDeviceRegistry(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("DeviceManagerRestTransport",) diff --git a/google/cloud/iot_v1/types/device_manager.py b/google/cloud/iot_v1/types/device_manager.py index d5876ad2..728e2d3a 100644 --- a/google/cloud/iot_v1/types/device_manager.py +++ b/google/cloud/iot_v1/types/device_manager.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence from google.protobuf import field_mask_pb2 # type: ignore diff --git a/google/cloud/iot_v1/types/resources.py b/google/cloud/iot_v1/types/resources.py index 72bc3a81..4f5d9472 100644 --- a/google/cloud/iot_v1/types/resources.py +++ b/google/cloud/iot_v1/types/resources.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence from google.protobuf import timestamp_pb2 # type: ignore diff --git a/iot-v1-py.tar.gz b/iot-v1-py.tar.gz new file mode 100644 index 00000000..abf61e62 Binary files /dev/null and b/iot-v1-py.tar.gz differ diff --git a/noxfile.py b/noxfile.py index e716318b..95e58c52 100644 --- a/noxfile.py +++ b/noxfile.py @@ -189,9 +189,9 @@ def unit(session): def install_systemtest_dependencies(session, *constraints): # Use pre-release gRPC for system tests. - # Exclude version 1.49.0rc1 which has a known issue. - # See https://github.com/grpc/grpc/pull/30642 - session.install("--pre", "grpcio!=1.49.0rc1") + # Exclude version 1.52.0rc1 which has a known issue. + # See https://github.com/grpc/grpc/issues/32163 + session.install("--pre", "grpcio!=1.52.0rc1") session.install(*SYSTEM_TEST_STANDARD_DEPENDENCIES, *constraints) @@ -346,9 +346,7 @@ def prerelease_deps(session): unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES session.install(*unit_deps_all) system_deps_all = ( - SYSTEM_TEST_STANDARD_DEPENDENCIES - + SYSTEM_TEST_EXTERNAL_DEPENDENCIES - + SYSTEM_TEST_EXTRAS + SYSTEM_TEST_STANDARD_DEPENDENCIES + SYSTEM_TEST_EXTERNAL_DEPENDENCIES ) session.install(*system_deps_all) @@ -378,8 +376,8 @@ def prerelease_deps(session): # dependency of grpc "six", "googleapis-common-protos", - # Exclude version 1.49.0rc1 which has a known issue. See https://github.com/grpc/grpc/pull/30642 - "grpcio!=1.49.0rc1", + # Exclude version 1.52.0rc1 which has a known issue. See https://github.com/grpc/grpc/issues/32163 + "grpcio!=1.52.0rc1", "grpcio-status", "google-api-core", "proto-plus", diff --git a/owlbot.py b/owlbot.py index b87604b4..6c908cbe 100644 --- a/owlbot.py +++ b/owlbot.py @@ -38,7 +38,7 @@ # Rename `format_` to `format` to avoid breaking change s.replace( - library / "google/cloud/**/types/resources.py", + library / "**/*.py", "format_", "format" ) diff --git a/samples/api-client/accesstoken_example/requirements-test.txt b/samples/api-client/accesstoken_example/requirements-test.txt index 3daba3f0..1cbe85f2 100644 --- a/samples/api-client/accesstoken_example/requirements-test.txt +++ b/samples/api-client/accesstoken_example/requirements-test.txt @@ -1,3 +1,3 @@ pytest==7.2.1 -google-cloud-pubsub==2.13.12 +google-cloud-pubsub==2.14.1 google-cloud-storage==2.7.0 diff --git a/samples/api-client/accesstoken_example/requirements.txt b/samples/api-client/accesstoken_example/requirements.txt index 891cfa55..a941ab9c 100644 --- a/samples/api-client/accesstoken_example/requirements.txt +++ b/samples/api-client/accesstoken_example/requirements.txt @@ -1,10 +1,10 @@ -cryptography==39.0.0 +cryptography==39.0.1 flaky==3.7.0 -google-api-python-client==2.73.0 +google-api-python-client==2.78.0 google-auth-httplib2==0.1.0 google-auth==2.16.0 -google-cloud-iot==2.8.0 -google-cloud-pubsub==2.13.12 +google-cloud-iot==2.8.1 +google-cloud-pubsub==2.14.1 google-cloud-storage==2.7.0 paho-mqtt==1.6.1 pyjwt==2.6.0 diff --git a/samples/api-client/manager/manager_test.py b/samples/api-client/manager/manager_test.py index 7fa434a7..5e62781a 100644 --- a/samples/api-client/manager/manager_test.py +++ b/samples/api-client/manager/manager_test.py @@ -106,7 +106,7 @@ def clean_up_registries(): "gatewayId": gateway_id, } client.projects().locations().registries().unbindDeviceFromGateway( - parent=registry.get("name"), body=bind_request + parent=registry.name, body=bind_request ).execute() gateway_name = "{}/devices/{}".format(registry.name, gateway_id) client.projects().locations().registries().devices().delete( diff --git a/samples/api-client/manager/requirements.txt b/samples/api-client/manager/requirements.txt index d392e09a..c83a0195 100644 --- a/samples/api-client/manager/requirements.txt +++ b/samples/api-client/manager/requirements.txt @@ -1,9 +1,9 @@ -cryptography==39.0.0 +cryptography==39.0.1 flaky==3.7.0 -google-api-python-client==2.73.0 +google-api-python-client==2.78.0 google-auth-httplib2==0.1.0 google-auth==2.16.0 -google-cloud-iot==2.8.0 -google-cloud-pubsub==2.13.12 +google-cloud-iot==2.8.1 +google-cloud-pubsub==2.14.1 paho-mqtt==1.6.1 pyjwt==2.6.0 diff --git a/samples/generated_samples/snippet_metadata_google.cloud.iot.v1.json b/samples/generated_samples/snippet_metadata_google.cloud.iot.v1.json index a07c90e6..941846d6 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.iot.v1.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.iot.v1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-iot", - "version": "2.8.1" + "version": "2.9.0" }, "snippets": [ { diff --git a/setup.py b/setup.py index d419b81b..80480257 100644 --- a/setup.py +++ b/setup.py @@ -56,9 +56,7 @@ if package.startswith("google") ] -namespaces = ["google"] -if "google.cloud" in packages: - namespaces.append("google.cloud") +namespaces = ["google", "google.cloud"] setuptools.setup( name=name, diff --git a/tests/unit/gapic/iot_v1/test_device_manager.py b/tests/unit/gapic/iot_v1/test_device_manager.py index 0934a649..b90a2c3a 100644 --- a/tests/unit/gapic/iot_v1/test_device_manager.py +++ b/tests/unit/gapic/iot_v1/test_device_manager.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 @@ -36,6 +38,7 @@ from google.oauth2 import service_account from google.protobuf import any_pb2 # type: ignore from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import json_format from google.protobuf import timestamp_pb2 # type: ignore from google.rpc import status_pb2 # type: ignore from google.type import expr_pb2 # type: ignore @@ -44,6 +47,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.iot_v1.services.device_manager import ( DeviceManagerAsyncClient, @@ -103,6 +108,7 @@ def test__get_default_mtls_endpoint(): [ (DeviceManagerClient, "grpc"), (DeviceManagerAsyncClient, "grpc_asyncio"), + (DeviceManagerClient, "rest"), ], ) def test_device_manager_client_from_service_account_info(client_class, transport_name): @@ -116,7 +122,11 @@ def test_device_manager_client_from_service_account_info(client_class, transport assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("cloudiot.googleapis.com:443") + assert client.transport._host == ( + "cloudiot.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudiot.googleapis.com" + ) @pytest.mark.parametrize( @@ -124,6 +134,7 @@ def test_device_manager_client_from_service_account_info(client_class, transport [ (transports.DeviceManagerGrpcTransport, "grpc"), (transports.DeviceManagerGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.DeviceManagerRestTransport, "rest"), ], ) def test_device_manager_client_service_account_always_use_jwt( @@ -149,6 +160,7 @@ def test_device_manager_client_service_account_always_use_jwt( [ (DeviceManagerClient, "grpc"), (DeviceManagerAsyncClient, "grpc_asyncio"), + (DeviceManagerClient, "rest"), ], ) def test_device_manager_client_from_service_account_file(client_class, transport_name): @@ -169,13 +181,18 @@ def test_device_manager_client_from_service_account_file(client_class, transport assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("cloudiot.googleapis.com:443") + assert client.transport._host == ( + "cloudiot.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudiot.googleapis.com" + ) def test_device_manager_client_get_transport_class(): transport = DeviceManagerClient.get_transport_class() available_transports = [ transports.DeviceManagerGrpcTransport, + transports.DeviceManagerRestTransport, ] assert transport in available_transports @@ -192,6 +209,7 @@ def test_device_manager_client_get_transport_class(): transports.DeviceManagerGrpcAsyncIOTransport, "grpc_asyncio", ), + (DeviceManagerClient, transports.DeviceManagerRestTransport, "rest"), ], ) @mock.patch.object( @@ -337,6 +355,8 @@ def test_device_manager_client_client_options( "grpc_asyncio", "false", ), + (DeviceManagerClient, transports.DeviceManagerRestTransport, "rest", "true"), + (DeviceManagerClient, transports.DeviceManagerRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -536,6 +556,7 @@ def test_device_manager_client_get_mtls_endpoint_and_cert_source(client_class): transports.DeviceManagerGrpcAsyncIOTransport, "grpc_asyncio", ), + (DeviceManagerClient, transports.DeviceManagerRestTransport, "rest"), ], ) def test_device_manager_client_client_options_scopes( @@ -576,6 +597,7 @@ def test_device_manager_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (DeviceManagerClient, transports.DeviceManagerRestTransport, "rest", None), ], ) def test_device_manager_client_client_options_credentials_file( @@ -5846,142 +5868,5905 @@ async def test_unbind_device_from_gateway_flattened_error_async(): ) -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.DeviceManagerGrpcTransport( +@pytest.mark.parametrize( + "request_type", + [ + device_manager.CreateDeviceRegistryRequest, + dict, + ], +) +def test_create_device_registry_rest(request_type): + client = DeviceManagerClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - with pytest.raises(ValueError): - client = DeviceManagerClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["device_registry"] = { + "id": "id_value", + "name": "name_value", + "event_notification_configs": [ + { + "subfolder_matches": "subfolder_matches_value", + "pubsub_topic_name": "pubsub_topic_name_value", + } + ], + "state_notification_config": {"pubsub_topic_name": "pubsub_topic_name_value"}, + "mqtt_config": {"mqtt_enabled_state": 1}, + "http_config": {"http_enabled_state": 1}, + "log_level": 10, + "credentials": [ + { + "public_key_certificate": { + "format": 1, + "certificate": "certificate_value", + "x509_details": { + "issuer": "issuer_value", + "subject": "subject_value", + "start_time": {"seconds": 751, "nanos": 543}, + "expiry_time": {}, + "signature_algorithm": "signature_algorithm_value", + "public_key_type": "public_key_type_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 = resources.DeviceRegistry( + id="id_value", + name="name_value", + log_level=resources.LogLevel.NONE, ) - # It is an error to provide a credentials file and a transport instance. - transport = transports.DeviceManagerGrpcTransport( + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = resources.DeviceRegistry.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_device_registry(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.DeviceRegistry) + assert response.id == "id_value" + assert response.name == "name_value" + assert response.log_level == resources.LogLevel.NONE + + +def test_create_device_registry_rest_required_fields( + request_type=device_manager.CreateDeviceRegistryRequest, +): + transport_class = transports.DeviceManagerRestTransport + + 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() + ).create_device_registry._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_device_registry._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 = DeviceManagerClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resources.DeviceRegistry() + # 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 = resources.DeviceRegistry.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_device_registry(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_device_registry_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials ) - with pytest.raises(ValueError): - client = DeviceManagerClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, + + unset_fields = transport.create_device_registry._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "deviceRegistry", + ) ) + ) - # It is an error to provide an api_key and a transport instance. - transport = transports.DeviceManagerGrpcTransport( + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_device_registry_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = DeviceManagerClient( - client_options=options, - transport=transport, + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_create_device_registry" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_create_device_registry" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.CreateDeviceRegistryRequest.pb( + device_manager.CreateDeviceRegistryRequest() + ) + 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 = resources.DeviceRegistry.to_json( + resources.DeviceRegistry() ) - # 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 = DeviceManagerClient( - client_options=options, credentials=ga_credentials.AnonymousCredentials() + request = device_manager.CreateDeviceRegistryRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resources.DeviceRegistry() + + client.create_device_registry( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], ) - # It is an error to provide scopes and a transport instance. - transport = transports.DeviceManagerGrpcTransport( + pre.assert_called_once() + post.assert_called_once() + + +def test_create_device_registry_rest_bad_request( + transport: str = "rest", request_type=device_manager.CreateDeviceRegistryRequest +): + client = DeviceManagerClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - with pytest.raises(ValueError): - client = DeviceManagerClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["device_registry"] = { + "id": "id_value", + "name": "name_value", + "event_notification_configs": [ + { + "subfolder_matches": "subfolder_matches_value", + "pubsub_topic_name": "pubsub_topic_name_value", + } + ], + "state_notification_config": {"pubsub_topic_name": "pubsub_topic_name_value"}, + "mqtt_config": {"mqtt_enabled_state": 1}, + "http_config": {"http_enabled_state": 1}, + "log_level": 10, + "credentials": [ + { + "public_key_certificate": { + "format": 1, + "certificate": "certificate_value", + "x509_details": { + "issuer": "issuer_value", + "subject": "subject_value", + "start_time": {"seconds": 751, "nanos": 543}, + "expiry_time": {}, + "signature_algorithm": "signature_algorithm_value", + "public_key_type": "public_key_type_value", + }, + } + } + ], + } + request = request_type(**request_init) -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.DeviceManagerGrpcTransport( + # 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_device_registry(request) + + +def test_create_device_registry_rest_flattened(): + client = DeviceManagerClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - client = DeviceManagerClient(transport=transport) - assert client.transport is transport + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = resources.DeviceRegistry() -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.DeviceManagerGrpcTransport( + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + device_registry=resources.DeviceRegistry(id="id_value"), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = resources.DeviceRegistry.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_device_registry(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*}/registries" % client.transport._host, + args[1], + ) + + +def test_create_device_registry_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel - transport = transports.DeviceManagerGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_device_registry( + device_manager.CreateDeviceRegistryRequest(), + parent="parent_value", + device_registry=resources.DeviceRegistry(id="id_value"), + ) + + +def test_create_device_registry_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) - channel = transport.grpc_channel - assert channel @pytest.mark.parametrize( - "transport_class", + "request_type", [ - transports.DeviceManagerGrpcTransport, - transports.DeviceManagerGrpcAsyncIOTransport, + device_manager.GetDeviceRegistryRequest, + dict, ], ) -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_get_device_registry_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) -@pytest.mark.parametrize( - "transport_name", - [ - "grpc", - ], -) -def test_transport_kind(transport_name): - transport = DeviceManagerClient.get_transport_class(transport_name)( + # 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 = resources.DeviceRegistry( + id="id_value", + name="name_value", + log_level=resources.LogLevel.NONE, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = resources.DeviceRegistry.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_device_registry(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.DeviceRegistry) + assert response.id == "id_value" + assert response.name == "name_value" + assert response.log_level == resources.LogLevel.NONE + + +def test_get_device_registry_rest_required_fields( + request_type=device_manager.GetDeviceRegistryRequest, +): + transport_class = transports.DeviceManagerRestTransport + + 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_device_registry._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_device_registry._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 = DeviceManagerClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resources.DeviceRegistry() + # 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 = resources.DeviceRegistry.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_device_registry(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_device_registry_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials ) - assert transport.kind == transport_name + unset_fields = transport.get_device_registry._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_device_registry_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_get_device_registry" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_get_device_registry" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.GetDeviceRegistryRequest.pb( + device_manager.GetDeviceRegistryRequest() + ) + 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 = resources.DeviceRegistry.to_json( + resources.DeviceRegistry() + ) + + request = device_manager.GetDeviceRegistryRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resources.DeviceRegistry() + + client.get_device_registry( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_device_registry_rest_bad_request( + transport: str = "rest", request_type=device_manager.GetDeviceRegistryRequest +): client = DeviceManagerClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - assert isinstance( - client.transport, - transports.DeviceManagerGrpcTransport, + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_device_registry(request) + + +def test_get_device_registry_rest_flattened(): + client = DeviceManagerClient( + 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 = resources.DeviceRegistry() -def test_device_manager_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.DeviceManagerTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json", + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/registries/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", ) + mock_args.update(sample_request) + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = resources.DeviceRegistry.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 -def test_device_manager_base_transport(): - # Instantiate the base transport. - with mock.patch( - "google.cloud.iot_v1.services.device_manager.transports.DeviceManagerTransport.__init__" - ) as Transport: - Transport.return_value = None - transport = transports.DeviceManagerTransport( - credentials=ga_credentials.AnonymousCredentials(), + client.get_device_registry(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/registries/*}" % client.transport._host, + args[1], ) - # Every method on the transport should just blindly - # raise NotImplementedError. + +def test_get_device_registry_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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_device_registry( + device_manager.GetDeviceRegistryRequest(), + name="name_value", + ) + + +def test_get_device_registry_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + device_manager.UpdateDeviceRegistryRequest, + dict, + ], +) +def test_update_device_registry_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "device_registry": { + "name": "projects/sample1/locations/sample2/registries/sample3" + } + } + request_init["device_registry"] = { + "id": "id_value", + "name": "projects/sample1/locations/sample2/registries/sample3", + "event_notification_configs": [ + { + "subfolder_matches": "subfolder_matches_value", + "pubsub_topic_name": "pubsub_topic_name_value", + } + ], + "state_notification_config": {"pubsub_topic_name": "pubsub_topic_name_value"}, + "mqtt_config": {"mqtt_enabled_state": 1}, + "http_config": {"http_enabled_state": 1}, + "log_level": 10, + "credentials": [ + { + "public_key_certificate": { + "format": 1, + "certificate": "certificate_value", + "x509_details": { + "issuer": "issuer_value", + "subject": "subject_value", + "start_time": {"seconds": 751, "nanos": 543}, + "expiry_time": {}, + "signature_algorithm": "signature_algorithm_value", + "public_key_type": "public_key_type_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 = resources.DeviceRegistry( + id="id_value", + name="name_value", + log_level=resources.LogLevel.NONE, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = resources.DeviceRegistry.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_device_registry(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.DeviceRegistry) + assert response.id == "id_value" + assert response.name == "name_value" + assert response.log_level == resources.LogLevel.NONE + + +def test_update_device_registry_rest_required_fields( + request_type=device_manager.UpdateDeviceRegistryRequest, +): + transport_class = transports.DeviceManagerRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_device_registry._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_device_registry._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 = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resources.DeviceRegistry() + # 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 = resources.DeviceRegistry.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_device_registry(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_device_registry_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_device_registry._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("updateMask",)) + & set( + ( + "deviceRegistry", + "updateMask", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_device_registry_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_update_device_registry" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_update_device_registry" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.UpdateDeviceRegistryRequest.pb( + device_manager.UpdateDeviceRegistryRequest() + ) + 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 = resources.DeviceRegistry.to_json( + resources.DeviceRegistry() + ) + + request = device_manager.UpdateDeviceRegistryRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resources.DeviceRegistry() + + client.update_device_registry( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_device_registry_rest_bad_request( + transport: str = "rest", request_type=device_manager.UpdateDeviceRegistryRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "device_registry": { + "name": "projects/sample1/locations/sample2/registries/sample3" + } + } + request_init["device_registry"] = { + "id": "id_value", + "name": "projects/sample1/locations/sample2/registries/sample3", + "event_notification_configs": [ + { + "subfolder_matches": "subfolder_matches_value", + "pubsub_topic_name": "pubsub_topic_name_value", + } + ], + "state_notification_config": {"pubsub_topic_name": "pubsub_topic_name_value"}, + "mqtt_config": {"mqtt_enabled_state": 1}, + "http_config": {"http_enabled_state": 1}, + "log_level": 10, + "credentials": [ + { + "public_key_certificate": { + "format": 1, + "certificate": "certificate_value", + "x509_details": { + "issuer": "issuer_value", + "subject": "subject_value", + "start_time": {"seconds": 751, "nanos": 543}, + "expiry_time": {}, + "signature_algorithm": "signature_algorithm_value", + "public_key_type": "public_key_type_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_device_registry(request) + + +def test_update_device_registry_rest_flattened(): + client = DeviceManagerClient( + 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 = resources.DeviceRegistry() + + # get arguments that satisfy an http rule for this method + sample_request = { + "device_registry": { + "name": "projects/sample1/locations/sample2/registries/sample3" + } + } + + # get truthy value for each flattened field + mock_args = dict( + device_registry=resources.DeviceRegistry(id="id_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 = resources.DeviceRegistry.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_device_registry(**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/{device_registry.name=projects/*/locations/*/registries/*}" + % client.transport._host, + args[1], + ) + + +def test_update_device_registry_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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_device_registry( + device_manager.UpdateDeviceRegistryRequest(), + device_registry=resources.DeviceRegistry(id="id_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_device_registry_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + device_manager.DeleteDeviceRegistryRequest, + dict, + ], +) +def test_delete_device_registry_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = 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_device_registry(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_device_registry_rest_required_fields( + request_type=device_manager.DeleteDeviceRegistryRequest, +): + transport_class = transports.DeviceManagerRestTransport + + 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_device_registry._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_device_registry._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 = DeviceManagerClient( + 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_device_registry(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_device_registry_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_device_registry._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_device_registry_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "pre_delete_device_registry" + ) as pre: + pre.assert_not_called() + pb_message = device_manager.DeleteDeviceRegistryRequest.pb( + device_manager.DeleteDeviceRegistryRequest() + ) + 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 = device_manager.DeleteDeviceRegistryRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_device_registry( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_device_registry_rest_bad_request( + transport: str = "rest", request_type=device_manager.DeleteDeviceRegistryRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_device_registry(request) + + +def test_delete_device_registry_rest_flattened(): + client = DeviceManagerClient( + 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": "projects/sample1/locations/sample2/registries/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_device_registry(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/registries/*}" % client.transport._host, + args[1], + ) + + +def test_delete_device_registry_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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_device_registry( + device_manager.DeleteDeviceRegistryRequest(), + name="name_value", + ) + + +def test_delete_device_registry_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + device_manager.ListDeviceRegistriesRequest, + dict, + ], +) +def test_list_device_registries_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = device_manager.ListDeviceRegistriesResponse( + 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 = device_manager.ListDeviceRegistriesResponse.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_device_registries(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListDeviceRegistriesPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_device_registries_rest_required_fields( + request_type=device_manager.ListDeviceRegistriesRequest, +): + transport_class = transports.DeviceManagerRestTransport + + 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_device_registries._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_device_registries._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 = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = device_manager.ListDeviceRegistriesResponse() + # 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 = device_manager.ListDeviceRegistriesResponse.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_device_registries(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_device_registries_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_device_registries._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_device_registries_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_list_device_registries" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_list_device_registries" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.ListDeviceRegistriesRequest.pb( + device_manager.ListDeviceRegistriesRequest() + ) + 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 = device_manager.ListDeviceRegistriesResponse.to_json( + device_manager.ListDeviceRegistriesResponse() + ) + + request = device_manager.ListDeviceRegistriesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = device_manager.ListDeviceRegistriesResponse() + + client.list_device_registries( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_device_registries_rest_bad_request( + transport: str = "rest", request_type=device_manager.ListDeviceRegistriesRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_device_registries(request) + + +def test_list_device_registries_rest_flattened(): + client = DeviceManagerClient( + 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 = device_manager.ListDeviceRegistriesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = device_manager.ListDeviceRegistriesResponse.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_device_registries(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*}/registries" % client.transport._host, + args[1], + ) + + +def test_list_device_registries_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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_device_registries( + device_manager.ListDeviceRegistriesRequest(), + parent="parent_value", + ) + + +def test_list_device_registries_rest_pager(transport: str = "rest"): + client = DeviceManagerClient( + 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 = ( + device_manager.ListDeviceRegistriesResponse( + device_registries=[ + resources.DeviceRegistry(), + resources.DeviceRegistry(), + resources.DeviceRegistry(), + ], + next_page_token="abc", + ), + device_manager.ListDeviceRegistriesResponse( + device_registries=[], + next_page_token="def", + ), + device_manager.ListDeviceRegistriesResponse( + device_registries=[ + resources.DeviceRegistry(), + ], + next_page_token="ghi", + ), + device_manager.ListDeviceRegistriesResponse( + device_registries=[ + resources.DeviceRegistry(), + resources.DeviceRegistry(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + device_manager.ListDeviceRegistriesResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {"parent": "projects/sample1/locations/sample2"} + + pager = client.list_device_registries(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resources.DeviceRegistry) for i in results) + + pages = list(client.list_device_registries(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", + [ + device_manager.CreateDeviceRequest, + dict, + ], +) +def test_create_device_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/registries/sample3"} + request_init["device"] = { + "id": "id_value", + "name": "name_value", + "num_id": 636, + "credentials": [ + { + "public_key": {"format": 3, "key": "key_value"}, + "expiration_time": {"seconds": 751, "nanos": 543}, + } + ], + "last_heartbeat_time": {}, + "last_event_time": {}, + "last_state_time": {}, + "last_config_ack_time": {}, + "last_config_send_time": {}, + "blocked": True, + "last_error_time": {}, + "last_error_status": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + "config": { + "version": 774, + "cloud_update_time": {}, + "device_ack_time": {}, + "binary_data": b"binary_data_blob", + }, + "state": {"update_time": {}, "binary_data": b"binary_data_blob"}, + "log_level": 10, + "metadata": {}, + "gateway_config": { + "gateway_type": 1, + "gateway_auth_method": 1, + "last_accessed_gateway_id": "last_accessed_gateway_id_value", + "last_accessed_gateway_time": {}, + }, + } + 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 = resources.Device( + id="id_value", + name="name_value", + num_id=636, + blocked=True, + log_level=resources.LogLevel.NONE, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = resources.Device.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_device(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.Device) + assert response.id == "id_value" + assert response.name == "name_value" + assert response.num_id == 636 + assert response.blocked is True + assert response.log_level == resources.LogLevel.NONE + + +def test_create_device_rest_required_fields( + request_type=device_manager.CreateDeviceRequest, +): + transport_class = transports.DeviceManagerRestTransport + + 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() + ).create_device._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_device._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 = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resources.Device() + # 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 = resources.Device.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_device(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_device_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_device._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "device", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_device_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_create_device" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_create_device" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.CreateDeviceRequest.pb( + device_manager.CreateDeviceRequest() + ) + 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 = resources.Device.to_json(resources.Device()) + + request = device_manager.CreateDeviceRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resources.Device() + + client.create_device( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_device_rest_bad_request( + transport: str = "rest", request_type=device_manager.CreateDeviceRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/registries/sample3"} + request_init["device"] = { + "id": "id_value", + "name": "name_value", + "num_id": 636, + "credentials": [ + { + "public_key": {"format": 3, "key": "key_value"}, + "expiration_time": {"seconds": 751, "nanos": 543}, + } + ], + "last_heartbeat_time": {}, + "last_event_time": {}, + "last_state_time": {}, + "last_config_ack_time": {}, + "last_config_send_time": {}, + "blocked": True, + "last_error_time": {}, + "last_error_status": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + "config": { + "version": 774, + "cloud_update_time": {}, + "device_ack_time": {}, + "binary_data": b"binary_data_blob", + }, + "state": {"update_time": {}, "binary_data": b"binary_data_blob"}, + "log_level": 10, + "metadata": {}, + "gateway_config": { + "gateway_type": 1, + "gateway_auth_method": 1, + "last_accessed_gateway_id": "last_accessed_gateway_id_value", + "last_accessed_gateway_time": {}, + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_device(request) + + +def test_create_device_rest_flattened(): + client = DeviceManagerClient( + 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 = resources.Device() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/registries/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + device=resources.Device(id="id_value"), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = resources.Device.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_device(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*/registries/*}/devices" + % client.transport._host, + args[1], + ) + + +def test_create_device_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_device( + device_manager.CreateDeviceRequest(), + parent="parent_value", + device=resources.Device(id="id_value"), + ) + + +def test_create_device_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + device_manager.GetDeviceRequest, + dict, + ], +) +def test_get_device_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = resources.Device( + id="id_value", + name="name_value", + num_id=636, + blocked=True, + log_level=resources.LogLevel.NONE, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = resources.Device.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_device(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.Device) + assert response.id == "id_value" + assert response.name == "name_value" + assert response.num_id == 636 + assert response.blocked is True + assert response.log_level == resources.LogLevel.NONE + + +def test_get_device_rest_required_fields(request_type=device_manager.GetDeviceRequest): + transport_class = transports.DeviceManagerRestTransport + + 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_device._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_device._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("field_mask",)) + 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 = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resources.Device() + # 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 = resources.Device.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_device(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_device_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_device._get_unset_required_fields({}) + assert set(unset_fields) == (set(("fieldMask",)) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_device_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_get_device" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_get_device" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.GetDeviceRequest.pb( + device_manager.GetDeviceRequest() + ) + 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 = resources.Device.to_json(resources.Device()) + + request = device_manager.GetDeviceRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resources.Device() + + client.get_device( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_device_rest_bad_request( + transport: str = "rest", request_type=device_manager.GetDeviceRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_device(request) + + +def test_get_device_rest_flattened(): + client = DeviceManagerClient( + 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 = resources.Device() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = resources.Device.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_device(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/registries/*/devices/*}" + % client.transport._host, + args[1], + ) + + +def test_get_device_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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_device( + device_manager.GetDeviceRequest(), + name="name_value", + ) + + +def test_get_device_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + device_manager.UpdateDeviceRequest, + dict, + ], +) +def test_update_device_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "device": { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + } + request_init["device"] = { + "id": "id_value", + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4", + "num_id": 636, + "credentials": [ + { + "public_key": {"format": 3, "key": "key_value"}, + "expiration_time": {"seconds": 751, "nanos": 543}, + } + ], + "last_heartbeat_time": {}, + "last_event_time": {}, + "last_state_time": {}, + "last_config_ack_time": {}, + "last_config_send_time": {}, + "blocked": True, + "last_error_time": {}, + "last_error_status": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + "config": { + "version": 774, + "cloud_update_time": {}, + "device_ack_time": {}, + "binary_data": b"binary_data_blob", + }, + "state": {"update_time": {}, "binary_data": b"binary_data_blob"}, + "log_level": 10, + "metadata": {}, + "gateway_config": { + "gateway_type": 1, + "gateway_auth_method": 1, + "last_accessed_gateway_id": "last_accessed_gateway_id_value", + "last_accessed_gateway_time": {}, + }, + } + 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 = resources.Device( + id="id_value", + name="name_value", + num_id=636, + blocked=True, + log_level=resources.LogLevel.NONE, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = resources.Device.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_device(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.Device) + assert response.id == "id_value" + assert response.name == "name_value" + assert response.num_id == 636 + assert response.blocked is True + assert response.log_level == resources.LogLevel.NONE + + +def test_update_device_rest_required_fields( + request_type=device_manager.UpdateDeviceRequest, +): + transport_class = transports.DeviceManagerRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_device._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_device._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 = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resources.Device() + # 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 = resources.Device.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_device(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_device_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_device._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("updateMask",)) + & set( + ( + "device", + "updateMask", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_device_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_update_device" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_update_device" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.UpdateDeviceRequest.pb( + device_manager.UpdateDeviceRequest() + ) + 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 = resources.Device.to_json(resources.Device()) + + request = device_manager.UpdateDeviceRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resources.Device() + + client.update_device( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_device_rest_bad_request( + transport: str = "rest", request_type=device_manager.UpdateDeviceRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "device": { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + } + request_init["device"] = { + "id": "id_value", + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4", + "num_id": 636, + "credentials": [ + { + "public_key": {"format": 3, "key": "key_value"}, + "expiration_time": {"seconds": 751, "nanos": 543}, + } + ], + "last_heartbeat_time": {}, + "last_event_time": {}, + "last_state_time": {}, + "last_config_ack_time": {}, + "last_config_send_time": {}, + "blocked": True, + "last_error_time": {}, + "last_error_status": { + "code": 411, + "message": "message_value", + "details": [ + { + "type_url": "type.googleapis.com/google.protobuf.Duration", + "value": b"\x08\x0c\x10\xdb\x07", + } + ], + }, + "config": { + "version": 774, + "cloud_update_time": {}, + "device_ack_time": {}, + "binary_data": b"binary_data_blob", + }, + "state": {"update_time": {}, "binary_data": b"binary_data_blob"}, + "log_level": 10, + "metadata": {}, + "gateway_config": { + "gateway_type": 1, + "gateway_auth_method": 1, + "last_accessed_gateway_id": "last_accessed_gateway_id_value", + "last_accessed_gateway_time": {}, + }, + } + 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_device(request) + + +def test_update_device_rest_flattened(): + client = DeviceManagerClient( + 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 = resources.Device() + + # get arguments that satisfy an http rule for this method + sample_request = { + "device": { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + } + + # get truthy value for each flattened field + mock_args = dict( + device=resources.Device(id="id_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 = resources.Device.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_device(**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/{device.name=projects/*/locations/*/registries/*/devices/*}" + % client.transport._host, + args[1], + ) + + +def test_update_device_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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_device( + device_manager.UpdateDeviceRequest(), + device=resources.Device(id="id_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_device_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + device_manager.DeleteDeviceRequest, + dict, + ], +) +def test_delete_device_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = 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_device(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_device_rest_required_fields( + request_type=device_manager.DeleteDeviceRequest, +): + transport_class = transports.DeviceManagerRestTransport + + 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_device._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_device._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 = DeviceManagerClient( + 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_device(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_device_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_device._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_device_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "pre_delete_device" + ) as pre: + pre.assert_not_called() + pb_message = device_manager.DeleteDeviceRequest.pb( + device_manager.DeleteDeviceRequest() + ) + 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 = device_manager.DeleteDeviceRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_device( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_device_rest_bad_request( + transport: str = "rest", request_type=device_manager.DeleteDeviceRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_device(request) + + +def test_delete_device_rest_flattened(): + client = DeviceManagerClient( + 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": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_device(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/registries/*/devices/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_device_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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_device( + device_manager.DeleteDeviceRequest(), + name="name_value", + ) + + +def test_delete_device_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + device_manager.ListDevicesRequest, + dict, + ], +) +def test_list_devices_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = device_manager.ListDevicesResponse( + 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 = device_manager.ListDevicesResponse.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_devices(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListDevicesPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_devices_rest_required_fields( + request_type=device_manager.ListDevicesRequest, +): + transport_class = transports.DeviceManagerRestTransport + + 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_devices._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_devices._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "device_ids", + "device_num_ids", + "field_mask", + "gateway_list_options", + "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 = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = device_manager.ListDevicesResponse() + # 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 = device_manager.ListDevicesResponse.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_devices(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_devices_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_devices._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "deviceIds", + "deviceNumIds", + "fieldMask", + "gatewayListOptions", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_devices_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_list_devices" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_list_devices" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.ListDevicesRequest.pb( + device_manager.ListDevicesRequest() + ) + 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 = device_manager.ListDevicesResponse.to_json( + device_manager.ListDevicesResponse() + ) + + request = device_manager.ListDevicesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = device_manager.ListDevicesResponse() + + client.list_devices( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_devices_rest_bad_request( + transport: str = "rest", request_type=device_manager.ListDevicesRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_devices(request) + + +def test_list_devices_rest_flattened(): + client = DeviceManagerClient( + 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 = device_manager.ListDevicesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/registries/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = device_manager.ListDevicesResponse.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_devices(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*/registries/*}/devices" + % client.transport._host, + args[1], + ) + + +def test_list_devices_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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_devices( + device_manager.ListDevicesRequest(), + parent="parent_value", + ) + + +def test_list_devices_rest_pager(transport: str = "rest"): + client = DeviceManagerClient( + 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 = ( + device_manager.ListDevicesResponse( + devices=[ + resources.Device(), + resources.Device(), + resources.Device(), + ], + next_page_token="abc", + ), + device_manager.ListDevicesResponse( + devices=[], + next_page_token="def", + ), + device_manager.ListDevicesResponse( + devices=[ + resources.Device(), + ], + next_page_token="ghi", + ), + device_manager.ListDevicesResponse( + devices=[ + resources.Device(), + resources.Device(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + device_manager.ListDevicesResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = { + "parent": "projects/sample1/locations/sample2/registries/sample3" + } + + pager = client.list_devices(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resources.Device) for i in results) + + pages = list(client.list_devices(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", + [ + device_manager.ModifyCloudToDeviceConfigRequest, + dict, + ], +) +def test_modify_cloud_to_device_config_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = resources.DeviceConfig( + version=774, + binary_data=b"binary_data_blob", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = resources.DeviceConfig.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.modify_cloud_to_device_config(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.DeviceConfig) + assert response.version == 774 + assert response.binary_data == b"binary_data_blob" + + +def test_modify_cloud_to_device_config_rest_required_fields( + request_type=device_manager.ModifyCloudToDeviceConfigRequest, +): + transport_class = transports.DeviceManagerRestTransport + + request_init = {} + request_init["name"] = "" + request_init["binary_data"] = b"" + 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() + ).modify_cloud_to_device_config._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + jsonified_request["binaryData"] = b"binary_data_blob" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).modify_cloud_to_device_config._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + assert "binaryData" in jsonified_request + assert jsonified_request["binaryData"] == b"binary_data_blob" + + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resources.DeviceConfig() + # 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 = resources.DeviceConfig.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.modify_cloud_to_device_config(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_modify_cloud_to_device_config_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.modify_cloud_to_device_config._get_unset_required_fields( + {} + ) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "binaryData", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_modify_cloud_to_device_config_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_modify_cloud_to_device_config" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_modify_cloud_to_device_config" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.ModifyCloudToDeviceConfigRequest.pb( + device_manager.ModifyCloudToDeviceConfigRequest() + ) + 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 = resources.DeviceConfig.to_json( + resources.DeviceConfig() + ) + + request = device_manager.ModifyCloudToDeviceConfigRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resources.DeviceConfig() + + client.modify_cloud_to_device_config( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_modify_cloud_to_device_config_rest_bad_request( + transport: str = "rest", + request_type=device_manager.ModifyCloudToDeviceConfigRequest, +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.modify_cloud_to_device_config(request) + + +def test_modify_cloud_to_device_config_rest_flattened(): + client = DeviceManagerClient( + 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 = resources.DeviceConfig() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + binary_data=b"binary_data_blob", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = resources.DeviceConfig.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.modify_cloud_to_device_config(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/registries/*/devices/*}:modifyCloudToDeviceConfig" + % client.transport._host, + args[1], + ) + + +def test_modify_cloud_to_device_config_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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.modify_cloud_to_device_config( + device_manager.ModifyCloudToDeviceConfigRequest(), + name="name_value", + binary_data=b"binary_data_blob", + ) + + +def test_modify_cloud_to_device_config_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + device_manager.ListDeviceConfigVersionsRequest, + dict, + ], +) +def test_list_device_config_versions_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = device_manager.ListDeviceConfigVersionsResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = device_manager.ListDeviceConfigVersionsResponse.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_device_config_versions(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, device_manager.ListDeviceConfigVersionsResponse) + + +def test_list_device_config_versions_rest_required_fields( + request_type=device_manager.ListDeviceConfigVersionsRequest, +): + transport_class = transports.DeviceManagerRestTransport + + 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() + ).list_device_config_versions._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() + ).list_device_config_versions._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("num_versions",)) + 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 = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = device_manager.ListDeviceConfigVersionsResponse() + # 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 = device_manager.ListDeviceConfigVersionsResponse.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_device_config_versions(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_device_config_versions_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_device_config_versions._get_unset_required_fields({}) + assert set(unset_fields) == (set(("numVersions",)) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_device_config_versions_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_list_device_config_versions" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_list_device_config_versions" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.ListDeviceConfigVersionsRequest.pb( + device_manager.ListDeviceConfigVersionsRequest() + ) + 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 = ( + device_manager.ListDeviceConfigVersionsResponse.to_json( + device_manager.ListDeviceConfigVersionsResponse() + ) + ) + + request = device_manager.ListDeviceConfigVersionsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = device_manager.ListDeviceConfigVersionsResponse() + + client.list_device_config_versions( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_device_config_versions_rest_bad_request( + transport: str = "rest", request_type=device_manager.ListDeviceConfigVersionsRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_device_config_versions(request) + + +def test_list_device_config_versions_rest_flattened(): + client = DeviceManagerClient( + 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 = device_manager.ListDeviceConfigVersionsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = device_manager.ListDeviceConfigVersionsResponse.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_device_config_versions(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/registries/*/devices/*}/configVersions" + % client.transport._host, + args[1], + ) + + +def test_list_device_config_versions_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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_device_config_versions( + device_manager.ListDeviceConfigVersionsRequest(), + name="name_value", + ) + + +def test_list_device_config_versions_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + device_manager.ListDeviceStatesRequest, + dict, + ], +) +def test_list_device_states_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = device_manager.ListDeviceStatesResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = device_manager.ListDeviceStatesResponse.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_device_states(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, device_manager.ListDeviceStatesResponse) + + +def test_list_device_states_rest_required_fields( + request_type=device_manager.ListDeviceStatesRequest, +): + transport_class = transports.DeviceManagerRestTransport + + 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() + ).list_device_states._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() + ).list_device_states._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("num_states",)) + 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 = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = device_manager.ListDeviceStatesResponse() + # 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 = device_manager.ListDeviceStatesResponse.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_device_states(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_device_states_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_device_states._get_unset_required_fields({}) + assert set(unset_fields) == (set(("numStates",)) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_device_states_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_list_device_states" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_list_device_states" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.ListDeviceStatesRequest.pb( + device_manager.ListDeviceStatesRequest() + ) + 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 = device_manager.ListDeviceStatesResponse.to_json( + device_manager.ListDeviceStatesResponse() + ) + + request = device_manager.ListDeviceStatesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = device_manager.ListDeviceStatesResponse() + + client.list_device_states( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_device_states_rest_bad_request( + transport: str = "rest", request_type=device_manager.ListDeviceStatesRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_device_states(request) + + +def test_list_device_states_rest_flattened(): + client = DeviceManagerClient( + 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 = device_manager.ListDeviceStatesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = device_manager.ListDeviceStatesResponse.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_device_states(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/registries/*/devices/*}/states" + % client.transport._host, + args[1], + ) + + +def test_list_device_states_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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_device_states( + device_manager.ListDeviceStatesRequest(), + name="name_value", + ) + + +def test_list_device_states_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + iam_policy_pb2.SetIamPolicyRequest, + dict, + ], +) +def test_set_iam_policy_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"resource": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy( + version=774, + etag=b"etag_blob", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = return_value + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.set_iam_policy(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b"etag_blob" + + +def test_set_iam_policy_rest_required_fields( + request_type=iam_policy_pb2.SetIamPolicyRequest, +): + transport_class = transports.DeviceManagerRestTransport + + request_init = {} + request_init["resource"] = "" + request = request_type(**request_init) + pb_request = 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() + ).set_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = "resource_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).set_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == "resource_value" + + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy() + # 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 + 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 = return_value + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.set_iam_policy(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_set_iam_policy_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.set_iam_policy._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "resource", + "policy", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_set_iam_policy_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_set_iam_policy" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_set_iam_policy" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = iam_policy_pb2.SetIamPolicyRequest() + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(policy_pb2.Policy()) + + request = iam_policy_pb2.SetIamPolicyRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = policy_pb2.Policy() + + client.set_iam_policy( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_set_iam_policy_rest_bad_request( + transport: str = "rest", request_type=iam_policy_pb2.SetIamPolicyRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"resource": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.set_iam_policy(request) + + +def test_set_iam_policy_rest_flattened(): + client = DeviceManagerClient( + 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 = policy_pb2.Policy() + + # get arguments that satisfy an http rule for this method + sample_request = { + "resource": "projects/sample1/locations/sample2/registries/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + resource="resource_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 = return_value + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.set_iam_policy(**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/{resource=projects/*/locations/*/registries/*}:setIamPolicy" + % client.transport._host, + args[1], + ) + + +def test_set_iam_policy_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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.set_iam_policy( + iam_policy_pb2.SetIamPolicyRequest(), + resource="resource_value", + ) + + +def test_set_iam_policy_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + iam_policy_pb2.GetIamPolicyRequest, + dict, + ], +) +def test_get_iam_policy_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"resource": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy( + version=774, + etag=b"etag_blob", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = 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_iam_policy(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, policy_pb2.Policy) + assert response.version == 774 + assert response.etag == b"etag_blob" + + +def test_get_iam_policy_rest_required_fields( + request_type=iam_policy_pb2.GetIamPolicyRequest, +): + transport_class = transports.DeviceManagerRestTransport + + request_init = {} + request_init["resource"] = "" + request = request_type(**request_init) + pb_request = 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_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = "resource_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_iam_policy._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == "resource_value" + + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = policy_pb2.Policy() + # 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 + 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 = 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_iam_policy(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_iam_policy_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_iam_policy._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("resource",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_iam_policy_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_get_iam_policy" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_get_iam_policy" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = iam_policy_pb2.GetIamPolicyRequest() + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(policy_pb2.Policy()) + + request = iam_policy_pb2.GetIamPolicyRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = policy_pb2.Policy() + + client.get_iam_policy( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_iam_policy_rest_bad_request( + transport: str = "rest", request_type=iam_policy_pb2.GetIamPolicyRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"resource": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_iam_policy(request) + + +def test_get_iam_policy_rest_flattened(): + client = DeviceManagerClient( + 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 = policy_pb2.Policy() + + # get arguments that satisfy an http rule for this method + sample_request = { + "resource": "projects/sample1/locations/sample2/registries/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + resource="resource_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 = 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_iam_policy(**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/{resource=projects/*/locations/*/registries/*}:getIamPolicy" + % client.transport._host, + args[1], + ) + + +def test_get_iam_policy_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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_iam_policy( + iam_policy_pb2.GetIamPolicyRequest(), + resource="resource_value", + ) + + +def test_get_iam_policy_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + iam_policy_pb2.TestIamPermissionsRequest, + dict, + ], +) +def test_test_iam_permissions_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"resource": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = iam_policy_pb2.TestIamPermissionsResponse( + permissions=["permissions_value"], + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = 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.test_iam_permissions(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, iam_policy_pb2.TestIamPermissionsResponse) + assert response.permissions == ["permissions_value"] + + +def test_test_iam_permissions_rest_required_fields( + request_type=iam_policy_pb2.TestIamPermissionsRequest, +): + transport_class = transports.DeviceManagerRestTransport + + request_init = {} + request_init["resource"] = "" + request_init["permissions"] = "" + request = request_type(**request_init) + pb_request = 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() + ).test_iam_permissions._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["resource"] = "resource_value" + jsonified_request["permissions"] = "permissions_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).test_iam_permissions._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "resource" in jsonified_request + assert jsonified_request["resource"] == "resource_value" + assert "permissions" in jsonified_request + assert jsonified_request["permissions"] == "permissions_value" + + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = iam_policy_pb2.TestIamPermissionsResponse() + # 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 + 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 = 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.test_iam_permissions(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_test_iam_permissions_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.test_iam_permissions._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "resource", + "permissions", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_test_iam_permissions_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_test_iam_permissions" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_test_iam_permissions" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = iam_policy_pb2.TestIamPermissionsRequest() + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + iam_policy_pb2.TestIamPermissionsResponse() + ) + + request = iam_policy_pb2.TestIamPermissionsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = iam_policy_pb2.TestIamPermissionsResponse() + + client.test_iam_permissions( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_test_iam_permissions_rest_bad_request( + transport: str = "rest", request_type=iam_policy_pb2.TestIamPermissionsRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"resource": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.test_iam_permissions(request) + + +def test_test_iam_permissions_rest_flattened(): + client = DeviceManagerClient( + 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 = iam_policy_pb2.TestIamPermissionsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "resource": "projects/sample1/locations/sample2/registries/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + resource="resource_value", + permissions=["permissions_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 = 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.test_iam_permissions(**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/{resource=projects/*/locations/*/registries/*}:testIamPermissions" + % client.transport._host, + args[1], + ) + + +def test_test_iam_permissions_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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.test_iam_permissions( + iam_policy_pb2.TestIamPermissionsRequest(), + resource="resource_value", + permissions=["permissions_value"], + ) + + +def test_test_iam_permissions_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + device_manager.SendCommandToDeviceRequest, + dict, + ], +) +def test_send_command_to_device_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = device_manager.SendCommandToDeviceResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = device_manager.SendCommandToDeviceResponse.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.send_command_to_device(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, device_manager.SendCommandToDeviceResponse) + + +def test_send_command_to_device_rest_required_fields( + request_type=device_manager.SendCommandToDeviceRequest, +): + transport_class = transports.DeviceManagerRestTransport + + request_init = {} + request_init["name"] = "" + request_init["binary_data"] = b"" + 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() + ).send_command_to_device._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + jsonified_request["binaryData"] = b"binary_data_blob" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).send_command_to_device._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + assert "binaryData" in jsonified_request + assert jsonified_request["binaryData"] == b"binary_data_blob" + + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = device_manager.SendCommandToDeviceResponse() + # 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 = device_manager.SendCommandToDeviceResponse.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.send_command_to_device(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_send_command_to_device_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.send_command_to_device._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "binaryData", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_send_command_to_device_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_send_command_to_device" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_send_command_to_device" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.SendCommandToDeviceRequest.pb( + device_manager.SendCommandToDeviceRequest() + ) + 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 = device_manager.SendCommandToDeviceResponse.to_json( + device_manager.SendCommandToDeviceResponse() + ) + + request = device_manager.SendCommandToDeviceRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = device_manager.SendCommandToDeviceResponse() + + client.send_command_to_device( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_send_command_to_device_rest_bad_request( + transport: str = "rest", request_type=device_manager.SendCommandToDeviceRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.send_command_to_device(request) + + +def test_send_command_to_device_rest_flattened(): + client = DeviceManagerClient( + 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 = device_manager.SendCommandToDeviceResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/registries/sample3/devices/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + binary_data=b"binary_data_blob", + subfolder="subfolder_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 = device_manager.SendCommandToDeviceResponse.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.send_command_to_device(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{name=projects/*/locations/*/registries/*/devices/*}:sendCommandToDevice" + % client.transport._host, + args[1], + ) + + +def test_send_command_to_device_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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.send_command_to_device( + device_manager.SendCommandToDeviceRequest(), + name="name_value", + binary_data=b"binary_data_blob", + subfolder="subfolder_value", + ) + + +def test_send_command_to_device_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + device_manager.BindDeviceToGatewayRequest, + dict, + ], +) +def test_bind_device_to_gateway_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = device_manager.BindDeviceToGatewayResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = device_manager.BindDeviceToGatewayResponse.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.bind_device_to_gateway(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, device_manager.BindDeviceToGatewayResponse) + + +def test_bind_device_to_gateway_rest_required_fields( + request_type=device_manager.BindDeviceToGatewayRequest, +): + transport_class = transports.DeviceManagerRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["gateway_id"] = "" + request_init["device_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).bind_device_to_gateway._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" + jsonified_request["gatewayId"] = "gateway_id_value" + jsonified_request["deviceId"] = "device_id_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).bind_device_to_gateway._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" + assert "gatewayId" in jsonified_request + assert jsonified_request["gatewayId"] == "gateway_id_value" + assert "deviceId" in jsonified_request + assert jsonified_request["deviceId"] == "device_id_value" + + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = device_manager.BindDeviceToGatewayResponse() + # 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 = device_manager.BindDeviceToGatewayResponse.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.bind_device_to_gateway(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_bind_device_to_gateway_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.bind_device_to_gateway._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "gatewayId", + "deviceId", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_bind_device_to_gateway_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_bind_device_to_gateway" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_bind_device_to_gateway" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.BindDeviceToGatewayRequest.pb( + device_manager.BindDeviceToGatewayRequest() + ) + 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 = device_manager.BindDeviceToGatewayResponse.to_json( + device_manager.BindDeviceToGatewayResponse() + ) + + request = device_manager.BindDeviceToGatewayRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = device_manager.BindDeviceToGatewayResponse() + + client.bind_device_to_gateway( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_bind_device_to_gateway_rest_bad_request( + transport: str = "rest", request_type=device_manager.BindDeviceToGatewayRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.bind_device_to_gateway(request) + + +def test_bind_device_to_gateway_rest_flattened(): + client = DeviceManagerClient( + 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 = device_manager.BindDeviceToGatewayResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/registries/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + gateway_id="gateway_id_value", + device_id="device_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = device_manager.BindDeviceToGatewayResponse.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.bind_device_to_gateway(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*/registries/*}:bindDeviceToGateway" + % client.transport._host, + args[1], + ) + + +def test_bind_device_to_gateway_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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.bind_device_to_gateway( + device_manager.BindDeviceToGatewayRequest(), + parent="parent_value", + gateway_id="gateway_id_value", + device_id="device_id_value", + ) + + +def test_bind_device_to_gateway_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + device_manager.UnbindDeviceFromGatewayRequest, + dict, + ], +) +def test_unbind_device_from_gateway_rest(request_type): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = device_manager.UnbindDeviceFromGatewayResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = device_manager.UnbindDeviceFromGatewayResponse.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.unbind_device_from_gateway(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, device_manager.UnbindDeviceFromGatewayResponse) + + +def test_unbind_device_from_gateway_rest_required_fields( + request_type=device_manager.UnbindDeviceFromGatewayRequest, +): + transport_class = transports.DeviceManagerRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["gateway_id"] = "" + request_init["device_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).unbind_device_from_gateway._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" + jsonified_request["gatewayId"] = "gateway_id_value" + jsonified_request["deviceId"] = "device_id_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).unbind_device_from_gateway._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" + assert "gatewayId" in jsonified_request + assert jsonified_request["gatewayId"] == "gateway_id_value" + assert "deviceId" in jsonified_request + assert jsonified_request["deviceId"] == "device_id_value" + + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = device_manager.UnbindDeviceFromGatewayResponse() + # 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 = device_manager.UnbindDeviceFromGatewayResponse.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.unbind_device_from_gateway(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_unbind_device_from_gateway_rest_unset_required_fields(): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.unbind_device_from_gateway._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "gatewayId", + "deviceId", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_unbind_device_from_gateway_rest_interceptors(null_interceptor): + transport = transports.DeviceManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.DeviceManagerRestInterceptor(), + ) + client = DeviceManagerClient(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.DeviceManagerRestInterceptor, "post_unbind_device_from_gateway" + ) as post, mock.patch.object( + transports.DeviceManagerRestInterceptor, "pre_unbind_device_from_gateway" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = device_manager.UnbindDeviceFromGatewayRequest.pb( + device_manager.UnbindDeviceFromGatewayRequest() + ) + 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 = ( + device_manager.UnbindDeviceFromGatewayResponse.to_json( + device_manager.UnbindDeviceFromGatewayResponse() + ) + ) + + request = device_manager.UnbindDeviceFromGatewayRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = device_manager.UnbindDeviceFromGatewayResponse() + + client.unbind_device_from_gateway( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_unbind_device_from_gateway_rest_bad_request( + transport: str = "rest", request_type=device_manager.UnbindDeviceFromGatewayRequest +): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/registries/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.unbind_device_from_gateway(request) + + +def test_unbind_device_from_gateway_rest_flattened(): + client = DeviceManagerClient( + 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 = device_manager.UnbindDeviceFromGatewayResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/registries/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + gateway_id="gateway_id_value", + device_id="device_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = device_manager.UnbindDeviceFromGatewayResponse.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.unbind_device_from_gateway(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1/{parent=projects/*/locations/*/registries/*}:unbindDeviceFromGateway" + % client.transport._host, + args[1], + ) + + +def test_unbind_device_from_gateway_rest_flattened_error(transport: str = "rest"): + client = DeviceManagerClient( + 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.unbind_device_from_gateway( + device_manager.UnbindDeviceFromGatewayRequest(), + parent="parent_value", + gateway_id="gateway_id_value", + device_id="device_id_value", + ) + + +def test_unbind_device_from_gateway_rest_error(): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.DeviceManagerGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.DeviceManagerGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = DeviceManagerClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.DeviceManagerGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = DeviceManagerClient( + 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 = DeviceManagerClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.DeviceManagerGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = DeviceManagerClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.DeviceManagerGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = DeviceManagerClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.DeviceManagerGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.DeviceManagerGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.DeviceManagerGrpcTransport, + transports.DeviceManagerGrpcAsyncIOTransport, + transports.DeviceManagerRestTransport, + ], +) +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 = DeviceManagerClient.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 = DeviceManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.DeviceManagerGrpcTransport, + ) + + +def test_device_manager_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.DeviceManagerTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_device_manager_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.iot_v1.services.device_manager.transports.DeviceManagerTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.DeviceManagerTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. methods = ( "create_device_registry", "get_device_registry", @@ -6097,6 +11882,7 @@ def test_device_manager_transport_auth_adc(transport_class): [ transports.DeviceManagerGrpcTransport, transports.DeviceManagerGrpcAsyncIOTransport, + transports.DeviceManagerRestTransport, ], ) def test_device_manager_transport_auth_gdch_credentials(transport_class): @@ -6197,11 +11983,23 @@ def test_device_manager_grpc_transport_client_cert_source_for_mtls(transport_cla ) +def test_device_manager_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.DeviceManagerRestTransport( + 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_device_manager_host_no_port(transport_name): @@ -6212,7 +12010,11 @@ def test_device_manager_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("cloudiot.googleapis.com:443") + assert client.transport._host == ( + "cloudiot.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudiot.googleapis.com" + ) @pytest.mark.parametrize( @@ -6220,6 +12022,7 @@ def test_device_manager_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_device_manager_host_with_port(transport_name): @@ -6230,7 +12033,87 @@ def test_device_manager_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("cloudiot.googleapis.com:8000") + assert client.transport._host == ( + "cloudiot.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudiot.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_device_manager_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = DeviceManagerClient( + credentials=creds1, + transport=transport_name, + ) + client2 = DeviceManagerClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_device_registry._session + session2 = client2.transport.create_device_registry._session + assert session1 != session2 + session1 = client1.transport.get_device_registry._session + session2 = client2.transport.get_device_registry._session + assert session1 != session2 + session1 = client1.transport.update_device_registry._session + session2 = client2.transport.update_device_registry._session + assert session1 != session2 + session1 = client1.transport.delete_device_registry._session + session2 = client2.transport.delete_device_registry._session + assert session1 != session2 + session1 = client1.transport.list_device_registries._session + session2 = client2.transport.list_device_registries._session + assert session1 != session2 + session1 = client1.transport.create_device._session + session2 = client2.transport.create_device._session + assert session1 != session2 + session1 = client1.transport.get_device._session + session2 = client2.transport.get_device._session + assert session1 != session2 + session1 = client1.transport.update_device._session + session2 = client2.transport.update_device._session + assert session1 != session2 + session1 = client1.transport.delete_device._session + session2 = client2.transport.delete_device._session + assert session1 != session2 + session1 = client1.transport.list_devices._session + session2 = client2.transport.list_devices._session + assert session1 != session2 + session1 = client1.transport.modify_cloud_to_device_config._session + session2 = client2.transport.modify_cloud_to_device_config._session + assert session1 != session2 + session1 = client1.transport.list_device_config_versions._session + session2 = client2.transport.list_device_config_versions._session + assert session1 != session2 + session1 = client1.transport.list_device_states._session + session2 = client2.transport.list_device_states._session + assert session1 != session2 + session1 = client1.transport.set_iam_policy._session + session2 = client2.transport.set_iam_policy._session + assert session1 != session2 + session1 = client1.transport.get_iam_policy._session + session2 = client2.transport.get_iam_policy._session + assert session1 != session2 + session1 = client1.transport.test_iam_permissions._session + session2 = client2.transport.test_iam_permissions._session + assert session1 != session2 + session1 = client1.transport.send_command_to_device._session + session2 = client2.transport.send_command_to_device._session + assert session1 != session2 + session1 = client1.transport.bind_device_to_gateway._session + session2 = client2.transport.bind_device_to_gateway._session + assert session1 != session2 + session1 = client1.transport.unbind_device_from_gateway._session + session2 = client2.transport.unbind_device_from_gateway._session + assert session1 != session2 def test_device_manager_grpc_transport_channel(): @@ -6554,6 +12437,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -6571,6 +12455,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: