def test_create_submission(transport: str = "grpc"):
client = WebRiskServiceClient(
credentials=credentials.AnonymousCredentials(),
transport=transport,
)
# Everything is optional in proto3 as far as the runtime is concerned,
# and we are mocking out the actual API, so just send an empty request.
request = webrisk.CreateSubmissionRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.create_submission),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = webrisk.Submission(uri="uri_value", )
response = client.create_submission(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the response is the type that we expect.
assert isinstance(response, webrisk.Submission)
assert response.uri == "uri_value"
def test_compute_threat_list_diff(transport: str = "grpc"):
client = WebRiskServiceClient(
credentials=credentials.AnonymousCredentials(),
transport=transport,
)
# Everything is optional in proto3 as far as the runtime is concerned,
# and we are mocking out the actual API, so just send an empty request.
request = webrisk.ComputeThreatListDiffRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.compute_threat_list_diff),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = webrisk.ComputeThreatListDiffResponse(
response_type=webrisk.ComputeThreatListDiffResponse.ResponseType.
DIFF,
new_version_token=b"new_version_token_blob",
)
response = client.compute_threat_list_diff(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == 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_flattened():
client = WebRiskServiceClient(
credentials=credentials.AnonymousCredentials(), )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.compute_threat_list_diff),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = webrisk.ComputeThreatListDiffResponse()
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.compute_threat_list_diff(
threat_type=webrisk.ThreatType.MALWARE,
version_token=b"version_token_blob",
constraints=webrisk.ComputeThreatListDiffRequest.Constraints(
max_diff_entries=1687),
)
# Establish that the underlying call was made with the expected
# request object values.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0].threat_type == webrisk.ThreatType.MALWARE
assert args[0].version_token == b"version_token_blob"
assert args[
0].constraints == webrisk.ComputeThreatListDiffRequest.Constraints(
max_diff_entries=1687)
def test_credentials_transport_error():
# It is an error to provide credentials and a transport instance.
transport = transports.WebRiskServiceGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = WebRiskServiceClient(
credentials=credentials.AnonymousCredentials(),
transport=transport,
)
# It is an error to provide a credentials file and a transport instance.
transport = transports.WebRiskServiceGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = WebRiskServiceClient(
client_options={"credentials_file": "credentials.json"},
transport=transport,
)
# It is an error to provide scopes and a transport instance.
transport = transports.WebRiskServiceGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = WebRiskServiceClient(
client_options={"scopes": ["1", "2"]},
transport=transport,
)
def test_create_submission_field_headers():
client = WebRiskServiceClient(
credentials=credentials.AnonymousCredentials(), )
# Any value that is part of the HTTP/1.1 URI should be sent as
# a field header. Set these to a non-empty value.
request = webrisk.CreateSubmissionRequest()
request.parent = "parent/value"
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.create_submission),
"__call__") as call:
call.return_value = webrisk.Submission()
client.create_submission(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the field header was sent.
_, _, kw = call.mock_calls[0]
assert (
"x-goog-request-params",
"parent=parent/value",
) in kw["metadata"]
def test_search_hashes_flattened_error():
client = WebRiskServiceClient(
credentials=credentials.AnonymousCredentials(), )
# 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_create_submission_flattened_error():
client = WebRiskServiceClient(
credentials=credentials.AnonymousCredentials(), )
# 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_compute_threat_list_diff_flattened_error():
client = WebRiskServiceClient(
credentials=credentials.AnonymousCredentials(), )
# 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_web_risk_service_host_with_port():
client = WebRiskServiceClient(
credentials=credentials.AnonymousCredentials(),
client_options=client_options.ClientOptions(
api_endpoint="webrisk.googleapis.com:8000"),
)
assert client._transport._host == "webrisk.googleapis.com:8000"
def test_web_risk_service_auth_adc():
# If no credentials are provided, we should use ADC credentials.
with mock.patch.object(auth, "default") as adc:
adc.return_value = (credentials.AnonymousCredentials(), None)
WebRiskServiceClient()
adc.assert_called_once_with(
scopes=("https://www.googleapis.com/auth/cloud-platform", ))
def test_transport_grpc_default():
# A client should use the gRPC transport by default.
client = WebRiskServiceClient(
credentials=credentials.AnonymousCredentials(), )
assert isinstance(
client._transport,
transports.WebRiskServiceGrpcTransport,
)
def run(self):
api_key_name = "GOOGLE_APPLICATION_CREDENTIALS"
credentials = secrets.get_secret(api_key_name)
if not credentials:
raise AnalyzerRunException(
f"No credentials retrieved with name: '{api_key_name}'")
if not exists(credentials):
raise AnalyzerRunException(
f"{credentials} should be an existing file. "
"Check the docs on how to add this file to"
" properly execute this analyzer")
web_risk_client = WebRiskServiceClient()
# threat types
# MALWARE = 1
# SOCIAL_ENGINEERING = 2
# THREAT_TYPE_UNSPECIFIED = 0 should not be used
# UNWANTED_SOFTWARE = 3
threat_types = [ThreatType(1), ThreatType(2), ThreatType(3)]
response = web_risk_client.search_uris(uri=self.observable_name,
threat_types=threat_types,
timeout=5)
threats_found = response.threat
# ThreatUri object
logger.debug(f"threat founds {threats_found}")
threat_types = threats_found.threat_types
malicious = True if threat_types else False
web_risk_result = malicious_detector_response(self.observable_name,
malicious)
# append extra data
if malicious:
threats_list = []
if 1 in threat_types:
threats_list.append("MALWARE")
if 2 in threat_types:
threats_list.append("SOCIAL_ENGINEERING")
if 3 in threat_types:
threats_list.append("UNWANTED_SOFTWARE")
web_risk_result["threats"] = threats_list
return web_risk_result
def test_search_hashes_flattened():
client = WebRiskServiceClient(
credentials=credentials.AnonymousCredentials(), )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.search_hashes),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = webrisk.SearchHashesResponse()
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.search_hashes(
hash_prefix=b"hash_prefix_blob",
threat_types=[webrisk.ThreatType.MALWARE],
)
# Establish that the underlying call was made with the expected
# request object values.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0].hash_prefix == b"hash_prefix_blob"
assert args[0].threat_types == [webrisk.ThreatType.MALWARE]
def test_create_submission_flattened():
client = WebRiskServiceClient(
credentials=credentials.AnonymousCredentials(), )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.create_submission),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = webrisk.Submission()
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.create_submission(
parent="parent_value",
submission=webrisk.Submission(uri="uri_value"),
)
# Establish that the underlying call was made with the expected
# request object values.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0].parent == "parent_value"
assert args[0].submission == webrisk.Submission(uri="uri_value")
def test_web_risk_service_client_client_options_from_dict():
with mock.patch(
"google.cloud.webrisk_v1.services.web_risk_service.transports.WebRiskServiceGrpcTransport.__init__"
) as grpc_transport:
grpc_transport.return_value = None
client = WebRiskServiceClient(
client_options={"api_endpoint": "squid.clam.whelk"})
grpc_transport.assert_called_once_with(
credentials=None,
credentials_file=None,
host="squid.clam.whelk",
scopes=None,
api_mtls_endpoint="squid.clam.whelk",
client_cert_source=None,
)
def test__get_default_mtls_endpoint():
api_endpoint = "example.googleapis.com"
api_mtls_endpoint = "example.mtls.googleapis.com"
sandbox_endpoint = "example.sandbox.googleapis.com"
sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com"
non_googleapi = "api.example.com"
assert WebRiskServiceClient._get_default_mtls_endpoint(None) is None
assert (WebRiskServiceClient._get_default_mtls_endpoint(api_endpoint) ==
api_mtls_endpoint)
assert (WebRiskServiceClient._get_default_mtls_endpoint(api_mtls_endpoint)
== api_mtls_endpoint)
assert (WebRiskServiceClient._get_default_mtls_endpoint(sandbox_endpoint)
== sandbox_mtls_endpoint)
assert (WebRiskServiceClient._get_default_mtls_endpoint(
sandbox_mtls_endpoint) == sandbox_mtls_endpoint)
assert (WebRiskServiceClient._get_default_mtls_endpoint(non_googleapi) ==
non_googleapi)
def test_transport_instance():
# A client may be instantiated with a custom transport instance.
transport = transports.WebRiskServiceGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
client = WebRiskServiceClient(transport=transport)
assert client._transport is transport
def test_web_risk_service_client_get_transport_class():
transport = WebRiskServiceClient.get_transport_class()
assert transport == transports.WebRiskServiceGrpcTransport
transport = WebRiskServiceClient.get_transport_class("grpc")
assert transport == transports.WebRiskServiceGrpcTransport