Files
governance/tools/teamstats.py
Doug Hellmann 1c98c456b5 add flake8 to the linter job
Turn on flake8 for code style checks, like in our other repos. Fix or
explicitly ignore various issues to allow the linter job to pass.

Change-Id: I7bfd8cf5e9c00dfa83c0393a4307fd54d2113047
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-03-15 17:47:28 -04:00

270 lines
9.6 KiB
Python

#!/usr/bin/env python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import functools
import os
import sys
import time
import uuid
import requests
import requests_cache
import yaml
import base
# Since the stackalytics is slow and we can call it twice, cache the results
requests_cache.install_cache(backend='memory', expire_after=60)
s = requests.session()
six_months = int(time.time() - 30*6*24*60*60) # 6 months ago
# NOTE(flaper87): This value affects both, single-vendor and diverse-affiliation
# tags and it's been tuned to a reasonable enough threshold to measure reviews
# activeness. Changes to this value must be discussed separately.
MIN_PERCENTAGE_REVIEWS = 0.02 # 2%
MIN_REVIEWS = 30
MIN_COMMITS = 6
def _memoize(func):
cache = {}
@functools.wraps(func)
def memoized(*args, **kwargs):
key = (args, tuple(kwargs.items()))
try:
return cache[key]
except KeyError:
cache[key] = func(*args, **kwargs)
return cache[key]
return memoized
@_memoize
def _get_number_of_commits(group, start_date=six_months):
commits = s.get('http://stackalytics.com/api/'
'1.0/stats/companies?metric=commits&release=all'
'&project_type=all&module=%s&start_date=%s'
% (group, start_date)).json()
return sum([company['metric'] for company in commits['stats']])
@_memoize
def get_team_size_stats(team):
team_stats = {}
group = "%s-group" % team.lower()
commits_total = _get_number_of_commits(group)
min_percent = int(commits_total * MIN_PERCENTAGE_REVIEWS)
reviews = s.get('http://stackalytics.com/api/'
'1.0/stats/engineers?metric=marks&release=all'
'&start_date=%s&project_type=all'
'&module=%s' % (six_months, group)).json()
team_stats['active_reviewers'] = 0
for eng in reviews['stats']:
if eng['metric'] >= MIN_REVIEWS or eng['metric'] >= min_percent:
team_stats['active_reviewers'] += 1
team_stats['active_committers'] = 0
commits = s.get('http://stackalytics.com/api/'
'1.0/stats/engineers?metric=commits&release=all'
'&project_type=all&module=%s&start_date=%s'
% (group, six_months)).json()
for eng in commits['stats']:
if eng['metric'] >= MIN_COMMITS:
team_stats['active_committers'] += 1
return team_stats
@_memoize
def get_core_reviews_by_company(group):
# reviews by individual
commits_total = _get_number_of_commits(group)
min_percent = int(commits_total * MIN_PERCENTAGE_REVIEWS)
reviews = s.get('http://stackalytics.com/api/'
'1.0/stats/engineers?metric=marks&release=all'
'&start_date=%s&project_type=all'
'&module=%s' % (six_months, group)).json()
companies = {}
for eng in reviews['stats']:
if eng['core'] != 'master':
continue
for stat in s.get('http://stackalytics.com/api/1.0/stats/'
'companies?metric=marks&module=%s&user_id=%s&'
'project_type=all&release=all&start_date=%s' %
(group, eng['id'], six_months)).json()['stats']:
company = stat['id']
if company == '*independent':
# several independent reviewers are not working in one company
company = 'independent-%s' % uuid.uuid4()
companies.setdefault(company, {'reviewers': 0, 'reviews': 0})
if eng['metric'] >= MIN_REVIEWS or eng['metric'] >= min_percent:
companies[company]['reviews'] += stat['metric']
companies[company]['reviewers'] += 1
return companies
@_memoize
def get_diversity_stats(project):
team_stats = {}
# commits by company
group = "%s-group" % project.lower()
commits = s.get('http://stackalytics.com/api/'
'1.0/stats/companies?metric=commits&release=all'
'&project_type=all&module=%s&start_date=%s'
% (group, six_months)).json()
# reviews by company
reviews = s.get('http://stackalytics.com/api/'
'1.0/stats/companies?metric=marks&release=all'
'&project_type=all&module=%s&start_date=%s'
% (group, six_months)).json()
core_reviews_by_company = get_core_reviews_by_company(group)
commits_total = sum([company['metric'] for company in commits['stats']])
top2 = [
commits['stats'][0]['metric'] if len(commits['stats']) > 0 else 0,
commits['stats'][1]['metric'] if len(commits['stats']) > 1 else 0,
]
team_stats['commits_top'] = (
(float(top2[0]) / commits_total * 100) if commits_total else 0)
team_stats['commits_top2'] = (
(float(sum(top2)) / commits_total * 100) if commits_total else 0)
reviews_total = sum([company['metric'] for company in reviews['stats']])
top2 = [
reviews['stats'][0]['metric'] if len(reviews['stats']) > 0 else 0,
reviews['stats'][1]['metric'] if len(reviews['stats']) > 1 else 0,
]
team_stats['reviews_top'] = (
(float(top2[0]) / reviews_total * 100) if reviews_total else 0)
team_stats['reviews_top2'] = (
(float(sum(top2)) / reviews_total * 100) if reviews_total else 0)
core_review_values = [company['reviews'] for company in
core_reviews_by_company.values()]
if len(core_review_values) == 1:
core_review_values = [core_review_values[0], 0]
core_review_values.sort(reverse=True)
core_reviews_total = sum(core_review_values)
team_stats['core_reviews_top'] = (
(float(core_review_values[0]) / core_reviews_total * 100)
if core_reviews_total else 0)
team_stats['core_reviews_top2'] = (
((float(core_review_values[0]) + float(core_review_values[1])) /
core_reviews_total * 100) if core_reviews_total else 0)
core_reviewers_values = [company['reviewers'] for company in
core_reviews_by_company.values()]
if len(core_reviewers_values) == 1:
core_reviewers_values = [core_reviewers_values[0], 0]
core_reviewers_values.sort(reverse=True)
core_reviewers_total = sum(core_reviewers_values)
team_stats['core_reviewers_top'] = (
(float(core_reviewers_values[0]) / core_reviewers_total * 100)
if core_reviewers_total else 0)
team_stats['core_reviewers_top2'] = (
((float(core_reviewers_values[0]) + float(core_reviewers_values[1])) /
core_reviewers_total * 100) if core_reviewers_total else 0)
return team_stats
def is_diverse(team):
team_stats = get_diversity_stats(team)
diversity = all((
(team_stats['commits_top'] <= 50),
(team_stats['reviews_top'] <= 50),
(team_stats['core_reviews_top'] <= 50),
(team_stats['core_reviewers_top'] <= 50),
(team_stats['commits_top2'] <= 80),
(team_stats['reviews_top2'] <= 80),
(team_stats['core_reviews_top2'] <= 80),
(team_stats['core_reviewers_top2'] <= 80),
))
return diversity
def is_single_vendor(team):
team_stats = get_diversity_stats(team)
multi_vendor = all((
(team_stats['commits_top'] < 90),
(team_stats['reviews_top'] < 90),
(team_stats['core_reviews_top'] < 90),
(team_stats['core_reviewers_top'] < 90),
))
return not multi_vendor
def print_diversity(team):
team_stats = get_diversity_stats(team)
print('%-18s (%.2f%% | %.2f%% | %.2f%% | %.2f%%)' % (
team, team_stats['commits_top'], team_stats['reviews_top'],
team_stats['core_reviews_top'], team_stats['core_reviewers_top']))
print('%-18s (%.2f%% | %.2f%% | %.2f%% | %.2f%%)' % (
'', team_stats['commits_top2'], team_stats['reviews_top2'],
team_stats['core_reviews_top2'], team_stats['core_reviewers_top2']))
def print_team_size(team):
team_stats = get_team_size_stats(team)
print('%-18s (%6s | %6s)' % (
'', team_stats['active_committers'],
team_stats['active_reviewers']))
class ValidateDiversity(base.ValidatorBase):
@staticmethod
def validate(team):
"""Return True of team should have 'team:diverse-affiliation'"""
return is_diverse(team)
@staticmethod
def get_tag_name():
return "team:diverse-affiliation"
class ValidateSingleVendor(base.ValidatorBase):
@staticmethod
def validate(team):
"""Return True of team should have 'team:single-vendor'"""
return is_single_vendor(team)
@staticmethod
def get_tag_name():
return "team:single-vendor"
def main():
filename = os.path.abspath('reference/projects.yaml')
with open(filename, 'r') as f:
projects = [k for k in yaml.safe_load(f.read())]
projects.sort()
print('<Team> (top commit % | top review % | top core review % | '
'top core reviewer %)')
print(' (top 2 commit % | top 2 review % | top 2 core review % | '
'top 2 core reviewer %)')
print(' (active committers | active reviewers)')
for project in projects:
print_diversity(project)
print_team_size(project)
if __name__ == '__main__':
sys.exit(main())