Merge "Add volume snapshot unmanage support"

Zuul · openstack-gerrit · commit 965c61c90ce9 · 2024-07-23T12:58:03.000Z
diff --git a/openstackclient/tests/unit/volume/v3/test_volume_snapshot.py b/openstackclient/tests/unit/volume/v3/test_volume_snapshot.py
@@ -17,16 +17,19 @@
 from osc_lib import utils
 
 from openstackclient.tests.unit.volume.v2 import fakes as volume_fakes
+from openstackclient.tests.unit.volume.v3 import fakes as volume_fakes_v3
 from openstackclient.volume.v3 import volume_snapshot
 
 
-class TestVolumeSnapshot(volume_fakes.TestVolume):
+class TestVolumeSnapshot(volume_fakes_v3.TestVolume):
     def setUp(self):
         super().setUp()
 
         self.snapshots_mock = self.volume_client.volume_snapshots
         self.snapshots_mock.reset_mock()
 
+        self.volume_sdk_client.unmanage_snapshot.return_value = None
+
 
 class TestVolumeSnapshotDelete(TestVolumeSnapshot):
     snapshots = volume_fakes.create_snapshots(count=2)
@@ -111,3 +114,48 @@ def test_delete_multiple_snapshots_with_exception(self):
             self.snapshots_mock.delete.assert_called_once_with(
                 self.snapshots[0].id, False
             )
+
+    def test_snapshot_delete_remote(self):
+        arglist = ['--remote', self.snapshots[0].id]
+        verifylist = [('remote', True), ("snapshots", [self.snapshots[0].id])]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+
+        self.volume_sdk_client.unmanage_snapshot.assert_called_with(
+            self.snapshots[0].id
+        )
+        self.assertIsNone(result)
+
+    def test_snapshot_delete_with_remote_force(self):
+        arglist = ['--remote', '--force', self.snapshots[0].id]
+        verifylist = [
+            ('remote', True),
+            ('force', True),
+            ("snapshots", [self.snapshots[0].id]),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        exc = self.assertRaises(
+            exceptions.CommandError, self.cmd.take_action, parsed_args
+        )
+        self.assertIn(
+            "The --force option is not supported with the --remote "
+            "parameter.",
+            str(exc),
+        )
+
+    def test_delete_multiple_snapshots_remote(self):
+        arglist = ['--remote']
+        for s in self.snapshots:
+            arglist.append(s.id)
+        verifylist = [('remote', True), ('snapshots', arglist[1:])]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        result = self.cmd.take_action(parsed_args)
+
+        calls = []
+        for s in self.snapshots:
+            calls.append(mock.call(s.id))
+        self.volume_sdk_client.unmanage_snapshot.assert_has_calls(calls)
+        self.assertIsNone(result)
diff --git a/openstackclient/volume/v3/volume_snapshot.py b/openstackclient/volume/v3/volume_snapshot.py
@@ -44,20 +44,41 @@ def get_parser(self, prog_name):
                 "regardless of state (defaults to False)"
             ),
         )
+        parser.add_argument(
+            '--remote',
+            action='store_true',
+            help=_(
+                'Unmanage the snapshot, removing it from the Block Storage '
+                'service management but not from the backend.'
+            ),
+        )
         return parser
 
     def take_action(self, parsed_args):
         volume_client = self.app.client_manager.volume
+        volume_client_sdk = self.app.client_manager.sdk_connection.volume
+
         result = 0
 
+        if parsed_args.remote:
+            if parsed_args.force:
+                msg = _(
+                    "The --force option is not supported with the "
+                    "--remote parameter."
+                )
+                raise exceptions.CommandError(msg)
+
         for i in parsed_args.snapshots:
             try:
                 snapshot_id = utils.find_resource(
                     volume_client.volume_snapshots, i
                 ).id
-                volume_client.volume_snapshots.delete(
-                    snapshot_id, parsed_args.force
-                )
+                if parsed_args.remote:
+                    volume_client_sdk.unmanage_snapshot(snapshot_id)
+                else:
+                    volume_client.volume_snapshots.delete(
+                        snapshot_id, parsed_args.force
+                    )
             except Exception as e:
                 result += 1
                 LOG.error(
diff --git a/releasenotes/notes/add-snapshot-unmanage-command-d4c0c8fd8b638d48.yaml b/releasenotes/notes/add-snapshot-unmanage-command-d4c0c8fd8b638d48.yaml
@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Added support for unmanaging snapshots with the
+    ``openstack snapshot delete --remote`` command.
