[openstack-dev] [all][openstackclient] check/gate job to check for duplicate openstackclient commands

Steve Martinelli stevemar at ca.ibm.com
Sun Jan 10 07:36:41 UTC 2016

During the Liberty release the OpenStackClient (OSC) team ran into an issue
that is documented here: [0] and here: [1]. In short, commands were
clobbering each other because they had the same command name.

A longer example is this, OSC has a command for listing compute flavors (os
flavor list). zaqarclient, an OSC plugin, also implemented an `os flavor
list` command. This caused OSC to break (it became unusable because it
couldn't load entry points), and the user had to upgrade their zaqarclient,
which included a renamed command (os messaging flavor list).

In an effort to make sure this doesn't happen against, we did two things:
1) fixed the exception handling upon load at the cliff level, now OSC won't
become unusable, it'll just take the last entrypoint it sees, and 2) we
created a new gate/check job that checks for duplicate commands [2].
(Thanks to ajaeger and dhellmann for their help in this work!)

I've added this job to the OpenStackClient gate (in a non-voting capacity
for now), and would like to get it added to the following projects, again
in a non-voting capacity (since they are all OSC plugins):

  - python-barbicanclient
  - python-congressclient
  - python-cueclient
  - python-designateclient
  - python-heatclient
  - python-ironicclient
  - python-ironic-inspector-client
  - python-mistralclient
  - python-saharaclient
  - python-tuskarclient
  - python-zaqarclient

If the core team for any of those projects objects to me adding a new check
job then reply to this thread or this patch [3]

Regarding the eventual question about the value of a non-voting job:
AFAICT, the new check job is working fine, it's catching valid errors and
succeeded where it should. I'd like to make this voting eventually, but
it's only been running in the OSC gate for about a week, and I'd like a few
non-voting runs in the plugin projects to ensure we don't have any hiccups
before making this a voting job.

[1] https://bugs.launchpad.net/python-openstackclient/+bug/1503512
[2] https://review.openstack.org/#/c/261828/
[3] https://review.openstack.org/#/c/265608/


Steve Martinelli
OpenStack Keystone Project Team Lead
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20160110/15bc6348/attachment.html>

More information about the OpenStack-dev mailing list