def test_dismiss_recommendation_field_headers():
client = RecommendationServiceClient(
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 = recommendation_service.DismissRecommendationRequest()
request.customer_id = 'customer_id/value'
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.dismiss_recommendation),
'__call__') as call:
call.return_value = recommendation_service.DismissRecommendationResponse(
)
client.dismiss_recommendation(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',
'customer_id=customer_id/value',
) in kw['metadata']
def test_dismiss_recommendation_flattened():
client = RecommendationServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.dismiss_recommendation),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = recommendation_service.DismissRecommendationResponse(
)
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.dismiss_recommendation(
customer_id='customer_id_value',
operations=[
recommendation_service.DismissRecommendationRequest.
DismissRecommendationOperation(
resource_name='resource_name_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].customer_id == 'customer_id_value'
assert args[0].operations == [
recommendation_service.DismissRecommendationRequest.
DismissRecommendationOperation(resource_name='resource_name_value')
]
def test_dismiss_recommendation(
transport: str = 'grpc',
request_type=recommendation_service.DismissRecommendationRequest):
client = RecommendationServiceClient(
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.dismiss_recommendation),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = recommendation_service.DismissRecommendationResponse(
)
response = client.dismiss_recommendation(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == recommendation_service.DismissRecommendationRequest()
# Establish that the response is the type that we expect.
assert isinstance(response,
recommendation_service.DismissRecommendationResponse)
def test_parse_common_project_path():
expected = {
"project": "octopus",
}
path = RecommendationServiceClient.common_project_path(**expected)
# Check that the path construction is reversible.
actual = RecommendationServiceClient.parse_common_project_path(path)
assert expected == actual
def test_parse_common_organization_path():
expected = {
"organization": "clam",
}
path = RecommendationServiceClient.common_organization_path(**expected)
# Check that the path construction is reversible.
actual = RecommendationServiceClient.parse_common_organization_path(path)
assert expected == actual
def test_parse_common_folder_path():
expected = {
"folder": "abalone",
}
path = RecommendationServiceClient.common_folder_path(**expected)
# Check that the path construction is reversible.
actual = RecommendationServiceClient.parse_common_folder_path(path)
assert expected == actual
def test_parse_common_billing_account_path():
expected = {
"billing_account": "nautilus",
}
path = RecommendationServiceClient.common_billing_account_path(**expected)
# Check that the path construction is reversible.
actual = RecommendationServiceClient.parse_common_billing_account_path(
path)
assert expected == actual
def test_parse_campaign_budget_path():
expected = {
"customer": "whelk",
"campaign_budget": "octopus",
}
path = RecommendationServiceClient.campaign_budget_path(**expected)
# Check that the path construction is reversible.
actual = RecommendationServiceClient.parse_campaign_budget_path(path)
assert expected == actual
def test_parse_campaign_path():
expected = {
"customer": "scallop",
"campaign": "abalone",
}
path = RecommendationServiceClient.campaign_path(**expected)
# Check that the path construction is reversible.
actual = RecommendationServiceClient.parse_campaign_path(path)
assert expected == actual
def test_parse_recommendation_path():
expected = {
"customer": "cuttlefish",
"recommendation": "mussel",
}
path = RecommendationServiceClient.recommendation_path(**expected)
# Check that the path construction is reversible.
actual = RecommendationServiceClient.parse_recommendation_path(path)
assert expected == actual
def test_get_recommendation_flattened_error():
client = RecommendationServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.get_recommendation(
recommendation_service.GetRecommendationRequest(),
resource_name='resource_name_value',
)
def test_recommendation_service_client_from_service_account_file():
creds = ga_credentials.AnonymousCredentials()
with mock.patch.object(service_account.Credentials,
'from_service_account_file') as factory:
factory.return_value = creds
client = RecommendationServiceClient.from_service_account_file(
"dummy/file/path.json")
assert client.transport._credentials == creds
client = RecommendationServiceClient.from_service_account_json(
"dummy/file/path.json")
assert client.transport._credentials == creds
assert client.transport._host == 'googleads.googleapis.com:443'
def test_apply_recommendation_flattened_error():
client = RecommendationServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.apply_recommendation(
recommendation_service.ApplyRecommendationRequest(),
customer_id='customer_id_value',
operations=[
recommendation_service.ApplyRecommendationOperation(
resource_name='resource_name_value')
],
)
def test_common_billing_account_path():
billing_account = "winkle"
expected = "billingAccounts/{billing_account}".format(
billing_account=billing_account, )
actual = RecommendationServiceClient.common_billing_account_path(
billing_account)
assert expected == actual
def test_recommendation_service_auth_adc():
# If no credentials are provided, we should use ADC credentials.
with mock.patch.object(google.auth, 'default') as adc:
adc.return_value = (ga_credentials.AnonymousCredentials(), None)
RecommendationServiceClient()
adc.assert_called_once_with(
scopes=('https://www.googleapis.com/auth/adwords', ))
def test_recommendation_service_host_with_port():
client = RecommendationServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
client_options=client_options.ClientOptions(
api_endpoint='googleads.googleapis.com:8000'),
)
assert client.transport._host == 'googleads.googleapis.com:8000'
def test_transport_grpc_default():
# A client should use the gRPC transport by default.
client = RecommendationServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
assert isinstance(
client.transport,
transports.RecommendationServiceGrpcTransport,
)
def test_campaign_path():
customer = "winkle"
campaign = "nautilus"
expected = "customers/{customer}/campaigns/{campaign}".format(
customer=customer,
campaign=campaign,
)
actual = RecommendationServiceClient.campaign_path(customer, campaign)
assert expected == actual
def test_credentials_transport_error():
# It is an error to provide credentials and a transport instance.
transport = transports.RecommendationServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = RecommendationServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
transport=transport,
)
def test_ad_group_path():
customer = "oyster"
ad_group = "nudibranch"
expected = "customers/{customer}/adGroups/{ad_group}".format(
customer=customer,
ad_group=ad_group,
)
actual = RecommendationServiceClient.ad_group_path(customer, ad_group)
assert expected == actual
def test_ad_path():
customer = "squid"
ad = "clam"
expected = "customers/{customer}/ads/{ad}".format(
customer=customer,
ad=ad,
)
actual = RecommendationServiceClient.ad_path(customer, ad)
assert expected == actual
def test_client_withDEFAULT_CLIENT_INFO():
client_info = gapic_v1.client_info.ClientInfo()
with mock.patch.object(transports.RecommendationServiceTransport,
'_prep_wrapped_messages') as prep:
client = RecommendationServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
with mock.patch.object(transports.RecommendationServiceTransport,
'_prep_wrapped_messages') as prep:
transport_class = RecommendationServiceClient.get_transport_class()
transport = transport_class(
credentials=ga_credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
def test_recommendation_path():
customer = "oyster"
recommendation = "nudibranch"
expected = "customers/{customer}/recommendations/{recommendation}".format(
customer=customer,
recommendation=recommendation,
)
actual = RecommendationServiceClient.recommendation_path(
customer, recommendation)
assert expected == actual
def test_common_location_path():
project = "oyster"
location = "nudibranch"
expected = "projects/{project}/locations/{location}".format(
project=project,
location=location,
)
actual = RecommendationServiceClient.common_location_path(
project, location)
assert expected == actual
def test_campaign_budget_path():
customer = "squid"
campaign_budget = "clam"
expected = "customers/{customer}/campaignBudgets/{campaign_budget}".format(
customer=customer,
campaign_budget=campaign_budget,
)
actual = RecommendationServiceClient.campaign_budget_path(
customer, campaign_budget)
assert expected == actual
def test_recommendation_service_client_from_service_account_info():
creds = ga_credentials.AnonymousCredentials()
with mock.patch.object(service_account.Credentials,
'from_service_account_info') as factory:
factory.return_value = creds
info = {"valid": True}
client = RecommendationServiceClient.from_service_account_info(info)
assert client.transport._credentials == creds
assert client.transport._host == 'googleads.googleapis.com:443'
def test_recommendation_service_client_client_options_from_dict():
with mock.patch(
'google.ads.googleads.v5.services.services.recommendation_service.transports.RecommendationServiceGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = RecommendationServiceClient(
client_options={'api_endpoint': 'squid.clam.whelk'})
grpc_transport.assert_called_once_with(
ssl_channel_credentials=None,
credentials=None,
host="squid.clam.whelk",
client_info=transports.base.DEFAULT_CLIENT_INFO,
)
def test_get_recommendation(
transport: str = 'grpc',
request_type=recommendation_service.GetRecommendationRequest):
client = RecommendationServiceClient(
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.get_recommendation),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = recommendation.Recommendation(
resource_name='resource_name_value',
type_=recommendation_type.RecommendationTypeEnum.
RecommendationType.UNKNOWN,
campaign_budget_recommendation=recommendation.Recommendation.
CampaignBudgetRecommendation(
current_budget_amount_micros=wrappers_pb2.Int64Value(
value=541)),
)
response = client.get_recommendation(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == recommendation_service.GetRecommendationRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, recommendation.Recommendation)
assert response.resource_name == 'resource_name_value'
assert response.type_ == recommendation_type.RecommendationTypeEnum.RecommendationType.UNKNOWN
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 RecommendationServiceClient._get_default_mtls_endpoint(None) is None
assert RecommendationServiceClient._get_default_mtls_endpoint(
api_endpoint) == api_mtls_endpoint
assert RecommendationServiceClient._get_default_mtls_endpoint(
api_mtls_endpoint) == api_mtls_endpoint
assert RecommendationServiceClient._get_default_mtls_endpoint(
sandbox_endpoint) == sandbox_mtls_endpoint
assert RecommendationServiceClient._get_default_mtls_endpoint(
sandbox_mtls_endpoint) == sandbox_mtls_endpoint
assert RecommendationServiceClient._get_default_mtls_endpoint(
non_googleapi) == non_googleapi
def test_transport_instance():
# A client may be instantiated with a custom transport instance.
transport = transports.RecommendationServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(), )
client = RecommendationServiceClient(transport=transport)
assert client.transport is transport