def test_predict(
transport: str = "grpc", request_type=prediction_service.PredictRequest
):
client = PredictionServiceClient(
credentials=ga_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 = request_type()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.predict), "__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = prediction_service.PredictResponse(
attribution_token="attribution_token_value",
missing_ids=["missing_ids_value"],
validate_only=True,
)
response = client.predict(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == prediction_service.PredictRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, prediction_service.PredictResponse)
assert response.attribution_token == "attribution_token_value"
assert response.missing_ids == ["missing_ids_value"]
assert response.validate_only is True
def test_credentials_transport_error():
# It is an error to provide credentials and a transport instance.
transport = transports.PredictionServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(),
)
with pytest.raises(ValueError):
client = PredictionServiceClient(
credentials=ga_credentials.AnonymousCredentials(), transport=transport,
)
# It is an error to provide a credentials file and a transport instance.
transport = transports.PredictionServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(),
)
with pytest.raises(ValueError):
client = PredictionServiceClient(
client_options={"credentials_file": "credentials.json"},
transport=transport,
)
# It is an error to provide scopes and a transport instance.
transport = transports.PredictionServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(),
)
with pytest.raises(ValueError):
client = PredictionServiceClient(
client_options={"scopes": ["1", "2"]}, transport=transport,
)
def test_prediction_service_client_get_transport_class():
transport = PredictionServiceClient.get_transport_class()
available_transports = [
transports.PredictionServiceGrpcTransport,
]
assert transport in available_transports
transport = PredictionServiceClient.get_transport_class("grpc")
assert transport == transports.PredictionServiceGrpcTransport
def test_parse_common_project_path():
expected = {
"project": "nudibranch",
}
path = PredictionServiceClient.common_project_path(**expected)
# Check that the path construction is reversible.
actual = PredictionServiceClient.parse_common_project_path(path)
assert expected == actual
def test_parse_common_organization_path():
expected = {
"organization": "octopus",
}
path = PredictionServiceClient.common_organization_path(**expected)
# Check that the path construction is reversible.
actual = PredictionServiceClient.parse_common_organization_path(path)
assert expected == actual
def test_parse_common_folder_path():
expected = {
"folder": "clam",
}
path = PredictionServiceClient.common_folder_path(**expected)
# Check that the path construction is reversible.
actual = PredictionServiceClient.parse_common_folder_path(path)
assert expected == actual
def test_parse_common_billing_account_path():
expected = {
"billing_account": "abalone",
}
path = PredictionServiceClient.common_billing_account_path(**expected)
# Check that the path construction is reversible.
actual = PredictionServiceClient.parse_common_billing_account_path(path)
assert expected == actual
def test_parse_common_location_path():
expected = {
"project": "winkle",
"location": "nautilus",
}
path = PredictionServiceClient.common_location_path(**expected)
# Check that the path construction is reversible.
actual = PredictionServiceClient.parse_common_location_path(path)
assert expected == actual
def test_predict_empty_call():
# This test is a coverage failsafe to make sure that totally empty calls,
# i.e. request == None and no flattened fields passed, work.
client = PredictionServiceClient(
credentials=ga_credentials.AnonymousCredentials(), transport="grpc",
)
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.predict), "__call__") as call:
client.predict()
call.assert_called()
_, args, _ = call.mock_calls[0]
assert args[0] == prediction_service.PredictRequest()
def test_parse_product_path():
expected = {
"project": "nudibranch",
"location": "cuttlefish",
"catalog": "mussel",
"branch": "winkle",
"product": "nautilus",
}
path = PredictionServiceClient.product_path(**expected)
# Check that the path construction is reversible.
actual = PredictionServiceClient.parse_product_path(path)
assert expected == actual
def test_transport_instance():
# A client may be instantiated with a custom transport instance.
transport = transports.PredictionServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(),
)
client = PredictionServiceClient(transport=transport)
assert client.transport is transport
def test_common_billing_account_path():
billing_account = "scallop"
expected = "billingAccounts/{billing_account}".format(
billing_account=billing_account,
)
actual = PredictionServiceClient.common_billing_account_path(billing_account)
assert expected == actual
def test_common_location_path():
project = "cuttlefish"
location = "mussel"
expected = "projects/{project}/locations/{location}".format(
project=project, location=location,
)
actual = PredictionServiceClient.common_location_path(project, location)
assert expected == actual
def test_prediction_service_host_with_port():
client = PredictionServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
client_options=client_options.ClientOptions(
api_endpoint="retail.googleapis.com:8000"
),
)
assert client.transport._host == "retail.googleapis.com:8000"
def test_prediction_service_auth_adc_old_google_auth():
# If no credentials are provided, we should use ADC credentials.
with mock.patch.object(google.auth, "default", autospec=True) as adc:
adc.return_value = (ga_credentials.AnonymousCredentials(), None)
PredictionServiceClient()
adc.assert_called_once_with(
scopes=("https://www.googleapis.com/auth/cloud-platform",),
quota_project_id=None,
)
def test_client_withDEFAULT_CLIENT_INFO():
client_info = gapic_v1.client_info.ClientInfo()
with mock.patch.object(
transports.PredictionServiceTransport, "_prep_wrapped_messages"
) as prep:
client = PredictionServiceClient(
credentials=ga_credentials.AnonymousCredentials(), client_info=client_info,
)
prep.assert_called_once_with(client_info)
with mock.patch.object(
transports.PredictionServiceTransport, "_prep_wrapped_messages"
) as prep:
transport_class = PredictionServiceClient.get_transport_class()
transport = transport_class(
credentials=ga_credentials.AnonymousCredentials(), client_info=client_info,
)
prep.assert_called_once_with(client_info)
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 PredictionServiceClient._get_default_mtls_endpoint(None) is None
assert (
PredictionServiceClient._get_default_mtls_endpoint(api_endpoint)
== api_mtls_endpoint
)
assert (
PredictionServiceClient._get_default_mtls_endpoint(api_mtls_endpoint)
== api_mtls_endpoint
)
assert (
PredictionServiceClient._get_default_mtls_endpoint(sandbox_endpoint)
== sandbox_mtls_endpoint
)
assert (
PredictionServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint)
== sandbox_mtls_endpoint
)
assert (
PredictionServiceClient._get_default_mtls_endpoint(non_googleapi)
== non_googleapi
)
def test_predict_field_headers():
client = PredictionServiceClient(credentials=ga_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 = prediction_service.PredictRequest()
request.placement = "placement/value"
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.predict), "__call__") as call:
call.return_value = prediction_service.PredictResponse()
client.predict(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", "placement=placement/value",) in kw["metadata"]
def test_product_path():
project = "squid"
location = "clam"
catalog = "whelk"
branch = "octopus"
product = "oyster"
expected = "projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}".format(
project=project,
location=location,
catalog=catalog,
branch=branch,
product=product,
)
actual = PredictionServiceClient.product_path(
project, location, catalog, branch, product
)
assert expected == actual
def test_prediction_service_client_client_options_from_dict():
with mock.patch(
"google.cloud.retail_v2.services.prediction_service.transports.PredictionServiceGrpcTransport.__init__"
) as grpc_transport:
grpc_transport.return_value = None
client = PredictionServiceClient(
client_options={"api_endpoint": "squid.clam.whelk"}
)
grpc_transport.assert_called_once_with(
credentials=None,
credentials_file=None,
host="squid.clam.whelk",
scopes=None,
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)
def test_common_folder_path():
folder = "squid"
expected = "folders/{folder}".format(folder=folder,)
actual = PredictionServiceClient.common_folder_path(folder)
assert expected == actual
def test_transport_grpc_default():
# A client should use the gRPC transport by default.
client = PredictionServiceClient(credentials=ga_credentials.AnonymousCredentials(),)
assert isinstance(client.transport, transports.PredictionServiceGrpcTransport,)
def test_common_organization_path():
organization = "whelk"
expected = "organizations/{organization}".format(organization=organization,)
actual = PredictionServiceClient.common_organization_path(organization)
assert expected == actual
def test_common_project_path():
project = "oyster"
expected = "projects/{project}".format(project=project,)
actual = PredictionServiceClient.common_project_path(project)
assert expected == actual