def test_keyword_plan_idea_service_host_with_port():
client = KeywordPlanIdeaServiceClient(
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_generate_keyword_ideas_field_headers():
client = KeywordPlanIdeaServiceClient(
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 = keyword_plan_idea_service.GenerateKeywordIdeasRequest()
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.generate_keyword_ideas),
'__call__') as call:
call.return_value = keyword_plan_idea_service.GenerateKeywordIdeaResponse(
)
client.generate_keyword_ideas(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_keyword_plan_idea_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)
KeywordPlanIdeaServiceClient()
adc.assert_called_once_with(
scopes=('https://www.googleapis.com/auth/adwords', ))
def test_generate_keyword_ideas(
transport: str = 'grpc',
request_type=keyword_plan_idea_service.GenerateKeywordIdeasRequest):
client = KeywordPlanIdeaServiceClient(
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.generate_keyword_ideas),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = keyword_plan_idea_service.GenerateKeywordIdeaResponse(
next_page_token='next_page_token_value',
total_size=1086,
)
response = client.generate_keyword_ideas(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[
0] == keyword_plan_idea_service.GenerateKeywordIdeasRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, pagers.GenerateKeywordIdeasPager)
assert response.next_page_token == 'next_page_token_value'
assert response.total_size == 1086
def test_transport_grpc_default():
# A client should use the gRPC transport by default.
client = KeywordPlanIdeaServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
assert isinstance(
client.transport,
transports.KeywordPlanIdeaServiceGrpcTransport,
)
def test_credentials_transport_error():
# It is an error to provide credentials and a transport instance.
transport = transports.KeywordPlanIdeaServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = KeywordPlanIdeaServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
transport=transport,
)
def test_keyword_plan_idea_service_client_client_options_from_dict():
with mock.patch(
'google.ads.googleads.v4.services.services.keyword_plan_idea_service.transports.KeywordPlanIdeaServiceGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = KeywordPlanIdeaServiceClient(
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_generate_keyword_ideas_pager():
client = KeywordPlanIdeaServiceClient(
credentials=ga_credentials.AnonymousCredentials, )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.generate_keyword_ideas),
'__call__') as call:
# Set the response to a series of pages.
call.side_effect = (
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
],
next_page_token='abc',
),
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[],
next_page_token='def',
),
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
],
next_page_token='ghi',
),
keyword_plan_idea_service.GenerateKeywordIdeaResponse(results=[
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
], ),
RuntimeError,
)
metadata = ()
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(('customer_id', ''), )), )
pager = client.generate_keyword_ideas(request={})
assert pager._metadata == metadata
results = [i for i in pager]
assert len(results) == 6
assert all(
isinstance(i, keyword_plan_idea_service.GenerateKeywordIdeaResult)
for i in results)
def test_client_withDEFAULT_CLIENT_INFO():
client_info = gapic_v1.client_info.ClientInfo()
with mock.patch.object(transports.KeywordPlanIdeaServiceTransport,
'_prep_wrapped_messages') as prep:
client = KeywordPlanIdeaServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
with mock.patch.object(transports.KeywordPlanIdeaServiceTransport,
'_prep_wrapped_messages') as prep:
transport_class = KeywordPlanIdeaServiceClient.get_transport_class()
transport = transport_class(
credentials=ga_credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
def test_generate_keyword_ideas_pages():
client = KeywordPlanIdeaServiceClient(
credentials=ga_credentials.AnonymousCredentials, )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.generate_keyword_ideas),
'__call__') as call:
# Set the response to a series of pages.
call.side_effect = (
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
],
next_page_token='abc',
),
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[],
next_page_token='def',
),
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
],
next_page_token='ghi',
),
keyword_plan_idea_service.GenerateKeywordIdeaResponse(results=[
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
], ),
RuntimeError,
)
pages = list(client.generate_keyword_ideas(request={}).pages)
for page_, token in zip(pages, ['abc', 'def', 'ghi', '']):
assert page_.raw_page.next_page_token == token
def test_transport_instance():
# A client may be instantiated with a custom transport instance.
transport = transports.KeywordPlanIdeaServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(), )
client = KeywordPlanIdeaServiceClient(transport=transport)
assert client.transport is transport
def test_keyword_plan_idea_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.v4.services.services.keyword_plan_idea_service.transports.KeywordPlanIdeaServiceGrpcTransport.__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 = KeywordPlanIdeaServiceClient(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.v4.services.services.keyword_plan_idea_service.transports.KeywordPlanIdeaServiceGrpcTransport.__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 = KeywordPlanIdeaServiceClient()
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.v4.services.services.keyword_plan_idea_service.transports.KeywordPlanIdeaServiceGrpcTransport.__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 = KeywordPlanIdeaServiceClient()
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_keyword_plan_idea_service_client_client_options():
# Check that if channel is provided we won't create a new one.
with mock.patch(
'google.ads.googleads.v4.services.services.keyword_plan_idea_service.KeywordPlanIdeaServiceClient.get_transport_class'
) as gtc:
transport = transports.KeywordPlanIdeaServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials())
client = KeywordPlanIdeaServiceClient(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.v4.services.services.keyword_plan_idea_service.KeywordPlanIdeaServiceClient.get_transport_class'
) as gtc:
client = KeywordPlanIdeaServiceClient(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.v4.services.services.keyword_plan_idea_service.transports.KeywordPlanIdeaServiceGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = KeywordPlanIdeaServiceClient(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.v4.services.services.keyword_plan_idea_service.transports.KeywordPlanIdeaServiceGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = KeywordPlanIdeaServiceClient()
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.v4.services.services.keyword_plan_idea_service.transports.KeywordPlanIdeaServiceGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = KeywordPlanIdeaServiceClient()
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 = KeywordPlanIdeaServiceClient()
# 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 = KeywordPlanIdeaServiceClient()