Cinder/tested-3rdParty-drivers

= Driver Testing =

Description
The Cinder community (and other OpenStack projects) have agreed that if a vendor wishes to submit a driver for their particular storage device that said vendor should also be required to set up a third party CI system in their lab which runs Tempest against their storage device for every relevant Cinder project commit (usually cinder and os-brick), and provides feedback in to Gerrit.

Third Party CI Requirements

 * See the official Third Party Testing wiki.
 * Test all volume/backup/connector drivers your company has integrated in Cinder with each of the supported backends.
 * Run on each change to cinder and os-brick. (Cinder tests use the latest released version of os-brick, so bad changes to os-brick master can slip in if you aren't checking.)
 * Post all test results. Even if you have failure results, those need to be posted.
 * The posted results must be browseable directly from the web so they can be easily viewed by reviewers. Do not post a link to an archive file that must be downloaded.
 * Test all fabrics your solution uses.
 * Setup your CI to rerun if it is triggered to do so.
 * You must execute your tests using at least one of the Python runtimes for the current development cycle.
 * The current Python runtimes are determined by the OpenStack Technical Committee. See Tested Runtimes in the OpenStack governance documents.

For example, if your company has two volume drivers in Cinder and they both use ISCSI and FibreChannel, you would need to have a CI that tests against four backends and reports the results for each backend, for every Cinder upstream patch. Likewise, if your company has one volume driver that supports two different backends, you would need to have a CI that tests that driver against both backends and reports results for each backend, for every Cinder upstream patch.

Existing CI Solutions
The CI solution you use is completely up to you.

That being said, we (the Cinder project team) are interested in fostering a community of Third Party CI maintainers so that people can more easily get help in setting up and maintaining a CI system. (That's because what seems to happen is that a CI gets stood up, works great, the person who set it up moves on to other duties (at the same company or elsewhere), and suddenly one day it's no longer reporting, and a new person has to scramble to figure out how to fix it while things are on fire.)


 * Our current (as of January 2020) recommendation is: Software Factory
 * It's being used by RDO for their CI system
 * Software Factory Operator Documentation (lots of other docs & guides, but this is good for a quick look)
 * if you try it out, please give us feedback in IRC (#openstack-cinder) or on the mailing list or on this wiki page


 * You can also try puppet modules for deploying OpenStack CI
 * Git repo
 * Mailing list information about CI
 * Questions can be answered on the #openstack-infra IRC channel


 * For historical background you can review Jay Pipe's external testing series
 * Note: Jay's repo is outdated, but the articles are useful to read. A more updated fork exists.
 * Git Repo
 * Understanding the OpenStack CI
 * Setting up CI Part 1 Outdated
 * Setting up a CI Part 2 Outdated
 * Official Third-Party CI Setup Example

Current Reporting Cinder CI's
See the list: http://cinderstats.ivehearditbothways.com/cireport.txt

Non-Compliance Policy
The current policy for CI compliance is:


 * CI's must report on every patch, whether the code change is in their own driver code or not
 * The CI comments must be properly formatted to show up in the CI summary in gerrit

Non-compliant drivers will be tagged as unsupported if:
 * No CI success reporting occurs within a two week span
 * The CI is found to not be testing the expected driver (CI runs using the default LVM driver, etc.)
 * Other issues are found but failed to be addressed in a timely manner

Note: Comment in the #openstack-cinder IRC to let the team know if the CI is down for any period of time. This does not mean it will be exempt from the non-compliance policy, but it will let us know that you are aware that your CI is down and you are working on it.

If a driver CI is found non compliant:
 * A driver patch will be submitted flagging it as unsupported
 * This will cause warning messages to be logged in the c-vol log stating it is unsupported and deprecated
 * Operators will need to set enable_unsupported_drivers=True in cinder.conf or the service will fail to load
 * If the issue is not corrected before the next release, the driver will subject to removal. Please see the Cinder Driver Removal Policy for details

CI results will be reviewed on a regular basis and if found non-compliant, drivers will be flagged. We will try to do a final review around the third milestone of the release. If marked as unsupported, vendors will have until the RC tag to become compliant. The flag can be reverted if addressed in time.

CI results are currently posted here: http://cinderstats.ivehearditbothways.com/cireport.txt

Questions

 * Join Third Party Meeting
 * Reach out to IRC nicks DuncanT or asselin on Freenode #openstack-cinder.

What tests do I use?
You must use both:
 * the OpenStack integration test suite Tempest
 * the cinder-tempest-plugin which will run additional tempest-based tests specifically for Cinder

Tempest will automatically discover any installed plugins when it is run. So by just installing the python packages containing the cinder-tempest-plugin, you’ll be using it with Tempest, nothing else is really required.

Volume & Connector Drivers
The volume related tests can be started with the following command from a Tempest repo:

tox -e all -- volume | tee -a console.log.out

For those using devstack-gate export this variable before running the job: export DEVSTACK_GATE_TEMPEST_REGEX="volume"

Backup Drivers
tox -e all -- volume_backup | tee -a console.log.out

For those using devstack-gate export this variable before running the job: export DEVSTACK_GATE_TEMPEST_REGEX="volume_backup"

How do I configure DevStack so my Driver Passes Tempest?
Sample local.conf for devstack setup.

for cinder:

localrc ADMIN_PASSWORD=password MYSQL_PASSWORD=password RABBIT_PASSWORD=password SERVICE_PASSWORD=password SERVICE_TOKEN=password

TEMPEST_VOLUME_DRIVER=foo TEMPEST_VOLUME_VENDOR="Foo Inc" TEMPEST_STORAGE_PROTOCOL=iSCSI
 * 1) These options define  expected driver capabilities

CINDER_REPO=https://opendev.org/openstack/cinder CINDER_BRANCH=refs/changes/83/72183/4
 * 1) These options allow you to specify a branch other than "master" be used

Q_USE_SECGROUP=False LIBVIRT_FIREWALL_DRIVER=nova.virt.firewall.NoopFirewallDriver CINDER_SECURE_DELETE=False
 * 1) Disable security groups entirely

$CINDER_CONF volume_driver=cinder.volume.drivers.foo.FooDriver

for os-brick:

localrc ADMIN_PASSWORD=password MYSQL_PASSWORD=password RABBIT_PASSWORD=password SERVICE_PASSWORD=password SERVICE_TOKEN=password

TEMPEST_VOLUME_DRIVER=foo TEMPEST_VOLUME_VENDOR="Foo Inc" TEMPEST_STORAGE_PROTOCOL=iSCSI
 * 1) These options define  expected driver capabilities

OS_BRICK_REPO=https://review.opendev.org/openstack/os-brick OS_BRICK_BRANCH=refs/changes/85/873085/1 LIBS_FROM_GIT=os-brick
 * 1) These options allow you to specify a branch other than "master" be used

Q_USE_SECGROUP=False LIBVIRT_FIREWALL_DRIVER=nova.virt.firewall.NoopFirewallDriver CINDER_SECURE_DELETE=False
 * 1) Disable security groups entirely

$CINDER_CONF volume_driver=cinder.volume.drivers.foo.FooDriver

What changes should I test on?
You should test on all changes to cinder and os-brick.
 * You want to protect yourself from cinder changes that somehow impact your driver. Note that because third-party CI systems are non-voting, a failure will not block a patch from merging.  Reviewers will (usually) check your third-party CI results on a change specifically to your driver's code, but they may not notice on patches to main cinder code that doesn't directly touch your driver.  So it's important for you to keep an eye on your CI's failures, and add a manual -1 if it's a real failure.


 * The os-brick used in cinder CI testing is the latest appropriate released version of os-brick. Thus, it is possible for changes to be happening in os-brick that might impact the functionality of your driver.  If you aren't testing os-brick changes, you won't find out about these until after the next os-brick release, which will really suck for your customers.


 * NOTE: The expectation that third-party CIs would test os-brick changes had not been communicated clearly, and hence some drivers test and some don't. Thus, this is not a hard requirement until the OpenStack 2023.1 release development cycle (that is, the cycle after the Zed release).

How do I run my CI to test all cinder patches with my driver not yet merged?
If using devstack-gate use the pre-test-hook to cherry-pick your driver on top of the cinder patch under review. If you've submitted your change to gerrit, you can use something like the following:

function pre_test_hook { echo "Cherry-picking latest driver from gerrit" cd $BASE/new/cinder

# fetch latest patchset from gerrit UPSTREAM_REMOTE=https://opendev.org/openstack/cinder

# set this to your gerrit change number CHANGE_NUM=999999

PATCHSET_BASE=refs/changes/${CHANGE_NUM:(-2)}/$CHANGE_NUM LATEST_PATCHSET=$(git ls-remote $UPSTREAM_REMOTE $PATCHSET_BASE/\* |                     sort -t/ -k 5 -n | tail -n1 | cut -d$'\t' -f2)

if [ -z "$LATEST_PATCHSET" ]; then echo "Failed to determine latest patchset of $PATCHSET_BASE from $UPSTREAM_REMOTE" exit 1 fi

echo "Latest patchset ref is $LATEST_PATCHSET"

git fetch $UPSTREAM_REMOTE $LATEST_PATCHSET && git cherry-pick FETCH_HEAD }

If you haven't submitted your change to gerrit yet, you'll have to fetch the change from your own repository (github or otherwise). For example:

function pre_test_hook { echo "Cherry-picking latest driver from private repository" cd $BASE/new/cinder

VENDOR_REMOTE=https://www.github.com/vendor/cinder-driver REFSPEC=bp/new-cinder-driver

git fetch $VENDOR_REMOTE $REFSPEC && git cherry-pick FETCH_HEAD }

Otherwise you can make the changes prior to calling stack.sh or via a custom devstack plugin.

When thirdparty CI voting will be required?
Once third party CI's become more common and stable, we'll revisit the subject. This was agreed in a discussion on October 15th 2014. In a discussion on April 8th 2015, it was agreed that open source solutions that have Infra hosted CI's could have the chance to vote.

As of July 2022, the third party CI systems are unfortunately so unstable that voting is out of the question.

How do I test FC drivers?
Use PCI Passthrough to give the VM access to the FC PCI Device Scripts available here: https://opendev.org/x/third-party-ci-tools/src/branch/master/provisioning_scripts/fibre_channel

How do I trigger my CI to rerun on gerrit comments?
It is required for your CI to rerun jobs if the following comment is posted in a gerrit review:

So if your CI account name is "Super Cool Storage CI", the CI should be able to be retriggered by leaving the comment:

CI's do not need to kick off tests until Zuul's has given a +1, though it is up to the maintainer if you want to trigger immediately on all patchsets.

For the openstack-ci configuration, change the following to switch to only trigger on a Zuul's +1:

In layout.yaml: Delete the line: - event: patchset-created And then add: - event: comment-added require-approval: - verified: 1 username: zuul

What about stable branch testing?
The current policy is described in this posting to the openstack-discuss mailing list: http://lists.openstack.org/pipermail/openstack-discuss/2022-February/027021.html

Here's an example of what we're looking for: https://review.opendev.org/c/openstack/cinder/+/821893/