| {{ report.revision }} | {{ report.executable }}@{{ report.environment}} | 9 |{{ report.item_description }} | 10 |
| {{ report.revision }} | {{ report.executable }}@{{ report.environment}} | 23 |{{ report.item_description }} | 24 |
{{ log.body|linebreaksbr|urlize }}
23 | {% endif %}
24 |
2 | {% include 'codespeed/changes_table.html' %}
3 |
4 |
5 |
6 |
7 |
25 |
26 | {% ifnotequal exe.project.repo_type 'N' %}
27 |
28 |
43 | {% endifnotequal %}
44 |
45 |
--------------------------------------------------------------------------------
/codespeed/feeds.py:
--------------------------------------------------------------------------------
1 | from django.contrib.syndication.views import Feed
2 | from codespeed.models import Report
3 | from django.conf import settings
4 | from django.db.models import Q
5 |
6 |
7 | class ResultFeed(Feed):
8 | title = settings.WEBSITE_NAME
9 | link = "/changes/"
10 |
11 | def items(self):
12 | return Report.objects\
13 | .filter(self.result_filter())\
14 | .order_by('-revision__date')[:10]
15 |
16 | def item_title(self, item):
17 | return "%s: %s" % (item.revision.get_short_commitid(),
18 | item.item_description())
19 |
20 | description_template = "codespeed/changes_table.html"
21 |
22 | def get_context_data(self, **kwargs):
23 | report = kwargs['item']
24 | trendconfig = settings.TREND
25 |
26 | tablelist = report.get_changes_table(trendconfig)
27 |
28 | return {
29 | 'tablelist': tablelist,
30 | 'trendconfig': trendconfig,
31 | 'rev': report.revision,
32 | 'exe': report.executable,
33 | 'env': report.environment,
34 | }
35 |
36 |
37 | class LatestEntries(ResultFeed):
38 | description = "Last Results"
39 |
40 | def result_filter(self):
41 | return Q()
42 |
43 |
44 | class LatestSignificantEntries(ResultFeed):
45 | description = "Last results with significant changes"
46 |
47 | def result_filter(self):
48 | return Q(colorcode__in=('red', 'green'))
49 |
--------------------------------------------------------------------------------
/codespeed/validators.py:
--------------------------------------------------------------------------------
1 | from django.core.exceptions import ValidationError
2 |
3 |
4 | def validate_results_request(data):
5 | """
6 | Validates that a result request dictionary has all needed parameters
7 | and their type is correct.
8 |
9 | Throws ValidationError on error.
10 | """
11 | mandatory_data = [
12 | 'env',
13 | 'proj',
14 | 'branch',
15 | 'exe',
16 | 'ben',
17 | ]
18 |
19 | for key in mandatory_data:
20 | if key not in data:
21 | raise ValidationError('Key "' + key +
22 | '" missing from GET request!')
23 | elif data[key] == '':
24 | raise ValidationError('Value for key "' + key +
25 | '" empty in GET request!')
26 |
27 | integer_data = [
28 | 'revs',
29 | 'width',
30 | 'height'
31 | ]
32 |
33 | """
34 | Check that the items in integer_data are the correct format,
35 | if they exist
36 | """
37 | for key in integer_data:
38 | if key in data:
39 | try:
40 | rev_value = int(data[key])
41 | except ValueError:
42 | raise ValidationError('Value for "' + key +
43 | '" is not an integer!')
44 | if rev_value <= 0:
45 | raise ValidationError('Value for "' + key + '" should be a'
46 | ' strictly positive integer!')
47 |
--------------------------------------------------------------------------------
/tools/save_multiple_results.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | ####################################################
3 | # Sample script that shows how to save result data using json #
4 | ####################################################
5 | import urllib
6 | import urllib2
7 | import json
8 |
9 |
10 | # You need to enter the real URL and have the server running
11 | CODESPEED_URL = 'http://localhost:8000/'
12 |
13 | sample_data = [
14 | {
15 | "commitid": "8",
16 | "project": "MyProject",
17 | "branch": "default",
18 | "executable": "myexe O3 64bits",
19 | "benchmark": "float",
20 | "environment": "Dual Core",
21 | "result_value": 2500.0
22 | },
23 | {
24 | "commitid": "8",
25 | "project": "MyProject",
26 | "branch": "default",
27 | "executable": "myexe O3 64bits",
28 | "benchmark": "int",
29 | "environment": "Dual Core",
30 | "result_value": 1100
31 | }
32 | ]
33 |
34 |
35 | def add(data):
36 | #params = urllib.urlencode(data)
37 | response = "None"
38 | try:
39 | f = urllib2.urlopen(
40 | CODESPEED_URL + 'result/add/json/', urllib.urlencode(data))
41 | except urllib2.HTTPError as e:
42 | print str(e)
43 | print e.read()
44 | return
45 | response = f.read()
46 | f.close()
47 | print "Server (%s) response: %s\n" % (CODESPEED_URL, response)
48 |
49 |
50 | if __name__ == "__main__":
51 | data = {'json': json.dumps(sample_data)}
52 | add(data)
53 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | from setuptools import setup, find_packages
2 |
3 | setup(
4 | name='codespeed',
5 | version='0.13.0',
6 | author='Miquel Torres',
7 | author_email='tobami@gmail.com',
8 | url='https://github.com/tobami/codespeed',
9 | download_url="https://github.com/tobami/codespeed/tags",
10 | license='GNU Lesser General Public License version 2.1',
11 | keywords=['benchmarking', 'visualization'],
12 | install_requires=['django>=1.11<2.2', 'isodate>=0.4.7,<0.6', 'matplotlib>=1.4.3,<2.0'],
13 | packages=find_packages(exclude=['ez_setup', 'sample_project']),
14 | setup_requires=['setuptools-markdown'],
15 | long_description_markdown_filename='README.md',
16 | description='A web application to monitor and analyze the performance of your code',
17 | include_package_data=True,
18 | zip_safe=False,
19 | classifiers=[
20 | 'Environment :: Web Environment',
21 | 'Framework :: Django',
22 | 'Intended Audience :: Developers',
23 | 'License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)',
24 | 'Operating System :: OS Independent',
25 | 'Programming Language :: Python',
26 | 'Programming Language :: Python :: 2',
27 | 'Programming Language :: Python :: 2.7',
28 | 'Programming Language :: Python :: 3',
29 | 'Programming Language :: Python :: 3.4',
30 | 'Programming Language :: Python :: 3.5',
31 | 'Programming Language :: Python :: 3.6',
32 | 'Topic :: Internet :: WWW/HTTP :: WSGI :: Application',
33 | ]
34 | )
35 |
--------------------------------------------------------------------------------
/codespeed/static/js/codespeed.js:
--------------------------------------------------------------------------------
1 | function readCheckbox(el) {
2 | /* Builds a string that holds all checked values in an input form */
3 | var config = "";
4 | $(el).each(function() {
5 | config += $(this).val() + ",";
6 | });
7 | // Remove last comma
8 | config = config.slice(0, -1);
9 | return config;
10 | }
11 |
12 | function getLoadText(text, h) {
13 | var loadtext = '| Revision | 12 ||
|---|---|
| Commit | 17 |{% if rev.get_browsing_url %}{{ rev.commitid }}{% else %}{{ rev.commitid }}{% endif %} | 18 |
| Date | {{ rev.date }} |
| Repo | {{ rev.branch.project.repo_path }} |
| Commit logs | 33 ||
|---|---|
| Loading... |
';
14 | var pstyle = "";
15 | if (h > 0) {
16 | h = h - 32;
17 | if(h < 80) { h = 180; }
18 | else if (h > 400) { h = 400; }
19 | pstyle = ' style="line-height:' + h + 'px;"';
20 | }
21 | loadtext += ''+ text;
22 | loadtext += '
';
23 | return loadtext;
24 | }
25 |
26 | $(function() {
27 | // Check all and none links
28 | $('.checkall').each(function() {
29 | var inputs = $(this).parent().children("li").children("input");
30 | $(this).click(function() {
31 | inputs.prop("checked", true);
32 | return false;
33 | });
34 | });
35 |
36 | $('.uncheckall').each(function() {
37 | var inputs = $(this).parent().children("li").children("input");
38 | $(this).click(function() {
39 | inputs.prop("checked", false);
40 | return false;
41 | });
42 | });
43 |
44 | $('.togglefold').each(function() {
45 | var lis = $(this).parent().children("li");
46 | $(this).click(function() {
47 | lis.slideToggle();
48 | return false;
49 | });
50 | });
51 | });
52 |
--------------------------------------------------------------------------------
/codespeed/urls.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | from django.conf.urls import url
3 | from django.views.generic import TemplateView
4 |
5 | from codespeed import views
6 | from codespeed.feeds import LatestEntries, LatestSignificantEntries
7 |
8 | urlpatterns = [
9 | url(r'^$', views.HomeView.as_view(), name='home'),
10 | url(r'^about/$',
11 | TemplateView.as_view(template_name='about.html'), name='about'),
12 | # RSS for reports
13 | url(r'^feeds/latest/$', LatestEntries(), name='latest-results'),
14 | url(r'^feeds/latest_significant/$', LatestSignificantEntries(),
15 | name='latest-significant-results'),
16 | ]
17 |
18 | urlpatterns += [
19 | url(r'^historical/json/$', views.gethistoricaldata, name='gethistoricaldata'),
20 | url(r'^reports/$', views.reports, name='reports'),
21 | url(r'^changes/$', views.changes, name='changes'),
22 | url(r'^changes/table/$', views.getchangestable, name='getchangestable'),
23 | url(r'^changes/logs/$', views.displaylogs, name='displaylogs'),
24 | url(r'^timeline/$', views.timeline, name='timeline'),
25 | url(r'^timeline/json/$', views.gettimelinedata, name='gettimelinedata'),
26 | url(r'^comparison/$', views.comparison, name='comparison'),
27 | url(r'^comparison/json/$', views.getcomparisondata, name='getcomparisondata'),
28 | url(r'^makeimage/$', views.makeimage, name='makeimage'),
29 | ]
30 |
31 | urlpatterns += [
32 | # URLs for adding results
33 | url(r'^result/add/json/$', views.add_json_results, name='add-json-results'),
34 | url(r'^result/add/$', views.add_result, name='add-result'),
35 | ]
36 |
--------------------------------------------------------------------------------
/tools/save_single_result.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | ####################################################
3 | # Sample script that shows how to save result data #
4 | ####################################################
5 | from datetime import datetime
6 | import urllib
7 | import urllib2
8 |
9 | # You need to enter the real URL and have the server running
10 | CODESPEED_URL = 'http://localhost:8000/'
11 |
12 | current_date = datetime.today()
13 |
14 | # Mandatory fields
15 | data = {
16 | 'commitid': '14',
17 | 'branch': 'default', # Always use default for trunk/master/tip
18 | 'project': 'MyProject',
19 | 'executable': 'myexe O3 64bits',
20 | 'benchmark': 'float',
21 | 'environment': "Dual Core",
22 | 'result_value': 4000,
23 | }
24 |
25 | # Optional fields
26 | data.update({
27 | 'revision_date': current_date, # Optional. Default is taken either
28 | # from VCS integration or from current date
29 | 'result_date': current_date, # Optional, default is current date
30 | 'std_dev': 1.11111, # Optional. Default is blank
31 | 'max': 4001.6, # Optional. Default is blank
32 | 'min': 3995.1, # Optional. Default is blank
33 | })
34 |
35 |
36 | def add(data):
37 | params = urllib.urlencode(data)
38 | response = "None"
39 | print "Saving result for executable %s, revision %s, benchmark %s" % (
40 | data['executable'], data['commitid'], data['benchmark'])
41 | try:
42 | f = urllib2.urlopen(CODESPEED_URL + 'result/add/', params)
43 | except urllib2.HTTPError as e:
44 | print str(e)
45 | print e.read()
46 | return
47 | response = f.read()
48 | f.close()
49 | print "Server (%s) response: %s\n" % (CODESPEED_URL, response)
50 |
51 | if __name__ == "__main__":
52 | add(data)
53 |
--------------------------------------------------------------------------------
/tools/migrate_script.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | """Adds the default branch to all existing revisions
3 |
4 | Note: This file is assumed to be in the same directory
5 | as the project settings.py. Otherwise you have to set the
6 | shell environment DJANGO_SETTINGS_MODULE
7 | """
8 | import sys
9 | import os
10 |
11 |
12 | ## Setup to import models from Django app ##
13 | def import_from_string(name):
14 | """helper to import module from a given string"""
15 |
16 | components = name.split('.')[1:]
17 | return reduce(lambda mod, y: getattr(mod, y), components, __import__(name))
18 |
19 | sys.path.append(os.path.abspath('..'))
20 |
21 | if 'DJANGO_SETTINGS_MODULE' in os.environ:
22 | settings = import_from_string(os.environ['DJANGO_SETTINGS_MODULE'])
23 | else:
24 | try:
25 | import settings # Assumed to be in the same directory.
26 | except ImportError:
27 | import sys
28 | sys.stderr.write(
29 | "Error: Can't find the file 'settings.py' in the directory "
30 | "containing %r. It appears you've customized things.\nYou'll have "
31 | "to run django-admin.py, passing it your settings module.\n(If the"
32 | " file settings.py does indeed exist, it's causing an ImportError "
33 | "somehow.)\n" % __file__)
34 | sys.exit(1)
35 |
36 | from django.core.management import setup_environ
37 | setup_environ(settings)
38 |
39 | from codespeed.models import Revision, Branch
40 |
41 |
42 | def main():
43 | """add default branch to revisions"""
44 | branches = Branch.objects.filter(name='default')
45 |
46 | for branch in branches:
47 | for rev in Revision.objects.filter(project=branch.project):
48 | rev.branch = branch
49 | rev.save()
50 |
51 | if __name__ == '__main__':
52 | main()
53 |
--------------------------------------------------------------------------------
/tools/create_trunks.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | """
3 | Create the default branch for all existing projects
4 | Starting v 0.8.0 that is mandatory.
5 |
6 | Note: This file is assumed to be in the same directory
7 | as the project settings.py. Otherwise you have to set the
8 | shell environment DJANGO_SETTINGS_MODULE
9 | """
10 | import sys
11 | import os
12 |
13 |
14 | ## Setup to import models from Django app ##
15 | def import_from_string(name):
16 | """helper to import module from a given string"""
17 | components = name.split('.')[1:]
18 | return reduce(lambda mod, y: getattr(mod, y), components, __import__(name))
19 |
20 |
21 | sys.path.append(os.path.abspath('..'))
22 |
23 |
24 | if 'DJANGO_SETTINGS_MODULE' in os.environ:
25 | settings = import_from_string(os.environ['DJANGO_SETTINGS_MODULE'])
26 | else:
27 | try:
28 | import settings # Assumed to be in the same directory.
29 | except ImportError:
30 | import sys
31 | sys.stderr.write(
32 | "Error: Can't find the file 'settings.py' in the directory "
33 | "containing %r. It appears you've customized things.\nYou'll have "
34 | "to run django-admin.py, passing it your settings module.\n(If the"
35 | " file settings.py does indeed exist, it's causing an ImportError "
36 | "somehow.)\n" % __file__)
37 | sys.exit(1)
38 |
39 | from django.core.management import setup_environ
40 | setup_environ(settings)
41 | from codespeed.models import Branch, Project
42 |
43 |
44 | def main():
45 | """Add Branch default to projects if not there"""
46 | projects = Project.objects.all()
47 |
48 | for proj in projects:
49 | if not proj.branches.filter(name='default'):
50 | trunk = Branch(name='default', project=proj)
51 | trunk.save()
52 | print "Created branch 'default' for project {0}".format(proj)
53 |
54 |
55 | if __name__ == '__main__':
56 | main()
57 |
--------------------------------------------------------------------------------
/tools/test_performance.py:
--------------------------------------------------------------------------------
1 | import timeit
2 | import urllib
3 | import sys
4 |
5 |
6 | SPEEDURL = 'http://localhost:8000/'
7 |
8 | benchmarks = ['ai', 'django', 'spambayes', 'grid']
9 |
10 |
11 | def test_overview():
12 | data = {
13 | "trend": 10,
14 | "baseline": 1,
15 | "revision": 73893,
16 | "executable": "1",
17 | "host": "bigdog",
18 | }
19 | params = urllib.urlencode(data)
20 | page = urllib.urlopen(SPEEDURL + 'overview/table/?' + params)
21 | jsonstring = page.read()
22 | page.close()
23 | if not '
20 | {% endblock logo %}
21 | | Benchmark | 13 |{{ units.units_title }} in {{ units.units }} | 14 | {% if units.has_stddev %}Std dev | {% endif%} 15 | {% if units.hasmin %}Min | {% endif%} 16 | {% if units.hasmax %}Max | {% endif%} 17 |Change | 18 |Trend | 19 |
|---|---|---|---|---|---|---|
| Average | 24 |25 | {% if units.hasmin %} | 26 | {% endif%}{% if units.has_stddev %} | {{ units.totals.min }} | 27 | {% endif%}{% if units.hasmax %}{{ units.totals.max }} | 28 | {% endif%}{{ units.totals.change|percentage }} | 29 |{% ifnotequal units.totals.trend "-" %}{{ units.totals.trend|floatformat:2 }}%{% else %}{{ units.totals.trend }}{% endifnotequal %} | 30 |
| {{ row.bench_name }} | 36 |{{ row.result|floatformat:units.precission }} | 37 | {% if units.has_stddev %}{{ row.std_dev|floatformat:units.precission }} | 38 | {% endif%}{% if units.hasmin %}{{ row.val_min|floatformat:units.precission }} | 39 | {% endif%}{% if units.hasmax %}{{ row.val_max|floatformat:units.precission }} | 40 | {% endif%}{{ row.change|percentage }} | 41 |{% ifequal row.trend "-" %}-{% else %}{{ row.trend|floatformat:2 }}%{% endifequal %} | 42 |
| Executable | 50 ||
|---|---|
| Name | {{ exe }} |
| Description | {{ exe.description }} |
| Environment | 61 ||
|---|---|
| Name | {{ env.name }} |
| CPU | {{ env.cpu }} |
| Memory | {{ env.memory }} |
| OS | {{ env.os }} |
| Kernel | {{ env.kernel }} |
60 |
61 | Permalink
62 |
63 |
64 |
65 |
66 | {% endblock %}
67 |
68 | {% block extra_script %}
69 | {{ block.super }}
70 |
71 |
72 |
92 | {% endblock %}
93 |
--------------------------------------------------------------------------------
/codespeed/auth.py:
--------------------------------------------------------------------------------
1 | import logging
2 | import types
3 | from functools import wraps
4 | from django.contrib.auth import authenticate, login
5 | from django.http import HttpResponse, HttpResponseForbidden
6 | from django.conf import settings
7 | from base64 import b64decode
8 |
9 | __ALL__ = ['basic_auth_required']
10 | logger = logging.getLogger(__name__)
11 |
12 |
13 | def is_authenticated(request):
14 | # NOTE: We do type check so we also support newer versions of Django when
15 | # is_authenticated and some other methods have been properties
16 | if isinstance(request.user.is_authenticated, (types.FunctionType,
17 | types.MethodType)):
18 | return request.user.is_authenticated()
19 | elif isinstance(request.user.is_authenticated, bool):
20 | return request.user.is_authenticated
21 | else:
22 | logger.info('Got unexpected type for request.user.is_authenticated '
23 | 'variable')
24 | return False
25 |
26 |
27 | def basic_auth_required(realm='default'):
28 | def _helper(func):
29 | @wraps(func)
30 | def _decorator(request, *args, **kwargs):
31 | allowed = False
32 | logger.info('request is secure? {}'.format(request.is_secure()))
33 | if settings.ALLOW_ANONYMOUS_POST:
34 | logger.debug('allowing anonymous post')
35 | allowed = True
36 | elif hasattr(request, 'user') and is_authenticated(request=request):
37 | allowed = True
38 | elif 'HTTP_AUTHORIZATION' in request.META:
39 | logger.debug('checking for http authorization header')
40 | if settings.REQUIRE_SECURE_AUTH and not request.is_secure():
41 | return insecure_connection_response()
42 | http_auth = request.META['HTTP_AUTHORIZATION']
43 | authmeth, auth = http_auth.split(' ', 1)
44 | if authmeth.lower() == 'basic':
45 | username, password = decode_basic_auth(auth)
46 | user = authenticate(username=username, password=password)
47 | if user is not None and user.is_active:
48 | logger.info(
49 | 'Authentication succeeded for {}'.format(username))
50 | login(request, user)
51 | allowed = True
52 | else:
53 | logger.info(
54 | 'Failed auth for {}'.format(username))
55 | return HttpResponseForbidden()
56 | if allowed:
57 | return func(request, *args, **kwargs)
58 |
59 | if settings.REQUIRE_SECURE_AUTH and not request.is_secure():
60 | logger.debug('not requesting auth over an insecure channel')
61 | return insecure_connection_response()
62 | else:
63 | res = HttpResponse()
64 | res.status_code = 401
65 | res.reason_phrase = 'Unauthorized'
66 | res['WWW-Authenticate'] = 'Basic realm="{}"'.format(realm)
67 | return res
68 | return _decorator
69 |
70 | return _helper
71 |
72 |
73 | def insecure_connection_response():
74 | return HttpResponseForbidden('Secure connection required')
75 |
76 |
77 | def decode_basic_auth(auth):
78 | authb = b64decode(auth.strip())
79 | auth = authb.decode()
80 | return auth.split(':', 1)
81 |
--------------------------------------------------------------------------------
/codespeed/commits/git.py:
--------------------------------------------------------------------------------
1 | import datetime
2 | import logging
3 | import os
4 |
5 | from subprocess import Popen, PIPE
6 | from django.conf import settings
7 | from .exceptions import CommitLogError
8 |
9 | logger = logging.getLogger(__name__)
10 |
11 |
12 | def execute_command(cmd, cwd):
13 | p = Popen(cmd, stdout=PIPE, stderr=PIPE, cwd=cwd)
14 | stdout, stderr = p.communicate()
15 | stdout = stdout.decode('utf8') if stdout is not None else stdout
16 | stderr = stderr.decode('utf8') if stderr is not None else stderr
17 | return (p, stdout, stderr)
18 |
19 |
20 | def updaterepo(project, update=True):
21 | if os.path.exists(project.working_copy):
22 | if not update:
23 | return
24 |
25 | p, _, stderr = execute_command(['git', 'pull'], cwd=project.working_copy)
26 |
27 | if p.returncode != 0:
28 | raise CommitLogError("git pull returned %s: %s" % (p.returncode,
29 | stderr))
30 | else:
31 | return [{'error': False}]
32 | else:
33 | cmd = ['git', 'clone', project.repo_path, project.repo_name]
34 | p, stdout, stderr = execute_command(cmd, settings.REPOSITORY_BASE_PATH)
35 | logger.debug('Cloning Git repo {0} for project {1}'.format(
36 | project.repo_path, project))
37 |
38 | if p.returncode != 0:
39 | raise CommitLogError("%s returned %s: %s" % (
40 | " ".join(cmd), p.returncode, stderr))
41 | else:
42 | return [{'error': False}]
43 |
44 |
45 | def getlogs(endrev, startrev):
46 | updaterepo(endrev.branch.project, update=False)
47 |
48 | # NULL separated values delimited by 0x1e record separators
49 | # See PRETTY FORMATS in git-log(1):
50 | if hasattr(settings, 'GIT_USE_COMMIT_DATE') and settings.GIT_USE_COMMIT_DATE:
51 | logfmt = '--format=format:%h%x00%H%x00%ct%x00%an%x00%ae%x00%s%x00%b%x1e'
52 | else:
53 | logfmt = '--format=format:%h%x00%H%x00%at%x00%an%x00%ae%x00%s%x00%b%x1e'
54 |
55 | cmd = ["git", "log", logfmt]
56 |
57 | if endrev.commitid != startrev.commitid:
58 | cmd.append("%s...%s" % (startrev.commitid, endrev.commitid))
59 | else:
60 | cmd.append("-1") # Only return one commit
61 | cmd.append(endrev.commitid)
62 |
63 | working_copy = endrev.branch.project.working_copy
64 | p, stdout, stderr = execute_command(cmd, working_copy)
65 |
66 | if p.returncode != 0:
67 | raise CommitLogError("%s returned %s: %s" % (
68 | " ".join(cmd), p.returncode, stderr))
69 | logs = []
70 | for log in filter(None, stdout.split('\x1e')):
71 | (short_commit_id, commit_id, date_t, author_name, author_email,
72 | subject, body) = map(lambda s: s.strip(), log.split('\x00', 7))
73 |
74 | cmd = ["git", "tag", "--points-at", commit_id]
75 |
76 | try:
77 | p, stdout, stderr = execute_command(cmd, working_copy)
78 | except Exception:
79 | logger.debug('Failed to get tag', exc_info=True)
80 |
81 | tag = stdout.strip() if p.returncode == 0 else ""
82 | date = datetime.datetime.fromtimestamp(
83 | int(date_t)).strftime("%Y-%m-%d %H:%M:%S")
84 |
85 | logs.append({
86 | 'date': date,
87 | 'message': subject,
88 | 'commitid': commit_id,
89 | 'author': author_name,
90 | 'author_email': author_email,
91 | 'body': body,
92 | 'short_commit_id': short_commit_id,
93 | 'tag': tag
94 | })
95 |
96 | return logs
97 |
--------------------------------------------------------------------------------
/documentation/intro.wiki:
--------------------------------------------------------------------------------
1 | = Introduction to Codespeed =
2 |
3 | == Concepts in Codespeed ==
4 |
5 | === Projects, revisions, branches and tags ===
6 |
7 | A **project** is a software project that has a version control repository. Within that repository will be multiple **branch**es, each of which contains a sequence of **revision**s.
8 |
9 | An **executable** is a compilation of a **project**, which benchmarks are run against. The concept of executables historically comes from testing multiple implementations of Python - CPython, PyPy, etc. In that context, there were multiple executables that had been compiled from different projects (cpython/pypy), with different versions (cpython 2.6.2, pypy 1.3, 1.4, 1.5, latest) and different compilation options (cpython can optionally use psyco-profile, pypy can optionally use a jit). Each of these executables were meant to be interchangeable...
10 |
11 | Certain **revision**s can optionally be given a **tag**. They then make the results from the executables of their project available as baselines to compare other results against on the timeline and comparison screens.
12 |
13 | === Benchmarks ===
14 |
15 | A **benchmark** is a particular test that returns a metric on performance. The benchmark specifies the units of that metric, and whether //less is better// (e.g. for time, a lower number of seconds is usually optimal), or not (e.g. for throughput). Benchmarks come in two kinds: //cross-project// and //own-project//. Only cross-project benchmarks are shown on the comparison screen.
16 |
17 | === Environment ===
18 |
19 | An **environment** is a particular context in which tests are executed - a machine with a given CPU, operating system, and speed. Recording this is significant to ensure that comparison between results is meaningful.
20 |
21 | === Results ===
22 |
23 | The **result**s of running a particular **benchmark** in a particular **environment**, on an **executable** compiled from a particular **revision** of a **project**, are uploaded to the server. Each **result** must have a //value//, and can optionally also have a //minimum//, //maximum//, and //standard deviation//.
24 |
25 | **Result**s are grouped into **report**s that cover all the benchmarks on a particular revision and executable.
26 |
27 | == Screens ==
28 |
29 | === Changes ===
30 |
31 | This screen can be used to monitor the detailed impact a set of revisions has on the benchmark results, as well as browsing those results.
32 |
33 | Only projects that are configured to //track changes// can be selected. Any executable from those projects can be chosen, and a list of recent revisions with benchmark results is presented for selection.
34 |
35 | The benchmark results are presented along with the change from the previous set of results, revision info and the commit logs since the previous revision
36 |
37 | === Timeline ===
38 |
39 | This shows how benchmark results have varied over time. Only results from the default project are shown, but they can be normalized against any of the valid tagged baseline revisions from any project.
40 |
41 | === Comparison ===
42 |
43 | This compares results across executables (and therefore projects). Possible executables are the latest version on each branch of each project (including the default), plus any tagged baseline revisions.
44 |
45 | Benchmarks are grouped by units. Only benchmarks marked as //cross-project// are shown.
46 |
47 | Users can select a subset of executables, benchmarks and environments from those available. There are also some useful statistical options to normalize against a particular executable (including the latest) as baseline, and display the charts as stacked bars or relative bars.
48 |
49 |
--------------------------------------------------------------------------------
/codespeed/commits/mercurial.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | from __future__ import absolute_import
3 |
4 | import os
5 | import datetime
6 | from subprocess import Popen, PIPE
7 | import logging
8 |
9 | from django.conf import settings
10 |
11 | from .exceptions import CommitLogError
12 |
13 | logger = logging.getLogger(__name__)
14 |
15 |
16 | def updaterepo(project, update=True):
17 | if os.path.exists(project.working_copy):
18 | if not update:
19 | return
20 |
21 | p = Popen(['hg', 'pull', '-u'], stdout=PIPE, stderr=PIPE,
22 | cwd=project.working_copy)
23 | stdout, stderr = p.communicate()
24 |
25 | if p.returncode != 0 or stderr:
26 | raise CommitLogError("hg pull returned %s: %s" % (p.returncode,
27 | stderr))
28 | else:
29 | return [{'error': False}]
30 | else:
31 | # Clone repo
32 | cmd = ['hg', 'clone', project.repo_path, project.repo_name]
33 |
34 | p = Popen(cmd, stdout=PIPE, stderr=PIPE,
35 | cwd=settings.REPOSITORY_BASE_PATH)
36 | logger.debug('Cloning Mercurial repo {0} for project {1}'.format(
37 | project.repo_path, project))
38 | stdout, stderr = p.communicate()
39 |
40 | if p.returncode != 0:
41 | raise CommitLogError("%s returned %s: %s" % (" ".join(cmd),
42 | p.returncode,
43 | stderr))
44 | else:
45 | return [{'error': False}]
46 |
47 |
48 | def getlogs(endrev, startrev):
49 | updaterepo(endrev.branch.project, update=False)
50 |
51 | cmd = [
52 | "hg", "log",
53 | "-r", "%s::%s" % (startrev.commitid, endrev.commitid),
54 | "--template",
55 | ("{rev}:{node|short}\n{node}\n{author|user}\n{author|email}"
56 | "\n{date}\n{tags}\n{desc}\n=newlog=\n")
57 | ]
58 |
59 | working_copy = endrev.branch.project.working_copy
60 | p = Popen(cmd, stdout=PIPE, stderr=PIPE, cwd=working_copy)
61 | stdout, stderr = p.communicate()
62 |
63 | if p.returncode != 0:
64 | raise CommitLogError(str(stderr))
65 | else:
66 | stdout = stdout.rstrip('\n') # Remove last newline
67 | logs = []
68 | for log in stdout.split("=newlog=\n"):
69 | elements = []
70 | elements = log.split('\n')[:-1]
71 | if len(elements) < 7:
72 | # "Malformed" log
73 | logs.append({
74 | 'date': '-', 'message': 'error parsing log', 'commitid': '-'})
75 | else:
76 | short_commit_id = elements.pop(0)
77 | commit_id = elements.pop(0)
78 | author_name = elements.pop(0)
79 | author_email = elements.pop(0)
80 | date = elements.pop(0)
81 | tag = elements.pop(0)
82 | tag = "" if tag == "tip" else tag
83 | # All other newlines should belong to the description text. Join.
84 | message = '\n'.join(elements)
85 |
86 | # Parse date
87 | date = date.split('-')[0]
88 | date = datetime.datetime.fromtimestamp(
89 | float(date)).strftime("%Y-%m-%d %H:%M:%S")
90 |
91 | # Add changeset info
92 | logs.append({
93 | 'date': date,
94 | 'author': author_name,
95 | 'author_email': author_email,
96 | 'message': message,
97 | 'short_commit_id': short_commit_id,
98 | 'commitid': commit_id,
99 | 'tag': tag
100 | })
101 | # Remove last log here because mercurial saves the short hast as commitid now
102 | if len(logs) > 1 and logs[-1].get('short_commit_id') == startrev.commitid:
103 | logs.pop()
104 | return logs
105 |
--------------------------------------------------------------------------------
/sample_project/client.py:
--------------------------------------------------------------------------------
1 | # encoding: utf-8
2 |
3 | from urlparse import urljoin
4 | import logging
5 | import platform
6 | import urllib
7 | import sys
8 |
9 |
10 | def save_to_speedcenter(url=None, project=None, commitid=None, executable=None,
11 | benchmark=None, result_value=None, **kwargs):
12 | """Save a benchmark result to your speedcenter server
13 |
14 | Mandatory:
15 |
16 | :param url:
17 | Codespeed server endpoint
18 | (e.g. `http://codespeed.example.org/result/add/`)
19 | :param project:
20 | Project name
21 | :param commitid:
22 | VCS identifier
23 | :param executable:
24 | The executable name
25 | :param benchmark:
26 | The name of this particular benchmark
27 | :param float result_value:
28 | The benchmark result
29 |
30 | Optional:
31 |
32 | :param environment:
33 | System description
34 | :param date revision_date:
35 | Optional, default will be either VCS commit, if available, or the
36 | current date
37 | :param date result_date:
38 | Optional
39 | :param float std_dev:
40 | Optional
41 | :param float max:
42 | Optional
43 | :param float min:
44 | Optional
45 | """
46 |
47 | data = {
48 | 'project': project,
49 | 'commitid': commitid,
50 | 'executable': executable,
51 | 'benchmark': benchmark,
52 | 'result_value': result_value,
53 | }
54 |
55 | data.update(kwargs)
56 |
57 | if not data.get('environment', None):
58 | data['environment'] = platform.platform(aliased=True)
59 |
60 | f = urllib.urlopen(url, urllib.urlencode(data))
61 |
62 | response = f.read()
63 | status = f.getcode()
64 |
65 | f.close()
66 |
67 | if status == 202:
68 | logging.debug("Server %s: HTTP %s: %s", url, status, response)
69 | else:
70 | raise IOError("Server %s returned HTTP %s" % (url, status))
71 |
72 |
73 | if __name__ == "__main__":
74 | from optparse import OptionParser
75 |
76 | parser = OptionParser()
77 | parser.add_option("--benchmark")
78 | parser.add_option("--commitid")
79 | parser.add_option("--environment",
80 | help="Use a custom Codespeed environment")
81 | parser.add_option("--executable")
82 | parser.add_option("--max", type="float")
83 | parser.add_option("--min", type="float")
84 | parser.add_option("--project")
85 | parser.add_option("--branch")
86 | parser.add_option("--result-date")
87 | parser.add_option("--result-value", type="float")
88 | parser.add_option("--revision_date")
89 | parser.add_option("--std-dev", type="float")
90 | parser.add_option("--url",
91 | help="URL of your Codespeed server (e.g. http://codespeed.example.org)")
92 |
93 | (options, args) = parser.parse_args()
94 |
95 | if args:
96 | parser.error("All arguments must be provided as command-line options")
97 |
98 | # Yes, the optparse manpage has a snide comment about "required options"
99 | # being gramatically dubious. Yes, it's still wrong about not needing to
100 | # do this.
101 | required = ('url', 'environment', 'project', 'commitid', 'executable',
102 | 'benchmark', 'result_value')
103 |
104 | if not all(getattr(options, i) for i in required):
105 | parser.error("The following parameters must be provided:\n\t%s" % "\n\t".join(
106 | "--%s".replace("_", "-") % i for i in required))
107 |
108 | kwargs = {}
109 | for k, v in options.__dict__.items():
110 | if v is not None:
111 | kwargs[k] = v
112 | kwargs.setdefault('branch', 'default')
113 |
114 | if not kwargs['url'].endswith("/result/add/"):
115 | kwargs['url'] = urljoin(kwargs['url'], '/result/add/')
116 |
117 | try:
118 | save_to_speedcenter(**kwargs)
119 | sys.exit(0)
120 | except StandardError as e:
121 | logging.error("Error saving results: %s", e)
122 | sys.exit(1)
123 |
--------------------------------------------------------------------------------
/codespeed/static/js/jqplot/jqplot.pointLabels.min.js:
--------------------------------------------------------------------------------
1 | !function(t){t.jqplot.PointLabels=function(e){this.show=t.jqplot.config.enablePlugins,this.location="n",this.labelsFromSeries=!1,this.seriesLabelIndex=null,this.labels=[],this._labels=[],this.stackedValue=!1,this.ypadding=6,this.xpadding=6,this.escapeHTML=!0,this.edgeTolerance=-5,this.formatter=t.jqplot.DefaultTickFormatter,this.formatString="",this.hideZeros=!1,this._elems=[],t.extend(!0,this,e)};var e={nw:0,n:1,ne:2,e:3,se:4,s:5,sw:6,w:7},s=["se","s","sw","w","nw","n","ne","e"];t.jqplot.PointLabels.init=function(e,s,i,a,l){var r=t.extend(!0,{},i,a);r.pointLabels=r.pointLabels||{},this.renderer.constructor!==t.jqplot.BarRenderer||"horizontal"!==this.barDirection||r.pointLabels.location||(r.pointLabels.location="e"),this.plugins.pointLabels=new t.jqplot.PointLabels(r.pointLabels),this.plugins.pointLabels.setLabels.call(this)},t.jqplot.PointLabels.prototype.setLabels=function(){var e,s=this.plugins.pointLabels;if(e=null!=s.seriesLabelIndex?s.seriesLabelIndex:this.renderer.constructor===t.jqplot.BarRenderer&&"horizontal"===this.barDirection?this._plotData[0].length<3?0:this._plotData[0].length-1:0===this._plotData.length?0:this._plotData[0].length-1,s._labels=[],0===s.labels.length||s.labelsFromSeries)if(s.stackedValue){if(this._plotData.length&&this._plotData[0].length)for(var i=0;i
59 |
64 |
72 |
76 | Permalink
77 |
78 |
79 |
80 |
81 | {% endblock %}
82 |
83 | {% block extra_script %}
84 | {{ block.super }}
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
107 | {% endblock %}
108 |
--------------------------------------------------------------------------------
/codespeed/tests/test_auth.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | import mock
4 |
5 | from django.test import TestCase, override_settings
6 | from django.http import HttpResponse
7 | from django.contrib.auth.models import AnonymousUser
8 | from django.test import RequestFactory
9 |
10 | from codespeed.auth import basic_auth_required
11 | from codespeed.views import add_result
12 |
13 |
14 | @override_settings(ALLOW_ANONYMOUS_POST=False)
15 | class AuthModuleTestCase(TestCase):
16 | @override_settings(ALLOW_ANONYMOUS_POST=True)
17 | def test_allow_anonymous_post_is_true(self):
18 | wrapped_function = mock.Mock()
19 | wrapped_function.__name__ = 'mock'
20 | wrapped_function.return_value = 'success'
21 |
22 | request = mock.Mock()
23 | request.user = AnonymousUser()
24 | request.META = {}
25 |
26 | res = basic_auth_required()(wrapped_function)(request=request)
27 | self.assertEqual(wrapped_function.call_count, 1)
28 | self.assertEqual(res, 'success')
29 |
30 | def test_basic_auth_required_django_pre_2_0_succesful_auth(self):
31 | # request.user.is_authenticated is a method (pre Django 2.0)
32 | user = mock.Mock()
33 | user.is_authenticated = lambda: True
34 |
35 | request = mock.Mock()
36 | request.user = user
37 |
38 | wrapped_function = mock.Mock()
39 | wrapped_function.__name__ = 'mock'
40 | wrapped_function.return_value = 'success'
41 |
42 | res = basic_auth_required()(wrapped_function)(request=request)
43 | self.assertEqual(wrapped_function.call_count, 1)
44 | self.assertEqual(res, 'success')
45 |
46 | def test_basic_auth_required_django_pre_2_0_failed_auth(self):
47 | # request.user.is_authenticated is a method (pre Django 2.0)
48 | user = mock.Mock()
49 | user.is_authenticated = lambda: False
50 |
51 | request = mock.Mock()
52 | request.user = user
53 | request.META = {}
54 |
55 | wrapped_function = mock.Mock()
56 | wrapped_function.__name__ = 'mock'
57 |
58 | res = basic_auth_required()(wrapped_function)(request=request)
59 | self.assertTrue(isinstance(res, HttpResponse))
60 | self.assertEqual(res.status_code, 401)
61 | self.assertEqual(wrapped_function.call_count, 0)
62 |
63 | # Also test with actual AnonymousUser class which will have different
64 | # implementation under different Django versions
65 | request.user = AnonymousUser()
66 |
67 | res = basic_auth_required()(wrapped_function)(request=request)
68 | self.assertTrue(isinstance(res, HttpResponse))
69 | self.assertEqual(res.status_code, 401)
70 | self.assertEqual(wrapped_function.call_count, 0)
71 |
72 | def test_basic_auth_required_django_post_2_0_successful_auth(self):
73 | # request.user.is_authenticated is a property (post Django 2.0)
74 | user = mock.Mock()
75 | user.is_authenticated = True
76 |
77 | request = mock.Mock()
78 | request.user = user
79 |
80 | wrapped_function = mock.Mock()
81 | wrapped_function.__name__ = 'mock'
82 | wrapped_function.return_value = 'success'
83 |
84 | res = basic_auth_required()(wrapped_function)(request=request)
85 | self.assertEqual(wrapped_function.call_count, 1)
86 | self.assertEqual(res, 'success')
87 |
88 | def test_basic_auth_required_django_post_2_0_failed_auth(self):
89 | # request.user.is_authenticated is a property (post Django 2.0)
90 | user = mock.Mock()
91 | user.is_authenticated = False
92 |
93 | request = mock.Mock()
94 | request.user = user
95 | request.META = {}
96 |
97 | wrapped_function = mock.Mock()
98 | wrapped_function.__name__ = 'mock'
99 |
100 | res = basic_auth_required()(wrapped_function)(request=request)
101 | self.assertTrue(isinstance(res, HttpResponse))
102 | self.assertEqual(res.status_code, 401)
103 | self.assertEqual(wrapped_function.call_count, 0)
104 |
105 | # Also test with actual AnonymousUser class which will have different
106 | # implementation under different Django versions
107 | request.user = AnonymousUser()
108 |
109 | res = basic_auth_required()(wrapped_function)(request=request)
110 | self.assertTrue(isinstance(res, HttpResponse))
111 | self.assertEqual(res.status_code, 401)
112 | self.assertEqual(wrapped_function.call_count, 0)
113 |
114 | @mock.patch('codespeed.views.save_result', mock.Mock())
115 | def test_basic_auth_with_failed_auth_request_factory(self):
116 | request_factory = RequestFactory()
117 |
118 | request = request_factory.get('/timeline')
119 | request.user = AnonymousUser()
120 | request.method = 'POST'
121 |
122 | response = add_result(request)
123 | self.assertEqual(response.status_code, 403)
124 |
125 | @mock.patch('codespeed.views.create_report_if_enough_data', mock.Mock())
126 | @mock.patch('codespeed.views.save_result', mock.Mock(return_value=([1, 2, 3], None)))
127 | def test_basic_auth_successefull_auth_request_factory(self):
128 | request_factory = RequestFactory()
129 |
130 | user = mock.Mock()
131 | user.is_authenticated = True
132 |
133 | request = request_factory.get('/result/add')
134 | request.user = user
135 | request.method = 'POST'
136 |
137 | response = add_result(request)
138 | self.assertEqual(response.status_code, 202)
139 |
--------------------------------------------------------------------------------
/codespeed/results.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | from __future__ import absolute_import
3 |
4 | import logging
5 | from datetime import datetime
6 |
7 | from django.core.exceptions import ValidationError
8 |
9 | from .models import (Environment, Project, Branch, Benchmark, Executable,
10 | Revision, Result, Report)
11 | from . import commits
12 |
13 | logger = logging.getLogger(__name__)
14 |
15 |
16 | def validate_result(item):
17 | """
18 | Validates that a result dictionary has all needed parameters
19 |
20 | It returns a tuple
21 | Environment, False when no errors where found
22 | Errormessage, True when there is an error
23 | """
24 | mandatory_data = [
25 | 'commitid',
26 | 'branch',
27 | 'project',
28 | 'executable',
29 | 'benchmark',
30 | 'environment',
31 | 'result_value',
32 | ]
33 |
34 | error = True
35 | for key in mandatory_data:
36 | if key not in item:
37 | return 'Key "' + key + '" missing from request', error
38 | elif key in item and item[key] == "":
39 | return 'Value for key "' + key + '" empty in request', error
40 |
41 | # Check that the Environment exists
42 | try:
43 | e = Environment.objects.get(name=item['environment'])
44 | error = False
45 | return e, error
46 | except Environment.DoesNotExist:
47 | return "Environment %(environment)s not found" % item, error
48 |
49 |
50 | def save_result(data, update_repo=True):
51 | res, error = validate_result(data)
52 | if error:
53 | return res, True
54 | else:
55 | assert(isinstance(res, Environment))
56 | env = res
57 |
58 | p, created = Project.objects.get_or_create(name=data["project"])
59 | branch, created = Branch.objects.get_or_create(name=data["branch"],
60 | project=p)
61 | b, created = Benchmark.objects.get_or_create(name=data["benchmark"])
62 |
63 | if created:
64 | if "description" in data:
65 | b.description = data["description"]
66 | if "units" in data:
67 | b.units = data["units"]
68 | if "units_title" in data:
69 | b.units_title = data["units_title"]
70 | if "lessisbetter" in data:
71 | b.lessisbetter = data["lessisbetter"]
72 | b.full_clean()
73 | b.save()
74 |
75 | try:
76 | rev = branch.revisions.get(commitid=data['commitid'])
77 | except Revision.DoesNotExist:
78 | rev_date = data.get("revision_date")
79 | # "None" (as string) can happen when we urlencode the POST data
80 | if not rev_date or rev_date in ["", "None"]:
81 | rev_date = datetime.today()
82 | rev = Revision(branch=branch, project=p, commitid=data['commitid'],
83 | date=rev_date)
84 | try:
85 | rev.full_clean()
86 | except ValidationError as e:
87 | return str(e), True
88 | if p.repo_type not in ("N", ""):
89 | try:
90 | commit_logs = commits.get_logs(rev, rev, update=update_repo)
91 | except commits.exceptions.CommitLogError as e:
92 | logger.warning("unable to save revision %s info: %s", rev, e,
93 | exc_info=True)
94 | else:
95 | if commit_logs:
96 | log = commit_logs[0]
97 | rev.author = log['author']
98 | rev.date = log['date']
99 | rev.message = log['message']
100 | rev.tag = log['tag']
101 |
102 | rev.save()
103 |
104 | exe, created = Executable.objects.get_or_create(
105 | name=data['executable'],
106 | project=p
107 | )
108 |
109 | try:
110 | r = Result.objects.get(
111 | revision=rev, executable=exe, benchmark=b, environment=env)
112 | except Result.DoesNotExist:
113 | r = Result(revision=rev, executable=exe, benchmark=b, environment=env)
114 |
115 | r.value = data["result_value"]
116 | if 'result_date' in data:
117 | r.date = data["result_date"]
118 | elif rev.date:
119 | r.date = rev.date
120 | else:
121 | r.date = datetime.now()
122 |
123 | r.std_dev = data.get('std_dev')
124 | r.val_min = data.get('min')
125 | r.val_max = data.get('max')
126 | r.q1 = data.get('q1')
127 | r.q3 = data.get('q3')
128 |
129 | r.full_clean()
130 | r.save()
131 |
132 | return (rev, exe, env), False
133 |
134 |
135 | def create_report_if_enough_data(rev, exe, e):
136 | """Triggers Report creation when there are enough results"""
137 | if exe.project.track is not True:
138 | return False
139 |
140 | last_revs = Revision.objects.filter(
141 | branch=rev.branch
142 | ).order_by('-date')[:2]
143 | if len(last_revs) > 1:
144 | current_results = rev.results.filter(executable=exe, environment=e)
145 | last_results = last_revs[1].results.filter(
146 | executable=exe, environment=e)
147 | # If there is are at least as many results as in the last revision,
148 | # create new report
149 | if len(current_results) >= len(last_results):
150 | logger.debug("create_report_if_enough_data: About to create new report")
151 | report, created = Report.objects.get_or_create(
152 | executable=exe, environment=e, revision=rev
153 | )
154 | report.full_clean()
155 | report.save()
156 | logger.debug("Created new report for branch %s and revision %s",
157 | rev.branch, rev.commitid)
158 |
--------------------------------------------------------------------------------
/codespeed/settings.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | """Default settings for Codespeed"""
3 |
4 | ## General default options ##
5 | WEBSITE_NAME = "MySpeedSite" # This name will be used in the reports RSS feed
6 |
7 | DEF_ENVIRONMENT = None # Name of the environment which should be selected as default
8 |
9 | DEF_BASELINE = None # Which executable + revision should be default as a baseline
10 | # Given as the name of the executable and commitid of the revision
11 | # Example: DEF_BASELINE = {'executable': 'baseExe', 'revision': '444'}
12 |
13 | TREND = 10 # Default value for the depth of the trend
14 | # Used by reports for the latest runs and changes view
15 |
16 | # Threshold that determines when a performance change over the last result is significant
17 | CHANGE_THRESHOLD = 3.0
18 |
19 | # Threshold that determines when a performance change
20 | # over a number of revisions is significant
21 | TREND_THRESHOLD = 5.0
22 |
23 | ## Home view options ##
24 | SHOW_REPORTS = True # Show report tables
25 | SHOW_HISTORICAL = False # Show historical graphs
26 |
27 | ## Changes view options ##
28 | DEF_EXECUTABLE = None # Executable that should be chosen as default in the changes view
29 | # Given as the name of the executable.
30 | # Example: DEF_EXECUTABLE = "myexe O3 64bits"
31 |
32 | SHOW_AUTHOR_EMAIL_ADDRESS = True # Whether to show the authors email address in the
33 | # changes log
34 |
35 | ## Timeline view options ##
36 | DEF_BENCHMARK = None # Default selected benchmark. Possible values:
37 | # None: will show a grid of plot thumbnails, or a
38 | # text message when the number of plots exceeds 30
39 | # "grid": will always show as default the grid of plots
40 | # "show_none": will show a text message (better
41 | # default when there are lots of benchmarks)
42 | # "mybench": will select benchmark named "mybench"
43 |
44 | DEF_TIMELINE_LIMIT = 50 # Default number of revisions to be plotted
45 | # Possible values 10,50,200,1000
46 |
47 | TIMELINE_GRID_LIMIT = 30 # Number of benchmarks beyond which the timeline view
48 | # is disabled as default setting. Too many benchmarks make
49 | # the view slow, and put load on the database, which may be
50 | # undeseriable.
51 |
52 | TIMELINE_GRID_PAGING = 4 # Number of benchmarks to be send in one grid request
53 | # May be adjusted to improve the performance of the timeline grid view.
54 | # If a large number of benchmarks is in the system,
55 | # and the database is not fast, it can take a long time
56 | # to send all results.
57 |
58 | #TIMELINE_BRANCHES = True # NOTE: Only the default branch is currently shown
59 | # Get timeline results for specific branches
60 | # Set to False if you want timeline plots and results only for trunk.
61 |
62 | ## Comparison view options ##
63 | CHART_TYPE = 'normal bars' # The options are 'normal bars', 'stacked bars' and 'relative bars'
64 |
65 | NORMALIZATION = False # True will enable normalization as the default selection
66 | # in the Comparison view. The default normalization can be
67 | # chosen in the defaultbaseline setting
68 |
69 | CHART_ORIENTATION = 'vertical' # 'vertical' or 'horizontal can be chosen as
70 | # default chart orientation
71 |
72 | COMP_EXECUTABLES = None # Which executable + revision should be checked as default
73 | # Given as a list of tuples containing the
74 | # name of an executable + commitid of a revision
75 | # An 'L' denotes the last revision
76 | # Example:
77 | # COMP_EXECUTABLES = [
78 | # ('myexe', '21df2423ra'),
79 | # ('myexe', 'L'),]
80 |
81 | COMPARISON_COMMIT_TAGS = None # List of tag names which should be included in the executables list
82 | # on the comparision page.
83 | # This comes handy where project contains a lot of tags, but you only want
84 | # to list subset of them on the comparison page.
85 | # If this value is set to None (default value), all the available tags will
86 | # be included.
87 |
88 | TIMELINE_EXECUTABLE_NAME_MAX_LEN = 22 # Maximum length of the executable name used in the
89 | # Changes and Timeline view. If the name is longer, the name
90 | # will be truncated and "..." will be added at the end.
91 |
92 | COMPARISON_EXECUTABLE_NAME_MAX_LEN = 20 # Maximum length of the executable name used in the
93 | # Coomparison view. If the name is longer, the name
94 |
95 | USE_MEDIAN_BANDS = True # True to enable median bands on Timeline view
96 |
97 |
98 | ALLOW_ANONYMOUS_POST = True # Whether anonymous users can post results
99 | REQUIRE_SECURE_AUTH = True # Whether auth needs to be over a secure channel
100 |
101 | US_TZ_AWARE_DATES = False # True to use timezone aware datetime objects with Github provider.
102 | # NOTE: Some database backends may not support tz aware dates.
103 |
104 | GITHUB_OAUTH_TOKEN = None # Github oAuth token to use when using Github repo type. If not
105 | # specified, it will utilize unauthenticated requests which have
106 | # low rate limits.
107 |
--------------------------------------------------------------------------------
/sample_project/README.md:
--------------------------------------------------------------------------------
1 | # Codespeed Example instance
2 |
3 | Codespeed uses the Web framework [Django](http://djangoproject.com/). To get a
4 | Codespeed instance running you need to set up a Django Project. This directory
5 | is just such a project for your reference and a jump start to create your own.
6 |
7 | ## For the impatient
8 |
9 | Warning: It is recommended to use [virtualenv](http://pypi.python.org/pypi/virtualenv) to avoid installing
10 | stuff on the root path of your operating system.
11 | However, it works also this way and might be desired in production
12 | environments.
13 |
14 | ### Testing with the built-in Development Server
15 | That will give you *just* the Django development server version. Please
16 | refer to *Installing for Production* for serious installations.
17 |
18 | It is assumed you are in the root directory of the Codespeed software.
19 |
20 | 1. Install the Python pip module
21 | `which pip >/dev/null || easy_install pip`
22 | (You might be required to use sudo)
23 | 2. You *must* copy the `sample_project` directory to your project. (Prevents updates on
24 | git tracked files in the future.) Let's call it speedcenter
25 | `cp -r sample_project speedcenter`
26 | 3a. (When configuring your own project) `pip install codespeeed`
27 | 3b. (For Codespeed development) Install Django and other dependencies using pip
28 | `pip install -r requirements.txt`. This will not install codespeed itself, as we want runserver to only "see" the local codespeed copy
29 | 4. Add codespeed to your Python path
30 | Either
31 | `export PYTHONPATH=../:$PYTHONPATH`
32 | or
33 | `ln -s ./codespeed ./sample_project`
34 | 5. Apply the migrations:
35 | `python manage.py migrate`
36 | Optionally, you may want to load the fixture data for a try
37 | `python manage.py loaddata ./codespeed/fixtures/testdata.json`
38 | 6. Finally, start the Django development server.
39 | `python manage.py runserver`
40 | 7. Enjoy.
41 | `python -m webbrowser -n http://localhost:8000`
42 |
43 | ## Installing for production
44 | There are many choices to get Django Web apps served. It all depends on
45 | your preferences and existing set up. Two options are shown. Please do
46 | not hesitate to consult a search engine to tune your set-up.
47 |
48 | ### NGINX + GUNICORN: Easy as manage.py runserver
49 | Assumed you have a [Debian](http://www.debian.org) like system.
50 |
51 | 1. Follow the steps from the development server set-up up to the the 6th step (database init).
52 | 2. Install [nginx](http://nginx.net/) and [gunicorn](http://gunicorn.org/)
53 | `sudo apt-get install nginx gunicorn`
54 | 3. Tune /etc/nginx/sites-enabled/default to match
55 | deploy/nginx.default-site.conf
56 | (Hint: See diff /etc/nginx/sites-enabled/default deploy/nginx.default-site.conf
57 | for changes)
58 | Note, the sitestatic dir needs to point to your speedcenter/sitestatic dir!
59 | 4. Restart nginx
60 | /etc/init.d/nginx restart`
61 | 5. Prepare static files
62 | `cd /path/to/speedcenter/`
63 | `python ./manage.py collectstatic`
64 | 6. Add 'gunicorn' to your INSTALLED_APPS in settings.py
65 | INSTALLED_APPS = (
66 | 'django.contrib.auth',
67 | [...]
68 | 'south',
69 | 'gunicorn'
70 | )
71 | 6. Run speedcenter by
72 | `python ./manage.py run_gunicorn`
73 | 7. Check your new speedcenter site! Great! But wait, who runs gunicorn after the
74 | terminal exits?
75 | There are several options like upstart, runit, or supervisor.
76 | Let's go with supervisor:
77 | 1.
80 |
86 |
90 | {% if use_median_bands %}
91 |
95 |
99 | {% endif %}
100 | Permalink
101 |
102 |
103 |
104 |
105 |
106 | {% endblock %}
107 |
108 | {% block extra_script %}
109 | {{ block.super }}
110 |
111 |
112 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
122 |
123 |
138 | {% endblock %}
139 |
--------------------------------------------------------------------------------
/tools/pypy/test_saveresults.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | import saveresults
3 | import unittest
4 |
5 | class testSaveresults(unittest.TestCase):
6 | '''Tests Saveresults script for saving data to speed.pypy.org'''
7 | fixture = [
8 | ['ai', 'ComparisonResult', {'avg_base': 0.42950453758219992, 'timeline_link': None, 'avg_changed': 0.43322672843939997, 'min_base': 0.42631793022199999, 'delta_min': '1.0065x faster', 'delta_avg': '1.0087x slower', 'std_changed': 0.0094009621054567376, 'min_changed': 0.423564910889, 'delta_std': '2.7513x larger', 'std_base': 0.0034169249420902843, 't_msg': 'Not significant\n'}],
9 | ['chaos', 'ComparisonResult', {'avg_base': 0.41804099082939999, 'timeline_link': None, 'avg_changed': 0.11744904518135998, 'min_base': 0.41700506210299998, 'delta_min': '9.0148x faster', 'delta_avg': '3.5593x faster', 'std_changed': 0.14350186143481433, 'min_changed': 0.046257972717299999, 'delta_std': '108.8162x larger', 'std_base': 0.0013187546718754512, 't_msg': 'Significant (t=4.683672, a=0.95)\n'}],
10 | ['django', 'ComparisonResult', {'avg_base': 0.83651852607739996, 'timeline_link': None, 'avg_changed': 0.48571481704719999, 'min_base': 0.82990884780899998, 'delta_min': '1.7315x faster', 'delta_avg': '1.7222x faster', 'std_changed': 0.006386606999421761, 'min_changed': 0.47929787635799997, 'delta_std': '1.7229x smaller', 'std_base': 0.011003382690633789, 't_msg': 'Significant (t=61.655971, a=0.95)\n'}],
11 | ['fannkuch', 'ComparisonResult', {'avg_base': 1.8561528205879998, 'timeline_link': None, 'avg_changed': 0.38401727676399999, 'min_base': 1.84801197052, 'delta_min': '5.0064x faster', 'delta_avg': '4.8335x faster', 'std_changed': 0.029594360755246251, 'min_changed': 0.36913013458299998, 'delta_std': '3.2353x larger', 'std_base': 0.0091472519207758066, 't_msg': 'Significant (t=106.269998, a=0.95)\n'}],
12 | ['float', 'ComparisonResult', {'avg_base': 0.50523018836940004, 'timeline_link': None, 'avg_changed': 0.15490598678593998, 'min_base': 0.49911379814099999, 'delta_min': '6.2651x faster', 'delta_avg': '3.2615x faster', 'std_changed': 0.057739598339608837, 'min_changed': 0.079665899276699995, 'delta_std': '7.7119x larger', 'std_base': 0.007487037523761327, 't_msg': 'Significant (t=13.454285, a=0.95)\n'}], ['gcbench', 'SimpleComparisonResult', {'base_time': 27.236408948899999, 'changed_time': 5.3500790595999996, 'time_delta': '5.0908x faster'}],
13 | ['html5lib', 'SimpleComparisonResult', {'base_time': 11.666918992999999, 'changed_time': 12.6703209877, 'time_delta': '1.0860x slower'}],
14 | ['richards', 'ComparisonResult', {'avg_base': 0.29083266258220003, 'timeline_link': None, 'avg_changed': 0.029299402236939998, 'min_base': 0.29025602340700002, 'delta_min': '10.7327x faster', 'delta_avg': '9.9262x faster', 'std_changed': 0.0033452973342946888, 'min_changed': 0.027044057846099999, 'delta_std': '5.6668x larger', 'std_base': 0.00059033067516221327, 't_msg': 'Significant (t=172.154488, a=0.95)\n'}],
15 | ['rietveld', 'ComparisonResult', {'avg_base': 0.46909418106079998, 'timeline_link': None, 'avg_changed': 1.312631273269, 'min_base': 0.46490097045899997, 'delta_min': '2.1137x slower', 'delta_avg': '2.7982x slower', 'std_changed': 0.44401595627955542, 'min_changed': 0.98267102241500004, 'delta_std': '76.0238x larger', 'std_base': 0.0058404831974135556, 't_msg': 'Significant (t=-4.247692, a=0.95)\n'}],
16 | ['slowspitfire', 'ComparisonResult', {'avg_base': 0.66740002632140005, 'timeline_link': None, 'avg_changed': 1.6204295635219998, 'min_base': 0.65965509414699997, 'delta_min': '1.9126x slower', 'delta_avg': '2.4280x slower', 'std_changed': 0.27415559151786589, 'min_changed': 1.26167798042, 'delta_std': '20.1860x larger', 'std_base': 0.013581457669479846, 't_msg': 'Significant (t=-7.763579, a=0.95)\n'}],
17 | ['spambayes', 'ComparisonResult', {'avg_base': 0.279049730301, 'timeline_link': None, 'avg_changed': 1.0178018569945999, 'min_base': 0.27623891830399999, 'delta_min': '3.3032x slower', 'delta_avg': '3.6474x slower', 'std_changed': 0.064953583956645466, 'min_changed': 0.91246294975300002, 'delta_std': '28.9417x larger', 'std_base': 0.0022442880892229711, 't_msg': 'Significant (t=-25.416839, a=0.95)\n'}],
18 | ['spectral-norm', 'ComparisonResult', {'avg_base': 0.48315834999099999, 'timeline_link': None, 'avg_changed': 0.066225481033300004, 'min_base': 0.476922035217, 'delta_min': '8.0344x faster', 'delta_avg': '7.2957x faster', 'std_changed': 0.013425108838933627, 'min_changed': 0.059360027313200003, 'delta_std': '1.9393x larger', 'std_base': 0.0069225510731835901, 't_msg': 'Significant (t=61.721418, a=0.95)\n'}],
19 | ['spitfire', 'ComparisonResult', {'avg_base': 7.1179999999999994, 'timeline_link': None, 'avg_changed': 7.2780000000000005, 'min_base': 7.04, 'delta_min': '1.0072x faster', 'delta_avg': '1.0225x slower', 'std_changed': 0.30507376157250898, 'min_changed': 6.9900000000000002, 'delta_std': '3.4948x larger', 'std_base': 0.08729261137118062, 't_msg': 'Not significant\n'}],
20 | ['twisted_iteration', 'SimpleComparisonResult', {'base_time': 0.148289627437, 'changed_time': 0.035354803126799998, 'time_delta': '4.1943x faster'}],
21 | ['twisted_web', 'SimpleComparisonResult', {'base_time': 0.11312217194599999, 'changed_time': 0.625, 'time_delta': '5.5250x slower'}]
22 | ]
23 |
24 | def testGoodInput(self):
25 | '''Given correct result data, check that every result being saved has the right parameters'''
26 | for resultparams in saveresults.save("pypy", 71212, self.fixture, "", "pypy-c-jit", "tannit", True):
27 | self.assertEqual(resultparams['project'], "pypy")
28 | self.assertEqual(resultparams['commitid'], 71212)
29 | self.assertEqual(resultparams['executable'], "pypy-c-jit")
30 | # get dict with correct data for this benchmark
31 | fixturedata = []
32 | benchfound = False
33 | for res in self.fixture:
34 | if res[0] == resultparams['benchmark']:
35 | fixturedata = res
36 | benchfound = True
37 | break
38 | self.assertTrue(benchfound)
39 | # get correct result value depending on the type of result
40 | fixturevalue = 0
41 | if fixturedata[1] == "SimpleComparisonResult":
42 | fixturevalue = fixturedata[2]['changed_time']
43 | else:
44 | fixturevalue = fixturedata[2]['avg_changed']
45 | self.assertEqual(resultparams['result_value'], fixturevalue)
46 |
47 | if __name__ == "__main__":
48 | unittest.main()
49 |
--------------------------------------------------------------------------------
/codespeed/commits/github.py:
--------------------------------------------------------------------------------
1 | # encoding: utf-8
2 | """
3 | Specialized Git backend which uses Github.com for all of the heavy work
4 |
5 | Among other things, this means that the codespeed server doesn't need to have
6 | git installed, the ability to write files, etc.
7 | """
8 | from __future__ import absolute_import
9 |
10 | import logging
11 | try:
12 | # Python 3
13 | from urllib.request import urlopen
14 | from urllib.request import Request
15 | except ImportError:
16 | # Python 2
17 | from urllib2 import urlopen
18 | from urllib2 import Request
19 | import re
20 | import json
21 |
22 | import isodate
23 | from django.core.cache import cache
24 | from django.conf import settings
25 |
26 | from .exceptions import CommitLogError
27 |
28 | logger = logging.getLogger(__name__)
29 |
30 | GITHUB_URL_RE = re.compile(
31 | r'^(?P
130 | {% endblock logo %}
131 |
132 | n.b. the layout will stay exactly the same for any image with a height of
133 | 48px (any width will do)
134 |
135 | * Custom JavaScript or CSS: add your files to the `sample_project/static/js` directory
136 | and extend the `extra_head` template block:
137 |
138 | {% block extra_head %}
139 | {{ block.super }}
140 |