Installation¶
In your virtualenv:
$ pip install django-functest
You will also need to add django-functest to your URLs. In your URLconf:
urlpatterns += [path("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 3.7 and later is supported. Django 2.0 and later is supported.
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 test against the latest version of the browser and latest version of the driver at the time of release.
Browser specific notes below:
Chrome¶
Chrome can be used if chromedriver is installed.
Firefox¶
You need to install the Marionette
driver, also known as geckodriver
(download releases here).
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.