Merge "volume: Migrate 'volume backup record *' to SDK"

Author: Zuul

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

@@ -10,86 +10,80 @@
 #   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #   License for the specific language governing permissions and limitations
 #   under the License.
-#
+
+from openstack.block_storage.v3 import backup as _backup
+from openstack.test import fakes as sdk_fakes
 
 from openstackclient.tests.unit.volume.v2 import fakes as volume_fakes
 from openstackclient.volume.v2 import backup_record
 
 
-class TestBackupRecord(volume_fakes.TestVolume):
-    def setUp(self):
-        super().setUp()
-
-        self.backups_mock = self.volume_client.backups
-        self.backups_mock.reset_mock()
-
-
-class TestBackupRecordExport(TestBackupRecord):
-    new_backup = volume_fakes.create_one_backup(
-        attrs={'volume_id': 'a54708a2-0388-4476-a909-09579f885c25'},
+class TestBackupRecordExport(volume_fakes.TestVolume):
+    fake_backup = sdk_fakes.generate_fake_resource(
+        _backup.Backup,
+        volume_id='a54708a2-0388-4476-a909-09579f885c25',
     )
-    new_record = volume_fakes.create_backup_record()
+    fake_record = {
+        'backup-record': {
+            'backup_service': 'cinder.backup.drivers.swift.SwiftBackupDriver',
+            'backup_url': 'eyJzdGF0dXMiOiAiYXZh',
+        }
+    }
 
     def setUp(self):
         super().setUp()
 
-        self.backups_mock.export_record.return_value = self.new_record
-        self.backups_mock.get.return_value = self.new_backup
+        self.volume_sdk_client.find_backup.return_value = self.fake_backup
+        self.volume_sdk_client.export_backup.return_value = self.fake_record
 
-        # Get the command object to mock
         self.cmd = backup_record.ExportBackupRecord(self.app, None)
 
     def test_backup_export_table(self):
-        arglist = [
-            self.new_backup.name,
-        ]
-        verifylist = [
-            ("backup", self.new_backup.name),
-        ]
+        arglist = [self.fake_backup.name]
+        verifylist = [("backup", self.fake_backup.name)]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         parsed_args.formatter = 'table'
         columns, __ = self.cmd.take_action(parsed_args)
 
-        self.backups_mock.export_record.assert_called_with(
-            self.new_backup.id,
+        self.volume_sdk_client.find_backup.assert_called_once_with(
+            self.fake_backup.name, ignore_missing=False
         )
-
-        expected_columns = ('Backup Service', 'Metadata')
-        self.assertEqual(columns, expected_columns)
+        self.volume_sdk_client.export_backup.assert_called_once_with(
+            self.fake_backup
+        )
+        self.assertEqual(('Backup Service', 'Metadata'), columns)
 
     def test_backup_export_json(self):
-        arglist = [
-            self.new_backup.name,
-        ]
-        verifylist = [
-            ("backup", self.new_backup.name),
-        ]
+        arglist = [self.fake_backup.name]
+        verifylist = [("backup", self.fake_backup.name)]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         parsed_args.formatter = 'json'
         columns, __ = self.cmd.take_action(parsed_args)
 
-        self.backups_mock.export_record.assert_called_with(
-            self.new_backup.id,
+        self.volume_sdk_client.find_backup.assert_called_once_with(
+            self.fake_backup.name, ignore_missing=False
         )
-
-        expected_columns = ('backup_service', 'backup_url')
-        self.assertEqual(columns, expected_columns)
+        self.volume_sdk_client.export_backup.assert_called_once_with(
+            self.fake_backup
+        )
+        self.assertEqual(('backup_service', 'backup_url'), columns)
 
 
-class TestBackupRecordImport(TestBackupRecord):
-    new_backup = volume_fakes.create_one_backup(
-        attrs={'volume_id': 'a54708a2-0388-4476-a909-09579f885c25'},
-    )
-    new_import = volume_fakes.import_backup_record()
+class TestBackupRecordImport(volume_fakes.TestVolume):
+    fake_import = {
+        'backup': {
+            'id': 'backup.id',
+            'name': 'backup.name',
+        },
+    }
 
     def setUp(self):
         super().setUp()
 
-        self.backups_mock.import_record.return_value = self.new_import
+        self.volume_sdk_client.import_backup.return_value = self.fake_import
 
-        # Get the command object to mock
         self.cmd = backup_record.ImportBackupRecord(self.app, None)
 
     def test_backup_import(self):
@@ -108,8 +102,8 @@ def test_backup_import(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         columns, __ = self.cmd.take_action(parsed_args)
 
-        self.backups_mock.import_record.assert_called_with(
+        self.volume_sdk_client.import_backup.assert_called_once_with(
             "cinder.backup.drivers.swift.SwiftBackupDriver",
             "fake_backup_record_data",
         )
-        self.assertEqual(columns, ('backup',))
+        self.assertEqual(('backup',), columns)

openstackclient/tests/unit/volume/v3/test_backup_record.py

@@ -11,84 +11,79 @@
 #   License for the specific language governing permissions and limitations
 #   under the License.
 
+from openstack.block_storage.v3 import backup as _backup
+from openstack.test import fakes as sdk_fakes
+
 from openstackclient.tests.unit.volume.v3 import fakes as volume_fakes
 from openstackclient.volume.v3 import backup_record
 
 
-class TestBackupRecord(volume_fakes.TestVolume):
-    def setUp(self):
-        super().setUp()
-
-        self.backups_mock = self.volume_client.backups
-        self.backups_mock.reset_mock()
-
-
-class TestBackupRecordExport(TestBackupRecord):
-    new_backup = volume_fakes.create_one_backup(
-        attrs={'volume_id': 'a54708a2-0388-4476-a909-09579f885c25'},
+class TestBackupRecordExport(volume_fakes.TestVolume):
+    fake_backup = sdk_fakes.generate_fake_resource(
+        _backup.Backup,
+        volume_id='a54708a2-0388-4476-a909-09579f885c25',
     )
-    new_record = volume_fakes.create_backup_record()
+    fake_record = {
+        'backup-record': {
+            'backup_service': 'cinder.backup.drivers.swift.SwiftBackupDriver',
+            'backup_url': 'eyJzdGF0dXMiOiAiYXZh',
+        },
+    }
 
     def setUp(self):
         super().setUp()
 
-        self.backups_mock.export_record.return_value = self.new_record
-        self.backups_mock.get.return_value = self.new_backup
+        self.volume_sdk_client.find_backup.return_value = self.fake_backup
+        self.volume_sdk_client.export_backup.return_value = self.fake_record
 
-        # Get the command object to mock
         self.cmd = backup_record.ExportBackupRecord(self.app, None)
 
     def test_backup_export_table(self):
-        arglist = [
-            self.new_backup.name,
-        ]
-        verifylist = [
-            ("backup", self.new_backup.name),
-        ]
+        arglist = [self.fake_backup.name]
+        verifylist = [("backup", self.fake_backup.name)]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         parsed_args.formatter = 'table'
         columns, __ = self.cmd.take_action(parsed_args)
 
-        self.backups_mock.export_record.assert_called_with(
-            self.new_backup.id,
+        self.volume_sdk_client.find_backup.assert_called_once_with(
+            self.fake_backup.name, ignore_missing=False
         )
-
-        expected_columns = ('Backup Service', 'Metadata')
-        self.assertEqual(columns, expected_columns)
+        self.volume_sdk_client.export_backup.assert_called_once_with(
+            self.fake_backup
+        )
+        self.assertEqual(('Backup Service', 'Metadata'), columns)
 
     def test_backup_export_json(self):
-        arglist = [
-            self.new_backup.name,
-        ]
-        verifylist = [
-            ("backup", self.new_backup.name),
-        ]
+        arglist = [self.fake_backup.name]
+        verifylist = [("backup", self.fake_backup.name)]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         parsed_args.formatter = 'json'
         columns, __ = self.cmd.take_action(parsed_args)
 
-        self.backups_mock.export_record.assert_called_with(
-            self.new_backup.id,
+        self.volume_sdk_client.find_backup.assert_called_once_with(
+            self.fake_backup.name, ignore_missing=False
         )
-
-        expected_columns = ('backup_service', 'backup_url')
-        self.assertEqual(columns, expected_columns)
+        self.volume_sdk_client.export_backup.assert_called_once_with(
+            self.fake_backup
+        )
+        self.assertEqual(('backup_service', 'backup_url'), columns)
 
 
-class TestBackupRecordImport(TestBackupRecord):
-    new_backup = volume_fakes.create_one_backup(
-        attrs={'volume_id': 'a54708a2-0388-4476-a909-09579f885c25'},
-    )
-    new_import = volume_fakes.import_backup_record()
+class TestBackupRecordImport(volume_fakes.TestVolume):
+    fake_import = {
+        'backup': {
+            'id': 'backup.id',
+            'name': 'backup.name',
+        },
+    }
 
     def setUp(self):
         super().setUp()
 
-        self.backups_mock.import_record.return_value = self.new_import
+        self.volume_sdk_client.import_backup.return_value = self.fake_import
 
-        # Get the command object to mock
         self.cmd = backup_record.ImportBackupRecord(self.app, None)
 
     def test_backup_import(self):
@@ -107,8 +102,8 @@ def test_backup_import(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         columns, __ = self.cmd.take_action(parsed_args)
 
-        self.backups_mock.import_record.assert_called_with(
+        self.volume_sdk_client.import_backup.assert_called_once_with(
             "cinder.backup.drivers.swift.SwiftBackupDriver",
             "fake_backup_record_data",
         )
-        self.assertEqual(columns, ('backup',))
+        self.assertEqual(('backup',), columns)

openstackclient/volume/v2/backup_record.py

@@ -19,7 +19,7 @@
 from collections.abc import Iterable, Sequence
 from typing import Any
 
-from osc_lib import utils
+from openstack import utils as sdk_utils
 
 from openstackclient import command
 from openstackclient.i18n import _
@@ -48,9 +48,13 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[Any]]:
-        volume_client = self.app.client_manager.volume
-        backup = utils.find_resource(volume_client.backups, parsed_args.backup)
-        backup_data = volume_client.backups.export_record(backup.id)
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '2'
+        )
+        backup = volume_client.find_backup(
+            parsed_args.backup, ignore_missing=False
+        )
+        backup_data = volume_client.export_backup(backup)['backup-record']
 
         # We only want to show "friendly" display names, but also want to keep
         # json structure compatibility with cinderclient
@@ -87,8 +91,10 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[Any]]:
-        volume_client = self.app.client_manager.volume
-        backup_data = volume_client.backups.import_record(
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '2'
+        )
+        backup_data = volume_client.import_backup(
             parsed_args.backup_service, parsed_args.backup_metadata
         )
         backup_data.pop('links', None)

openstackclient/volume/v3/backup_record.py

@@ -18,7 +18,7 @@
 from collections.abc import Iterable, Sequence
 from typing import Any
 
-from osc_lib import utils
+from openstack import utils as sdk_utils
 
 from openstackclient import command
 from openstackclient.i18n import _
@@ -46,9 +46,13 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[Any]]:
-        volume_client = self.app.client_manager.volume
-        backup = utils.find_resource(volume_client.backups, parsed_args.backup)
-        backup_data = volume_client.backups.export_record(backup.id)
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
+        backup = volume_client.find_backup(
+            parsed_args.backup, ignore_missing=False
+        )
+        backup_data = volume_client.export_backup(backup)['backup-record']
 
         # We only want to show "friendly" display names, but also want to keep
         # json structure compatibility with cinderclient
@@ -85,8 +89,10 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[Any]]:
-        volume_client = self.app.client_manager.volume
-        backup_data = volume_client.backups.import_record(
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
+        backup_data = volume_client.import_backup(
             parsed_args.backup_service, parsed_args.backup_metadata
         )
         backup_data.pop('links', None)