def test_ad_group_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) AdGroupServiceClient() adc.assert_called_once_with( scopes=('https://www.googleapis.com/auth/adwords', ))
def test_ad_group_service_host_with_port(): client = AdGroupServiceClient( 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_ad_groups_field_headers(): client = AdGroupServiceClient( 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_group_service.MutateAdGroupsRequest() 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_ad_groups), '__call__') as call: call.return_value = ad_group_service.MutateAdGroupsResponse() client.mutate_ad_groups(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_ad_groups_flattened(): client = AdGroupServiceClient( credentials=ga_credentials.AnonymousCredentials(), ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client.transport.mutate_ad_groups), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = ad_group_service.MutateAdGroupsResponse() # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. client.mutate_ad_groups( customer_id='customer_id_value', operations=[ ad_group_service.AdGroupOperation( 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_group_service.AdGroupOperation( update_mask=field_mask_pb2.FieldMask(paths=['paths_value'])) ]
def test_mutate_ad_groups(transport: str = 'grpc', request_type=ad_group_service.MutateAdGroupsRequest): client = AdGroupServiceClient( 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_ad_groups), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = ad_group_service.MutateAdGroupsResponse() response = client.mutate_ad_groups(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_group_service.MutateAdGroupsRequest() # Establish that the response is the type that we expect. assert isinstance(response, ad_group_service.MutateAdGroupsResponse)
def test_transport_grpc_default(): # A client should use the gRPC transport by default. client = AdGroupServiceClient( credentials=ga_credentials.AnonymousCredentials(), ) assert isinstance( client.transport, transports.AdGroupServiceGrpcTransport, )
def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.AdGroupServiceGrpcTransport( credentials=ga_credentials.AnonymousCredentials(), ) with pytest.raises(ValueError): client = AdGroupServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, )
def test_get_ad_group_flattened_error(): client = AdGroupServiceClient( 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_group( ad_group_service.GetAdGroupRequest(), resource_name='resource_name_value', )
def test_ad_group_service_client_client_options_from_dict(): with mock.patch( 'google.ads.googleads.v6.services.services.ad_group_service.transports.AdGroupServiceGrpcTransport.__init__' ) as grpc_transport: grpc_transport.return_value = None client = AdGroupServiceClient( 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_ad_groups_flattened_error(): client = AdGroupServiceClient( 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_ad_groups( ad_group_service.MutateAdGroupsRequest(), customer_id='customer_id_value', operations=[ ad_group_service.AdGroupOperation( update_mask=field_mask_pb2.FieldMask( paths=['paths_value'])) ], )
def test_get_ad_group_flattened(): client = AdGroupServiceClient( 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_group), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = ad_group.AdGroup() # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. client.get_ad_group(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.AdGroupServiceTransport, '_prep_wrapped_messages') as prep: client = AdGroupServiceClient( credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, ) prep.assert_called_once_with(client_info) with mock.patch.object(transports.AdGroupServiceTransport, '_prep_wrapped_messages') as prep: transport_class = AdGroupServiceClient.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.AdGroupServiceGrpcTransport( credentials=ga_credentials.AnonymousCredentials(), ) client = AdGroupServiceClient(transport=transport) assert client.transport is transport
def test_get_ad_group(transport: str = 'grpc', request_type=ad_group_service.GetAdGroupRequest): client = AdGroupServiceClient( 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_group), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = ad_group.AdGroup( resource_name='resource_name_value', id=205, name='name_value', status=ad_group_status.AdGroupStatusEnum.AdGroupStatus.UNKNOWN, type_=ad_group_type.AdGroupTypeEnum.AdGroupType.UNKNOWN, ad_rotation_mode=ad_group_ad_rotation_mode. AdGroupAdRotationModeEnum.AdGroupAdRotationMode.UNKNOWN, base_ad_group='base_ad_group_value', tracking_url_template='tracking_url_template_value', campaign='campaign_value', cpc_bid_micros=1456, cpm_bid_micros=1466, target_cpa_micros=1798, cpv_bid_micros=1475, target_cpm_micros=1810, target_roas=0.1179, percent_cpc_bid_micros=2304, display_custom_bid_dimension=targeting_dimension. TargetingDimensionEnum.TargetingDimension.UNKNOWN, final_url_suffix='final_url_suffix_value', effective_target_cpa_micros=2838, effective_target_cpa_source=bidding_source.BiddingSourceEnum. BiddingSource.UNKNOWN, effective_target_roas=0.2219, effective_target_roas_source=bidding_source.BiddingSourceEnum. BiddingSource.UNKNOWN, labels=['labels_value'], ) response = client.get_ad_group(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_group_service.GetAdGroupRequest() # Establish that the response is the type that we expect. assert isinstance(response, ad_group.AdGroup) assert response.resource_name == 'resource_name_value' assert response.id == 205 assert response.name == 'name_value' assert response.status == ad_group_status.AdGroupStatusEnum.AdGroupStatus.UNKNOWN assert response.type_ == ad_group_type.AdGroupTypeEnum.AdGroupType.UNKNOWN assert response.ad_rotation_mode == ad_group_ad_rotation_mode.AdGroupAdRotationModeEnum.AdGroupAdRotationMode.UNKNOWN assert response.base_ad_group == 'base_ad_group_value' assert response.tracking_url_template == 'tracking_url_template_value' assert response.campaign == 'campaign_value' assert response.cpc_bid_micros == 1456 assert response.cpm_bid_micros == 1466 assert response.target_cpa_micros == 1798 assert response.cpv_bid_micros == 1475 assert response.target_cpm_micros == 1810 assert math.isclose(response.target_roas, 0.1179, rel_tol=1e-6) assert response.percent_cpc_bid_micros == 2304 assert response.display_custom_bid_dimension == targeting_dimension.TargetingDimensionEnum.TargetingDimension.UNKNOWN assert response.final_url_suffix == 'final_url_suffix_value' assert response.effective_target_cpa_micros == 2838 assert response.effective_target_cpa_source == bidding_source.BiddingSourceEnum.BiddingSource.UNKNOWN assert math.isclose(response.effective_target_roas, 0.2219, rel_tol=1e-6) assert response.effective_target_roas_source == bidding_source.BiddingSourceEnum.BiddingSource.UNKNOWN assert response.labels == ['labels_value']
def test_ad_group_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.v6.services.services.ad_group_service.transports.AdGroupServiceGrpcTransport.__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 = AdGroupServiceClient(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.v6.services.services.ad_group_service.transports.AdGroupServiceGrpcTransport.__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 = AdGroupServiceClient() 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.v6.services.services.ad_group_service.transports.AdGroupServiceGrpcTransport.__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 = AdGroupServiceClient() 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_group_service_client_client_options(): # Check that if channel is provided we won't create a new one. with mock.patch( 'google.ads.googleads.v6.services.services.ad_group_service.AdGroupServiceClient.get_transport_class' ) as gtc: transport = transports.AdGroupServiceGrpcTransport( credentials=ga_credentials.AnonymousCredentials()) client = AdGroupServiceClient(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.v6.services.services.ad_group_service.AdGroupServiceClient.get_transport_class' ) as gtc: client = AdGroupServiceClient(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.v6.services.services.ad_group_service.transports.AdGroupServiceGrpcTransport.__init__' ) as grpc_transport: grpc_transport.return_value = None client = AdGroupServiceClient(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.v6.services.services.ad_group_service.transports.AdGroupServiceGrpcTransport.__init__' ) as grpc_transport: grpc_transport.return_value = None client = AdGroupServiceClient() 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.v6.services.services.ad_group_service.transports.AdGroupServiceGrpcTransport.__init__' ) as grpc_transport: grpc_transport.return_value = None client = AdGroupServiceClient() 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 = AdGroupServiceClient() # 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 = AdGroupServiceClient()