Merge lp:~broder/ubuntu-archive-tools/backport-helper into lp:ubuntu-archive-tools

[Evan Broder]

The backports team (plus backporter wannabes like me) are trying to attack any delays we can find in the backport process.

To that end, I've implemented backport-helper.py, intended to be a sync-helper for backports. It finds all bugs in any of the backports projects with a status of IN PROGRESS and ubuntu-archive subscribed, and prompts for any information it can't guess (i.e. which source package to backport). It takes as an argument a filename, to which it writes a list of instructions that can be piped into mass-sync.py.

Right now each bug requires some manual handling. But we're also planning to add scripts for filing backports bugs. Hopefully as the form of backports requests is standardized, we'll be able to add more automatic detection to the script.

I'm registering this merge proposal primarily to get process review - am I understanding how the tools work correctly? Does this workflow line up with how backports are currently processed? What else can backporters do to make the archive admins' lives easier?

[Colin Watson (cjwatson)]

Lovely, thanks! I haven't been able to try this out for real yet because there aren't any backport requests in the ubuntu-archive queue right now, but I changed it locally to look at Confirmed bugs from the ubuntu-backporters list, it behaves roughly as I'd expect, and the output looks more or less right. I'm going to go ahead and merge this since it's clearly much better than our current available tools.

review: Approve

=== added file 'backport-helper.py'
--- backport-helper.py	1970-01-01 00:00:00 +0000
+++ backport-helper.py	2010-11-16 06:47:57 +0000
@@ -0,0 +1,182 @@
+#!/usr/bin/python
+
+import optparse
+import os
+import re
+import sys
+import webbrowser
+
+import lputils
+
+
+CONSUMER_KEY = 'backport-helper'
+
+valid_series = set()
+backporters = set()
+
+
+class BPBug(object):
+    SOURCE_RE = re.compile(r'\bfrom (\w+)\b', re.I)
+
+    def __init__(self, bugtask):
+        self.number = bugtask.bug.id
+        self.title = bugtask.bug.title
+        self.reporter = bugtask.bug.owner
+
+        # Can't guess the package yet
+        self.package = None
+
+        # Try to guess the backport destination
+        self.dest = None
+        self.setDest(bugtask.bug_target_name)
+
+        # Try to guess the backport source
+        self.source = None
+        match = self.SOURCE_RE.search(bugtask.bug.title)
+        if match:
+            self.setSource(match.group(1))
+
+        # Collate the bug's history
+        self.content = bugtask.bug.description
+        for m in reversed(bugtask.bug.messages):
+            self.content += '\n=============================================\n'
+            star = ''
+            if m.owner in backporters:
+                star = '(*)'
+            self.content += '%s%s said %s on %s:\n\n' % (m.owner.name, star,
+                                                         m.subject, str(m.date_created))
+            self.content += m.content
+
+    # All setters return True if the input was valid
+    def setSource(self, value):
+        value = value.lower()
+        if self.validSuite(value):
+            self.source = value
+            return True
+        return False
+
+    def setDest(self, value):
+        value = value.lower()
+        value = value.split('-')[0]
+        if self.validSuite(value):
+            self.dest = value
+            return True
+        return False
+
+    def valid(self):
+        return self.package and self.source and self.dest
+
+    def validSuite(self, suite):
+        return suite.split('-')[0] in valid_series
+
+    def writeBackport(self, f):
+        params = {'number': self.number,
+                  'fromsuite': self.source,
+                  'tosuite': self.dest,
+                  'package': self.package,
+                  'requestor': self.reporter.name}
+        f.write('backport %(number)s -b %(requestor)s -S %(fromsuite)s -s %(tosuite)s %(package)s\n' % params)
+
+    def __str__(self):
+        return '#%d (%s: %s -> %s) %s' % (self.number,
+                                          self.package if self.package else 'unknown package',
+                                          self.source if self.source else 'unknown',
+                                          self.dest if self.dest else 'unknown',
+                                          self.title)
+
+def length(collection):
+    # XXX: Workaround bug 274074. Thanks wgrant.
+    return int(collection._wadl_resource.representation['total_size'])
+
+
+def parse_options(args=None):
+    p = optparse.OptionParser(usage='Usage: %prog [options] filename')
+
+    p.add_option('-l', '--launchpad', dest='launchpad_instance',
+                 default='edge')
+
+    options, args = p.parse_args(args=args)
+    if len(args) != 1:
+        p.error('Need a filename to write instructions to')
+
+    return options, args
+
+
+def main(args=None):
+    global valid_series, backporters
+
+    options, args = parse_options(args[1:])
+
+    try:
+        f = open(args[0], 'w')
+    except:
+        print 'Error opening instruction file'
+        return 1
+
+    print 'Connceting to LP ...',
+    lp = lputils.lpfactory(options.launchpad_instance, CONSUMER_KEY)
+    print 'Done'
+
+    valid_series = set(s.name for s in lp.distributions['ubuntu'].series if s.active)
+    bp_team = lp.people['ubuntu-backporters']
+    backporters = set(bp_team.getMembersByStatus(status='Approved')).union(
+        bp_team.getMembersByStatus(status='Administrator'))
+    pillar = lp.projects['ubp']
+    subscriber = lp.people['ubuntu-archive']
+
+    print 'Loading bugs (this may take some time) ...'
+    bugs = pillar.searchTasks(bug_subscriber=subscriber,
+                              status='In Progress')
+    bp_bugs = []
+    num_bugs = length(bugs)
+    print 'Found %d bug(s)' % num_bugs
+
+    for i, bugtask in enumerate(bugs, 1):
+        bug = BPBug(bugtask)
+        print '%d/%d: %s' % (i, num_bugs, bug)
+        bp_bugs.append(bug)
+    print 'Done, %d bugs to consider.' % len(bp_bugs)
+
+    for bug in bp_bugs:
+        print
+        print '=========================='
+
+        while True:
+            print
+            print bug
+
+            msg = '[Show/sKip/'
+            if bug.valid():
+                msg += 'process Backport/'
+            msg += 'set Package/set sOurce series/set Dest series/opEn bug]: '
+            sys.stdout.write(msg)
+            sys.stdout.flush()
+            ret = sys.stdin.readline().rstrip().upper()
+
+            if ret == 'S':
+                print bug.content
+            elif ret == 'K':
+                break
+            elif ret == 'B':
+                if not bug.valid():
+                    print 'Backport does not yet have all required information'
+                    continue
+                bug.writeBackport(f)
+                break
+            elif ret == 'P':
+                maybe_package = raw_input('New package? ').lower()
+                bug.package = maybe_package
+            elif ret == 'O':
+                if not bug.setSource(raw_input('New source series? ')):
+                    print 'Invalid series'
+            elif ret == 'D':
+                if not bug.setDest(raw_input('New dest series? ')):
+                    print 'Invalid series'
+            elif ret == 'E':
+                webbrowser.open('https://bugs.launchpad.net/bugs/%s' % bug.number)
+            else:
+                print 'Unknown command: %s' % ret
+
+
+if __name__ == '__main__':
+    sys.exit(main(sys.argv))