Merge "Cinder: Adds a api mv 3.66 check for snapshot creation"

Author: Zuul

openstackclient/tests/unit/volume/v3/test_volume_snapshot.py

@@ -180,6 +180,59 @@ def test_snapshot_create_with_remote_source(self):
         )
         self.volume_sdk_client.create_snapshot.assert_not_called()
 
+    def test_snapshot_create_pre_v366(self):
+        self.set_volume_api_version('3.65')
+
+        arglist = ["--force", self.snapshot.name]
+        verifylist = [("force", True), ("snapshot_name", self.snapshot.name)]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # force parameter should be passed
+        self.volume_sdk_client.create_snapshot.assert_called_with(
+            volume_id=self.snapshot.volume_id,
+            force=True,
+            name=self.snapshot.name,
+            description=None,
+            metadata=None,
+        )
+
+    def test_snapshot_create_v366_or_later(self):
+        self.set_volume_api_version('3.66')
+
+        arglist = [self.snapshot.name]
+        verifylist = [("force", False), ("snapshot_name", self.snapshot.name)]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # force parameter should not be passed, for >=3.66
+        self.volume_sdk_client.create_snapshot.assert_called_with(
+            volume_id=self.snapshot.volume_id,
+            name=self.snapshot.name,
+            description=None,
+            metadata=None,
+        )
+
+    def test_snapshot_create_v366_or_later_with_force(self):
+        """--force should be ignored for microversion >= 3.66."""
+        self.set_volume_api_version('3.66')
+
+        arglist = ["--force", self.snapshot.name]
+        verifylist = [("force", True), ("snapshot_name", self.snapshot.name)]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # passed but ignored
+        self.volume_sdk_client.create_snapshot.assert_called_with(
+            volume_id=self.snapshot.volume_id,
+            name=self.snapshot.name,
+            description=None,
+            metadata=None,
+        )
+
 
 class TestVolumeSnapshotDelete(volume_fakes.TestVolume):
     def setUp(self):

openstackclient/volume/v3/volume_snapshot.py

@@ -128,7 +128,9 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             action="store_true",
             default=False,
             help=_(
-                "Create a snapshot attached to an instance. Default is False"
+                "Allow snapshot of in-use (attached) volume. "
+                "Only needed for microversions prior to 3.66; "
+                "ignored for 3.66+"
             ),
         )
         parser.add_argument(
@@ -185,13 +187,23 @@ def take_action(
             )
         else:
             # Create a new snapshot from scratch
-            snapshot = volume_client.create_snapshot(
-                volume_id=volume_id,
-                force=parsed_args.force,
-                name=parsed_args.snapshot_name,
-                description=parsed_args.description,
-                metadata=parsed_args.properties,
-            )
+            # only for microversion < 3.66, pass force parameter
+            # for backward compatibility
+            if not sdk_utils.supports_microversion(volume_client, '3.66'):
+                snapshot = volume_client.create_snapshot(
+                    volume_id=volume_id,
+                    force=parsed_args.force,
+                    name=parsed_args.snapshot_name,
+                    description=parsed_args.description,
+                    metadata=parsed_args.properties,
+                )
+            else:
+                snapshot = volume_client.create_snapshot(
+                    volume_id=volume_id,
+                    name=parsed_args.snapshot_name,
+                    description=parsed_args.description,
+                    metadata=parsed_args.properties,
+                )
 
         data = _format_snapshot(snapshot)
         col_headers, col_data = zip(*sorted(data.items()))

releasenotes/notes/bug-2089188-snapshot-mv-366-force.yaml

@@ -0,0 +1,9 @@
+---
+fixes:
+  - |
+    Fix ``volume snapshot create`` to work with Cinder API microversion 3.66
+    and later. Since version 3.66, the 'force' parameter is no longer
+    needed for snapshot creation as in-use volumes can be snapshotted by
+    default. The command now only passes the 'force' parameter for version
+    prior to 3.66.
+    [Bug `2089188 <https://bugs.launchpad.net/python-openstackclient/+bug/2089188>`_]