Env Detection¶

Env detection is the primary feature of Tox-Travis. Based on the matrix created in .travis.yml, it decides which Tox envs need to be run for each Travis job.

Usage¶

Configure the Python versions to test with in .travis.yml:

language: python
python:
  - "3.6"
  - "3.7"
install: pip install tox-travis
script: tox

And it will run the appropriate testenvs, which by default are any declared env with py36 or py37 as factors of the name. If no environments match a given factor, the py36 or py37 envs are used as a fallback.

Advanced Configuration¶

To customize what environments tox will run on Travis, add a section to tox.ini telling it what environments to run under which versions of Python:

[tox]
envlist = py{36,37}-django{21,22}, docs

[travis]
python =
  3.6: py36
  3.7: py37, docs

This would run the Python 3.6 variants under 3.6, and the Python 3.7 variants and the docs env under 3.7.

Note that Travis won’t run all the envs simultaneously, because its build matrix is only aware of the Python versions. Only one Travis build will be run per Python version, unless other settings are specified in the Travis build matrix.

If you are using multiple Travis factors, then you can use those factors to decide what will run. For example, see the following .travis.yml and tox.ini:

language: python
python:
  - "3.6"
  - "3.7"
env:
  - DJANGO="2.1"
  - DJANGO="2.2"
matrix:
  include:
    - os: osx
      language: generic
install: pip install tox-travis
script: tox

[tox]
envlist = py{36,37}-django{21,22}, docs

[travis]
os =
  linux: py{36,37}-django{21,22}, docs
  osx: py{36,37}-django{21,22}
python =
  3.7: py37, docs

[travis:env]
DJANGO =
  2.1: django21
  2.2: django22, docs

Travis will run 5 different jobs, which will each run jobs as specified by the factors given.

os: linux (default), language: python, python: 3.6, env: DJANGO=2.1

This will run the env py36-django21, because py36 is the default, and django21 is specified.
os: linux (default), language: python, python: 3.7, env: DJANGO=2.2

This will run the env py37-django22, but not docs, because docs is not included in the DJANGO 2.2 configuration.
os: linux (default), language: python, python: 3.6, env: DJANGO=2.1

This will run the env py36-django21, because py36 is the default. docs is not run, because Python 3.6 doesn’t include docs in the defaults that are not overridden.
os: linux (default), language: python, python: 3.7, env: DJANGO=2.2

This will run the envs py37-django22 and docs, because all specified factors match, and docs is present in all related factors.
os: osx, language: generic

This will run envs py36-django21, py37-django21, py36-django22, and py37-django22, because the os factor is present, and limits it to just those envs.

Unignore Outcomes¶

By default, when using ignore_outcome in your Tox configuration, any build errors will show as successful on Travis. This might not be desired, as you might want to control allowed failures inside your .travis.yml. To cater this need, you can set unignore_outcomes to True. This will override ignore_outcome by setting it to False for all environments.

Configure the allowed failures in the build matrix in your .travis.yml:

matrix:
  allow_failures:
  - python: 3.6
    env: DJANGO=master

And in your tox.ini:

[travis]
unignore_outcomes = True