openstack/goal-tools
Code Issues Proposed changes

Add initial tools for burndown charts

Browse Source 
This tooling has been used several times for tracking large efforts
across many projects. This commit introduces it to the goal-tools
reporsitory and attempts to make it a bit more generic and not
specific to any one effort it was used for in the past.

Change-Id: I316cbd0fb9a98c5cc7cfdc6e4b96579e91d69271
This commit is contained in:
Lance Bragstad 2018-01-18 16:39:28 +00:00
parent 96dea45ef7
commit df995a0328
7 changed files with 354 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
config.ini

5
burndown-generator/config.ini.sample Normal file
View File

@ -0,0 +1,5 @@
# edit this file and copy it to config.ini to use the gen-burndown.py tool
[default]
user = <your gerrit http user>
password = <your gerrit http password>
gerrit-topic = <topic used to track reviews in gerrit>

0
burndown-generator/expected_repos.txt Normal file
View File

114
burndown-generator/gen-burndown.py Executable file
View File

@ -0,0 +1,114 @@
#!/usr/bin/env python3
import csv
import time
import os
import configparser
import json
import requests
from requests.auth import HTTPDigestAuth
PROJECT_SITE = "https://review.openstack.org/changes/"
def _parse_content(resp, debug=False):
# slice out the "safety characters"
if resp.content[:4] == b")]}'":
content = resp.content[5:]
if debug:
print("Response from Gerrit:\n")
print(content)
return json.loads(content.decode('utf-8'))
else:
print('could not parse response')
return resp.content
def parse_config():
config = configparser.ConfigParser()
config.read('config.ini')
user = config.get('default', 'user')
password = config.get('default', 'password')
topic = config.get('default', 'gerrit-topic')
return (user, password, topic)
def build_auth(user, password):
return HTTPDigestAuth(user, password)
def fetch_data(auth, url, debug=False):
start = None
more_changes = True
response = []
to_fetch = url
while more_changes:
if start:
to_fetch = url + '&start={}'.format(start)
print('fetching {}'.format(to_fetch))
resp = requests.get(to_fetch, auth=auth)
content = _parse_content(resp, debug)
response.extend(content)
try:
more_changes = content[-1].get('_more_changes', False)
except AttributeError:
print('Unrecognized response: {!r}'.format(resp.content))
raise
start = (start or 0) + len(content)
return response
observed_repos = set()
in_progress = set()
user, password, topic = parse_config()
auth = build_auth(user, password)
query = "q=topic:%s" % topic
url = "%s?%s" % (PROJECT_SITE, query)
relevant = fetch_data(auth, url)
print('Found {} reviews'.format(len(relevant)))
for review in relevant:
if review['status'] == 'ABANDONED':
continue
observed_repos.add(review['project'])
if review['status'] == 'MERGED':
# Do not count this repo as in-progress
continue
in_progress.add(review['project'])
with open('expected_repos.txt', 'r', encoding='utf-8') as f:
expected_repos = set([line.strip() for line in f])
unseen_repos = expected_repos - observed_repos
not_started = len(unseen_repos)
print('Found {} changes in review'.format(len(in_progress)))
print('Found {} repos not started'.format(not_started))
if not os.path.exists('data.csv'):
with open('data.csv', 'w') as f:
writer = csv.writer(f)
writer.writerow(
('date', 'Changes In Review', 'Repos Not Started')
)
with open('data.csv', 'a') as f:
writer = csv.writer(f)
writer.writerow(
(int(time.time()), len(in_progress), not_started),
)
with open('data.json', 'w') as f:
f.write(json.dumps([
{'Changes In Review': repo}
for repo in sorted(in_progress)
]))
with open('notstarted.json', 'w') as f:
f.write(json.dumps([
{'Repos Not Started': repo}
for repo in sorted(unseen_repos)
]))

211
burndown-generator/index.html Normal file
View File

@ -0,0 +1,211 @@
<!DOCTYPE html>
<head>
<title>Policy Burndown</title>
<meta charset="utf-8">
<meta http-equiv="refresh" content="3600">
<style type="text/css">
body {
font: 10px sans-serif;
}
.axis path,
.axis line {
fill: none;
stroke: #000;
shape-rendering: crispEdges;
}
.browser text {
text-anchor: end;
}
.todo {
font-size: 1.6em;
}
tr:nth-child(even) {
background-color: #eeeeee;
}
table.todo th {
background-color: #ccc;
padding: 0.5em;
}
table.todo td {
padding-left: 0.5em;
}
</style>
</head>
<body>
<p>Last updated: Thu Jan 18 16:33:28 UTC 2018
</p>
<div id="chart"></div>
<table id="tables">
<tr style="vertical-align: top;">
<td id="changes">
</td>
<td id="not-started">
</td>
</tr>
</table>
</div>
<script src="https://d3js.org/d3.v3.js"></script>
<script language="javascript">
var margin = {top: 20, right: 40, bottom: 30, left: 50},
width = 960 - margin.left - margin.right,
height = 500 - margin.top - margin.bottom;
var x = d3.time.scale()
.range([0, width]);
var y = d3.scale.linear()
.range([height, 0]);
var color = d3.scale.category20();
var xAxis = d3.svg.axis()
.scale(x)
.orient("bottom");
var yAxis = d3.svg.axis()
.scale(y)
.orient("left");
var yAxisR = d3.svg.axis()
.scale(y)
.orient("right");
var area = d3.svg.area()
.x(function(d) { return x(d.date); })
.y0(function(d) { return y(d.y0); })
.y1(function(d) { return y(d.y0 + d.y); });
var stack = d3.layout.stack()
.values(function(d) { return d.values; });
var svg = d3.select("#chart").append("svg")
.attr("width", width + margin.left + margin.right)
.attr("height", height + margin.top + margin.bottom)
.append("g")
.attr("transform", "translate(" + margin.left + "," + margin.top + ")");
var files = d3.select("body").append("div");
d3.csv("./data.csv", function(error, data) {
color.domain(d3.keys(data[0]).filter(function(key) { return key !== "date"; }));
data.forEach(function(d) {
d.date = new Date(d.date * 1000);
});
var browsers = stack(color.domain().map(function(name) {
return {
name: name,
values: data.map(function(d) {
return {date: d.date, y: d[name] * 1};
})
};
}));
// Find the value of the day with highest total value
var maxDateVal = d3.max(data, function(d){
var vals = d3.keys(d).map(function(key){ return key !== "date" ? d[key] : 0 });
return d3.sum(vals);
});
// Set domains for axes
x.domain(d3.extent(data, function(d) { return d.date; }));
y.domain([0, maxDateVal])
var browser = svg.selectAll(".browser")
.data(browsers)
.enter().append("g")
.attr("class", "browser");
browser.append("path")
.attr("class", "area")
.attr("d", function(d) { return area(d.values); })
.style("fill", function(d) { return color(d.name); });
browser.append("text")
.datum(function(d) { return {name: d.name, value: d.values[d.values.length - 1]}; })
.attr("transform", function(d) { return "translate(" + x(d.value.date) + "," + y(d.value.y0 + d.value.y / 2) + ")"; })
.attr("x", -40)
.attr("dy", ".35em")
.text(function(d) { return d.name; });
svg.append("g")
.attr("class", "x axis")
.attr("transform", "translate(0," + height + ")")
.call(xAxis);
svg.append("g")
.attr("class", "y axis")
.call(yAxis);
svg.append("g")
.attr("class", "y axis")
.attr("transform", "translate(" + width + " ,0)")
.attr("x", 20)
.call(yAxisR);
});
d3.json("data.json", function(data) {
function tabulate(data, columns) {
var table = d3.select('#changes').append('table').attr("class", "todo");
var thead = table.append('thead')
var tbody = table.append('tbody');
// append the header row
thead.append('tr')
.selectAll('th')
.data(columns).enter()
.append('th')
.text(function (column) { return column; });
// create a row for each object in the data
var rows = tbody.selectAll('tr')
.data(data)
.enter()
.append('tr');
// create a cell in each row for each column
var cells = rows.selectAll('td')
.data(function (row) {
return columns.map(function (column) {
return {column: column, value: row[column]};
});
})
.enter()
.append('td')
.html(function (d) {
return "<a href=https://review.openstack.org/#/q/is:open+topic:policy-and-docs-in-code+project:" + d.value + ">" + d.value + "</a>";
});
return table;
}
// render the table(s)
tabulate(data, ['Changes In Review']);
});
d3.json("notstarted.json", function(data) {
function tabulate(data, columns) {
var table = d3.select('#not-started').append('table').attr("class", "todo");
var thead = table.append('thead')
var tbody = table.append('tbody');
// append the header row
thead.append('tr')
.selectAll('th')
.data(columns).enter()
.append('th')
.text(function (column) { return column; });
// create a row for each object in the data
var rows = tbody.selectAll('tr')
.data(data)
.enter()
.append('tr');
// create a cell in each row for each column
var cells = rows.selectAll('td')
.data(function (row) {
return columns.map(function (column) {
return {column: column, value: row[column]};
});
})
.enter()
.append('td')
.text(function (d) { return d.value; });
return table;
}
// render the table(s)
tabulate(data, ['Repos Not Started']);
});
</script>
</body>

2
burndown-generator/requirements.txt Normal file
View File

@ -0,0 +1,2 @@
PyYAML
requests

21
burndown-generator/run.sh Executable file
View File

@ -0,0 +1,21 @@
#!/bin/bash -x
set -e
date
cd $(dirname $0)
if [[ ! -d .venv ]]
then
virtualenv --python=python3.5 .venv
.venv/bin/pip install -r requirements.txt
fi
source .venv/bin/activate
./gen-burndown.py
sed -i "s/Last updated:.*/Last updated: $(date -u)/" index.html
git add data.* *.json index.html
git commit -m "Updated csv"
git push origin master