Copy sample_project to speed_python

Also adjust manage.py to use speed_python

Author: zware

.gitignore

@@ -4,6 +4,7 @@
 .DS_Store
 *.db
 sample_project/repos/*
+speed_python/repos/*
 override
 build
 dist

manage.py

@@ -2,7 +2,7 @@
 import os, sys
 
 if __name__ == "__main__":
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "sample_project.settings")
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "speed_python.settings")
 
     from django.core.management import execute_from_command_line
 

speed_python/README.md

@@ -0,0 +1,132 @@
+# Codespeed Example instance
+
+Codespeed uses the Web framework [Django](http://djangoproject.com/). To get a
+Codespeed instance running you need to set up a Django Project. This directory
+is just such a project for your reference and a jump start to create your own.
+
+## For the impatient
+
+Warning: It is recommended to use [virtualenv](http://pypi.python.org/pypi/virtualenv) to avoid installing
+stuff on the root path of your operating system.
+However, it works also this way and might be desired in production
+environments.
+
+### Testing with the built-in Development Server
+That will give you *just* the Django development server version. Please
+refer to *Installing for Production* for serious installations.
+
+It is assumed you are in the root directory of the Codespeed software.
+
+1. Install the Python pip module
+   `which pip >/dev/null || easy_install pip`
+   (You might be required to use sudo)
+2. You *must* copy the `sample_project` directory to your project. (Prevents updates on
+   git tracked files in the future.) Let's call it speedcenter
+   `cp -r sample_project speedcenter`
+3a. (When configuring your own project) `pip install codespeeed`
+3b. (For Codespeed development) Install Django and other dependencies using pip
+   `pip install -r requirements.txt`. This will not install codespeed itself, as we want runserver to only "see" the local codespeed copy
+4. Add codespeed to your Python path
+   Either
+   `export PYTHONPATH=../:$PYTHONPATH`
+   or
+   `ln -s ./codespeed ./sample_project`
+5. Initialise the Django Database
+   `python manage.py syncdb`
+   (Yes, add a superuser.)
+   `python manage.py migrate`
+   Optionally, you may want to load the fixture data for a try
+   `python manage.py loaddata ../codespeed/fixtures/testdata.json`
+6. Finally, start the Django development server.
+   `python manage.py runserver`
+7. Enjoy.
+   `python -m webbrowser -n http://localhost:8000`
+
+## Installing for production
+There are many choices to get Django Web apps served. It all depends on
+your preferences and existing set up. Two options are shown. Please do
+not hesitate to consult a search engine to tune your set-up.
+
+### NGINX + GUNICORN: Easy as manage.py runserver
+Assumed you have a [Debian](http://www.debian.org) like system.
+
+1. Follow the steps from the development server set-up up to the the 6th step (database init).
+2. Install [nginx](http://nginx.net/) and [gunicorn](http://gunicorn.org/)
+   `sudo apt-get install nginx gunicorn`
+3. Tune /etc/nginx/sites-enabled/default to match
+   deploy/nginx.default-site.conf
+   (Hint: See diff /etc/nginx/sites-enabled/default deploy/nginx.default-site.conf
+   for changes)
+   Note, the sitestatic dir needs to point to your speedcenter/sitestatic dir!
+4. Restart nginx
+   /etc/init.d/nginx restart`
+5. Prepare static files
+   `cd /path/to/speedcenter/`
+   `python ./manage.py collectstatic`
+6. Add 'gunicorn' to your INSTALLED_APPS in settings.py
+   INSTALLED_APPS = (
+       'django.contrib.auth',
+   [...]
+       'south',
+       'gunicorn'
+   )
+6. Run speedcenter by
+   `python ./manage.py run_gunicorn`
+7. Check your new speedcenter site! Great! But wait, who runs gunicorn after the
+   terminal exits?
+   There are several options like upstart, runit, or supervisor.
+   Let's go with supervisor:
+   1. <Ctrl>+<c> to exit gunicorn
+   2. `apt-get install supervisor`
+   3. `cp deploy/supervisor-speedcenter.conf /etc/supervisor/conf.d/speedcenter.conf`
+   4. `$EDITOR /etc/supervisor/conf.d/speedcenter.conf  #adjust the path`
+   5. `supervisorctl update`
+   6. `supervisorctl status`
+       speedcenter                      RUNNING    pid 2036, uptime 0:00:05
+8. Warning: You may find another way to run gunicorn using `gunicorn_django`. That might
+   have a shebang of `#!/usr/bin/python` bypassing your virtualenv. Run it out of your
+   virtualenv by `python $(which gunicorn_django)`
+
+### Good old Apache + mod_wsgi
+If you don't like surprises and are not into experimenting go with the old work horse.
+Assumed you have a [Debian](http://www.debian.org) like system.
+
+1. Follow the steps from the development server set-up
+2. Prepare static files
+   `cd /path/to/speedcenter/`
+   `python ./manage.py collectstatic`
+3. Install apache and mod_wsgi
+   `apt-get install apache2 libapache2-mod-wsgi`
+4. Copy deploy/apache-speedcenter.conf
+   `cp deploy/apache-speedcenter.conf /etc/apache2/sites-available/speedcenter.conf`
+5. Edit /etc/apache2/sites-available/speedcenter.conf to match your needs
+6. Enable the new vhost
+   `a2ensite speedcenter.conf`
+7. Restart apache
+   `/etc/init.d/apache2 restart`
+8. Check your new vhost.
+
+## Customisations
+
+### Using your own Templates
+Just edit your very own Django templates in `speedcenter/templates`. A good
+start is `codespeed/base.html` the root of all templates.
+
+If you need to change the codespeed templates:
+1. Copy the templates from the codespeed module into your Django project folder.
+   `cp -r codespeed/templates/codespeed  speedcenter/templates/`
+2. Edit the templates in speedcenter/templates/codespeed/*html
+Please, also refer to the [Django template docu]
+(http://docs.djangoproject.com/en/1.4/ref/templates/)
+
+### Changing the URL Scheme
+If you don't want to have your speedcenter in the root url you can change urls.py.
+Comment (add a '#' at the beginning) line number 25 `(r'^', include('cod...`
+and uncomment the next line `(r'^speed/', include('cod...` (Note, Python is
+picky about indentation).
+Please, also refer to the [Django URL dispatcher docu]
+(http://docs.djangoproject.com/en/1.4/topics/http/urls/).
+
+### Codespeed settings
+The main config file is `settings.py`. There you configure everything related
+to your set up.

speed_python/__init__.py

@@ -0,0 +1,122 @@
+# encoding: utf-8
+
+from urlparse import urljoin
+import logging
+import platform
+import urllib
+import sys
+
+
+def save_to_speedcenter(url=None, project=None, commitid=None, executable=None,
+                        benchmark=None, result_value=None, **kwargs):
+    """Save a benchmark result to your speedcenter server
+
+    Mandatory:
+
+    :param url:
+        Codespeed server endpoint
+        (e.g. `http://codespeed.example.org/result/add/`)
+    :param project:
+        Project name
+    :param commitid:
+        VCS identifier
+    :param executable:
+        The executable name
+    :param benchmark:
+        The name of this particular benchmark
+    :param float result_value:
+        The benchmark result
+
+    Optional:
+
+    :param environment:
+        System description
+    :param date revision_date:
+        Optional, default will be either VCS commit, if available, or the
+        current date
+    :param date result_date:
+        Optional
+    :param float std_dev:
+        Optional
+    :param float max:
+        Optional
+    :param float min:
+        Optional
+    """
+
+    data = {
+        'project': project,
+        'commitid': commitid,
+        'executable': executable,
+        'benchmark': benchmark,
+        'result_value': result_value,
+    }
+
+    data.update(kwargs)
+
+    if not data.get('environment', None):
+        data['environment'] = platform.platform(aliased=True)
+
+    f = urllib.urlopen(url, urllib.urlencode(data))
+
+    response = f.read()
+    status = f.getcode()
+
+    f.close()
+
+    if status == 202:
+        logging.debug("Server %s: HTTP %s: %s", url, status, response)
+    else:
+        raise IOError("Server %s returned HTTP %s" % (url, status))
+
+
+if __name__ == "__main__":
+    from optparse import OptionParser
+
+    parser = OptionParser()
+    parser.add_option("--benchmark")
+    parser.add_option("--commitid")
+    parser.add_option("--environment",
+        help="Use a custom Codespeed environment")
+    parser.add_option("--executable")
+    parser.add_option("--max", type="float")
+    parser.add_option("--min", type="float")
+    parser.add_option("--project")
+    parser.add_option("--branch")
+    parser.add_option("--result-date")
+    parser.add_option("--result-value", type="float")
+    parser.add_option("--revision_date")
+    parser.add_option("--std-dev", type="float")
+    parser.add_option("--url",
+        help="URL of your Codespeed server (e.g. http://codespeed.example.org)")
+
+    (options, args) = parser.parse_args()
+
+    if args:
+        parser.error("All arguments must be provided as command-line options")
+
+    # Yes, the optparse manpage has a snide comment about "required options"
+    # being gramatically dubious. Yes, it's still wrong about not needing to
+    # do this.
+    required = ('url', 'environment', 'project', 'commitid', 'executable',
+                'benchmark', 'result_value')
+
+    if not all(getattr(options, i) for i in required):
+        parser.error("The following parameters must be provided:\n\t%s" % "\n\t".join(
+            "--%s".replace("_", "-") % i for i in required))
+
+    kwargs = {}
+    for k, v in options.__dict__.items():
+        if v is not None:
+            kwargs[k] = v
+    kwargs.setdefault('branch', 'default')
+
+    if not kwargs['url'].endswith("/result/add/"):
+        kwargs['url'] = urljoin(kwargs['url'], '/result/add/')
+
+    try:
+        save_to_speedcenter(**kwargs)
+        sys.exit(0)
+    except StandardError, e:
+        logging.error("Error saving results: %s", e)
+        sys.exit(1)

speed_python/client.py

@@ -0,0 +1,30 @@
+<VirtualHost *>
+    ServerName speed.pypy.org
+    DocumentRoot /var/www/speed.pypy.org
+
+    ErrorLog /var/log/apache2/speed-pypy.org-error.log
+
+    # Possible values include: debug, info, notice, warn, error, crit,
+    # alert, emerg.
+    LogLevel warn
+
+    CustomLog /var/log/apache2/speed-pypy.org-access.log combined
+    ServerSignature On
+
+  Alias /static/ /path/to/speedcenter/sitestatic/
+
+  <Directory /path/to/speedcenter/sitestatic/>
+        Order allow,deny
+        Allow from all
+    </Directory>
+
+   ProxyRequests Off
+   <Proxy *>
+     Order deny,allow
+     Allow from all
+   </Proxy>
+   ProxyPass              /static !
+   ProxyPass              /  http://localhost:8000/
+   ProxyPassReverse       /  http://localhost:8000/
+
+</VirtualHost>

speed_python/deploy/apache-reverseproxy.conf

@@ -0,0 +1,15 @@
+<VirtualHost speedcenter.foo.bar:80>
+        ServerName speedcenter.foo.bar
+        ServerAlias speed speed.foo.bar
+        DocumentRoot /var/www/speedcenter/
+        ServerAdmin admin@foo.bar
+        ErrorLog /var/log/apache2/speedcenter-errors.log
+        CustomLog /var/log/apache2/speedcenter-access.log combined
+        DirectoryIndex index.html index.shtml
+
+        Alias /static/ /path/to/speedcenter/sitestatic/
+
+    WSGIDaemonProcess speedcenter user=www-data group=www-data python-path=/path/to/virtualenv/codespeed/lib/python2.6/site-packages/
+    WSGIProcessGroup speedcenter
+    WSGIScriptAlias / /path/to/speedcenter/django.wsgi
+</VirtualHost>

speed_python/deploy/apache-speedcenter.conf

@@ -0,0 +1,28 @@
+<VirtualHost *:80>
+    ServerAdmin name@mail.server
+    ServerName myspeedcenter
+
+    TransferLog /var/log/apache2/myspeedcenter.pypy.org.log
+    ErrorLog /var/log/apache2/myspeedcenter.pypy.org.err
+
+    # To be able to serve images for admin site:
+    Alias /admin_media/ /usr/local/lib/python2.7/dist-packages/django/contrib/admin/media/
+    <Directory /usr/local/lib/python2.7/dist-packages/django/contrib/admin/media/>
+        Order deny,allow
+        Allow from all
+    </Directory>
+
+    # Serve media files
+    Alias /static/ /path/to/codespeed/app/static/
+    <Directory /path/to/codespeed/app/static/>
+        Order deny,allow
+        Allow from all
+    </Directory>
+
+    #let Django handle requests
+    WSGIScriptAlias / /path/to/example/project/example/deploy/django.wsgi
+    <Directory /path/to/example/project/example/deploy/>
+        Order deny,allow
+        Allow from all
+    </Directory>
+</VirtualHost>

speed_python/deploy/apache-speedcenter2.conf

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+"""
+WSGI config
+"""
+
+import os
+import sys
+
+current_dir = os.path.abspath(os.path.dirname(__file__).replace('\\','/'))
+dirs = current_dir.split(os.path.sep)
+del(dirs[-1])
+codespeed_dir = os.path.sep.join(dirs)
+del(dirs[-1])
+project_dir = os.path.sep.join(dirs)
+
+sys.path.append(project_dir)
+sys.path.append(codespeed_dir)
+os.environ['DJANGO_SETTINGS_MODULE'] = codespeed_dir.split(os.path.sep)[-1] + '.settings'
+
+import django.core.handlers.wsgi
+application = django.core.handlers.wsgi.WSGIHandler()
+