def test_user_list_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)
UserListServiceClient()
adc.assert_called_once_with(
scopes=('https://www.googleapis.com/auth/adwords', ))
def test_user_list_service_host_with_port():
client = UserListServiceClient(
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_mutate_user_lists_field_headers():
client = UserListServiceClient(
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 = user_list_service.MutateUserListsRequest()
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.mutate_user_lists),
'__call__') as call:
call.return_value = user_list_service.MutateUserListsResponse()
client.mutate_user_lists(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_mutate_user_lists_flattened():
client = UserListServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.mutate_user_lists),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = user_list_service.MutateUserListsResponse()
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.mutate_user_lists(
customer_id='customer_id_value',
operations=[
user_list_service.UserListOperation(
update_mask=field_mask_pb2.FieldMask(
paths=['paths_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 == [
user_list_service.UserListOperation(
update_mask=field_mask_pb2.FieldMask(paths=['paths_value']))
]
def test_mutate_user_lists(
transport: str = 'grpc',
request_type=user_list_service.MutateUserListsRequest):
client = UserListServiceClient(
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.mutate_user_lists),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = user_list_service.MutateUserListsResponse()
response = client.mutate_user_lists(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == user_list_service.MutateUserListsRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, user_list_service.MutateUserListsResponse)
def test_transport_grpc_default():
# A client should use the gRPC transport by default.
client = UserListServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
assert isinstance(
client.transport,
transports.UserListServiceGrpcTransport,
)
def test_credentials_transport_error():
# It is an error to provide credentials and a transport instance.
transport = transports.UserListServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = UserListServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
transport=transport,
)
def test_get_user_list_flattened_error():
client = UserListServiceClient(
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_user_list(
user_list_service.GetUserListRequest(),
resource_name='resource_name_value',
)
def test_user_list_service_client_client_options_from_dict():
with mock.patch(
'google.ads.googleads.v8.services.services.user_list_service.transports.UserListServiceGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = UserListServiceClient(
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_mutate_user_lists_flattened_error():
client = UserListServiceClient(
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.mutate_user_lists(
user_list_service.MutateUserListsRequest(),
customer_id='customer_id_value',
operations=[
user_list_service.UserListOperation(
update_mask=field_mask_pb2.FieldMask(
paths=['paths_value']))
],
)
def test_get_user_list_flattened():
client = UserListServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.get_user_list),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = user_list.UserList()
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.get_user_list(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_client_withDEFAULT_CLIENT_INFO():
client_info = gapic_v1.client_info.ClientInfo()
with mock.patch.object(transports.UserListServiceTransport,
'_prep_wrapped_messages') as prep:
client = UserListServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
with mock.patch.object(transports.UserListServiceTransport,
'_prep_wrapped_messages') as prep:
transport_class = UserListServiceClient.get_transport_class()
transport = transport_class(
credentials=ga_credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
def test_transport_instance():
# A client may be instantiated with a custom transport instance.
transport = transports.UserListServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(), )
client = UserListServiceClient(transport=transport)
assert client.transport is transport
def test_get_user_list(transport: str = 'grpc',
request_type=user_list_service.GetUserListRequest):
client = UserListServiceClient(
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_user_list),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = user_list.UserList(
resource_name='resource_name_value',
id=205,
read_only=True,
name='name_value',
description='description_value',
membership_status=user_list_membership_status.
UserListMembershipStatusEnum.UserListMembershipStatus.UNKNOWN,
integration_code='integration_code_value',
membership_life_span=2108,
size_for_display=1718,
size_range_for_display=user_list_size_range.UserListSizeRangeEnum.
UserListSizeRange.UNKNOWN,
size_for_search=1590,
size_range_for_search=user_list_size_range.UserListSizeRangeEnum.
UserListSizeRange.UNKNOWN,
type_=user_list_type.UserListTypeEnum.UserListType.UNKNOWN,
closing_reason=user_list_closing_reason.UserListClosingReasonEnum.
UserListClosingReason.UNKNOWN,
access_reason=access_reason.AccessReasonEnum.AccessReason.UNKNOWN,
account_user_list_status=user_list_access_status.
UserListAccessStatusEnum.UserListAccessStatus.UNKNOWN,
eligible_for_search=True,
eligible_for_display=True,
match_rate_percentage=2197,
crm_based_user_list=user_lists.CrmBasedUserListInfo(
app_id='app_id_value'),
)
response = client.get_user_list(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == user_list_service.GetUserListRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, user_list.UserList)
assert response.resource_name == 'resource_name_value'
assert response.id == 205
assert response.read_only is True
assert response.name == 'name_value'
assert response.description == 'description_value'
assert response.membership_status == user_list_membership_status.UserListMembershipStatusEnum.UserListMembershipStatus.UNKNOWN
assert response.integration_code == 'integration_code_value'
assert response.membership_life_span == 2108
assert response.size_for_display == 1718
assert response.size_range_for_display == user_list_size_range.UserListSizeRangeEnum.UserListSizeRange.UNKNOWN
assert response.size_for_search == 1590
assert response.size_range_for_search == user_list_size_range.UserListSizeRangeEnum.UserListSizeRange.UNKNOWN
assert response.type_ == user_list_type.UserListTypeEnum.UserListType.UNKNOWN
assert response.closing_reason == user_list_closing_reason.UserListClosingReasonEnum.UserListClosingReason.UNKNOWN
assert response.access_reason == access_reason.AccessReasonEnum.AccessReason.UNKNOWN
assert response.account_user_list_status == user_list_access_status.UserListAccessStatusEnum.UserListAccessStatus.UNKNOWN
assert response.eligible_for_search is True
assert response.eligible_for_display is True
assert response.match_rate_percentage == 2197
def test_user_list_service_client_mtls_env_auto(use_client_cert_env):
# This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default
# mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists.
# Check the case client_cert_source is provided. Whether client cert is used depends on
# GOOGLE_API_USE_CLIENT_CERTIFICATE value.
with mock.patch.dict(
os.environ,
{"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}):
options = client_options.ClientOptions(
client_cert_source=client_cert_source_callback)
with mock.patch(
'google.ads.googleads.v8.services.services.user_list_service.transports.UserListServiceGrpcTransport.__init__'
) as grpc_transport:
ssl_channel_creds = mock.Mock()
with mock.patch('grpc.ssl_channel_credentials',
return_value=ssl_channel_creds):
grpc_transport.return_value = None
client = UserListServiceClient(client_options=options)
if use_client_cert_env == "false":
expected_ssl_channel_creds = None
expected_host = client.DEFAULT_ENDPOINT
else:
expected_ssl_channel_creds = ssl_channel_creds
expected_host = client.DEFAULT_MTLS_ENDPOINT
grpc_transport.assert_called_once_with(
ssl_channel_credentials=expected_ssl_channel_creds,
credentials=None,
host=expected_host,
client_info=transports.base.DEFAULT_CLIENT_INFO,
)
# Check the case ADC client cert is provided. Whether client cert is used depends on
# GOOGLE_API_USE_CLIENT_CERTIFICATE value.
with mock.patch.dict(
os.environ,
{"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}):
with mock.patch(
'google.ads.googleads.v8.services.services.user_list_service.transports.UserListServiceGrpcTransport.__init__'
) as grpc_transport:
with mock.patch(
'google.auth.transport.grpc.SslCredentials.__init__',
return_value=None):
with mock.patch(
'google.auth.transport.grpc.SslCredentials.is_mtls',
new_callable=mock.PropertyMock) as is_mtls_mock:
with mock.patch(
'google.auth.transport.grpc.SslCredentials.ssl_credentials',
new_callable=mock.PropertyMock
) as ssl_credentials_mock:
if use_client_cert_env == "false":
is_mtls_mock.return_value = False
ssl_credentials_mock.return_value = None
expected_host = client.DEFAULT_ENDPOINT
expected_ssl_channel_creds = None
else:
is_mtls_mock.return_value = True
ssl_credentials_mock.return_value = mock.Mock()
expected_host = client.DEFAULT_MTLS_ENDPOINT
expected_ssl_channel_creds = ssl_credentials_mock.return_value
grpc_transport.return_value = None
client = UserListServiceClient()
grpc_transport.assert_called_once_with(
ssl_channel_credentials=expected_ssl_channel_creds,
credentials=None,
host=expected_host,
client_info=transports.base.DEFAULT_CLIENT_INFO,
)
# Check the case client_cert_source and ADC client cert are not provided.
with mock.patch.dict(
os.environ,
{"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}):
with mock.patch(
'google.ads.googleads.v8.services.services.user_list_service.transports.UserListServiceGrpcTransport.__init__'
) as grpc_transport:
with mock.patch(
'google.auth.transport.grpc.SslCredentials.__init__',
return_value=None):
with mock.patch(
'google.auth.transport.grpc.SslCredentials.is_mtls',
new_callable=mock.PropertyMock) as is_mtls_mock:
is_mtls_mock.return_value = False
grpc_transport.return_value = None
client = UserListServiceClient()
grpc_transport.assert_called_once_with(
ssl_channel_credentials=None,
credentials=None,
host=client.DEFAULT_ENDPOINT,
client_info=transports.base.DEFAULT_CLIENT_INFO,
)
def test_user_list_service_client_client_options():
# Check that if channel is provided we won't create a new one.
with mock.patch(
'google.ads.googleads.v8.services.services.user_list_service.UserListServiceClient.get_transport_class'
) as gtc:
transport = transports.UserListServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials())
client = UserListServiceClient(transport=transport)
gtc.assert_not_called()
# Check that if channel is provided via str we will create a new one.
with mock.patch(
'google.ads.googleads.v8.services.services.user_list_service.UserListServiceClient.get_transport_class'
) as gtc:
client = UserListServiceClient(transport="grpc")
gtc.assert_called()
# Check the case api_endpoint is provided.
options = client_options.ClientOptions(api_endpoint="squid.clam.whelk")
with mock.patch(
'google.ads.googleads.v8.services.services.user_list_service.transports.UserListServiceGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = UserListServiceClient(client_options=options)
grpc_transport.assert_called_once_with(
ssl_channel_credentials=None,
credentials=None,
host="squid.clam.whelk",
client_info=transports.base.DEFAULT_CLIENT_INFO,
)
# Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT
# is "never".
with mock.patch.dict(os.environ,
{"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}):
with mock.patch(
'google.ads.googleads.v8.services.services.user_list_service.transports.UserListServiceGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = UserListServiceClient()
grpc_transport.assert_called_once_with(
ssl_channel_credentials=None,
credentials=None,
host=client.DEFAULT_ENDPOINT,
client_info=transports.base.DEFAULT_CLIENT_INFO,
)
# Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is
# "always".
with mock.patch.dict(os.environ,
{"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}):
with mock.patch(
'google.ads.googleads.v8.services.services.user_list_service.transports.UserListServiceGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = UserListServiceClient()
grpc_transport.assert_called_once_with(
ssl_channel_credentials=None,
credentials=None,
host=client.DEFAULT_MTLS_ENDPOINT,
client_info=transports.base.DEFAULT_CLIENT_INFO,
)
# Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has
# unsupported value.
with mock.patch.dict(os.environ,
{"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}):
with pytest.raises(MutualTLSChannelError):
client = UserListServiceClient()
# Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value.
with mock.patch.dict(os.environ,
{"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}):
with pytest.raises(ValueError):
client = UserListServiceClient()