python-openstackclient 6.3.0__py3-none-any.whl → 6.5.0__py3-none-any.whl

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

@@ -17,9 +17,13 @@ import random
 from unittest import mock
 import uuid
 
+# FIXME(stephenfin): We are using v3 resource versions despite being v2 fakes
 from cinderclient import api_versions
+from openstack.block_storage.v2 import _proxy as block_storage_v2_proxy
 from openstack.block_storage.v3 import backup as _backup
-from openstack.block_storage.v3 import volume
+from openstack.block_storage.v3 import capabilities as _capabilities
+from openstack.block_storage.v3 import stats as _stats
+from openstack.block_storage.v3 import volume as _volume
 from openstack.image.v2 import _proxy as image_v2_proxy
 from osc_lib.cli import format_columns
 
@@ -87,13 +91,26 @@ class FakeVolumeClient:
         self.volumes.resource_class = fakes.FakeResource(None, {})
 
 
-class TestVolume(utils.TestCommand):
+class FakeClientMixin:
     def setUp(self):
         super().setUp()
 
         self.app.client_manager.volume = FakeVolumeClient(
             endpoint=fakes.AUTH_URL, token=fakes.AUTH_TOKEN
         )
+        self.volume_client = self.app.client_manager.volume
+
+        # TODO(stephenfin): Rename to 'volume_client' once all commands are
+        # migrated to SDK
+        self.app.client_manager.sdk_connection.volume = mock.Mock(
+            spec=block_storage_v2_proxy.Proxy,
+        )
+        self.volume_sdk_client = self.app.client_manager.sdk_connection.volume
+
+
+class TestVolume(FakeClientMixin, utils.TestCommand):
+    def setUp(self):
+        super().setUp()
 
         self.app.client_manager.identity = identity_fakes.FakeIdentityv3Client(
             endpoint=fakes.AUTH_URL, token=fakes.AUTH_TOKEN
@@ -286,7 +303,7 @@ def create_one_capability(attrs=None):
     # Overwrite default attributes if there are some attributes set
     capability_info.update(attrs or {})
 
-    capability = fakes.FakeResource(None, capability_info, loaded=True)
+    capability = _capabilities.Capabilities(**capability_info)
 
     return capability
 
@@ -302,19 +319,21 @@ def create_one_pool(attrs=None):
     # Set default attribute
     pool_info = {
         'name': 'host@lvmdriver-1#lvmdriver-1',
-        'storage_protocol': 'iSCSI',
-        'thick_provisioning_support': False,
-        'thin_provisioning_support': True,
-        'total_volumes': 99,
-        'total_capacity_gb': 1000.00,
-        'allocated_capacity_gb': 100,
-        'max_over_subscription_ratio': 200.0,
+        'capabilities': {
+            'storage_protocol': 'iSCSI',
+            'thick_provisioning_support': False,
+            'thin_provisioning_support': True,
+            'total_volumes': 99,
+            'total_capacity_gb': 1000.00,
+            'allocated_capacity_gb': 100,
+            'max_over_subscription_ratio': 200.0,
+        },
     }
 
     # Overwrite default attributes if there are some attributes set
     pool_info.update(attrs or {})
 
-    pool = fakes.FakeResource(None, pool_info, loaded=True)
+    pool = _stats.Pools(**pool_info)
 
     return pool
 
@@ -413,7 +432,7 @@ def create_one_sdk_volume(attrs=None):
 
     # Overwrite default attributes if there are some attributes set
     volume_info.update(attrs)
-    return volume.Volume(**volume_info)
+    return _volume.Volume(**volume_info)
 
 
 def create_sdk_volumes(attrs=None, count=2):
@@ -520,6 +539,7 @@ def create_one_backup(attrs=None):
         "object_count": None,
         "container": 'container-' + uuid.uuid4().hex,
         "size": random.randint(1, 20),
+        "is_incremental": False,
         "status": "error",
         "availability_zone": 'zone' + uuid.uuid4().hex,
     }

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

@@ -20,7 +20,7 @@ class TestBackupRecord(volume_fakes.TestVolume):
     def setUp(self):
         super().setUp()
 
-        self.backups_mock = self.app.client_manager.volume.backups
+        self.backups_mock = self.volume_client.backups
         self.backups_mock.reset_mock()
 
 

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

@@ -28,18 +28,16 @@ class TestConsistencyGroup(volume_fakes.TestVolume):
         super().setUp()
 
         # Get a shortcut to the TransferManager Mock
-        self.consistencygroups_mock = (
-            self.app.client_manager.volume.consistencygroups
-        )
+        self.consistencygroups_mock = self.volume_client.consistencygroups
         self.consistencygroups_mock.reset_mock()
 
-        self.cgsnapshots_mock = self.app.client_manager.volume.cgsnapshots
+        self.cgsnapshots_mock = self.volume_client.cgsnapshots
         self.cgsnapshots_mock.reset_mock()
 
-        self.volumes_mock = self.app.client_manager.volume.volumes
+        self.volumes_mock = self.volume_client.volumes
         self.volumes_mock.reset_mock()
 
-        self.types_mock = self.app.client_manager.volume.volume_types
+        self.types_mock = self.volume_client.volume_types
         self.types_mock.reset_mock()
 
 

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

@@ -23,11 +23,9 @@ class TestConsistencyGroupSnapshot(volume_fakes.TestVolume):
         super(TestConsistencyGroupSnapshot, self).setUp()
 
         # Get a shortcut to the TransferManager Mock
-        self.cgsnapshots_mock = self.app.client_manager.volume.cgsnapshots
+        self.cgsnapshots_mock = self.volume_client.cgsnapshots
         self.cgsnapshots_mock.reset_mock()
-        self.consistencygroups_mock = (
-            self.app.client_manager.volume.consistencygroups
-        )
+        self.consistencygroups_mock = self.volume_client.consistencygroups
         self.consistencygroups_mock.reset_mock()
 
 

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

@@ -29,10 +29,10 @@ class TestQos(volume_fakes.TestVolume):
     def setUp(self):
         super(TestQos, self).setUp()
 
-        self.qos_mock = self.app.client_manager.volume.qos_specs
+        self.qos_mock = self.volume_client.qos_specs
         self.qos_mock.reset_mock()
 
-        self.types_mock = self.app.client_manager.volume.volume_types
+        self.types_mock = self.volume_client.volume_types
         self.types_mock.reset_mock()
 
 

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

@@ -23,7 +23,7 @@ class TestService(volume_fakes.TestVolume):
         super().setUp()
 
         # Get a shortcut to the ServiceManager Mock
-        self.service_mock = self.app.client_manager.volume.services
+        self.service_mock = self.volume_client.services
         self.service_mock.reset_mock()
 
 

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

@@ -10,9 +10,7 @@
 #   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #   License for the specific language governing permissions and limitations
 #   under the License.
-#
 
-import argparse
 from unittest import mock
 from unittest.mock import call
 
@@ -23,7 +21,7 @@ from osc_lib import utils
 
 from openstackclient.tests.unit.identity.v3 import fakes as identity_fakes
 from openstackclient.tests.unit.image.v2 import fakes as image_fakes
-from openstackclient.tests.unit import utils as tests_utils
+from openstackclient.tests.unit import utils as test_utils
 from openstackclient.tests.unit.volume.v2 import fakes as volume_fakes
 from openstackclient.volume.v2 import volume
 
@@ -32,7 +30,7 @@ class TestVolume(volume_fakes.TestVolume):
     def setUp(self):
         super().setUp()
 
-        self.volumes_mock = self.app.client_manager.volume.volumes
+        self.volumes_mock = self.volume_client.volumes
         self.volumes_mock.reset_mock()
 
         self.projects_mock = self.app.client_manager.identity.projects
@@ -41,18 +39,16 @@ class TestVolume(volume_fakes.TestVolume):
         self.users_mock = self.app.client_manager.identity.users
         self.users_mock.reset_mock()
 
-        self.snapshots_mock = self.app.client_manager.volume.volume_snapshots
+        self.snapshots_mock = self.volume_client.volume_snapshots
         self.snapshots_mock.reset_mock()
 
-        self.backups_mock = self.app.client_manager.volume.backups
+        self.backups_mock = self.volume_client.backups
         self.backups_mock.reset_mock()
 
-        self.types_mock = self.app.client_manager.volume.volume_types
+        self.types_mock = self.volume_client.volume_types
         self.types_mock.reset_mock()
 
-        self.consistencygroups_mock = (
-            self.app.client_manager.volume.consistencygroups
-        )
+        self.consistencygroups_mock = self.volume_client.consistencygroups
         self.consistencygroups_mock.reset_mock()
 
     def setup_volumes_mock(self, count):
@@ -365,9 +361,7 @@ class TestVolumeCreate(TestVolume):
 
         self.backups_mock.get.return_value = backup
 
-        self.app.client_manager.volume.api_version = api_versions.APIVersion(
-            '3.47'
-        )
+        self.volume_client.api_version = api_versions.APIVersion('3.47')
 
         # In base command class ShowOne in cliff, abstract method take_action()
         # returns a two-part tuple with a tuple of column names and a tuple of
@@ -679,13 +673,81 @@ class TestVolumeCreate(TestVolume):
         ]
 
         self.assertRaises(
-            tests_utils.ParserException,
+            test_utils.ParserException,
             self.check_parser,
             self.cmd,
             arglist,
             verifylist,
         )
 
+    def test_volume_create_hints(self):
+        """--hint needs to behave differently based on the given hint
+
+        different_host and same_host need to append to a list if given multiple
+        times. All other parameter are strings.
+        """
+        arglist = [
+            '--size',
+            str(self.new_volume.size),
+            '--hint',
+            'k=v',
+            '--hint',
+            'k=v2',
+            '--hint',
+            'same_host=v3',
+            '--hint',
+            'same_host=v4',
+            '--hint',
+            'different_host=v5',
+            '--hint',
+            'local_to_instance=v6',
+            '--hint',
+            'different_host=v7',
+            self.new_volume.name,
+        ]
+        verifylist = [
+            ('size', self.new_volume.size),
+            (
+                'hint',
+                {
+                    'k': 'v2',
+                    'same_host': ['v3', 'v4'],
+                    'local_to_instance': 'v6',
+                    'different_host': ['v5', 'v7'],
+                },
+            ),
+            ('name', self.new_volume.name),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        # In base command class ShowOne in cliff, abstract method take_action()
+        # returns a two-part tuple with a tuple of column names and a tuple of
+        # data to be shown.
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volumes_mock.create.assert_called_with(
+            size=self.new_volume.size,
+            snapshot_id=None,
+            name=self.new_volume.name,
+            description=None,
+            volume_type=None,
+            availability_zone=None,
+            metadata=None,
+            imageRef=None,
+            source_volid=None,
+            consistencygroup_id=None,
+            scheduler_hints={
+                'k': 'v2',
+                'same_host': ['v3', 'v4'],
+                'local_to_instance': 'v6',
+                'different_host': ['v5', 'v7'],
+            },
+            backup_id=None,
+        )
+
+        self.assertEqual(self.columns, columns)
+        self.assertCountEqual(self.datalist, data)
+
 
 class TestVolumeDelete(TestVolume):
     def setUp(self):
@@ -1283,7 +1345,7 @@ class TestVolumeList(TestVolume):
             ("limit", -2),
         ]
         self.assertRaises(
-            argparse.ArgumentTypeError,
+            test_utils.ParserException,
             self.check_parser,
             self.cmd,
             arglist,
@@ -1394,7 +1456,7 @@ class TestVolumeMigrate(TestVolume):
         ]
 
         self.assertRaises(
-            tests_utils.ParserException,
+            test_utils.ParserException,
             self.check_parser,
             self.cmd,
             arglist,

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

@@ -12,6 +12,8 @@
 #   under the License.
 #
 
+from osc_lib.cli import format_columns
+
 from openstackclient.tests.unit.volume.v2 import fakes as volume_fakes
 from openstackclient.volume.v2 import volume_backend
 
@@ -25,9 +27,8 @@ class TestShowVolumeCapability(volume_fakes.TestVolume):
     def setUp(self):
         super().setUp()
 
-        # Get a shortcut to the capability Mock
-        self.capability_mock = self.app.client_manager.volume.capabilities
-        self.capability_mock.get.return_value = self.capability
+        # 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)
@@ -68,7 +69,7 @@ class TestShowVolumeCapability(volume_fakes.TestVolume):
             self.assertIn(cap[0], capabilities)
 
         # checking if proper call was made to get capabilities
-        self.capability_mock.get.assert_called_with(
+        self.volume_sdk_client.get_capabilities.assert_called_with(
             'fake',
         )
 
@@ -82,8 +83,7 @@ class TestListVolumePool(volume_fakes.TestVolume):
     def setUp(self):
         super().setUp()
 
-        self.pool_mock = self.app.client_manager.volume.pools
-        self.pool_mock.list.return_value = [self.pools]
+        self.volume_sdk_client.backend_pools.return_value = [self.pools]
 
         # Get the command object to test
         self.cmd = volume_backend.ListPool(self.app, None)
@@ -111,7 +111,7 @@ class TestListVolumePool(volume_fakes.TestVolume):
         self.assertEqual(datalist, tuple(data))
 
         # checking if proper call was made to list pools
-        self.pool_mock.list.assert_called_with(
+        self.volume_sdk_client.backend_pools.assert_called_with(
             detailed=False,
         )
 
@@ -131,13 +131,7 @@ class TestListVolumePool(volume_fakes.TestVolume):
 
         expected_columns = [
             'Name',
-            'Protocol',
-            'Thick',
-            'Thin',
-            'Volumes',
-            'Capacity',
-            'Allocated',
-            'Max Over Ratio',
+            'Capabilities',
         ]
 
         # confirming if all expected columns are present in the result.
@@ -146,19 +140,13 @@ class TestListVolumePool(volume_fakes.TestVolume):
         datalist = (
             (
                 self.pools.name,
-                self.pools.storage_protocol,
-                self.pools.thick_provisioning_support,
-                self.pools.thin_provisioning_support,
-                self.pools.total_volumes,
-                self.pools.total_capacity_gb,
-                self.pools.allocated_capacity_gb,
-                self.pools.max_over_subscription_ratio,
+                format_columns.DictColumn(self.pools.capabilities),
             ),
         )
 
         # confirming if all expected values are present in the result.
         self.assertEqual(datalist, tuple(data))
 
-        self.pool_mock.list.assert_called_with(
+        self.volume_sdk_client.backend_pools.assert_called_with(
             detailed=True,
         )