def test_list_environments(transport: str = "grpc",
request_type=environment.ListEnvironmentsRequest):
client = EnvironmentsClient(
credentials=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.list_environments),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = environment.ListEnvironmentsResponse(
next_page_token="next_page_token_value", )
response = client.list_environments(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == environment.ListEnvironmentsRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, pagers.ListEnvironmentsPager)
assert response.next_page_token == "next_page_token_value"
def test_list_environments_field_headers():
client = EnvironmentsClient(
credentials=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 = environment.ListEnvironmentsRequest()
request.parent = "parent/value"
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.list_environments),
"__call__") as call:
call.return_value = environment.ListEnvironmentsResponse()
client.list_environments(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",
"parent=parent/value",
) in kw["metadata"]
def test_list_environments_pages():
client = EnvironmentsClient(credentials=credentials.AnonymousCredentials, )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.list_environments),
"__call__") as call:
# Set the response to a series of pages.
call.side_effect = (
environment.ListEnvironmentsResponse(
environments=[
environment.Environment(),
environment.Environment(),
environment.Environment(),
],
next_page_token="abc",
),
environment.ListEnvironmentsResponse(
environments=[],
next_page_token="def",
),
environment.ListEnvironmentsResponse(
environments=[
environment.Environment(),
],
next_page_token="ghi",
),
environment.ListEnvironmentsResponse(environments=[
environment.Environment(),
environment.Environment(),
], ),
RuntimeError,
)
pages = list(client.list_environments(request={}).pages)
for page_, token in zip(pages, ["abc", "def", "ghi", ""]):
assert page_.raw_page.next_page_token == token
def test_credentials_transport_error():
# It is an error to provide credentials and a transport instance.
transport = transports.EnvironmentsGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = EnvironmentsClient(
credentials=credentials.AnonymousCredentials(),
transport=transport,
)
# It is an error to provide a credentials file and a transport instance.
transport = transports.EnvironmentsGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = EnvironmentsClient(
client_options={"credentials_file": "credentials.json"},
transport=transport,
)
# It is an error to provide scopes and a transport instance.
transport = transports.EnvironmentsGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = EnvironmentsClient(
client_options={"scopes": ["1", "2"]},
transport=transport,
)
def test_parse_common_project_path():
expected = {
"project": "abalone",
}
path = EnvironmentsClient.common_project_path(**expected)
# Check that the path construction is reversible.
actual = EnvironmentsClient.parse_common_project_path(path)
assert expected == actual
def test_parse_common_organization_path():
expected = {
"organization": "nautilus",
}
path = EnvironmentsClient.common_organization_path(**expected)
# Check that the path construction is reversible.
actual = EnvironmentsClient.parse_common_organization_path(path)
assert expected == actual
def test_parse_common_folder_path():
expected = {
"folder": "mussel",
}
path = EnvironmentsClient.common_folder_path(**expected)
# Check that the path construction is reversible.
actual = EnvironmentsClient.parse_common_folder_path(path)
assert expected == actual
def test_parse_common_billing_account_path():
expected = {
"billing_account": "nudibranch",
}
path = EnvironmentsClient.common_billing_account_path(**expected)
# Check that the path construction is reversible.
actual = EnvironmentsClient.parse_common_billing_account_path(path)
assert expected == actual
def test_environments_client_get_transport_class():
transport = EnvironmentsClient.get_transport_class()
available_transports = [
transports.EnvironmentsGrpcTransport,
]
assert transport in available_transports
transport = EnvironmentsClient.get_transport_class("grpc")
assert transport == transports.EnvironmentsGrpcTransport
def test_parse_common_location_path():
expected = {
"project": "whelk",
"location": "octopus",
}
path = EnvironmentsClient.common_location_path(**expected)
# Check that the path construction is reversible.
actual = EnvironmentsClient.parse_common_location_path(path)
assert expected == actual
def test_list_environments_flattened_error():
client = EnvironmentsClient(
credentials=credentials.AnonymousCredentials(), )
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.list_environments(
environment.ListEnvironmentsRequest(),
parent="parent_value",
)
def test_common_organization_path():
organization = "winkle"
expected = "organizations/{organization}".format(
organization=organization, )
actual = EnvironmentsClient.common_organization_path(organization)
assert expected == actual
def test_common_billing_account_path():
billing_account = "oyster"
expected = "billingAccounts/{billing_account}".format(
billing_account=billing_account, )
actual = EnvironmentsClient.common_billing_account_path(billing_account)
assert expected == actual
def test_list_environments_empty_call():
# This test is a coverage failsafe to make sure that totally empty calls,
# i.e. request == None and no flattened fields passed, work.
client = EnvironmentsClient(
credentials=credentials.AnonymousCredentials(),
transport="grpc",
)
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.list_environments),
"__call__") as call:
client.list_environments()
call.assert_called()
_, args, _ = call.mock_calls[0]
assert args[0] == environment.ListEnvironmentsRequest()
def test_environments_host_with_port():
client = EnvironmentsClient(
credentials=credentials.AnonymousCredentials(),
client_options=client_options.ClientOptions(
api_endpoint="dialogflow.googleapis.com:8000"),
)
assert client.transport._host == "dialogflow.googleapis.com:8000"
def test_transport_grpc_default():
# A client should use the gRPC transport by default.
client = EnvironmentsClient(
credentials=credentials.AnonymousCredentials(), )
assert isinstance(
client.transport,
transports.EnvironmentsGrpcTransport,
)
def test_environment_path():
project = "squid"
environment = "clam"
expected = "projects/{project}/agent/environments/{environment}".format(
project=project,
environment=environment,
)
actual = EnvironmentsClient.environment_path(project, environment)
assert expected == actual
def test_list_environments_pager():
client = EnvironmentsClient(credentials=credentials.AnonymousCredentials, )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.list_environments),
"__call__") as call:
# Set the response to a series of pages.
call.side_effect = (
environment.ListEnvironmentsResponse(
environments=[
environment.Environment(),
environment.Environment(),
environment.Environment(),
],
next_page_token="abc",
),
environment.ListEnvironmentsResponse(
environments=[],
next_page_token="def",
),
environment.ListEnvironmentsResponse(
environments=[
environment.Environment(),
],
next_page_token="ghi",
),
environment.ListEnvironmentsResponse(environments=[
environment.Environment(),
environment.Environment(),
], ),
RuntimeError,
)
metadata = ()
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("parent", ""), )), )
pager = client.list_environments(request={})
assert pager._metadata == metadata
results = [i for i in pager]
assert len(results) == 6
assert all(isinstance(i, environment.Environment) for i in results)
def test_common_location_path():
project = "squid"
location = "clam"
expected = "projects/{project}/locations/{location}".format(
project=project,
location=location,
)
actual = EnvironmentsClient.common_location_path(project, location)
assert expected == actual
def test_client_withDEFAULT_CLIENT_INFO():
client_info = gapic_v1.client_info.ClientInfo()
with mock.patch.object(transports.EnvironmentsTransport,
"_prep_wrapped_messages") as prep:
client = EnvironmentsClient(
credentials=credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
with mock.patch.object(transports.EnvironmentsTransport,
"_prep_wrapped_messages") as prep:
transport_class = EnvironmentsClient.get_transport_class()
transport = transport_class(
credentials=credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
def test_list_environments_flattened():
client = EnvironmentsClient(
credentials=credentials.AnonymousCredentials(), )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.list_environments),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = environment.ListEnvironmentsResponse()
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.list_environments(parent="parent_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].parent == "parent_value"
def test_environments_auth_adc():
# If no credentials are provided, we should use ADC credentials.
with mock.patch.object(auth, "default") as adc:
adc.return_value = (credentials.AnonymousCredentials(), None)
EnvironmentsClient()
adc.assert_called_once_with(
scopes=(
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow",
),
quota_project_id=None,
)
def test_environments_client_client_options_from_dict():
with mock.patch(
"google.cloud.dialogflow_v2beta1.services.environments.transports.EnvironmentsGrpcTransport.__init__"
) as grpc_transport:
grpc_transport.return_value = None
client = EnvironmentsClient(
client_options={"api_endpoint": "squid.clam.whelk"})
grpc_transport.assert_called_once_with(
credentials=None,
credentials_file=None,
host="squid.clam.whelk",
scopes=None,
ssl_channel_credentials=None,
quota_project_id=None,
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 EnvironmentsClient._get_default_mtls_endpoint(None) is None
assert (EnvironmentsClient._get_default_mtls_endpoint(api_endpoint) ==
api_mtls_endpoint)
assert (EnvironmentsClient._get_default_mtls_endpoint(api_mtls_endpoint) ==
api_mtls_endpoint)
assert (EnvironmentsClient._get_default_mtls_endpoint(sandbox_endpoint) ==
sandbox_mtls_endpoint)
assert (EnvironmentsClient._get_default_mtls_endpoint(
sandbox_mtls_endpoint) == sandbox_mtls_endpoint)
assert EnvironmentsClient._get_default_mtls_endpoint(
non_googleapi) == non_googleapi
def test_environments_client_get_transport_class():
transport = EnvironmentsClient.get_transport_class()
assert transport == transports.EnvironmentsGrpcTransport
transport = EnvironmentsClient.get_transport_class("grpc")
assert transport == transports.EnvironmentsGrpcTransport
def test_transport_instance():
# A client may be instantiated with a custom transport instance.
transport = transports.EnvironmentsGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
client = EnvironmentsClient(transport=transport)
assert client.transport is transport
def test_common_folder_path():
folder = "cuttlefish"
expected = "folders/{folder}".format(folder=folder, )
actual = EnvironmentsClient.common_folder_path(folder)
assert expected == actual
def test_common_project_path():
project = "scallop"
expected = "projects/{project}".format(project=project, )
actual = EnvironmentsClient.common_project_path(project)
assert expected == actual
