def test_list_users_pages():
client = IdentityClient(credentials=credentials.AnonymousCredentials, )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.list_users),
'__call__') as call:
# Set the response to a series of pages.
call.side_effect = (
identity.ListUsersResponse(
users=[
identity.User(),
identity.User(),
identity.User(),
],
next_page_token='abc',
),
identity.ListUsersResponse(
users=[],
next_page_token='def',
),
identity.ListUsersResponse(
users=[
identity.User(),
],
next_page_token='ghi',
),
identity.ListUsersResponse(users=[
identity.User(),
identity.User(),
], ),
RuntimeError,
)
pages = list(client.list_users(request={}).pages)
for page, token in zip(pages, ['abc', 'def', 'ghi', '']):
assert page.raw_page.next_page_token == token
def test_list_users(transport: str = 'grpc'):
client = IdentityClient(
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 = identity.ListUsersRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.list_users),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = identity.ListUsersResponse(
next_page_token='next_page_token_value', )
response = client.list_users(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 response is the type that we expect.
assert isinstance(response, pagers.ListUsersPager)
assert response.next_page_token == 'next_page_token_value'
def test_list_users_pager():
client = IdentityClient(credentials=credentials.AnonymousCredentials, )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.list_users),
'__call__') as call:
# Set the response to a series of pages.
call.side_effect = (
identity.ListUsersResponse(
users=[
identity.User(),
identity.User(),
identity.User(),
],
next_page_token='abc',
),
identity.ListUsersResponse(
users=[],
next_page_token='def',
),
identity.ListUsersResponse(
users=[
identity.User(),
],
next_page_token='ghi',
),
identity.ListUsersResponse(users=[
identity.User(),
identity.User(),
], ),
RuntimeError,
)
results = [i for i in client.list_users(request={}, )]
assert len(results) == 6
assert all(isinstance(i, identity.User) for i in results)
def test_get_user_field_headers():
client = IdentityClient(
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 = identity.GetUserRequest(
name='name/value',
)
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(
type(client._transport.get_user),
'__call__') as call:
call.return_value = identity.User()
response = client.get_user(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',
'name=name/value',
) in kw['metadata']
def test_create_user_flattened():
client = IdentityClient(
credentials=credentials.AnonymousCredentials(),
)
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(
type(client._transport.create_user),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = identity.User()
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
response = client.create_user(
display_name='display_name_value',
email='email_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].user.display_name == 'display_name_value'
assert args[0].user.email == 'email_value'
def test_delete_user_flattened_error():
client = IdentityClient(credentials=credentials.AnonymousCredentials(), )
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.delete_user(
identity.DeleteUserRequest(),
name='name_value',
)
def test_create_user_flattened_error():
client = IdentityClient(credentials=credentials.AnonymousCredentials(), )
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.create_user(
identity.CreateUserRequest(),
display_name='display_name_value',
email='email_value',
)
def test_identity_client_from_service_account_file():
creds = credentials.AnonymousCredentials()
with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory:
factory.return_value = creds
client = IdentityClient.from_service_account_file("dummy/file/path.json")
assert client._transport._credentials == creds
client = IdentityClient.from_service_account_json("dummy/file/path.json")
assert client._transport._credentials == creds
assert client._transport._host == 'localhost:7469'
def test_transport_grpc_default():
# A client should use the gRPC transport by default.
client = IdentityClient(credentials=credentials.AnonymousCredentials(), )
assert isinstance(
client._transport,
transports.IdentityGrpcTransport,
)
def test_identity_client_client_options_from_dict():
with mock.patch('google.showcase_v1beta1.services.identity.IdentityClient.get_transport_class') as gtc:
transport = gtc.return_value = mock.MagicMock()
client = IdentityClient(
client_options={'api_endpoint': 'squid.clam.whelk'}
)
transport.assert_called_once_with(credentials=None, host="squid.clam.whelk")
def test_identity_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)
client = IdentityClient()
adc.assert_called_once_with(scopes=(
))
def test_transport_instance():
# A client may be instantiated with a custom transport instance.
transport = transports.IdentityGrpcTransport(
credentials=credentials.AnonymousCredentials(),
)
client = IdentityClient(transport=transport)
assert client._transport is transport
def test_identity_host_no_port():
client = IdentityClient(
credentials=credentials.AnonymousCredentials(),
client_options=client_options.ClientOptions(api_endpoint='localhost'),
transport='grpc',
)
assert client._transport._host == 'localhost:443'
def test_credentials_transport_error():
# It is an error to provide credentials and a transport instance.
transport = transports.IdentityGrpcTransport(
credentials=credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = IdentityClient(
credentials=credentials.AnonymousCredentials(),
transport=transport,
)
def test_identity_client_client_options():
# Check the default options have their expected values.
assert IdentityClient.DEFAULT_OPTIONS.api_endpoint == 'localhost:7469'
# Check that options can be customized.
options = client_options.ClientOptions(api_endpoint="squid.clam.whelk")
with mock.patch('google.showcase_v1beta1.services.identity.IdentityClient.get_transport_class') as gtc:
transport = gtc.return_value = mock.MagicMock()
client = IdentityClient(
client_options=options
)
transport.assert_called_once_with(credentials=None, host="squid.clam.whelk")
def test_identity_client_client_options_from_dict():
with mock.patch(
'google.showcase_v1beta1.services.identity.transports.IdentityGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = IdentityClient(
client_options={'api_endpoint': 'squid.clam.whelk'})
grpc_transport.assert_called_once_with(
api_mtls_endpoint=None,
client_cert_source=None,
credentials=None,
host="squid.clam.whelk",
)
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 IdentityClient._get_default_mtls_endpoint(None) == None
assert IdentityClient._get_default_mtls_endpoint(
api_endpoint) == api_mtls_endpoint
assert IdentityClient._get_default_mtls_endpoint(
api_mtls_endpoint) == api_mtls_endpoint
assert IdentityClient._get_default_mtls_endpoint(
sandbox_endpoint) == sandbox_mtls_endpoint
assert IdentityClient._get_default_mtls_endpoint(
sandbox_mtls_endpoint) == sandbox_mtls_endpoint
assert IdentityClient._get_default_mtls_endpoint(
non_googleapi) == non_googleapi
def test_identity_client_client_options():
# Check that if channel is provided we won't create a new one.
with mock.patch(
'google.showcase_v1beta1.services.identity.IdentityClient.get_transport_class'
) as gtc:
transport = transports.IdentityGrpcTransport(
credentials=credentials.AnonymousCredentials())
client = IdentityClient(transport=transport)
gtc.assert_not_called()
# Check mTLS is not triggered with empty client options.
options = client_options.ClientOptions()
with mock.patch(
'google.showcase_v1beta1.services.identity.IdentityClient.get_transport_class'
) as gtc:
transport = gtc.return_value = mock.MagicMock()
client = IdentityClient(client_options=options)
transport.assert_called_once_with(
credentials=None,
host=client.DEFAULT_ENDPOINT,
)
# Check mTLS is not triggered if api_endpoint is provided but
# client_cert_source is None.
options = client_options.ClientOptions(api_endpoint="squid.clam.whelk")
with mock.patch(
'google.showcase_v1beta1.services.identity.transports.IdentityGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = IdentityClient(client_options=options)
grpc_transport.assert_called_once_with(
api_mtls_endpoint=None,
client_cert_source=None,
credentials=None,
host="squid.clam.whelk",
)
# Check mTLS is triggered if client_cert_source is provided.
options = client_options.ClientOptions(
client_cert_source=client_cert_source_callback)
with mock.patch(
'google.showcase_v1beta1.services.identity.transports.IdentityGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = IdentityClient(client_options=options)
grpc_transport.assert_called_once_with(
api_mtls_endpoint=client.DEFAULT_MTLS_ENDPOINT,
client_cert_source=client_cert_source_callback,
credentials=None,
host=client.DEFAULT_ENDPOINT,
)
# Check mTLS is triggered if api_endpoint and client_cert_source are provided.
options = client_options.ClientOptions(
api_endpoint="squid.clam.whelk",
client_cert_source=client_cert_source_callback)
with mock.patch(
'google.showcase_v1beta1.services.identity.transports.IdentityGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = IdentityClient(client_options=options)
grpc_transport.assert_called_once_with(
api_mtls_endpoint="squid.clam.whelk",
client_cert_source=client_cert_source_callback,
credentials=None,
host="squid.clam.whelk",
)
def test_user_path():
user_id = "squid"
expected = "users/{user_id}".format(user_id=user_id, )
actual = IdentityClient.user_path(user_id)
assert expected == actual
