def test_list_databases(self): # Setup Expected Response next_page_token = '' databases_element = {} databases = [databases_element] expected_response = { 'next_page_token': next_page_token, 'databases': databases } expected_response = spanner_database_admin_pb2.ListDatabasesResponse( **expected_response) # Mock the API response channel = ChannelStub(responses=[expected_response]) client = spanner_admin_database_v1.DatabaseAdminClient(channel=channel) # Setup Request parent = client.instance_path('[PROJECT]', '[INSTANCE]') paged_list_response = client.list_databases(parent) resources = list(paged_list_response) assert len(resources) == 1 assert expected_response.databases[0] == resources[0] assert len(channel.requests) == 1 expected_request = spanner_database_admin_pb2.ListDatabasesRequest( parent=parent) actual_request = channel.requests[0][1] assert expected_request == actual_request
def test_list_databases(self): # Setup Expected Response next_page_token = "" databases_element = {} databases = [databases_element] expected_response = { "next_page_token": next_page_token, "databases": databases } expected_response = spanner_database_admin_pb2.ListDatabasesResponse( **expected_response) # Mock the API response channel = ChannelStub(responses=[expected_response]) patch = mock.patch("google.api_core.grpc_helpers.create_channel") with patch as create_channel: create_channel.return_value = channel client = spanner_admin_database_v1.DatabaseAdminClient() # Setup Request parent = client.instance_path("[PROJECT]", "[INSTANCE]") paged_list_response = client.list_databases(parent) resources = list(paged_list_response) assert len(resources) == 1 assert expected_response.databases[0] == resources[0] assert len(channel.requests) == 1 expected_request = spanner_database_admin_pb2.ListDatabasesRequest( parent=parent) actual_request = channel.requests[0][1] assert expected_request == actual_request
def test_list_databases_w_options(self): from google.cloud.spanner_admin_database_v1.gapic import ( database_admin_client) from google.cloud.spanner_admin_database_v1.proto import ( spanner_database_admin_pb2) api = database_admin_client.DatabaseAdminClient(mock.Mock()) client = _Client(self.PROJECT) client.database_admin_api = api instance = self._make_one(self.INSTANCE_ID, client) databases_pb = spanner_database_admin_pb2.ListDatabasesResponse( databases=[]) ld_api = api._inner_api_calls['list_databases'] = mock.Mock( return_value=databases_pb) page_size = 42 page_token = 'token' response = instance.list_databases(page_size=page_size, page_token=page_token) databases = list(response) self.assertEqual(databases, []) ld_api.assert_called_once_with( spanner_database_admin_pb2.ListDatabasesRequest( parent=self.INSTANCE_NAME, page_size=page_size, page_token=page_token), metadata=[('google-cloud-resource-prefix', instance.name)], retry=mock.ANY, timeout=mock.ANY)
def test_list_databases(self): from google.cloud.spanner_admin_database_v1.gapic import ( database_admin_client) from google.cloud.spanner_admin_database_v1.proto import ( spanner_database_admin_pb2) from google.cloud.spanner_v1.database import Database api = database_admin_client.DatabaseAdminClient(mock.Mock()) client = _Client(self.PROJECT) client.database_admin_api = api instance = self._make_one(self.INSTANCE_ID, client) databases_pb = spanner_database_admin_pb2.ListDatabasesResponse( databases=[ spanner_database_admin_pb2.Database( name='{}/databases/aa'.format(self.INSTANCE_NAME)), spanner_database_admin_pb2.Database( name='{}/databases/bb'.format(self.INSTANCE_NAME)) ]) api._list_databases = mock.Mock(return_value=databases_pb) response = instance.list_databases() databases = list(response) self.assertIsInstance(databases[0], Database) self.assertTrue(databases[0].name.endswith('/aa')) self.assertTrue(databases[1].name.endswith('/bb')) api._list_databases.assert_called_once_with( spanner_database_admin_pb2.ListDatabasesRequest( parent=self.INSTANCE_NAME), metadata=[('google-cloud-resource-prefix', instance.name)], retry=mock.ANY, timeout=mock.ANY)
def list_databases(self, parent, page_size=None, options=None): """ Lists Cloud Spanner databases. Example: >>> from google.cloud import spanner_admin_database_v1 >>> from google.gax import CallOptions, INITIAL_PAGE >>> >>> client = spanner_admin_database_v1.DatabaseAdminClient() >>> >>> parent = client.instance_path('[PROJECT]', '[INSTANCE]') >>> >>> >>> # Iterate over all results >>> for element in client.list_databases(parent): ... # process element ... pass >>> >>> # Or iterate over results one page at a time >>> for page in client.list_databases(parent, options=CallOptions(page_token=INITIAL_PAGE)): ... for element in page: ... # process element ... pass Args: parent (str): Required. The instance whose databases should be listed. Values are of the form ``projects/<project>/instances/<instance>``. page_size (int): The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. options (~google.gax.CallOptions): Overrides the default settings for this call, e.g, timeout, retries etc. Returns: A :class:`~google.gax.PageIterator` instance. By default, this is an iterable of :class:`~google.cloud.spanner_admin_database_v1.types.Database` instances. This object can also be configured to iterate over the pages of the response through the `options` parameter. Raises: :exc:`google.gax.errors.GaxError` if the RPC is aborted. :exc:`ValueError` if the parameters are invalid. """ request = spanner_database_admin_pb2.ListDatabasesRequest( parent=parent, page_size=page_size) return self._list_databases(request, options)
def test_list_databases(self): from google.cloud.spanner_admin_database_v1.gapic import database_admin_client from google.cloud.spanner_admin_database_v1.proto import ( spanner_database_admin_pb2, ) from google.cloud.spanner_v1.database import Database api = database_admin_client.DatabaseAdminClient(mock.Mock()) client = _Client(self.PROJECT) client.database_admin_api = api instance = self._make_one(self.INSTANCE_ID, client) databases_pb = spanner_database_admin_pb2.ListDatabasesResponse( databases=[ spanner_database_admin_pb2.Database( name="{}/databases/aa".format(self.INSTANCE_NAME) ), spanner_database_admin_pb2.Database( name="{}/databases/bb".format(self.INSTANCE_NAME) ), ] ) ld_api = api._inner_api_calls["list_databases"] = mock.Mock( return_value=databases_pb ) response = instance.list_databases() databases = list(response) self.assertIsInstance(databases[0], Database) self.assertTrue(databases[0].name.endswith("/aa")) self.assertTrue(databases[1].name.endswith("/bb")) expected_metadata = [ ("google-cloud-resource-prefix", instance.name), ("x-goog-request-params", "parent={}".format(instance.name)), ] ld_api.assert_called_once_with( spanner_database_admin_pb2.ListDatabasesRequest(parent=self.INSTANCE_NAME), metadata=expected_metadata, retry=mock.ANY, timeout=mock.ANY, )
def test_list_databases_w_options(self): from google.cloud.spanner_admin_database_v1.gapic import database_admin_client from google.cloud.spanner_admin_database_v1.proto import ( spanner_database_admin_pb2, ) api = database_admin_client.DatabaseAdminClient(mock.Mock()) client = _Client(self.PROJECT) client.database_admin_api = api instance = self._make_one(self.INSTANCE_ID, client) databases_pb = spanner_database_admin_pb2.ListDatabasesResponse( databases=[]) ld_api = api._inner_api_calls["list_databases"] = mock.Mock( return_value=databases_pb) page_size = 42 page_token = "token" response = instance.list_databases(page_size=page_size, page_token=page_token) databases = list(response) self.assertEqual(databases, []) expected_metadata = [ ("google-cloud-resource-prefix", instance.name), ("x-goog-request-params", "parent={}".format(instance.name)), ] ld_api.assert_called_once_with( spanner_database_admin_pb2.ListDatabasesRequest( parent=self.INSTANCE_NAME, page_size=page_size, page_token=page_token), metadata=expected_metadata, retry=mock.ANY, timeout=mock.ANY, )
def test_list_databases(self, mock_create_stub): # Mock gRPC layer grpc_stub = mock.Mock() mock_create_stub.return_value = grpc_stub client = spanner_admin_database_v1.DatabaseAdminClient() # Mock request parent = client.instance_path('[PROJECT]', '[INSTANCE]') # Mock response next_page_token = '' databases_element = {} databases = [databases_element] expected_response = { 'next_page_token': next_page_token, 'databases': databases } expected_response = spanner_database_admin_pb2.ListDatabasesResponse( **expected_response) grpc_stub.ListDatabases.return_value = expected_response paged_list_response = client.list_databases(parent) resources = list(paged_list_response) self.assertEqual(1, len(resources)) self.assertEqual(expected_response.databases[0], resources[0]) grpc_stub.ListDatabases.assert_called_once() args, kwargs = grpc_stub.ListDatabases.call_args self.assertEqual(len(args), 2) self.assertEqual(len(kwargs), 1) self.assertIn('metadata', kwargs) actual_request = args[0] expected_request = spanner_database_admin_pb2.ListDatabasesRequest( parent=parent) self.assertEqual(expected_request, actual_request)
def list_databases(self, parent, page_size=None, retry=google.api_core.gapic_v1.method.DEFAULT, timeout=google.api_core.gapic_v1.method.DEFAULT, metadata=None): """ Lists Cloud Spanner databases. Example: >>> from google.cloud import spanner_admin_database_v1 >>> >>> client = spanner_admin_database_v1.DatabaseAdminClient() >>> >>> parent = client.instance_path('[PROJECT]', '[INSTANCE]') >>> >>> # Iterate over all results >>> for element in client.list_databases(parent): ... # process element ... pass >>> >>> >>> # Alternatively: >>> >>> # Iterate over results one page at a time >>> for page in client.list_databases(parent).pages: ... for element in page: ... # process element ... pass Args: parent (str): Required. The instance whose databases should be listed. Values are of the form ``projects/<project>/instances/<instance>``. page_size (int): The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. retry (Optional[google.api_core.retry.Retry]): A retry object used to retry requests. If ``None`` is specified, requests will not be retried. timeout (Optional[float]): The amount of time, in seconds, to wait for the request to complete. Note that if ``retry`` is specified, the timeout applies to each individual attempt. metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata that is provided to the method. Returns: A :class:`~google.gax.PageIterator` instance. By default, this is an iterable of :class:`~google.cloud.spanner_admin_database_v1.types.Database` instances. This object can also be configured to iterate over the pages of the response through the `options` parameter. Raises: google.api_core.exceptions.GoogleAPICallError: If the request failed for any reason. google.api_core.exceptions.RetryError: If the request failed due to a retryable error and retry attempts failed. ValueError: If the parameters are invalid. """ # Wrap the transport method to add retry and timeout logic. if 'list_databases' not in self._inner_api_calls: self._inner_api_calls[ 'list_databases'] = google.api_core.gapic_v1.method.wrap_method( self.transport.list_databases, default_retry=self._method_configs['ListDatabases'].retry, default_timeout=self._method_configs['ListDatabases']. timeout, client_info=self._client_info, ) request = spanner_database_admin_pb2.ListDatabasesRequest( parent=parent, page_size=page_size, ) iterator = google.api_core.page_iterator.GRPCIterator( client=None, method=functools.partial(self._inner_api_calls['list_databases'], retry=retry, timeout=timeout, metadata=metadata), request=request, items_field='databases', request_token_field='page_token', response_token_field='next_page_token', ) return iterator