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 not in valid_states:
 115             print >> sys.stderr, 'ERROR: invalid state "%s" for work item "%s"' % (
 116                 state, desc)
 117             continue
 118         result.append((desc, state))
 119
 120     return result
 121
 122 def get_moin_workitems(url):
 123     '''Collect work items from a moin wiki URL.
 124
 125     Every line starting with "|| " is treated as a work item.
 126
 127     Return a list of ('item', 'status') pairs.
 128     '''
 129     result = []
 130     for line in urllib.urlopen(url):
 131         if line.startswith('|| '):
 132             fields = line.strip().split('||')
 133             assert not fields[0] # should be empty
 134             desc = fields[1].strip()
 135             for f in fields[2:]:
 136                 if 'DONE' in f:
 137                     result.append((desc, 'done'))
 138                     break
 139                 elif 'POSTPONED' in f:
 140                     result.append((desc, 'done'))
 141                     break
 142             else:
 143                 result.append((desc, 'todo'))
 144
 145     return result
 146
 147 def dump(db):
 148     '''Dump database contents.'''
 149
 150     cur = db.cursor()
 151     cur.execute('SELECT * FROM work_items')
 152     for (blueprint, workitem, status, date) in cur:
 153         print '%s [%s]\t%s: %s' % (date, blueprint, workitem, status)
 154
 155 def add_work_item(db, blueprint, item, status):
 156     '''Add work item to database.'''
 157
 158     cur = db.cursor()
 159     cur.execute('INSERT INTO work_items VALUES (?, ?, ?, date(CURRENT_TIMESTAMP))',
 160             (blueprint, item, status))
 161
 162 def import_lp(db, name_pattern, release):
 163     '''Collect blueprint work items from Launchpad into DB.'''
 164
 165     blueprints = get_blueprints('%s//ubuntu/%s/+specs' % (blueprints_base_url,
 166         opts.release), name_pattern)
 167
 168     cur = db.cursor()
 169     cur.execute('DELETE FROM work_items WHERE date = date(CURRENT_TIMESTAMP)')
 170
 171     for bp in blueprints:
 172         #print 'Checking', bp
 173         bpname = bp.split('/')[-1]
 174         work_items = get_blueprint_workitems(bp)
 175         if not work_items:
 176             print >> sys.stderr, 'WARNING: %s has no work items' % bpname
 177         for (item, status) in work_items:
 178             add_work_item(db, bpname, item, status)
 179
 180 def workitems_over_time(db):
 181     '''Calculate work item development over time.
 182
 183     Return date -> state -> count mapping.
 184     '''
 185     data = {}
 186     for s in valid_states:
 187         cur = db.cursor()
 188         cur.execute('SELECT date, count(*) FROM work_items WHERE status=? GROUP BY date',
 189                 (s,))
 190         for (date, num) in cur:
 191             data.setdefault(date, {})[s] = num
 192     return data
 193
 194 def blueprint_status(db):
 195     '''Determine current blueprint status.
 196
 197     Return blueprint -> [todo, done, postponed] mapping.
 198     '''
 199     data = {}
 200
 201     # last date
 202     cur = db.cursor()
 203     cur.execute('SELECT max(date) FROM work_items')
 204     (last_date,) = cur.fetchone()
 205
 206     index = 0
 207     for s in valid_states:
 208         cur = db.cursor()
 209         cur.execute('SELECT blueprint, count(workitem) FROM work_items '
 210                 'WHERE status = ? AND date = ? GROUP BY blueprint',
 211                 (s, last_date))
 212         for (bp, num) in cur:
 213             data.setdefault(bp, [0, 0, 0])[index] = num
 214         index += 1
 215
 216     return data
 217
 218 def text(db):
 219     '''Print work item status as text.'''
 220
 221     data = workitems_over_time(db)
 222
 223     print 'History:'
 224     for d in sorted(data.keys()):
 225         print d, data[d]
 226
 227     print '\nBlueprint status:'
 228     data = blueprint_status(db)
 229     for (bp, (todo, done, postponed)) in data.iteritems():
 230         print '%s: %i/%i (%i%%)' % (bp, postponed+done, todo+done+postponed,
 231                 int(float(postponed+done)/(todo+done+postponed)*100 + 0.5))
 232
 233 def csv(db, from_date, to_date):
 234     '''Print work item status as csv.'''
 235
 236     def _fmtdate(d):
 237         '''Convert datetime.date into MM/DD/YYYY'''
 238
 239         return '%s/%s/%s' % (d.month, d.day, d.year)
 240
 241     def _fromstr(s):
 242         '''Convert YYYY-MM-DD string to datetime.date'''
 243
 244         (y, m, d) = s.split('-')
 245         return datetime.date(int(y), int(m), int(d))
 246
 247     data = workitems_over_time(db)
 248
 249     dates = sorted(data.keys())
 250
 251     f = _fromstr(from_date or dates[0])
 252     t = _fromstr(to_date or dates[-1])
 253
 254     d = f
 255     while d <= t:
 256         entry = data.get('%i-%02i-%02i' % (d.year, d.month, d.day), {})
 257         print '%02i/%02i/%i,%i,%i,%i' % (d.month, d.day, d.year,
 258                 entry.get('todo', 0), entry.get('done', 0),
 259                 entry.get('postponed', 0))
 260         d += datetime.timedelta(days=1)
 261
 262 def import_moin(db, urls):
 263     '''Collect blueprint work items from a moin wiki.'''
 264
 265     for url in urls:
 266         for (d, s) in get_moin_workitems(url):
 267             add_work_item(db, url, d, s)
 268
 269 #
 270 # main
 271 #
 272
 273 (opts, args) = parse_argv()
 274
 275 db = get_db(opts.database)
 276
 277 if opts.dump:
 278     dump(db)
 279 elif opts.text:
 280     text(db)
 281 elif opts.csv:
 282     csv(db, opts.from_date, opts.to_date)
 283 else:
 284     import_lp(db, opts.pattern, opts.release)
 285     import_moin(db, opts.moin)
 286     db.commit()
 287