tox.ini

[tox]
skipsdist=True
# Temporarily disabling this to deliberately support conflicting versions
# wagtail==1.13.3 with django-modelcluster==4.4.
# tox_pip_extensions_ext_venv_update=True
# Run these envs when tox is invoked without -e
envlist=lint-py{27}, unittest-py{27,36}-dj{111}-wag{113}-slow


[testenv]
# Factored env for running most things with a matrix of Python, Django, and
# Wagtail versions. Configuration of individual top-level factors like lint
# and unittest is done in their respective configuration sections below.
#
# Factors:
#   lint:               Lint Python files with flake8 and isort
#   unittest:           Run Python unittests
#   acceptance:         Run a Django server and acceptance tests
#   py27:               Use Python 2.7
#   py36:               Use Python 3.6
#   dj111:              Use Django 1.11
#   dj20:               Use Django 2.0
#   wag113:             Use Wagtail 1.13
#   wag20:              Use Wagtail 2.0
#
# These factors are expected to combine into the follow generative environments:
#
#   lint-py{27,36}
#   unittest-py{27,36}-dj{111}-wag{113}-{fast,slow}
#   unittest-py{36}-dj{20}-wag{20}-{fast,slow}
#   acceptance-py{27,36}-dj{111}-wag{113}-fast
#
# These factors are expected to combine to be invoked with:
#
#   tox -e lint-py27
#   tox -e lint-py36
#   tox -e unittest-py27-dj111-wag113-fast
#   tox -e unittest-py27-dj111-wag113-slow
#   tox -e unittest-py36-dj111-wag113-fast
#   tox -e unittest-py36-dj111-wag113-slow
#   tox -e unittest-py36-dj20-wag20-fast
#   tox -e unittest-py36-dj20-wag20-slow
#   tox -e acceptance-py27-dj111-wag113-fast
#   tox -e acceptance-py36-dj111-wag113-fast

recreate=False

whitelist_externals=echo

changedir=
    unittest:           {[unittest]changedir}
    acceptance:         {[acceptance]changedir}

basepython=
    py27: python2.7
    py36: python3.6

deps=
    dj111:              Django>=1.11,<1.12
    dj20:               Django>=2.0,<2.1
    wag113:             wagtail>=1.13,<1.14
    wag20:              wagtail>=2.0,<2.1
    lint:               {[lint]deps}
    unittest:           {[unittest]deps}
    acceptance:         {[acceptance]deps}

passenv=
    fast:       {[unittest]passenv}
    slow:       {[unittest]passenv}
    unittest:   {[unittest]passenv}
    acceptance: {[acceptance]passenv}

setenv=
    fast:               {[fast]setenv}
    slow:               {[slow]setenv}
    unittest:           {[unittest]setenv}
    acceptance:         {[acceptance]setenv}

commands=
    lint:               {[lint]commands}
    py27-slow:          {[py27-slow]commands}
    unittest:           {[unittest]commands}
    acceptance:         {[acceptance]commands}


[lint]
# Configuration values necessary to lint Python files.
# Note: This is not an env will not run if invoked. Use an invocation of:
#
#   tox -e lint-py{27,36}
#
# To run Python linting.
deps=
    flake8
    isort
commands=
    flake8
    isort --check-only --diff --recursive cfgov


[unittest]
# Configuration values necessary to run unittests.
# Note: This is not an env will not run if invoked. Use an invocation of:
#
#   tox -e unittest-py{27,36}-dj{111,20}-wag{113,20}-{fast,slow}
#
# To run unit tests.
changedir=
    {toxinidir}/cfgov
passenv=
    TRAVIS TRAVIS_JOB_ID TRAVIS_BRANCH TEST_DATABASE_URL TEST_RUNNER
# Set DJANGO_SETTINGS_MODULE based on {with,no}-migrations
setenv=
    GOVDELIVERY_ACCOUNT_CODE=fake_account_code
    DJANGO_ADMIN_USERNAME=admin
    DJANGO_ADMIN_PASSWORD=admin
    LANG=en_US.UTF-8
    LC_ALL=en_US.UTF-8
    WAGTAIL_SHARING_HOSTNAME=content.localhost
deps=
    -r{toxinidir}/requirements/libraries.txt
    -r{toxinidir}/requirements/test.txt
commands=
    coverage erase
    coverage run --source='.' manage.py test {posargs}


[fast]
# Configuration values necessary to run unittests without migrations.
# Note: This is not an env will not run if invoked. Use an invocation of:
#
#   tox -e unittest-py{27,36}-dj{111}-wag{113}-fast
#
# To run unit tests.
setenv=
    DJANGO_SETTINGS_MODULE=cfgov.settings.test_nomigrations


[slow]
# Configuration values necessary to run unittests with migrations.
# Note: This is not an env will not run if invoked. Use an invocation of:
#
#   tox -e unittest-py{27,36}-dj{111}-wag{113}-slow
#
# To run unit tests.
setenv=
    DJANGO_SETTINGS_MODULE=cfgov.settings.test


[py27-slow]
# Extra configuration values used as part of py27-slow environments.
#
# When running on Travis, we want to verify that Django migrations are
# up-to-date. But we don't want to do that when running tox locally. We
# accomplish this by having Travis set the TRAVIS_CHECK_MIGRATIONS
# environment variable with the check migrations command.
#
# When not running on Travis, we want this to be a noop.
commands=
    {env:TRAVIS_CHECK_MIGRATIONS:echo "Skipping Travis-only step"}


[acceptance]
# Configuration values necessary to run acceptance tests using same
# virtualenv as backend tests.
# Note: This is not an env will not run if invoked. Use an invocation of:
#
#   acceptance-py{27,36}-dj{111}-wag{113}-fast
#
# To run acceptance tests.
changedir=
    {[unittest]changedir}
deps=
    {[unittest]deps}
passenv=
    USER
    DISPLAY
    SAUCE_USERNAME
    SAUCE_ACCESS_KEY
    SAUCE_SELENIUM_URL
    SAUCE_TUNNEL
    TRAVIS
setenv=
    DJANGO_LIVE_TEST_SERVER_ADDRESS=localhost:9000-9010
    DJANGO_SETTINGS_MODULE=cfgov.settings.test_acceptance
commands=
    ./manage.py test {posargs}


## Standalone and past-friendly envs


[testenv:lint]
# Invoke with: tox -e lint
# This should run identically to tox -e lint-py27
recreate=False
basepython=python2.7
envdir={toxworkdir}/lint-py27
deps={[lint]deps}
commands={[lint]commands}


[testenv:fast]
# Invoke with: tox -e fast
# This should run identically to tox -e unittest-py27-dj111-wag113-fast
recreate=False
changedir={[unittest]changedir}
basepython=python2.7
envdir={toxworkdir}/unittest-py27-dj111-wag113-fast
deps=
    -r{toxinidir}/requirements/django.txt
    -r{toxinidir}/requirements/wagtail.txt
    {[unittest]deps}
setenv=
    {[fast]setenv}
    {[unittest]setenv}
commands={[unittest]commands}


[testenv:acceptance]
recreate=False
changedir={[acceptance]changedir}
basepython=python2.7
envdir={toxworkdir}/acceptance-py27-dj111-wag113
deps=
    -r{toxinidir}/requirements/django.txt
    -r{toxinidir}/requirements/wagtail.txt
    {[acceptance]deps}
passenv={[acceptance]passenv}
setenv=
    acceptance: {[acceptance]setenv}
    LANG=en_US.UTF-8
    LC_ALL=en_US.UTF-8
commands={[acceptance]commands}


[testenv:validate-assets]
# Invoke with: tox -e validate-assets
# Ensure all assets are generated without error.
recreate=False
changedir={toxinidir}
basepython=python2.7
deps=-r{toxinidir}/requirements/base.txt
setenv=
    DJANGO_SETTINGS_MODULE=cfgov.settings.production
    DJANGO_STATIC_ROOT={toxinidir}/collectstatic
    ALLOWED_HOSTS=["*"]
commands=
    {toxinidir}/frontend.sh production
    {toxinidir}/cfgov/manage.py collectstatic --noinput