From c0d06dd1f9cef778bbf1901ff78eae06e92bc0b2 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Tue, 12 Nov 2019 16:34:35 -0600 Subject: [PATCH] Remove py2 mentions from contributor docs We had information about running py27 tox targets that can now be removed. We also had special notes about getting py3 set up, but since that is now part of the default setup of a development environment, that can be removed. Change-Id: I6d49fe02d3a5b826cf93076a0828450ca52220cc Signed-off-by: Sean McGinnis --- .../contributor/development.environment.rst | 15 ++---- doc/source/contributor/testing.rst | 50 +++---------------- 2 files changed, 9 insertions(+), 56 deletions(-) diff --git a/doc/source/contributor/development.environment.rst b/doc/source/contributor/development.environment.rst index cb70bca9fb0..b403d708685 100644 --- a/doc/source/contributor/development.environment.rst +++ b/doc/source/contributor/development.environment.rst @@ -120,8 +120,7 @@ so the only package you install is ``tox`` itself:: Run the unit tests by doing:: - tox -e py35 - tox -e py27 + tox -e py3 See :doc:`testing` for more details. @@ -132,22 +131,14 @@ Manually installing and using the virtualenv You can also manually install the virtual environment:: - tox -e py27 --notest - -or:: - - tox -e py35 --notest + tox -e py3 --notest This will install all of the Python packages listed in the ``requirements.txt`` file into your virtualenv. To activate the Cinder virtualenv you can run:: - $ source .tox/py27/bin/activate - -or:: - - $ source .tox/py35/bin/activate + $ source .tox/py3/bin/activate To exit your virtualenv, just type:: diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index e1671328e2f..a3f73aeb5fb 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -57,9 +57,9 @@ This will create a virtual environment, load all the packages from test-requirements.txt and run all unit tests as well as run flake8 and hacking checks against the code. -You may run individual test targets, for example only py27 tests, by running:: +You may run individual test targets, for example only py37 tests, by running:: - tox -e py27 + tox -e py37 Note that you can inspect the tox.ini file to get more details on the available options and what the test run does by default. @@ -93,17 +93,17 @@ it's setup in the CI environment. Running a subset of tests using tox ----------------------------------- One common activity is to just run a single test, you can do this with tox -simply by specifying to just run py27 or py35 tests against a single test:: +simply by specifying to just run py37 tests against a single test:: - tox -epy27 -- cinder.tests.unit.volume.test_availability_zone.AvailabilityZoneTestCase.test_list_availability_zones_cached + tox -epy37 -- cinder.tests.unit.volume.test_availability_zone.AvailabilityZoneTestCase.test_list_availability_zones_cached Or all tests in the test_volume.py file:: - tox -epy27 -- cinder.tests.unit.volume.test_volume + tox -epy37 -- cinder.tests.unit.volume.test_volume You may also use regular expressions to run any matching tests:: - tox -epy27 -- test_volume + tox -epy37 -- test_volume For more information on these options and details about stestr, please see the `stestr documentation `_. @@ -123,44 +123,6 @@ can get around this by manually setting or updating the following line in Note that you may use any location (not just ``/tmp``!) as long as it is not a shared folder. -**Running py35 tests** - -You will need to install python3-dev in order to get py35 tests to run. If you -do not have this, you will get the following:: - - netifaces.c:1:20: fatal error: Python.h: No such file or directory - #include - ^ - compilation terminated. - error: command 'x86_64-linux-gnu-gcc' failed with exit status 1 - - ---------------------------------------- - - ERROR: could not install deps [-r/opt/stack/cinder/test-requirements.txt, - oslo.versionedobjects[fixtures]]; v = InvocationError('/opt/stack/cinder/ - .tox/py35/bin/pip install -r/opt/stack/cinder/test-requirements.txt - oslo.versionedobjects[fixtures] (see /opt/stack/cinder/.tox/py35/log/py35-1.log)', 1) - _______________________________________________________________ summary _______________________________________________________________ - ERROR: py35: could not install deps [-r/opt/stack/cinder/test-requirements.txt, - oslo.versionedobjects[fixtures]]; v = InvocationError('/opt/stack/cinder/ - .tox/py35/bin/pip install -r/opt/stack/cinder/test-requirements.txt - oslo.versionedobjects[fixtures] (see /opt/stack/cinder/.tox/py35/log/py35-1.log)', 1) - -To Fix: - -- On Ubuntu/Debian:: - - sudo apt-get install python3-dev - -- On Fedora 21/RHEL7/CentOS7:: - - sudo yum install python3-devel - -- On Fedora 22 and higher:: - - sudo dnf install python3-devel - - **Assertion types in unit tests** In general, it is best to use the most specific assertion possible in a unit