Implementing Bigtable Cluster.operation_finished().

This method is intended to be used to check if a create,
update or undelete operation has completed.

Author: dhermes

gcloud/bigtable/cluster.py

@@ -22,6 +22,7 @@
 from gcloud.bigtable._generated import bigtable_cluster_data_pb2 as data_pb2
 from gcloud.bigtable._generated import (
     bigtable_cluster_service_messages_pb2 as messages_pb2)
+from gcloud.bigtable._generated import operations_pb2
 from gcloud.bigtable.table import Table
 
 
@@ -291,6 +292,32 @@ def reload(self):
         #       cluster ID on the response match the request.
         self._update_from_pb(cluster_pb)
 
+    def operation_finished(self):
+        """Check if the current operation has finished.
+
+        :rtype: bool
+        :returns: A boolean indicating if the current operation has completed.
+        :raises: :class:`ValueError <exceptions.ValueError>` if there is no
+                 current operation set.
+        """
+        if self._operation_id is None:
+            raise ValueError('There is no current operation.')
+
+        operation_name = ('operations/' + self.name +
+                          '/operations/%d' % (self._operation_id,))
+        request_pb = operations_pb2.GetOperationRequest(name=operation_name)
+        # We expact a `._generated.operations_pb2.Operation`.
+        operation_pb = self._client._operations_stub.GetOperation(
+            request_pb, self._client.timeout_seconds)
+
+        if operation_pb.done:
+            self._operation_type = None
+            self._operation_id = None
+            self._operation_begin = None
+            return True
+        else:
+            return False
+
     def create(self):
         """Create this cluster.
 

gcloud/bigtable/test_cluster.py

@@ -231,6 +231,71 @@ def test_reload(self):
         self.assertEqual(cluster.serve_nodes, serve_nodes)
         self.assertEqual(cluster.display_name, display_name)
 
+    def test_operation_finished_without_operation(self):
+        zone = 'zone'
+        cluster_id = 'cluster-id'
+        cluster = self._makeOne(zone, cluster_id, None)
+        self.assertEqual(cluster._operation_type, None)
+        with self.assertRaises(ValueError):
+            cluster.operation_finished()
+
+    def _operation_finished_helper(self, done):
+        from gcloud.bigtable._generated import operations_pb2
+        from gcloud.bigtable._testing import _FakeStub
+
+        project = 'PROJECT'
+        zone = 'zone'
+        cluster_id = 'cluster-id'
+        timeout_seconds = 1
+
+        client = _Client(project, timeout_seconds=timeout_seconds)
+        cluster = self._makeOne(zone, cluster_id, client)
+
+        # Patch up the cluster's operation attributes.
+        cluster._operation_id = op_id = 789
+        cluster._operation_begin = op_begin = object()
+        cluster._operation_type = op_type = object()
+
+        # Create request_pb
+        op_name = ('operations/projects/' + project + '/zones/' +
+                   zone + '/clusters/' + cluster_id +
+                   '/operations/%d' % (op_id,))
+        request_pb = operations_pb2.GetOperationRequest(name=op_name)
+
+        # Create response_pb
+        response_pb = operations_pb2.Operation(done=done)
+
+        # Patch the stub used by the API method.
+        client._operations_stub = stub = _FakeStub(response_pb)
+
+        # Create expected_result.
+        expected_result = done
+
+        # Perform the method and check the result.
+        result = cluster.operation_finished()
+
+        self.assertEqual(result, expected_result)
+        self.assertEqual(stub.method_calls, [(
+            'GetOperation',
+            (request_pb, timeout_seconds),
+            {},
+        )])
+
+        if done:
+            self.assertEqual(cluster._operation_type, None)
+            self.assertEqual(cluster._operation_id, None)
+            self.assertEqual(cluster._operation_begin, None)
+        else:
+            self.assertEqual(cluster._operation_type, op_type)
+            self.assertEqual(cluster._operation_id, op_id)
+            self.assertEqual(cluster._operation_begin, op_begin)
+
+    def test_operation_finished(self):
+        self._operation_finished_helper(done=True)
+
+    def test_operation_finished_not_done(self):
+        self._operation_finished_helper(done=False)
+
     def test_create(self):
         from gcloud._testing import _Monkey
         from gcloud.bigtable._generated import (