Handle not having cinderclient.v1 available

The Cinder v1 API was deprecated several years ago and may be removed
from python-cinderclient in the near future. To handle the case where v1
is no longer present, this updates cinderclient initialization to work
without it and give an appropriate error if v1 is requested with a
version where it is no longer available.

Change-Id: I277d7b48b8ad4cce383ec3722f8117938378f615
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>

Author: stmcginnis

openstackclient/tests/unit/volume/test_find_resource.py

@@ -15,8 +15,8 @@
 
 import mock
 
-from cinderclient.v1 import volume_snapshots
-from cinderclient.v1 import volumes
+from cinderclient.v3 import volume_snapshots
+from cinderclient.v3 import volumes
 from osc_lib import exceptions
 from osc_lib import utils
 

openstackclient/tests/unit/volume/v2/test_volume.py

@@ -131,7 +131,6 @@ def test_volume_create_min_options(self):
             imageRef=None,
             source_volid=None,
             consistencygroup_id=None,
-            multiattach=False,
             scheduler_hints=None,
         )
 
@@ -149,7 +148,6 @@ def test_volume_create_options(self):
             '--availability-zone', self.new_volume.availability_zone,
             '--consistency-group', consistency_group.id,
             '--hint', 'k=v',
-            '--multi-attach',
             self.new_volume.name,
         ]
         verifylist = [
@@ -159,7 +157,6 @@ def test_volume_create_options(self):
             ('availability_zone', self.new_volume.availability_zone),
             ('consistency_group', consistency_group.id),
             ('hint', {'k': 'v'}),
-            ('multi_attach', True),
             ('name', self.new_volume.name),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -180,7 +177,6 @@ def test_volume_create_options(self):
             imageRef=None,
             source_volid=None,
             consistencygroup_id=consistency_group.id,
-            multiattach=True,
             scheduler_hints={'k': 'v'},
         )
 
@@ -251,7 +247,6 @@ def test_volume_create_properties(self):
             imageRef=None,
             source_volid=None,
             consistencygroup_id=None,
-            multiattach=False,
             scheduler_hints=None,
         )
 
@@ -290,7 +285,6 @@ def test_volume_create_image_id(self):
             imageRef=image.id,
             source_volid=None,
             consistencygroup_id=None,
-            multiattach=False,
             scheduler_hints=None,
         )
 
@@ -329,7 +323,6 @@ def test_volume_create_image_name(self):
             imageRef=image.id,
             source_volid=None,
             consistencygroup_id=None,
-            multiattach=False,
             scheduler_hints=None,
         )
 
@@ -367,7 +360,6 @@ def test_volume_create_with_snapshot(self):
             imageRef=None,
             source_volid=None,
             consistencygroup_id=None,
-            multiattach=False,
             scheduler_hints=None,
         )
 
@@ -406,7 +398,6 @@ def test_volume_create_with_bootable_and_readonly(self):
             imageRef=None,
             source_volid=None,
             consistencygroup_id=None,
-            multiattach=False,
             scheduler_hints=None,
         )
 
@@ -449,7 +440,6 @@ def test_volume_create_with_nonbootable_and_readwrite(self):
             imageRef=None,
             source_volid=None,
             consistencygroup_id=None,
-            multiattach=False,
             scheduler_hints=None,
         )
 
@@ -501,7 +491,6 @@ def test_volume_create_with_bootable_and_readonly_fail(
             imageRef=None,
             source_volid=None,
             consistencygroup_id=None,
-            multiattach=False,
             scheduler_hints=None,
         )
 

openstackclient/volume/client.py

@@ -37,13 +37,20 @@ def make_client(instance):
 
     # Defer client imports until we actually need them
     from cinderclient import extension
-    from cinderclient.v1.contrib import list_extensions
-    from cinderclient.v1 import volume_snapshots
-    from cinderclient.v1 import volumes
-
-    # Monkey patch for v1 cinderclient
-    volumes.Volume.NAME_ATTR = 'display_name'
-    volume_snapshots.Snapshot.NAME_ATTR = 'display_name'
+    from cinderclient.v3.contrib import list_extensions
+    from cinderclient.v3 import volume_snapshots
+    from cinderclient.v3 import volumes
+
+    # Try a small import to check if cinderclient v1 is supported
+    try:
+        from cinderclient.v1 import services  # noqa
+    except Exception:
+        del API_VERSIONS['1']
+
+    if instance._api_version[API_NAME] == '1':
+        # Monkey patch for v1 cinderclient
+        volumes.Volume.NAME_ATTR = 'display_name'
+        volume_snapshots.Snapshot.NAME_ATTR = 'display_name'
 
     volume_client = utils.get_client_class(
         API_NAME,

openstackclient/volume/v2/volume.py

@@ -212,6 +212,9 @@ def take_action(self, parsed_args):
             raise exceptions.CommandError(
                 _("ERROR: --user is deprecated, please use"
                   " --os-username instead."))
+        if parsed_args.multi_attach:
+            LOG.warning(_("'--multi-attach' option is no longer supported by "
+                          "the block storage service."))
 
         volume = volume_client.volumes.create(
             size=size,
@@ -224,7 +227,6 @@ def take_action(self, parsed_args):
             imageRef=image,
             source_volid=source_volume,
             consistencygroup_id=consistency_group,
-            multiattach=parsed_args.multi_attach,
             scheduler_hints=parsed_args.hint,
         )