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

openstackclient/tests/unit/object/v1/test_object.py

@@ -14,29 +14,12 @@
 #
 
 import copy
-from unittest import mock
 
-from openstackclient.api import object_store_v1 as object_store
 from openstackclient.object.v1 import object as obj
 from openstackclient.tests.unit.object.v1 import fakes as object_fakes
 
 
-AUTH_TOKEN = "foobar"
-AUTH_URL = "http://0.0.0.0"
-
-
-class TestObject(object_fakes.TestObjectv1):
-    def setUp(self):
-        super().setUp()
-        self.app.client_manager.object_store = object_store.APIv1(
-            session=mock.Mock(),
-            service_type="object-store",
-        )
-        self.api = self.app.client_manager.object_store
-
-
-@mock.patch('openstackclient.api.object_store_v1.APIv1.object_list')
-class TestObjectList(TestObject):
+class TestObjectList(object_fakes.TestObjectV1):
     columns = ('Name',)
     datalist = ((object_fakes.object_name_2,),)
 
@@ -46,8 +29,8 @@ class TestObjectList(TestObject):
         # Get the command object to test
         self.cmd = obj.ListObject(self.app, None)
 
-    def test_object_list_objects_no_options(self, o_mock):
-        o_mock.return_value = [
+    def test_object_list_objects_no_options(self):
+        self.object_store_client.object_list.return_value = [
             copy.deepcopy(object_fakes.OBJECT),
             copy.deepcopy(object_fakes.OBJECT_2),
         ]
@@ -65,7 +48,7 @@ class TestObjectList(TestObject):
         # containing the data to be listed.
         columns, data = self.cmd.take_action(parsed_args)
 
-        o_mock.assert_called_with(
+        self.object_store_client.object_list.assert_called_with(
             container=object_fakes.container_name,
         )
 
@@ -76,8 +59,8 @@ class TestObjectList(TestObject):
         )
         self.assertEqual(datalist, tuple(data))
 
-    def test_object_list_objects_prefix(self, o_mock):
-        o_mock.return_value = [
+    def test_object_list_objects_prefix(self):
+        self.object_store_client.object_list.return_value = [
             copy.deepcopy(object_fakes.OBJECT_2),
         ]
 
@@ -97,19 +80,16 @@ class TestObjectList(TestObject):
         # containing the data to be listed.
         columns, data = self.cmd.take_action(parsed_args)
 
-        # Set expected values
-        kwargs = {
-            'prefix': 'floppy',
-        }
-        o_mock.assert_called_with(
-            container=object_fakes.container_name_2, **kwargs
+        self.object_store_client.object_list.assert_called_with(
+            container=object_fakes.container_name_2,
+            prefix='floppy',
         )
 
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.datalist, tuple(data))
 
-    def test_object_list_objects_delimiter(self, o_mock):
-        o_mock.return_value = [
+    def test_object_list_objects_delimiter(self):
+        self.object_store_client.object_list.return_value = [
             copy.deepcopy(object_fakes.OBJECT_2),
         ]
 
@@ -129,19 +109,16 @@ class TestObjectList(TestObject):
         # containing the data to be listed.
         columns, data = self.cmd.take_action(parsed_args)
 
-        # Set expected values
-        kwargs = {
-            'delimiter': '=',
-        }
-        o_mock.assert_called_with(
-            container=object_fakes.container_name_2, **kwargs
+        self.object_store_client.object_list.assert_called_with(
+            container=object_fakes.container_name_2,
+            delimiter='=',
         )
 
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.datalist, tuple(data))
 
-    def test_object_list_objects_marker(self, o_mock):
-        o_mock.return_value = [
+    def test_object_list_objects_marker(self):
+        self.object_store_client.object_list.return_value = [
             copy.deepcopy(object_fakes.OBJECT_2),
         ]
 
@@ -161,19 +138,16 @@ class TestObjectList(TestObject):
         # containing the data to be listed.
         columns, data = self.cmd.take_action(parsed_args)
 
-        # Set expected values
-        kwargs = {
-            'marker': object_fakes.object_name_2,
-        }
-        o_mock.assert_called_with(
-            container=object_fakes.container_name_2, **kwargs
+        self.object_store_client.object_list.assert_called_with(
+            container=object_fakes.container_name_2,
+            marker=object_fakes.object_name_2,
         )
 
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.datalist, tuple(data))
 
-    def test_object_list_objects_end_marker(self, o_mock):
-        o_mock.return_value = [
+    def test_object_list_objects_end_marker(self):
+        self.object_store_client.object_list.return_value = [
             copy.deepcopy(object_fakes.OBJECT_2),
         ]
 
@@ -193,19 +167,16 @@ class TestObjectList(TestObject):
         # containing the data to be listed.
         columns, data = self.cmd.take_action(parsed_args)
 
-        # Set expected values
-        kwargs = {
-            'end_marker': object_fakes.object_name_2,
-        }
-        o_mock.assert_called_with(
-            container=object_fakes.container_name_2, **kwargs
+        self.object_store_client.object_list.assert_called_with(
+            container=object_fakes.container_name_2,
+            end_marker=object_fakes.object_name_2,
         )
 
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.datalist, tuple(data))
 
-    def test_object_list_objects_limit(self, o_mock):
-        o_mock.return_value = [
+    def test_object_list_objects_limit(self):
+        self.object_store_client.object_list.return_value = [
             copy.deepcopy(object_fakes.OBJECT_2),
         ]
 
@@ -225,19 +196,16 @@ class TestObjectList(TestObject):
         # containing the data to be listed.
         columns, data = self.cmd.take_action(parsed_args)
 
-        # Set expected values
-        kwargs = {
-            'limit': 2,
-        }
-        o_mock.assert_called_with(
-            container=object_fakes.container_name_2, **kwargs
+        self.object_store_client.object_list.assert_called_with(
+            container=object_fakes.container_name_2,
+            limit=2,
         )
 
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.datalist, tuple(data))
 
-    def test_object_list_objects_long(self, o_mock):
-        o_mock.return_value = [
+    def test_object_list_objects_long(self):
+        self.object_store_client.object_list.return_value = [
             copy.deepcopy(object_fakes.OBJECT),
             copy.deepcopy(object_fakes.OBJECT_2),
         ]
@@ -257,10 +225,8 @@ class TestObjectList(TestObject):
         # containing the data to be listed.
         columns, data = self.cmd.take_action(parsed_args)
 
-        # Set expected values
-        kwargs = {}
-        o_mock.assert_called_with(
-            container=object_fakes.container_name, **kwargs
+        self.object_store_client.object_list.assert_called_with(
+            container=object_fakes.container_name,
         )
 
         collist = ('Name', 'Bytes', 'Hash', 'Content Type', 'Last Modified')
@@ -283,8 +249,8 @@ class TestObjectList(TestObject):
         )
         self.assertEqual(datalist, tuple(data))
 
-    def test_object_list_objects_all(self, o_mock):
-        o_mock.return_value = [
+    def test_object_list_objects_all(self):
+        self.object_store_client.object_list.return_value = [
             copy.deepcopy(object_fakes.OBJECT),
             copy.deepcopy(object_fakes.OBJECT_2),
         ]
@@ -304,12 +270,9 @@ class TestObjectList(TestObject):
         # containing the data to be listed.
         columns, data = self.cmd.take_action(parsed_args)
 
-        # Set expected values
-        kwargs = {
-            'full_listing': True,
-        }
-        o_mock.assert_called_with(
-            container=object_fakes.container_name, **kwargs
+        self.object_store_client.object_list.assert_called_with(
+            container=object_fakes.container_name,
+            full_listing=True,
         )
 
         self.assertEqual(self.columns, columns)
@@ -320,16 +283,17 @@ class TestObjectList(TestObject):
         self.assertEqual(datalist, tuple(data))
 
 
-@mock.patch('openstackclient.api.object_store_v1.APIv1.object_show')
-class TestObjectShow(TestObject):
+class TestObjectShow(object_fakes.TestObjectV1):
     def setUp(self):
         super().setUp()
 
         # Get the command object to test
         self.cmd = obj.ShowObject(self.app, None)
 
-    def test_object_show(self, c_mock):
-        c_mock.return_value = copy.deepcopy(object_fakes.OBJECT)
+    def test_object_show(self):
+        self.object_store_client.object_show.return_value = copy.deepcopy(
+            object_fakes.OBJECT
+        )
 
         arglist = [
             object_fakes.container_name,
@@ -346,13 +310,9 @@ class TestObjectShow(TestObject):
         # data to be shown.
         columns, data = self.cmd.take_action(parsed_args)
 
-        # Set expected values
-        kwargs = {}
-        # lib.container.show_container(api, url, container)
-        c_mock.assert_called_with(
+        self.object_store_client.object_show.assert_called_with(
             container=object_fakes.container_name,
             object=object_fakes.object_name_1,
-            **kwargs,
         )
 
         collist = ('bytes', 'content_type', 'hash', 'last_modified', 'name')

openstackclient/tests/unit/object/v1/test_object_all.py

@@ -15,18 +15,25 @@ import copy
 import io
 from unittest import mock
 
+from keystoneauth1 import session
 from osc_lib import exceptions
 from requests_mock.contrib import fixture
 
+from openstackclient.api import object_store_v1 as object_store
 from openstackclient.object.v1 import object as object_cmds
 from openstackclient.tests.unit.object.v1 import fakes as object_fakes
 
 
-class TestObjectAll(object_fakes.TestObjectv1):
+class TestObjectAll(object_fakes.TestObjectV1):
     def setUp(self):
         super().setUp()
 
+        # these tests require a "real" client since we mock requests
         self.requests_mock = self.useFixture(fixture.Fixture())
+        self.app.client_manager.object_store = object_store.APIv1(
+            session=session.Session(),
+            endpoint=object_fakes.ENDPOINT,
+        )
 
 
 class TestObjectCreate(TestObjectAll):

openstackclient/tests/unit/test_hacking.py

@@ -0,0 +1,108 @@
+# 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.
+
+import importlib.util
+import os
+import re
+import subprocess
+import sys
+import unittest
+
+import fixtures
+
+ROOT_DIR = os.path.normpath(
+    os.path.join(os.path.dirname(__file__), '..', '..', '..')
+)
+SELFTEST_REGEX = re.compile(r'\b(Okay|[HEW]\d{3}|O\d{3}):\s(.*)')
+
+# Checks that filter on 'openstackclient/tests/unit' in the filename need the
+# temp file written into that path structure so the check is not skipped.
+_UNIT_TEST_SUBDIRS = {
+    'O401': os.path.join('openstackclient', 'tests', 'unit'),
+    'O402': os.path.join('openstackclient', 'tests', 'unit'),
+}
+
+
+def _load_checks():
+    spec = importlib.util.spec_from_file_location(
+        '_osc_hacking_checks',
+        os.path.join(ROOT_DIR, 'hacking', 'checks.py'),
+    )
+    module = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(module)
+    return module
+
+
+def _get_examples(check):
+    for line in check.__doc__.splitlines():
+        line = line.lstrip()
+        match = SELFTEST_REGEX.match(line)
+        if match:
+            yield match.group(1), match.group(2)
+
+
+class HackingTestCase(unittest.TestCase):
+    def _test_check(self, code, source):
+        lines = [
+            part.replace(r'\t', '\t') + '\n' for part in source.split(r'\n')
+        ]
+        subdir = {
+            'O401': os.path.join('openstackclient', 'tests', 'unit'),
+            'O402': os.path.join('openstackclient', 'tests', 'unit'),
+        }.get(code, '')
+
+        with fixtures.TempDir() as tmp:
+            dirpath = os.path.join(tmp.path, subdir) if subdir else tmp.path
+            if subdir:
+                os.makedirs(dirpath)
+
+            fpath = os.path.join(dirpath, 'test_tmp.py')
+            with open(fpath, 'w') as f:
+                f.write(''.join(lines))
+
+            cmd = [
+                sys.executable,
+                '-mflake8',
+                '--config',
+                os.path.join(ROOT_DIR, 'tox.ini'),
+                f'--select={code}',
+                '--format=%(code)s\t%(path)s\t%(row)d',
+                fpath,
+            ]
+            out, _ = subprocess.Popen(
+                cmd, stdout=subprocess.PIPE, cwd=ROOT_DIR
+            ).communicate()
+            out = out.decode('utf-8')
+
+            if code == 'Okay':
+                self.assertEqual('', out)
+            else:
+                self.assertNotEqual('', out, f"Failed to trigger rule {code}")
+                self.assertEqual(code, out.split('\t')[0].rstrip(':'), out)
+
+    def test_checks(self):
+        checks_module = _load_checks()
+
+        for name in sorted(dir(checks_module)):
+            check = getattr(checks_module, name)
+            if not callable(check):
+                continue
+
+            if getattr(check, 'skip_on_py3', None) is not False:
+                continue
+
+            if not check.__doc__:
+                continue
+
+            for code, source in _get_examples(check):
+                with self.subTest(check=name, example=source):
+                    self._test_check(code, source)

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

@@ -88,6 +88,7 @@ class FakeClientMixin:
         self.app.client_manager.sdk_connection.volume = mock.Mock(
             spec=block_storage_v2_proxy.Proxy,
         )
+        self.app.client_manager.sdk_connection.volume.api_version = '2'
         self.volume_sdk_client = self.app.client_manager.sdk_connection.volume
         self.set_volume_api_version()  # default to the lowest
 

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

@@ -220,11 +220,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()

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

@@ -297,7 +297,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",

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

@@ -332,7 +332,7 @@ class TestTypeList(TestType):
         "Name",
         "Is Public",
     ]
-    columns_long = columns + ["Description"]
+    columns_long = [*columns, "Description"]
     data_with_default_type = [(volume_types[0].id, volume_types[0].name, True)]
     data = []
     for t in volume_types:
@@ -436,9 +436,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/tests/unit/volume/v3/fakes.py

@@ -96,6 +96,7 @@ class FakeClientMixin:
         self.app.client_manager.sdk_connection.volume = mock.Mock(
             spec=_proxy.Proxy,
         )
+        self.app.client_manager.sdk_connection.volume.api_version = '3'
         self.volume_sdk_client = self.app.client_manager.sdk_connection.volume
         self.set_volume_api_version()  # default to the lowest
 

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

@@ -1723,9 +1723,10 @@ class TestVolumeMigrate(volume_fakes.TestVolume):
             host="host@backend-name#pool",
             force_host_copy=False,
             lock_volume=False,
+            cluster=None,
         )
 
-    def test_volume_migrate_with_option(self):
+    def test_volume_migrate_with_host(self):
         arglist = [
             "--force-host-copy",
             "--lock-volume",
@@ -1752,9 +1753,66 @@ class TestVolumeMigrate(volume_fakes.TestVolume):
             host="host@backend-name#pool",
             force_host_copy=True,
             lock_volume=True,
+            cluster=None,
         )
 
-    def test_volume_migrate_without_host(self):
+    def test_volume_migrate_with_cluster(self):
+        self.set_volume_api_version('3.16')
+        arglist = [
+            "--cluster",
+            "cluster@backend-name#pool",
+            self.volume.id,
+        ]
+        verifylist = [
+            (
+                "cluster",
+                "cluster@backend-name#pool",
+            ),
+            ("volume", self.volume.id),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+        self.assertIsNone(result)
+
+        self.volume_sdk_client.find_volume.assert_called_with(
+            self.volume.id, ignore_missing=False
+        )
+        self.volume_sdk_client.migrate_volume.assert_called_once_with(
+            self.volume.id,
+            host=None,
+            force_host_copy=False,
+            lock_volume=False,
+            cluster="cluster@backend-name#pool",
+        )
+
+    def test_volume_migrate_with_cluster_pre_v316(self):
+        self.set_volume_api_version('3.15')
+        arglist = [
+            "--cluster",
+            "cluster@backend-name#pool",
+            self.volume.id,
+        ]
+        verifylist = [
+            (
+                "cluster",
+                "cluster@backend-name#pool",
+            ),
+            ("volume", self.volume.id),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.assertRaises(
+            exceptions.CommandError,
+            self.cmd.take_action,
+            parsed_args,
+        )
+
+        self.volume_sdk_client.migrate_volume.assert_not_called()
+
+    def test_volume_migrate_without_host_and_cluster(self):
         arglist = [
             self.volume.id,
         ]
@@ -1771,7 +1829,6 @@ class TestVolumeMigrate(volume_fakes.TestVolume):
             arglist,
             verifylist,
         )
-
         self.volume_sdk_client.find_volume.assert_not_called()
         self.volume_sdk_client.migrate_volume.assert_not_called()
 

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

@@ -23,7 +23,7 @@ class TestVolumeAttachment(volume_fakes.TestVolume):
     def setUp(self):
         super().setUp()
 
-        self.projects_mock = self.app.client_manager.identity.projects
+        self.projects_mock = self.identity_client.projects
 
 
 class TestVolumeAttachmentCreate(TestVolumeAttachment):

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()

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",

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(
             (