Merge "common: Replace remaining use of keystoneclient"

Author: Zuul

openstackclient/common/extension.py

@@ -20,6 +20,7 @@
 from collections.abc import Iterable, Sequence
 from typing import Any
 
+from openstack.identity import v2 as identity_v2
 from osc_lib import utils
 
 from openstackclient import command
@@ -55,7 +56,9 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             '--identity',
             action='store_true',
             default=False,
-            help=_('List extensions for the Identity API'),
+            help=_(
+                'List extensions for the Identity API (only supported by v2)'
+            ),
         )
         parser.add_argument(
             '--network',
@@ -84,7 +87,7 @@ def take_action(
         if parsed_args.long:
             columns += ('Namespace', 'Updated At', 'Links')
 
-        data = []
+        data: list[Any] = []
 
         # by default we want to show everything, unless the
         # user specifies one or more of the APIs to show
@@ -97,12 +100,16 @@ def take_action(
         )
 
         if parsed_args.identity or show_all:
-            identity_client = self.app.client_manager.identity
-            try:
-                data += identity_client.extensions.list()
-            except Exception:
-                message = _("Extensions list not supported by Identity API")
-                LOG.warning(message)
+            identity_client = self.app.client_manager.sdk_connection.identity
+            # only identity v2 support extensions
+            if isinstance(identity_client, identity_v2.Proxy):
+                try:
+                    data += identity_client.extensions()
+                except Exception:
+                    message = _(
+                        "Extensions list not supported by Identity API"
+                    )
+                    LOG.warning(message)
 
         if parsed_args.compute or show_all:
             compute_client = self.app.client_manager.compute

openstackclient/common/limits.py

@@ -20,7 +20,7 @@
 from collections.abc import Iterable, Sequence
 from typing import Any
 
-from osc_lib import utils
+from openstack import utils as sdk_utils
 
 from openstackclient import command
 from openstackclient.i18n import _
@@ -93,13 +93,13 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
                 '(only valid with --absolute)'
             ),
         )
+        identity_common.add_project_domain_option_to_parser(parser)
+        # deprecated alias for --project-domain
         parser.add_argument(
             '--domain',
             metavar='<domain>',
-            help=_(
-                'Domain the project belongs to (name or ID) '
-                '(only valid with --absolute)'
-            ),
+            dest='project_domain',
+            help=argparse.SUPPRESS,
         )
         return parser
 
@@ -108,20 +108,14 @@ def take_action(
     ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         project_id = None
         if parsed_args.project is not None:
-            identity_client = self.app.client_manager.identity
-            if parsed_args.domain is not None:
-                domain = identity_common.find_domain(
-                    identity_client, parsed_args.domain
-                )
-                project_id = utils.find_resource(
-                    identity_client.projects,
-                    parsed_args.project,
-                    domain_id=domain.id,
-                ).id
-            else:
-                project_id = utils.find_resource(
-                    identity_client.projects, parsed_args.project
-                ).id
+            identity_client = sdk_utils.ensure_service_version(
+                self.app.client_manager.sdk_connection.identity, '3'
+            )
+            project_id = identity_common.find_project_id_sdk(
+                identity_client,
+                parsed_args.project,
+                parsed_args.project_domain,
+            )
 
         compute_limits = None
         volume_limits = None

openstackclient/tests/unit/common/test_extension.py

@@ -10,6 +10,8 @@
 #   License for the specific language governing permissions and limitations
 #   under the License.
 
+from openstack.identity.v2 import extension as _extension
+from openstack.test import fakes as sdk_fakes
 
 from openstackclient.common import extension
 from openstackclient.tests.unit.compute.v2 import fakes as compute_fakes
@@ -41,14 +43,14 @@ class TestExtensionList(TestExtension):
     )
 
     volume_extension = volume_fakes.create_one_extension()
-    identity_extension = identity_fakes.FakeExtension.create_one_extension()
+    identity_extension = sdk_fakes.generate_fake_resource(_extension.Extension)
     compute_extension = compute_fakes.create_one_extension()
     network_extension = network_fakes.create_one_extension()
 
     def setUp(self):
         super().setUp()
 
-        self.identity_client.extensions.list.return_value = [
+        self.identity_sdk_client.extensions.return_value = [
             self.identity_extension
         ]
         self.compute_client.extensions.return_value = [self.compute_extension]
@@ -102,7 +104,7 @@ def test_extension_list_no_options(self):
             ),
         )
         self._test_extension_list_helper(arglist, verifylist, datalist)
-        self.identity_client.extensions.list.assert_called_with()
+        self.identity_sdk_client.extensions.assert_called_with()
         self.compute_client.extensions.assert_called_with()
         self.volume_sdk_client.extensions.assert_called_with()
         self.network_client.extensions.assert_called_with()
@@ -120,7 +122,7 @@ def test_extension_list_long(self):
                 self.identity_extension.alias,
                 self.identity_extension.description,
                 self.identity_extension.namespace,
-                '',
+                self.identity_extension.updated_at,
                 self.identity_extension.links,
             ),
             (
@@ -149,7 +151,7 @@ def test_extension_list_long(self):
             ),
         )
         self._test_extension_list_helper(arglist, verifylist, datalist, True)
-        self.identity_client.extensions.list.assert_called_with()
+        self.identity_sdk_client.extensions.assert_called_with()
         self.compute_client.extensions.assert_called_with()
         self.volume_sdk_client.extensions.assert_called_with()
         self.network_client.extensions.assert_called_with()
@@ -169,7 +171,7 @@ def test_extension_list_identity(self):
             ),
         )
         self._test_extension_list_helper(arglist, verifylist, datalist)
-        self.identity_client.extensions.list.assert_called_with()
+        self.identity_sdk_client.extensions.assert_called_with()
 
     def test_extension_list_network(self):
         arglist = [

openstackclient/tests/unit/common/test_project_cleanup.py

@@ -12,6 +12,9 @@
 
 from unittest import mock
 
+from openstack.identity.v3 import project as _project
+from openstack.test import fakes as sdk_fakes
+
 from openstackclient.common import project_cleanup
 from openstackclient.tests.unit.identity.v3 import fakes as identity_fakes
 from openstackclient.tests.unit import utils as test_utils
@@ -20,25 +23,13 @@
 class TestProjectCleanup(
     identity_fakes.FakeClientMixin, test_utils.TestCommand
 ):
-    project = identity_fakes.FakeProject.create_one_project()
-
     def setUp(self):
         super().setUp()
         self.cmd = project_cleanup.ProjectCleanup(self.app, None)
 
-        self.project_cleanup_mock = mock.Mock()
-        self.sdk_connect_as_project_mock = mock.Mock(
-            return_value=self.app.client_manager.sdk_connection
-        )
-        self.app.client_manager.sdk_connection.project_cleanup = (
-            self.project_cleanup_mock
-        )
-        self.app.client_manager.sdk_connection.identity.find_project = (
-            mock.Mock(return_value=self.project)
-        )
-        self.app.client_manager.sdk_connection.connect_as_project = (
-            self.sdk_connect_as_project_mock
-        )
+        self.project = sdk_fakes.generate_fake_resource(_project.Project)
+        self.identity_sdk_client.find_project.return_value = self.project
+        self.app.client_manager.sdk_connection.connect_as_project.return_value = self.app.client_manager.sdk_connection
 
     def test_project_no_options(self):
         arglist = []
@@ -74,7 +65,9 @@ def test_project_cleanup_with_filters(self):
         with mock.patch('getpass.getpass', return_value='y'):
             result = self.cmd.take_action(parsed_args)
 
-        self.sdk_connect_as_project_mock.assert_called_with(self.project)
+        self.app.client_manager.sdk_connection.connect_as_project.assert_called_with(
+            self.project
+        )
         filters = {'created_at': '2200-01-01', 'updated_at': '2200-01-02'}
 
         calls = [
@@ -91,7 +84,9 @@ def test_project_cleanup_with_filters(self):
                 skip_resources=None,
             ),
         ]
-        self.project_cleanup_mock.assert_has_calls(calls)
+        self.app.client_manager.sdk_connection.project_cleanup.assert_has_calls(
+            calls
+        )
 
         self.assertIsNone(result)
 
@@ -112,7 +107,9 @@ def test_project_cleanup_with_auto_approve(self):
 
         result = self.cmd.take_action(parsed_args)
 
-        self.sdk_connect_as_project_mock.assert_called_with(self.project)
+        self.app.client_manager.sdk_connection.connect_as_project.assert_called_with(
+            self.project
+        )
         calls = [
             mock.call(
                 dry_run=True,
@@ -127,7 +124,9 @@ def test_project_cleanup_with_auto_approve(self):
                 skip_resources=None,
             ),
         ]
-        self.project_cleanup_mock.assert_has_calls(calls)
+        self.app.client_manager.sdk_connection.project_cleanup.assert_has_calls(
+            calls
+        )
 
         self.assertIsNone(result)
 
@@ -147,7 +146,9 @@ def test_project_cleanup_with_project(self):
         with mock.patch('getpass.getpass', return_value='y'):
             result = self.cmd.take_action(parsed_args)
 
-        self.sdk_connect_as_project_mock.assert_called_with(self.project)
+        self.app.client_manager.sdk_connection.connect_as_project.assert_called_with(
+            self.project
+        )
         calls = [
             mock.call(
                 dry_run=True,
@@ -162,7 +163,9 @@ def test_project_cleanup_with_project(self):
                 skip_resources=None,
             ),
         ]
-        self.project_cleanup_mock.assert_has_calls(calls)
+        self.app.client_manager.sdk_connection.project_cleanup.assert_has_calls(
+            calls
+        )
 
         self.assertIsNone(result)
 
@@ -182,7 +185,9 @@ def test_project_cleanup_with_project_abort(self):
         with mock.patch('getpass.getpass', return_value='y'):
             result = self.cmd.take_action(parsed_args)
 
-        self.sdk_connect_as_project_mock.assert_called_with(self.project)
+        self.app.client_manager.sdk_connection.connect_as_project.assert_called_with(
+            self.project
+        )
         calls = [
             mock.call(
                 dry_run=True,
@@ -191,7 +196,9 @@ def test_project_cleanup_with_project_abort(self):
                 skip_resources=None,
             ),
         ]
-        self.project_cleanup_mock.assert_has_calls(calls)
+        self.app.client_manager.sdk_connection.project_cleanup.assert_has_calls(
+            calls
+        )
 
         self.assertIsNone(result)
 
@@ -211,8 +218,10 @@ def test_project_cleanup_with_dry_run(self):
 
         result = self.cmd.take_action(parsed_args)
 
-        self.sdk_connect_as_project_mock.assert_called_with(self.project)
-        self.project_cleanup_mock.assert_called_once_with(
+        self.app.client_manager.sdk_connection.connect_as_project.assert_called_with(
+            self.project
+        )
+        self.app.client_manager.sdk_connection.project_cleanup.assert_called_once_with(
             dry_run=True,
             status_queue=mock.ANY,
             filters={},
@@ -238,7 +247,7 @@ def test_project_cleanup_with_auth_project(self):
         with mock.patch('getpass.getpass', return_value='y'):
             result = self.cmd.take_action(parsed_args)
 
-        self.sdk_connect_as_project_mock.assert_not_called()
+        self.app.client_manager.sdk_connection.connect_as_project.assert_not_called()
         calls = [
             mock.call(
                 dry_run=True,
@@ -253,7 +262,9 @@ def test_project_cleanup_with_auth_project(self):
                 skip_resources=None,
             ),
         ]
-        self.project_cleanup_mock.assert_has_calls(calls)
+        self.app.client_manager.sdk_connection.project_cleanup.assert_has_calls(
+            calls
+        )
 
         self.assertIsNone(result)
 
@@ -272,7 +283,9 @@ def test_project_cleanup_with_skip_resource(self):
         with mock.patch('getpass.getpass', return_value='y'):
             result = self.cmd.take_action(parsed_args)
 
-        self.sdk_connect_as_project_mock.assert_called_with(self.project)
+        self.app.client_manager.sdk_connection.connect_as_project.assert_called_with(
+            self.project
+        )
 
         calls = [
             mock.call(
@@ -288,6 +301,8 @@ def test_project_cleanup_with_skip_resource(self):
                 skip_resources=[skip_resource],
             ),
         ]
-        self.project_cleanup_mock.assert_has_calls(calls)
+        self.app.client_manager.sdk_connection.project_cleanup.assert_has_calls(
+            calls
+        )
 
         self.assertIsNone(result)

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

@@ -206,45 +206,6 @@ class TestIdentity(
 ): ...
 
 
-class FakeExtension:
-    """Fake one or more extension."""
-
-    @staticmethod
-    def create_one_extension(attrs=None):
-        """Create a fake extension.
-
-        :param Dictionary attrs:
-            A dictionary with all attributes
-        :return:
-            A FakeResource object with name, namespace, etc.
-        """
-        attrs = attrs or {}
-
-        # Set default attributes.
-        extension_info = {
-            'name': 'name-' + uuid.uuid4().hex,
-            'namespace': (
-                'http://docs.openstack.org/identity/api/ext/OS-KSCRUD/v1.0'
-            ),
-            'description': 'description-' + uuid.uuid4().hex,
-            'updated': '2013-07-07T12:00:0-00:00',
-            'alias': 'OS-KSCRUD',
-            'links': (
-                '[{"href":'
-                '"https://github.com/openstack/identity-api", "type":'
-                ' "text/html", "rel": "describedby"}]'
-            ),
-        }
-
-        # Overwrite default attributes.
-        extension_info.update(attrs)
-
-        extension = fakes.FakeResource(
-            info=copy.deepcopy(extension_info), loaded=True
-        )
-        return extension
-
-
 class FakeCatalog:
     """Fake one or more catalog."""