Merge "Add '--force' option to 'volume snapshot delete' command"

Author: Jenkins

doc/source/command-objects/volume-snapshot.rst

@@ -51,8 +51,13 @@ Delete volume snapshot(s)
 .. code:: bash
 
     os volume snapshot delete
+        [--force]
         <snapshot> [<snapshot> ...]
 
+.. option:: --force
+
+    Attempt forced removal of snapshot(s), regardless of state (defaults to False)
+
 .. _volume_snapshot_delete-snapshot:
 .. describe:: <snapshot>
 

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

@@ -179,7 +179,24 @@ def test_snapshot_delete(self):
         result = self.cmd.take_action(parsed_args)
 
         self.snapshots_mock.delete.assert_called_with(
-            self.snapshots[0].id)
+            self.snapshots[0].id, False)
+        self.assertIsNone(result)
+
+    def test_snapshot_delete_with_force(self):
+        arglist = [
+            '--force',
+            self.snapshots[0].id
+        ]
+        verifylist = [
+            ('force', True),
+            ("snapshots", [self.snapshots[0].id])
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+
+        self.snapshots_mock.delete.assert_called_with(
+            self.snapshots[0].id, True)
         self.assertIsNone(result)
 
     def test_delete_multiple_snapshots(self):
@@ -195,7 +212,7 @@ def test_delete_multiple_snapshots(self):
 
         calls = []
         for s in self.snapshots:
-            calls.append(call(s.id))
+            calls.append(call(s.id, False))
         self.snapshots_mock.delete.assert_has_calls(calls)
         self.assertIsNone(result)
 
@@ -226,7 +243,7 @@ def test_delete_multiple_snapshots_with_exception(self):
 
             self.assertEqual(2, find_mock.call_count)
             self.snapshots_mock.delete.assert_called_once_with(
-                self.snapshots[0].id
+                self.snapshots[0].id, False
             )
 
 

openstackclient/volume/v2/volume_snapshot.py

@@ -98,6 +98,12 @@ def get_parser(self, prog_name):
             nargs="+",
             help=_("Snapshot(s) to delete (name or ID)")
         )
+        parser.add_argument(
+            '--force',
+            action='store_true',
+            help=_("Attempt forced removal of snapshot(s), "
+                   "regardless of state (defaults to False)")
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -108,7 +114,8 @@ def take_action(self, parsed_args):
             try:
                 snapshot_id = utils.find_resource(
                     volume_client.volume_snapshots, i).id
-                volume_client.volume_snapshots.delete(snapshot_id)
+                volume_client.volume_snapshots.delete(
+                    snapshot_id, parsed_args.force)
             except Exception as e:
                 result += 1
                 LOG.error(_("Failed to delete snapshot with "

releasenotes/notes/bug-1597195-54ff1ecf381899f6.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Add ``--force`` option to ``volume snapshot delete`` command to allow delete
+    in state other than error or available.
+    [Bug `1597195 <https://bugs.launchpad.net/bugs/1597195>`_]