Add "--force" option to "backup create" command in volumev2

Cinder V2 API supports creating volume backup with "--force"
option. However, OSC doesn't support this argument. So this
patch add the "--force" option to allow users to back up a
in-use volume.

Change-Id: I326f8d6172b2830da4cf1317348af50142cc5490
Closes-Bug: #1596443

Author: Huanxuan Ao

doc/source/command-objects/backup.rst

@@ -16,6 +16,7 @@ Create new backup
         [--container <container>]
         [--name <name>]
         [--description <description>]
+        [--force]
         <volume>
 
 .. option:: --container <container>
@@ -30,6 +31,10 @@ Create new backup
 
     Description of the backup
 
+.. option:: --force
+
+    Allow to back up an in-use volume
+
 .. _backup_create-backup:
 .. describe:: <volume>
 

openstackclient/tests/volume/v2/test_backup.py

@@ -72,12 +72,14 @@ def test_backup_create(self):
             "--name", self.new_backup.name,
             "--description", self.new_backup.description,
             "--container", self.new_backup.container,
+            "--force",
             self.new_backup.volume_id,
         ]
         verifylist = [
             ("name", self.new_backup.name),
             ("description", self.new_backup.description),
             ("container", self.new_backup.container),
+            ("force", True),
             ("volume", self.new_backup.volume_id),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -88,7 +90,8 @@ def test_backup_create(self):
             self.new_backup.volume_id,
             container=self.new_backup.container,
             name=self.new_backup.name,
-            description=self.new_backup.description
+            description=self.new_backup.description,
+            force=True,
         )
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, data)
@@ -112,7 +115,8 @@ def test_backup_create_without_name(self):
             self.new_backup.volume_id,
             container=self.new_backup.container,
             name=None,
-            description=self.new_backup.description
+            description=self.new_backup.description,
+            force=False,
         )
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, data)

openstackclient/volume/v2/backup.py

@@ -48,6 +48,12 @@ def get_parser(self, prog_name):
             metavar="<container>",
             help=_("Optional backup container name")
         )
+        parser.add_argument(
+            '--force',
+            action='store_true',
+            default=False,
+            help=_("Allow to back up an in-use volume")
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -58,7 +64,8 @@ def take_action(self, parsed_args):
             volume_id,
             container=parsed_args.container,
             name=parsed_args.name,
-            description=parsed_args.description
+            description=parsed_args.description,
+            force=parsed_args.force,
         )
         backup._info.pop("links", None)
         return zip(*sorted(six.iteritems(backup._info)))

releasenotes/notes/bug-1596443-9e2af267e91d1643.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Add ``--force`` option to ``backup create`` command to allow users to
+    back up an in-use volume.
+    [Bug `1596443 <https://bugs.launchpad.net/bugs/1596443>`_]