329898ffbc
This adds sample API content for versions and servers resources, including the parameters.yaml that is needed in both of these cases. It also makes a new tox.ini target 'api-ref' for building these docs, which will be used as part of the publishing pipeline. Change-Id: I310ed352dc5dd81d01f2fd5f1a2fab662c29f0dc
157 lines
5.9 KiB
INI
157 lines
5.9 KiB
INI
[tox]
|
|
minversion = 2.0
|
|
envlist = py34,py27,functional,pep8,pip-missing-reqs
|
|
skipsdist = True
|
|
|
|
[testenv]
|
|
usedevelop = True
|
|
# tox is silly... these need to be separated by a newline....
|
|
whitelist_externals = bash
|
|
find
|
|
rm
|
|
install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
OS_TEST_PATH=./nova/tests/unit
|
|
LANGUAGE=en_US
|
|
LC_ALL=en_US.utf-8
|
|
deps = -r{toxinidir}/test-requirements.txt
|
|
commands =
|
|
find . -type f -name "*.pyc" -delete
|
|
bash tools/pretty_tox.sh '{posargs}'
|
|
passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
|
|
# there is also secret magic in pretty_tox.sh which lets you run in a fail only
|
|
# mode. To do this define the TRACE_FAILONLY environmental variable.
|
|
|
|
[testenv:pep8]
|
|
basepython = python2.7
|
|
deps = hacking
|
|
commands =
|
|
bash tools/flake8wrap.sh {posargs}
|
|
# Check that .po and .pot files are valid.
|
|
bash -c "find nova -type f -regex '.*\.pot?' -print0| \
|
|
xargs -0 -n 1 msgfmt --check-format -o /dev/null"
|
|
|
|
[testenv:py34]
|
|
# NOTE(mriedem): If py34 fails with "db type could not be determined", delete
|
|
# .testrepository and try again. Running py34 before py27 is OK, but not the
|
|
# other way around. See: https://bugs.launchpad.net/testrepository/+bug/1212909
|
|
setenv = {[testenv]setenv}
|
|
commands =
|
|
find . -type f -name "*.pyc" -delete
|
|
ostestr --blacklist_file tests-py3.txt
|
|
|
|
[testenv:functional]
|
|
usedevelop = True
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
OS_TEST_PATH=./nova/tests/functional
|
|
LANGUAGE=en_US
|
|
commands =
|
|
find . -type f -name "*.pyc" -delete
|
|
bash tools/pretty_tox.sh '{posargs}'
|
|
|
|
[testenv:api-samples]
|
|
usedevelop = True
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
GENERATE_SAMPLES=True
|
|
PYTHONHASHSEED=0
|
|
OS_TEST_PATH=./nova/tests/functional/api_sample_tests
|
|
LANGUAGE=en_US
|
|
commands =
|
|
find . -type f -name "*.pyc" -delete
|
|
bash tools/pretty_tox.sh '{posargs}'
|
|
|
|
[testenv:genconfig]
|
|
commands = oslo-config-generator --config-file=etc/nova/nova-config-generator.conf
|
|
|
|
[testenv:cover]
|
|
# Also do not run test_coverage_ext tests while gathering coverage as those
|
|
# tests conflict with coverage.
|
|
# NOTE(sdague): this target does not use constraints because
|
|
# upstream infra does not yet support it. Once that's fixed, we can
|
|
# drop the install_command.
|
|
install_command = pip install -U --force-reinstall {opts} {packages}
|
|
commands =
|
|
coverage erase
|
|
python setup.py testr --coverage \
|
|
--testr-args='{posargs}'
|
|
coverage combine
|
|
coverage html --include='nova/*' --omit='nova/openstack/common/*' -d covhtml -i
|
|
|
|
[testenv:venv]
|
|
# NOTE(jaegerandi): This target does not use constraints because
|
|
# upstream infra does not yet support it. Once that's fixed, we can
|
|
# drop the install_command.
|
|
install_command = pip install -U --force-reinstall {opts} {packages}
|
|
commands = {posargs}
|
|
|
|
[testenv:docs]
|
|
commands =
|
|
rm -rf doc/source/api doc/build api-guide/build
|
|
python setup.py build_sphinx
|
|
bash -c '! find doc/ -type f -name *.json | xargs -t -n1 python -m json.tool 2>&1 > /dev/null | grep -B1 -v ^python'
|
|
oslo-config-generator --config-file=etc/nova/nova-config-generator.conf
|
|
sphinx-build -W -b html api-guide/source api-guide/build/html
|
|
sphinx-build -b html api-ref/source api-ref/build/html
|
|
|
|
[testenv:api-guide]
|
|
# This environment is called from CI scripts to test and publish
|
|
# the API Guide to developer.openstack.org.
|
|
# NOTE(sdague): this target does not use constraints because
|
|
# upstream infra does not yet support it. Once that's fixed, we can
|
|
# drop the install_command.
|
|
install_command = pip install -U --force-reinstall {opts} {packages}
|
|
commands =
|
|
sphinx-build -W -b html -d api-guide/build/doctrees api-guide/source api-guide/build/html
|
|
|
|
[testenv:api-ref]
|
|
# This environment is called from CI scripts to test and publish
|
|
# the API Ref to developer.openstack.org.
|
|
# NOTE(sdague): this target does not use constraints because
|
|
# upstream infra does not yet support it. Once that's fixed, we can
|
|
# drop the install_command.
|
|
#
|
|
# we do not used -W here because we are doing some slightly tricky
|
|
# things to build a single page document, and as such, we are ok
|
|
# ignoring the duplicate stanzas warning.
|
|
install_command = pip install -U --force-reinstall {opts} {packages}
|
|
commands =
|
|
sphinx-build -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
|
|
|
|
[testenv:bandit]
|
|
commands = bandit -c bandit.yaml -r nova -n 5 -ll
|
|
|
|
[testenv:releasenotes]
|
|
# NOTE(sdague): this target does not use constraints because
|
|
# upstream infra does not yet support it. Once that's fixed, we can
|
|
# drop the install_command.
|
|
install_command = pip install -U --force-reinstall {opts} {packages}
|
|
commands =
|
|
rm -rf releasenotes/build
|
|
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
|
|
|
[flake8]
|
|
# E125 is deliberately excluded. See https://github.com/jcrocholl/pep8/issues/126
|
|
# The rest of the ignores are TODOs
|
|
# New from hacking 0.9: E129, E131, H407, H405
|
|
# E251 Skipped due to https://github.com/jcrocholl/pep8/issues/301
|
|
|
|
ignore = E121,E122,E123,E124,E125,E126,E127,E128,E129,E131,E251,H405
|
|
exclude = .venv,.git,.tox,dist,doc,*openstack/common/*,*lib/python*,*egg,build,tools/xenserver*,releasenotes
|
|
# To get a list of functions that are more complex than 25, set max-complexity
|
|
# to 25 and run 'tox -epep8'.
|
|
# 34 is currently the most complex thing we have
|
|
# TODO(jogo): get this number down to 25 or so
|
|
max-complexity=35
|
|
|
|
[hacking]
|
|
local-check-factory = nova.hacking.checks.factory
|
|
import_exceptions = nova.i18n
|
|
|
|
[testenv:pip-missing-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_missing_reqs
|
|
commands=pip-missing-reqs -d --ignore-file=nova/tests/* --ignore-file=nova/test.py nova
|