def test_create_customer_client_field_headers():
client = CustomerServiceClient(
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 = customer_service.CreateCustomerClientRequest()
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.create_customer_client),
'__call__') as call:
call.return_value = customer_service.CreateCustomerClientResponse()
client.create_customer_client(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_create_customer_client(
transport: str = 'grpc',
request_type=customer_service.CreateCustomerClientRequest):
client = CustomerServiceClient(
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.create_customer_client),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = customer_service.CreateCustomerClientResponse(
resource_name='resource_name_value',
invitation_link='invitation_link_value',
)
response = client.create_customer_client(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == customer_service.CreateCustomerClientRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, customer_service.CreateCustomerClientResponse)
assert response.resource_name == 'resource_name_value'
assert response.invitation_link == 'invitation_link_value'
def test_parse_customer_path():
expected = {
"customer_id": "nudibranch",
}
path = CustomerServiceClient.customer_path(**expected)
# Check that the path construction is reversible.
actual = CustomerServiceClient.parse_customer_path(path)
assert expected == actual
def test_parse_common_billing_account_path():
expected = {
"billing_account": "mussel",
}
path = CustomerServiceClient.common_billing_account_path(**expected)
# Check that the path construction is reversible.
actual = CustomerServiceClient.parse_common_billing_account_path(path)
assert expected == actual
def test_parse_common_folder_path():
expected = {
"folder": "nautilus",
}
path = CustomerServiceClient.common_folder_path(**expected)
# Check that the path construction is reversible.
actual = CustomerServiceClient.parse_common_folder_path(path)
assert expected == actual
def test_parse_common_organization_path():
expected = {
"organization": "abalone",
}
path = CustomerServiceClient.common_organization_path(**expected)
# Check that the path construction is reversible.
actual = CustomerServiceClient.parse_common_organization_path(path)
assert expected == actual
def test_parse_common_project_path():
expected = {
"project": "clam",
}
path = CustomerServiceClient.common_project_path(**expected)
# Check that the path construction is reversible.
actual = CustomerServiceClient.parse_common_project_path(path)
assert expected == actual
def test_parse_conversion_action_path():
expected = {
"customer_id": "whelk",
"conversion_action_id": "octopus",
}
path = CustomerServiceClient.conversion_action_path(**expected)
# Check that the path construction is reversible.
actual = CustomerServiceClient.parse_conversion_action_path(path)
assert expected == actual
def test_parse_common_location_path():
expected = {
"project": "oyster",
"location": "nudibranch",
}
path = CustomerServiceClient.common_location_path(**expected)
# Check that the path construction is reversible.
actual = CustomerServiceClient.parse_common_location_path(path)
assert expected == actual
def test_get_customer_flattened_error():
client = CustomerServiceClient(
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_customer(
customer_service.GetCustomerRequest(),
resource_name='resource_name_value',
)
def test_create_customer_client_flattened_error():
client = CustomerServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.create_customer_client(
customer_service.CreateCustomerClientRequest(),
customer_id='customer_id_value',
customer_client=customer.Customer(
resource_name='resource_name_value'),
)
def test_customer_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 = CustomerServiceClient.from_service_account_file(
"dummy/file/path.json")
assert client.transport._credentials == creds
client = CustomerServiceClient.from_service_account_json(
"dummy/file/path.json")
assert client.transport._credentials == creds
assert client.transport._host == 'googleads.googleapis.com:443'
def test_customer_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)
CustomerServiceClient()
adc.assert_called_once_with(
scopes=('https://www.googleapis.com/auth/adwords', ))
def test_customer_service_host_with_port():
client = CustomerServiceClient(
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 = CustomerServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
assert isinstance(
client.transport,
transports.CustomerServiceGrpcTransport,
)
def test_common_location_path():
project = "whelk"
location = "octopus"
expected = "projects/{project}/locations/{location}".format(
project=project,
location=location,
)
actual = CustomerServiceClient.common_location_path(project, location)
assert expected == actual
def test_get_customer_flattened():
client = CustomerServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.get_customer),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = customer.Customer()
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.get_customer(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].resource_name == 'resource_name_value'
def test_credentials_transport_error():
# It is an error to provide credentials and a transport instance.
transport = transports.CustomerServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = CustomerServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
transport=transport,
)
def test_client_withDEFAULT_CLIENT_INFO():
client_info = gapic_v1.client_info.ClientInfo()
with mock.patch.object(transports.CustomerServiceTransport,
'_prep_wrapped_messages') as prep:
client = CustomerServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
with mock.patch.object(transports.CustomerServiceTransport,
'_prep_wrapped_messages') as prep:
transport_class = CustomerServiceClient.get_transport_class()
transport = transport_class(
credentials=ga_credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
def test_customer_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 = CustomerServiceClient.from_service_account_info(info)
assert client.transport._credentials == creds
assert client.transport._host == 'googleads.googleapis.com:443'
def test_conversion_action_path():
customer_id = "squid"
conversion_action_id = "clam"
expected = "customers/{customer_id}/conversionActions/{conversion_action_id}".format(
customer_id=customer_id,
conversion_action_id=conversion_action_id,
)
actual = CustomerServiceClient.conversion_action_path(
customer_id, conversion_action_id)
assert expected == actual
def test_customer_service_client_client_options_from_dict():
with mock.patch(
'google.ads.googleads.v6.services.services.customer_service.transports.CustomerServiceGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = CustomerServiceClient(
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_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 CustomerServiceClient._get_default_mtls_endpoint(None) is None
assert CustomerServiceClient._get_default_mtls_endpoint(
api_endpoint) == api_mtls_endpoint
assert CustomerServiceClient._get_default_mtls_endpoint(
api_mtls_endpoint) == api_mtls_endpoint
assert CustomerServiceClient._get_default_mtls_endpoint(
sandbox_endpoint) == sandbox_mtls_endpoint
assert CustomerServiceClient._get_default_mtls_endpoint(
sandbox_mtls_endpoint) == sandbox_mtls_endpoint
assert CustomerServiceClient._get_default_mtls_endpoint(
non_googleapi) == non_googleapi
def test_common_project_path():
project = "squid"
expected = "projects/{project}".format(project=project, )
actual = CustomerServiceClient.common_project_path(project)
assert expected == actual
def test_common_organization_path():
organization = "scallop"
expected = "organizations/{organization}".format(
organization=organization, )
actual = CustomerServiceClient.common_organization_path(organization)
assert expected == actual
def test_common_folder_path():
folder = "winkle"
expected = "folders/{folder}".format(folder=folder, )
actual = CustomerServiceClient.common_folder_path(folder)
assert expected == actual
def test_get_customer(transport: str = 'grpc',
request_type=customer_service.GetCustomerRequest):
client = CustomerServiceClient(
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_customer),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = customer.Customer(
resource_name='resource_name_value',
id=205,
descriptive_name='descriptive_name_value',
currency_code='currency_code_value',
time_zone='time_zone_value',
tracking_url_template='tracking_url_template_value',
final_url_suffix='final_url_suffix_value',
auto_tagging_enabled=True,
has_partners_badge=True,
manager=True,
test_account=True,
pay_per_conversion_eligibility_failure_reasons=[
customer_pay_per_conversion_eligibility_failure_reason.
CustomerPayPerConversionEligibilityFailureReasonEnum.
CustomerPayPerConversionEligibilityFailureReason.UNKNOWN
],
optimization_score=0.1954,
optimization_score_weight=0.2697,
)
response = client.get_customer(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == customer_service.GetCustomerRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, customer.Customer)
assert response.resource_name == 'resource_name_value'
assert response.id == 205
assert response.descriptive_name == 'descriptive_name_value'
assert response.currency_code == 'currency_code_value'
assert response.time_zone == 'time_zone_value'
assert response.tracking_url_template == 'tracking_url_template_value'
assert response.final_url_suffix == 'final_url_suffix_value'
assert response.auto_tagging_enabled is True
assert response.has_partners_badge is True
assert response.manager is True
assert response.test_account is True
assert response.pay_per_conversion_eligibility_failure_reasons == [
customer_pay_per_conversion_eligibility_failure_reason.
CustomerPayPerConversionEligibilityFailureReasonEnum.
CustomerPayPerConversionEligibilityFailureReason.UNKNOWN
]
assert math.isclose(response.optimization_score, 0.1954, rel_tol=1e-6)
assert math.isclose(response.optimization_score_weight,
0.2697,
rel_tol=1e-6)
def test_common_billing_account_path():
billing_account = "cuttlefish"
expected = "billingAccounts/{billing_account}".format(
billing_account=billing_account, )
actual = CustomerServiceClient.common_billing_account_path(billing_account)
assert expected == actual
def test_customer_path():
customer_id = "oyster"
expected = "customers/{customer_id}".format(customer_id=customer_id, )
actual = CustomerServiceClient.customer_path(customer_id)
assert expected == actual
def test_transport_instance():
# A client may be instantiated with a custom transport instance.
transport = transports.CustomerServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(), )
client = CustomerServiceClient(transport=transport)
assert client.transport is transport
