openstack/nova
Code Issues Proposed changes
92bce2558f
nova/tox.ini

240 lines
9.0 KiB
INI
Raw Normal View History

Support tox-based unittests. Change-Id: I6a0a616a979688595762e6b772d77a14f1968070
2012-01-07 19:34:41 -08:00
[tox]
do not pass proxy env variables by tox In an environment where http_proxy env variable is needed to buil a proper python virtualenv the functional test fails with: RuntimeError: http_proxy or https_proxy set in environment, please unset This patch removes passing proxy env varibles in tox.ini to avoid this error. Change-Id: Ia4d8fe952aecb5c3e688878ef0fdafd6fac4fc7a Closes-Bug: #1706545
2017-07-26 11:03:13 +02:00
minversion = 2.1
Remove references to Python 3.4 Now that there exists only a gate job for Python 3.5 and not 3.4, we should remove those references to the 3.4 that is untested. Change-Id: I4716c12a29427d2d101eb5527eb08096c147f333
2017-01-09 10:00:33 -08:00
envlist = py{35,27},functional,pep8,pip-missing-reqs
Have tox install via setup.py develop tox 1.6 was released, which means that we can now take advantage of the feature we added to it - which is using setup.py develop to install the code into the virtualenv. The logic was taken from run_tests.sh - so the performance issues around using tox vs. using install_venv should now be gone. run_tests.sh is still needed to handle the ui switching between parallel, single and debug modes to testr. Change-Id: Ida5e440d1bdb9f8e9031277ea53a02d2ef171438
2013-08-15 14:36:40 -03:00
skipsdist = True
Support tox-based unittests. Change-Id: I6a0a616a979688595762e6b772d77a14f1968070
2012-01-07 19:34:41 -08:00
[testenv]
Have tox install via setup.py develop tox 1.6 was released, which means that we can now take advantage of the feature we added to it - which is using setup.py develop to install the code into the virtualenv. The logic was taken from run_tests.sh - so the performance issues around using tox vs. using install_venv should now be gone. run_tests.sh is still needed to handle the ui switching between parallel, single and debug modes to testr. Change-Id: Ida5e440d1bdb9f8e9031277ea53a02d2ef171438
2013-08-15 14:36:40 -03:00
usedevelop = True
tox: Fix indentation Makes life easier for future, actually important changes. TrivialFix Change-Id: Idda28f153d5054efc885ef2bde0989841df29cd3
2018-03-26 15:02:09 +01:00
whitelist_externals =
bash
find
rm
env
always use pip constraints This flips the tox.ini to always use constraints installation for all targets. It drops the extra -constraints targets in the process. This makes it so there is no developer change required to operate in our new world order. Change-Id: I857032002c2ca873510ce7c39138e0e35cc5d3b3
2016-01-13 13:46:40 -05:00
install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
tox: Fix indentation Makes life easier for future, actually important changes. TrivialFix Change-Id: Idda28f153d5054efc885ef2bde0989841df29cd3
2018-03-26 15:02:09 +01:00
setenv =
VIRTUAL_ENV={envdir}
LANGUAGE=en_US
LC_ALL=en_US.utf-8
OS_STDOUT_CAPTURE=1
OS_STDERR_CAPTURE=1
OS_TEST_TIMEOUT=160
Remove redundant deps in tox.ini. Tox installs the current tree (either via an sdist or as a develop install) always. Our requirements.txt are reflected into the metadata of that tree, so we shouldn't use requirements.txt directly - it just means that we'd be hiding from ourselves issues like e.g. using URLs which can't be reflected properly. Change-Id: Id096f1d1971cb8a19f9e86ba57957b39e00bd6f5
2015-10-16 14:30:59 +13:00
deps = -r{toxinidir}/test-requirements.txt
Update tox.ini to support RHEL 6.x. In order to support running unit tests on RHEL 6.x we need to patch eventlet with contrib/redhat-eventlet.patch. We already have support for this in the tools/install_venv_common.py but we need to make a couple changes to allow tox to consume this: 1) Sync in the latest intall_venv_common.py from oslo. This changes patch to use the -N option (ignore already applied patches) and makes it safe to call the patching function more than once. 2) Add a new patch_tox_venv.py script in tools. 3) Update tox.ini to call patch_tox_venv.py before it runs tests and coverage. Change-Id: I3e2b07c3f718e4aede5c5f231ff0cdb7721ec885
2013-03-06 16:00:37 -05:00
commands =
Revert "tox: Don't create '.pyc' files" This reverts commit 0d6d1616b9a05f1c3e1e34cb235fee327196d423. The PYTHONDONTWRITEBYTECODE setting is ignored in post-v1.6.0 versions of tox due to issues with setuptools [1]. Suffer the performance hit. [1] https://tox.readthedocs.io/en/latest/changelog.html#id21 Change-Id: I99d165f0cc4f5382aef72f21f31bc985585f4748
2016-09-14 10:45:44 +01:00
find . -type f -name "*.pyc" -delete
do not pass proxy env variables by tox In an environment where http_proxy env variable is needed to buil a proper python virtualenv the functional test fails with: RuntimeError: http_proxy or https_proxy set in environment, please unset This patch removes passing proxy env varibles in tox.ini to avoid this error. Change-Id: Ia4d8fe952aecb5c3e688878ef0fdafd6fac4fc7a Closes-Bug: #1706545
2017-07-26 11:03:13 +02:00
passenv = OS_DEBUG GENERATE_HASHES
More usage of ostestr and cleanup an unused dependency Use ostestr as runner instead of the custome pretty_tox.sh script (pretty much removed everywhere). pretty_tox3.sh is just a wrapper for ostestr but it could be probably removed as well going forward. Also remove the tempest-lib dependency, which originally provided subunit-trace (now from os-testr). Change-Id: I4390964ce83167d634b80f696e82a0e199582ce6
2017-02-23 17:38:37 +01:00
# there is also secret magic in subunit-trace which lets you run in a fail only
support TRACE_FAILONLY env variable In order to get similar behavior to the way testr out of the box works, only displaying failing results, all the user to define TRACE_FAILONLY environment variable (any value will do). After this point only failures, and things leaking out of stderr will end up on the screen. We also need to remove the suppression of the inline fail dumps for this to have the impact that you'd expect. Change-Id: I72911adc8a03450522429c52db661ec0a1bc4678
2014-09-24 13:56:49 -04:00
# mode. To do this define the TRACE_FAILONLY environmental variable.
Support tox-based unittests. Change-Id: I6a0a616a979688595762e6b772d77a14f1968070
2012-01-07 19:34:41 -08:00
Explicitly name commands target environments Naming envs like this is breaking the current oslo periodic day job; a simple way to unbreak this is to name them explicitly (which appears to be more common). So this changes the command listing to do just that as well as lists py35 in the envlist (because its a valid target). Change-Id: I2a162604b60df8f18ff53069c6bf99cfecc4217e
2016-10-17 13:53:10 -07:00
[testenv:py27]
commands =
tox: Fix indentation Makes life easier for future, actually important changes. TrivialFix Change-Id: Idda28f153d5054efc885ef2bde0989841df29cd3
2018-03-26 15:02:09 +01:00
{[testenv]commands}
stestr run {posargs}
env TEST_OSPROFILER=1 stestr run --combine --no-discover 'nova.tests.unit.test_profiler'
stestr slowest
Explicitly name commands target environments Naming envs like this is breaking the current oslo periodic day job; a simple way to unbreak this is to name them explicitly (which appears to be more common). So this changes the command listing to do just that as well as lists py35 in the envlist (because its a valid target). Change-Id: I2a162604b60df8f18ff53069c6bf99cfecc4217e
2016-10-17 13:53:10 -07:00
[testenv:py35]
commands =
tox: Fix indentation Makes life easier for future, actually important changes. TrivialFix Change-Id: Idda28f153d5054efc885ef2bde0989841df29cd3
2018-03-26 15:02:09 +01:00
{[testenv]commands}
stestr run --blacklist-file=tests-py3.txt {posargs}
env TEST_OSPROFILER=1 stestr run --combine --no-discover 'nova.tests.unit.test_profiler'
Cleanup running of osprofiler tests Now that we're using stestr directly we have more flexibility on how we run the osprofiler tests. This patch makes it run second without test discovery and combines the subunit output with the results of the previous full test run. Change-Id: I49db096dd3056a4fd2ec6e6603b59e70a8d25480
2017-09-13 17:22:19 -04:00
Enable py36 unit tests in tox With the current super-explicit version of tox.ini, it is not possible to run tox -epy<any version> and have tests discovered and run. This is because the default testenv does not run tests. Therefore, the easiest way to add another version is to simply add another testenv, as done in this change. Python3.6 is the default Python3 on recent distributions so it needs to be present if people are expected to be able to run python3 unit tests before pushing their changes. Change-Id: I728e482af3142bb101fc6bf52ec7926e29a42594
2018-01-16 10:14:46 +00:00
[testenv:py36]
commands =
tox: Fix indentation Makes life easier for future, actually important changes. TrivialFix Change-Id: Idda28f153d5054efc885ef2bde0989841df29cd3
2018-03-26 15:02:09 +01:00
{[testenv]commands}
stestr run --blacklist-file=tests-py3.txt {posargs}
env TEST_OSPROFILER=1 stestr run --combine --no-discover 'nova.tests.unit.test_profiler'
Explicitly name commands target environments Naming envs like this is breaking the current oslo periodic day job; a simple way to unbreak this is to name them explicitly (which appears to be more common). So this changes the command listing to do just that as well as lists py35 in the envlist (because its a valid target). Change-Id: I2a162604b60df8f18ff53069c6bf99cfecc4217e
2016-10-17 13:53:10 -07:00
Support tox-based unittests. Change-Id: I6a0a616a979688595762e6b772d77a14f1968070
2012-01-07 19:34:41 -08:00
[testenv:pep8]
Default to py3 for the pep8 tox env because it's stricter We recently fixed a couple of pep8 failures under py3 [0] which got through because we're not gating pep8 on py3. This changes the python version for the pep8 tox env to python3 because the py3 checks are stricter. This updates the fast8 tox env as well. [0] https://review.openstack.org/#/c/557633 Change-Id: I540377606a8224ba569b8c145773e7d057575bd8
2018-04-03 23:12:52 +00:00
# Let's gate pep8 under py3 by default because the py3 checks are stricter.
basepython = python3
remove flake8-import-order for test requirements - When flake8-import-order is installed the additional ordering tests it provides are enabled by default. - When devstack installs python projects from source such as nova, the pip_install function installs both the requirements.txt and test-requiremets.txt dependencies systemwide. As a result, any python project that runs pep8 tests without a python virtual environment will also have import ordering enforced which may fail. - This change removes flake8-import-order from the test-requirements.txt to prevent failures in projects other than nova that don't enforce pep8 import ordering. Change-Id: I994df178f0000a0840f6658ccc2f277d5503f826
2017-03-14 18:40:36 +00:00
deps = {[testenv]deps}
Switch to flake8+hacking. Remove a bunch of local custom scripts. Replace with configurable external tools. Use local hacking checks for nova specifics. Change-Id: I75a01375ba0ec36d2ff05abc47abe0a3f225eda5
2013-05-17 12:54:12 -07:00
commands =
tox: make it possible to run pep8 on current patch only The 'tox -epep8' command takes a long time as it checks every single file in the Nova git repository (~1,400 at time of writing). This makes tox use a simple wrapper around flake8 which can be told to restrict the check to only files changed in the current command. This can be invoked in a simple manner with 'tox -epep8 -- -HEAD'. Since most commits only touch a handful of files, this will usually be far faster than checking all 1,400 source files. To check an entire branch for bisectability it can be automated via git rebase -i master -x 'tox -epep8 -- -HEAD' Change-Id: I157d1ccb883ca02402eee51fd7d6a50f86079389
2015-07-24 16:05:49 +01:00
bash tools/flake8wrap.sh {posargs}
Duplicate JSON line ending check to pep8 The docs job is not run in the gate, meaning invalid JSON files with \r\n line endings are able to sneak in. Duplicate the checks from the docs environment to the pep8 environment so that gate jobs run it. Note that pep8 is our general linting target and thus should include these kind of tests. Change-Id: Ie923902b04be79b9f66ba1841c60899a413f6439 Closes-Bug: #1673131
2017-03-15 15:57:23 +00:00
# Check that all JSON files don't have \r\n in line.
bash -c "! find doc/ -type f -name *.json | xargs grep -U -n $'\r'"
Move JSON linting to pep8 The docs job is not run in the gate, add the linting command from the docs environment that checks for valid JSON files to the pep8 environement so that jobs run it. Add a simple comment to both invocations to explain what it does. Note that pep8 is our general linting target and thus should include these kind of tests. Change-Id: Ibb2ad29ca59b86fef41ebfe0ec3b8e8ea38e6d72
2016-07-13 13:39:47 +02:00
# Check that all included JSON files are valid JSON
bash -c '! find doc/ -type f -name *.json | xargs -t -n1 python -m json.tool 2>&1 > /dev/null | grep -B1 -v ^python'
Support tox-based unittests. Change-Id: I6a0a616a979688595762e6b772d77a14f1968070
2012-01-07 19:34:41 -08:00
Introduce fast8 tox target The pep8 target has the little known "-HEAD" argument which makes it only run flake8 on the changes since the last change in the history. Even though that's nice, it's sometimes hard to remember the -HEAD argument. Plus pep8 is running some other checks on things like the docs. So if all you want is the pep8 -- -HEAD behavior, this is a simplied convenient form of it. Change-Id: I97b277d8ac95ca3ef8379570e0e3886df26263e1
2017-03-15 13:00:10 -04:00
[testenv:fast8]
Default to py3 for the pep8 tox env because it's stricter We recently fixed a couple of pep8 failures under py3 [0] which got through because we're not gating pep8 on py3. This changes the python version for the pep8 tox env to python3 because the py3 checks are stricter. This updates the fast8 tox env as well. [0] https://review.openstack.org/#/c/557633 Change-Id: I540377606a8224ba569b8c145773e7d057575bd8
2018-04-03 23:12:52 +00:00
# Let's run fast8 under py3 by default because the py3 checks are stricter.
basepython = python3
Introduce fast8 tox target The pep8 target has the little known "-HEAD" argument which makes it only run flake8 on the changes since the last change in the history. Even though that's nice, it's sometimes hard to remember the -HEAD argument. Plus pep8 is running some other checks on things like the docs. So if all you want is the pep8 -- -HEAD behavior, this is a simplied convenient form of it. Change-Id: I97b277d8ac95ca3ef8379570e0e3886df26263e1
2017-03-15 13:00:10 -04:00
# This is a subset of the full pep8 check which
# only runs flake8 on the changes made since
# HEAD-1. For a full flake8 run including checking
# docs, just use pep8.
commands =
bash tools/flake8wrap.sh -HEAD
Add tox -e functional Provide a tox -e functional stub, as a place for functional tests to migrate to. This will allow us to write a zuul test configuration for this environment. Part of bp:functional-tests-for-nova Change-Id: I8a1107beab151f9bf574cfbae1d4dc18400fd74e
2014-11-06 11:32:34 +01:00
[testenv:functional]
Corrects the type of a base64 encoded string The nova/tests/functional/api_sample_tests/test_servers.py contains the ServersSampleBase class, and in its class definition creates a 'user_data' attribute by base64 encoding a string. However, this will not work in Python 3, as the base64.b64encode() method requires bytes, not a string. As a result, importing the test class fails and no tests get run. Note that this change doesn't fix all tests to work under Python 3; it simply fixes the bug that prevents the tests from running at all under Python 3. Closes-Bug: #1632856 Change-Id: I35a7b02132bed0387a173b339f6204bf0e3269de
2016-10-12 20:55:40 +00:00
# TODO(melwitt): This can be removed when functional tests are gating with
# python 3.x
Always use python2.7 for functional tests The functional testenv doesn't work with python 3.x on our codebase. If someone is on a platform that defaults to python => python3, functional tests will fail for them. Closes-Bug: #1632521 Change-Id: I7bf6653f55c10d0a4f75054e519edf7da19c5c09
2016-10-11 23:59:25 +00:00
basepython = python2.7
Make setenv consistent for unit, func, and api-samples Since ostestr switched to running stestr under the covers, we lost the old magic setting of the environment variables via .testr.conf for capturing stderr/stdout and the test timeout. This makes the unit, functional, and api-samples envs consistent with the py27 env that was already updated to set those variables. This also updates the pretty_tox3.sh script to run stestr directly. Change-Id: I27fa9b7e25c1a1dc921653eec84864423f898a85
2017-09-27 20:02:36 +00:00
setenv = {[testenv]setenv}
Add tox -e functional Provide a tox -e functional stub, as a place for functional tests to migrate to. This will allow us to write a zuul test configuration for this environment. Part of bp:functional-tests-for-nova Change-Id: I8a1107beab151f9bf574cfbae1d4dc18400fd74e
2014-11-06 11:32:34 +01:00
commands =
Make setenv consistent for unit, func, and api-samples Since ostestr switched to running stestr under the covers, we lost the old magic setting of the environment variables via .testr.conf for capturing stderr/stdout and the test timeout. This makes the unit, functional, and api-samples envs consistent with the py27 env that was already updated to set those variables. This also updates the pretty_tox3.sh script to run stestr directly. Change-Id: I27fa9b7e25c1a1dc921653eec84864423f898a85
2017-09-27 20:02:36 +00:00
{[testenv]commands}
Finish stestr migration Nova switched to using stestr for all it's in tree testing except for the coverage job. This commit updates that job so it also uses stestr and cleans up the last bits of testr setup left in tree. As part of this change this moves all the one off per job configuration into the tox job definitions instead of hiding it in either the .stestr.conf or in a wrapper script. Change-Id: I36e0e791d485b44641a1ed8770eca8e95aca19be
2017-11-21 19:01:11 -05:00
# NOTE(cdent): The group_regex describes how stestr will group tests into the
# same process when running concurently. The following ensures that gabbi tests
# coming from the same YAML file are all in the same process. This is important
# because each YAML file represents an ordered sequence of HTTP requests. Note
# that tests which do not match this regex will not be grouped in any
# special way. See the following for more details.
# http://stestr.readthedocs.io/en/latest/MANUAL.html#grouping-tests
# https://gabbi.readthedocs.io/en/latest/#purpose
Remove single quotes from posargs on stestr run commands This commit removes the single quotes from all the stestr run commands in the tox.ini. These were originally added as a workaround from the ostestr days to ensure people could run a subset of tests with a regex like: tox -epy27 regex With the switch to stestr this is no longer needed because stestr treats extra arguments as a filter regex. Quoting the posargs has a negative effect because '--' parameters are treated as a string on input instead of a parameter. Fixing this also uncovered another issue in the stestr commands for the functional jobs. The CLI arg for stestr versions <=1.1.0 is --group_regex not --group-regex. This commit fixes this to make those jobs pass without the quotes. Change-Id: I512a517fa6890b29de24060376b4d7e061dc3add
2018-02-16 17:22:59 -05:00
stestr --test-path=./nova/tests/functional --group_regex=nova\.tests\.functional\.api\.openstack\.placement\.test_placement_api(?:\.|_)([^_]+) run {posargs}
Add slowest command to tox.ini This commit adds a printing of the 10 slowest tests during the run at the end of the tox jobs. People have found this useful in the past and ostestr used to do this by defualt. But, now that stestr is used to run tests we need to make this call after a run to retain the output. Change-Id: Ife81963e5ffb63e4ea09817e735eb768d7cf6209
2017-09-26 15:27:35 -04:00
stestr slowest
Add tox -e functional Provide a tox -e functional stub, as a place for functional tests to migrate to. This will allow us to write a zuul test configuration for this environment. Part of bp:functional-tests-for-nova Change-Id: I8a1107beab151f9bf574cfbae1d4dc18400fd74e
2014-11-06 11:32:34 +01:00
Add Python 3.5 functional tests in tox.ini Add Python 3.5 functional tests tox envlist, this is needed by python 3.5 functional tests Jenkins job. Change-Id: I1bba877fcc2c1f2140cbbba2bc6e6c20d7972615
2016-12-08 16:46:57 +08:00
# TODO(gcb) Merge this into [testenv:functional] when functional tests are gating
# with python 3.5
[testenv:functional-py35]
basepython = python3.5
Make setenv consistent for unit, func, and api-samples Since ostestr switched to running stestr under the covers, we lost the old magic setting of the environment variables via .testr.conf for capturing stderr/stdout and the test timeout. This makes the unit, functional, and api-samples envs consistent with the py27 env that was already updated to set those variables. This also updates the pretty_tox3.sh script to run stestr directly. Change-Id: I27fa9b7e25c1a1dc921653eec84864423f898a85
2017-09-27 20:02:36 +00:00
setenv = {[testenv]setenv}
Add Python 3.5 functional tests in tox.ini Add Python 3.5 functional tests tox envlist, this is needed by python 3.5 functional tests Jenkins job. Change-Id: I1bba877fcc2c1f2140cbbba2bc6e6c20d7972615
2016-12-08 16:46:57 +08:00
commands =
tox: Fix indentation Makes life easier for future, actually important changes. TrivialFix Change-Id: Idda28f153d5054efc885ef2bde0989841df29cd3
2018-03-26 15:02:09 +01:00
{[testenv]commands}
Finish stestr migration Nova switched to using stestr for all it's in tree testing except for the coverage job. This commit updates that job so it also uses stestr and cleans up the last bits of testr setup left in tree. As part of this change this moves all the one off per job configuration into the tox job definitions instead of hiding it in either the .stestr.conf or in a wrapper script. Change-Id: I36e0e791d485b44641a1ed8770eca8e95aca19be
2017-11-21 19:01:11 -05:00
# NOTE(cdent): The group_regex describes how stestr will group tests into the
# same process when running concurently. The following ensures that gabbi tests
# coming from the same YAML file are all in the same process. This is important
# because each YAML file represents an ordered sequence of HTTP requests. Note
# that tests which do not match this regex will not be grouped in any
# special way. See the following for more details.
# http://stestr.readthedocs.io/en/latest/MANUAL.html#grouping-tests
# https://gabbi.readthedocs.io/en/latest/#purpose
tox: Fix indentation Makes life easier for future, actually important changes. TrivialFix Change-Id: Idda28f153d5054efc885ef2bde0989841df29cd3
2018-03-26 15:02:09 +01:00
stestr --test-path=./nova/tests/functional --group_regex=nova\.tests\.functional\.api\.openstack\.placement\.test_placement_api(?:\.|_)([^_]+) run {posargs}
Add Python 3.5 functional tests in tox.ini Add Python 3.5 functional tests tox envlist, this is needed by python 3.5 functional tests Jenkins job. Change-Id: I1bba877fcc2c1f2140cbbba2bc6e6c20d7972615
2016-12-08 16:46:57 +08:00
add api-samples tox target api-samples generation is no longer straight forward, now that tox is blocking environment changes, and that PYTHONHASHSEED is randomized in each run. This creates a tox target to make it easy to generate the api-samples. Change-Id: Ie88597fecee5ce81fb29ce2cfb73b15d60f3f389
2015-12-03 17:24:53 -05:00
[testenv:api-samples]
tox: Fix indentation Makes life easier for future, actually important changes. TrivialFix Change-Id: Idda28f153d5054efc885ef2bde0989841df29cd3
2018-03-26 15:02:09 +01:00
setenv =
{[testenv]setenv}
GENERATE_SAMPLES=True
PYTHONHASHSEED=0
add api-samples tox target api-samples generation is no longer straight forward, now that tox is blocking environment changes, and that PYTHONHASHSEED is randomized in each run. This creates a tox target to make it easy to generate the api-samples. Change-Id: Ie88597fecee5ce81fb29ce2cfb73b15d60f3f389
2015-12-03 17:24:53 -05:00
commands =
Revert "tox: Don't create '.pyc' files" This reverts commit 0d6d1616b9a05f1c3e1e34cb235fee327196d423. The PYTHONDONTWRITEBYTECODE setting is ignored in post-v1.6.0 versions of tox due to issues with setuptools [1]. Suffer the performance hit. [1] https://tox.readthedocs.io/en/latest/changelog.html#id21 Change-Id: I99d165f0cc4f5382aef72f21f31bc985585f4748
2016-09-14 10:45:44 +01:00
find . -type f -name "*.pyc" -delete
Remove single quotes from posargs on stestr run commands This commit removes the single quotes from all the stestr run commands in the tox.ini. These were originally added as a workaround from the ostestr days to ensure people could run a subset of tests with a regex like: tox -epy27 regex With the switch to stestr this is no longer needed because stestr treats extra arguments as a filter regex. Quoting the posargs has a negative effect because '--' parameters are treated as a string on input instead of a parameter. Fixing this also uncovered another issue in the stestr commands for the functional jobs. The CLI arg for stestr versions <=1.1.0 is --group_regex not --group-regex. This commit fixes this to make those jobs pass without the quotes. Change-Id: I512a517fa6890b29de24060376b4d7e061dc3add
2018-02-16 17:22:59 -05:00
stestr --test-path=./nova/tests/functional/api_sample_tests run {posargs}
Add slowest command to tox.ini This commit adds a printing of the 10 slowest tests during the run at the end of the tox jobs. People have found this useful in the past and ostestr used to do this by defualt. But, now that stestr is used to run tests we need to make this call after a run to retain the output. Change-Id: Ife81963e5ffb63e4ea09817e735eb768d7cf6209
2017-09-26 15:27:35 -04:00
stestr slowest
add api-samples tox target api-samples generation is no longer straight forward, now that tox is blocking environment changes, and that PYTHONHASHSEED is randomized in each run. This creates a tox target to make it easy to generate the api-samples. Change-Id: Ie88597fecee5ce81fb29ce2cfb73b15d60f3f389
2015-12-03 17:24:53 -05:00
Remove the nova.config.sample file This file is not gated anymore and therefore it gets out of date. Replacing it with a README that explains how to generate it DocImpact Closes-Bug: 1294774 Change-Id: I2a72a005208a2c86d69ac461d72e54c53bd395cf
2014-03-19 10:56:49 -07:00
[testenv:genconfig]
Use oslo-config-generator instead of generate_sample.sh Oslo team is actively getting rid of the old style generator.py in openstack/common/config. So we should switch to the newer oslo-config-generator which is the way forward. For simplicity's sake, i used one single list_opts in opts.py. However we can split this up and add entrypoints in setup.cfg if we decide to do that instead. blueprint oslo-config-generator Change-Id: Ib7c72af7be47df08983708ac6da0ce103518b78c
2015-05-04 23:00:25 -04:00
commands = oslo-config-generator --config-file=etc/nova/nova-config-generator.conf
Remove the nova.config.sample file This file is not gated anymore and therefore it gets out of date. Replacing it with a README that explains how to generate it DocImpact Closes-Bug: 1294774 Change-Id: I2a72a005208a2c86d69ac461d72e54c53bd395cf
2014-03-19 10:56:49 -07:00
Add policy sample generation This adds the entry point and config file necessary for using the oslo.policy sample generation script. It also adds a tox target to simplify the usage of it. The command is also run in the docs tox target since the sample file can be considered documentation. Change-Id: I18a1fa567fc04b0e0a37c02f20024b2ce483f060 Partially-Implements: bp policy-in-code
2016-06-21 16:53:57 -04:00
[testenv:genpolicy]
commands = oslopolicy-sample-generator --config-file=etc/nova/nova-policy-generator.conf
Run coverage tests via xcover for jenkins. In the jenkins jobs, we need to run coverage with xunit output so that jenkins can parse it. Change-Id: Ie4cfec6f89d6b37554b5345cde92f982397915e2
2012-05-25 15:27:03 -04:00
[testenv:cover]
Use testrepository setuptools support. The previous false-positive bug was fixed upstream in 0.0.13. Change-Id: Iceb07a511992249c104bbc7c34b7c35e01bd9fbd
2013-01-15 06:40:47 +00:00
# Also do not run test_coverage_ext tests while gathering coverage as those
# tests conflict with coverage.
Finish stestr migration Nova switched to using stestr for all it's in tree testing except for the coverage job. This commit updates that job so it also uses stestr and cleans up the last bits of testr setup left in tree. As part of this change this moves all the one off per job configuration into the tox job definitions instead of hiding it in either the .stestr.conf or in a wrapper script. Change-Id: I36e0e791d485b44641a1ed8770eca8e95aca19be
2017-11-21 19:01:11 -05:00
setenv = {[testenv]setenv}
PYTHON=coverage run --source nova --parallel-mode
Add -constraints sections for CI jobs Tox does not currently support using factors with sections, and work towards enabling this has stalled, as such we will need to duplicate sections adding -constraints to facilitate running sections with the constrained install_command. Implements Blueprint: Requirements-Management Change-Id: Icbbb78cfcd074b0050e60c54557637af723f9b92
2015-10-19 17:38:17 +11:00
commands =
coverage erase
Remove stale pyc files when running the cover job The cover job runs the unit tests and having stale pycs can skew those results, so remove the pyc files before running the tests with --coverage. Change-Id: I7393d2df36e715dbf53ba9ae6a077bdc8e79b5a5
2016-09-28 11:27:38 -04:00
find . -type f -name "*.pyc" -delete
Remove single quotes from posargs on stestr run commands This commit removes the single quotes from all the stestr run commands in the tox.ini. These were originally added as a workaround from the ostestr days to ensure people could run a subset of tests with a regex like: tox -epy27 regex With the switch to stestr this is no longer needed because stestr treats extra arguments as a filter regex. Quoting the posargs has a negative effect because '--' parameters are treated as a string on input instead of a parameter. Fixing this also uncovered another issue in the stestr commands for the functional jobs. The CLI arg for stestr versions <=1.1.0 is --group_regex not --group-regex. This commit fixes this to make those jobs pass without the quotes. Change-Id: I512a517fa6890b29de24060376b4d7e061dc3add
2018-02-16 17:22:59 -05:00
stestr run {posargs}
Finish stestr migration Nova switched to using stestr for all it's in tree testing except for the coverage job. This commit updates that job so it also uses stestr and cleans up the last bits of testr setup left in tree. As part of this change this moves all the one off per job configuration into the tox job definitions instead of hiding it in either the .stestr.conf or in a wrapper script. Change-Id: I36e0e791d485b44641a1ed8770eca8e95aca19be
2017-11-21 19:01:11 -05:00
coverage combine
coverage html -d cover
coverage xml -o cover/coverage.xml
Enable coverage report Enable coverage report in tox.ini. Change-Id: Ifcb5d5d78e2a06e807050ce18e34e1d1f0fa1972
2017-02-21 19:51:47 +08:00
coverage report
Add -constraints sections for CI jobs Tox does not currently support using factors with sections, and work towards enabling this has stalled, as such we will need to duplicate sections adding -constraints to facilitate running sections with the constrained install_command. Implements Blueprint: Requirements-Management Change-Id: Icbbb78cfcd074b0050e60c54557637af723f9b92
2015-10-19 17:38:17 +11:00
Add debug to tox environment The oslotest package distributes a shell file that may be used to assist in debugging python code. The shell file uses testtools, and supports debugging with pdb. Debug tox environment implements following test instructions. https://wiki.openstack.org/wiki/Testr#Debugging_.28pdb.29_Tests To enable debugging, run tox with the debug environment. Below are the following ways to run it. * tox -e debug module * tox -e debug module.test_class * tox -e debug module.test_class.test_method Change-Id: I08937845803be7bd125b838ab07bda56f202e88d Closes-Bug: 1632486
2016-10-11 21:55:05 +00:00
[testenv:debug]
commands =
find . -type f -name "*.pyc" -delete
oslo_debug_helper {posargs}
Support tox-based unittests. Change-Id: I6a0a616a979688595762e6b772d77a14f1968070
2012-01-07 19:34:41 -08:00
[testenv:venv]
Follow the new PTI for document build The Project Testing Interface [1] asks that we list requirements in 'doc/requirements.txt' and build docs by calling 'sphinx-build' directly instead of via the 'build_sphinx' setuptool/distutils wrapper. Start doing this. [1] https://governance.openstack.org/tc/reference/project-testing-interface.html Change-Id: If9342c8ea757b1735f2488db751008984fb33baf
2018-03-16 10:23:26 +00:00
deps =
-r{toxinidir}/test-requirements.txt
-r{toxinidir}/doc/requirements.txt
Undo tox -e docs pip install sphinx workaround Now that we require at least pbr 1.3 and that has commit 61a3a1ecdf99c680e509742fdc6c441b499af130 in it, let's remove the workaround. Change-Id: I4074b05a823d32f5db0051062527b0db4d379b62 Related-Bug: #1473401
2015-07-15 06:41:21 -07:00
commands = {posargs}
Switch to flake8+hacking. Remove a bunch of local custom scripts. Replace with configurable external tools. Use local hacking checks for nova specifics. Change-Id: I75a01375ba0ec36d2ff05abc47abe0a3f225eda5
2013-05-17 12:54:12 -07:00
Add specific doc build option to tox Add doc venv to align with other OpenStack projects (such as keystone, heat and nova-specs) who are using 'docs' for there doc builds. Change-Id: I37771db339d864b2b938d1c02d15d38b07093493
2014-04-16 16:56:00 -07:00
[testenv:docs]
Follow the new PTI for document build The Project Testing Interface [1] asks that we list requirements in 'doc/requirements.txt' and build docs by calling 'sphinx-build' directly instead of via the 'build_sphinx' setuptool/distutils wrapper. Start doing this. [1] https://governance.openstack.org/tc/reference/project-testing-interface.html Change-Id: If9342c8ea757b1735f2488db751008984fb33baf
2018-03-16 10:23:26 +00:00
deps = -r{toxinidir}/doc/requirements.txt
Cleanup bad JSON files - Add missing commas - Replace single quote with double quote - events field contains a list of events (event-create-req.json) - Remove empty files - Adds a JSON validation test to the docs pipeline Co-Authored-By: Nicolas Simonds <nic@metacloud.com> Change-Id: I9a4a9b6b8e2da73b5f25145be3b2faa44ebdb340
2015-01-21 22:25:10 -05:00
commands =
Structure for simply managing placement-api-ref This consists of a duplicate of the [nova-]api-ref setup and conf.py along with tooling to fail the tox -edocs target when a route that is defined in nova.api.openstack.placement.handler.ROUTE_DECLARATIONS is not present in placement-api-ref/source/index.rst. tools/placement_api_docs.py will report which routes are missing. Though completely gameable (as demonstrated in the current lame index.rst) it's better than nothing and provides some useful structuring on what to do next. It's also the case that the 'docs' target in tox is not part of gating. The response for GET / is in place with the necessary parameters.yaml for it to be correctly described. The 'get-root.json' file provides the JSON of the expected response. The expectation is that later commits will add information for other urls and their JSON files will be named method-path-separated-by-dash.json with a request/response qualifier as necessary. Followup patches will add other routes. A new parameters.yaml is used instead of reusing the one from api-ref as there isn't a lot of expected overlap and having a separate file will ease eventual extraction. Running tox -eplacement-api-ref will generate the docs for review, with output in placement-api-ref/build/html/index.html. This will be hooked up with CI to deploy the generated docs, eventually. Change-Id: Ifb4d91d39db0e49b55952e37cdfc9f63dcd37aa3
2016-12-09 21:47:25 +00:00
rm -rf doc/source/api doc/build api-guide/build api-ref/build placement-api-ref/build
Check that all JSON files don't have \r\n in line The windows edited file may contain \r\n in line, add a check for json files for the docs job. Change-Id: I1ca30be139651ed49eb1f7867616dda6bd080884
2016-12-09 12:00:06 +08:00
# Check that all JSON files don't have \r\n in line.
bash -c "! find doc/ -type f -name *.json | xargs grep -U -n $'\r'"
Move JSON linting to pep8 The docs job is not run in the gate, add the linting command from the docs environment that checks for valid JSON files to the pep8 environement so that jobs run it. Add a simple comment to both invocations to explain what it does. Note that pep8 is our general linting target and thus should include these kind of tests. Change-Id: Ibb2ad29ca59b86fef41ebfe0ec3b8e8ea38e6d72
2016-07-13 13:39:47 +02:00
# Check that all included JSON files are valid JSON
Cleanup bad JSON files - Add missing commas - Replace single quote with double quote - events field contains a list of events (event-create-req.json) - Remove empty files - Adds a JSON validation test to the docs pipeline Co-Authored-By: Nicolas Simonds <nic@metacloud.com> Change-Id: I9a4a9b6b8e2da73b5f25145be3b2faa44ebdb340
2015-01-21 22:25:10 -05:00
bash -c '! find doc/ -type f -name *.json | xargs -t -n1 python -m json.tool 2>&1 > /dev/null | grep -B1 -v ^python'
Follow the new PTI for document build The Project Testing Interface [1] asks that we list requirements in 'doc/requirements.txt' and build docs by calling 'sphinx-build' directly instead of via the 'build_sphinx' setuptool/distutils wrapper. Start doing this. [1] https://governance.openstack.org/tc/reference/project-testing-interface.html Change-Id: If9342c8ea757b1735f2488db751008984fb33baf
2018-03-16 10:23:26 +00:00
# Build docs
sphinx-build -W -b html doc/source doc/build/html
Error on API Guide warnings Error on warnings in building the API guide and fix any problem encountered: * tox.ini: Enable tread warnings as errors * index.rst: Add unreferenced file extra_specs_and_properties as hidden file so that it does not show up in index. It is still built and will be referenced from other files. * general_info.rst: Remove reference to non-existing file * server_concept: Add missing empty line after code directives Also fix a typo and remove extra EOL whitespace. Change-Id: Ie766f8d2f7d82b7b5b02541b342f9829ca4550a0
2016-03-13 21:08:49 +01:00
sphinx-build -W -b html api-guide/source api-guide/build/html
Final warnings removals for api-ref This removes the final warnings from the api-ref code base, and flips the sphinx switch to enforce warnings as errors. It also adds code to the rest_parameters extension to make it more clear where a problem is when it comes to included parameters. This puts us in a place where we can start doing the file per file look at content. Part of bp:api-ref-in-rst Change-Id: Ic2c99d96d6addcafa00b9f16785c2fe59b1798d3
2016-04-20 11:20:05 -04:00
sphinx-build -W -b html api-ref/source api-ref/build/html
Structure for simply managing placement-api-ref This consists of a duplicate of the [nova-]api-ref setup and conf.py along with tooling to fail the tox -edocs target when a route that is defined in nova.api.openstack.placement.handler.ROUTE_DECLARATIONS is not present in placement-api-ref/source/index.rst. tools/placement_api_docs.py will report which routes are missing. Though completely gameable (as demonstrated in the current lame index.rst) it's better than nothing and provides some useful structuring on what to do next. It's also the case that the 'docs' target in tox is not part of gating. The response for GET / is in place with the necessary parameters.yaml for it to be correctly described. The 'get-root.json' file provides the JSON of the expected response. The expectation is that later commits will add information for other urls and their JSON files will be named method-path-separated-by-dash.json with a request/response qualifier as necessary. Followup patches will add other routes. A new parameters.yaml is used instead of reusing the one from api-ref as there isn't a lot of expected overlap and having a separate file will ease eventual extraction. Running tox -eplacement-api-ref will generate the docs for review, with output in placement-api-ref/build/html/index.html. This will be hooked up with CI to deploy the generated docs, eventually. Change-Id: Ifb4d91d39db0e49b55952e37cdfc9f63dcd37aa3
2016-12-09 21:47:25 +00:00
sphinx-build -W -b html placement-api-ref/source placement-api-ref/build/html
Follow the new PTI for document build The Project Testing Interface [1] asks that we list requirements in 'doc/requirements.txt' and build docs by calling 'sphinx-build' directly instead of via the 'build_sphinx' setuptool/distutils wrapper. Start doing this. [1] https://governance.openstack.org/tc/reference/project-testing-interface.html Change-Id: If9342c8ea757b1735f2488db751008984fb33baf
2018-03-16 10:23:26 +00:00
# Test the redirects. This must run after the main docs build
whereto doc/build/html/.htaccess doc/test/redirect-tests.txt
Rearranges to create new Compute API Guide Uses openstackdocstheme to match other content Has a dependent change in project-config also so that file will build to developer.openstack.org/compute at https://review.openstack.org/#/c/231000/ Change-Id: Ic060a1e79e4b2f8695cb788ff4df018e0cfd3286
2015-10-01 17:27:50 -05:00
[testenv:api-guide]
# This environment is called from CI scripts to test and publish
# the API Guide to developer.openstack.org.
Follow the new PTI for document build The Project Testing Interface [1] asks that we list requirements in 'doc/requirements.txt' and build docs by calling 'sphinx-build' directly instead of via the 'build_sphinx' setuptool/distutils wrapper. Start doing this. [1] https://governance.openstack.org/tc/reference/project-testing-interface.html Change-Id: If9342c8ea757b1735f2488db751008984fb33baf
2018-03-16 10:23:26 +00:00
deps = -r{toxinidir}/doc/requirements.txt
Rearranges to create new Compute API Guide Uses openstackdocstheme to match other content Has a dependent change in project-config also so that file will build to developer.openstack.org/compute at https://review.openstack.org/#/c/231000/ Change-Id: Ic060a1e79e4b2f8695cb788ff4df018e0cfd3286
2015-10-01 17:27:50 -05:00
commands =
Error on API Guide warnings Error on warnings in building the API guide and fix any problem encountered: * tox.ini: Enable tread warnings as errors * index.rst: Add unreferenced file extra_specs_and_properties as hidden file so that it does not show up in index. It is still built and will be referenced from other files. * general_info.rst: Remove reference to non-existing file * server_concept: Add missing empty line after code directives Also fix a typo and remove extra EOL whitespace. Change-Id: Ie766f8d2f7d82b7b5b02541b342f9829ca4550a0
2016-03-13 21:08:49 +01:00
sphinx-build -W -b html -d api-guide/build/doctrees api-guide/source api-guide/build/html
Add specific doc build option to tox Add doc venv to align with other OpenStack projects (such as keystone, heat and nova-specs) who are using 'docs' for there doc builds. Change-Id: I37771db339d864b2b938d1c02d15d38b07093493
2014-04-16 16:56:00 -07:00
Add sample API content 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
2016-03-29 11:56:21 -04:00
[testenv:api-ref]
# This environment is called from CI scripts to test and publish
# the API Ref to developer.openstack.org.
Follow the new PTI for document build The Project Testing Interface [1] asks that we list requirements in 'doc/requirements.txt' and build docs by calling 'sphinx-build' directly instead of via the 'build_sphinx' setuptool/distutils wrapper. Start doing this. [1] https://governance.openstack.org/tc/reference/project-testing-interface.html Change-Id: If9342c8ea757b1735f2488db751008984fb33baf
2018-03-16 10:23:26 +00:00
deps = -r{toxinidir}/doc/requirements.txt
Add sample API content 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
2016-03-29 11:56:21 -04:00
commands =
Final warnings removals for api-ref This removes the final warnings from the api-ref code base, and flips the sphinx switch to enforce warnings as errors. It also adds code to the rest_parameters extension to make it more clear where a problem is when it comes to included parameters. This puts us in a place where we can start doing the file per file look at content. Part of bp:api-ref-in-rst Change-Id: Ic2c99d96d6addcafa00b9f16785c2fe59b1798d3
2016-04-20 11:20:05 -04:00
rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
Add sample API content 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
2016-03-29 11:56:21 -04:00
Structure for simply managing placement-api-ref This consists of a duplicate of the [nova-]api-ref setup and conf.py along with tooling to fail the tox -edocs target when a route that is defined in nova.api.openstack.placement.handler.ROUTE_DECLARATIONS is not present in placement-api-ref/source/index.rst. tools/placement_api_docs.py will report which routes are missing. Though completely gameable (as demonstrated in the current lame index.rst) it's better than nothing and provides some useful structuring on what to do next. It's also the case that the 'docs' target in tox is not part of gating. The response for GET / is in place with the necessary parameters.yaml for it to be correctly described. The 'get-root.json' file provides the JSON of the expected response. The expectation is that later commits will add information for other urls and their JSON files will be named method-path-separated-by-dash.json with a request/response qualifier as necessary. Followup patches will add other routes. A new parameters.yaml is used instead of reusing the one from api-ref as there isn't a lot of expected overlap and having a separate file will ease eventual extraction. Running tox -eplacement-api-ref will generate the docs for review, with output in placement-api-ref/build/html/index.html. This will be hooked up with CI to deploy the generated docs, eventually. Change-Id: Ifb4d91d39db0e49b55952e37cdfc9f63dcd37aa3
2016-12-09 21:47:25 +00:00
[testenv:placement-api-ref]
# This environment is called from CI scripts to test and publish
# the Placement API Ref to developer.openstack.org.
Follow the new PTI for document build The Project Testing Interface [1] asks that we list requirements in 'doc/requirements.txt' and build docs by calling 'sphinx-build' directly instead of via the 'build_sphinx' setuptool/distutils wrapper. Start doing this. [1] https://governance.openstack.org/tc/reference/project-testing-interface.html Change-Id: If9342c8ea757b1735f2488db751008984fb33baf
2018-03-16 10:23:26 +00:00
deps = -r{toxinidir}/doc/requirements.txt
Structure for simply managing placement-api-ref This consists of a duplicate of the [nova-]api-ref setup and conf.py along with tooling to fail the tox -edocs target when a route that is defined in nova.api.openstack.placement.handler.ROUTE_DECLARATIONS is not present in placement-api-ref/source/index.rst. tools/placement_api_docs.py will report which routes are missing. Though completely gameable (as demonstrated in the current lame index.rst) it's better than nothing and provides some useful structuring on what to do next. It's also the case that the 'docs' target in tox is not part of gating. The response for GET / is in place with the necessary parameters.yaml for it to be correctly described. The 'get-root.json' file provides the JSON of the expected response. The expectation is that later commits will add information for other urls and their JSON files will be named method-path-separated-by-dash.json with a request/response qualifier as necessary. Followup patches will add other routes. A new parameters.yaml is used instead of reusing the one from api-ref as there isn't a lot of expected overlap and having a separate file will ease eventual extraction. Running tox -eplacement-api-ref will generate the docs for review, with output in placement-api-ref/build/html/index.html. This will be hooked up with CI to deploy the generated docs, eventually. Change-Id: Ifb4d91d39db0e49b55952e37cdfc9f63dcd37aa3
2016-12-09 21:47:25 +00:00
commands =
# Check that all placement api routes are in the documentation
[placement] Make placement_api_docs.py failing If there is no api reference for some placement API method tox -e placement-api-ref will fail now. Change-Id: Ifefedcd51f1f8d5e741ef6d02b7a0879a185e05f
2017-07-06 12:09:16 +03:00
python tools/placement_api_docs.py placement-api-ref/source/
Structure for simply managing placement-api-ref This consists of a duplicate of the [nova-]api-ref setup and conf.py along with tooling to fail the tox -edocs target when a route that is defined in nova.api.openstack.placement.handler.ROUTE_DECLARATIONS is not present in placement-api-ref/source/index.rst. tools/placement_api_docs.py will report which routes are missing. Though completely gameable (as demonstrated in the current lame index.rst) it's better than nothing and provides some useful structuring on what to do next. It's also the case that the 'docs' target in tox is not part of gating. The response for GET / is in place with the necessary parameters.yaml for it to be correctly described. The 'get-root.json' file provides the JSON of the expected response. The expectation is that later commits will add information for other urls and their JSON files will be named method-path-separated-by-dash.json with a request/response qualifier as necessary. Followup patches will add other routes. A new parameters.yaml is used instead of reusing the one from api-ref as there isn't a lot of expected overlap and having a separate file will ease eventual extraction. Running tox -eplacement-api-ref will generate the docs for review, with output in placement-api-ref/build/html/index.html. This will be hooked up with CI to deploy the generated docs, eventually. Change-Id: Ifb4d91d39db0e49b55952e37cdfc9f63dcd37aa3
2016-12-09 21:47:25 +00:00
rm -rf placement-api-ref/build
sphinx-build -W -b html -d placement-api-ref/build/doctrees placement-api-ref/source placement-api-ref/build/html
Add bandit for security static analysis testing This change adds a basic bandit config for Nova. It can be invoked by running the tox environment for bandit; tox -e bandit This is intended as a starting point for using bandit with Nova and it should be revisited to improve the testing as more is learned about the specific needs of the Nova code base. Tox is configured to only show results for high and medium severity results. https://wiki.openstack.org/wiki/Security/Projects/Bandit Change-Id: I3026b81317f0a6322acfc94784899a7453af586f
2015-05-01 23:52:34 -07:00
[testenv:bandit]
Remove bandit.yaml in favor of defaults With the latest version of bandit, the bandit.yaml is only necessary for advanced tweaking. Change-Id: I933a5389865fe577925ce3be30877ceae12fad31
2016-02-10 09:48:50 -08:00
# NOTE(browne): This is required for the integration test job of the bandit
# project. Please do not remove.
commands = bandit -r nova -x tests -n 5 -ll
Add bandit for security static analysis testing This change adds a basic bandit config for Nova. It can be invoked by running the tox environment for bandit; tox -e bandit This is intended as a starting point for using bandit with Nova and it should be revisited to improve the testing as more is learned about the specific needs of the Nova code base. Tox is configured to only show results for high and medium severity results. https://wiki.openstack.org/wiki/Security/Projects/Bandit Change-Id: I3026b81317f0a6322acfc94784899a7453af586f
2015-05-01 23:52:34 -07:00
Add reno for release notes management Since reno is the new tool for Relnotes [1], we need to add it to Nova and provide some Sphinx docs for Liberty and Mitaka. Change-Id: Ibd74e62b6f36076dbec17dd146632fd42aad6eb2
2015-11-05 12:12:28 +01:00
[testenv:releasenotes]
Follow the new PTI for document build The Project Testing Interface [1] asks that we list requirements in 'doc/requirements.txt' and build docs by calling 'sphinx-build' directly instead of via the 'build_sphinx' setuptool/distutils wrapper. Start doing this. [1] https://governance.openstack.org/tc/reference/project-testing-interface.html Change-Id: If9342c8ea757b1735f2488db751008984fb33baf
2018-03-16 10:23:26 +00:00
deps = -r{toxinidir}/doc/requirements.txt
Reminder that release notes are built from commits This patch introduces a new tools/releasenotes_tox.sh script for the tox -e releasenotes test environment. It will detect when there are uncommitted release notes and print a reminder to commit them. Change-Id: I54af12d7eb20b37263e23443900745884cffacea
2016-07-06 14:39:57 -04:00
commands = bash -c tools/releasenotes_tox.sh
Add reno for release notes management Since reno is the new tool for Relnotes [1], we need to add it to Nova and provide some Sphinx docs for Liberty and Mitaka. Change-Id: Ibd74e62b6f36076dbec17dd146632fd42aad6eb2
2015-11-05 12:12:28 +01:00
Switch to flake8+hacking. Remove a bunch of local custom scripts. Replace with configurable external tools. Use local hacking checks for nova specifics. Change-Id: I75a01375ba0ec36d2ff05abc47abe0a3f225eda5
2013-05-17 12:54:12 -07:00
[flake8]
update wording around pep8 exceptions At least once a cycle we get contributions from new folks that attempt to update a bunch of pep8 formatting. They believe that this is in good faith helping, but don't realize we really aren't likely to accept that. Update the text here to explain that more clearly, so that people don't keep falling down this rabbit hole. Change-Id: Iec383a18cb3d64b9655e5bd1d82cabd3e785686c
2016-08-04 11:31:56 -04:00
# E125 is deliberately excluded. See
# https://github.com/jcrocholl/pep8/issues/126. It's just wrong.
#
# Most of the whitespace related rules (E12* and E131) are excluded
# because while they are often useful guidelines, strict adherence to
# them ends up causing some really odd code formatting and forced
# extra line breaks. Updating code to enforce these will be a hard sell.
#
# H405 is another one that is good as a guideline, but sometimes
# multiline doc strings just don't have a natural summary
# line. Rejecting code for this reason is wrong.
#
Cleanup and gate on pep8 rules that are stricter in hacking 0.9 Fix up pep8 failures for rules we previously gated on, but that are now stricter in there enforcement. Ignore E251 due to https://github.com/jcrocholl/pep8/issues/301 Change-Id: I62b33e97c44c4a5be436b381cfbdaeb31cd2638b
2014-06-09 14:45:26 -07:00
# E251 Skipped due to https://github.com/jcrocholl/pep8/issues/301
Cleanup the flake8 section of tox.ini * Stop ignoring F403 as we have no cases of it anyway * Cleanup the comments to make it clear what is ignored on purpose and what is ignored until we clean up the code. Change-Id: I2500e2db70b9c71fbed781d8f7b7c80eee45140f
2013-12-11 19:18:53 +01:00
Enable global hacking checks and removed local checks In this patchset, I set up 'enabled-extensions' in flake8 section of tox.ini. In newer hacking versions, we can enable some of the non-default hacking rules (one by one), which are disabled by default and implemented in the newer versions of hacking. The enabled extensions are the following: * [H106] Don’t put vim configuration in source files (off by default). * [H203] Use assertIs(Not)None to check for None (off by default). * [H904] Delay string interpolations at logging calls (off by default). Together with enabling these rules, I also removed the locally implemented versions of them. Due to limitations of local checking engine, there were some places in the tests, where pep8 failed. In this patchset, these codes are also fixed. Change-Id: I3a9d2dc007a269cdb2cad441e22f5eb9b58ce0a0
2017-02-08 16:41:31 +01:00
enable-extensions = H106,H203,H904
Revert : Switch off oslo.* namespace check temporarily In I7033847bab82b6d3cd8f2bdb66c553fec93d7acb, we disabled N333 to allow changes in flight to still mix up oslo_ and oslo. based imports. We should revert the change and enforce every review use just the oslo_ version from now on. Change-Id: I1db83048c569bcdd62538cce9df076fc355f7b26
2015-02-09 17:34:09 -05:00
ignore = E121,E122,E123,E124,E125,E126,E127,E128,E129,E131,E251,H405
doc: Enable pep8 on doc generation code As pep8 does not run on doc generation python code so we have some style violations there. As it not too hard to fix the problems and therefore enable pep8 on these files this patch proposes such a change. Change-Id: I26104ea66fc4f3e67f8227025f43202e483beb25
2017-07-12 10:40:37 +01:00
exclude = .venv,.git,.tox,dist,*lib/python*,*egg,build,tools/xenserver*,releasenotes
Drop max-complexity to 47 Now that we fixed the two worst offenders, drop the mccabe max-complexity setting in flake8 to 47. Add note explaining how to generate a list of functions that are too 'complex'. Change-Id: I44000e9e95c457ae9000c428460b5825d8ad3f92
2014-10-29 12:22:29 -07:00
# To get a list of functions that are more complex than 25, set max-complexity
# to 25 and run 'tox -epep8'.
Tox: reduce complexity level to 35 The max-complexity is now set at 35. We are unable to lower this due to the following offenders: ./nova/virt/xenapi/vmops.py:431:1: C901 'VMOps._spawn' is too complex (34) ./nova/network/manager.py:1226:1: C901 'NetworkManager._do_create_networks' is too complex (34) ./nova/network/neutronv2/api.py:370:1: C901 'API.allocate_for_instance' is too complex (34) Change-Id: I6101dcb594b88d346edd72eea2ef2250c4e2891f
2015-03-18 01:58:30 -07:00
# 34 is currently the most complex thing we have
Put a cap on our cyclomatic complexity flake8 has support for cyclomatic complexity (Mccabe) currently our worst offender has a complexity of 67 (25 is considered very bad). So set our max-complexity to 68 so we at least don't make things any worse. This is the first step in bringing this number down to 25 or so. https://github.com/flintwork/mccabe Change-Id: I5117ca58ad28888e24c16251aa5e92084ead97ca
2014-10-16 21:04:08 -07:00
# TODO(jogo): get this number down to 25 or so
Tox: reduce complexity level to 35 The max-complexity is now set at 35. We are unable to lower this due to the following offenders: ./nova/virt/xenapi/vmops.py:431:1: C901 'VMOps._spawn' is too complex (34) ./nova/network/manager.py:1226:1: C901 'NetworkManager._do_create_networks' is too complex (34) ./nova/network/neutronv2/api.py:370:1: C901 'API.allocate_for_instance' is too complex (34) Change-Id: I6101dcb594b88d346edd72eea2ef2250c4e2891f
2015-03-18 01:58:30 -07:00
max-complexity=35
Switch to flake8+hacking. Remove a bunch of local custom scripts. Replace with configurable external tools. Use local hacking checks for nova specifics. Change-Id: I75a01375ba0ec36d2ff05abc47abe0a3f225eda5
2013-05-17 12:54:12 -07:00
[hacking]
local-check-factory = nova.hacking.checks.factory
Use oslo.i18n oslo.i18n provides the i18n functions that were provided by oslo-incubator's gettextutils module. Some tests that were using internal details of the library were removed. Change-Id: I44cfd5552e0dd86af21073419d31622f5fdb28e0
2014-07-11 21:03:15 -04:00
import_exceptions = nova.i18n
Check requirements.txt files for missing (used) requirements Invoke the pip-missing-reqs tool to find packages used by nova but not explicitly included in its requirements.txt file. Add simplejson to the requirements to fix the failing check. Change-Id: Ia90416c613c0acea04f3d4ab4898f550cb702a49
2014-08-14 15:06:00 +10:00
[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
Switch from pip_missing_reqs to pip_check_reqs The pip_missing_reqs tool is abandoned and now incompatible with recent versions of pip. It has been supplanted by the pip_check_reqs tool which provides the same pip-missing-reqs entrypoint (plus some others), effectively renamed. https://github.com/r1chardj0n3s/pip-check-reqs/commit/99c5628 https://ask.openstack.org/question/105026 Change-Id: I3fab8439891fab7ca837230dfccf89e4c0a7190c
2017-04-04 14:43:17 +00:00
deps = pip_check_reqs
Fix pip-missing-reqs The gate-nova-pip-missing-reqs job on the experimental queue is failing and pointing out several missing runtime dependencies from requirements.txt. Also, we need to ignore the nova/test.py file during the scan since pip-missing-reqs doesn't include test-requirements.txt. requests -------- nova/scheduler/filters/trusted_filter.py:50 dist=requests nova/api/ec2/__init__.py:30 dist=requests prettytable ----------- nova/openstack/common/cliutils.py:29 dist=prettytable python-keystoneclient --------------------- nova/context.py:22 dist=python-keystoneclient nova/network/neutronv2/api.py:21 dist=python-keystoneclient nova/compute/manager.py:42 dist=python-keystoneclient nova/volume/cinder.py:27 dist=python-keystoneclient nova/context.py:23 dist=python-keystoneclient nova/network/neutronv2/api.py:23 dist=python-keystoneclient nova/network/neutronv2/api.py:24 dist=python-keystoneclient nova/volume/cinder.py:28 dist=python-keystoneclient nova/keymgr/barbican.py:25 dist=python-keystoneclient nova/network/neutronv2/api.py:22 dist=python-keystoneclient netifaces --------- nova/compute/utils.py:21 dist=netifaces setuptools ---------- nova/openstack/common/versionutils.py:26 dist=setuptools nova/virt/xenapi/image/bittorrent.py:18 dist=setuptools Closes-Bug: #1453857 Change-Id: If880d76cf3e47c14b370d63313330996e09f5ab8
2015-05-14 11:37:28 -07:00
commands=pip-missing-reqs -d --ignore-file=nova/tests/* --ignore-file=nova/test.py nova
List system dependencies for running common tests Add a bindep.txt file containing a cross-platform list of dependencies needed for running included tox-based tests. Also include a tox environment for convenience calling the bindep[*] utility to list any missing system requirements, and simplify the contributor documentation to recommend this rather than embedding an ad-hoc list of package names in an untestable document. This change is self-testing. [*] http://docs.openstack.org/infra/bindep/ Change-Id: I7c18b0921c39b99df89f2c356208303c2bad5a97
2015-07-10 18:38:51 +00:00
[testenv:bindep]
# Do not install any requirements. We want this to be fast and work even if
# system dependencies are missing, since it's used to tell you what system
# dependencies are missing! This also means that bindep must be installed
# separately, outside of the requirements files, and develop mode disabled
# explicitly to avoid unnecessarily installing the checked-out repo too (this
# further relies on "tox.skipsdist = True" above).
deps = bindep
commands = bindep test
usedevelop = False
Copy Permalink