@@ -31,29 +31,15 @@ Testing
-------
Patchwork includes a `tox`_ script to automate testing. This requires a
-functional database and some Python requirements like *tox*. Refer to
-:doc:`installation` for information on how to configure these.
-
-You may also need to install *tox*. If so, do this now:
+functional database and some Python requirements like *tox*. These can be
+installed using :command:`pip`:
.. code-block:: shell
- $ pip install --user tox
-
-.. tip::
-
- If you're using Docker, you may not need to install *tox*
- locally. Instead, it will already be installed inside the
- container. For Docker, you can run *tox* like so:
-
- .. code-block:: shell
-
- $ docker-compose run --rm web tox [ARGS...]
-
- For more information, refer to :ref:`installation-docker`.
+ $ pip install --user tox tox-docker
-Assuming these requirements are met, actually testing Patchwork is quite easy
-to do. To start, you can show the default targets like so:
+Once installed, actually testing Patchwork is quite easy to do. To start, you
+can show the default targets like so:
.. code-block:: shell
@@ -66,7 +52,7 @@ parameter:
.. code-block:: shell
- $ tox -e py27-django18
+ $ tox -e py36-django21-mysql
In the case of the unit tests targets, you can also run specific tests by
passing the fully qualified test name as an additional argument to this
@@ -74,7 +60,7 @@ command:
.. code-block:: shell
- $ tox -e py27-django18 patchwork.tests.SubjectCleanUpTest
+ $ tox -e py36-django21-mysql patchwork.tests.SubjectCleanUpTest
Because Patchwork support multiple versions of Django, it's very important that
you test against all supported versions. When run without argument, tox will do
@@ -86,12 +86,6 @@ To run unit tests against the system Python packages, run:
$ docker-compose run --rm web python manage.py test
-To run unit tests for multiple versions using ``tox``, run:
-
-.. code-block:: shell
-
- $ docker-compose run --rm web tox
-
To reset the database before any of these commands, add ``--reset`` to the
command line after ``web`` and before any other arguments:
@@ -19,6 +19,18 @@ try:
except ImportError:
debug_toolbar = None
+#
+# tox-docker settings
+#
+
+if 'POSTGRES_5432_TCP' in os.environ:
+ os.environ['PW_TEST_DB_HOST'] = 'localhost'
+ os.environ['PW_TEST_DB_PORT'] = os.environ['POSTGRES_5432_TCP']
+elif 'MYSQL_3306_TCP' in os.environ:
+ os.environ['PW_TEST_DB_HOST'] = 'localhost'
+ os.environ['PW_TEST_DB_PORT'] = os.environ['MYSQL_3306_TCP']
+
+
#
# Core settings
# https://docs.djangoproject.com/en/1.11/ref/settings/#core-settings
@@ -5,4 +5,6 @@ django-filter==2.1.0; python_version >= '3.4'
django-filter==1.1.0; python_version < '3.0' # pyup: ignore
django-debug-toolbar==1.11
django-dbbackup==3.2.0
+psycopg2-binary==2.8.2
+mysqlclient==1.3.14
-r requirements-test.txt
@@ -1,5 +1,3 @@
-mysqlclient==1.3.14
-psycopg2-binary==2.8.2
sqlparse==0.3.0
python-dateutil==2.8.0
openapi-core==0.8.0
@@ -1,6 +1,6 @@
[tox]
minversion = 2.0
-envlist = pep8,docs,py{27,34}-django111,py{35,36}-django{111,20,21}
+envlist = pep8,docs,py{27,34}-django111-{mysql,postgres},py{35,36}-django{111,20,21}-{mysql,postgres}
skipsdist = True
[testenv]
@@ -14,6 +14,11 @@ deps =
django21: django>=2.1,<2.2
django{20,21}: djangorestframework>=3.7,<3.10
django{20,21}: django-filter>=2.0,<3.0
+ postgres: psycopg2-binary==2.7.7
+ mysql: mysqlclient==1.3.14
+docker =
+ postgres: postgres:9.6
+ mysql: mysql:5.7
setenv =
DJANGO_SETTINGS_MODULE = patchwork.settings.dev
PYTHONDONTWRITEBYTECODE = 1
@@ -21,15 +26,31 @@ setenv =
py27: PYTHONWARNINGS = once
py{34,36}:PYTHONWARNINGS = once,ignore::ImportWarning:backports
py35:PYTHONWARNINGS = once,ignore::ResourceWarning:unittest.suite,ignore::ImportWarning:backports
+ postgres: PW_TEST_DB_TYPE = postgres
+ postgres: PW_TEST_DB_USER = postgres
+ postgres: PW_TEST_DB_PASS = password
+ postgres: PGPASSWORD = password
passenv =
http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
PW_TEST_DB_TYPE PW_TEST_DB_USER PW_TEST_DB_PASS PW_TEST_DB_HOST
PW_TEST_DB_PORT
+dockerenv =
+ postgres: POSTGRES_PASSWORD=password
+ mysql: MYSQL_ROOT_PASSWORD=password
+ mysql: MYSQL_USER=patchwork
+ mysql: MYSQL_PASSWORD=password$
+whitelist_externals =
+ sleep
+# If we're using the docker containers, we need to sleep to ensure the
+# container has time to startup
commands =
+ {postgres,mysql}: sleep 5
python {toxinidir}/manage.py test --noinput '{posargs:patchwork}'
[testenv:bashate]
deps = bashate
+docker =
+dockerenv =
whitelist_externals = bash
commands =
bash -c "find {toxinidir} \
@@ -40,6 +61,8 @@ commands =
[testenv:pep8]
basepython = python2.7
deps = flake8
+docker =
+dockerenv =
commands = flake8 {posargs} patchwork patchwork/bin/pwclient
[flake8]
@@ -54,6 +77,8 @@ exclude = ./patchwork/migrations
[testenv:docs]
deps =
-r{toxinidir}/docs/requirements.txt
+docker =
+dockerenv =
commands =
sphinx-build -E -W -b dirhtml -d docs/_build/doctrees docs docs/_build/html
This eliminates the need to use docker-compose for most use cases. Instead, we can now do: tox -e py27-django111-postgres If you're using a locally configured PostgreSQL or MySQL instance, you simply omit the last factor and things behave as before: tox -e py27-django111 Signed-off-by: Stephen Finucane <stephen@that.guru> Cc: Daniel Axtens <dja@axtens.net> --- docs/development/contributing.rst | 28 +++++++--------------------- docs/development/installation.rst | 6 ------ patchwork/settings/dev.py | 12 ++++++++++++ requirements-dev.txt | 2 ++ requirements-test.txt | 2 -- tox.ini | 27 ++++++++++++++++++++++++++- 6 files changed, 47 insertions(+), 30 deletions(-)