openstack/ironic
Code Issues Proposed changes
10ee7c816d
ironic/tox.ini

70 lines
1.8 KiB
INI
Raw Normal View History

Added project infrastructure needs.
2013-05-02 14:50:57 -04:00
[tox]
Add constraint target to tox.ini This adds a pip install command to tox.ini that is only used when the tox env is passed with the 'constraints' factor appended onto it. As such this will not effect developer workflows or current unit tests. The initial use of this will be in a non-voting job, to verify that the constrained checks with tox are stable. DevStack is already running constrained jobs, as such problems are not expected. To run a tox with pip using constraints on a developer system a developer should run the desired tox environment with -constraints. For example: $(tox -epy27-constraints) Pip will pull the current version of the upper-constraints.txt file down from the git.openstack.org, however this method can be overriden to use a local file setting the environment variable "UPPER_CONSTRAINTS_FILE" to the local path or a different URL, it is passed directly to pip. This is currently not enabled in the default tox run, however it is possible to enable it as a default by adding it to 'envlist' in tox.ini Backport of Nova commit ad38ce1fc98692ee59ef061de1a35f355d219aa1 Change-Id: Ia3cfb30fd1d8529bb4fbcf8873036149ea6f483c Implements Blueprint: Requirements-Management
2015-09-04 11:57:16 -07:00
minversion = 1.8
Upgrade tox to 1.6 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. Change-Id: Ib011a9add595696f5db5fe596db9d3d60f46d038 Fixes-Bug: #1233213
2013-09-30 22:55:00 +08:00
skipsdist = True
Put py34 first in the env order of tox To solve the problem of "db type could not be determined" on py34 we have to run first the py34 env to, then, run py27. This patch puts py34 first on the tox.ini list of envs to avoid this problem to happen. Change-Id: Ib09cbc71149ffcc1f36495faf1c6586c4e0a0a86 Closes-bug: #1489059
2015-08-26 12:58:56 -03:00
envlist = py34,py27,pep8
Added project infrastructure needs.
2013-05-02 14:50:57 -04:00
[testenv]
Upgrade tox to 1.6 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. Change-Id: Ib011a9add595696f5db5fe596db9d3d60f46d038 Fixes-Bug: #1233213
2013-09-30 22:55:00 +08:00
usedevelop = True
Add constraint target to tox.ini This adds a pip install command to tox.ini that is only used when the tox env is passed with the 'constraints' factor appended onto it. As such this will not effect developer workflows or current unit tests. The initial use of this will be in a non-voting job, to verify that the constrained checks with tox are stable. DevStack is already running constrained jobs, as such problems are not expected. To run a tox with pip using constraints on a developer system a developer should run the desired tox environment with -constraints. For example: $(tox -epy27-constraints) Pip will pull the current version of the upper-constraints.txt file down from the git.openstack.org, however this method can be overriden to use a local file setting the environment variable "UPPER_CONSTRAINTS_FILE" to the local path or a different URL, it is passed directly to pip. This is currently not enabled in the default tox run, however it is possible to enable it as a default by adding it to 'envlist' in tox.ini Backport of Nova commit ad38ce1fc98692ee59ef061de1a35f355d219aa1 Change-Id: Ia3cfb30fd1d8529bb4fbcf8873036149ea6f483c Implements Blueprint: Requirements-Management
2015-09-04 11:57:16 -07:00
install_command =
constraints: pip install -U --force-reinstall -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
pip install -U {opts} {packages}
Added project infrastructure needs.
2013-05-02 14:50:57 -04:00
setenv = VIRTUAL_ENV={envdir}
Don't write python bytecode while testing This patch was based on the Nova patch: https://review.openstack.org/#/c/121044 This should reduce the number of times you need to completely delete your tox dir because you have stale pyc files around. In Ironic we have hit this problem a number of times, migrating to oslo.message was a big one that caused a lot of confusion. Closes-Bug: #1368661 Change-Id: I7dda3ad879beff1e494a36144c941a847177c2ef
2014-09-12 12:04:50 +01:00
PYTHONDONTWRITEBYTECODE = 1
Force LANGUAGE=en_US in test runs Basically back-porting what was done for Nova in this patch: https://review.openstack.org/#/c/160892/ If your native locale is not en_US and you run tests, some could fail due to the message translation that happens since the assertion messages are in en_US (not translated, just hard-coded in the tests). Note that setting LANG=en_US had no effect. Change-Id: I16fab554612a718871625f688dd5501a69fb3417
2015-03-13 08:42:51 -07:00
LANGUAGE=en_US
Remove requirements.txt from tox.ini deps This is redundant, per lifeless email: http://lists.openstack.org/pipermail/openstack-dev/2015-July/069663.html Change-Id: Ie78d0e5b2fc8274867f2c6013b04ae9e0796f81f
2015-07-15 18:31:29 -07:00
deps = -r{toxinidir}/test-requirements.txt
Check that all po/pot files are valid Perform minimal checks on po and pot files so that no broken files can get imported. Change-Id: I328fc11c688c16737ae88984e4778483ce5db5ab Co-Authored-By: Clark Boylan <clark.boylan@gmail.com> Related-Bug: #1298645
2014-03-31 20:42:46 +02:00
whitelist_externals = bash
Update tox.ini to also run nova tests This updates testr.conf to allow passing of the tests directory as an environment variable (defaulting to ironic/tests/). Also updates tox.ini to run testr once for ironic/tests and once for ironic/nova/tests/, then combine subunit output. test-requirements.txt is updated to pull in Nova from a tarball, as well as mox and python-ironicclient. Updates the existing Nova driver unit tests to account for recent refactoring and changes in the Nova virt API. Change-Id: Ibefa2e0d3f97512f4da9ace780703fe47467232e Closes-bug: #1299312
2014-03-30 16:14:16 -07:00
commands =
bash -c "TESTS_DIR=./ironic/tests/ python setup.py testr --slowest --testr-args='{posargs}'"
Pass environment variables of proxy to tox When a development environment is under a proxy, tox is failed even if environment variables of the proxy are set. This patch fix this problem. Change-Id: I650019ae86e223d5e9c2d4a5b51b92377f3c471e
2015-06-15 09:59:20 +09:00
passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
Check that all po/pot files are valid Perform minimal checks on po and pot files so that no broken files can get imported. Change-Id: I328fc11c688c16737ae88984e4778483ce5db5ab Co-Authored-By: Clark Boylan <clark.boylan@gmail.com> Related-Bug: #1298645
2014-03-31 20:42:46 +02:00
Added project infrastructure needs.
2013-05-02 14:50:57 -04:00
[tox:jenkins]
downloadcache = ~/cache/pip
Add a venv that can generate/write/update the states diagram Instead of requiring manual understanding of how to generate the states diagram, add an explicit virtualenv that can be used to create and generate that docs diagram (and replace the existing file with it). Change-Id: I1738da9bf08bfda9b9be01489e8456569a31709e
2015-04-27 11:00:29 -07:00
[testenv:genstates]
deps = {[testenv]deps}
pydot2
Use svg as it looks better/scales better than png Change-Id: I2a17b5ddbe90fe8ea1ead53497e4dfcac5bf5647
2015-06-03 16:56:08 -07:00
commands = {toxinidir}/tools/states_to_dot.py -f {toxinidir}/doc/source/images/states.svg --format svg
Add a venv that can generate/write/update the states diagram Instead of requiring manual understanding of how to generate the states diagram, add an explicit virtualenv that can be used to create and generate that docs diagram (and replace the existing file with it). Change-Id: I1738da9bf08bfda9b9be01489e8456569a31709e
2015-04-27 11:00:29 -07:00
Added project infrastructure needs.
2013-05-02 14:50:57 -04:00
[testenv:pep8]
commands =
Remove extra pep8/flake8/pyflakes requirements pep8 flake8 and pyflakes are pinned as part of hacking. So they don't need to be pinned here as well. Also add posargs to flake8, so can do things like 'tox -epep8 -- --statistics' Change-Id: Id37949caa5a487cd98b6b85c026689fbd63cb5d8
2013-07-22 16:07:06 -07:00
flake8 {posargs}
Check that all po/pot files are valid Perform minimal checks on po and pot files so that no broken files can get imported. Change-Id: I328fc11c688c16737ae88984e4778483ce5db5ab Co-Authored-By: Clark Boylan <clark.boylan@gmail.com> Related-Bug: #1298645
2014-03-31 20:42:46 +02:00
# Check that .po and .pot files are valid:
Use xargs -0 instead of --null This gives compatibility with OS X in the test. Change-Id: I483b4279d0d6a5a6fe4f81b9fb07a838e17e1b0f
2014-04-03 20:25:43 +02:00
bash -c "find ironic -type f -regex '.*\.pot?' -print0|xargs -0 -n 1 msgfmt --check-format -o /dev/null"
Added project infrastructure needs.
2013-05-02 14:50:57 -04:00
[testenv:cover]
setenv = VIRTUAL_ENV={envdir}
Force LANGUAGE=en_US in test runs Basically back-porting what was done for Nova in this patch: https://review.openstack.org/#/c/160892/ If your native locale is not en_US and you run tests, some could fail due to the message translation that happens since the assertion messages are in en_US (not translated, just hard-coded in the tests). Note that setting LANG=en_US had no effect. Change-Id: I16fab554612a718871625f688dd5501a69fb3417
2015-03-13 08:42:51 -07:00
LANGUAGE=en_US
Added project infrastructure needs.
2013-05-02 14:50:57 -04:00
commands =
python setup.py testr --coverage {posargs}
Stop running check_uptodate in the pep8 testenv As per this discussion on the mailing list: http://lists.openstack.org/pipermail/openstack-dev/2014-September/047160.html We are going to stop enforcing the correctness of the sample config file, and move to a separate non-voting check test that notifies us when it is no longer accurate, thus prompting a human to correct it. This addresses the issue where config options in dependent libraries (eg. keystone) repeatedly break our gate, without removing the sample config file that deployers benefit from. Change-Id: Ief88a693e4967b32f5f2f71b9a683599527a5129
2014-09-29 15:59:36 -07:00
[testenv:checkconfig]
sitepackages = False
envdir = {toxworkdir}/venv
commands =
{toxinidir}/tools/config/check_uptodate.sh
Add genconfig tox job for sample config file generation If someone tries to run generate_sample.sh outside a venv or without installing project dependencies, you could encounter error messages related to missing or outdated dependencies. This change wraps generate_sample.sh execution in tox. Wrapping it in a tox job makes sure all dependencies found in requirements.txt and test-requirements.txt are properly installed prior to its execution. This change does not propose the removal of the sample config file already in place in the repository and it does not propose adding it to the list of jobs automatically ran by tox. This change is merely the introduction of a more convenient way to execute generate_sample.sh in a proper venv. You can now (re)generate the sample config file with this tox job: tox -egenconfig Change-Id: I1058a306a462ba8349a4433c78070fabd6d03e39
2014-06-20 13:53:17 -04:00
[testenv:genconfig]
Stop running check_uptodate in the pep8 testenv As per this discussion on the mailing list: http://lists.openstack.org/pipermail/openstack-dev/2014-September/047160.html We are going to stop enforcing the correctness of the sample config file, and move to a separate non-voting check test that notifies us when it is no longer accurate, thus prompting a human to correct it. This addresses the issue where config options in dependent libraries (eg. keystone) repeatedly break our gate, without removing the sample config file that deployers benefit from. Change-Id: Ief88a693e4967b32f5f2f71b9a683599527a5129
2014-09-29 15:59:36 -07:00
sitepackages = False
envdir = {toxworkdir}/venv
Add genconfig tox job for sample config file generation If someone tries to run generate_sample.sh outside a venv or without installing project dependencies, you could encounter error messages related to missing or outdated dependencies. This change wraps generate_sample.sh execution in tox. Wrapping it in a tox job makes sure all dependencies found in requirements.txt and test-requirements.txt are properly installed prior to its execution. This change does not propose the removal of the sample config file already in place in the repository and it does not propose adding it to the list of jobs automatically ran by tox. This change is merely the introduction of a more convenient way to execute generate_sample.sh in a proper venv. You can now (re)generate the sample config file with this tox job: tox -egenconfig Change-Id: I1058a306a462ba8349a4433c78070fabd6d03e39
2014-06-20 13:53:17 -04:00
commands =
bash tools/config/generate_sample.sh -b . -p ironic -o etc/ironic
Rename gendocs tox environment All other openstack projects use docs environment, use the same name for ironic as well. Change-Id: I46fd50da89c3247bffefc9c971f8eda309bbe9bd
2015-05-20 16:36:35 +02:00
[testenv:docs]
Set hash seed to 0 in gendocs environment This was done in the venv environment to fix docs builds in the gate, but they still fail randonly locally when using the tox environment to build them. This change ensures the gendocs environment works for generating documentation locally. Change-Id: I41e4af9edaaa76b837a6c92a296b5738c85b632b
2015-04-07 13:32:53 -07:00
setenv = PYTHONHASHSEED=0
Add gendocs tox job for generating the documentation We already use tox to generate the sample configuration, run the tests, etc.. This patch is adding a new 'gendocs' tox job for generating the documentation. I always have a hard time remembering the syntax to generate the docs, by adding it to tox I hope it may facilitate it a bit. You can now (re)generate the docs with this tox job: tox -egendocs The quick start guide was also updated with the new command. Change-Id: I6a755c31382310420d706e51a3e014941fd49872
2014-11-14 17:14:19 +00:00
sitepackages = False
envdir = {toxworkdir}/venv
commands =
python setup.py build_sphinx
Added project infrastructure needs.
2013-05-02 14:50:57 -04:00
[testenv:venv]
Set PYTHONHASHSEED for venv tox environment We're seeing frequent failures of the docs Jenkins job that appear to be caused by the tox 1.7.2 upgrade and the migration to using PYTHONHASHSEED=random. This overrides the environment in the venv testenv to set PYTHONHASHSEED=0 and allows docs to build successfully. Note that we want to run our tests with a random seed if possible, so this avoids disabling it for the base testenv and only uses non-random for the testenv used by Jenkins for doc builds. Change-Id: I665703c9a002500bc90b90cd268bd3ccff4e3534 Closes-bug: 1361295
2014-08-25 12:48:10 -07:00
setenv = PYTHONHASHSEED=0
Added project infrastructure needs.
2013-05-02 14:50:57 -04:00
commands = {posargs}
[flake8]
Enforce flake8 E711 This patch enforces the rules E711 in the Ironic code base. Change-Id: Ic9395f5f6869212e4076a045ced83b57d0c16324
2015-08-13 16:26:45 +01:00
ignore = E129
Enable flake8 checking of ironic/nova/* The directory ironic/nova/* was being excluded from the flake8 check. Make some minor whitespace and comment changes to ironic/nova/compute/manager.py to make it pass the flake8 checks. Change-Id: I5a76550db3b28a87964d1505441246cdb0354ee7
2015-06-12 11:44:28 -07:00
exclude = .venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build,tools
Put a cap on our cyclomatic complexity Flake8 has support for McCabe cyclomatic complexity. Ironic's most complex code is at 16 right now, so cap this at 17 to make sure we don't start writing more complex code than what we already have today. Nova is doing similar: https://review.openstack.org/#/c/129125 Change-Id: I99fa26f763ab456d3428951d6a729098a73cf9ef
2014-10-16 22:27:32 -07:00
max-complexity=17
Import missing gettext _ to fix Sphinx error We run "python setup.py build_sphinx" to generate the API documents, however encountered a lot of "NameError: name '_' is not defined", which will cause our api.controllers.v1.* objects documents will not be generated by Sphinx, so we are missing these in the document page http://docs.openstack.org/developer/ironic/py-modindex.html. Import missing gettext _ to fix such Sphinx error with this patch. Change-Id: Ie53d96203109b8b95b9734b58d85da41a2d011cf Closes-Bug: #1251011
2013-11-19 08:15:25 +08:00
[hacking]
Remove bypassing of H302 for gettextutils markers When we used the i18n markers (_, _LE, _LW, etc) from ironic.openstack.common.gettextutils, we bypassed H302 hacking rule for them (via tox.ini file). Now that we've converted to using the markers from oslo.i18n and are no longer using the markers from gettextutils, we can remove the bypass stuff. Change-Id: I26147b69884cd9c075e1cfe38a92e38e861083e7 Closes-Bug: #1368425
2014-09-11 21:04:47 +00:00
import_exceptions = testtools.matchers, ironic.common.i18n
Copy Permalink