openstack/nova - nova - OpenDev: Free Software Needs Free Tools

install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}

Add missing directive to tox.ini. Change-Id: Ib6d178af62f631de76e66c2bb6c07fd6b277fa97

2012年02月25日 12:25:56 -08:00

setenv = VIRTUAL_ENV={envdir}

move all tests to nova/tests/unit As part of the split of functional and unit tests we need to isolate the unit tests into a separate directory for having multiple test targets in a sane way. Part of bp:functional-tests-for-nova Change-Id: Id42ba373c1bda6a312b673ab2b489ca56da8c628

2014年11月07日 14:27:03 +01:00

OS_TEST_PATH=./nova/tests/unit

Force LANGUAGE=en_US in test runs If your native locale is not en_US and you run tests, some will fail due to the message translation that happens since the assertion messages are in en_US (not translated, just hard-coded in the tests). I recreated the bug by setting LANGUAGE=en_GB in my tox.ini and tested against nova.tests.unit.api.openstack.test_wsgi. Note that setting LANG=en_US had no effect. Closes-Bug: #1427745 Change-Id: Ib1c71d0d4170ba1a7ed2fe3eaf0e2d8071ec01d6

2015年03月03日 08:58:42 -08:00

LANGUAGE=en_US

Force the value of LC_ALL to be en_US.UTF-8 On Python 3, if LC_ALL is not passed then the interpreter will assume it is C (which causes the interpreter to use ASCII). This, in turn, causes the unicode in the README.rst for rfc3986 to trigger a UnicodeDecodeError exception. jlvillal (John Villalovos) pointed out I340c88ea7d098ca5943d60adc73f63a0af79a405 in IRC as the fix to this bug. Closes-bug: 1460206 Change-Id: If05e3fe76450c06431413f63e46e154cf44fc1cf

2015年05月29日 16:41:44 -05:00

LC_ALL=en_US.utf-8

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

Tests: remove .testrepository/times.dbm in tox.ini Existance of this file causes py3* tests to fail if run after py27. This patch adds cleaning up of this file before running py3* tests. Change-Id: I64ef1eac7f05f217674c73ddd2cc3af773dd75ce Closes-Bug: #1229445

2017年02月16日 20:52:41 +00:00

rm -Rf .testrepository/times.dbm

Pass GENERATE_HASHES to the tox test environment When bumping nova object versions, it's necessary to generate new hashes for those that have changed. New hashes are generated when the GENERATE_HASHES environment variable is set. Let tox copy GENERATE_HASHES to the test environment to allow object hash generation for a command line like: GENERATE_HASHES=1 tox -epy27 Change-Id: Id652a7a9fbaeaf35db06744cbaf2484504fc2531

2016年09月08日 23:45:41 +00:00

passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY OS_DEBUG GENERATE_HASHES

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

# 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.

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 =

{[testenv]commands}

bash tools/pretty_tox.sh '{posargs}'

Integrate OSProfiler and Nova * Add osprofiler wsgi middleware. This middleware is used for 2 things: 1) It checks that person who want to trace is trusted and knows secret HMAC key. 2) It starts tracing in case of proper trace headers and adds the first wsgi trace point with info about the HTTP request * Add initialization of osprofiler on start of a service Currently that includes oslo.messaging notifier instance creation to send Ceilometer backend notifications. oslo-spec: https://review.openstack.org/#/c/103825/ python-novaclient change: https://review.openstack.org/#/c/254699/ based on: https://review.openstack.org/#/c/105096/ Co-Authored-By: Boris Pavlovic <boris@pavlovic.me> Co-Authored-By: Munoz, Obed N <obed.n.munoz@intel.com> Co-Authored-By: Roman Podoliaka <rpodolyaka@mirantis.com> Co-Authored-By: Tovin Seven <vinhnt@vn.fujitsu.com> Implements: blueprint osprofiler-support-in-nova Change-Id: I82d2badc8c1fcec27c3fce7c3c20e0f3b76414f1

2015年12月08日 14:32:10 +03:00

env TEST_OSPROFILER=1 bash tools/pretty_tox.sh '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

[testenv:py35]

commands =

{[testenv]commands}

bash tools/pretty_tox3.sh '{posargs}'

Integrate OSProfiler and Nova * Add osprofiler wsgi middleware. This middleware is used for 2 things: 1) It checks that person who want to trace is trusted and knows secret HMAC key. 2) It starts tracing in case of proper trace headers and adds the first wsgi trace point with info about the HTTP request * Add initialization of osprofiler on start of a service Currently that includes oslo.messaging notifier instance creation to send Ceilometer backend notifications. oslo-spec: https://review.openstack.org/#/c/103825/ python-novaclient change: https://review.openstack.org/#/c/254699/ based on: https://review.openstack.org/#/c/105096/ Co-Authored-By: Boris Pavlovic <boris@pavlovic.me> Co-Authored-By: Munoz, Obed N <obed.n.munoz@intel.com> Co-Authored-By: Roman Podoliaka <rpodolyaka@mirantis.com> Co-Authored-By: Tovin Seven <vinhnt@vn.fujitsu.com> Implements: blueprint osprofiler-support-in-nova Change-Id: I82d2badc8c1fcec27c3fce7c3c20e0f3b76414f1

2015年12月08日 14:32:10 +03:00

env TEST_OSPROFILER=1 bash tools/pretty_tox.sh '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]

always use python2.7 for pep8 pep8 doesn't work with python3 on our codebase. If someone is on a platform that defaults to python => python3, pep8 won't work for them. This is actually really easy to fix with a single line in tox. Change-Id: I7a888e4f7cc828638a9d61d2249a854ba1f3cb7b Closes-Bug: #1456955

2016年02月19日 21:10:42 -05:00

basepython = python2.7

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}

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

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

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

usedevelop = True

setenv = VIRTUAL_ENV={envdir}

OS_TEST_PATH=./nova/tests/functional

Force LANGUAGE=en_US in test runs If your native locale is not en_US and you run tests, some will fail due to the message translation that happens since the assertion messages are in en_US (not translated, just hard-coded in the tests). I recreated the bug by setting LANGUAGE=en_GB in my tox.ini and tested against nova.tests.unit.api.openstack.test_wsgi. Note that setting LANG=en_US had no effect. Closes-Bug: #1427745 Change-Id: Ib1c71d0d4170ba1a7ed2fe3eaf0e2d8071ec01d6

2015年03月03日 08:58:42 -08:00

LANGUAGE=en_US

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 =

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

move the integrated tests into the functional tree This moves the integrated tests into the functional tree as an initial seed for the functional tests. It was agreed to as an early step at the design summit. Work on cleaning these up will happen after the move. PYTHON_HASH_SEED=0 is needed because these tests apparently remain order dependent. Also remove the use of test.ReplaceModule, which is an untested mocking system in the nova tree that doesn't seem to reliably work. Use stubs instead for the time being, as this will ensure repeatability of the code. Part of bp:functional-tests-for-nova Change-Id: I742c487dd7bca9de3e811c545de477367fff112c

2014年11月24日 09:34:30 -05:00

bash tools/pretty_tox.sh '{posargs}'

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

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_tox3.sh '{posargs}'

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]

usedevelop = True

setenv = VIRTUAL_ENV={envdir}

GENERATE_SAMPLES=True

PYTHONHASHSEED=0

OS_TEST_PATH=./nova/tests/functional/api_sample_tests

LANGUAGE=en_US

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

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

bash tools/pretty_tox.sh '{posargs}'

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.

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

Fix 'No data to report' error Remove 2 unnecessary commands in 'testenv:cover' of tox.ini. HTML coverage reports can be generated in 'cover' directory by 'python setup.py testr --coverage' only without the removed commands. Change-Id: Ib9539f845aad29269a9cb07db719b22e35f7bbeb Closes-Bug: #1613256

2016年08月16日 13:23:18 +09:00

python setup.py testr --coverage --testr-args='{posargs}'

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]

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]

Always use python2.7 for docs target The docs testenv doesn't work with python 3.x on our codebase. If someone is on a platform that defaults to python => python3, building docs will fail for them. Closes-Bug: #1646629 Change-Id: I56f3933e89e6fe9e181517325e2d7af5110c5656

2016年12月01日 22:04:48 +00:00

# TODO(melwitt): This can be removed when the docs target can be run

# with python 3.x

basepython = python2.7

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 =

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 doc/source/api doc/build api-guide/build api-ref/build

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

python setup.py build_sphinx

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'

Gate on nova.conf.sample generation If someone makes a change that breaks "tox -e genconfig" it is not caught today by any of the gate/check jobs. We should fail at least the docs job by running oslo-config-generator to make sure it works. Change-Id: I63fede4a7b5f358f2212383e2870cc64c4f9f1e4

2015年08月21日 13:20:23 -04:00

oslo-config-generator --config-file=etc/nova/nova-config-generator.conf

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

oslopolicy-sample-generator --config-file=etc/nova/nova-policy-generator.conf

Add oslopolicy script runs to the docs tox target In an untouched codebase these two commands should not output anything of interest as they are primarily tools for managing a custom policy.json file. But it's useful to run them to ensure that they do not error out. Change-Id: I33e0b27164a0e9df240337c7e9b467f0f3859eac

2016年08月24日 16:45:24 -04:00

oslopolicy-list-redundant --namespace nova

oslopolicy-policy-generator --namespace nova --output-file etc/nova/policy.yaml.merged

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

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.

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.

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

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]

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

Nuke cliutils from oslo-incubator Oslo team won't create new libary to include functions of module cliutils. Nova only use two methods in cmd/manage.py, so copy these two methods to nova/utils.py and clean up oslo-incubator related stuff. Note:There is tiny change of method validate_args to make it Python 3 compatible. Change-Id: Ibef5076f9556fa3224c2ca32e8c7fe2c4c1f739b

2016年03月03日 20:13:16 +08:00

exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,tools/xenserver*,releasenotes

Use flake8-import-order Use the flake8 plugin flake8-import-order to check import ordering. It can do it automatically and don't need reviewers to check it. Change-Id: Ia3d81bbbb44b40804b3268c0e648276a36cb4805

2017年02月17日 11:26:41 -08:00

import-order-style = pep8

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

deps = pip_missing_reqs

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

openstack/nova - nova - OpenDev: Free Software Needs Free Tools

189 lines 6.7 KiB INI Raw Normal View History Unescape Escape

189 lines

6.7 KiB

INI

Raw Normal View History