Installation

At the command line:

$ easy_install django-functest

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv django-functest
$ pip install django-functest

You will also need to add django-functest to your URLs. In your URLconf:

urlpatterns += patterns('',
    url(r'^django_functest/', include('django_functest.urls'))
)

or:

urlpatterns += [
    url(r'^django_functest/', include('django_functest.urls'))
]

This is only necessary for running tests, so the above can be done conditionally for test mode only, if possible.

When running tests, you will also need to have localhost in your ALLOWED_HOSTS setting.

Dependencies

Python dependencies are automatically installed, including the Python selenium package. However, due the nature of Selenium, if you are writing Selenium tests (i.e. if you are not simply using the WebTest wrapper), dependencies are quite complex.

Selenium uses a WebDriver protocol for talking to browsers that is more or less supported by different browsers. Please see the django_functest.FuncSeleniumMixin.driver_name attribute for selecting the browser to use.

In addition to needing web browsers installed, you often need additional driver programs that speak the WebDriver protocol. These programs are not 100% complete with each other, and have their own bugs and incompatibilities depending on their version, and the version of the browser. Our policy is to try to test against the latest version of the browser and latest version of the driver at the time of release - see table below.

Tested browser versions:

django-functest

Firefox

Chrome

1.2

Firefox 96.0 geckodriver 0.30.0

Chrome 97.0 chromedriver 97.0.4692.71

1.1.1

Firefox 92.0 geckodriver 0.30.0

Chrome 94 chromedriver 94.0.4606.41

1.1.0

Firefox 84 geckodriver 0.28.0

Chrome 87 chromedriver 87.0.4280.88

1.0.4

Firefox 58 geckodriver 0.20.0

Chrome ? chromedriver 2.37

Browser specific notes below:

Chrome

Chrome can be used if chromedriver is installed.

Firefox

For recent versions of Firefox, you can use Selenium 3 or later, if you install the new Marionette driver, also known as geckodriver (download releases here).

Older versions of Firefox (45 and earlier) could be used with Selenium < 3 and without anything additional installed, but this has not been tested recently.

If you need to run your own tests with a different version of Firefox than the default one on your system, it is recommended you follow the pattern used by django-functest’s own runtests.py script which allows you to pass a --firefox-binary option. This is then eventually returned by get_webdriver_options() as argument firefox_binary (see tests/base.py). You could also make get_webdriver_options look in os.environ if that is easier to arrange. If you are using pytest, see the Pytest integration tips for some better patterns for doing this kind of thing.

PhantomJS

If installed, PhantomJS can be used. PhantomJS is no longer officially supported - the test suite does not run against it and bugs for it will not be fixed. This is because the project has been abandoned, and Selenium also no longer supports it.

Other notes about old versions

  • If you are using Django < 1.11, you should install django-functest < 1.0.1 and django-webtest < 1.9.1.

  • If you are using Firefox 45 or older, you will need Selenium < 3