Cinder: Adds a api mv 3.66 check for snapshot creation

auniyal61 · auniyal61 · commit 01bdf5feb312 · 2026-05-08T14:26:58.000+05:30
Since api mv 3.66 the --force parameter is not requied for snapshot creation. In-use volumes snapshot can be taken by default without requiring the force flag. This is already handled in cinder side. fixed conflict master -> 2026.1: added import: from openstack import utils as sdk_utils fixed conflict stable/2025.2 -> stable/2025.1: - placed backport fix/changes to v2/volume_snapshot.py because CreateVolumeSnapshot class is in v2, not v3 - added import: from cinderclient import api_versions - changed mv check from sdk_utils.supports_microversion() to volume_client.api_version < api_versions.APIVersion('3.66') - set default api_version in tests to fix existing tests that now trigger mv check take_action() Closes-Bug: #2089188 Change-Id: I452ad973c76fa7f039797e8ea02556bf9fe7315c Signed-off-by: Amit Uniyal <auniyal@redhat.com> (cherry picked from commit ede91ec) (cherry picked from commit 97d6641) (cherry picked from commit 896a167)
diff --git a/openstackclient/tests/unit/volume/v2/test_volume_snapshot.py b/openstackclient/tests/unit/volume/v2/test_volume_snapshot.py
@@ -13,6 +13,7 @@
 
 from unittest import mock
 
+from cinderclient import api_versions
 from osc_lib.cli import format_columns
 from osc_lib import exceptions
 from osc_lib import utils
@@ -69,6 +70,10 @@ def setUp(self):
         self.volumes_mock.get.return_value = self.volume
         self.snapshots_mock.create.return_value = self.new_snapshot
         self.snapshots_mock.manage.return_value = self.new_snapshot
+        # Set default api_version for all tests
+        # CreateVolumeSnapshot now checks api_version to handle mv 3.66 logic
+        # in take_action()
+        self.volume_client.api_version = api_versions.APIVersion('3.0')
         # Get the command object to test
         self.cmd = volume_snapshot.CreateVolumeSnapshot(self.app, None)
 
@@ -183,6 +188,77 @@ def test_snapshot_create_with_remote_source(self):
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, data)
 
+    def test_snapshot_create_pre_v366(self):
+        self.volume_client.api_version = api_versions.APIVersion('3.65')
+
+        arglist = ["--force", self.new_snapshot.name]
+        verifylist = [
+            ("force", True),
+            ("snapshot_name", self.new_snapshot.name),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # force parameter should be passed
+        self.snapshots_mock.create.assert_called_with(
+            self.new_snapshot.volume_id,
+            force=True,
+            name=self.new_snapshot.name,
+            description=None,
+            metadata=None,
+        )
+
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.data, data)
+
+    def test_snapshot_create_v366_or_later(self):
+        self.volume_client.api_version = api_versions.APIVersion('3.66')
+
+        arglist = [self.new_snapshot.name]
+        verifylist = [
+            ("force", False),
+            ("snapshot_name", self.new_snapshot.name),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # force parameter should not be passed, for >=3.66
+        self.snapshots_mock.create.assert_called_with(
+            self.new_snapshot.volume_id,
+            name=self.new_snapshot.name,
+            description=None,
+            metadata=None,
+        )
+
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.data, data)
+
+    def test_snapshot_create_v366_or_later_with_force(self):
+        """--force should be ignored for microversion >= 3.66."""
+        self.volume_client.api_version = api_versions.APIVersion('3.66')
+
+        arglist = ["--force", self.new_snapshot.name]
+        verifylist = [
+            ("force", True),
+            ("snapshot_name", self.new_snapshot.name),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # passed but ignored
+        self.snapshots_mock.create.assert_called_with(
+            self.new_snapshot.volume_id,
+            name=self.new_snapshot.name,
+            description=None,
+            metadata=None,
+        )
+
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.data, data)
+
 
 class TestVolumeSnapshotDelete(TestVolumeSnapshot):
     snapshots = volume_fakes.create_snapshots(count=2)
diff --git a/openstackclient/volume/v2/volume_snapshot.py b/openstackclient/volume/v2/volume_snapshot.py
@@ -18,6 +18,7 @@
 import functools
 import logging
 
+from cinderclient import api_versions
 from cliff import columns as cliff_columns
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
@@ -88,8 +89,9 @@ def get_parser(self, prog_name):
             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(
@@ -138,13 +140,23 @@ def take_action(self, parsed_args):
             )
         else:
             # create a new snapshot from scratch
-            snapshot = volume_client.volume_snapshots.create(
-                volume_id,
-                force=parsed_args.force,
-                name=parsed_args.snapshot_name,
-                description=parsed_args.description,
-                metadata=parsed_args.property,
-            )
+            # only for microversion < 3.66, pass force parameter
+            # for backward compatibility
+            if volume_client.api_version < api_versions.APIVersion('3.66'):
+                snapshot = volume_client.volume_snapshots.create(
+                    volume_id,
+                    force=parsed_args.force,
+                    name=parsed_args.snapshot_name,
+                    description=parsed_args.description,
+                    metadata=parsed_args.property,
+                )
+            else:
+                snapshot = volume_client.volume_snapshots.create(
+                    volume_id,
+                    name=parsed_args.snapshot_name,
+                    description=parsed_args.description,
+                    metadata=parsed_args.property,
+                )
         snapshot._info.update(
             {
                 'properties': format_columns.DictColumn(
diff --git a/releasenotes/notes/bug-2089188-snapshot-mv-366-force.yaml b/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>`_]
