zc.testbrowser integration for Django;
zc.testbrowser is a lot more robust than the default functional testing
client that comes with Django.
See the introduction_ to
zc.testbrowser for a better understanding
of how powerful it is.
.. _introduction: http://pypi.python.org/pypi/zc.testbrowser/1.0a1
First of all, you need to have homophony installed; for your convenience, recent versions should be available from PyPI.
Let's say you're working on an application called
foobar; the tests for
this application are located in
Use this as a starting point for
from homophony import BrowserTestCase, Browser class FoobarTestCase(BrowserTestCase): def testHome(self): browser = Browser() browser.open('http://testserver') browser.getControl(name='first_name').value = 'Jim' browser.getForm().submit() self.assertEquals(browser.url, 'http://testserver/hello') self.assertEquals(browser.title, 'Hello Jim')
Bear in mind that implementing custom
should involve calling those defined in
If you prefer doctests over unit tests (as we do!), use the following as a base
from homophony import DocFileSuite def suite(): return DocFileSuite('tests.txt')
And here is an example
The website welcomes its visitors with a form: >>> browser = Browser() >>> browser.open('http://testserver') >>> browser.getControl(name='first_name').value = 'Jim' >>> browser.getForm().submit() When a name is given, it echoes back with an informal greeting: >>> browser.title 'Hello Jim' >>> print browser.contents <!DOCTYPE html> ... <h1>Hello Jim</h1> ... And there is a link to go back: >>> browser.getLink('Go back').click() >>> browser.title 'Home'
There are some useful helpers on the browser class. You can run XPath queries
on HTML documents using
queryHTML, like this:
>>> browser.queryHTML('//h1') <h1>Hello Jim</h1>
When debugging tests, it is sometimes handy to open a browser at a particular
point in the test. You can accomplish that by invoking
This command will start an HTTP server and open a web browser with live access to your application. Use Ctrl-C to stop the server and continue running tests.
The browser will persist cookies accross requests, so things like user sessions should work.
There is an example Django application in the source distribution. Let's run the tests::
wormhole:example admp$ ./manage.py test -v 2 website Creating test database... Creating table auth_permission Creating table auth_group Creating table auth_user Creating table auth_message Creating table django_content_type Creating table django_session Creating table django_site Installing index for auth.Permission model Installing index for auth.Message model ... testHome (example.website.tests.FoobarTestCase) ... ok Doctest: tests.txt ... ok ---------------------------------------------------------------------- Ran 2 tests in 0.102s OK Destroying test database...
-v 2 parameter is there to get the list of tests printed, and is otherwise
For learning purposes, try to break the tests and witness the details in the output of the test runner.
How does it work?
Custom hooks are installed for
urllib to pass all requests for
http://testserver to a subclass of
exposes Django applications through WSGI_). The real heavy lifting is
.. _WSGI: http://www.wsgi.org/
There is a
home page <http://github.com/shrubberysoft/homophony>_ with
instructions on how to access the code repository.
Send feedback and suggestions to email@example.com.