tox
目次

tox とは

これをテストに使いたいとは限らないのでもうテスト用に環境分けちゃおうぜ的なツール

  • 別々の virtualenv にそれぞれテスト環境を構築してくれる

  • 構築した virtualenv の中でテストを実行して、結果を表示してくれる

  • テストツールや環境変数などをまとめておける

  • tox コマンドを実行するだけで、必要なテストを簡単に、まとめて実行できるようになる

  • それぞれのテストは virtualenv によって分離されているため、他のテスト用設定が別のテストに影響を与えない

インストール

$ pip install tox

tox.ini

テスト実行環境の設定を記述するファイル

[tox]
# envlist: テスト環境の一覧。それぞれ別々の環境が用意される。
# py27: インストールされている python2.7 コマンドを探し出して、 Python2.7 の virtualenv を作成してくれる。
envlist = flake8,typecheck,py27

# setup.py がなくても実行可能にする。 setup.py がない場合は、 requirements.txt などで依存ライブラリを管理する。
skipsdist = True

[pytest]
addopts = --durations=10

# 実行対象を指定する。この場合は、 tests ディレクトリ配下。
testpaths = tests

# pytest-pythonpath の項を参照のこと。
python_paths = apps tests

# https://pytest-django.readthedocs.io/en/latest/managing_python_path.html#managing-the-python-path-explicitly
django_find_project = false
DJANGO_SETTINGS_MODULE = settings.test

# [testenv]: テスト環境の設定。
# `[testenv:flake8]` のように環境の名前が指定されている場合は、そちらの指定が優先される。
# 環境の名前に合う設定がない場合は、 `[testenv]` セクションの汎用的な設定が利用される。
[testenv]

# 環境にインストールするライブラリを指定する。
# この部分は pip に直接渡されるため、ライブラリではなく requirements.txt の指定も可能。
# `-r` と `requirements_dev.txt` の間にスペースを入れるとエラーになるので注意。
deps = -rrequirements_dev.txt

# 環境変数を固定したい場合はここに書く
setenv =
    PYTHONDONTWRITEBYTECODE = 1

# 実行するコマンド: py.test, 実行対象: tox コマンド実行時に引数として渡されたディレクトリ配下
# `{posargs}` と書くと、 tox コマンド実行時に引数を渡すことができる
commands = py.test {posargs}

# typecheck はこちらのテスト環境設定が優先される
[testenv:typecheck]
# typecheck 用の環境にインストールするライブラリを指定する。
deps =
    mypy
    mypy-extensions

# typecheck 用の virtualenv は python3 で作る
# https://tox.readthedocs.io/en/latest/config.html#conf-basepython
basepython = python3

# 実行するコマンド: mypy, 実行対象: app ディレクトリ配下
commands = mypy apps

# flake8 はこちらのテスト環境設定が優先される
[testenv:flake8]
deps =
    flake8>=3.6.0
    flake8-blind-except
    flake8-docstrings<1.1.0
    flake8-import-order
    pydocstyle<2.0.0
    mccabe
    radon

# https://docs.python.org/ja/3/using/cmdline.html#envvar-PYTHONDONTWRITEBYTECODE (よくわからない)
setenv =
    PYTHONDONTWRITEBYTECODE = 1

# 実行するコマンド: flake8, 実行対象: app ディレクトリ配下
commands = flake8 apps

[flake8]
# 実行対象外リスト。除外するディレクトリを列記する。
# `[testenv:flake8]` セクションに `app` 配下を実行対象とする、と書いてあるので、 `app` の中の `migrations,urls.py,manage.py,settings` 配下は対象外、の意。
exclude = migrations,urls.py,manage.py,settings

max-line-length = 120
max-complexity = 10
radon-max-cc = 10
import-order-style = google

# flake8 警告を抑止するリスト。詳しくは shihmizukawa さんの scrapbox ↓ を参照のこと。
extend-ignore = C901,D100,D101,D102,D103,D104,D105,D200,D202,D203,D204,D205,D208,D209,D210,D300,D301,D302,D400,D401,D402,D403,E741,I100,I101,R701

実行

全部実行する。 tox.ini ファイルのあるディレクトリで実行する!!

$ tox

-e オプションを指定すると、指定した環境のテストのみが実行できる。

# pytest だけ
$ tox -e py27
# pytest だけ, tests/test_target 配下だけ
$ tox -e py27 tests/test_target
# flake8 だけ
$ tox -e flake8
# flake8 と typecheck
$ tox -e flake8, typecheck

tox ではなく、テストコマンドにオプションを渡したい場合は、 -- のあとにオプションを指定する。

$ tox -e py27 -- -vv tests/test_target

テスト用仮想環境の再作成

$ tox -r
  • tox.ini から参照している requirements.txt の中身を変更したあとは、明示的にテスト用仮想環境を再作成する必要がある。

    • tox は、 テスト用の仮想環境を作成するときに、 -rrequirements_dev.txt 引数を内部で pip コマンドに渡して実行する。

      • tox.ini の deps の記述が更新された場合は、テスト用の仮想環境を再作成してくれる。

      • requirements_dev.txt の中身だけ更新されて、deps 自体の更新がない場合は、 仮想環境の再作成も pip コマンドの再実行も行わない。

pytest-pythonpath

テスト実行の前に、 pytests.ini に指定した検索パスを PYTHONPATH に追加してくれるプラグイン