python-openstackclient 10.0.0__py3-none-any.whl → 10.1.0__py3-none-any.whl

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

@@ -459,3 +459,68 @@ class TestVolumeGroupTypeList(TestVolumeGroupType):
         self.assertIn(
             '--os-volume-api-version 3.11 or greater is required', str(exc)
         )
+
+
+class TestVolumeGroupTypeShow(TestVolumeGroupType):
+    fake_volume_group_type = volume_fakes.create_one_volume_group_type()
+
+    columns = (
+        'ID',
+        'Name',
+        'Description',
+        'Is Public',
+        'Properties',
+    )
+    data = (
+        fake_volume_group_type.id,
+        fake_volume_group_type.name,
+        fake_volume_group_type.description,
+        fake_volume_group_type.is_public,
+        format_columns.DictColumn(fake_volume_group_type.group_specs),
+    )
+
+    def setUp(self):
+        super().setUp()
+
+        self.volume_group_types_mock.get.return_value = (
+            self.fake_volume_group_type
+        )
+
+        self.cmd = volume_group_type.ShowVolumeGroupType(self.app, None)
+
+    def test_volume_group_type_show(self):
+        self.set_volume_api_version('3.11')
+
+        arglist = [
+            self.fake_volume_group_type.id,
+        ]
+        verifylist = [
+            ('group_type', self.fake_volume_group_type.id),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volume_group_types_mock.get.assert_called_once_with(
+            self.fake_volume_group_type.id,
+        )
+        self.assertEqual(self.columns, columns)
+        self.assertCountEqual(self.data, data)
+
+    def test_volume_group_type_show_pre_v311(self):
+        self.set_volume_api_version('3.10')
+
+        arglist = [
+            self.fake_volume_group_type.id,
+        ]
+        verifylist = [
+            ('group_type', self.fake_volume_group_type.id),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        exc = self.assertRaises(
+            exceptions.CommandError, self.cmd.take_action, parsed_args
+        )
+        self.assertIn(
+            '--os-volume-api-version 3.11 or greater is required', str(exc)
+        )

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

@@ -0,0 +1,115 @@
+#
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   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 openstackclient.tests.unit.volume.v3 import fakes as volume_fakes
+from openstackclient.volume.v3 import volume_host
+
+
+class TestVolumeHost(volume_fakes.TestVolume):
+    def setUp(self):
+        super().setUp()
+
+        self.host_mock = self.volume_client.services
+        self.host_mock.reset_mock()
+
+
+class TestVolumeHostSet(TestVolumeHost):
+    service = volume_fakes.create_one_service()
+
+    def setUp(self):
+        super().setUp()
+
+        self.host_mock.freeze_host.return_value = None
+        self.host_mock.thaw_host.return_value = None
+
+        # Get the command object to mock
+        self.cmd = volume_host.SetVolumeHost(self.app, None)
+
+    def test_volume_host_set_nothing(self):
+        arglist = [
+            self.service.host,
+        ]
+        verifylist = [
+            ('host', self.service.host),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        result = self.cmd.take_action(parsed_args)
+
+        self.host_mock.freeze_host.assert_not_called()
+        self.host_mock.thaw_host.assert_not_called()
+        self.assertIsNone(result)
+
+    def test_volume_host_set_enable(self):
+        arglist = [
+            '--enable',
+            self.service.host,
+        ]
+        verifylist = [
+            ('enable', True),
+            ('host', self.service.host),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+
+        self.host_mock.thaw_host.assert_called_with(self.service.host)
+        self.host_mock.freeze_host.assert_not_called()
+        self.assertIsNone(result)
+
+    def test_volume_host_set_disable(self):
+        arglist = [
+            '--disable',
+            self.service.host,
+        ]
+        verifylist = [
+            ('disable', True),
+            ('host', self.service.host),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+
+        self.host_mock.freeze_host.assert_called_with(self.service.host)
+        self.host_mock.thaw_host.assert_not_called()
+        self.assertIsNone(result)
+
+
+class TestVolumeHostFailover(TestVolumeHost):
+    service = volume_fakes.create_one_service()
+
+    def setUp(self):
+        super().setUp()
+
+        self.host_mock.failover_host.return_value = None
+
+        # Get the command object to mock
+        self.cmd = volume_host.FailoverVolumeHost(self.app, None)
+
+    def test_volume_host_failover(self):
+        arglist = [
+            '--volume-backend',
+            'backend_test',
+            self.service.host,
+        ]
+        verifylist = [
+            ('volume_backend', 'backend_test'),
+            ('host', self.service.host),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+
+        self.host_mock.failover_host.assert_called_with(
+            self.service.host, 'backend_test'
+        )
+        self.assertIsNone(result)

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

@@ -439,6 +439,7 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.volume_sdk_client.snapshots.assert_called_once_with(
             limit=None,
             marker=None,
+            max_items=None,
             all_projects=False,
             name=None,
             status=None,
@@ -472,6 +473,7 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.volume_sdk_client.snapshots.assert_called_once_with(
             limit=2,
             marker=self.snapshots[0].id,
+            max_items=None,
             all_projects=True,
             project_id=self.project.id,
             name=None,
@@ -493,6 +495,7 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.volume_sdk_client.snapshots.assert_called_once_with(
             limit=None,
             marker=None,
+            max_items=None,
             all_projects=True,
             name=None,
             status=None,
@@ -519,6 +522,7 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.volume_sdk_client.snapshots.assert_called_once_with(
             limit=None,
             marker=None,
+            max_items=None,
             all_projects=False,
             name=self.snapshots[0].name,
             status=None,
@@ -545,6 +549,7 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.volume_sdk_client.snapshots.assert_called_once_with(
             limit=None,
             marker=None,
+            max_items=None,
             all_projects=False,
             name=None,
             status='available',
@@ -571,6 +576,7 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.volume_sdk_client.snapshots.assert_called_once_with(
             limit=None,
             marker=None,
+            max_items=None,
             all_projects=False,
             name=None,
             status=None,

openstackclient/volume/v2/volume.py

@@ -102,7 +102,7 @@ class AttachmentsColumn(cliff_columns.FormattableColumn[list[Any]]):
         return msg
 
 
-def _format_volume(volume: _volume.Volume) -> dict[str, Any]:
+def _format_volume(volume: _volume.Volume) -> dict[str, object]:
     # Some columns returned by openstacksdk should not be shown because they're
     # either irrelevant or duplicates
     ignored_columns = {
@@ -494,7 +494,9 @@ class ListVolume(command.Lister):
             default=False,
             help=_('List additional fields in output'),
         )
-        pagination.add_marker_pagination_option_to_parser(parser)
+        pagination.add_marker_pagination_option_to_parser(
+            parser, include_max_items=False
+        )
         return parser
 
     def take_action(

openstackclient/volume/v2/volume_backup.py

@@ -322,6 +322,7 @@ class ListVolumeBackup(command.Lister):
             all_tenants=parsed_args.all_projects,
             marker=marker_backup_id,
             limit=parsed_args.limit,
+            max_items=parsed_args.max_items,
         )
 
         return (
@@ -404,9 +405,7 @@ class RestoreVolumeBackup(command.ShowOne):
                 raise exceptions.CommandError(msg % parsed_args.volume)
 
         restore = volume_client.restore_backup(
-            backup.id,
-            volume_id=volume_id,
-            name=volume_name,
+            backup.id, volume=volume_id, name=volume_name
         )
 
         data = utils.get_dict_properties(restore, columns)

openstackclient/volume/v2/volume_snapshot.py

@@ -66,7 +66,7 @@ class VolumeIdColumn(cliff_columns.FormattableColumn[str]):
         return volume
 
 
-def _format_snapshot(snapshot: _snapshot.Snapshot) -> dict[str, Any]:
+def _format_snapshot(snapshot: _snapshot.Snapshot) -> dict[str, object]:
     # Some columns returned by openstacksdk should not be shown because they're
     # either irrelevant or duplicates
     ignored_columns = {
@@ -231,11 +231,9 @@ class DeleteVolumeSnapshot(command.Command):
                 snapshot_id = volume_client.find_snapshot(
                     snapshot, ignore_missing=False
                 ).id
-                # FIXME(stephenfin): This parameter is missing from sdk
-                # https://review.opendev.org/c/openstack/openstacksdk/+/984529
                 volume_client.delete_snapshot(
                     snapshot_id,
-                    force=parsed_args.force,  # type: ignore
+                    force=parsed_args.force,
                 )
             except Exception as e:
                 result += 1
@@ -378,6 +376,7 @@ class ListVolumeSnapshot(command.Lister):
         data = volume_client.snapshots(
             marker=parsed_args.marker,
             limit=parsed_args.limit,
+            max_items=parsed_args.max_items,
             all_projects=all_projects,
             project_id=project_id,
             name=parsed_args.name,

openstackclient/volume/v3/backup_record.py

@@ -0,0 +1,94 @@
+#
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+
+"""Volume v3 Backup action implementations"""
+
+import argparse
+import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
+
+from osc_lib import utils
+
+from openstackclient import command
+from openstackclient.i18n import _
+
+LOG = logging.getLogger(__name__)
+
+
+class ExportBackupRecord(command.ShowOne):
+    _description = _(
+        """Export volume backup details.
+
+Backup information can be imported into a new service instance to be able to
+restore."""
+    )
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "backup",
+            metavar="<backup>",
+            help=_("Backup to export (name or ID)"),
+        )
+        return parser
+
+    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)
+
+        # We only want to show "friendly" display names, but also want to keep
+        # json structure compatibility with cinderclient
+        if parsed_args.formatter == 'table':
+            backup_data['Backup Service'] = backup_data.pop('backup_service')
+            backup_data['Metadata'] = backup_data.pop('backup_url')
+
+        col_headers, col_data = zip(*sorted(backup_data.items()))
+        return col_headers, col_data
+
+
+class ImportBackupRecord(command.ShowOne):
+    _description = _(
+        """Import volume backup details.
+
+Exported backup details contain the metadata necessary to restore to a new or
+rebuilt service instance"""
+    )
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "backup_service",
+            metavar="<backup_service>",
+            help=_("Backup service containing the backup."),
+        )
+        parser.add_argument(
+            "backup_metadata",
+            metavar="<backup_metadata>",
+            help=_("Encoded backup metadata from export."),
+        )
+        return parser
+
+    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(
+            parsed_args.backup_service, parsed_args.backup_metadata
+        )
+        backup_data.pop('links', None)
+        col_headers, col_data = zip(*sorted(backup_data.items()))
+        return col_headers, col_data