1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
|
#!/usr/bin/python
#
# Create HTML reports from a work item database.
import json
import optparse
from report_tools import escape_url
import report_tools
class WorkitemTarget(object):
def __init__(self, todo=0, blocked=0, inprogress=0, postponed=0,
done=0):
self.todo = todo
self.blocked = blocked
self.inprogress = inprogress
self.postponed = postponed
self.done = done
@property
def percent_complete(self):
completed = self.postponed + self.done
total = completed + self.todo + self.blocked + self.inprogress
if total < 1:
return 0
return int((float(completed)/total)*100 + 0.5)
class Blueprint(WorkitemTarget):
def __init__(self, name, url, complexity=0,
todo=0, blocked=0, inprogress=0, postponed=0,
done=0, implementation=None, priority=None,
status=None):
super(Blueprint, self).__init__(
todo=todo, blocked=blocked, inprogress=inprogress,
postponed=postponed, done=done)
self.name = name
self.url = url
self.complexity = complexity
self.implementation = implementation
self.priority = priority
self.status = status
class Assignee(WorkitemTarget):
def __init__(self, name, url, complexity=0, todo_wis=[],
blocked_wis=[], inprogress_wis=[], postponed_wis=[],
done_wis=[]):
super(Assignee, self).__init__(
todo=len(todo_wis), blocked=len(blocked_wis),
inprogress=len(inprogress_wis), postponed=len(postponed_wis),
done=len(done_wis))
self.name = name
self.url = url
self.complexity = complexity
self.todo_wis = todo_wis
self.blocked_wis = blocked_wis
self.inprogress_wis = inprogress_wis
self.postponed_wis = postponed_wis
self.done_wis = done_wis
class BlueprintGroup(Blueprint):
def __init__(self, name, url, area, complexity=0, todo=0, blocked=0,
inprogress=0, postponed=0, done=0, implementation=None,
priority=None, status=None):
super(BlueprintGroup, self).__init__(name, url,
complexity=complexity, todo=todo, blocked=blocked,
inprogress=inprogress, postponed=postponed,
done=done, implementation=implementation, priority=priority,
status=status)
self.area = area
self.specs = []
class Area(object):
def __init__(self, name):
self.name = name
self.groups = []
def has_priority(self):
return any([g.priority for g in self.groups])
def spec_group_completion(db, team, milestone):
data = report_tools.spec_group_completion(db, team, milestone)
if not data:
return
by_area = {}
by_completion = [0, 0, 0, 0]
for bp_name, i in data.items():
area_name = i['area']
area_name = " ".join([a.capitalize() for a in area_name.split()])
if area_name not in by_area:
area = Area(area_name)
by_area[area_name] = area
else:
area = by_area[area_name]
group = BlueprintGroup(bp_name, i['url'], area,
todo=i['todo'], blocked=i['blocked'],
inprogress=i['inprogress'],
postponed=i['postponed'], done=i['done'],
implementation=i['implementation'],
priority=i['priority'], status=i['status'])
area.groups.append(group)
completion = group.percent_complete
if completion < 25:
by_completion[0] += 1
elif completion < 50:
by_completion[1] += 1
elif completion < 75:
by_completion[2] += 1
else:
by_completion[3] += 1
series = []
for i, completion_count in enumerate(by_completion):
label = ">= 75% complete"
if i == 0:
label = "< 25% complete"
elif i == 1:
label = ">= 25% and < 50% complete"
elif i == 2:
label = ">= 50% and < 75% complete"
series.append(dict(label=label, data=completion_count))
return dict(areas=sorted(by_area.values(), key=lambda x: x.name),
group_completion_series=json.dumps(series))
def spec_completion(db, team, milestone):
data = report_tools.blueprint_completion(db, team, milestone)
blueprints = []
all_workitems = WorkitemTarget()
for bp_name, i in data.items():
bp = Blueprint(bp_name, i['url'], complexity=i['complexity'],
todo=i['todo'], blocked=i['blocked'],
inprogress=i['inprogress'],
postponed=i['postponed'], done=i['done'],
implementation=i['implementation'],
priority=i['priority'], status=i['status'])
all_workitems.todo += bp.todo
all_workitems.blocked += bp.blocked
all_workitems.inprogress += bp.inprogress
all_workitems.postponed += bp.postponed
all_workitems.done += bp.done
blueprints.append(bp)
# avoid showing empty columns
specs_have_status = any([bp.status for bp in blueprints])
specs_have_complexity = any([bp.complexity > 0 for bp in blueprints])
blueprints.sort(
key=lambda bp: bp.percent_complete*100+report_tools.priority_value(bp.priority),
reverse=True)
return dict(
specs_have_status=specs_have_status,
specs_have_complexity=specs_have_complexity,
blueprints=blueprints,
all_workitems=all_workitems)
def get_assignee_completion(db, team, milestone):
data = report_tools.assignee_completion(db, team, milestone)
def _sort(a, b):
# Takes [blueprint, workitem, priority, url] in a and b.
# first by priority
relative = cmp(report_tools.priority_value(b[2]), report_tools.priority_value(a[2]))
if relative != 0:
return relative
# then by blueprint
return cmp(a[0], b[0])
assignees = []
for name, info in data.items():
name = name or team or 'nobody'
name_html = escape_url(name or team or 'nobody')
if not milestone or isinstance(team, report_tools.user_string):
url = '%s/~%s/+specs?role=assignee' % (report_tools.blueprints_base_url, name_html)
else:
target = name_html + '-' + milestone
url = 'u/%s.html' % target
assignees.append(
Assignee(name, url, complexity=info['complexity'],
todo_wis=sorted(info['todo'], cmp=_sort),
blocked_wis=info['blocked'],
inprogress_wis=info['inprogress'],
postponed_wis=info['postponed'],
done_wis=info['done']))
return assignees
def by_assignee(db, team, milestone):
assignees = get_assignee_completion(db, team, milestone)
assignees.sort(key=lambda a: a.name, reverse=False)
# avoid showing empty columns
assignees_have_complexity = any([a.complexity > 0 for a in assignees])
# avoid showing empty columns
workitems_have_priority = False
for assignee in assignees:
for status in report_tools.valid_states:
for wi in getattr(assignee, status+"_wis", []):
if wi[2]:
workitems_have_priority = True
break
if workitems_have_priority:
break
return dict(
assignees_have_complexity=assignees_have_complexity,
assignees=assignees,
workitems_have_priority=workitems_have_priority,
valid_states=report_tools.valid_states)
def member_completion(db, team, milestone):
members = report_tools.subteams(db, team)
return dict(members=sorted(members))
class Milestone(object):
def __init__(self, name, link):
self.name = name
self.link = link
def milestones_info(db, team, milestone):
if team:
template = team + "-%s.html"
else:
template = "%s.html"
milestones = []
for milestone in report_tools.milestone_list(db):
milestones.append(Milestone(milestone, template % milestone))
return dict(milestones=milestones)
def get_group(db, group_name):
info = report_tools.spec_group_info(db, group_name)
assert info is not None, "group %s not found" % group_name
area = Area(info['area'])
group = BlueprintGroup(group_name, info['url'], area,
todo=info['todo'], blocked=info['blocked'],
inprogress=info['inprogress'], postponed=info['postponed'],
done=info['done'], implementation=info['implementation'],
priority=info['priority'], status=info['status'])
for spec_name, spec_info in info['specs'].items():
spec = Blueprint(spec_name, spec_info['url'],
complexity=0,
todo=spec_info['todo'],
blocked=spec_info['blocked'],
inprogress=spec_info['inprogress'],
postponed=spec_info['postponed'],
done=spec_info['done'],
implementation=spec_info['implementation'],
priority=spec_info['priority'],
status=spec_info['status'])
group.specs.append(spec)
return group
class ReportWriter(object):
def burndown(self, db, opts):
'''Print work item status as HTML.'''
if not opts.title:
if opts.team:
title = opts.team
else:
title = 'all teams'
else:
title = opts.title
if opts.milestone:
title += ' (%s)' % opts.milestone
data = dict(team_name=title, chart_url=opts.chart_url)
data.update(spec_completion(db, opts.team, opts.milestone))
data.update(by_assignee(db, opts.team, opts.milestone))
print report_tools.fill_template("burndown.html", data)
def overview(self, db, opts):
if not opts.title:
if opts.team:
title = opts.team
else:
title = 'all teams'
else:
title = opts.title
if opts.milestone:
title += ' (%s)' % opts.milestone
data = 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(member_completion(db, opts.team, opts.milestone))
data.update(milestones_info(db, opts.team, opts.milestone))
print report_tools.fill_template("overview.html", data)
def group_overview(self, db, opts):
if not opts.group:
raise AssertionError(
"Must specify group for group_overview report.")
data = dict(chart_url=opts.chart_url)
data["group"] = get_group(db, opts.group)
print report_tools.fill_template("group_overview.html", data)
#
# main
#
if __name__ == '__main__':
report_tools.fix_stdouterr()
# argv parsing
optparser = optparse.OptionParser()
optparser.add_option('-d', '--database',
help='Path to database', dest='database', metavar='PATH')
optparser.add_option('-t', '--team',
help='Restrict report to a particular team', dest='team')
optparser.add_option('-m', '--milestone',
help='Restrict report to a particular milestone', dest='milestone')
optparser.add_option('--chart', default='burndown.svg',
help='(Relative) URL to burndown chart', dest='chart_url')
optparser.add_option('-u', '--user',
help='Run for this user', dest='user')
optparser.add_option('--title',
help='Set custom title')
optparser.add_option('--report-type', default="burndown",
dest="report_type")
optparser.add_option('--group', dest="group",
help="Select the group for a group_overview report.")
(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')
# The typing allows polymorphic behavior
if opts.user:
opts.team = report_tools.user_string(opts.user)
elif opts.team:
opts.team = report_tools.team_string(opts.team)
db = report_tools.get_db(opts.database)
writer = ReportWriter()
method = getattr(writer, opts.report_type, None)
if method is None:
optparser.error('Unknown report type: %s' % opts.report_type)
method(db, opts)
|