def test__update_from_pb_no_display_name(self):
from google.cloud.spanner_admin_instance_v1 import Instance
instance_pb = Instance()
instance = self._make_one(None, None, None, None)
self.assertEqual(instance.display_name, None)
with self.assertRaises(ValueError):
instance._update_from_pb(instance_pb)
self.assertEqual(instance.display_name, None)
def test_from_pb_bad_instance_name(self):
from google.cloud.spanner_admin_instance_v1 import Instance
instance_name = "INCORRECT_FORMAT"
instance_pb = Instance(name=instance_name)
klass = self._getTargetClass()
with self.assertRaises(ValueError):
klass.from_pb(instance_pb, None)
def test__update_from_pb_success(self):
from google.cloud.spanner_admin_instance_v1 import Instance
display_name = "display_name"
instance_pb = Instance(display_name=display_name)
instance = self._make_one(None, None, None, None)
self.assertEqual(instance.display_name, None)
instance._update_from_pb(instance_pb)
self.assertEqual(instance.display_name, display_name)
def instance(
self,
instance_id,
configuration_name=None,
display_name=None,
node_count=None,
labels=None,
processing_units=None,
):
"""Factory to create a instance associated with this client.
:type instance_id: str
:param instance_id: The ID of the instance.
:type configuration_name: string
:param configuration_name:
(Optional) Name of the instance configuration used to set up the
instance's cluster, in the form:
``projects/<project>/instanceConfigs/``
``<config>``.
**Required** for instances which do not yet exist.
:type display_name: str
:param display_name: (Optional) The display name for the instance in
the Cloud Console UI. (Must be between 4 and 30
characters.) If this value is not set in the
constructor, will fall back to the instance ID.
:type node_count: int
:param node_count: (Optional) The number of nodes in the instance's
cluster; used to set up the instance's cluster.
:type processing_units: int
:param processing_units: (Optional) The number of processing units
allocated to this instance.
:type labels: dict (str -> str) or None
:param labels: (Optional) User-assigned labels for this instance.
:rtype: :class:`~google.cloud.spanner_v1.instance.Instance`
:returns: an instance owned by this client.
"""
return Instance(
instance_id,
self,
configuration_name,
node_count,
display_name,
self._emulator_host,
labels,
processing_units,
)
def test_from_pb_project_mistmatch(self):
from google.cloud.spanner_admin_instance_v1 import Instance
ALT_PROJECT = "ALT_PROJECT"
client = _Client(project=ALT_PROJECT)
self.assertNotEqual(self.PROJECT, ALT_PROJECT)
instance_pb = Instance(name=self.INSTANCE_NAME)
klass = self._getTargetClass()
with self.assertRaises(ValueError):
klass.from_pb(instance_pb, client)
def test_from_pb_success(self):
from google.cloud.spanner_admin_instance_v1 import Instance
client = _Client(project=self.PROJECT)
instance_pb = Instance(
name=self.INSTANCE_NAME,
config=self.CONFIG_NAME,
display_name=self.INSTANCE_ID,
labels=self.LABELS,
)
klass = self._getTargetClass()
instance = klass.from_pb(instance_pb, client)
self.assertIsInstance(instance, klass)
self.assertEqual(instance._client, client)
self.assertEqual(instance.instance_id, self.INSTANCE_ID)
self.assertEqual(instance.configuration_name, self.CONFIG_NAME)
self.assertEqual(instance.labels, self.LABELS)
def test_exists_success(self):
from google.cloud.spanner_admin_instance_v1 import Instance
client = _Client(self.PROJECT)
instance_pb = Instance(
name=self.INSTANCE_NAME,
config=self.CONFIG_NAME,
display_name=self.DISPLAY_NAME,
node_count=self.NODE_COUNT,
)
api = client.instance_admin_api = _FauxInstanceAdminAPI(
_get_instance_response=instance_pb)
instance = self._make_one(self.INSTANCE_ID, client)
self.assertTrue(instance.exists())
name, metadata = api._got_instance
self.assertEqual(name, self.INSTANCE_NAME)
self.assertEqual(metadata,
[("google-cloud-resource-prefix", instance.name)])
def instance(
self,
instance_id,
configuration_name=None,
display_name=None,
node_count=DEFAULT_NODE_COUNT,
):
"""Factory to create a instance associated with this client.
:type instance_id: str
:param instance_id: The ID of the instance.
:type configuration_name: string
:param configuration_name:
(Optional) Name of the instance configuration used to set up the
instance's cluster, in the form:
``projects/<project>/instanceConfigs/``
``<config>``.
**Required** for instances which do not yet exist.
:type display_name: str
:param display_name: (Optional) The display name for the instance in
the Cloud Console UI. (Must be between 4 and 30
characters.) If this value is not set in the
constructor, will fall back to the instance ID.
:type node_count: int
:param node_count: (Optional) The number of nodes in the instance's
cluster; used to set up the instance's cluster.
:rtype: :class:`~google.cloud.spanner_v1.instance.Instance`
:returns: an instance owned by this client.
"""
return Instance(
instance_id,
self,
configuration_name,
node_count,
display_name,
_get_spanner_emulator_host(),
)
def _make_connection(self):
# we don't need real Client object to test the constructor
instance = Instance(self.instance_name, client=None)
database = instance.database(self.database_name)
return Connection(instance, database)