From 22a912bddc5dda042c7fd4ed11ba1c864fa0cca0 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 25 Jan 2023 11:54:50 -0500 Subject: [PATCH 1/6] chore: Update gapic-generator-python to v1.8.2 (#251) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore: Update gapic-generator-python to v1.8.2 PiperOrigin-RevId: 504289125 Source-Link: https://github.com/googleapis/googleapis/commit/38a48a44a44279e9cf9f2f864b588958a2d87491 Source-Link: https://github.com/googleapis/googleapis-gen/commit/b2dc22663dbe47a972c8d8c2f8a4df013dafdcbc Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJkYzIyNjYzZGJlNDdhOTcyYzhkOGMyZjhhNGRmMDEzZGFmZGNiYyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot --- .coveragerc | 1 + google/cloud/webrisk_v1/__init__.py | 2 +- google/cloud/webrisk_v1beta1/__init__.py | 2 +- .../snippet_metadata_google.cloud.webrisk.v1.json | 2 +- .../snippet_metadata_google.cloud.webrisk.v1beta1.json | 2 +- 5 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.coveragerc b/.coveragerc index 76e052e..87a6982 100644 --- a/.coveragerc +++ b/.coveragerc @@ -5,6 +5,7 @@ branch = True show_missing = True omit = google/cloud/webrisk/__init__.py + google/cloud/webrisk/gapic_version.py exclude_lines = # Re-enable the standard pragma pragma: NO COVER diff --git a/google/cloud/webrisk_v1/__init__.py b/google/cloud/webrisk_v1/__init__.py index 50c72b1..d69c703 100644 --- a/google/cloud/webrisk_v1/__init__.py +++ b/google/cloud/webrisk_v1/__init__.py @@ -13,7 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -from google.cloud.webrisk import gapic_version as package_version +from google.cloud.webrisk_v1 import gapic_version as package_version __version__ = package_version.__version__ diff --git a/google/cloud/webrisk_v1beta1/__init__.py b/google/cloud/webrisk_v1beta1/__init__.py index 73de02d..d5a20d9 100644 --- a/google/cloud/webrisk_v1beta1/__init__.py +++ b/google/cloud/webrisk_v1beta1/__init__.py @@ -13,7 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -from google.cloud.webrisk import gapic_version as package_version +from google.cloud.webrisk_v1beta1 import gapic_version as package_version __version__ = package_version.__version__ diff --git a/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1.json b/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1.json index 9222b07..60eac29 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-webrisk", - "version": "1.10.1" + "version": "0.1.0" }, "snippets": [ { diff --git a/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1beta1.json b/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1beta1.json index 62ad44e..de1e97a 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1beta1.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1beta1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-webrisk", - "version": "1.10.1" + "version": "0.1.0" }, "snippets": [ { From 45ea311ae714942c154bca7914de978bbe1d2ac0 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Mon, 30 Jan 2023 16:52:18 +0000 Subject: [PATCH 2/6] chore: fix prerelease_deps nox session [autoapprove] (#252) Source-Link: https://togithub.com/googleapis/synthtool/commit/26c7505b2f76981ec1707b851e1595c8c06e90fc Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:f946c75373c2b0040e8e318c5e85d0cf46bc6e61d0a01f3ef94d8de974ac6790 --- .github/.OwlBot.lock.yaml | 2 +- noxfile.py | 14 ++++++-------- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml index 889f77d..f0f3b24 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:f946c75373c2b0040e8e318c5e85d0cf46bc6e61d0a01f3ef94d8de974ac6790 diff --git a/noxfile.py b/noxfile.py index e716318..95e58c5 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", From 3bdaea727c0cd2289b00a83a78e87c94d1e00e4b Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 7 Feb 2023 15:06:30 -0500 Subject: [PATCH 3/6] chore: Update gapic-generator-python to v1.8.4 (#253) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore: Update gapic-generator-python to v1.8.4 PiperOrigin-RevId: 507808936 Source-Link: https://github.com/googleapis/googleapis/commit/64cf8492b21778ce62c66ecee81b468a293bfd4c Source-Link: https://github.com/googleapis/googleapis-gen/commit/53c48cac153d3b37f3d2c2dec4830cfd91ec4153 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNTNjNDhjYWMxNTNkM2IzN2YzZDJjMmRlYzQ4MzBjZmQ5MWVjNDE1MyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot --- setup.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/setup.py b/setup.py index 39d1d5d..92479ed 100644 --- a/setup.py +++ b/setup.py @@ -55,9 +55,7 @@ if package.startswith("google") ] -namespaces = ["google"] -if "google.cloud" in packages: - namespaces.append("google.cloud") +namespaces = ["google", "google.cloud"] setuptools.setup( name=name, From 53ef7fdaf9f1db590eb1645891e79e5f1f3b84b3 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 8 Feb 2023 15:10:24 +0000 Subject: [PATCH 4/6] build(deps): bump cryptography from 38.0.3 to 39.0.1 in /synthtool/gcp/templates/python_library/.kokoro (#255) Source-Link: https://togithub.com/googleapis/synthtool/commit/bb171351c3946d3c3c32e60f5f18cee8c464ec51 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:f62c53736eccb0c4934a3ea9316e0d57696bb49c1a7c86c726e9bb8a2f87dadf --- .github/.OwlBot.lock.yaml | 2 +- .kokoro/requirements.txt | 49 ++++++++++++++++++--------------------- 2 files changed, 23 insertions(+), 28 deletions(-) diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml index f0f3b24..894fb6b 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:f946c75373c2b0040e8e318c5e85d0cf46bc6e61d0a01f3ef94d8de974ac6790 + digest: sha256:f62c53736eccb0c4934a3ea9316e0d57696bb49c1a7c86c726e9bb8a2f87dadf diff --git a/.kokoro/requirements.txt b/.kokoro/requirements.txt index 05dc467..096e480 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 From 0bc759d1ecff83656a08f8ea11e0712b8522cc7c Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 9 Feb 2023 14:26:37 -0500 Subject: [PATCH 5/6] feat: enable "rest" transport in Python for services supporting numeric enums (#256) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: enable "rest" transport in Python for services supporting numeric enums PiperOrigin-RevId: 508143576 Source-Link: https://github.com/googleapis/googleapis/commit/7a702a989db3b413f39ff8994ca53fb38b6928c2 Source-Link: https://github.com/googleapis/googleapis-gen/commit/6ad1279c0e7aa787ac6b66c9fd4a210692edffcd Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNmFkMTI3OWMwZTdhYTc4N2FjNmI2NmM5ZmQ0YTIxMDY5MmVkZmZjZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot --- google/cloud/webrisk_v1/gapic_metadata.json | 25 + .../services/web_risk_service/client.py | 2 + .../web_risk_service/transports/__init__.py | 4 + .../web_risk_service/transports/rest.py | 705 ++++++++++ .../cloud/webrisk_v1beta1/gapic_metadata.json | 20 + .../web_risk_service_v1_beta1/client.py | 2 + .../transports/__init__.py | 7 + .../transports/rest.py | 565 ++++++++ .../gapic/webrisk_v1/test_web_risk_service.py | 1221 ++++++++++++++++- .../test_web_risk_service_v1_beta1.py | 964 ++++++++++++- 10 files changed, 3507 insertions(+), 8 deletions(-) create mode 100644 google/cloud/webrisk_v1/services/web_risk_service/transports/rest.py create mode 100644 google/cloud/webrisk_v1beta1/services/web_risk_service_v1_beta1/transports/rest.py diff --git a/google/cloud/webrisk_v1/gapic_metadata.json b/google/cloud/webrisk_v1/gapic_metadata.json index fc56236..8a1f2eb 100644 --- a/google/cloud/webrisk_v1/gapic_metadata.json +++ b/google/cloud/webrisk_v1/gapic_metadata.json @@ -56,6 +56,31 @@ ] } } + }, + "rest": { + "libraryClient": "WebRiskServiceClient", + "rpcs": { + "ComputeThreatListDiff": { + "methods": [ + "compute_threat_list_diff" + ] + }, + "CreateSubmission": { + "methods": [ + "create_submission" + ] + }, + "SearchHashes": { + "methods": [ + "search_hashes" + ] + }, + "SearchUris": { + "methods": [ + "search_uris" + ] + } + } } } } diff --git a/google/cloud/webrisk_v1/services/web_risk_service/client.py b/google/cloud/webrisk_v1/services/web_risk_service/client.py index abc41ad..2b6e712 100644 --- a/google/cloud/webrisk_v1/services/web_risk_service/client.py +++ b/google/cloud/webrisk_v1/services/web_risk_service/client.py @@ -53,6 +53,7 @@ from .transports.base import DEFAULT_CLIENT_INFO, WebRiskServiceTransport from .transports.grpc import WebRiskServiceGrpcTransport from .transports.grpc_asyncio import WebRiskServiceGrpcAsyncIOTransport +from .transports.rest import WebRiskServiceRestTransport class WebRiskServiceClientMeta(type): @@ -68,6 +69,7 @@ class WebRiskServiceClientMeta(type): ) # type: Dict[str, Type[WebRiskServiceTransport]] _transport_registry["grpc"] = WebRiskServiceGrpcTransport _transport_registry["grpc_asyncio"] = WebRiskServiceGrpcAsyncIOTransport + _transport_registry["rest"] = WebRiskServiceRestTransport def get_transport_class( cls, diff --git a/google/cloud/webrisk_v1/services/web_risk_service/transports/__init__.py b/google/cloud/webrisk_v1/services/web_risk_service/transports/__init__.py index 0ba92ea..8f54ae9 100644 --- a/google/cloud/webrisk_v1/services/web_risk_service/transports/__init__.py +++ b/google/cloud/webrisk_v1/services/web_risk_service/transports/__init__.py @@ -19,14 +19,18 @@ from .base import WebRiskServiceTransport from .grpc import WebRiskServiceGrpcTransport from .grpc_asyncio import WebRiskServiceGrpcAsyncIOTransport +from .rest import WebRiskServiceRestInterceptor, WebRiskServiceRestTransport # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[WebRiskServiceTransport]] _transport_registry["grpc"] = WebRiskServiceGrpcTransport _transport_registry["grpc_asyncio"] = WebRiskServiceGrpcAsyncIOTransport +_transport_registry["rest"] = WebRiskServiceRestTransport __all__ = ( "WebRiskServiceTransport", "WebRiskServiceGrpcTransport", "WebRiskServiceGrpcAsyncIOTransport", + "WebRiskServiceRestTransport", + "WebRiskServiceRestInterceptor", ) diff --git a/google/cloud/webrisk_v1/services/web_risk_service/transports/rest.py b/google/cloud/webrisk_v1/services/web_risk_service/transports/rest.py new file mode 100644 index 0000000..35ef297 --- /dev/null +++ b/google/cloud/webrisk_v1/services/web_risk_service/transports/rest.py @@ -0,0 +1,705 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import dataclasses +import json # type: ignore +import re +from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, path_template, rest_helpers, rest_streaming +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore +from google.protobuf import json_format +import grpc # type: ignore +from requests import __version__ as requests_version + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.webrisk_v1.types import webrisk + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .base import WebRiskServiceTransport + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class WebRiskServiceRestInterceptor: + """Interceptor for WebRiskService. + + 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 WebRiskServiceRestTransport. + + .. code-block:: python + class MyCustomWebRiskServiceInterceptor(WebRiskServiceRestInterceptor): + def pre_compute_threat_list_diff(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_compute_threat_list_diff(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_create_submission(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_submission(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_search_hashes(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_search_hashes(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_search_uris(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_search_uris(self, response): + logging.log(f"Received response: {response}") + return response + + transport = WebRiskServiceRestTransport(interceptor=MyCustomWebRiskServiceInterceptor()) + client = WebRiskServiceClient(transport=transport) + + + """ + + def pre_compute_threat_list_diff( + self, + request: webrisk.ComputeThreatListDiffRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[webrisk.ComputeThreatListDiffRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for compute_threat_list_diff + + Override in a subclass to manipulate the request or metadata + before they are sent to the WebRiskService server. + """ + return request, metadata + + def post_compute_threat_list_diff( + self, response: webrisk.ComputeThreatListDiffResponse + ) -> webrisk.ComputeThreatListDiffResponse: + """Post-rpc interceptor for compute_threat_list_diff + + Override in a subclass to manipulate the response + after it is returned by the WebRiskService server but before + it is returned to user code. + """ + return response + + def pre_create_submission( + self, + request: webrisk.CreateSubmissionRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[webrisk.CreateSubmissionRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_submission + + Override in a subclass to manipulate the request or metadata + before they are sent to the WebRiskService server. + """ + return request, metadata + + def post_create_submission( + self, response: webrisk.Submission + ) -> webrisk.Submission: + """Post-rpc interceptor for create_submission + + Override in a subclass to manipulate the response + after it is returned by the WebRiskService server but before + it is returned to user code. + """ + return response + + def pre_search_hashes( + self, request: webrisk.SearchHashesRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[webrisk.SearchHashesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for search_hashes + + Override in a subclass to manipulate the request or metadata + before they are sent to the WebRiskService server. + """ + return request, metadata + + def post_search_hashes( + self, response: webrisk.SearchHashesResponse + ) -> webrisk.SearchHashesResponse: + """Post-rpc interceptor for search_hashes + + Override in a subclass to manipulate the response + after it is returned by the WebRiskService server but before + it is returned to user code. + """ + return response + + def pre_search_uris( + self, request: webrisk.SearchUrisRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[webrisk.SearchUrisRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for search_uris + + Override in a subclass to manipulate the request or metadata + before they are sent to the WebRiskService server. + """ + return request, metadata + + def post_search_uris( + self, response: webrisk.SearchUrisResponse + ) -> webrisk.SearchUrisResponse: + """Post-rpc interceptor for search_uris + + Override in a subclass to manipulate the response + after it is returned by the WebRiskService server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class WebRiskServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: WebRiskServiceRestInterceptor + + +class WebRiskServiceRestTransport(WebRiskServiceTransport): + """REST backend transport for WebRiskService. + + Web Risk API defines an interface to detect malicious URLs on + your website and in client applications. + + 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 = "webrisk.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[WebRiskServiceRestInterceptor] = 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 WebRiskServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _ComputeThreatListDiff(WebRiskServiceRestStub): + def __hash__(self): + return hash("ComputeThreatListDiff") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "threatType": {}, + "constraints": {}, + } + + @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: webrisk.ComputeThreatListDiffRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> webrisk.ComputeThreatListDiffResponse: + r"""Call the compute threat list diff method over HTTP. + + Args: + request (~.webrisk.ComputeThreatListDiffRequest): + The request object. Describes an API diff request. + 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: + ~.webrisk.ComputeThreatListDiffResponse: + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/threatLists:computeDiff", + }, + ] + request, metadata = self._interceptor.pre_compute_threat_list_diff( + request, metadata + ) + pb_request = webrisk.ComputeThreatListDiffRequest.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 = webrisk.ComputeThreatListDiffResponse() + pb_resp = webrisk.ComputeThreatListDiffResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_compute_threat_list_diff(resp) + return resp + + class _CreateSubmission(WebRiskServiceRestStub): + def __hash__(self): + return hash("CreateSubmission") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: webrisk.CreateSubmissionRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> webrisk.Submission: + r"""Call the create submission method over HTTP. + + Args: + request (~.webrisk.CreateSubmissionRequest): + The request object. Request to send a potentially phishy + URI to WebRisk. + + 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: + ~.webrisk.Submission: + Wraps a URI that might be displaying + malicious content. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{parent=projects/*}/submissions", + "body": "submission", + }, + ] + request, metadata = self._interceptor.pre_create_submission( + request, metadata + ) + pb_request = webrisk.CreateSubmissionRequest.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 = webrisk.Submission() + pb_resp = webrisk.Submission.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_submission(resp) + return resp + + class _SearchHashes(WebRiskServiceRestStub): + def __hash__(self): + return hash("SearchHashes") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "threatTypes": {}, + } + + @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: webrisk.SearchHashesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> webrisk.SearchHashesResponse: + r"""Call the search hashes method over HTTP. + + Args: + request (~.webrisk.SearchHashesRequest): + The request object. Request to return full hashes matched + by the provided hash prefixes. + + 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: + ~.webrisk.SearchHashesResponse: + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/hashes:search", + }, + ] + request, metadata = self._interceptor.pre_search_hashes(request, metadata) + pb_request = webrisk.SearchHashesRequest.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 = webrisk.SearchHashesResponse() + pb_resp = webrisk.SearchHashesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_search_hashes(resp) + return resp + + class _SearchUris(WebRiskServiceRestStub): + def __hash__(self): + return hash("SearchUris") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "uri": "", + "threatTypes": {}, + } + + @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: webrisk.SearchUrisRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> webrisk.SearchUrisResponse: + r"""Call the search uris method over HTTP. + + Args: + request (~.webrisk.SearchUrisRequest): + The request object. Request to check URI entries against + threatLists. + + 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: + ~.webrisk.SearchUrisResponse: + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/uris:search", + }, + ] + request, metadata = self._interceptor.pre_search_uris(request, metadata) + pb_request = webrisk.SearchUrisRequest.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 = webrisk.SearchUrisResponse() + pb_resp = webrisk.SearchUrisResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_search_uris(resp) + return resp + + @property + def compute_threat_list_diff( + self, + ) -> Callable[ + [webrisk.ComputeThreatListDiffRequest], webrisk.ComputeThreatListDiffResponse + ]: + # 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._ComputeThreatListDiff(self._session, self._host, self._interceptor) # type: ignore + + @property + def create_submission( + self, + ) -> Callable[[webrisk.CreateSubmissionRequest], webrisk.Submission]: + # 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._CreateSubmission(self._session, self._host, self._interceptor) # type: ignore + + @property + def search_hashes( + self, + ) -> Callable[[webrisk.SearchHashesRequest], webrisk.SearchHashesResponse]: + # 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._SearchHashes(self._session, self._host, self._interceptor) # type: ignore + + @property + def search_uris( + self, + ) -> Callable[[webrisk.SearchUrisRequest], webrisk.SearchUrisResponse]: + # 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._SearchUris(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("WebRiskServiceRestTransport",) diff --git a/google/cloud/webrisk_v1beta1/gapic_metadata.json b/google/cloud/webrisk_v1beta1/gapic_metadata.json index 64df094..e8ee3d3 100644 --- a/google/cloud/webrisk_v1beta1/gapic_metadata.json +++ b/google/cloud/webrisk_v1beta1/gapic_metadata.json @@ -46,6 +46,26 @@ ] } } + }, + "rest": { + "libraryClient": "WebRiskServiceV1Beta1Client", + "rpcs": { + "ComputeThreatListDiff": { + "methods": [ + "compute_threat_list_diff" + ] + }, + "SearchHashes": { + "methods": [ + "search_hashes" + ] + }, + "SearchUris": { + "methods": [ + "search_uris" + ] + } + } } } } diff --git a/google/cloud/webrisk_v1beta1/services/web_risk_service_v1_beta1/client.py b/google/cloud/webrisk_v1beta1/services/web_risk_service_v1_beta1/client.py index 2fbc698..b6118c9 100644 --- a/google/cloud/webrisk_v1beta1/services/web_risk_service_v1_beta1/client.py +++ b/google/cloud/webrisk_v1beta1/services/web_risk_service_v1_beta1/client.py @@ -53,6 +53,7 @@ from .transports.base import DEFAULT_CLIENT_INFO, WebRiskServiceV1Beta1Transport from .transports.grpc import WebRiskServiceV1Beta1GrpcTransport from .transports.grpc_asyncio import WebRiskServiceV1Beta1GrpcAsyncIOTransport +from .transports.rest import WebRiskServiceV1Beta1RestTransport class WebRiskServiceV1Beta1ClientMeta(type): @@ -68,6 +69,7 @@ class WebRiskServiceV1Beta1ClientMeta(type): ) # type: Dict[str, Type[WebRiskServiceV1Beta1Transport]] _transport_registry["grpc"] = WebRiskServiceV1Beta1GrpcTransport _transport_registry["grpc_asyncio"] = WebRiskServiceV1Beta1GrpcAsyncIOTransport + _transport_registry["rest"] = WebRiskServiceV1Beta1RestTransport def get_transport_class( cls, diff --git a/google/cloud/webrisk_v1beta1/services/web_risk_service_v1_beta1/transports/__init__.py b/google/cloud/webrisk_v1beta1/services/web_risk_service_v1_beta1/transports/__init__.py index c6bfd6c..fcb2365 100644 --- a/google/cloud/webrisk_v1beta1/services/web_risk_service_v1_beta1/transports/__init__.py +++ b/google/cloud/webrisk_v1beta1/services/web_risk_service_v1_beta1/transports/__init__.py @@ -19,6 +19,10 @@ from .base import WebRiskServiceV1Beta1Transport from .grpc import WebRiskServiceV1Beta1GrpcTransport from .grpc_asyncio import WebRiskServiceV1Beta1GrpcAsyncIOTransport +from .rest import ( + WebRiskServiceV1Beta1RestInterceptor, + WebRiskServiceV1Beta1RestTransport, +) # Compile a registry of transports. _transport_registry = ( @@ -26,9 +30,12 @@ ) # type: Dict[str, Type[WebRiskServiceV1Beta1Transport]] _transport_registry["grpc"] = WebRiskServiceV1Beta1GrpcTransport _transport_registry["grpc_asyncio"] = WebRiskServiceV1Beta1GrpcAsyncIOTransport +_transport_registry["rest"] = WebRiskServiceV1Beta1RestTransport __all__ = ( "WebRiskServiceV1Beta1Transport", "WebRiskServiceV1Beta1GrpcTransport", "WebRiskServiceV1Beta1GrpcAsyncIOTransport", + "WebRiskServiceV1Beta1RestTransport", + "WebRiskServiceV1Beta1RestInterceptor", ) diff --git a/google/cloud/webrisk_v1beta1/services/web_risk_service_v1_beta1/transports/rest.py b/google/cloud/webrisk_v1beta1/services/web_risk_service_v1_beta1/transports/rest.py new file mode 100644 index 0000000..6da0a2d --- /dev/null +++ b/google/cloud/webrisk_v1beta1/services/web_risk_service_v1_beta1/transports/rest.py @@ -0,0 +1,565 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import dataclasses +import json # type: ignore +import re +from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, path_template, rest_helpers, rest_streaming +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore +from google.protobuf import json_format +import grpc # type: ignore +from requests import __version__ as requests_version + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.webrisk_v1beta1.types import webrisk + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .base import WebRiskServiceV1Beta1Transport + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class WebRiskServiceV1Beta1RestInterceptor: + """Interceptor for WebRiskServiceV1Beta1. + + 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 WebRiskServiceV1Beta1RestTransport. + + .. code-block:: python + class MyCustomWebRiskServiceV1Beta1Interceptor(WebRiskServiceV1Beta1RestInterceptor): + def pre_compute_threat_list_diff(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_compute_threat_list_diff(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_search_hashes(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_search_hashes(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_search_uris(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_search_uris(self, response): + logging.log(f"Received response: {response}") + return response + + transport = WebRiskServiceV1Beta1RestTransport(interceptor=MyCustomWebRiskServiceV1Beta1Interceptor()) + client = WebRiskServiceV1Beta1Client(transport=transport) + + + """ + + def pre_compute_threat_list_diff( + self, + request: webrisk.ComputeThreatListDiffRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[webrisk.ComputeThreatListDiffRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for compute_threat_list_diff + + Override in a subclass to manipulate the request or metadata + before they are sent to the WebRiskServiceV1Beta1 server. + """ + return request, metadata + + def post_compute_threat_list_diff( + self, response: webrisk.ComputeThreatListDiffResponse + ) -> webrisk.ComputeThreatListDiffResponse: + """Post-rpc interceptor for compute_threat_list_diff + + Override in a subclass to manipulate the response + after it is returned by the WebRiskServiceV1Beta1 server but before + it is returned to user code. + """ + return response + + def pre_search_hashes( + self, request: webrisk.SearchHashesRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[webrisk.SearchHashesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for search_hashes + + Override in a subclass to manipulate the request or metadata + before they are sent to the WebRiskServiceV1Beta1 server. + """ + return request, metadata + + def post_search_hashes( + self, response: webrisk.SearchHashesResponse + ) -> webrisk.SearchHashesResponse: + """Post-rpc interceptor for search_hashes + + Override in a subclass to manipulate the response + after it is returned by the WebRiskServiceV1Beta1 server but before + it is returned to user code. + """ + return response + + def pre_search_uris( + self, request: webrisk.SearchUrisRequest, metadata: Sequence[Tuple[str, str]] + ) -> Tuple[webrisk.SearchUrisRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for search_uris + + Override in a subclass to manipulate the request or metadata + before they are sent to the WebRiskServiceV1Beta1 server. + """ + return request, metadata + + def post_search_uris( + self, response: webrisk.SearchUrisResponse + ) -> webrisk.SearchUrisResponse: + """Post-rpc interceptor for search_uris + + Override in a subclass to manipulate the response + after it is returned by the WebRiskServiceV1Beta1 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class WebRiskServiceV1Beta1RestStub: + _session: AuthorizedSession + _host: str + _interceptor: WebRiskServiceV1Beta1RestInterceptor + + +class WebRiskServiceV1Beta1RestTransport(WebRiskServiceV1Beta1Transport): + """REST backend transport for WebRiskServiceV1Beta1. + + Web Risk v1beta1 API defines an interface to detect malicious + URLs on your website and in client applications. + + 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 = "webrisk.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[WebRiskServiceV1Beta1RestInterceptor] = 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 WebRiskServiceV1Beta1RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _ComputeThreatListDiff(WebRiskServiceV1Beta1RestStub): + def __hash__(self): + return hash("ComputeThreatListDiff") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "threatType": {}, + "constraints": {}, + } + + @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: webrisk.ComputeThreatListDiffRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> webrisk.ComputeThreatListDiffResponse: + r"""Call the compute threat list diff method over HTTP. + + Args: + request (~.webrisk.ComputeThreatListDiffRequest): + The request object. Describes an API diff request. + 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: + ~.webrisk.ComputeThreatListDiffResponse: + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/threatLists:computeDiff", + }, + ] + request, metadata = self._interceptor.pre_compute_threat_list_diff( + request, metadata + ) + pb_request = webrisk.ComputeThreatListDiffRequest.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 = webrisk.ComputeThreatListDiffResponse() + pb_resp = webrisk.ComputeThreatListDiffResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_compute_threat_list_diff(resp) + return resp + + class _SearchHashes(WebRiskServiceV1Beta1RestStub): + def __hash__(self): + return hash("SearchHashes") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "threatTypes": {}, + } + + @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: webrisk.SearchHashesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> webrisk.SearchHashesResponse: + r"""Call the search hashes method over HTTP. + + Args: + request (~.webrisk.SearchHashesRequest): + The request object. Request to return full hashes matched + by the provided hash prefixes. + + 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: + ~.webrisk.SearchHashesResponse: + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/hashes:search", + }, + ] + request, metadata = self._interceptor.pre_search_hashes(request, metadata) + pb_request = webrisk.SearchHashesRequest.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 = webrisk.SearchHashesResponse() + pb_resp = webrisk.SearchHashesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_search_hashes(resp) + return resp + + class _SearchUris(WebRiskServiceV1Beta1RestStub): + def __hash__(self): + return hash("SearchUris") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "uri": "", + "threatTypes": {}, + } + + @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: webrisk.SearchUrisRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> webrisk.SearchUrisResponse: + r"""Call the search uris method over HTTP. + + Args: + request (~.webrisk.SearchUrisRequest): + The request object. Request to check URI entries against + threatLists. + + 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: + ~.webrisk.SearchUrisResponse: + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/uris:search", + }, + ] + request, metadata = self._interceptor.pre_search_uris(request, metadata) + pb_request = webrisk.SearchUrisRequest.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 = webrisk.SearchUrisResponse() + pb_resp = webrisk.SearchUrisResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_search_uris(resp) + return resp + + @property + def compute_threat_list_diff( + self, + ) -> Callable[ + [webrisk.ComputeThreatListDiffRequest], webrisk.ComputeThreatListDiffResponse + ]: + # 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._ComputeThreatListDiff(self._session, self._host, self._interceptor) # type: ignore + + @property + def search_hashes( + self, + ) -> Callable[[webrisk.SearchHashesRequest], webrisk.SearchHashesResponse]: + # 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._SearchHashes(self._session, self._host, self._interceptor) # type: ignore + + @property + def search_uris( + self, + ) -> Callable[[webrisk.SearchUrisRequest], webrisk.SearchUrisResponse]: + # 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._SearchUris(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("WebRiskServiceV1Beta1RestTransport",) diff --git a/tests/unit/gapic/webrisk_v1/test_web_risk_service.py b/tests/unit/gapic/webrisk_v1/test_web_risk_service.py index ab69da2..28a9a01 100644 --- a/tests/unit/gapic/webrisk_v1/test_web_risk_service.py +++ b/tests/unit/gapic/webrisk_v1/test_web_risk_service.py @@ -22,6 +22,8 @@ except ImportError: # pragma: NO COVER import mock +from collections.abc import Iterable +import json import math from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template @@ -31,12 +33,15 @@ from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError from google.oauth2 import service_account +from google.protobuf import json_format from google.protobuf import timestamp_pb2 # type: ignore import grpc from grpc.experimental import aio from proto.marshal.rules import wrappers from proto.marshal.rules.dates import DurationRule, TimestampRule import pytest +from requests import PreparedRequest, Request, Response +from requests.sessions import Session from google.cloud.webrisk_v1.services.web_risk_service import ( WebRiskServiceAsyncClient, @@ -95,6 +100,7 @@ def test__get_default_mtls_endpoint(): [ (WebRiskServiceClient, "grpc"), (WebRiskServiceAsyncClient, "grpc_asyncio"), + (WebRiskServiceClient, "rest"), ], ) def test_web_risk_service_client_from_service_account_info( @@ -110,7 +116,11 @@ def test_web_risk_service_client_from_service_account_info( assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("webrisk.googleapis.com:443") + assert client.transport._host == ( + "webrisk.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://webrisk.googleapis.com" + ) @pytest.mark.parametrize( @@ -118,6 +128,7 @@ def test_web_risk_service_client_from_service_account_info( [ (transports.WebRiskServiceGrpcTransport, "grpc"), (transports.WebRiskServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.WebRiskServiceRestTransport, "rest"), ], ) def test_web_risk_service_client_service_account_always_use_jwt( @@ -143,6 +154,7 @@ def test_web_risk_service_client_service_account_always_use_jwt( [ (WebRiskServiceClient, "grpc"), (WebRiskServiceAsyncClient, "grpc_asyncio"), + (WebRiskServiceClient, "rest"), ], ) def test_web_risk_service_client_from_service_account_file( @@ -165,13 +177,18 @@ def test_web_risk_service_client_from_service_account_file( assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("webrisk.googleapis.com:443") + assert client.transport._host == ( + "webrisk.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://webrisk.googleapis.com" + ) def test_web_risk_service_client_get_transport_class(): transport = WebRiskServiceClient.get_transport_class() available_transports = [ transports.WebRiskServiceGrpcTransport, + transports.WebRiskServiceRestTransport, ] assert transport in available_transports @@ -188,6 +205,7 @@ def test_web_risk_service_client_get_transport_class(): transports.WebRiskServiceGrpcAsyncIOTransport, "grpc_asyncio", ), + (WebRiskServiceClient, transports.WebRiskServiceRestTransport, "rest"), ], ) @mock.patch.object( @@ -333,6 +351,8 @@ def test_web_risk_service_client_client_options( "grpc_asyncio", "false", ), + (WebRiskServiceClient, transports.WebRiskServiceRestTransport, "rest", "true"), + (WebRiskServiceClient, transports.WebRiskServiceRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -532,6 +552,7 @@ def test_web_risk_service_client_get_mtls_endpoint_and_cert_source(client_class) transports.WebRiskServiceGrpcAsyncIOTransport, "grpc_asyncio", ), + (WebRiskServiceClient, transports.WebRiskServiceRestTransport, "rest"), ], ) def test_web_risk_service_client_client_options_scopes( @@ -572,6 +593,7 @@ def test_web_risk_service_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (WebRiskServiceClient, transports.WebRiskServiceRestTransport, "rest", None), ], ) def test_web_risk_service_client_client_options_credentials_file( @@ -1509,6 +1531,1140 @@ async def test_create_submission_flattened_error_async(): ) +@pytest.mark.parametrize( + "request_type", + [ + webrisk.ComputeThreatListDiffRequest, + dict, + ], +) +def test_compute_threat_list_diff_rest(request_type): + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = webrisk.ComputeThreatListDiffResponse( + response_type=webrisk.ComputeThreatListDiffResponse.ResponseType.DIFF, + new_version_token=b"new_version_token_blob", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.ComputeThreatListDiffResponse.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.compute_threat_list_diff(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, webrisk.ComputeThreatListDiffResponse) + assert ( + response.response_type + == webrisk.ComputeThreatListDiffResponse.ResponseType.DIFF + ) + assert response.new_version_token == b"new_version_token_blob" + + +def test_compute_threat_list_diff_rest_required_fields( + request_type=webrisk.ComputeThreatListDiffRequest, +): + transport_class = transports.WebRiskServiceRestTransport + + 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() + ).compute_threat_list_diff._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() + ).compute_threat_list_diff._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "constraints", + "threat_type", + "version_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = webrisk.ComputeThreatListDiffResponse() + # 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 = webrisk.ComputeThreatListDiffResponse.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.compute_threat_list_diff(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_compute_threat_list_diff_rest_unset_required_fields(): + transport = transports.WebRiskServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.compute_threat_list_diff._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "constraints", + "threatType", + "versionToken", + ) + ) + & set( + ( + "threatType", + "constraints", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_compute_threat_list_diff_rest_interceptors(null_interceptor): + transport = transports.WebRiskServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.WebRiskServiceRestInterceptor(), + ) + client = WebRiskServiceClient(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.WebRiskServiceRestInterceptor, "post_compute_threat_list_diff" + ) as post, mock.patch.object( + transports.WebRiskServiceRestInterceptor, "pre_compute_threat_list_diff" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = webrisk.ComputeThreatListDiffRequest.pb( + webrisk.ComputeThreatListDiffRequest() + ) + 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 = webrisk.ComputeThreatListDiffResponse.to_json( + webrisk.ComputeThreatListDiffResponse() + ) + + request = webrisk.ComputeThreatListDiffRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = webrisk.ComputeThreatListDiffResponse() + + client.compute_threat_list_diff( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_compute_threat_list_diff_rest_bad_request( + transport: str = "rest", request_type=webrisk.ComputeThreatListDiffRequest +): + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.compute_threat_list_diff(request) + + +def test_compute_threat_list_diff_rest_flattened(): + client = WebRiskServiceClient( + 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 = webrisk.ComputeThreatListDiffResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + threat_type=webrisk.ThreatType.MALWARE, + version_token=b"version_token_blob", + constraints=webrisk.ComputeThreatListDiffRequest.Constraints( + max_diff_entries=1687 + ), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.ComputeThreatListDiffResponse.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.compute_threat_list_diff(**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/threatLists:computeDiff" % client.transport._host, args[1] + ) + + +def test_compute_threat_list_diff_rest_flattened_error(transport: str = "rest"): + client = WebRiskServiceClient( + 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.compute_threat_list_diff( + webrisk.ComputeThreatListDiffRequest(), + threat_type=webrisk.ThreatType.MALWARE, + version_token=b"version_token_blob", + constraints=webrisk.ComputeThreatListDiffRequest.Constraints( + max_diff_entries=1687 + ), + ) + + +def test_compute_threat_list_diff_rest_error(): + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + webrisk.SearchUrisRequest, + dict, + ], +) +def test_search_uris_rest(request_type): + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = webrisk.SearchUrisResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.SearchUrisResponse.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.search_uris(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, webrisk.SearchUrisResponse) + + +def test_search_uris_rest_required_fields(request_type=webrisk.SearchUrisRequest): + transport_class = transports.WebRiskServiceRestTransport + + request_init = {} + request_init["uri"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + assert "uri" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).search_uris._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "uri" in jsonified_request + assert jsonified_request["uri"] == request_init["uri"] + + jsonified_request["uri"] = "uri_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).search_uris._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "threat_types", + "uri", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "uri" in jsonified_request + assert jsonified_request["uri"] == "uri_value" + + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = webrisk.SearchUrisResponse() + # 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 = webrisk.SearchUrisResponse.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.search_uris(request) + + expected_params = [ + ( + "uri", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_search_uris_rest_unset_required_fields(): + transport = transports.WebRiskServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.search_uris._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "threatTypes", + "uri", + ) + ) + & set( + ( + "uri", + "threatTypes", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_search_uris_rest_interceptors(null_interceptor): + transport = transports.WebRiskServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.WebRiskServiceRestInterceptor(), + ) + client = WebRiskServiceClient(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.WebRiskServiceRestInterceptor, "post_search_uris" + ) as post, mock.patch.object( + transports.WebRiskServiceRestInterceptor, "pre_search_uris" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = webrisk.SearchUrisRequest.pb(webrisk.SearchUrisRequest()) + 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 = webrisk.SearchUrisResponse.to_json( + webrisk.SearchUrisResponse() + ) + + request = webrisk.SearchUrisRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = webrisk.SearchUrisResponse() + + client.search_uris( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_search_uris_rest_bad_request( + transport: str = "rest", request_type=webrisk.SearchUrisRequest +): + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.search_uris(request) + + +def test_search_uris_rest_flattened(): + client = WebRiskServiceClient( + 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 = webrisk.SearchUrisResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + uri="uri_value", + threat_types=[webrisk.ThreatType.MALWARE], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.SearchUrisResponse.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.search_uris(**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/uris:search" % client.transport._host, args[1] + ) + + +def test_search_uris_rest_flattened_error(transport: str = "rest"): + client = WebRiskServiceClient( + 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.search_uris( + webrisk.SearchUrisRequest(), + uri="uri_value", + threat_types=[webrisk.ThreatType.MALWARE], + ) + + +def test_search_uris_rest_error(): + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + webrisk.SearchHashesRequest, + dict, + ], +) +def test_search_hashes_rest(request_type): + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = webrisk.SearchHashesResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.SearchHashesResponse.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.search_hashes(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, webrisk.SearchHashesResponse) + + +def test_search_hashes_rest_required_fields(request_type=webrisk.SearchHashesRequest): + transport_class = transports.WebRiskServiceRestTransport + + 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() + ).search_hashes._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() + ).search_hashes._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "hash_prefix", + "threat_types", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = webrisk.SearchHashesResponse() + # 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 = webrisk.SearchHashesResponse.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.search_hashes(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_search_hashes_rest_unset_required_fields(): + transport = transports.WebRiskServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.search_hashes._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "hashPrefix", + "threatTypes", + ) + ) + & set(("threatTypes",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_search_hashes_rest_interceptors(null_interceptor): + transport = transports.WebRiskServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.WebRiskServiceRestInterceptor(), + ) + client = WebRiskServiceClient(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.WebRiskServiceRestInterceptor, "post_search_hashes" + ) as post, mock.patch.object( + transports.WebRiskServiceRestInterceptor, "pre_search_hashes" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = webrisk.SearchHashesRequest.pb(webrisk.SearchHashesRequest()) + 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 = webrisk.SearchHashesResponse.to_json( + webrisk.SearchHashesResponse() + ) + + request = webrisk.SearchHashesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = webrisk.SearchHashesResponse() + + client.search_hashes( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_search_hashes_rest_bad_request( + transport: str = "rest", request_type=webrisk.SearchHashesRequest +): + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.search_hashes(request) + + +def test_search_hashes_rest_flattened(): + client = WebRiskServiceClient( + 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 = webrisk.SearchHashesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + hash_prefix=b"hash_prefix_blob", + threat_types=[webrisk.ThreatType.MALWARE], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.SearchHashesResponse.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.search_hashes(**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/hashes:search" % client.transport._host, args[1] + ) + + +def test_search_hashes_rest_flattened_error(transport: str = "rest"): + client = WebRiskServiceClient( + 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.search_hashes( + webrisk.SearchHashesRequest(), + hash_prefix=b"hash_prefix_blob", + threat_types=[webrisk.ThreatType.MALWARE], + ) + + +def test_search_hashes_rest_error(): + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + webrisk.CreateSubmissionRequest, + dict, + ], +) +def test_create_submission_rest(request_type): + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1"} + request_init["submission"] = {"uri": "uri_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 = webrisk.Submission( + uri="uri_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.Submission.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_submission(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, webrisk.Submission) + assert response.uri == "uri_value" + + +def test_create_submission_rest_required_fields( + request_type=webrisk.CreateSubmissionRequest, +): + transport_class = transports.WebRiskServiceRestTransport + + 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_submission._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_submission._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 = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = webrisk.Submission() + # 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 = webrisk.Submission.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_submission(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_submission_rest_unset_required_fields(): + transport = transports.WebRiskServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_submission._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "submission", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_submission_rest_interceptors(null_interceptor): + transport = transports.WebRiskServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.WebRiskServiceRestInterceptor(), + ) + client = WebRiskServiceClient(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.WebRiskServiceRestInterceptor, "post_create_submission" + ) as post, mock.patch.object( + transports.WebRiskServiceRestInterceptor, "pre_create_submission" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = webrisk.CreateSubmissionRequest.pb( + webrisk.CreateSubmissionRequest() + ) + 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 = webrisk.Submission.to_json(webrisk.Submission()) + + request = webrisk.CreateSubmissionRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = webrisk.Submission() + + client.create_submission( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_submission_rest_bad_request( + transport: str = "rest", request_type=webrisk.CreateSubmissionRequest +): + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1"} + request_init["submission"] = {"uri": "uri_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.create_submission(request) + + +def test_create_submission_rest_flattened(): + client = WebRiskServiceClient( + 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 = webrisk.Submission() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + submission=webrisk.Submission(uri="uri_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 = webrisk.Submission.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_submission(**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/*}/submissions" % client.transport._host, args[1] + ) + + +def test_create_submission_rest_flattened_error(transport: str = "rest"): + client = WebRiskServiceClient( + 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_submission( + webrisk.CreateSubmissionRequest(), + parent="parent_value", + submission=webrisk.Submission(uri="uri_value"), + ) + + +def test_create_submission_rest_error(): + client = WebRiskServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.WebRiskServiceGrpcTransport( @@ -1590,6 +2746,7 @@ def test_transport_get_channel(): [ transports.WebRiskServiceGrpcTransport, transports.WebRiskServiceGrpcAsyncIOTransport, + transports.WebRiskServiceRestTransport, ], ) def test_transport_adc(transport_class): @@ -1604,6 +2761,7 @@ def test_transport_adc(transport_class): "transport_name", [ "grpc", + "rest", ], ) def test_transport_kind(transport_name): @@ -1736,6 +2894,7 @@ def test_web_risk_service_transport_auth_adc(transport_class): [ transports.WebRiskServiceGrpcTransport, transports.WebRiskServiceGrpcAsyncIOTransport, + transports.WebRiskServiceRestTransport, ], ) def test_web_risk_service_transport_auth_gdch_credentials(transport_class): @@ -1833,11 +2992,23 @@ def test_web_risk_service_grpc_transport_client_cert_source_for_mtls(transport_c ) +def test_web_risk_service_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.WebRiskServiceRestTransport( + 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_web_risk_service_host_no_port(transport_name): @@ -1848,7 +3019,11 @@ def test_web_risk_service_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("webrisk.googleapis.com:443") + assert client.transport._host == ( + "webrisk.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://webrisk.googleapis.com" + ) @pytest.mark.parametrize( @@ -1856,6 +3031,7 @@ def test_web_risk_service_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_web_risk_service_host_with_port(transport_name): @@ -1866,7 +3042,42 @@ def test_web_risk_service_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("webrisk.googleapis.com:8000") + assert client.transport._host == ( + "webrisk.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://webrisk.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_web_risk_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = WebRiskServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = WebRiskServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.compute_threat_list_diff._session + session2 = client2.transport.compute_threat_list_diff._session + assert session1 != session2 + session1 = client1.transport.search_uris._session + session2 = client2.transport.search_uris._session + assert session1 != session2 + session1 = client1.transport.search_hashes._session + session2 = client2.transport.search_hashes._session + assert session1 != session2 + session1 = client1.transport.create_submission._session + session2 = client2.transport.create_submission._session + assert session1 != session2 def test_web_risk_service_grpc_transport_channel(): @@ -2137,6 +3348,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -2154,6 +3366,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/tests/unit/gapic/webrisk_v1beta1/test_web_risk_service_v1_beta1.py b/tests/unit/gapic/webrisk_v1beta1/test_web_risk_service_v1_beta1.py index 60acd17..65b325a 100644 --- a/tests/unit/gapic/webrisk_v1beta1/test_web_risk_service_v1_beta1.py +++ b/tests/unit/gapic/webrisk_v1beta1/test_web_risk_service_v1_beta1.py @@ -22,6 +22,8 @@ except ImportError: # pragma: NO COVER import mock +from collections.abc import Iterable +import json import math from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template @@ -31,12 +33,15 @@ from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError from google.oauth2 import service_account +from google.protobuf import json_format from google.protobuf import timestamp_pb2 # type: ignore import grpc from grpc.experimental import aio from proto.marshal.rules import wrappers from proto.marshal.rules.dates import DurationRule, TimestampRule import pytest +from requests import PreparedRequest, Request, Response +from requests.sessions import Session from google.cloud.webrisk_v1beta1.services.web_risk_service_v1_beta1 import ( WebRiskServiceV1Beta1AsyncClient, @@ -96,6 +101,7 @@ def test__get_default_mtls_endpoint(): [ (WebRiskServiceV1Beta1Client, "grpc"), (WebRiskServiceV1Beta1AsyncClient, "grpc_asyncio"), + (WebRiskServiceV1Beta1Client, "rest"), ], ) def test_web_risk_service_v1_beta1_client_from_service_account_info( @@ -111,7 +117,11 @@ def test_web_risk_service_v1_beta1_client_from_service_account_info( assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("webrisk.googleapis.com:443") + assert client.transport._host == ( + "webrisk.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://webrisk.googleapis.com" + ) @pytest.mark.parametrize( @@ -119,6 +129,7 @@ def test_web_risk_service_v1_beta1_client_from_service_account_info( [ (transports.WebRiskServiceV1Beta1GrpcTransport, "grpc"), (transports.WebRiskServiceV1Beta1GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.WebRiskServiceV1Beta1RestTransport, "rest"), ], ) def test_web_risk_service_v1_beta1_client_service_account_always_use_jwt( @@ -144,6 +155,7 @@ def test_web_risk_service_v1_beta1_client_service_account_always_use_jwt( [ (WebRiskServiceV1Beta1Client, "grpc"), (WebRiskServiceV1Beta1AsyncClient, "grpc_asyncio"), + (WebRiskServiceV1Beta1Client, "rest"), ], ) def test_web_risk_service_v1_beta1_client_from_service_account_file( @@ -166,13 +178,18 @@ def test_web_risk_service_v1_beta1_client_from_service_account_file( assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("webrisk.googleapis.com:443") + assert client.transport._host == ( + "webrisk.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://webrisk.googleapis.com" + ) def test_web_risk_service_v1_beta1_client_get_transport_class(): transport = WebRiskServiceV1Beta1Client.get_transport_class() available_transports = [ transports.WebRiskServiceV1Beta1GrpcTransport, + transports.WebRiskServiceV1Beta1RestTransport, ] assert transport in available_transports @@ -193,6 +210,11 @@ def test_web_risk_service_v1_beta1_client_get_transport_class(): transports.WebRiskServiceV1Beta1GrpcAsyncIOTransport, "grpc_asyncio", ), + ( + WebRiskServiceV1Beta1Client, + transports.WebRiskServiceV1Beta1RestTransport, + "rest", + ), ], ) @mock.patch.object( @@ -348,6 +370,18 @@ def test_web_risk_service_v1_beta1_client_client_options( "grpc_asyncio", "false", ), + ( + WebRiskServiceV1Beta1Client, + transports.WebRiskServiceV1Beta1RestTransport, + "rest", + "true", + ), + ( + WebRiskServiceV1Beta1Client, + transports.WebRiskServiceV1Beta1RestTransport, + "rest", + "false", + ), ], ) @mock.patch.object( @@ -553,6 +587,11 @@ def test_web_risk_service_v1_beta1_client_get_mtls_endpoint_and_cert_source( transports.WebRiskServiceV1Beta1GrpcAsyncIOTransport, "grpc_asyncio", ), + ( + WebRiskServiceV1Beta1Client, + transports.WebRiskServiceV1Beta1RestTransport, + "rest", + ), ], ) def test_web_risk_service_v1_beta1_client_client_options_scopes( @@ -593,6 +632,12 @@ def test_web_risk_service_v1_beta1_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + ( + WebRiskServiceV1Beta1Client, + transports.WebRiskServiceV1Beta1RestTransport, + "rest", + None, + ), ], ) def test_web_risk_service_v1_beta1_client_client_options_credentials_file( @@ -1278,6 +1323,863 @@ async def test_search_hashes_flattened_error_async(): ) +@pytest.mark.parametrize( + "request_type", + [ + webrisk.ComputeThreatListDiffRequest, + dict, + ], +) +def test_compute_threat_list_diff_rest(request_type): + client = WebRiskServiceV1Beta1Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = webrisk.ComputeThreatListDiffResponse( + response_type=webrisk.ComputeThreatListDiffResponse.ResponseType.DIFF, + new_version_token=b"new_version_token_blob", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.ComputeThreatListDiffResponse.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.compute_threat_list_diff(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, webrisk.ComputeThreatListDiffResponse) + assert ( + response.response_type + == webrisk.ComputeThreatListDiffResponse.ResponseType.DIFF + ) + assert response.new_version_token == b"new_version_token_blob" + + +def test_compute_threat_list_diff_rest_required_fields( + request_type=webrisk.ComputeThreatListDiffRequest, +): + transport_class = transports.WebRiskServiceV1Beta1RestTransport + + 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() + ).compute_threat_list_diff._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() + ).compute_threat_list_diff._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "constraints", + "threat_type", + "version_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = WebRiskServiceV1Beta1Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = webrisk.ComputeThreatListDiffResponse() + # 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 = webrisk.ComputeThreatListDiffResponse.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.compute_threat_list_diff(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_compute_threat_list_diff_rest_unset_required_fields(): + transport = transports.WebRiskServiceV1Beta1RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.compute_threat_list_diff._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "constraints", + "threatType", + "versionToken", + ) + ) + & set( + ( + "threatType", + "constraints", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_compute_threat_list_diff_rest_interceptors(null_interceptor): + transport = transports.WebRiskServiceV1Beta1RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.WebRiskServiceV1Beta1RestInterceptor(), + ) + client = WebRiskServiceV1Beta1Client(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.WebRiskServiceV1Beta1RestInterceptor, "post_compute_threat_list_diff" + ) as post, mock.patch.object( + transports.WebRiskServiceV1Beta1RestInterceptor, "pre_compute_threat_list_diff" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = webrisk.ComputeThreatListDiffRequest.pb( + webrisk.ComputeThreatListDiffRequest() + ) + 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 = webrisk.ComputeThreatListDiffResponse.to_json( + webrisk.ComputeThreatListDiffResponse() + ) + + request = webrisk.ComputeThreatListDiffRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = webrisk.ComputeThreatListDiffResponse() + + client.compute_threat_list_diff( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_compute_threat_list_diff_rest_bad_request( + transport: str = "rest", request_type=webrisk.ComputeThreatListDiffRequest +): + client = WebRiskServiceV1Beta1Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.compute_threat_list_diff(request) + + +def test_compute_threat_list_diff_rest_flattened(): + client = WebRiskServiceV1Beta1Client( + 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 = webrisk.ComputeThreatListDiffResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + threat_type=webrisk.ThreatType.MALWARE, + version_token=b"version_token_blob", + constraints=webrisk.ComputeThreatListDiffRequest.Constraints( + max_diff_entries=1687 + ), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.ComputeThreatListDiffResponse.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.compute_threat_list_diff(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/threatLists:computeDiff" % client.transport._host, args[1] + ) + + +def test_compute_threat_list_diff_rest_flattened_error(transport: str = "rest"): + client = WebRiskServiceV1Beta1Client( + 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.compute_threat_list_diff( + webrisk.ComputeThreatListDiffRequest(), + threat_type=webrisk.ThreatType.MALWARE, + version_token=b"version_token_blob", + constraints=webrisk.ComputeThreatListDiffRequest.Constraints( + max_diff_entries=1687 + ), + ) + + +def test_compute_threat_list_diff_rest_error(): + client = WebRiskServiceV1Beta1Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + webrisk.SearchUrisRequest, + dict, + ], +) +def test_search_uris_rest(request_type): + client = WebRiskServiceV1Beta1Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = webrisk.SearchUrisResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.SearchUrisResponse.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.search_uris(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, webrisk.SearchUrisResponse) + + +def test_search_uris_rest_required_fields(request_type=webrisk.SearchUrisRequest): + transport_class = transports.WebRiskServiceV1Beta1RestTransport + + request_init = {} + request_init["uri"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + assert "uri" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).search_uris._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "uri" in jsonified_request + assert jsonified_request["uri"] == request_init["uri"] + + jsonified_request["uri"] = "uri_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).search_uris._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "threat_types", + "uri", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "uri" in jsonified_request + assert jsonified_request["uri"] == "uri_value" + + client = WebRiskServiceV1Beta1Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = webrisk.SearchUrisResponse() + # 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 = webrisk.SearchUrisResponse.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.search_uris(request) + + expected_params = [ + ( + "uri", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_search_uris_rest_unset_required_fields(): + transport = transports.WebRiskServiceV1Beta1RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.search_uris._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "threatTypes", + "uri", + ) + ) + & set( + ( + "uri", + "threatTypes", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_search_uris_rest_interceptors(null_interceptor): + transport = transports.WebRiskServiceV1Beta1RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.WebRiskServiceV1Beta1RestInterceptor(), + ) + client = WebRiskServiceV1Beta1Client(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.WebRiskServiceV1Beta1RestInterceptor, "post_search_uris" + ) as post, mock.patch.object( + transports.WebRiskServiceV1Beta1RestInterceptor, "pre_search_uris" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = webrisk.SearchUrisRequest.pb(webrisk.SearchUrisRequest()) + 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 = webrisk.SearchUrisResponse.to_json( + webrisk.SearchUrisResponse() + ) + + request = webrisk.SearchUrisRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = webrisk.SearchUrisResponse() + + client.search_uris( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_search_uris_rest_bad_request( + transport: str = "rest", request_type=webrisk.SearchUrisRequest +): + client = WebRiskServiceV1Beta1Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.search_uris(request) + + +def test_search_uris_rest_flattened(): + client = WebRiskServiceV1Beta1Client( + 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 = webrisk.SearchUrisResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + uri="uri_value", + threat_types=[webrisk.ThreatType.MALWARE], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.SearchUrisResponse.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.search_uris(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/uris:search" % client.transport._host, args[1] + ) + + +def test_search_uris_rest_flattened_error(transport: str = "rest"): + client = WebRiskServiceV1Beta1Client( + 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.search_uris( + webrisk.SearchUrisRequest(), + uri="uri_value", + threat_types=[webrisk.ThreatType.MALWARE], + ) + + +def test_search_uris_rest_error(): + client = WebRiskServiceV1Beta1Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + webrisk.SearchHashesRequest, + dict, + ], +) +def test_search_hashes_rest(request_type): + client = WebRiskServiceV1Beta1Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = webrisk.SearchHashesResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.SearchHashesResponse.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.search_hashes(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, webrisk.SearchHashesResponse) + + +def test_search_hashes_rest_required_fields(request_type=webrisk.SearchHashesRequest): + transport_class = transports.WebRiskServiceV1Beta1RestTransport + + 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() + ).search_hashes._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() + ).search_hashes._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "hash_prefix", + "threat_types", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = WebRiskServiceV1Beta1Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = webrisk.SearchHashesResponse() + # 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 = webrisk.SearchHashesResponse.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.search_hashes(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_search_hashes_rest_unset_required_fields(): + transport = transports.WebRiskServiceV1Beta1RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.search_hashes._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "hashPrefix", + "threatTypes", + ) + ) + & set(("threatTypes",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_search_hashes_rest_interceptors(null_interceptor): + transport = transports.WebRiskServiceV1Beta1RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.WebRiskServiceV1Beta1RestInterceptor(), + ) + client = WebRiskServiceV1Beta1Client(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.WebRiskServiceV1Beta1RestInterceptor, "post_search_hashes" + ) as post, mock.patch.object( + transports.WebRiskServiceV1Beta1RestInterceptor, "pre_search_hashes" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = webrisk.SearchHashesRequest.pb(webrisk.SearchHashesRequest()) + 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 = webrisk.SearchHashesResponse.to_json( + webrisk.SearchHashesResponse() + ) + + request = webrisk.SearchHashesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = webrisk.SearchHashesResponse() + + client.search_hashes( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_search_hashes_rest_bad_request( + transport: str = "rest", request_type=webrisk.SearchHashesRequest +): + client = WebRiskServiceV1Beta1Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.search_hashes(request) + + +def test_search_hashes_rest_flattened(): + client = WebRiskServiceV1Beta1Client( + 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 = webrisk.SearchHashesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + hash_prefix=b"hash_prefix_blob", + threat_types=[webrisk.ThreatType.MALWARE], + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = webrisk.SearchHashesResponse.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.search_hashes(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/hashes:search" % client.transport._host, args[1] + ) + + +def test_search_hashes_rest_flattened_error(transport: str = "rest"): + client = WebRiskServiceV1Beta1Client( + 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.search_hashes( + webrisk.SearchHashesRequest(), + hash_prefix=b"hash_prefix_blob", + threat_types=[webrisk.ThreatType.MALWARE], + ) + + +def test_search_hashes_rest_error(): + client = WebRiskServiceV1Beta1Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.WebRiskServiceV1Beta1GrpcTransport( @@ -1359,6 +2261,7 @@ def test_transport_get_channel(): [ transports.WebRiskServiceV1Beta1GrpcTransport, transports.WebRiskServiceV1Beta1GrpcAsyncIOTransport, + transports.WebRiskServiceV1Beta1RestTransport, ], ) def test_transport_adc(transport_class): @@ -1373,6 +2276,7 @@ def test_transport_adc(transport_class): "transport_name", [ "grpc", + "rest", ], ) def test_transport_kind(transport_name): @@ -1504,6 +2408,7 @@ def test_web_risk_service_v1_beta1_transport_auth_adc(transport_class): [ transports.WebRiskServiceV1Beta1GrpcTransport, transports.WebRiskServiceV1Beta1GrpcAsyncIOTransport, + transports.WebRiskServiceV1Beta1RestTransport, ], ) def test_web_risk_service_v1_beta1_transport_auth_gdch_credentials(transport_class): @@ -1605,11 +2510,23 @@ def test_web_risk_service_v1_beta1_grpc_transport_client_cert_source_for_mtls( ) +def test_web_risk_service_v1_beta1_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.WebRiskServiceV1Beta1RestTransport( + 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_web_risk_service_v1_beta1_host_no_port(transport_name): @@ -1620,7 +2537,11 @@ def test_web_risk_service_v1_beta1_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("webrisk.googleapis.com:443") + assert client.transport._host == ( + "webrisk.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://webrisk.googleapis.com" + ) @pytest.mark.parametrize( @@ -1628,6 +2549,7 @@ def test_web_risk_service_v1_beta1_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_web_risk_service_v1_beta1_host_with_port(transport_name): @@ -1638,7 +2560,39 @@ def test_web_risk_service_v1_beta1_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("webrisk.googleapis.com:8000") + assert client.transport._host == ( + "webrisk.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://webrisk.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_web_risk_service_v1_beta1_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = WebRiskServiceV1Beta1Client( + credentials=creds1, + transport=transport_name, + ) + client2 = WebRiskServiceV1Beta1Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.compute_threat_list_diff._session + session2 = client2.transport.compute_threat_list_diff._session + assert session1 != session2 + session1 = client1.transport.search_uris._session + session2 = client2.transport.search_uris._session + assert session1 != session2 + session1 = client1.transport.search_hashes._session + session2 = client2.transport.search_hashes._session + assert session1 != session2 def test_web_risk_service_v1_beta1_grpc_transport_channel(): @@ -1909,6 +2863,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -1926,6 +2881,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: From 07eb4a6874c655113c956bed4b625cccbab86171 Mon Sep 17 00:00:00 2001 From: "release-please[bot]" <55107282+release-please[bot]@users.noreply.github.com> Date: Thu, 23 Feb 2023 16:50:09 -0800 Subject: [PATCH 6/6] chore(main): release 1.11.0 (#257) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> --- .release-please-manifest.json | 2 +- CHANGELOG.md | 7 +++++++ google/cloud/webrisk/gapic_version.py | 2 +- google/cloud/webrisk_v1/gapic_version.py | 2 +- google/cloud/webrisk_v1beta1/gapic_version.py | 2 +- .../snippet_metadata_google.cloud.webrisk.v1.json | 2 +- .../snippet_metadata_google.cloud.webrisk.v1beta1.json | 2 +- 7 files changed, 13 insertions(+), 6 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 211ac9a..cf198b9 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.10.1" + ".": "1.11.0" } diff --git a/CHANGELOG.md b/CHANGELOG.md index 1ba9c59..5a09ed8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,13 @@ [PyPI History][1] [1]: https://pypi.org/project/google-cloud-webrisk/#history +## [1.11.0](https://github.com/googleapis/python-webrisk/compare/v1.10.1...v1.11.0) (2023-02-09) + + +### Features + +* Enable "rest" transport in Python for services supporting numeric enums ([#256](https://github.com/googleapis/python-webrisk/issues/256)) ([0bc759d](https://github.com/googleapis/python-webrisk/commit/0bc759d1ecff83656a08f8ea11e0712b8522cc7c)) + ## [1.10.1](https://github.com/googleapis/python-webrisk/compare/v1.10.0...v1.10.1) (2023-01-23) diff --git a/google/cloud/webrisk/gapic_version.py b/google/cloud/webrisk/gapic_version.py index 6f9b28f..98fb3f5 100644 --- a/google/cloud/webrisk/gapic_version.py +++ b/google/cloud/webrisk/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "1.10.1" # {x-release-please-version} +__version__ = "1.11.0" # {x-release-please-version} diff --git a/google/cloud/webrisk_v1/gapic_version.py b/google/cloud/webrisk_v1/gapic_version.py index 6f9b28f..98fb3f5 100644 --- a/google/cloud/webrisk_v1/gapic_version.py +++ b/google/cloud/webrisk_v1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "1.10.1" # {x-release-please-version} +__version__ = "1.11.0" # {x-release-please-version} diff --git a/google/cloud/webrisk_v1beta1/gapic_version.py b/google/cloud/webrisk_v1beta1/gapic_version.py index 6f9b28f..98fb3f5 100644 --- a/google/cloud/webrisk_v1beta1/gapic_version.py +++ b/google/cloud/webrisk_v1beta1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "1.10.1" # {x-release-please-version} +__version__ = "1.11.0" # {x-release-please-version} diff --git a/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1.json b/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1.json index 60eac29..9ed61de 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-webrisk", - "version": "0.1.0" + "version": "1.11.0" }, "snippets": [ { diff --git a/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1beta1.json b/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1beta1.json index de1e97a..3b2b78f 100644 --- a/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1beta1.json +++ b/samples/generated_samples/snippet_metadata_google.cloud.webrisk.v1beta1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-webrisk", - "version": "0.1.0" + "version": "1.11.0" }, "snippets": [ {