python-openstackclient 8.1.0__py3-none-any.whl → 8.3.0__py3-none-any.whl

openstackclient/tests/unit/compute/v2/test_server_backup.py

@@ -161,9 +161,7 @@ class TestServerBackupCreate(compute_fakes.TestComputev2):
 
     @mock.patch.object(common_utils, 'wait_for_status', return_value=True)
     def test_server_backup_wait_ok(self, mock_wait_for_status):
-        self.image_client.get_image = mock.Mock(
-            side_effect=self.image,
-        )
+        self.image_client.get_image.side_effect = (self.image,)
 
         arglist = [
             '--name',

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

@@ -77,9 +77,7 @@ class TestServiceDelete(compute_fakes.TestComputev2):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         delete_mock_result = [None, exceptions.CommandError]
-        self.compute_client.delete_service = mock.Mock(
-            side_effect=delete_mock_result
-        )
+        self.compute_client.delete_service.side_effect = delete_mock_result
 
         try:
             self.cmd.take_action(parsed_args)

openstackclient/tests/unit/fakes.py

@@ -12,13 +12,43 @@
 #   License for the specific language governing permissions and limitations
 #   under the License.
 
+# TODO(stephenfin): Remove the contents of this module in favour of the osc_lib
+# version once our min version is bumped to 4.3.0
+
 import json
-import sys
 from unittest import mock
 
 from keystoneauth1 import fixture
+from osc_lib.tests.fakes import (
+    FakeApp,
+    FakeClientManager as BaseFakeClientManager,
+    FakeLog,
+    FakeOptions,
+    FakeResource as BaseFakeResource,
+    FakeStdout,
+)
 import requests
 
+__all__ = [
+    'AUTH_TOKEN',
+    'AUTH_URL',
+    'INTERFACE',
+    'PASSWORD',
+    'PROJECT_NAME',
+    'REGION_NAME',
+    'TEST_RESPONSE_DICT',
+    'TEST_RESPONSE_DICT_V3',
+    'TEST_VERSIONS',
+    'USERNAME',
+    'VERSION',
+    'FakeApp',
+    'FakeClientManager',
+    'FakeLog',
+    'FakeOptions',
+    'FakeResource',
+    'FakeResponse',
+    'FakeStdout',
+]
 
 AUTH_TOKEN = "foobar"
 AUTH_URL = "http://0.0.0.0"
@@ -47,79 +77,15 @@ TEST_RESPONSE_DICT_V3.set_project_scope()
 TEST_VERSIONS = fixture.DiscoveryList(href=AUTH_URL)
 
 
-class FakeStdout:
-    def __init__(self):
-        self.content = []
-
-    def write(self, text):
-        self.content.append(text)
-
-    def make_string(self):
-        result = ''
-        for line in self.content:
-            result = result + line
-        return result
-
-
-class FakeLog:
-    def __init__(self):
-        self.messages = {}
-
-    def debug(self, msg):
-        self.messages['debug'] = msg
-
-    def info(self, msg):
-        self.messages['info'] = msg
-
-    def warning(self, msg):
-        self.messages['warning'] = msg
-
-    def error(self, msg):
-        self.messages['error'] = msg
-
-    def critical(self, msg):
-        self.messages['critical'] = msg
-
-
-class FakeApp:
-    def __init__(self, _stdout, _log):
-        self.stdout = _stdout
-        self.client_manager = None
-        self.api_version = {}
-        self.stdin = sys.stdin
-        self.stdout = _stdout or sys.stdout
-        self.stderr = sys.stderr
-        self.log = _log
-
-
-class FakeOptions:
-    def __init__(self, **kwargs):
-        self.os_beta_command = False
-
-
-class FakeClient:
-    def __init__(self, **kwargs):
-        self.endpoint = kwargs['endpoint']
-        self.token = kwargs['token']
-
-
-class FakeClientManager:
+class FakeClientManager(BaseFakeClientManager):
     _api_version = {
         'image': '2',
     }
 
     def __init__(self):
-        self.compute = None
-        self.identity = None
-        self.image = None
-        self.object_store = None
-        self.volume = None
-        self.network = None
-        self.sdk_connection = mock.Mock()
+        super().__init__()
 
-        self.session = None
-        self.auth_ref = None
-        self.auth_plugin_name = None
+        self.sdk_connection = mock.Mock()
 
         self.network_endpoint_enabled = True
         self.compute_endpoint_enabled = True
@@ -158,64 +124,7 @@ class FakeClientManager:
         return self.volume_endpoint_enabled
 
 
-class FakeModule:
-    def __init__(self, name, version):
-        self.name = name
-        self.__version__ = version
-        # Workaround for openstacksdk case
-        self.version = mock.Mock()
-        self.version.__version__ = version
-
-
-class FakeResource:
-    def __init__(self, manager=None, info=None, loaded=False, methods=None):
-        """Set attributes and methods for a resource.
-
-        :param manager:
-            The resource manager
-        :param Dictionary info:
-            A dictionary with all attributes
-        :param bool loaded:
-            True if the resource is loaded in memory
-        :param Dictionary methods:
-            A dictionary with all methods
-        """
-        info = info or {}
-        methods = methods or {}
-
-        self.__name__ = type(self).__name__
-        self.manager = manager
-        self._info = info
-        self._add_details(info)
-        self._add_methods(methods)
-        self._loaded = loaded
-
-    def _add_details(self, info):
-        for k, v in info.items():
-            setattr(self, k, v)
-
-    def _add_methods(self, methods):
-        """Fake methods with MagicMock objects.
-
-        For each <@key, @value> pairs in methods, add an callable MagicMock
-        object named @key as an attribute, and set the mock's return_value to
-        @value. When users access the attribute with (), @value will be
-        returned, which looks like a function call.
-        """
-        for name, ret in methods.items():
-            method = mock.Mock(return_value=ret)
-            setattr(self, name, method)
-
-    def __repr__(self):
-        reprkeys = sorted(
-            k for k in self.__dict__.keys() if k[0] != '_' and k != 'manager'
-        )
-        info = ", ".join(f"{k}={getattr(self, k)}" for k in reprkeys)
-        return f"<{self.__class__.__name__} {info}>"
-
-    def keys(self):
-        return self._info.keys()
-
+class FakeResource(BaseFakeResource):
     def to_dict(self):
         return self._info
 
@@ -247,11 +156,3 @@ class FakeResponse(requests.Response):
         self._content = json.dumps(data)
         if not isinstance(self._content, bytes):
             self._content = self._content.encode()
-
-
-class FakeModel(dict):
-    def __getattr__(self, key):
-        try:
-            return self[key]
-        except KeyError:
-            raise AttributeError(key)

openstackclient/tests/unit/identity/test_common.py

@@ -0,0 +1,100 @@
+# 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 unittest import mock
+
+from openstack import exceptions as sdk_exc
+from openstack.identity.v3 import user as _user
+from openstack.test import fakes as sdk_fakes
+from osc_lib import exceptions
+
+from openstackclient.identity import common
+from openstackclient.tests.unit import utils as test_utils
+
+
+class TestFindSDKId(test_utils.TestCase):
+    def setUp(self):
+        super().setUp()
+        self.user = sdk_fakes.generate_fake_resource(_user.User)
+        self.identity_sdk_client = mock.Mock()
+        self.identity_sdk_client.find_user = mock.Mock()
+
+    def test_find_sdk_id_validate(self):
+        self.identity_sdk_client.find_user.side_effect = [self.user]
+
+        result = common._find_sdk_id(
+            self.identity_sdk_client.find_user,
+            name_or_id=self.user.id,
+            validate_actor_existence=True,
+        )
+        self.assertEqual(self.user.id, result)
+
+    def test_find_sdk_id_no_validate(self):
+        self.identity_sdk_client.find_user.side_effect = [self.user]
+
+        result = common._find_sdk_id(
+            self.identity_sdk_client.find_user,
+            name_or_id=self.user.id,
+            validate_actor_existence=False,
+        )
+        self.assertEqual(self.user.id, result)
+
+    def test_find_sdk_id_not_found_validate(self):
+        self.identity_sdk_client.find_user.side_effect = [
+            sdk_exc.ResourceNotFound,
+        ]
+
+        self.assertRaises(
+            exceptions.CommandError,
+            common._find_sdk_id,
+            self.identity_sdk_client.find_user,
+            name_or_id=self.user.id,
+            validate_actor_existence=True,
+        )
+
+    def test_find_sdk_id_not_found_no_validate(self):
+        self.identity_sdk_client.find_user.side_effect = [
+            sdk_exc.ResourceNotFound,
+        ]
+
+        result = common._find_sdk_id(
+            self.identity_sdk_client.find_user,
+            name_or_id=self.user.id,
+            validate_actor_existence=False,
+        )
+        self.assertEqual(self.user.id, result)
+
+    def test_find_sdk_id_forbidden_validate(self):
+        self.identity_sdk_client.find_user.side_effect = [
+            sdk_exc.ForbiddenException,
+        ]
+
+        result = common._find_sdk_id(
+            self.identity_sdk_client.find_user,
+            name_or_id=self.user.id,
+            validate_actor_existence=True,
+        )
+
+        self.assertEqual(self.user.id, result)
+
+    def test_find_sdk_id_forbidden_no_validate(self):
+        self.identity_sdk_client.find_user.side_effect = [
+            sdk_exc.ForbiddenException,
+        ]
+
+        result = common._find_sdk_id(
+            self.identity_sdk_client.find_user,
+            name_or_id=self.user.id,
+            validate_actor_existence=False,
+        )
+
+        self.assertEqual(self.user.id, result)

openstackclient/tests/unit/identity/v2_0/test_project.py

@@ -195,7 +195,7 @@ class TestProjectCreate(TestProject):
             self.fake_project.name,
         ]
         verifylist = [
-            ('property', {'fee': 'fi', 'fo': 'fum'}),
+            ('properties', {'fee': 'fi', 'fo': 'fum'}),
             ('name', self.fake_project.name),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -464,7 +464,7 @@ class TestProjectSet(TestProject):
             ('description', None),
             ('enable', False),
             ('disable', False),
-            ('property', None),
+            ('properties', None),
         ]
         self.projects_mock.get.side_effect = exceptions.NotFound(None)
         self.projects_mock.find.side_effect = exceptions.NotFound(None)
@@ -588,7 +588,7 @@ class TestProjectSet(TestProject):
             self.fake_project.name,
         ]
         verifylist = [
-            ('property', {'fee': 'fi', 'fo': 'fum'}),
+            ('properties', {'fee': 'fi', 'fo': 'fum'}),
             ('project', self.fake_project.name),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -683,7 +683,7 @@ class TestProjectUnset(TestProject):
             self.fake_proj.name,
         ]
         verifylist = [
-            ('property', ['fee', 'fo']),
+            ('properties', ['fee', 'fo']),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 

openstackclient/tests/unit/identity/v3/fakes.py

@@ -693,6 +693,14 @@ class TestIdentityv3(
 ): ...
 
 
+class FakeModel(dict):
+    def __getattr__(self, key):
+        try:
+            return self[key]
+        except KeyError:
+            raise AttributeError(key)
+
+
 # We don't use FakeClientMixin since we want a different fake legacy client
 class TestFederatedIdentity(utils.TestCommand):
     def setUp(self):
@@ -1075,7 +1083,7 @@ class FakeEndpoint:
         # Overwrite default attributes if there are some attributes set
         endpoint_filter_info.update(attrs)
 
-        endpoint_filter = fakes.FakeModel(copy.deepcopy(endpoint_filter_info))
+        endpoint_filter = FakeModel(copy.deepcopy(endpoint_filter_info))
 
         return endpoint_filter
 
@@ -1133,7 +1141,7 @@ class FakeEndpointGroup:
         # Overwrite default attributes if there are some attributes set
         endpointgroup_filter_info.update(attrs)
 
-        endpointgroup_filter = fakes.FakeModel(
+        endpointgroup_filter = FakeModel(
             copy.deepcopy(endpointgroup_filter_info)
         )
 

openstackclient/tests/unit/identity/v3/test_application_credential.py

@@ -31,18 +31,6 @@ from openstackclient.tests.unit.identity.v3 import fakes as identity_fakes
 
 
 class TestApplicationCredentialCreate(identity_fakes.TestIdentityv3):
-    columns = (
-        'id',
-        'name',
-        'description',
-        'project_id',
-        'roles',
-        'unrestricted',
-        'access_rules',
-        'expires_at',
-        'secret',
-    )
-
     def setUp(self):
         super().setUp()
 
@@ -52,12 +40,25 @@ class TestApplicationCredentialCreate(identity_fakes.TestIdentityv3):
             roles=[],
         )
 
-        self.datalist = (
+        self.columns = (
+            'ID',
+            'Name',
+            'Description',
+            'Project ID',
+            'Roles',
+            'Unrestricted',
+            'Access Rules',
+            'Expires At',
+            'Secret',
+        )
+        self.data = (
             self.application_credential.id,
             self.application_credential.name,
             self.application_credential.description,
             self.application_credential.project_id,
-            self.application_credential.roles,
+            application_credential.RolesColumn(
+                self.application_credential.roles
+            ),
             self.application_credential.unrestricted,
             self.application_credential.access_rules,
             self.application_credential.expires_at,
@@ -101,7 +102,7 @@ class TestApplicationCredentialCreate(identity_fakes.TestIdentityv3):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertEqual(self.data, data)
 
     def test_application_credential_create_with_options(self):
         name = self.application_credential.name
@@ -119,7 +120,7 @@ class TestApplicationCredentialCreate(identity_fakes.TestIdentityv3):
         verifylist = [
             ('name', self.application_credential.name),
             ('secret', 'moresecuresecret'),
-            ('role', [self.roles.id]),
+            ('roles', [self.roles.id]),
             ('expiration', '2024-01-01T00:00:00'),
             ('description', 'credential for testing'),
         ]
@@ -147,7 +148,7 @@ class TestApplicationCredentialCreate(identity_fakes.TestIdentityv3):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertEqual(self.data, data)
 
     def test_application_credential_create_with_access_rules_string(self):
         name = self.application_credential.name
@@ -191,7 +192,7 @@ class TestApplicationCredentialCreate(identity_fakes.TestIdentityv3):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertEqual(self.data, data)
 
     @mock.patch('openstackclient.identity.v3.application_credential.json.load')
     @mock.patch('openstackclient.identity.v3.application_credential.open')
@@ -231,7 +232,7 @@ class TestApplicationCredentialCreate(identity_fakes.TestIdentityv3):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertEqual(self.data, data)
 
 
 class TestApplicationCredentialDelete(identity_fakes.TestIdentityv3):
@@ -301,7 +302,7 @@ class TestApplicationCredentialDelete(identity_fakes.TestIdentityv3):
 
         calls = []
         for a in arglist:
-            calls.append(call(user_id, a))
+            calls.append(call(user_id, a, ignore_missing=False))
 
         self.identity_sdk_client.find_application_credential.assert_has_calls(
             calls
@@ -345,7 +346,9 @@ class TestApplicationCredentialList(identity_fakes.TestIdentityv3):
                 self.application_credential.name,
                 self.application_credential.description,
                 self.application_credential.project_id,
-                '',
+                application_credential.RolesColumn(
+                    self.application_credential.roles
+                ),
                 self.application_credential.unrestricted,
                 self.application_credential.access_rules,
                 self.application_credential.expires_at,
@@ -408,6 +411,29 @@ class TestApplicationCredentialShow(identity_fakes.TestIdentityv3):
             self.application_credential
         )
 
+        self.columns = (
+            'ID',
+            'Name',
+            'Description',
+            'Project ID',
+            'Roles',
+            'Unrestricted',
+            'Access Rules',
+            'Expires At',
+        )
+        self.data = (
+            self.application_credential.id,
+            self.application_credential.name,
+            self.application_credential.description,
+            self.application_credential.project_id,
+            application_credential.RolesColumn(
+                self.application_credential.roles
+            ),
+            self.application_credential.unrestricted,
+            self.application_credential.access_rules,
+            self.application_credential.expires_at,
+        )
+
         # Get the command object to test
         self.cmd = application_credential.ShowApplicationCredential(
             self.app, None
@@ -431,28 +457,8 @@ class TestApplicationCredentialShow(identity_fakes.TestIdentityv3):
         columns, data = self.cmd.take_action(parsed_args)
 
         self.identity_sdk_client.find_application_credential.assert_called_with(
-            user_id, self.application_credential.id
+            user_id, self.application_credential.id, ignore_missing=False
         )
 
-        collist = (
-            'id',
-            'name',
-            'description',
-            'project_id',
-            'roles',
-            'unrestricted',
-            'access_rules',
-            'expires_at',
-        )
-        self.assertEqual(collist, columns)
-        datalist = (
-            self.application_credential.id,
-            self.application_credential.name,
-            self.application_credential.description,
-            self.application_credential.project_id,
-            self.application_credential.roles,
-            self.application_credential.unrestricted,
-            self.application_credential.access_rules,
-            self.application_credential.expires_at,
-        )
-        self.assertEqual(datalist, data)
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.data, data)

openstackclient/tests/unit/identity/v3/test_domain.py

@@ -186,7 +186,7 @@ class TestDomainCreate(identity_fakes.TestIdentityv3):
             self.domain.name,
         ]
         verifylist = [
-            ('no_immutable', True),
+            ('immutable', False),
             ('name', self.domain.name),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -461,7 +461,7 @@ class TestDomainSet(identity_fakes.TestIdentityv3):
             self.domain.id,
         ]
         verifylist = [
-            ('no_immutable', True),
+            ('immutable', False),
             ('domain', self.domain.id),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -520,7 +520,7 @@ class TestDomainShow(identity_fakes.TestIdentityv3):
         # data to be shown.
         columns, data = self.cmd.take_action(parsed_args)
         self.identity_sdk_client.find_domain.assert_called_with(
-            self.domain.id,
+            self.domain.id, ignore_missing=False
         )
 
         self.assertEqual(self.columns, columns)

openstackclient/tests/unit/identity/v3/test_endpoint.py

@@ -678,7 +678,7 @@ class TestEndpointShow(identity_fakes.TestIdentityv3):
         # data to be shown.
         columns, data = self.cmd.take_action(parsed_args)
         self.identity_sdk_client.find_endpoint.assert_called_with(
-            self.endpoint.id,
+            self.endpoint.id, ignore_missing=False
         )
 
         collist = (

openstackclient/tests/unit/identity/v3/test_group.py

@@ -253,7 +253,7 @@ class TestGroupCreate(identity_fakes.TestIdentityv3):
 
         columns, data = self.cmd.take_action(parsed_args)
         self.identity_sdk_client.find_group.assert_called_once_with(
-            self.group.name
+            self.group.name, ignore_missing=False
         )
         self.assertEqual(self.columns, columns)
         datalist = (
@@ -286,7 +286,9 @@ class TestGroupCreate(identity_fakes.TestIdentityv3):
 
         columns, data = self.cmd.take_action(parsed_args)
         self.identity_sdk_client.find_group.assert_called_once_with(
-            self.group_with_options.name, domain_id=self.domain.id
+            self.group_with_options.name,
+            domain_id=self.domain.id,
+            ignore_missing=False,
         )
         self.assertEqual(self.columns, columns)
         datalist = (