def test_generate_historical_metrics_field_headers():
    client = KeywordPlanServiceClient(
        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_service.GenerateHistoricalMetricsRequest()

    request.keyword_plan = 'keyword_plan/value'

    # Mock the actual call within the gRPC stub, and fake the request.
    with mock.patch.object(type(client.transport.generate_historical_metrics),
                           '__call__') as call:
        call.return_value = keyword_plan_service.GenerateHistoricalMetricsResponse(
        )
        client.generate_historical_metrics(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',
        'keyword_plan=keyword_plan/value',
    ) in kw['metadata']
def test_generate_historical_metrics(
        transport: str = 'grpc',
        request_type=keyword_plan_service.GenerateHistoricalMetricsRequest):
    client = KeywordPlanServiceClient(
        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_historical_metrics),
                           '__call__') as call:
        # Designate an appropriate return value for the call.
        call.return_value = keyword_plan_service.GenerateHistoricalMetricsResponse(
        )
        response = client.generate_historical_metrics(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_service.GenerateHistoricalMetricsRequest()

    # Establish that the response is the type that we expect.
    assert isinstance(response,
                      keyword_plan_service.GenerateHistoricalMetricsResponse)
def test_mutate_keyword_plans_flattened():
    client = KeywordPlanServiceClient(
        credentials=ga_credentials.AnonymousCredentials(), )

    # Mock the actual call within the gRPC stub, and fake the request.
    with mock.patch.object(type(client.transport.mutate_keyword_plans),
                           '__call__') as call:
        # Designate an appropriate return value for the call.
        call.return_value = keyword_plan_service.MutateKeywordPlansResponse()
        # Call the method with a truthy value for each flattened field,
        # using the keyword arguments to the method.
        client.mutate_keyword_plans(
            customer_id='customer_id_value',
            operations=[
                keyword_plan_service.KeywordPlanOperation(
                    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 == [
            keyword_plan_service.KeywordPlanOperation(
                update_mask=field_mask_pb2.FieldMask(paths=['paths_value']))
        ]
def test_parse_common_project_path():
    expected = {
        "project": "abalone",
    }
    path = KeywordPlanServiceClient.common_project_path(**expected)

    # Check that the path construction is reversible.
    actual = KeywordPlanServiceClient.parse_common_project_path(path)
    assert expected == actual
def test_parse_common_organization_path():
    expected = {
        "organization": "nautilus",
    }
    path = KeywordPlanServiceClient.common_organization_path(**expected)

    # Check that the path construction is reversible.
    actual = KeywordPlanServiceClient.parse_common_organization_path(path)
    assert expected == actual
def test_parse_common_folder_path():
    expected = {
        "folder": "mussel",
    }
    path = KeywordPlanServiceClient.common_folder_path(**expected)

    # Check that the path construction is reversible.
    actual = KeywordPlanServiceClient.parse_common_folder_path(path)
    assert expected == actual
def test_parse_common_billing_account_path():
    expected = {
        "billing_account": "nudibranch",
    }
    path = KeywordPlanServiceClient.common_billing_account_path(**expected)

    # Check that the path construction is reversible.
    actual = KeywordPlanServiceClient.parse_common_billing_account_path(path)
    assert expected == actual
def test_parse_common_location_path():
    expected = {
        "project": "whelk",
        "location": "octopus",
    }
    path = KeywordPlanServiceClient.common_location_path(**expected)

    # Check that the path construction is reversible.
    actual = KeywordPlanServiceClient.parse_common_location_path(path)
    assert expected == actual
def test_parse_keyword_plan_path():
    expected = {
        "customer": "whelk",
        "keyword_plan": "octopus",
    }
    path = KeywordPlanServiceClient.keyword_plan_path(**expected)

    # Check that the path construction is reversible.
    actual = KeywordPlanServiceClient.parse_keyword_plan_path(path)
    assert expected == actual
def test_generate_historical_metrics_flattened_error():
    client = KeywordPlanServiceClient(
        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.generate_historical_metrics(
            keyword_plan_service.GenerateHistoricalMetricsRequest(),
            keyword_plan='keyword_plan_value',
        )
def test_get_keyword_plan_flattened_error():
    client = KeywordPlanServiceClient(
        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_keyword_plan(
            keyword_plan_service.GetKeywordPlanRequest(),
            resource_name='resource_name_value',
        )
def test_keyword_plan_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 = KeywordPlanServiceClient.from_service_account_file(
            "dummy/file/path.json")
        assert client.transport._credentials == creds

        client = KeywordPlanServiceClient.from_service_account_json(
            "dummy/file/path.json")
        assert client.transport._credentials == creds

        assert client.transport._host == 'googleads.googleapis.com:443'
def test_mutate_keyword_plans_flattened_error():
    client = KeywordPlanServiceClient(
        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_keyword_plans(
            keyword_plan_service.MutateKeywordPlansRequest(),
            customer_id='customer_id_value',
            operations=[
                keyword_plan_service.KeywordPlanOperation(
                    update_mask=field_mask_pb2.FieldMask(
                        paths=['paths_value']))
            ],
        )
def test_keyword_plan_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)
        KeywordPlanServiceClient()
        adc.assert_called_once_with(
            scopes=('https://www.googleapis.com/auth/adwords', ))
def test_common_billing_account_path():
    billing_account = "oyster"
    expected = "billingAccounts/{billing_account}".format(
        billing_account=billing_account, )
    actual = KeywordPlanServiceClient.common_billing_account_path(
        billing_account)
    assert expected == actual
def test_keyword_plan_service_host_with_port():
    client = KeywordPlanServiceClient(
        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 = KeywordPlanServiceClient(
        credentials=ga_credentials.AnonymousCredentials(), )
    assert isinstance(
        client.transport,
        transports.KeywordPlanServiceGrpcTransport,
    )
def test_common_location_path():
    project = "squid"
    location = "clam"
    expected = "projects/{project}/locations/{location}".format(
        project=project,
        location=location,
    )
    actual = KeywordPlanServiceClient.common_location_path(project, location)
    assert expected == actual
def test_get_keyword_plan_flattened():
    client = KeywordPlanServiceClient(
        credentials=ga_credentials.AnonymousCredentials(), )

    # Mock the actual call within the gRPC stub, and fake the request.
    with mock.patch.object(type(client.transport.get_keyword_plan),
                           '__call__') as call:
        # Designate an appropriate return value for the call.
        call.return_value = keyword_plan.KeywordPlan()
        # Call the method with a truthy value for each flattened field,
        # using the keyword arguments to the method.
        client.get_keyword_plan(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.KeywordPlanServiceGrpcTransport(
        credentials=ga_credentials.AnonymousCredentials(), )
    with pytest.raises(ValueError):
        client = KeywordPlanServiceClient(
            credentials=ga_credentials.AnonymousCredentials(),
            transport=transport,
        )
def test_keyword_plan_path():
    customer = "squid"
    keyword_plan = "clam"
    expected = "customers/{customer}/keywordPlans/{keyword_plan}".format(
        customer=customer,
        keyword_plan=keyword_plan,
    )
    actual = KeywordPlanServiceClient.keyword_plan_path(customer, keyword_plan)
    assert expected == actual
def test_client_withDEFAULT_CLIENT_INFO():
    client_info = gapic_v1.client_info.ClientInfo()

    with mock.patch.object(transports.KeywordPlanServiceTransport,
                           '_prep_wrapped_messages') as prep:
        client = KeywordPlanServiceClient(
            credentials=ga_credentials.AnonymousCredentials(),
            client_info=client_info,
        )
        prep.assert_called_once_with(client_info)

    with mock.patch.object(transports.KeywordPlanServiceTransport,
                           '_prep_wrapped_messages') as prep:
        transport_class = KeywordPlanServiceClient.get_transport_class()
        transport = transport_class(
            credentials=ga_credentials.AnonymousCredentials(),
            client_info=client_info,
        )
        prep.assert_called_once_with(client_info)
def test_keyword_plan_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 = KeywordPlanServiceClient.from_service_account_info(info)
        assert client.transport._credentials == creds

        assert client.transport._host == 'googleads.googleapis.com:443'
def test_keyword_plan_service_client_client_options_from_dict():
    with mock.patch(
            'google.ads.googleads.v4.services.services.keyword_plan_service.transports.KeywordPlanServiceGrpcTransport.__init__'
    ) as grpc_transport:
        grpc_transport.return_value = None
        client = KeywordPlanServiceClient(
            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 KeywordPlanServiceClient._get_default_mtls_endpoint(None) is None
    assert KeywordPlanServiceClient._get_default_mtls_endpoint(
        api_endpoint) == api_mtls_endpoint
    assert KeywordPlanServiceClient._get_default_mtls_endpoint(
        api_mtls_endpoint) == api_mtls_endpoint
    assert KeywordPlanServiceClient._get_default_mtls_endpoint(
        sandbox_endpoint) == sandbox_mtls_endpoint
    assert KeywordPlanServiceClient._get_default_mtls_endpoint(
        sandbox_mtls_endpoint) == sandbox_mtls_endpoint
    assert KeywordPlanServiceClient._get_default_mtls_endpoint(
        non_googleapi) == non_googleapi
def test_common_organization_path():
    organization = "winkle"
    expected = "organizations/{organization}".format(
        organization=organization, )
    actual = KeywordPlanServiceClient.common_organization_path(organization)
    assert expected == actual
def test_common_project_path():
    project = "scallop"
    expected = "projects/{project}".format(project=project, )
    actual = KeywordPlanServiceClient.common_project_path(project)
    assert expected == actual
def test_keyword_plan_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_service.KeywordPlanServiceClient.get_transport_class'
    ) as gtc:
        transport = transports.KeywordPlanServiceGrpcTransport(
            credentials=ga_credentials.AnonymousCredentials())
        client = KeywordPlanServiceClient(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_service.KeywordPlanServiceClient.get_transport_class'
    ) as gtc:
        client = KeywordPlanServiceClient(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_service.transports.KeywordPlanServiceGrpcTransport.__init__'
    ) as grpc_transport:
        grpc_transport.return_value = None
        client = KeywordPlanServiceClient(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_service.transports.KeywordPlanServiceGrpcTransport.__init__'
        ) as grpc_transport:
            grpc_transport.return_value = None
            client = KeywordPlanServiceClient()
            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_service.transports.KeywordPlanServiceGrpcTransport.__init__'
        ) as grpc_transport:
            grpc_transport.return_value = None
            client = KeywordPlanServiceClient()
            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 = KeywordPlanServiceClient()

    # 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 = KeywordPlanServiceClient()
def test_transport_instance():
    # A client may be instantiated with a custom transport instance.
    transport = transports.KeywordPlanServiceGrpcTransport(
        credentials=ga_credentials.AnonymousCredentials(), )
    client = KeywordPlanServiceClient(transport=transport)
    assert client.transport is transport
def test_keyword_plan_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_service.transports.KeywordPlanServiceGrpcTransport.__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 = KeywordPlanServiceClient(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_service.transports.KeywordPlanServiceGrpcTransport.__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 = KeywordPlanServiceClient()
                        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_service.transports.KeywordPlanServiceGrpcTransport.__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 = KeywordPlanServiceClient()
                    grpc_transport.assert_called_once_with(
                        ssl_channel_credentials=None,
                        credentials=None,
                        host=client.DEFAULT_ENDPOINT,
                        client_info=transports.base.DEFAULT_CLIENT_INFO,
                    )