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

- 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

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

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 

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

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 

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

Enable coverage report in tox.ini.
Change-Id: Ifcb5d5d78e2a06e807050ce18e34e1d1f0fa1972

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

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

* 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

Add Python 3.5 functional tests tox envlist, this is
needed by python 3.5 functional tests Jenkins job.
Change-Id: I1bba877fcc2c1f2140cbbba2bc6e6c20d7972615

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

The windows edited file may contain \r\n in line, add a check for
json files for the docs job.
Change-Id: I1ca30be139651ed49eb1f7867616dda6bd080884

This reverts commit 1e287ae14b
Constraints mechanism doesn't work for 'hacking' lib:
I11eb0d762869ad8920795fb710f1b2eeb9354f12
We have to install all of test-requirements to get
'hacking' at the right version.
Closes-Bug: #1648054
Change-Id: I512192e8a9ab3a53a52e6cc4d4b8a222951af7fb

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

With the latest version of bandit, the bandit.yaml is only
necessary for advanced tweaking.
Change-Id: I933a5389865fe577925ce3be30877ceae12fad31

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

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

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

The jobs periodic-nova-py27-with-oslo-master and
periodic-nova-py35-with-oslo-master are failing with:
"tox.ConfigError: ConfigError: substitution key '34,35' not found".
For details, see
http://logs.openstack.org/periodic/periodic-nova-py27-with-oslo-master/c01eab1/
http://logs.openstack.org/periodic/periodic-nova-py35-with-oslo-master/c10b034/
Fix this with not using a clever "py{34,35}" substitution in tox.ini and
instead duplicate the line.
Change-Id: If10fa53fff85350234ac1308505c273cde1333a1

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

This reverts commit 0d6d1616b9.
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

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

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

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

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 

Infra is now ready to use constraints everywhere, adapt
the venv environment to use the default install command instead of a
specific non-constrainted install command.
With this change, now all tox environments use constraints.
Change-Id: Ibb73b4a27b5b0462a9e9f2dd80e437bcc8c7f8f4

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

OpenStack CI has now enabled constraints for releasenotes, use them -
remove the special install command.
Note that venv still cannot use constraints, this needs more changes
in OpenStack CI.
Change-Id: I125cb906f89c1de4227dc53521e1a60241ace997
Depends-On: If5d6b11bd795091eef949001cca6e8d4ec723ef2

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

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

OpenStack CI setup has been changed so that api jobs can
use constraints, remove the extra install_command.
Change-Id: I1eb8c5b74adf28e8b6267f25b116341c540729dd
Depends-On: I8f45a53429b9fcbf3689a268f096afdf5f32f461

OpenStack CI supports now constraints in the coverage job - as a first
job to check that recent changes for zuul-cloner work correctly.
Use constraints for cover environment. If this works successfully, the
other environments can be updated in followups.
Change-Id: I6069bee0a89d38f6a3ec57418e7bda9850dc6f64

This simplifies our tox file and reduces duplication.
Change-Id: I085899e00a249fb850c81737b1088bb82ce820ba

There's no reason to create these files and cleaning them up takes
precious time during each test run. Don't do it.
The benefits of this can be seen in running both the full test suite
and part of the test suite. For the former case - running the full
test suite:
 $ time ( tox -e py27 )
Without this change:
 real 12m48.003s
 user 38m27.039s
 sys 1m2.786s
With this change:
 real 11m53.921s
 user 39m33.360s
 sys 1m1.686s
For the latter case - running part of the full test suite:
 $ time ( tox -e py27 -- nova.tests.unit.test_configdrive2 )
Without this change:
 real 2m0.686s
 user 1m3.080s
 sys 0m12.950s
With this change:
 real 1m37.098s
 user 1m16.559s
 sys 0m11.846s
The actual results can vary massively, but this change is always
faster.
Change-Id: Iffd759e368878f39c015258935d8b37de09d9745

Infra will start running python35 jobs soon [1], targeting to replace
the current python34 jobs. This is due to the change from Ubuntu Trusty
to Xenial, where only python3.5 will be available.
So we add a py35 environment with the same definitions for skipping
not-yet-working checks as we have in place for py34 already.
[1] https://review.openstack.org/336272
Change-Id: I017478fafa31121f40c95d73e49ac4dced80c7a2