distbuild: Add distbuild status command

Adds a command to get the status of all recently ran distbuilds
for a given server (e.g. Running, Finished, Failed, Cancelled),
so as to tell if a build running via distbuild-start has finished
or otherwise exited without going through the server's log files

Change-Id: I5ce9fe54ae7b1bd8fe3e0d629f615042be8827ed

7 files changed, 156 insertions, 10 deletions

diff --git a/distbuild/__init__.py b/distbuild/__init__.py
index b9b5fbc5..54103922 100644
--- a/distbuild/__init__.py
+++ b/distbuild/__init__.py
@@ -55,7 +55,7 @@ from build_controller import (BuildController, BuildFailed, BuildProgress,
                               BuildFinished, BuildCancel,
                               build_step_name, map_build_graph)
 from initiator import (Initiator, InitiatorStart, InitiatorCancel,
-                       InitiatorListJobs)
+                       InitiatorListJobs, InitiatorStatus)
 from protocol import message
 
 from crashpoint import (crash_point, add_crash_condition, add_crash_conditions,
diff --git a/distbuild/build_controller.py b/distbuild/build_controller.py
index 27a6c862..7983dede 100644
--- a/distbuild/build_controller.py
+++ b/distbuild/build_controller.py
@@ -176,6 +176,12 @@ class BuildController(distbuild.StateMachine):
         self.debug_transitions = False
         self.debug_graph_state = False
         self.allow_detach = build_request_message['allow_detach']
+        self.build_status = 'Building'
+        self.build_info = {
+            'id': build_request_message['id'],
+            'morphology': build_request_message['morphology'],
+            'build-status': self.build_status,
+        }
 
     def __repr__(self):
         return '<BuildController at 0x%x, request-id %s>' % (id(self),
@@ -187,6 +193,14 @@ class BuildController(distbuild.StateMachine):
     def get_request(self):
         return self._request
 
+    def get_status(self):
+        return self.build_status
+
+    def get_status_message(self):
+        return ('Build request ID: %s\n  System build: %s\n  Build status: %s' %
+            (self.build_info['id'], self.build_info['morphology'],
+            self.build_status))
+
     def setup(self):
         distbuild.crash_point()
 
@@ -502,6 +516,7 @@ class BuildController(distbuild.StateMachine):
             logging.debug('Detaching from client; build continuing remotely.')
         else:
             self.mainloop.queue_event(self, build_cancel(event.id))
+            self.build_status = 'Cancelled'
 
     def build_cancel(self, event_id):
         cancel_pending = distbuild.WorkerCancelPending(event_id)
@@ -542,6 +557,7 @@ class BuildController(distbuild.StateMachine):
             return
 
         logging.debug('BC: got build step started: %s' % artifact.name)
+        self.build_status = ('Building %s' % artifact.name)
         started = BuildStepStarted(
             self._request['id'], build_step_name(artifact), event.worker_name)
         self.mainloop.queue_event(BuildController, started)
@@ -661,6 +677,8 @@ class BuildController(distbuild.StateMachine):
 
         self.fail('Building failed for %s' % artifact.name)
 
+        self.build_status = ('Failed building %s' % artifact.name)
+
         # Cancel any jobs waiting to be executed, since there is no point
         # running them if this build has failed, it would just waste
         # resources
@@ -680,6 +698,7 @@ class BuildController(distbuild.StateMachine):
         distbuild.crash_point()
 
         logging.debug('Notifying initiator of successful build')
+        self.build_status = 'Finished'
         baseurl = urlparse.urljoin(
             self._artifact_cache_server, '/1.0/artifacts')
         urls = []
diff --git a/distbuild/initiator.py b/distbuild/initiator.py
index 391c8707..7d0d4f0d 100644
--- a/distbuild/initiator.py
+++ b/distbuild/initiator.py
@@ -385,3 +385,57 @@ class InitiatorListJobs(distbuild.StateMachine):
     def _terminate(self, event_source, event):
         self.mainloop.queue_event(self._cm, distbuild.StopConnecting())
         self._jm.close()
+
+
+class InitiatorStatus(distbuild.StateMachine):
+
+    def __init__(self, cm, conn, app, job_id):
+        distbuild.StateMachine.__init__(self, 'waiting')
+        self._cm = cm
+        self._conn = conn
+        self._app = app
+        self._job_id = job_id
+
+    def setup(self):
+        distbuild.crash_point()
+
+        self._jm = distbuild.JsonMachine(self._conn)
+        self.mainloop.add_state_machine(self._jm)
+        logging.debug('initiator: _jm=%s' % repr(self._jm))
+
+        spec = [
+            # state, source, event_class, new_state, callback
+            ('waiting', self._jm, distbuild.JsonEof, None, self._terminate),
+            ('waiting', self._jm, distbuild.JsonNewMessage, None,
+                self._handle_json_message),
+        ]
+        self.add_transitions(spec)
+
+        self._app.status(msg='Requesting status of recently-ran distbuilds.')
+        msg = distbuild.message('build-status',
+            id=self._job_id,
+            protocol_version=distbuild.protocol.VERSION,
+        )
+        self._jm.send(msg)
+        logging.debug('Initiator: sent to controller: %s', repr(msg))
+
+    def _handle_json_message(self, event_source, event):
+        distbuild.crash_point()
+
+        logging.debug('Initiator: from controller: %s', str(event.msg))
+
+        handlers = {
+            'request-output': self._handle_request_output,
+        }
+
+        handler = handlers[event.msg['type']]
+        handler(event.msg)
+
+    def _handle_request_output(self, msg):
+        self._app.status(msg=str(msg['message']))
+        self.mainloop.queue_event(self._cm, distbuild.StopConnecting())
+        self._jm.close()
+
+    def _terminate(self, event_source, event):
+        self.mainloop.queue_event(self._cm, distbuild.StopConnecting())
+        self._jm.close()
diff --git a/distbuild/initiator_connection.py b/distbuild/initiator_connection.py
index 601d8c5c..c566e548 100644
--- a/distbuild/initiator_connection.py
+++ b/distbuild/initiator_connection.py
@@ -97,6 +97,12 @@ class InitiatorConnection(distbuild.StateMachine):
         logging.debug('InitiatorConnection: from %s: %r', self.initiator_name,
                 event.msg)
 
+        msg_handler = {
+            'build-request': self._handle_build_request,
+            'list-requests': self._handle_list_requests,
+            'build-cancel': self._handle_build_cancel,
+            'build-status': self._handle_build_status,
+        }
         try:
             if event.msg.get('protocol_version') != distbuild.protocol.VERSION:
                 msg = distbuild.message('build-failed',
@@ -113,14 +119,7 @@ class InitiatorConnection(distbuild.StateMachine):
                 self.jm.send(msg)
                 self._log_send(msg)
                 return
-            if event.msg['type'] == 'build-request':
-                self._handle_build_request(event)
-            elif event.msg['type'] == 'list-requests':
-                self._handle_list_requests(event)
-            elif event.msg['type'] == 'build-cancel':
-                self._handle_build_cancel(event)
-            else:
-                logging.error('Invalid message type: %s', event.msg)
+            msg_handler[event.msg['type']](event)
         except (KeyError, ValueError) as ex:
             logging.error('Invalid message from initiator: %s: exception %s',
                            event.msg, ex)
@@ -134,6 +133,7 @@ class InitiatorConnection(distbuild.StateMachine):
             self, event.msg, self.artifact_cache_server,
             self.morph_instance)
         self.mainloop.add_state_machine(build_controller)
+        self.mainloop.store_state_machine(build_controller)
 
     def _handle_list_requests(self, event):
         requests = self.mainloop.state_machines_of_type(
@@ -173,6 +173,21 @@ class InitiatorConnection(distbuild.StateMachine):
                                     'running build IDs.'))
             self.jm.send(msg)
 
+    def _handle_build_status(self, event):
+        requests = self.mainloop.state_stored_requests(
+                   distbuild.BuildController)
+        for build in requests:
+            if build.get_request()['id'] == event.msg['id']:
+                msg = distbuild.message('request-output', message=(
+                                        build.get_status_message()))
+                self.jm.send(msg)
+                break
+        else:
+            msg = distbuild.message('request-output', message=('Given '
+                                    'build-request ID does not match any '
+                                    'recent build IDs.'))
+            self.jm.send(msg)
+
     def _disconnect(self, event_source, event):
         for id in self.our_ids:
             logging.debug('InitiatorConnection: %s: InitiatorDisconnect(%s)',
diff --git a/distbuild/mainloop.py b/distbuild/mainloop.py
index e7c0cc3b..3a5963dd 100644
--- a/distbuild/mainloop.py
+++ b/distbuild/mainloop.py
@@ -40,6 +40,7 @@ class MainLoop(object):
         self._machines = []
         self._sources = []
         self._events = []
+        self.store_request = []
         self.dump_filename = None
         
     def add_state_machine(self, machine):
@@ -51,7 +52,10 @@ class MainLoop(object):
             filename = '%s%s.dot' % (self.dump_filename, 
                                      machine.__class__.__name__)
             machine.dump_dot(filename)
-        
+
+    def store_state_machine(self, machine):
+        self.store_request.append(machine)
+
     def remove_state_machine(self, machine):
         logging.debug('MainLoop.remove_state_machine: %s' % machine)
         self._machines.remove(machine)
@@ -59,6 +63,9 @@ class MainLoop(object):
     def state_machines_of_type(self, machine_type):
         return [m for m in self._machines if isinstance(m, machine_type)]
 
+    def state_stored_requests(self, machine_type):
+        return [m for m in self.store_request if isinstance(m, machine_type)]
+
     def n_state_machines_of_type(self, machine_type):
         return len(self.state_machines_of_type(machine_type))
 
diff --git a/distbuild/protocol.py b/distbuild/protocol.py
index 1924925d..d6bb513a 100644
--- a/distbuild/protocol.py
+++ b/distbuild/protocol.py
@@ -97,6 +97,10 @@ _required_fields = {
         'id',
         'protocol_version',
     ],
+    'build-status': [
+        'id',
+        'protocol_version',
+    ],
 }
 
 
diff --git a/morphlib/plugins/distbuild_plugin.py b/morphlib/plugins/distbuild_plugin.py
index d93c2214..d974fb98 100644
--- a/morphlib/plugins/distbuild_plugin.py
+++ b/morphlib/plugins/distbuild_plugin.py
@@ -82,6 +82,53 @@ class DistbuildCancel(cliapp.Plugin):
         loop.run()
 
 
+class DistbuildStatusPlugin(cliapp.Plugin):
+
+    RECONNECT_INTERVAL = 30 # seconds
+    MAX_RETRIES = 1
+
+    def enable(self):
+        self.app.add_subcommand('distbuild-get-status', self.distbuild_status,
+                                arg_synopsis='ID')
+
+    def disable(self):
+        pass
+
+    def distbuild_status(self, args):
+        '''Displays build status of recent distbuild requests.
+
+        Lists last known build status for all distbuilds (e.g. Building,
+        Failed, Finished, Cancelled) on a given distbuild server as set in
+        /etc/morph.conf
+
+        Example:
+
+            morph distbuild-get-status InitiatorConnection-1
+
+        Example output:
+
+            Build request ID: InitiatorConnection-1
+              System build: systems/devel-system-x86_64-generic.morph
+              Build status: Building stage1-binutils-misc
+
+        '''
+
+        if len(args) == 0:
+            raise cliapp.AppException(
+                'This command requires a build-request ID to run.')
+
+        addr = self.app.settings['controller-initiator-address']
+        port = self.app.settings['controller-initiator-port']
+        icm = distbuild.InitiatorConnectionMachine(self.app, addr, port,
+                                                   distbuild.InitiatorStatus,
+                                                   [self.app] + args,
+                                                   self.RECONNECT_INTERVAL,
+                                                   self.MAX_RETRIES)
+        loop = distbuild.MainLoop()
+        loop.add_state_machine(icm)
+        loop.run()
+
+
 class DistbuildListJobsPlugin(cliapp.Plugin):
 
     RECONNECT_INTERVAL = 30 # seconds