feat: expose read-only 'Instance.create_time' property

tseaver · tseaver · commit 030012176bcb · 2021-10-19T14:53:21.000-04:00
From new field in the 'Instance' proto, added in PR #449.
diff --git a/google/cloud/bigtable/instance.py b/google/cloud/bigtable/instance.py
@@ -15,22 +15,18 @@
 """User-friendly container for Google Cloud Bigtable Instance."""
 
 import re
+import warnings
 
-from google.cloud.bigtable.app_profile import AppProfile
-from google.cloud.bigtable.cluster import Cluster
-from google.cloud.bigtable.table import Table
-
+from google.api_core.datetime_helpers import DatetimeWithNanoseconds
+from google.api_core.exceptions import NotFound
+from google.iam.v1 import options_pb2  # type: ignore
 from google.protobuf import field_mask_pb2
 
 from google.cloud.bigtable_admin_v2.types import instance
-
-from google.iam.v1 import options_pb2  # type: ignore
-
-from google.api_core.exceptions import NotFound
-
+from google.cloud.bigtable.app_profile import AppProfile
+from google.cloud.bigtable.cluster import Cluster
 from google.cloud.bigtable.policy import Policy
-
-import warnings
+from google.cloud.bigtable.table import Table
 
 _INSTANCE_NAME_RE = re.compile(
     r"^projects/(?P<project>[^/]+)/" r"instances/(?P<instance_id>[a-z][-a-z0-9]*)$"
@@ -115,6 +111,7 @@ def __init__(
         self.type_ = instance_type
         self.labels = labels
         self._state = _state
+        self._create_time = None
 
     def _update_from_pb(self, instance_pb):
         """Refresh self from the server-provided protobuf.
@@ -126,6 +123,12 @@ def _update_from_pb(self, instance_pb):
         self.type_ = instance_pb.type_
         self.labels = dict(instance_pb.labels)
         self._state = instance_pb.state
+        if instance_pb.create_time is not None:
+            self._create_time = DatetimeWithNanoseconds.from_pb(
+                instance_pb.create_time
+            )
+        else:
+            self._create_time = None
 
     @classmethod
     def from_pb(cls, instance_pb, client):
@@ -208,6 +211,16 @@ def state(self):
         """
         return self._state
 
+    @property
+    def create_time(self):
+        """Timestamp when the instance was created.
+
+        :rtype:
+            :class:`~google.api_core.datetime_helpers.DatetimeWithNanoseconds`
+            or ``None``
+        """
+        return self._create_time
+
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
             return NotImplemented
diff --git a/tests/unit/test_instance.py b/tests/unit/test_instance.py
@@ -72,6 +72,7 @@ def test_constructor_defaults(self):
         self.assertIsNone(instance.labels)
         self.assertIs(instance._client, client)
         self.assertIsNone(instance.state)
+        self.assertIsNone(instance.create_time)
 
     def test_constructor_non_default(self):
         from google.cloud.bigtable import enums
@@ -95,19 +96,34 @@ def test_constructor_non_default(self):
         self.assertEqual(instance.labels, labels)
         self.assertIs(instance._client, client)
         self.assertEqual(instance.state, state)
+        self.assertIsNone(instance.create_time)
+
+    @staticmethod
+    def _make_timestamp_pb():
+        import datetime
+        from google.protobuf import timestamp_pb2
+
+        now = datetime.datetime.utcnow().replace(tzinfo=datetime.timezone.utc)
+        seconds = int(now.timestamp())
+        nanos = int((now.timestamp() - seconds) * 1e9)
+        return timestamp_pb2.Timestamp(seconds=seconds, nanos=nanos)
 
     def test__update_from_pb_success(self):
+        import datetime
+        from google.api_core.datetime_helpers import DatetimeWithNanoseconds
         from google.cloud.bigtable_admin_v2.types import instance as data_v2_pb2
         from google.cloud.bigtable import enums
 
         instance_type = data_v2_pb2.Instance.Type.PRODUCTION
         state = enums.Instance.State.READY
+        timestamp = self._make_timestamp_pb()
         # todo type to type_?
         instance_pb = data_v2_pb2.Instance(
             display_name=self.DISPLAY_NAME,
             type_=instance_type,
             labels=self.LABELS,
             state=state,
+            create_time=timestamp,
         )
 
         instance = self._make_one(None, None)
@@ -119,6 +135,8 @@ def test__update_from_pb_success(self):
         self.assertEqual(instance.type_, instance_type)
         self.assertEqual(instance.labels, self.LABELS)
         self.assertEqual(instance._state, state)
+        expected_dt = DatetimeWithNanoseconds.from_timestamp_pb(timestamp)
+        self.assertEqual( instance.create_time, expected_dt )
 
     def test__update_from_pb_success_defaults(self):
         from google.cloud.bigtable_admin_v2.types import instance as data_v2_pb2
@@ -134,6 +152,7 @@ def test__update_from_pb_success_defaults(self):
         self.assertEqual(instance.display_name, self.DISPLAY_NAME)
         self.assertEqual(instance.type_, enums.Instance.Type.UNSPECIFIED)
         self.assertFalse(instance.labels)
+        self.assertIsNone(instance.create_time)
 
     def test__update_from_pb_no_display_name(self):
         from google.cloud.bigtable_admin_v2.types import instance as data_v2_pb2
@@ -145,6 +164,7 @@ def test__update_from_pb_no_display_name(self):
             instance._update_from_pb(instance_pb)
 
     def test_from_pb_success(self):
+        from google.api_core.datetime_helpers import DatetimeWithNanoseconds
         from google.cloud.bigtable_admin_v2.types import instance as data_v2_pb2
         from google.cloud.bigtable import enums
 
@@ -154,12 +174,14 @@ def test_from_pb_success(self):
         )
         instance_type = enums.Instance.Type.PRODUCTION
         state = enums.Instance.State.READY
+        timestamp = self._make_timestamp_pb()
         instance_pb = data_v2_pb2.Instance(
             name=self.INSTANCE_NAME,
             display_name=self.INSTANCE_ID,
             type_=instance_type,
             labels=self.LABELS,
             state=state,
+            created_time=timestamp,
         )
 
         klass = self._get_target_class()
@@ -171,6 +193,8 @@ def test_from_pb_success(self):
         self.assertEqual(instance.type_, instance_type)
         self.assertEqual(instance.labels, self.LABELS)
         self.assertEqual(instance._state, state)
+        expected_dt = DatetimeWithNanoseconds.from_timestamp_pb(timestamp)
+        self.assertEqual( instance.create_time, expected_dt )
 
     def test_from_pb_bad_instance_name(self):
         from google.cloud.bigtable_admin_v2.types import instance as data_v2_pb2
