workitems.py

   1 #!/usr/bin/python
   2
   3 import urllib, re, sys, optparse, os.path, datetime
   4 import sqlite3 as dbapi2
   5
   6 blueprints_base_url = 'https://blueprints.launchpad.net'
   7
   8 valid_states = set(['todo', 'done', 'postponed'])
   9
  10 def get_db(dbpath):
  11     '''Open/initialize database.
  12
  13     This creates the database if it does not exist.
  14     '''
  15     init = not os.path.exists(dbpath)
  16
  17     db = dbapi2.connect(dbpath)
  18
  19     if init:
  20         cur = db.cursor()
  21         cur.execute('''CREATE TABLE work_items (
  22             blueprint VARCHAR(255) NOT NULL,
  23             workitem VARCHAR(255) NOT NULL,
  24             status VARCHAR(20) NOT NULL,
  25             date TIMESTAMP NOT NULL)''')
  26         db.commit()
  27
  28     return db
  29
  30 def parse_argv():
  31     '''Parse CLI arguments.
  32
  33     Return (options, args) tuple.
  34     '''
  35     optparser = optparse.OptionParser()
  36     optparser.add_option('-d', '--database',
  37         help='Path to database', dest='database', metavar='PATH')
  38     optparser.add_option('-r', '--release',
  39         help='Release name', dest='release')
  40     optparser.add_option('-p', '--pattern', metavar='REGEX',
  41         help='Regex pattern for blueprint name', dest='pattern')
  42     optparser.add_option('-D', '--dump', action='store_true', default=False,
  43         help='Dump database', dest='dump')
  44     optparser.add_option('-m', '--moin', metavar='URL',
  45         help='moin URL for additional work items (can be given multiple times)',
  46         action='append', dest='moin', default=[])
  47     optparser.add_option('-t', '--text', action='store_true', default=False,
  48         help='Print work item summary in text format', dest='text')
  49     optparser.add_option('-c', '--csv', action='store_true', default=False,
  50         help='Print work item summary in text format', dest='csv')
  51     optparser.add_option('--from', metavar='YYYY-MM-DD',
  52         help='Generate CSV data from this day on', dest='from_date')
  53     optparser.add_option('--to', metavar='YYYY-MM-DD',
  54         help='Generate CSV data until this day', dest='to_date')
  55
  56     (opts, args) = optparser.parse_args()
  57
  58     if not opts.database:
  59         optparser.error('No database given')
  60     if not opts.dump and not opts.text and not opts.csv:
  61         if not opts.release:
  62             optparser.error('No release given')
  63         if not opts.pattern:
  64             optparser.error('No pattern given')
  65
  66     return (opts, args)
  67
  68 def get_blueprints(url, name_pattern):
  69     '''Return a list of blueprint URLs for the current release.'''
  70
  71     blueprint_name_filter = re.compile('href="(/ubuntu/\+spec/%s[^"]+)"' %
  72             name_pattern)
  73
  74     result = []
  75     for l in urllib.urlopen(url):
  76         m = blueprint_name_filter.search(l)
  77         if m:
  78             result.append(blueprints_base_url + m.group(1))
  79
  80     return result
  81
  82 def get_blueprint_workitems(blueprint_url):
  83     '''Collect work items from a particular blueprint URL.
  84
  85     This will return a list of ('item', 'status') pairs.
  86     '''
  87     work_items_re = re.compile('(<p>|^)work items:\s*<br />', re.I)
  88
  89     found_workitems = False
  90     result = []
  91     for l in urllib.urlopen(blueprint_url):
  92         if not found_workitems:
  93             if work_items_re.search(l):
  94                 found_workitems = True
  95             continue
  96
  97         l = l.replace('<br />', '').replace('</div>', '').strip()
  98
  99         # ends with empty line
 100         if l.endswith('</p>') or not l:
 101             break
 102
 103         try:
 104             (desc, state) = l.rsplit(':', 1)
 105         except ValueError:
 106             print >> sys.stderr, 'ERROR: invalid work item format: ' + l
 107             continue
 108         desc = desc.strip()
 109         state = state.strip().lower()
 110         if not state:
 111             state = 'todo'
 112         if state == 'completed':
 113             state = 'done'
 114         if state == 'inprogress':
 115             state = 'todo'
 116         if state not in valid_states:
 117             print >> sys.stderr, 'ERROR: invalid state "%s" for work item "%s"' % (
 118                 state, desc)
 119             continue
 120         result.append((desc, state))
 121
 122     return result
 123
 124 def get_moin_workitems(url):
 125     '''Collect work items from a moin wiki URL.
 126
 127     Every line starting with "|| " is treated as a work item.
 128
 129     Return a list of ('item', 'status') pairs.
 130     '''
 131     result = []
 132     for line in urllib.urlopen(url):
 133         if line.startswith('|| '):
 134             fields = line.strip().split('||')
 135             assert not fields[0] # should be empty
 136             desc = fields[1].strip()
 137             for f in fields[2:]:
 138                 if 'DONE' in f:
 139                     result.append((desc, 'done'))
 140                     break
 141                 elif 'POSTPONED' in f:
 142                     result.append((desc, 'done'))
 143                     break
 144             else:
 145                 result.append((desc, 'todo'))
 146
 147     return result
 148
 149 def dump(db):
 150     '''Dump database contents.'''
 151
 152     cur = db.cursor()
 153     cur.execute('SELECT * FROM work_items')
 154     for (blueprint, workitem, status, date) in cur:
 155         print '%s [%s]\t%s: %s' % (date, blueprint, workitem, status)
 156
 157 def add_work_item(db, blueprint, item, status):
 158     '''Add work item to database.'''
 159
 160     cur = db.cursor()
 161     cur.execute('INSERT INTO work_items VALUES (?, ?, ?, date(CURRENT_TIMESTAMP))',
 162             (blueprint, item, status))
 163
 164 def import_lp(db, name_pattern, release):
 165     '''Collect blueprint work items from Launchpad into DB.'''
 166
 167     blueprints = get_blueprints('%s//ubuntu/%s/+specs' % (blueprints_base_url,
 168         opts.release), name_pattern)
 169
 170     cur = db.cursor()
 171     cur.execute('DELETE FROM work_items WHERE date = date(CURRENT_TIMESTAMP)')
 172
 173     for bp in blueprints:
 174         #print 'Checking', bp
 175         bpname = bp.split('/')[-1]
 176         work_items = get_blueprint_workitems(bp)
 177         if not work_items:
 178             print >> sys.stderr, 'WARNING: %s has no work items' % bpname
 179         for (item, status) in work_items:
 180             add_work_item(db, bpname, item, status)
 181
 182 def workitems_over_time(db):
 183     '''Calculate work item development over time.
 184
 185     Return date -> state -> count mapping.
 186     '''
 187     data = {}
 188     for s in valid_states:
 189         cur = db.cursor()
 190         cur.execute('SELECT date, count(*) FROM work_items WHERE status=? GROUP BY date',
 191                 (s,))
 192         for (date, num) in cur:
 193             data.setdefault(date, {})[s] = num
 194     return data
 195
 196 def blueprint_status(db):
 197     '''Determine current blueprint status.
 198
 199     Return blueprint -> [todo, done, postponed] mapping.
 200     '''
 201     data = {}
 202
 203     # last date
 204     cur = db.cursor()
 205     cur.execute('SELECT max(date) FROM work_items')
 206     (last_date,) = cur.fetchone()
 207
 208     index = 0
 209     for s in valid_states:
 210         cur = db.cursor()
 211         cur.execute('SELECT blueprint, count(workitem) FROM work_items '
 212                 'WHERE status = ? AND date = ? GROUP BY blueprint',
 213                 (s, last_date))
 214         for (bp, num) in cur:
 215             data.setdefault(bp, [0, 0, 0])[index] = num
 216         index += 1
 217
 218     return data
 219
 220 def text(db):
 221     '''Print work item status as text.'''
 222
 223     data = workitems_over_time(db)
 224
 225     print 'History:'
 226     for d in sorted(data.keys()):
 227         print d, data[d]
 228
 229     print '\nBlueprint status:'
 230     data = blueprint_status(db)
 231     for (bp, (todo, done, postponed)) in data.iteritems():
 232         print '%s: %i/%i (%i%%)' % (bp, postponed+done, todo+done+postponed,
 233                 int(float(postponed+done)/(todo+done+postponed)*100 + 0.5))
 234
 235 def csv(db, from_date, to_date):
 236     '''Print work item status as csv.'''
 237
 238     def _fmtdate(d):
 239         '''Convert datetime.date into MM/DD/YYYY'''
 240
 241         return '%s/%s/%s' % (d.month, d.day, d.year)
 242
 243     def _fromstr(s):
 244         '''Convert YYYY-MM-DD string to datetime.date'''
 245
 246         (y, m, d) = s.split('-')
 247         return datetime.date(int(y), int(m), int(d))
 248
 249     data = workitems_over_time(db)
 250
 251     dates = sorted(data.keys())
 252
 253     f = _fromstr(from_date or dates[0])
 254     t = _fromstr(to_date or dates[-1])
 255
 256     d = f
 257     while d <= t:
 258         entry = data.get('%i-%02i-%02i' % (d.year, d.month, d.day), {})
 259         print '%02i/%02i/%i,%i,%i,%i' % (d.month, d.day, d.year,
 260                 entry.get('todo', 0), entry.get('done', 0),
 261                 entry.get('postponed', 0))
 262         d += datetime.timedelta(days=1)
 263
 264 def import_moin(db, urls):
 265     '''Collect blueprint work items from a moin wiki.'''
 266
 267     for url in urls:
 268         for (d, s) in get_moin_workitems(url):
 269             add_work_item(db, url, d, s)
 270
 271 #
 272 # main
 273 #
 274
 275 (opts, args) = parse_argv()
 276
 277 db = get_db(opts.database)
 278
 279 if opts.dump:
 280     dump(db)
 281 elif opts.text:
 282     text(db)
 283 elif opts.csv:
 284     csv(db, opts.from_date, opts.to_date)
 285 else:
 286     import_lp(db, opts.pattern, opts.release)
 287     import_moin(db, opts.moin)
 288     db.commit()
 289