New Driver Review Checklist¶
Reviewers can use this list for some common things to watch for when doing new driver reviews. This list is by no means exhaustive, but does try to capture some of things that have been found in past reviews.
Feel free to propose additional items to help make this a more complete list.
Passing all gate tests
Driver keeps all configuration in
cinder.confand not in separate vendor specific config file.
xml files for configs are forbidden
Code should use
Handles detach where
connector == Nonefor force detach
Create from snapshot and clone properly account for new volume size being larger than original volume size
Volume not found in delete calls should return success
Ensure proper code format w/ pep8 (
tox -e pep8), but start here first: https://docs.openstack.org/hacking/latest/user/hacking.html
tox -e fast8can be used as a quick check only against modified files
Unit tests included for all but trivial code in driver
Make sure there’s an
__init__.pyfile in the directory containing the test files or they won’t be discovered by stestr when running the generic
tox -e pyXXcommand to run unit tests.
Use the results of the
cinder-code-coveragejob or run
tox -e coverlocally to see a test coverage report.
All source code files contain Apache 2 copyright header
Stating copyright for vendor is optional
Don’t attribute copyright to the OpenStack Foundation
tox -e complianceto make sure all required interfaces are implemented.
Required in driver:
Concrete driver implementation has decorator
VERSIONconstant defined in driver class
CI_WIKI_NAMEconstant defined in driver class
well documented version history in the comment block for the main driver class.
Support minimum driver features.
Meet release deadline(s)
By Milestone 2 of the current development cycle, the driver should have working third party CI and no code review issues.
You can find the exact date on the current release schedule, which you can find from https://releases.openstack.org/index.html
Driver does not add unnecessary new config options
For example, adding vendor_username instead of using the common san_login
Driver reports all options it uses in get_driver_options() method
This is necessary for cinderlib/emberCSI use of the driver
The response should include any common config options (see above) in addition to driver-specific options
See https://review.opendev.org/c/openstack/cinder/+/770807/ for an example of how to do this
If the driver is a subclass of an existing driver, verify that it implements its own
_update_volume_stats()function to override any capabilities of the parent driver that the child driver may not have. For example, the parent driver may support multiattach, while this may not be the case (or may not yet be verified) for the child driver.
Driver specific exceptions inherit from
Exceptions should be defined with driver code
Logging level is appropriate for content
General tracing should be at debug level
Things operators should be aware of should be at Info level
Issues that are of concern but may not have an impact on actual operation should be warning
Issues operators need to take action on or should definitely know about should be ERROR
Messages about a failure should include the snapshot or volume in question.
All exception messages that could be raised to users should be marked for translation with _()
Drivers must not use md5 for any security-related purpose. (In fact, drivers should avoid using it at all, because some security audits only allow a “yes”/”no” checkbox for md5 use … but that’s up to the vendor.)
If md5 is being used for a non security-related purpose, the code must use oslo.utils and not call hashlib directly to access md5. Here’s an example of how to do this: https://review.opendev.org/c/openstack/os-brick/+/756151
Any cryptography done by a driver should be implemented by using a well-respected cryptographic library. Under no circumstances should a driver implement its own cryptographic functions.
If the library is already in OpenStack global requirements, then it is well-respected; otherwise, you will find out if it’s well-respected when you apply for it to be added to global requirements (see next item).
Any additional libraries needed for a driver must be added to the global requirements.
Pypi installable libraries should be added to driver section in setup.cfg
Binary dependencies need to be OSI licensed and added to bindep.txt
Third Party CI checks
Responds correctly to recheck from “run-<CI Name>”
Tempest run console log available
cinder.confand all cinder service logs available
LVM driver is not being configured in
Only the driver in question should be in
specify correct patch for each CI run
git fetch https://review.opendev.org/openstack/cinder refs/changes/56/657856/2 && git checkout cherry-pick(https://wiki.openstack.org/wiki/Cinder/tested-3rdParty-drivers )
tox -e all -- *volume*
Any skipped tests need to be clearly documented why they are being skipped including the plan for getting rid of the need to skip them.
https://opendev.org/openstack/cinder-tempest-plugin needs to be installed so those tempest tests run as well.
--subunithelps generate HTML output (https://docs.openstack.org/os-testr/latest/user/subunit2html.html )
<n>number of test runners
CI must run Cinder services using Python 3. More specifically:
At the Ussuri Virtual Mid-Cycle meeting (session 2, 16 March 2020), the Cinder team agreed that new Third-Party CI systems should:
ideally, test using all of the cycle Python runtimes
otherwise, test using at least one of the cycle runtimes
The current Python runtimes are determined by the OpenStack Technical Committee. See Tested Runtimes in the OpenStack governance documents.
CI does not report failures or exception due to the CI operation and not due to test failures due to code changes.
optional, but highly recommended: CI only runs on third party CI recheck trigger or on successful +1 from Zuul.
CI only runs on patches to the master branch unless they are intentionally set up to be able to properly run stable branch testing.
Included with driver patch
Release note stating something like “New volume driver added for Blah blah blah storage”
See Reno usage information here: https://docs.openstack.org/reno/latest/user/usage.html
Make sure that the release note is in the correct subdirectory, namely,
releasenotes/notes/in the repository root directory. It should not be located in the driver’s section of the code tree.
Driver added to
Driver configuration information added under
cinder/opts.pyincluding the new driver library options using the command
tox -e genopts