OpenStack Block Storage (Cinder)
Go to file
Sean McGinnis 3eb9b422f4
Introduce flake8-import-order extension
This adds usage of the flake8-import-order extension to our flake8
checks to enforce consistency on our import ordering to follow the
overall OpenStack code guidelines.

Since we have now dropped Python 2, this also cleans up a few cases for
things that were third party libs but became part of the standard
library such as mock, which is now a standard part of unittest.

Some questions, in order of importance:

Q: Are you insane?
A: Potentially.

Q: Why should we touch all of these files?
A: This adds consistency to our imports. The extension makes sure that
   all imports follow our published guidelines of having imports ordered
   by standard lib, third party, and local. This will be a one time
   churn, then we can ensure consistency over time.

Q: Why bother. this doesn't really matter?
A: I agree - but...

We have the issue that we have less people actively involved and less
time to perform thorough code reviews. This will make it objective and
automated to catch these kinds of issues.

But part of this, even though it maybe seems a little annoying, is for
making it easier for contributors. Right now, we may or may not notice
if something is following the guidelines or not. And we may or may not
comment in a review to ask for a contributor to make adjustments to
follow the guidelines.

But then further along into the review process, someone decides to be
thorough, and after the contributor feels like they've had to deal with
other change requests and things are in really good shape, they get a -1
on something mostly meaningless as far as the functionality of their
code. It can be a frustrating and disheartening thing.

I believe this actually helps avoid that by making it an objective thing
that they find out right away up front - either the code is following
the guidelines and everything is happy, or it's not and running local
jobs or the pep8 CI job will let them know right away and they can fix
it. No guessing on whether or not someone is going to take a stand on
following the guidelines or not.

This will also make it easier on the code reviewers. The more we can
automate, the more time we can spend in code reviews making sure the
logic of the change is correct and less time looking at trivial coding
and style things.

Q: Should we use our hacking extensions for this?
A: Hacking has had to keep back linter requirements for a long time now.
   Current versions of the linters actually don't work with the way
   we've been hooking into them for our hacking checks. We will likely
   need to do away with those at some point so we can move on to the
   current linter releases. This will help ensure we have something in
   place when that time comes to make sure some checks are automated.

Q: Didn't you spend more time on this than the benefit we'll get from
   it?
A: Yeah, probably.

Change-Id: Ic13ba238a4a45c6219f4de131cfe0366219d722f
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2020-01-06 09:59:35 -06:00
api-ref/source Merge "api-ref: add metadata parameter in the response of create-backup" 2019-10-14 20:56:46 +00:00
cinder Introduce flake8-import-order extension 2020-01-06 09:59:35 -06:00
contrib/block-box Small doc updates: canonical URLs, rally doc, etc 2019-06-04 17:57:16 +02:00
doc Merge "Remove Sheepdog Driver" 2020-01-02 19:10:41 +00:00
etc/cinder Leverage hw accelerator in image compression 2019-09-18 03:01:18 +00:00
playbooks Move cinder grenade job to py3 and in cinder repo 2019-12-12 13:27:19 +00:00
rally-jobs Small doc updates: canonical URLs, rally doc, etc 2019-06-04 17:57:16 +02:00
releasenotes Merge "Remove Sheepdog Driver" 2020-01-02 19:10:41 +00:00
tools Introduce flake8-import-order extension 2020-01-06 09:59:35 -06:00
.coveragerc Update .coveragerc after the removal of openstack directory 2016-10-17 19:09:37 +05:30
.gitignore Add policy sample file to gitignore 2019-07-10 12:28:24 -04:00
.gitreview OpenDev Migration Patch 2019-04-19 19:26:48 +00:00
.pylintrc Pylint: Filter out cinder.objects and requests E1101 2019-02-21 13:28:44 -05:00
.stestr.conf Add .stestr.conf configuration 2017-10-10 00:46:42 +00:00
.zuul.yaml Move cinder grenade job to py3 and in cinder repo 2019-12-12 13:27:19 +00:00
babel.cfg Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
bindep.txt Merge "add libpq-dev to build psycopg2" 2019-04-10 00:42:06 +00:00
CONTRIBUTING.rst Optimize the link address 2017-04-08 15:03:44 +08:00
driver-requirements.txt Merge "LINSTOR driver update for LINSTOR v0.9.12 with REST API" 2019-10-04 21:46:48 +00:00
HACKING.rst Doc8: Stop skipping D001: Line too long 2019-02-19 16:51:56 -06:00
LICENSE Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
lower-constraints.txt Introduce flake8-import-order extension 2020-01-06 09:59:35 -06:00
README.rst Start README.rst with a better title 2019-11-19 17:48:27 +01:00
requirements.txt Convert PrettyTable usage to tabulate 2019-11-13 13:02:35 -06:00
setup.cfg Remove Python 2 support from testing and gate jobs 2019-11-25 13:31:32 -05:00
setup.py Updated from global requirements 2017-03-02 23:53:29 +00:00
test-requirements.txt Introduce flake8-import-order extension 2020-01-06 09:59:35 -06:00
tox.ini Introduce flake8-import-order extension 2020-01-06 09:59:35 -06:00

OpenStack Cinder

image

OpenStack Cinder is a storage service for an open cloud computing service.

You can learn more about Cinder at:

Getting Started

If you'd like to run from the master branch, you can clone the git repo:

git clone https://opendev.org/openstack/cinder

If you'd like to contribute, please see the information in CONTRIBUTING.rst

You can raise bugs here https://bugs.launchpad.net/cinder

Python client

https://opendev.org/openstack/python-cinderclient