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

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

@@ -0,0 +1,158 @@
+#
+#   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 osc_lib.cli import format_columns
+
+from openstackclient.tests.unit.volume.v3 import fakes as volume_fakes
+from openstackclient.volume.v3 import volume_backend
+
+
+class TestShowVolumeCapability(volume_fakes.TestVolume):
+    """Test backend capability functionality."""
+
+    # The capability to be listed
+    capability = volume_fakes.create_one_capability()
+
+    def setUp(self):
+        super().setUp()
+
+        # Assign return value to capabilities mock
+        self.volume_sdk_client.get_capabilities.return_value = self.capability
+
+        # Get the command object to test
+        self.cmd = volume_backend.ShowCapability(self.app, None)
+
+    def test_capability_show(self):
+        self.set_volume_api_version('3.0')
+
+        arglist = [
+            'fake',
+        ]
+        verifylist = [
+            ('host', 'fake'),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        # In base command class Lister in cliff, abstract method take_action()
+        # returns a tuple containing the column names and an iterable
+        # containing the data to be listed.
+        columns, data = self.cmd.take_action(parsed_args)
+
+        expected_columns = [
+            'Title',
+            'Key',
+            'Type',
+            'Description',
+        ]
+
+        # confirming if all expected columns are present in the result.
+        self.assertEqual(expected_columns, columns)
+
+        capabilities = [
+            'Compression',
+            'Replication',
+            'QoS',
+            'Thin Provisioning',
+        ]
+
+        # confirming if all expected values are present in the result.
+        for cap in data:
+            self.assertIn(cap[0], capabilities)
+
+        # checking if proper call was made to get capabilities
+        self.volume_sdk_client.get_capabilities.assert_called_with(
+            'fake',
+        )
+
+
+class TestListVolumePool(volume_fakes.TestVolume):
+    """Tests for volume backend pool listing."""
+
+    # The pool to be listed
+    pools = volume_fakes.create_one_pool()
+
+    def setUp(self):
+        super().setUp()
+
+        self.volume_sdk_client.backend_pools.return_value = [self.pools]
+
+        # Get the command object to test
+        self.cmd = volume_backend.ListPool(self.app, None)
+
+    def test_pool_list(self):
+        self.set_volume_api_version('3.0')
+
+        arglist = []
+        verifylist = []
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        # In base command class Lister in cliff, abstract method take_action()
+        # returns a tuple containing the column names and an iterable
+        # containing the data to be listed.
+        columns, data = self.cmd.take_action(parsed_args)
+
+        expected_columns = [
+            'Name',
+        ]
+
+        # confirming if all expected columns are present in the result.
+        self.assertEqual(expected_columns, columns)
+
+        datalist = ((self.pools.name,),)
+
+        # confirming if all expected values are present in the result.
+        self.assertEqual(datalist, tuple(data))
+
+        # checking if proper call was made to list pools
+        self.volume_sdk_client.backend_pools.assert_called_with(
+            detailed=False,
+        )
+
+        # checking if long columns are present in output
+        self.assertNotIn("total_volumes", columns)
+        self.assertNotIn("storage_protocol", columns)
+
+    def test_service_list_with_long_option(self):
+        self.set_volume_api_version('3.0')
+
+        arglist = ['--long']
+        verifylist = [('long', True)]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        # In base command class Lister in cliff, abstract method take_action()
+        # returns a tuple containing the column names and an iterable
+        # containing the data to be listed.
+        columns, data = self.cmd.take_action(parsed_args)
+
+        expected_columns = [
+            'Name',
+            'Capabilities',
+        ]
+
+        # confirming if all expected columns are present in the result.
+        self.assertEqual(expected_columns, columns)
+
+        datalist = (
+            (
+                self.pools.name,
+                format_columns.DictColumn(self.pools.capabilities),
+            ),
+        )
+
+        # confirming if all expected values are present in the result.
+        self.assertEqual(datalist, tuple(data))
+
+        self.volume_sdk_client.backend_pools.assert_called_with(
+            detailed=True,
+        )

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

@@ -319,11 +319,7 @@ class TestBackupList(volume_fakes.TestVolume):
         'Incremental',
         'Created At',
     )
-    columns_long = columns + (
-        'Availability Zone',
-        'Volume',
-        'Container',
-    )
+    columns_long = (*columns, 'Availability Zone', 'Volume', 'Container')
 
     def setUp(self):
         super().setUp()
@@ -397,6 +393,7 @@ class TestBackupList(volume_fakes.TestVolume):
             all_tenants=False,
             marker=None,
             limit=None,
+            max_items=None,
             project_id=None,
         )
         self.assertEqual(self.columns, columns)
@@ -448,6 +445,7 @@ class TestBackupList(volume_fakes.TestVolume):
             all_tenants=True,
             marker=self.backups[0].id,
             limit=3,
+            max_items=None,
             project_id=project.id,
         )
         self.assertEqual(self.columns_long, columns)
@@ -498,9 +496,7 @@ class TestBackupRestore(volume_fakes.TestVolume):
 
         columns, data = self.cmd.take_action(parsed_args)
         self.volume_sdk_client.restore_backup.assert_called_with(
-            self.backup.id,
-            volume_id=None,
-            name=None,
+            self.backup.id, volume=None, name=None
         )
 
         self.assertEqual(self.columns, columns)
@@ -522,9 +518,7 @@ class TestBackupRestore(volume_fakes.TestVolume):
 
         columns, data = self.cmd.take_action(parsed_args)
         self.volume_sdk_client.restore_backup.assert_called_with(
-            self.backup.id,
-            volume_id=None,
-            name=self.backup.volume_id,
+            self.backup.id, volume=None, name=self.backup.volume_id
         )
 
         self.assertEqual(self.columns, columns)
@@ -545,9 +539,7 @@ class TestBackupRestore(volume_fakes.TestVolume):
 
         columns, data = self.cmd.take_action(parsed_args)
         self.volume_sdk_client.restore_backup.assert_called_with(
-            self.backup.id,
-            volume_id=self.volume.id,
-            name=None,
+            self.backup.id, volume=self.volume.id, name=None
         )
 
         self.assertEqual(self.columns, columns)

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

@@ -180,6 +180,59 @@ class TestVolumeSnapshotCreate(volume_fakes.TestVolume):
         )
         self.volume_sdk_client.create_snapshot.assert_not_called()
 
+    def test_snapshot_create_pre_v366(self):
+        self.set_volume_api_version('3.65')
+
+        arglist = ["--force", self.snapshot.name]
+        verifylist = [("force", True), ("snapshot_name", self.snapshot.name)]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # force parameter should be passed
+        self.volume_sdk_client.create_snapshot.assert_called_with(
+            volume_id=self.snapshot.volume_id,
+            force=True,
+            name=self.snapshot.name,
+            description=None,
+            metadata=None,
+        )
+
+    def test_snapshot_create_v366_or_later(self):
+        self.set_volume_api_version('3.66')
+
+        arglist = [self.snapshot.name]
+        verifylist = [("force", False), ("snapshot_name", self.snapshot.name)]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # force parameter should not be passed, for >=3.66
+        self.volume_sdk_client.create_snapshot.assert_called_with(
+            volume_id=self.snapshot.volume_id,
+            name=self.snapshot.name,
+            description=None,
+            metadata=None,
+        )
+
+    def test_snapshot_create_v366_or_later_with_force(self):
+        """--force should be ignored for microversion >= 3.66."""
+        self.set_volume_api_version('3.66')
+
+        arglist = ["--force", self.snapshot.name]
+        verifylist = [("force", True), ("snapshot_name", self.snapshot.name)]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # passed but ignored
+        self.volume_sdk_client.create_snapshot.assert_called_with(
+            volume_id=self.snapshot.volume_id,
+            name=self.snapshot.name,
+            description=None,
+            metadata=None,
+        )
+
 
 class TestVolumeSnapshotDelete(volume_fakes.TestVolume):
     def setUp(self):
@@ -340,7 +393,8 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.project_mock.get.return_value = self.project
 
         self.columns = ("ID", "Name", "Description", "Status", "Size")
-        self.columns_long = self.columns + (
+        self.columns_long = (
+            *self.columns,
             "Created At",
             "Volume",
             "Properties",
@@ -385,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,
@@ -418,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,
@@ -439,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,
@@ -465,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,
@@ -491,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',
@@ -517,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/tests/unit/volume/v3/test_volume_type.py

@@ -331,7 +331,7 @@ class TestTypeList(TestType):
         "Name",
         "Is Public",
     ]
-    columns_long = columns + ["Description", "Properties"]
+    columns_long = [*columns, "Description", "Properties"]
     data_with_default_type = [(volume_types[0].id, volume_types[0].name, True)]
     data = []
     for t in volume_types:
@@ -509,9 +509,7 @@ class TestTypeList(TestType):
             'key_size': None,
             'control_location': 'front-end',
         }
-        encryption_columns = self.columns + [
-            "Encryption",
-        ]
+        encryption_columns = [*self.columns, "Encryption"]
         encryption_data = []
         encryption_data.append(
             (

openstackclient/volume/client.py

@@ -13,7 +13,9 @@
 #   under the License.
 #
 
+import argparse
 import logging
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -34,7 +36,7 @@ API_VERSIONS = {
 _volume_api_version = None
 
 
-def make_client(instance):
+def make_client(instance: Any) -> Any:
     """Returns a volume service client."""
 
     # Defer client imports until we actually need them
@@ -92,7 +94,9 @@ def make_client(instance):
     return client
 
 
-def build_option_parser(parser):
+def build_option_parser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
     """Hook to add global options"""
     parser.add_argument(
         '--os-volume-api-version',
@@ -104,7 +108,7 @@ def build_option_parser(parser):
     return parser
 
 
-def check_api_version(check_version):
+def check_api_version(check_version: str) -> bool:
     """Validate version supplied by user
 
     Returns:

openstackclient/volume/v2/backup_record.py

@@ -14,7 +14,10 @@
 
 """Volume v2 Backup action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib import utils
 
@@ -33,7 +36,7 @@ Backup information can be imported into a new service instance to be able to
 restore."""
     )
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "backup",
@@ -42,7 +45,9 @@ restore."""
         )
         return parser
 
-    def take_action(self, parsed_args):
+    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)
@@ -53,7 +58,8 @@ restore."""
             backup_data['Backup Service'] = backup_data.pop('backup_service')
             backup_data['Metadata'] = backup_data.pop('backup_url')
 
-        return zip(*sorted(backup_data.items()))
+        col_headers, col_data = zip(*sorted(backup_data.items()))
+        return col_headers, col_data
 
 
 class ImportBackupRecord(command.ShowOne):
@@ -64,7 +70,7 @@ Exported backup details contain the metadata necessary to restore to a new or
 rebuilt service instance"""
     )
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "backup_service",
@@ -78,10 +84,13 @@ rebuilt service instance"""
         )
         return parser
 
-    def take_action(self, parsed_args):
+    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)
-        return zip(*sorted(backup_data.items()))
+        col_headers, col_data = zip(*sorted(backup_data.items()))
+        return col_headers, col_data