def test_ad_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) AdServiceClient() adc.assert_called_once_with( scopes=('https://www.googleapis.com/auth/adwords', ))
def test_ad_service_host_with_port(): client = AdServiceClient( 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_ads_field_headers(): client = AdServiceClient( 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 = ad_service.MutateAdsRequest() 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_ads), '__call__') as call: call.return_value = ad_service.MutateAdsResponse() client.mutate_ads(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_ads_flattened(): client = AdServiceClient( credentials=ga_credentials.AnonymousCredentials(), ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client.transport.mutate_ads), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = ad_service.MutateAdsResponse() # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. client.mutate_ads( customer_id='customer_id_value', operations=[ ad_service.AdOperation(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 == [ ad_service.AdOperation(update_mask=field_mask_pb2.FieldMask( paths=['paths_value'])) ]
def test_mutate_ads(transport: str = 'grpc', request_type=ad_service.MutateAdsRequest): client = AdServiceClient( 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_ads), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = ad_service.MutateAdsResponse() response = client.mutate_ads(request) # Establish that the underlying gRPC stub method was called. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] assert args[0] == ad_service.MutateAdsRequest() # Establish that the response is the type that we expect. assert isinstance(response, ad_service.MutateAdsResponse)
def test_transport_grpc_default(): # A client should use the gRPC transport by default. client = AdServiceClient( credentials=ga_credentials.AnonymousCredentials(), ) assert isinstance( client.transport, transports.AdServiceGrpcTransport, )
def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.AdServiceGrpcTransport( credentials=ga_credentials.AnonymousCredentials(), ) with pytest.raises(ValueError): client = AdServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, )
def test_get_ad_flattened_error(): client = AdServiceClient( 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_ad( ad_service.GetAdRequest(), resource_name='resource_name_value', )
def test_ad_service_client_client_options_from_dict(): with mock.patch( 'google.ads.googleads.v7.services.services.ad_service.transports.AdServiceGrpcTransport.__init__' ) as grpc_transport: grpc_transport.return_value = None client = AdServiceClient( 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_ad(transport: str = 'grpc', request_type=ad_service.GetAdRequest): client = AdServiceClient( 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_ad), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = ad.Ad( resource_name='resource_name_value', id=205, final_urls=['final_urls_value'], final_mobile_urls=['final_mobile_urls_value'], tracking_url_template='tracking_url_template_value', final_url_suffix='final_url_suffix_value', display_url='display_url_value', type_=ad_type.AdTypeEnum.AdType.UNKNOWN, added_by_google_ads=True, device_preference=device.DeviceEnum.Device.UNKNOWN, name='name_value', system_managed_resource_source=system_managed_entity_source. SystemManagedResourceSourceEnum.SystemManagedResourceSource. UNKNOWN, text_ad=ad_type_infos.TextAdInfo(headline='headline_value'), ) response = client.get_ad(request) # Establish that the underlying gRPC stub method was called. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] assert args[0] == ad_service.GetAdRequest() # Establish that the response is the type that we expect. assert isinstance(response, ad.Ad) assert response.resource_name == 'resource_name_value' assert response.id == 205 assert response.final_urls == ['final_urls_value'] assert response.final_mobile_urls == ['final_mobile_urls_value'] assert response.tracking_url_template == 'tracking_url_template_value' assert response.final_url_suffix == 'final_url_suffix_value' assert response.display_url == 'display_url_value' assert response.type_ == ad_type.AdTypeEnum.AdType.UNKNOWN assert response.added_by_google_ads is True assert response.device_preference == device.DeviceEnum.Device.UNKNOWN assert response.name == 'name_value' assert response.system_managed_resource_source == system_managed_entity_source.SystemManagedResourceSourceEnum.SystemManagedResourceSource.UNKNOWN
def test_mutate_ads_flattened_error(): client = AdServiceClient( 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_ads( ad_service.MutateAdsRequest(), customer_id='customer_id_value', operations=[ ad_service.AdOperation(update_mask=field_mask_pb2.FieldMask( paths=['paths_value'])) ], )
def test_get_ad_flattened(): client = AdServiceClient( credentials=ga_credentials.AnonymousCredentials(), ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client.transport.get_ad), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = ad.Ad() # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. client.get_ad(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.AdServiceTransport, '_prep_wrapped_messages') as prep: client = AdServiceClient( credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, ) prep.assert_called_once_with(client_info) with mock.patch.object(transports.AdServiceTransport, '_prep_wrapped_messages') as prep: transport_class = AdServiceClient.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.AdServiceGrpcTransport( credentials=ga_credentials.AnonymousCredentials(), ) client = AdServiceClient(transport=transport) assert client.transport is transport
def test_ad_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.v7.services.services.ad_service.transports.AdServiceGrpcTransport.__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 = AdServiceClient(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.v7.services.services.ad_service.transports.AdServiceGrpcTransport.__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 = AdServiceClient() 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.v7.services.services.ad_service.transports.AdServiceGrpcTransport.__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 = AdServiceClient() 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_ad_service_client_client_options(): # Check that if channel is provided we won't create a new one. with mock.patch( 'google.ads.googleads.v7.services.services.ad_service.AdServiceClient.get_transport_class' ) as gtc: transport = transports.AdServiceGrpcTransport( credentials=ga_credentials.AnonymousCredentials()) client = AdServiceClient(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.v7.services.services.ad_service.AdServiceClient.get_transport_class' ) as gtc: client = AdServiceClient(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.v7.services.services.ad_service.transports.AdServiceGrpcTransport.__init__' ) as grpc_transport: grpc_transport.return_value = None client = AdServiceClient(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.v7.services.services.ad_service.transports.AdServiceGrpcTransport.__init__' ) as grpc_transport: grpc_transport.return_value = None client = AdServiceClient() 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.v7.services.services.ad_service.transports.AdServiceGrpcTransport.__init__' ) as grpc_transport: grpc_transport.return_value = None client = AdServiceClient() 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 = AdServiceClient() # 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 = AdServiceClient()