Merge lp:~james-w/launchpad-work-items-tracker/date-based into lp:~linaro-automation/launchpad-work-items-tracker/linaro

[James Westby]

Hi,

This branch adds a new way of viewing milestones, by target
date rather than by milestone.

This means that you can have a page that shows info for all
milestones that land on the same day.

This is desirable, as the monthly milestones we will be moving
to may be named differently in different projects, but engineers
will want to see everything that they have to do for a particular
day on one page.

Thanks,

James

[Michael Hudson-Doyle (mwhudson)]

I don't think I understand the code well enough to say whether these changes make sense, I'm afraid. Happy to talk through the changes on mumble.

The sheer number of places that have to be changed to accept a date argument suggests that the layering in this code isn't really right, but I don't think that's a surprise to learn somehow :-)

review: Abstain

[lp:~james-w/launchpad-work-items-tracker/date-based]

283. By James Westby on 2011-03-18

Rework to use polymorpism for milestone due dates.

284. By James Westby on 2011-03-18

Changes from review comments. Thanks Michael.

285. By James Westby on 2011-03-22

Comments from review. Thanks Michael.

Unmerged revisions

279. By James Westby on 2011-03-04

Set the right status for each bug task workitem.

278. By James Westby on 2011-03-04

Allow workitems from projects other than Ubuntu.

277. By James Westby on 2011-02-28

Correct a copy-paste error that stopped the new workitem list pages from being generated.

276. By James Westby on 2011-02-28

Generate pages for each workitem status.

=== modified file 'burndown-chart'
--- burndown-chart	2011-02-16 23:59:52 +0000
+++ burndown-chart	2011-03-10 18:14:55 +0000
@@ -247,6 +247,8 @@
         help='Do not show foreign totals separate', dest='noforeign')
 optparser.add_option('--group',
         help='Run for this group', dest='group')
+optparser.add_option('--date',
+        help='Run for this date', dest='date')
 
 (opts, args) = optparser.parse_args()
 if not opts.database:
@@ -260,6 +262,8 @@
     optparser.error('user and group options are mutually exclusive')
 if opts.team and opts.group:
     optparser.error('team and group options are mutually exclusive')
+if opts.milestone and opts.date:
+    optparser.error('milestone and date options are mutually exclusive')
 
 # The typing allows polymorphic behavior
 if opts.user:
@@ -269,11 +273,11 @@
 
 # get date -> state -> count mapping
 db = report_tools.get_db(opts.database)
-data = report_tools.workitems_over_time(db, team=opts.team, milestone=opts.milestone, group=opts.group)
+data = report_tools.workitems_over_time(db, team=opts.team, milestone=opts.milestone, group=opts.group, date=opts.date)
 
 if len(data) == 0:
-    print 'WARNING: no work items, not generating chart (team: %s, milestone: %s, group: %s)' % (
-        opts.team or 'all', opts.milestone or 'none', opts.group or 'none')
+    print 'WARNING: no work items, not generating chart (team: %s, milestone: %s, group: %s, date: %s)' % (
+        opts.team or 'all', opts.milestone or 'none', opts.group or 'none', opts.date or 'none')
     sys.exit(0)
 
 # calculate start/end date if no dates are given
@@ -283,14 +287,17 @@
     start_date=opts.start_date
 
 if opts.end_date is None:
-    cur = db.cursor()
-    end_date=report_tools.milestone_due_date(db, milestone=opts.milestone)
+    if opts.date:
+        end_date = opts.date
+    else:
+        cur = db.cursor()
+        end_date=report_tools.milestone_due_date(db, milestone=opts.milestone)
 else:
     end_date=opts.end_date
 
 if not start_date or not end_date or date_to_ordinal(start_date) > date_to_ordinal(end_date):
-    print 'WARNING: empty date range, not generating chart (team: %s, milestone: %s)' % (
-        opts.team or 'all', opts.milestone or 'none')
+    print 'WARNING: empty date range, not generating chart (team: %s, milestone: %s, group: %s, date: %s)' % (
+        opts.team or 'all', opts.milestone or 'none', opts.group or 'none', opts.date or 'none')
     sys.exit(0)
 
 # title
@@ -307,6 +314,8 @@
 
 if opts.milestone:
     title += ' (%s)' % opts.milestone
+elif opts.date:
+    title += ' (%s)' % opts.date
 
 do_chart(data, start_date, end_date, opts.trendstart, title, opts.output, opts.only_weekdays, opts.inverted, noforeign)
 

=== modified file 'generate-all'
--- generate-all	2011-02-26 00:57:42 +0000
+++ generate-all	2011-03-10 18:14:55 +0000
@@ -34,11 +34,15 @@
     optparser.error('output directory does not exist')
 
 if opts.config:
-    trend_starts = report_tools.load_config(opts.config).get('trend_start', {})
-    burnup_chart_teams = report_tools.load_config(opts.config).get('burnup_chart_teams', [])
+    cfg = report_tools.load_config(opts.config)
+    trend_starts = cfg.get('trend_start', {})
+    burnup_chart_teams = cfg.get('burnup_chart_teams', [])
+    primary_team = cfg.get("primary_team", None)
 else:
+    cfg = None
     trend_starts = {}
     burnup_chart_teams = []
+    primary_team = None
 
 lock_path = opts.database + ".generate_lock"
 lock_f = open(lock_path, "wb")
@@ -104,6 +108,12 @@
     else:
         report_tools.run_reports(my_path, opts.database, basename, opts.config, milestone=m, team=None, root=opts.root)
 
+# date-based milestone view
+for mg in report_tools.milestone_groups(db, team=primary_team):
+    due_date_str = mg.due_date_str
+    basename = os.path.join(opts.output_dir, due_date_str)
+    report_tools.run_reports(my_path, opts.database, basename, opts.config, team=primary_team, root=opts.root, date=due_date_str)
+
 # groups
 for g in groups:
     basename = os.path.join(groupssubdir, g)

=== modified file 'html-report'
--- html-report	2011-02-28 15:59:50 +0000
+++ html-report	2011-03-10 18:14:55 +0000
@@ -105,8 +105,8 @@
         return self._assignee or self.blueprint.assignee
 
 
-def spec_group_completion(db, team, milestone):
-    data = report_tools.spec_group_completion(db, team, milestone)
+def spec_group_completion(db, team, milestone=None, date=None):
+    data = report_tools.spec_group_completion(db, team, milestone=milestone, date=date)
     if not data:
         return dict(areas=[], group_completion_series=[], groups=[])
     groups = []
@@ -250,25 +250,6 @@
     return dict(members=sorted(members))
 
 
-class Milestone(object):
-
-    def __init__(self, name, link, project):
-        self.name = name
-        self.link = link
-        self.project = project
-
-
-def milestones_info(db, team, milestone):
-    if team:
-        template = team + "-%s.html"
-    else:
-        template = "%s.html"
-    milestones = []
-    for milestone, project in report_tools.milestone_list(db).items():
-        milestones.append(Milestone(milestone, template % milestone, project))
-    return dict(milestones=milestones)
-
-
 def blueprint_count(db, team, milestone):
     return dict(blueprint_count=report_tools.blueprint_count(db, team=team, milestone=milestone))
 
@@ -360,13 +341,15 @@
 
         if opts.milestone:
             title += ' (%s)' % opts.milestone
+        elif opts.date:
+            title += ' (%s)' % opts.date
 
         data = self.template_data(db, opts)
         data.update(dict(team_name=title, chart_url=opts.chart_url))
         data.update(spec_group_completion(db, opts.team, opts.milestone))
         data.update(spec_completion(db, opts.team, opts.milestone))
         data.update(by_assignee(db, opts.team, opts.milestone))
-        if opts.milestone:
+        if opts.milestone or opts.date:
             data.update(dict(page_type="milestones"))
         elif isinstance(opts.team, report_tools.user_string):
             data.update(dict(page_type="people"))
@@ -390,7 +373,6 @@
         data.update(dict(team_name=title, chart_url=opts.chart_url))
         data.update(spec_group_completion(db, None, opts.milestone))
         data.update(spec_completion(db, opts.team, opts.milestone))
-        data.update(milestones_info(db, opts.team, opts.milestone))
         data.update(blueprint_count(db, opts.team, opts.milestone))
         data.update(dict(page_type="overview"))
         print report_tools.fill_template("overview.html", data)
@@ -423,7 +405,9 @@
 
     def milestone_list(self, db, opts):
         data = self.template_data(db, opts)
-        data.update(milestones_info(db, opts.team, opts.milestone))
+        data.update(
+            milestone_groups=report_tools.milestone_groups(
+                db, team=opts.team))
         data.update(dict(page_type="milestones"))
         print report_tools.fill_template("milestone_list.html", data)
 
@@ -474,12 +458,16 @@
             help="Root URL for the charts")
     optparser.add_option('--status', dest="status",
             help="Workitem status to consider for workitem_list report-type")
+    optparser.add_option('--date', dest="date",
+            help="Include all milestones targetted to this date.")
 
     (opts, args) = optparser.parse_args()
     if not opts.database:
         optparser.error('No database given')
     if opts.user and  opts.team:
         optparser.error('team and user options are mutually exclusive')
+    if opts.milestone and opts.date:
+        optparser.error('milestone and date options are mutually exclusive')
 
     # The typing allows polymorphic behavior
     if opts.user:

=== modified file 'report_tools.py'
--- report_tools.py	2011-02-28 18:18:24 +0000
+++ report_tools.py	2011-03-10 18:14:55 +0000
@@ -24,13 +24,15 @@
 def escape_sql(text):
     return text.replace("'", "''")
 
-def report_args(args, team=None, user=None, milestone=None):
+def report_args(args, team=None, user=None, milestone=None, date=None):
     if milestone:
         args.extend(['-m',milestone])
     if team:
         args.extend(['-t',team])
     if user:
         args.extend(['-u',user])
+    if date:
+        args.extend(['--date', date])
 
 def status_overview(my_path, database, basename, config, root=None):
     cfg = load_config(config)
@@ -166,13 +168,17 @@
 
 
 def run_reports(my_path, database, basename, config, milestone=None, team=None,
-        user=None, trend_starts=None, trend_override=None, burnup=False, root=None):
+        user=None, trend_starts=None, trend_override=None, burnup=False, root=None, date=None):
 
     ident = (team or user)
     if milestone and ident:
         chartname = ident + '-' + milestone
     elif milestone:
         chartname = 'all-' + milestone
+    elif date and ident:
+        chartname = "%s-%s" % (date, milestone)
+    elif date:
+        chartname = 'all-' + date
     elif ident:
         chartname = ident
     else:
@@ -186,16 +192,17 @@
         args += ['--title', cfg['title']]
     if root:
         args += ['--root', root]
-    report_args(args, team, user, milestone)
+    report_args(args, team=team, user=user, milestone=milestone, date=date)
     hreport = Popen(args, stdout=hf)
 
-    jf = open(basename + '.json', 'w')
-    args = [os.path.join(my_path, 'json-report'), '-d', database, '-c', config]
-    report_args(args, team, user, milestone)
-    jreport = Popen(args, stdout=jf)
+    if not date:
+        jf = open(basename + '.json', 'w')
+        args = [os.path.join(my_path, 'json-report'), '-d', database, '-c', config]
+        report_args(args, team=team, user=user, milestone=milestone)
+        jreport = Popen(args, stdout=jf)
 
     args = [os.path.join(my_path, 'burndown-chart'), '-d', database, '-o', basename + '.svg']
-    report_args(args, team, user, milestone)
+    report_args(args, team=team, user=user, milestone=milestone, date=date)
 
     if trend_override:
         args.extend(['--trend-start', trend_override])
@@ -203,7 +210,7 @@
         if milestone and ident:
             if (ident, milestone) in trend_starts:
                 args.extend(['--trend-start', str(trend_starts[(ident, milestone)])])
-        elif ident:
+        elif ident and not date:
             if ident in trend_starts:
                 args.extend(['--trend-start', str(trend_starts[ident])])
     if burnup:
@@ -259,7 +266,7 @@
     return escape(html, True)
 
 
-def get_milestone_start_sql(db, milestone):
+def get_milestone_start_sql(db, milestone=None, date=None):
     if milestone:
         # get milestone date range
         cur = db.cursor()
@@ -279,12 +286,21 @@
         else:
             ms_sql = "AND w.milestone='%s' AND date <= '%s'" % (
                     escape_sql(milestone), date_end)
+    elif date:
+        cur = db.cursor()
+        cur.execute('SELECT MAX(due_date), MAX(due_date) < date(CURRENT_TIMESTAMP) FROM milestones WHERE due_date < ?', (escape_sql(date), ))
+        (date_start, in_milestone) = cur.fetchone()
+        if in_milestone:
+            ms_sql = "AND date >= '%s' AND date <= '%s'" % (date_start, escape_sql(date))
+        else:
+            ms_sql = "AND date <= '%s'" % escape_sql(date)
+        ms_sql += "AND w.milestone IN (SELECT m.name from milestones m WHERE m.due_date = '%s')" % escape_sql(date)
     else:
         ms_sql = ''
     return ms_sql
 
 
-def workitems_over_time(db, team=None, milestone=None, group=None):
+def workitems_over_time(db, team=None, milestone=None, group=None, date=None):
     '''Calculate work item development over time.
 
     If team is given, this filters out blueprints for that particular team. If
@@ -296,7 +312,7 @@
     {todo,inprogress,done,postponed}{,_teamonly}.
     '''
     data = {}
-    ms_sql = get_milestone_start_sql(db, milestone)
+    ms_sql = get_milestone_start_sql(db, milestone=milestone, date=date)
     # include both direct team assignments, as well as assignmets to
     # members of that team
     cur = db.cursor()
@@ -361,14 +377,20 @@
             data.setdefault(date, {})[s] = num
     return data
 
-def spec_group_completion(db, team=None, milestone=None):
-    data = {}
-    if milestone == '':
+def milestone_select_sql(milestone=None, date=None):
+    if not milestone and not date:
         ms_sql = "AND w.milestone IS NULL"
     elif milestone:
         ms_sql = "AND w.milestone='%s'" % escape_sql(milestone)
+    elif date:
+        ms_sql = "AND w.milestone IN (SELECT m.name from milestones m WHERE m.due_date = '%s'" % date
     else:
         ms_sql = ''
+    return ms_sql
+
+def spec_group_completion(db, team=None, milestone=None, date=None):
+    data = {}
+    ms_sql = milestone_select_sql(milestone=milestone, date=date)
 
     # last date
     cur = db.cursor()
@@ -451,19 +473,14 @@
     return info
 
 
-def blueprint_completion(db, team=None, milestone=None):
+def blueprint_completion(db, team=None, milestone=None, date=None):
     '''Determine current blueprint completion.
 
     Return blueprint -> info mapping, with info being a map with these
     keys: todo, inprogress, done, postponed, status, priority, implementation, url.
     '''
     data = {}
-    if milestone == '':
-        ms_sql = "AND w.milestone IS NULL"
-    elif milestone:
-        ms_sql = "AND w.milestone='%s'" % escape_sql(milestone)
-    else:
-        ms_sql = ''
+    ms_sql = milestone_select_sql(milestone=milestone, date=date)
 
     # last date
     cur = db.cursor()
@@ -651,7 +668,7 @@
 
 
 def milestone_start_date(db, milestone=None):
-    ms_sql = get_milestone_start_sql(db, milestone)
+    ms_sql = get_milestone_start_sql(db, milestone=milestone)
     cur = db.cursor()
     cur.execute('SELECT MIN(date) FROM work_items w '
             'WHERE 1=1 %s GROUP BY date' % ms_sql)
@@ -673,12 +690,13 @@
     cycle_percent_elapsed = duration_elapsed(
         start_date, due_date, current_date)
     return dict(
+        current_date=current_date,
         days_left=weekdays_between(current_date, due_date),
         cycle_percent_elapsed=cycle_percent_elapsed,
         )
 
 
-def assignee_completion(db, team=None, milestone=None, group=None):
+def assignee_completion(db, team=None, milestone=None, group=None, date=None):
     '''Determine current by-assignee completion.
 
     Return assignee -> info mapping with info being a map with these
@@ -686,12 +704,7 @@
     workitem, priority, spec_url].
     '''
     data = {}
-    if milestone == '':
-        ms_sql = "AND w.milestone IS NULL"
-    elif milestone:
-        ms_sql = "AND w.milestone='%s'" % milestone
-    else:
-        ms_sql = ''
+    ms_sql = milestone_select_sql(milestone=milestone, date=date)
 
     # last date
     cur = db.cursor()
@@ -904,6 +917,47 @@
         return milestones
 
 
+class Milestone(object):
+
+    def __init__(self, name, link, project, due_date):
+        self.name = name
+        self.link = link
+        self.project = project
+        self.due_date = due_date
+
+
+class MilestoneGroup(object):
+
+    def __init__(self, due_date):
+        self.due_date = due_date
+        self.milestones = []
+
+    @property
+    def due_date_str(self):
+        return self.due_date.strftime("%Y-%m-%d")
+
+
+def milestone_groups(db, team=None):
+    if team:
+        template = team + "-%s.html"
+    else:
+        template = "%s.html"
+    groups = []
+    cur = db.cursor()
+    cur.execute('SELECT m.name, m.project, m.due_date '
+            'FROM milestones m ORDER BY m.due_date, m.name, m.project')
+    for name, project, due_date_str in cur:
+        due_date = date_to_python(due_date_str)
+        if len(groups) < 1 or due_date != groups[-1].due_date:
+            group = MilestoneGroup(due_date)
+            groups.append(group)
+        else:
+            group = groups[-1]
+        group.milestones.append(
+            Milestone(name, template % name, project, due_date))
+    return groups
+
+
 def real_names(db):
     cur = db.cursor()
     cur.execute('SELECT name, display_name FROM real_names')

=== modified file 'templates/base.html'
--- templates/base.html	2011-02-28 15:59:50 +0000
+++ templates/base.html	2011-03-10 18:14:55 +0000
@@ -12,6 +12,26 @@
                border-width: 1px; padding-right: 10px; }
     table#byworkitem td { vertical-align: top; }
 
+    table#milestones {
+        border-style: none;
+    }
+
+    table#milestones td.date {
+        border-left: 3px solid #98C13D;
+    }
+
+    table#milestones td {
+        vertical-align: bottom;
+        border-style: none;
+        border-bottom: none;
+        padding-left: 0px;
+        margin-left: 0px;
+    }
+
+    table#milestones td span.connector{
+        color: #98C13D;
+    }
+
     td.priority_Undefined, th.priority_Undefined { color: gray; }
     td.priority_Low, th.priority_Low { color: blue; }
     td.priority_Medium, th.priority_Medium { color: #f60; }

=== modified file 'templates/milestone_list.html'
--- templates/milestone_list.html	2011-02-06 20:10:39 +0000
+++ templates/milestone_list.html	2011-03-10 18:14:55 +0000
@@ -7,16 +7,38 @@
 
 <h1>Milestones</h1>
 
-<p>These are all of the milestones during the current cycle. Click on any one of them to see
-the tasks that are assigned to be completed by that milestone.</p>
+<p>Here is a timeline of all the milestones during the current cycle. Click on any one of them to see
+the tasks that are assigned to be completed by that milestone.
+The next milestone is highlighted by the marker on the left of the timeline.</p>
 
-% if milestones:
-<ul>
-% for milestone in milestones:
-<li><a href="${base.url(milestone.link)}">${milestone.name} (${milestone.project})</a></li>
-% endfor
-</ul>
+% if milestone_groups:
+<table id="milestones">
+<% last_group = None %>
+% for group in milestone_groups:
+<tr
+## Make the height of the row proportional to the duration between this milestone
+## and the previous. The height will not shrink below the contents though, so
+## there is no worry about very short durations.
+% if last_group is not None:
+height="${(group.due_date.toordinal() - last_group.due_date.toordinal())*2}px"
+% endif
+    
+>
+    <td class="current_date_marker">
+## Point at the first milestone that is after the current date
+% if group.due_date >= current_date and (last_group is None or last_group.due_date < current_date):
+&gt;
+% endif
+    </td>
+    <td class="date"><span class="connector">-</span> <a href="${base.url(group.due_date_str+".html")}">${group.due_date}</a></td>
+    <td class="milestones">
+% for milestone in group.milestones:
+<a href="${base.url(milestone.link)}">${milestone.name} (${milestone.project})</a>
+% endfor
+    </td>
+<% last_group = group %>
+% endfor
+</table>
 % else:
-<p>No teams!</p>
+<p>No milestones!</p>
 % endif
-