designate/tox.ini
Kiall Mac Innes 4735d2301f Fix all doc warnings and enforce clean docs
* Fixes all doc warnings and errors
* Updates tox.ini to run sphinx with "fail on warnings"
  enabled.

Change-Id: I188733aa5a9de072c52da7269af22c5c1361ec29
2016-04-14 20:34:44 +01:00

118 lines
3.6 KiB
INI

[tox]
minversion = 1.6
envlist = py34,py27,flake8
skipsdist = True
[testenv]
usedevelop = True
install_command = pip install {opts} {packages}
deps = -r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt
setenv =
PYTHONDONTWRITEBYTECODE=1
whitelist_externals = sh
find
rm
commands =
find . -type f -name "*.pyc" -delete
sh tools/pretty_tox.sh '{posargs}'
passenv = http_proxy
HTTP_PROXY
https_proxy
HTTPS_PROXY
no_proxy
NO_PROXY
OS_DEBUG
OS_LOG_CAPTURE
OS_STDERR_CAPTURE
OS_STDOUT_CAPTURE
[testenv:py34]
commands =
ostestr --blacklist_file=tests-py3.txt
[testenv:docs]
commands = rm -rf doc/build
sphinx-build -E -W -b html doc/source doc/build/html
[testenv:cover]
commands = python setup.py testr --coverage --testr-args='{posargs}'
[testenv:bandit]
deps = -r{toxinidir}/test-requirements.txt
commands = bandit -r designate -n5 -x tests -t \
B111,B505,B504,B503,B502,B501,B604,B605,B001,B601,B602,B701,B609,B702,\
B608,B506,B312,B310,B411,B109,B108,B103,B102,B309,B308,B302,B307,B306
[testenv:debug]
commands = oslo_debug_helper {posargs}
[testenv:flake8]
commands = sh tools/pretty_flake8.sh
[testenv:pep8]
basepython = python2.7
commands = sh tools/pretty_flake8.sh
[testenv:pyflakes]
commands = sh tools/pretty_flake8.sh
[testenv:bashate]
deps = bashate
whitelist_externals = bash
commands = bash -c "find {toxinidir}/devstack \
-not \( -type d -name .?\* -prune \) \
-not \( -type d -name doc -prune \) \
-type f \
-not -name \*~ \
-not -name \*.md \
\( \
-name \*.sh -or \
-name \*rc -or \
-name functions\* -or \
-wholename \*/lib/\* \
\) \
-print0 | xargs -0 bashate -v"
[testenv:pip-check-reqs]
# do not install test-requirements as that will pollute the virtualenv for
# determining missing packages
# this also means that pip-missing-reqs must be installed separately, outside
# of the requirements.txt files
deps = pip-check-reqs
-r{toxinidir}/requirements.txt
commands=pip-missing-reqs -d --ignore-file=designate/tests/* designate
[testenv:functional]
usedevelop = False
setenv = VIRTUAL_ENV={envdir}
OS_TEST_PATH=functionaltests/
passenv = TEMPEST_CONFIG
OS_STDOUT_CAPTURE
OS_STDERR_CAPTURE
OS_LOG_CAPTURE
OS_DEBUG
[testenv:releasenotes]
commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[testenv:venv]
commands = {posargs}
[flake8]
# ignored flake8 codes:
# H302 import only modules
# H306 imports not in alphabetical order
# H402 one line docstring needs punctuation
# H404 multi line docstring should start with a summary
# H405 multi line docstring summary not separated with an empty line
# H904 Wrap long lines in parentheses instead of a backslash
# E126 continuation line over-indented for hanging indent
# E128 continuation line under-indented for visual indent
ignore = H302,H306,H402,H404,H405,H904,E126,E128
exclude = .venv,.git,.tox,dist,doc,*openstack/common*,*openstack/deprecated*,*lib/python*,*egg,build,tools,.ropeproject
[hacking]
local-check-factory = designate.hacking.checks.factory