Before you start¶

Do you have pip, virtualenv, virtualenvwrapper, and git-scm installed? If not, you’ll need to get those on your machine before proceeding.

If you need to install pip:

$ curl -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py
$ python get-pip.py

If you need to install virtualenv:

$ pip install virtualenv

If you need to install virtualenvwrapper:

$ pip install virtualenvwrapper

If you need to install git:

• http://git-scm.com

The Basics¶

Create a virtualenv for this project. We do this so we isolate all our work from the rest of Python on our computer:

$ mkvirtualenv dpkenv

Now we clone django-party-pack and go into django-party-pack:

$ git clone https://pydanny@github.com/pydanny/django-party-pack.git
$ cd django-party-pack

Now let’s install our dependencies:

$ pip install -r requirements.txt

This may take a few minutes. Feel free to go get some coffee. :)

Settings setup¶

We’re going to follow what Django BDFL Jacob Kaplan-Moss advocates as best practices for dealing with settings. That means we’re going to ignore the manage.py file in the root of our Django project and use the django-admin.py script. In order to do that, we need to take a few more steps.

First, we add some virtualenv bits to allow us to access the settings properly:

$ echo "export DJANGO_SETTINGS_MODULE=settings.dev" >> $VIRTUAL_ENV/bin/postactivate
$ echo "unset DJANGO_SETTINGS_MODULE" >> $VIRTUAL_ENV/bin/postdeactivate

This will allow you to eschew passing in –settings= into management commands.

Now we add to the virtualenv paths our pollaxe project:

add2virtualenv <<path to django-party-pack repo>>/pollaxe

Running standard Django Commands¶

Try out the project:

$ django-admin.py syncdb
$ django-admin.py runserver

Running django-coverage¶

Simply run this command:

$ django-admin.py test

Now open the pollaxe/coverage/index.html file in your favorite browser.

Building these sphinx docs¶

Want to have a local copy of these documents? Easy! Change to our docs directory:

$ cd docs

Now we generate the sphinx docs in html format:

$ make html

Step 1 - environment prep¶

In your virtualenv install the necessary requirements:

$ pip install -r requirements.txt

Make a coverage directory in your project directory:

# This is done for you in django-party-pack
#   but you'll need to remember it for future projects
$ mkdir coverage

Step 2 - create testrunner.py¶

Create a testrunner.py file into your project root and paste in the following code:

# Make our own testrunner that by default only tests our own apps

from django.conf import settings
from django.test.simple import DjangoTestSuiteRunner
from django_coverage.coverage_runner import CoverageRunner

class OurTestRunner(DjangoTestSuiteRunner):
    def build_suite(self, test_labels, *args, **kwargs):
        return super(OurTestRunner, self).build_suite(test_labels or settings.PROJECT_APPS, *args, **kwargs)

class OurCoverageRunner(OurTestRunner, CoverageRunner):
    pass

Step 3 - settings customization¶

The first thing you’ll notice about dpp is that apps installment is broken up into three variables:

• PREREQ_APPS - These are either built-in Django apps or third-party apps you don’t want to test.
• PROJECT_APPS - These are the custom apps you’ve written for your project. You want to test these.
• INSTALLED_APPS - This is what Django loads into it’s app cache. We generate this iterable by adding PREREQ_APPS to PROJECT_APPS.

Here is the sample code from dpp/pollaxe project settings.py file:

PREREQ_APPS = (
     'django.contrib.auth',
     'django.contrib.contenttypes',
     'django.contrib.sessions',
     'django.contrib.sites',
     'django.contrib.messages',
     'django.contrib.admin',
)

PROJECT_APPS = (
    'polls', # or whatever your custom project uses
)

INSTALLED_APPS = PREREQ_APPS + PROJECT_APPS

Also in settings.py, underneath where you have defined the PREREQ_APPS setting, add the following:

TEST_RUNNER = 'testrunner.OurCoverageRunner'
COVERAGE_MODULE_EXCLUDES = [
    'tests$', 'settings$', 'urls$', 'locale$',
    'migrations', 'fixtures', 'admin$',
]
COVERAGE_MODULE_EXCLUDES += PREREQ_APPS
COVERAGE_REPORT_HTML_OUTPUT_DIR = "coverage"

Step 4 - run it!¶

From the command-line:

$ python manage.py test

Open file:///path-to-your-project/coverage/index.html in a web browser and check out your coverage.

Coding Standard for JavaScript¶

• https://github.com/jbalogh/zamboni/blob/master/STYLE.rst

Philosophy¶

import this

Code Bits¶

# See this commented out? 'import *' usually slows things down AND makes it harder to debug
# import *

# Explicit imports are easier to debug
from polls import views
...

# Don't do this!
url(
    r'^$',
    views.poll_list,
    'poll_list',
),

# Or this!
(
    r'^$',
    views.poll_list,
    'poll_list',
),

url(
    regex=r'^$',
    view=views.poll_list,
    name='poll_list',
),

# Don't do this!
url(
    regex=r'^$',
    view='polls.views.standard.poll_list', # this single bit makes it harder to debug on errors
    name='poll_list',
),

url(regex=r'^$',
    view=views.poll_list,
    name='poll_list',
),

try:
    do_blah()
except:
    pass

class BlahDoesNotWork(Exception): pass

try:
    do_blah
except ImportError:
    # do something
except AttributeError:
    # do something else
except Exception as e:
    msg = "{0} has failed!".format(str(e))
    logging.error(msg)
    raise BlahDoesNotWork(msg)

polls.models¶

class polls.models.Choice(*args, **kwargs)[source]¶

Choices on a poll

class polls.models.Poll(*args, **kwargs)[source]¶

An individual poll to be tested

polls.views¶

polls.views.detail(request, poll_id, template_name='polls/detail.html')[source]¶

Show detail on a poll

polls.views.index(request, template_name='polls/index.html')[source]¶

Show a list of polls

polls.views.vote(request, poll_id, template_name='polls/detail.html')[source]¶

user votes on a poll

polls.tests¶

class polls.tests.test_models.TestPolls(methodName='runTest')[source]¶

test_poll_create()[source]¶

Can we create a poll?

• Seems trivial now
• But for complex systems what started out as a simple create can get complex
• Get your test coverage up!

test_was_published_today()[source]¶

class polls.tests.test_views.TestPollSample(methodName='runTest')[source]¶

setUp()[source]¶

test_poll_detail()[source]¶

Check if the poll detail displays

test_poll_index()[source]¶

Check if the poll index displays

test_poll_vote()[source]¶

vote on a poll