Identity: Migrate 'mapping' commands to SDK

Change-Id: Id4b4ac89f57b09b7aba7b4cc7832bb175a455cdd
Signed-off-by: 0weng <oweng@osuosl.org>

Author: ArtofBugs

openstackclient/identity/v3/mapping.py

@@ -21,6 +21,7 @@
 import logging
 from typing import Any
 
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -31,6 +32,15 @@
 LOG = logging.getLogger(__name__)
 
 
+def _format_mapping(mapping):
+    columns = ('id', 'rules', 'schema_version')
+    column_headers = ('id', 'rules', 'schema_version')
+    return (
+        column_headers,
+        utils.get_item_properties(mapping, columns),
+    )
+
+
 class _RulesReader:
     _description = _("Helper class capable of reading rules from files")
 
@@ -124,18 +134,18 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[Any]]:
-        identity_client = self.app.client_manager.identity
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         rules = self._read_rules(parsed_args.rules)
-        mapping = identity_client.federation.mappings.create(
-            mapping_id=parsed_args.mapping,
+        mapping = identity_client.create_mapping(
+            id=parsed_args.mapping,
             rules=rules,
             schema_version=parsed_args.schema_version,
         )
 
-        mapping._info.pop('links', None)
-        col_headers, col_data = zip(*sorted(mapping._info.items()))
-        return col_headers, col_data
+        return _format_mapping(mapping)
 
 
 class DeleteMapping(command.Command):
@@ -152,11 +162,13 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         return parser
 
     def take_action(self, parsed_args: argparse.Namespace) -> None:
-        identity_client = self.app.client_manager.identity
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         result = 0
         for i in parsed_args.mapping:
             try:
-                identity_client.federation.mappings.delete(i)
+                identity_client.delete_mapping(i, ignore_missing=False)
             except Exception as e:
                 result += 1
                 LOG.error(
@@ -185,8 +197,10 @@ def take_action(
         # NOTE(marek-denis): Since rules can be long and tedious I have decided
         # to only list ids of the mappings. If somebody wants to check the
         # rules, (s)he should show specific ones.
-        identity_client = self.app.client_manager.identity
-        data = identity_client.federation.mappings.list()
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
+        data = identity_client.mappings()
         columns = ('ID', 'schema_version')
         items = [utils.get_item_properties(s, columns) for s in data]
         return (columns, items)
@@ -212,18 +226,18 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         return parser
 
     def take_action(self, parsed_args: argparse.Namespace) -> None:
-        identity_client = self.app.client_manager.identity
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         rules = self._read_rules(parsed_args.rules)
 
-        mapping = identity_client.federation.mappings.update(
+        identity_client.update_mapping(
             mapping=parsed_args.mapping,
             rules=rules,
             schema_version=parsed_args.schema_version,
         )
 
-        mapping._info.pop('links', None)
-
 
 class ShowMapping(command.ShowOne):
     _description = _("Display mapping details")
@@ -240,10 +254,10 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[Any]]:
-        identity_client = self.app.client_manager.identity
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
-        mapping = identity_client.federation.mappings.get(parsed_args.mapping)
+        mapping = identity_client.get_mapping(parsed_args.mapping)
 
-        mapping._info.pop('links', None)
-        col_headers, col_data = zip(*sorted(mapping._info.items()))
-        return col_headers, col_data
+        return _format_mapping(mapping)

openstackclient/tests/functional/identity/v3/common.py

@@ -10,7 +10,9 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+import json
 import os
+import tempfile
 from typing import ClassVar
 
 import fixtures
@@ -75,6 +77,10 @@ class IdentityTests(base.TestCase):
     ]
     ENDPOINT_LIST_PROJECT_HEADERS = ['ID', 'Name']
 
+    MAPPING_FIELDS = ['id', 'rules', 'schema_version']
+
+    MAPPING_LIST_HEADERS = ['ID', 'schema_version']
+
     IDENTITY_PROVIDER_FIELDS = [
         'description',
         'enabled',
@@ -371,6 +377,34 @@ def _create_dummy_endpoint(self, interface='public', add_clean_up=True):
         self.assert_show_fields(items, self.ENDPOINT_FIELDS)
         return endpoint['id']
 
+    def _create_dummy_mapping(self, add_clean_up=True):
+        mapping = data_utils.rand_name('Mapping')
+        # Create rules file
+        with tempfile.NamedTemporaryFile(mode='w+') as f:
+            RULES = [
+                {
+                    "local": [{"group": {"id": "85a868"}}],
+                    "remote": [
+                        {"type": "orgPersonType", "any_one_of": ["Employee"]},
+                        {"type": "sn", "any_one_of": ["Young"]},
+                    ],
+                }
+            ]
+            f.write(json.dumps(RULES))
+            f.flush()
+            raw_output = self.openstack(
+                f'mapping create {mapping} --rules {f.name} --schema-version 1.0'
+            )
+
+        if add_clean_up:
+            self.addCleanup(
+                self.openstack,
+                f'mapping delete {mapping}',
+            )
+        items = self.parse_show(raw_output)
+        self.assert_show_fields(items, self.MAPPING_FIELDS)
+        return mapping
+
     def _create_dummy_idp(self, add_clean_up=True):
         identity_provider = data_utils.rand_name('IdentityProvider')
         description = data_utils.rand_name('description')

openstackclient/tests/functional/identity/v3/test_mapping.py

@@ -0,0 +1,81 @@
+#    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 json
+import tempfile
+
+from openstackclient.tests.functional.identity.v3 import common
+
+
+class MappingTests(common.IdentityTests):
+    def test_mapping_create(self):
+        self._create_dummy_mapping()
+
+    def test_mapping_delete(self):
+        mapping = self._create_dummy_mapping(add_clean_up=False)
+        raw_output = self.openstack(f'mapping delete {mapping}')
+        self.assertEqual(0, len(raw_output))
+
+    def test_mapping_multi_delete(self):
+        mapping_1 = self._create_dummy_mapping(add_clean_up=False)
+        mapping_2 = self._create_dummy_mapping(add_clean_up=False)
+        raw_output = self.openstack(f'mapping delete {mapping_1} {mapping_2}')
+        self.assertEqual(0, len(raw_output))
+
+    def test_mapping_show(self):
+        mapping = self._create_dummy_mapping(add_clean_up=True)
+        raw_output = self.openstack(f'mapping show {mapping}')
+        items = self.parse_show(raw_output)
+        self.assert_show_fields(items, self.MAPPING_FIELDS)
+
+    def test_mapping_list(self):
+        self._create_dummy_mapping(add_clean_up=True)
+        raw_output = self.openstack('mapping list')
+        items = self.parse_listing(raw_output)
+        self.assert_table_structure(items, self.MAPPING_LIST_HEADERS)
+
+    def test_mapping_set(self):
+        mapping = self._create_dummy_mapping(add_clean_up=True)
+        new_schema_version = '2.0'
+        with tempfile.NamedTemporaryFile(mode='w+') as f:
+            NEW_RULES = [
+                {
+                    "local": [{"group": {"id": "85a868"}}],
+                    "remote": [
+                        {"type": "orgPersonType", "any_one_of": ["Employee"]},
+                        {"type": "sn", "any_one_of": ["Young"]},
+                    ],
+                },
+                {
+                    "local": [
+                        {"group": {"id": "0cd5e9"}},
+                        {"user": {"name": "0cd5e9"}},
+                    ],
+                    "remote": [
+                        {"type": "UserName"},
+                        {
+                            "type": "orgPersonType",
+                            "not_any_of": ["Contractor", "SubContractor"],
+                        },
+                        {"type": "LastName", "any_one_of": ["Bo"]},
+                    ],
+                },
+            ]
+            f.write(json.dumps(NEW_RULES))
+            f.flush()
+            raw_output = self.openstack(
+                f'mapping set {mapping} --rules {f.name} --schema-version {new_schema_version}'
+            )
+        self.assertEqual(0, len(raw_output))
+        raw_output = self.openstack(f'mapping show {mapping}')
+        updated_value = self.parse_show_as_object(raw_output)
+        self.assertEqual('2.0', updated_value['schema_version'])