Refactor "volume backup restore" command

Make the positional argument "volume" optional and add a "--force"
option (volume v2 only) to the "volume backup restore" command.

Closes-Bug: #1597189
Change-Id: If944e10158bd18e8331be63e96187a23e23095d7

2 files changed, 113 insertions, 13 deletions

diff --git a/openstackclient/tests/unit/volume/v1/test_volume_backup.py b/openstackclient/tests/unit/volume/v1/test_volume_backup.py
index f25a5ffa..2f568929 100644
--- a/openstackclient/tests/unit/volume/v1/test_volume_backup.py
+++ b/openstackclient/tests/unit/volume/v1/test_volume_backup.py
@@ -319,29 +319,69 @@ class TestBackupRestore(TestBackup):
         attrs={'volume_id': volume.id})
 
     def setUp(self):
-        super(TestBackupRestore, self).setUp()
+        super().setUp()
 
         self.backups_mock.get.return_value = self.backup
         self.volumes_mock.get.return_value = self.volume
-        self.restores_mock.restore.return_value = None
+        self.restores_mock.restore.return_value = (
+            volume_fakes.FakeVolume.create_one_volume(
+                {'id': self.volume['id']},
+            )
+        )
         # Get the command object to mock
         self.cmd = volume_backup.RestoreVolumeBackup(self.app, None)
 
     def test_backup_restore(self):
         arglist = [
             self.backup.id,
-            self.backup.volume_id
         ]
         verifylist = [
             ("backup", self.backup.id),
-            ("volume", self.backup.volume_id)
+            ("volume", None),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         result = self.cmd.take_action(parsed_args)
         self.restores_mock.restore.assert_called_with(self.backup.id,
-                                                      self.backup.volume_id)
-        self.assertIsNone(result)
+                                                      None)
+        self.assertIsNotNone(result)
+
+    def test_backup_restore_with_existing_volume(self):
+        arglist = [
+            self.backup.id,
+            self.backup.volume_id,
+        ]
+        verifylist = [
+            ("backup", self.backup.id),
+            ("volume", self.backup.volume_id),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+        self.restores_mock.restore.assert_called_with(
+            self.backup.id, self.backup.volume_id,
+        )
+        self.assertIsNotNone(result)
+
+    def test_backup_restore_with_invalid_volume(self):
+        arglist = [
+            self.backup.id,
+            "unexist_volume",
+        ]
+        verifylist = [
+            ("backup", self.backup.id),
+            ("volume", "unexist_volume"),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        with mock.patch.object(
+            utils, 'find_resource',
+            side_effect=exceptions.CommandError(),
+        ):
+            self.assertRaises(
+                exceptions.CommandError,
+                self.cmd.take_action,
+                parsed_args,
+            )
 
 
 class TestBackupShow(TestBackup):
diff --git a/openstackclient/tests/unit/volume/v2/test_volume_backup.py b/openstackclient/tests/unit/volume/v2/test_volume_backup.py
index 4b9212d0..ffd84901 100644
--- a/openstackclient/tests/unit/volume/v2/test_volume_backup.py
+++ b/openstackclient/tests/unit/volume/v2/test_volume_backup.py
@@ -458,35 +458,95 @@ class TestBackupRestore(TestBackup):
 
     volume = volume_fakes.FakeVolume.create_one_volume()
     backup = volume_fakes.FakeBackup.create_one_backup(
-        attrs={'volume_id': volume.id})
+        attrs={'volume_id': volume.id},
+    )
 
     def setUp(self):
-        super(TestBackupRestore, self).setUp()
+        super().setUp()
 
         self.backups_mock.get.return_value = self.backup
         self.volumes_mock.get.return_value = self.volume
         self.restores_mock.restore.return_value = (
             volume_fakes.FakeVolume.create_one_volume(
-                {'id': self.volume['id']}))
+                {'id': self.volume['id']},
+            )
+        )
         # Get the command object to mock
         self.cmd = volume_backup.RestoreVolumeBackup(self.app, None)
 
     def test_backup_restore(self):
+        self.volumes_mock.get.side_effect = exceptions.CommandError()
+        self.volumes_mock.find.side_effect = exceptions.CommandError()
+        arglist = [
+            self.backup.id
+        ]
+        verifylist = [
+            ("backup", self.backup.id),
+            ("volume", None),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+        self.restores_mock.restore.assert_called_with(
+            self.backup.id, None, None,
+        )
+        self.assertIsNotNone(result)
+
+    def test_backup_restore_with_volume(self):
+        self.volumes_mock.get.side_effect = exceptions.CommandError()
+        self.volumes_mock.find.side_effect = exceptions.CommandError()
+        arglist = [
+            self.backup.id,
+            self.backup.volume_id,
+        ]
+        verifylist = [
+            ("backup", self.backup.id),
+            ("volume", self.backup.volume_id),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+        self.restores_mock.restore.assert_called_with(
+            self.backup.id, None, self.backup.volume_id,
+        )
+        self.assertIsNotNone(result)
+
+    def test_backup_restore_with_volume_force(self):
         arglist = [
+            "--force",
             self.backup.id,
-            self.backup.volume_id
+            self.volume.name,
         ]
         verifylist = [
+            ("force", True),
             ("backup", self.backup.id),
-            ("volume", self.backup.volume_id)
+            ("volume", self.volume.name),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         result = self.cmd.take_action(parsed_args)
-        self.restores_mock.restore.assert_called_with(self.backup.id,
-                                                      self.backup.volume_id)
+        self.restores_mock.restore.assert_called_with(
+            self.backup.id, self.volume.id, None,
+        )
         self.assertIsNotNone(result)
 
+    def test_backup_restore_with_volume_existing(self):
+        arglist = [
+            self.backup.id,
+            self.volume.name,
+        ]
+        verifylist = [
+            ("backup", self.backup.id),
+            ("volume", self.volume.name),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.assertRaises(
+            exceptions.CommandError,
+            self.cmd.take_action,
+            parsed_args,
+        )
+
 
 class TestBackupSet(TestBackup):