Renaming ExecutionStage to OperationStage for clarity

#83

buildgrid/server/job.py

@@ -26,50 +26,28 @@ from buildgrid._protos.google.devtools.remoteworkers.v1test2 import bots_pb2
 from buildgrid._protos.google.longrunning import operations_pb2
 
 
-class ExecuteStage(Enum):
+class OperationStage(Enum):
+    # Initially unknown stage.
     UNKNOWN = remote_execution_pb2.ExecuteOperationMetadata.Stage.Value('UNKNOWN')
-
     # Checking the result against the cache.
     CACHE_CHECK = remote_execution_pb2.ExecuteOperationMetadata.Stage.Value('CACHE_CHECK')
-
     # Currently idle, awaiting a free machine to execute.
     QUEUED = remote_execution_pb2.ExecuteOperationMetadata.Stage.Value('QUEUED')
-
     # Currently being executed by a worker.
     EXECUTING = remote_execution_pb2.ExecuteOperationMetadata.Stage.Value('EXECUTING')
-
     # Finished execution.
     COMPLETED = remote_execution_pb2.ExecuteOperationMetadata.Stage.Value('COMPLETED')
 
 
-class BotStatus(Enum):
-    BOT_STATUS_UNSPECIFIED = bots_pb2.BotStatus.Value('BOT_STATUS_UNSPECIFIED')
-
-    # The bot is healthy, and will accept leases as normal.
-    OK = bots_pb2.BotStatus.Value('OK')
-
-    # The bot is unhealthy and will not accept new leases.
-    UNHEALTHY = bots_pb2.BotStatus.Value('UNHEALTHY')
-
-    # The bot has been asked to reboot the host.
-    HOST_REBOOTING = bots_pb2.BotStatus.Value('HOST_REBOOTING')
-
-    # The bot has been asked to shut down.
-    BOT_TERMINATING = bots_pb2.BotStatus.Value('BOT_TERMINATING')
-
-
 class LeaseState(Enum):
+    # Initially unknown state.
     LEASE_STATE_UNSPECIFIED = bots_pb2.LeaseState.Value('LEASE_STATE_UNSPECIFIED')
-
     # The server expects the bot to accept this lease.
     PENDING = bots_pb2.LeaseState.Value('PENDING')
-
     # The bot has accepted this lease.
     ACTIVE = bots_pb2.LeaseState.Value('ACTIVE')
-
     # The bot is no longer leased.
     COMPLETED = bots_pb2.LeaseState.Value('COMPLETED')
-
     # The bot should immediately release all resources associated with the lease.
     CANCELLED = bots_pb2.LeaseState.Value('CANCELLED')
 
@@ -85,7 +63,7 @@ class Job:
 
         self._action_digest = action_digest
         self._do_not_cache = do_not_cache
-        self._execute_stage = ExecuteStage.UNKNOWN
+        self._execute_stage = OperationStage.UNKNOWN
         self._name = str(uuid.uuid4())
         self._operation = operations_pb2.Operation(name=self._name)
         self._operation_update_queues = []

buildgrid/server/scheduler.py

@@ -27,7 +27,7 @@ from buildgrid._exceptions import NotFoundError
 from buildgrid._protos.build.bazel.remote.execution.v2 import remote_execution_pb2
 from buildgrid._protos.google.longrunning import operations_pb2
 
-from .job import ExecuteStage, LeaseState
+from .job import OperationStage, LeaseState
 
 
 class Scheduler:
@@ -55,26 +55,26 @@ class Scheduler:
                 cached_result = self._action_cache.get_action_result(job.action_digest)
             except NotFoundError:
                 self.queue.append(job)
-                job.update_execute_stage(ExecuteStage.QUEUED)
+                job.update_execute_stage(OperationStage.QUEUED)
 
             else:
                 job.result = cached_result
                 job.result_cached = True
-                job.update_execute_stage(ExecuteStage.COMPLETED)
+                job.update_execute_stage(OperationStage.COMPLETED)
 
         else:
             self.queue.append(job)
-            job.update_execute_stage(ExecuteStage.QUEUED)
+            job.update_execute_stage(OperationStage.QUEUED)
 
     def retry_job(self, name):
         if name in self.jobs:
             job = self.jobs[name]
             if job.n_tries >= self.MAX_N_TRIES:
                 # TODO: Decide what to do with these jobs
-                job.update_execute_stage(ExecuteStage.COMPLETED)
+                job.update_execute_stage(OperationStage.COMPLETED)
                 # TODO: Mark these jobs as done
             else:
-                job.update_execute_stage(ExecuteStage.QUEUED)
+                job.update_execute_stage(OperationStage.QUEUED)
                 job.n_tries += 1
                 self.queue.appendleft(job)
 
@@ -87,7 +87,7 @@ class Scheduler:
         if not job.do_not_cache and self._action_cache is not None:
             if not job.lease.status.code:
                 self._action_cache.update_action_result(job.action_digest, action_result)
-        job.update_execute_stage(ExecuteStage.COMPLETED)
+        job.update_execute_stage(OperationStage.COMPLETED)
 
     def get_operations(self):
         response = operations_pb2.ListOperationsResponse()
@@ -111,7 +111,7 @@ class Scheduler:
     def create_lease(self):
         if self.queue:
             job = self.queue.popleft()
-            job.update_execute_stage(ExecuteStage.EXECUTING)
+            job.update_execute_stage(OperationStage.EXECUTING)
             job.create_lease()
             job.lease.state = LeaseState.PENDING.value
             return job.lease

tests/integration/execution_service.py

@@ -82,7 +82,7 @@ def test_execute(skip_cache_lookup, instance, context):
     assert isinstance(result, operations_pb2.Operation)
     metadata = remote_execution_pb2.ExecuteOperationMetadata()
     result.metadata.Unpack(metadata)
-    assert metadata.stage == job.ExecuteStage.QUEUED.value
+    assert metadata.stage == job.OperationStage.QUEUED.value
     assert uuid.UUID(result.name, version=4)
     assert result.done is False
 
@@ -116,7 +116,7 @@ def test_wait_execution(instance, controller, context):
     action_result = remote_execution_pb2.ActionResult()
     action_result_any.Pack(action_result)
 
-    j.update_execute_stage(job.ExecuteStage.COMPLETED)
+    j.update_execute_stage(job.OperationStage.COMPLETED)
 
     response = instance.WaitExecution(request, context)
 
@@ -125,7 +125,7 @@ def test_wait_execution(instance, controller, context):
     assert isinstance(result, operations_pb2.Operation)
     metadata = remote_execution_pb2.ExecuteOperationMetadata()
     result.metadata.Unpack(metadata)
-    assert metadata.stage == job.ExecuteStage.COMPLETED.value
+    assert metadata.stage == job.OperationStage.COMPLETED.value
     assert uuid.UUID(result.name, version=4)
     assert result.done is True