Changeset 17 for mergebot/trunk/mergebot/web_ui.py

Timestamp:

Jun 8, 2009 3:07:47 AM (15 years ago)

Author:

retracile

Message:

Mergebot: redesigned implementation. Still has rough edges.

File:

• mergebot/trunk/mergebot/web_ui.py (modified) (6 diffs)

mergebot/trunk/mergebot/web_ui.py

@@ -1 +1 @@
 #!/usr/bin/env python
 
-import random
+import socket
+import time
+import os
+import base64
+from subprocess import check_call
 
 from trac.core import *
@@ -7 +11 @@
 from trac.ticket.query import Query
 from trac.ticket.model import Ticket
-from trac.config import Option
+from trac.env import IEnvironmentSetupParticipant
 from trac.perm import IPermissionRequestor
 from trac.web.main import IRequestHandler
-from trac.web.chrome import INavigationContributor, ITemplateProvider
-
-from MergeActor import MergeActor
-from BranchActor import BranchActor
-from RebranchActor import RebranchActor
-from CheckMergeActor import CheckMergeActor
+from trac.web.chrome import INavigationContributor, ITemplateProvider, add_warning
+
+from action_logic import is_branchable, is_rebranchable, is_mergeable, is_checkmergeable
 
 class MergeBotModule(Component):
-    implements(INavigationContributor, IPermissionRequestor, IRequestHandler, ITemplateProvider)
+    implements(INavigationContributor, IPermissionRequestor, IRequestHandler, ITemplateProvider, IEnvironmentSetupParticipant)
+
+    # IEnvironmentSetupParticipant
+    def environment_created(self):
+        self._setup_config()
+
+    def environment_needs_upgrade(self, db):
+        return not list(self.config.options('mergebot'))
+
+    def upgrade_environment(self, db):
+        self._setup_config()
+
+    def _setup_config(self):
+        self.config.set('mergebot', 'work_dir', 'mergebot')
+        self.config.set('mergebot', 'repository_url', 'http://FIXME/svn')
+        self.config.set('mergebot', 'listen.ip', 'localhost')
+        self.config.set('mergebot', 'listen.port', '12345')
+        self.config.set('mergebot', 'worker_count', '2')
+        # Set up the needed custom field for the bot
+        self.config.set('ticket-custom', 'mergebotstate', 'select')
+        self.config.set('ticket-custom', 'mergebotstate.label', 'MergeBotState')
+        self.config.set('ticket-custom', 'mergebotstate.options', '| merged | branched | conflicts')
+        self.config.set('ticket-custom', 'mergebotstate.value', '')
+        self.config.save()
 
     # INavigationContributor
@@ -24 +48 @@
     def get_active_navigation_item(self, req):
         return 'mergebot'
+
     def get_navigation_items(self, req):
         """Generator that yields the MergeBot tab, but only if the user has
@@ -57 +82 @@
         fields = ['summary', 'component', 'version', 'status']
         info = {}
-        ticket = Ticket(self.env, ticketid)
-        for field in fields:
-            info[field] = ticket[field]
-        info['href'] = self.env.href.ticket(ticketid)
-        self.log.debug("id=%s, info=%r" % (ticketid, info))
+        if ticketid:
+            ticket = Ticket(self.env, ticketid)
+            for field in fields:
+                info[field] = ticket[field]
+            info['href'] = self.env.href.ticket(ticketid)
+            self.log.debug("id=%s, info=%r" % (ticketid, info))
         return info
+
+    def daemon_address(self):
+        host = self.env.config.get('mergebot', 'listen.ip')
+        port = int(self.env.config.get('mergebot', 'listen.port'))
+        return (host, port)
+
+    def start_daemon(self):
+        check_call(['mergebotdaemon', self.env.path])
+        time.sleep(1) # bleh
+
+    def _daemon_cmd(self, cmd):
+        self.log.debug('Sending mergebotdaemon: %r' % cmd)
+        try:
+            info_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+            info_socket.connect(self.daemon_address())
+        except socket.error, e:
+            # if we're refused, try starting the daemon and re-try
+            if e and e[0] == 111:
+                self.log.debug('connection to mergebotdaemon refused, trying to start mergebotdaemon')
+                self.start_daemon()
+            self.log.debug('Resending mergebotdaemon: %r' % cmd)
+            info_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+            info_socket.connect(self.daemon_address())
+        info_socket.sendall(cmd)
+        self.log.debug('Reading mergebotdaemon response')
+        raw = info_socket.recv(4096)
+        info_socket.close()
+        self.log.debug('Reading mergebotdaemon response was %r' % raw)
+        return raw
 
     def process_request(self, req):
@@ -68 +123 @@
         req.perm.assert_permission("MERGEBOT_VIEW")
 
-        # 2nd redirect back to the real mergebot page To address POST
+        # 2nd redirect back to the real mergebot page to address POST and
+        # browser refresh
         if req.path_info == "/mergebot/redir":
             req.redirect(req.href.mergebot())
 
-        debugs = []
-        req.hdf["title"] = "MergeBot"
+        data = {}
 
         if req.method == "POST": # The user hit a button
-            #debugs += [
-            #    "POST",
-            #    "Branching ticket %s" % req.args,
-            #]
-
-            ticketnum = req.args['ticket']
-            component = req.args['component']
-            version = req.args['version']
-            requestor = req.authname or "anonymous"
-            ticket = Ticket(self.env, int(ticketnum))
-            # FIXME: check for 'todo' key?
-            # If the request is not valid, just ignore it.
-            actor = None
-            if req.args['action'] == "Branch":
-                req.perm.assert_permission("MERGEBOT_BRANCH")
-                if self._is_branchable(ticket):
-                    actor = BranchActor(self.env)
-            elif req.args['action'] == "Rebranch":
-                req.perm.assert_permission("MERGEBOT_BRANCH")
-                if self._is_rebranchable(ticket):
-                    actor = RebranchActor(self.env)
-            elif req.args['action'] == "CheckMerge":
-                req.perm.assert_permission("MERGEBOT_VIEW")
-                if self._is_checkmergeable(ticket):
-                    actor = CheckMergeActor(self.env)
-            elif req.args['action'] == "Merge":
-                if version.startswith("#"):
-                    req.perm.assert_permission("MERGEBOT_MERGE_TICKET")
-                else:
-                    req.perm.assert_permission("MERGEBOT_MERGE_RELEASE")
-                if self._is_mergeable(ticket):
-                    actor = MergeActor(self.env)
-            if actor:
-                actor.AddTask([ticketnum, component, version, requestor])
-                try:
-                    actor.Run() # Starts processing deamon.
-                except Exception, e:
-                    self.log.exception(e)
+            if req.args['action'] in ['Branch', 'Rebranch', 'CheckMerge', 'Merge']:
+                ticketnum = req.args['ticket']
+                component = req.args['component']
+                version = req.args['version']
+                requestor = req.authname or 'anonymous'
+                ticket = Ticket(self.env, int(ticketnum))
+                # FIXME: check for 'todo' key?
+                # If the request is not valid, just ignore it.
+                action = None
+                if req.args['action'] == "Branch":
+                    req.perm.assert_permission("MERGEBOT_BRANCH")
+                    if is_branchable(ticket):
+                        action = 'branch'
+                elif req.args['action'] == "Rebranch":
+                    req.perm.assert_permission("MERGEBOT_BRANCH")
+                    if is_rebranchable(ticket):
+                        action = 'rebranch'
+                elif req.args['action'] == "CheckMerge":
+                    req.perm.assert_permission("MERGEBOT_VIEW")
+                    if is_checkmergeable(ticket):
+                        action = 'checkmerge'
+                elif req.args['action'] == "Merge":
+                    if version.startswith("#"):
+                        req.perm.assert_permission("MERGEBOT_MERGE_TICKET")
+                    else:
+                        req.perm.assert_permission("MERGEBOT_MERGE_RELEASE")
+                    if is_mergeable(ticket):
+                        action = 'merge'
+                if action:
+                    command = 'ADD %s %s %s %s %s\nQUIT\n' % (ticketnum, action, component, version, requestor)
+                    result = self._daemon_cmd(command)
+                    if 'OK' not in result:
+                        add_warning(req, result)
+            if req.args['action'] == "Cancel":
+                command = 'CANCEL %s\nQUIT\n' % req.args['task']
+                result = self._daemon_cmd(command)
+                if 'OK' not in result:
+                    add_warning(req, result)
             # First half of a double-redirect to make a refresh not re-send the
             # POST data.
@@ -120 +175 @@
         # We want to fill out the information for the page unconditionally.
 
+        # Connect to the daemon and read the current queue information
+        raw_queue_info = self._daemon_cmd('LIST\nQUIT\n')
+        # Parse the queue information into something we can display
+        queue_info = [x.split(',') for x in raw_queue_info.split('\n') if ',' in x]
+        status_map = {
+            'Z':'Zombie',
+            'R':'Running',
+            'Q':'Queued',
+            'W':'Waiting',
+            'P':'Pending',
+        }
+        for row in queue_info:
+            status = row[1]
+            row[1] = status_map[status]
+            summary = row[7]
+            row[7] = base64.b64decode(summary)
+
+        data['queue'] = queue_info
+
+        queued_tickets = set([int(q[2]) for q in queue_info])
+
+        # Provide the list of tickets at the bottom of the page, along with
+        # flags for which buttons should be enabled for each ticket.
         # I need to get a list of tickets.  For non-admins, restrict the list
         # to the tickets owned by that user.
-        querystring = "status=new|assigned|reopened&version!="
-        if not req.perm.has_permission("MERGEBOT_ADMIN"):
+        querystring = "status!=closed&version!="
+        required_columns = ["component", "version", "mergebotstate"]
+        if req.perm.has_permission("MERGEBOT_ADMIN"):
+            required_columns.append("owner")
+        else:
             querystring += "&owner=%s" % (req.authname,)
         query = Query.from_string(self.env, querystring, order="id")
         columns = query.get_columns()
-        for name in ("component", "version", "mergebotstate"):
+        for name in required_columns:
             if name not in columns:
                 columns.append(name)
-        #debugs.append("query.fields = %s" % str(query.fields))
         db = self.env.get_db_cnx()
         tickets = query.execute(req, db)
-        #debugs += map(str, tickets)
-        req.hdf['mergebot.ticketcount'] = str(len(tickets))
-
-        # Make the tickets indexable by ticket id number:
-        ticketinfo = {}
+        data['unqueued'] = []
         for ticket in tickets:
-            ticketinfo[ticket['id']] = ticket
-        #debugs.append(str(ticketinfo))
-
-        availableTickets = tickets[:]
-        queued_tickets = []
-        # We currently have 4 queues, "branch", "rebranch", "checkmerge", and
-        # "merge"
-        queues = [
-            ("branch", BranchActor),
-            ("rebranch", RebranchActor),
-            ("checkmerge", CheckMergeActor),
-            ("merge", MergeActor)
-        ]
-        for queuename, actor in queues:
-            status, queue = actor(self.env).GetStatus()
-            req.hdf["mergebot.queue.%s" % (queuename, )] = queuename
-            if status:
-                # status[0] is ticketnum
-                req.hdf["mergebot.queue.%s.current" % (queuename)] = status[0]
-                req.hdf["mergebot.queue.%s.current.requestor" % (queuename)] = status[3]
-                ticketnum = int(status[0])
-                queued_tickets.append(ticketnum)
-                ticket = self._get_ticket_info(ticketnum)
-                for field, value in ticket.items():
-                    req.hdf["mergebot.queue.%s.current.%s" % (queuename, field)] = value
-            else:
-                req.hdf["mergebot.queue.%s.current" % (queuename)] = ""
-                req.hdf["mergebot.queue.%s.current.requestor" % (queuename)] = ""
-
-            for i in range(len(queue)):
-                ticketnum = int(queue[i][0])
-                queued_tickets.append(ticketnum)
-                req.hdf["mergebot.queue.%s.queue.%d" % (queuename, i)] = str(ticketnum)
-                req.hdf["mergebot.queue.%s.queue.%d.requestor" % (queuename, i)] = queue[i][3]
-                ticket = self._get_ticket_info(ticketnum)
-                for field, value in ticket.items():
-                    req.hdf["mergebot.queue.%s.queue.%d.%s" % (queuename, i, field)] = value
-                    #debugs.append("%s queue %d, ticket #%d, %s = %s" % (queuename, i, ticketnum, field, value))
-
-        # Provide the list of tickets at the bottom of the page, along with
-        # flags for which buttons should be enabled for each ticket.
-        for ticket in availableTickets:
             ticketnum = ticket['id']
             if ticketnum in queued_tickets:
                 # Don't allow more actions to be taken on a ticket that is
                 # currently queued for something.  In the future, we may want
-                # to support a 'Cancel' button, though.
+                # to support a 'Cancel' button, though.  Or present actions
+                # based upon the expected state of the ticket
                 continue
-            req.hdf["mergebot.notqueued.%d" % (ticketnum)] = str(ticketnum)
-            for field, value in ticket.items():
-                req.hdf["mergebot.notqueued.%d.%s" % (ticketnum, field)] = value
+
+            ticket_info = {'info': ticket}
+            data['unqueued'].append(ticket_info)
+
             # Select what actions this user may make on this ticket based on
             # its current state.
+
             # MERGE
-            req.hdf["mergebot.notqueued.%d.actions.merge" % (ticketnum)] = 0
-            if req.perm.has_permission("MERGEBOT_MERGE_RELEASE") and \
-                not ticket['version'].startswith("#"):
-                req.hdf["mergebot.notqueued.%d.actions.merge" % (ticketnum)] = self._is_mergeable(ticket)
-            if req.perm.has_permission("MERGEBOT_MERGE_TICKET") and \
-                ticket['version'].startswith("#"):
-                req.hdf["mergebot.notqueued.%d.actions.merge" % (ticketnum)] = self._is_mergeable(ticket)
+            ticket_info['merge'] = False
+            if ticket['version'].startswith('#'):
+                if req.perm.has_permission("MERGEBOT_MERGE_TICKET"):
+                    ticket_info['merge'] = is_mergeable(ticket)
+            else:
+                if req.perm.has_permission("MERGEBOT_MERGE_RELEASE"):
+                    ticket_info['merge'] = is_mergeable(ticket)
             # CHECK-MERGE
             if req.perm.has_permission("MERGEBOT_VIEW"):
-                req.hdf["mergebot.notqueued.%d.actions.checkmerge" % (ticketnum)] = self._is_checkmergeable(ticket)
+                ticket_info['checkmerge'] = is_checkmergeable(ticket)
             else:
-                req.hdf["mergebot.notqueued.%d.actions.checkmerge" % (ticketnum)] = 0
+                ticket_info['checkmerge'] = False
             # BRANCH, REBRANCH
             if req.perm.has_permission("MERGEBOT_BRANCH"):
-                req.hdf["mergebot.notqueued.%d.actions.branch" % (ticketnum)] = self._is_branchable(ticket)
-                req.hdf["mergebot.notqueued.%d.actions.rebranch" % (ticketnum)] = self._is_rebranchable(ticket)
+                ticket_info['branch'] = is_branchable(ticket)
+                ticket_info['rebranch'] = is_rebranchable(ticket)
             else:
-                req.hdf["mergebot.notqueued.%d.actions.branch" % (ticketnum)] = 0
-                req.hdf["mergebot.notqueued.%d.actions.rebranch" % (ticketnum)] = 0
-
-        # Add debugs:
-        req.hdf["mergebot.debug"] = len(debugs)
-        for i in range(len(debugs)):
-            req.hdf["mergebot.debug.%d" % (i)] = debugs[i]
-
-        return "mergebot.cs", None
-
-    def _is_branchable(self, ticket):
-        try:
-            state = ticket['mergebotstate']
-        except KeyError:
-            state = ""
-        return state == "" or state == "merged"
-    def _is_rebranchable(self, ticket):
-        # TODO: we should be able to tell if trunk (or version) has had commits
-        # since we branched, and only mark it as rebranchable if there have
-        # been.
-        try:
-            state = ticket['mergebotstate']
-        except KeyError:
-            state = ""
-        return state in ["branched", "conflicts"]
-    def _is_mergeable(self, ticket):
-        try:
-            state = ticket['mergebotstate']
-        except KeyError:
-            state = ""
-        return state == "branched"
-    def _is_checkmergeable(self, ticket):
-        try:
-            state = ticket['mergebotstate']
-        except KeyError:
-            state = ""
-        return state == "branched" or state == "conflicts"
+                ticket_info['branch'] = False
+                ticket_info['rebranch'] = False
+
+        # proactive warnings
+        work_dir = self.env.config.get('mergebot', 'work_dir')
+        if not os.path.isabs(work_dir):
+            work_dir = os.path.join(self.env.path, work_dir)
+        if not os.path.isdir(work_dir):
+            add_warning(req, 'The Mergebot work directory "%s" does not exist.' % work_dir)
+
+        return "mergebot.html", data, None
 
     # ITemplateProvider
     def get_htdocs_dirs(self):
         return []
+
     def get_templates_dirs(self):
         # It appears that everyone does this import here instead of at the top