Merge "Identity: Migrate 'policy' commands to SDK"

Author: Zuul

openstackclient/identity/v3/policy.py

@@ -20,6 +20,8 @@
 import logging
 from typing import Any
 
+from openstack.identity.v3 import policy as _policy
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -30,6 +32,14 @@
 LOG = logging.getLogger(__name__)
 
 
+def _format_policy(
+    policy: _policy.Policy,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
+    columns = ('id', 'blob', 'type')
+    column_headers = ('id', 'rules', 'type')
+    return (column_headers, utils.get_item_properties(policy, columns))
+
+
 class CreatePolicy(command.ShowOne):
     _description = _("Create new policy")
 
@@ -56,15 +66,14 @@ def take_action(
     ) -> tuple[Sequence[str], Iterable[Any]]:
         blob = utils.read_blob_file_contents(parsed_args.rules)
 
-        identity_client = self.app.client_manager.identity
-        policy = identity_client.policies.create(
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
+        policy = identity_client.create_policy(
             blob=blob, type=parsed_args.type
         )
 
-        policy._info.pop('links')
-        policy._info.update({'rules': policy._info.pop('blob')})
-        col_headers, col_data = zip(*sorted(policy._info.items()))
-        return col_headers, col_data
+        return _format_policy(policy)
 
 
 class DeletePolicy(command.Command):
@@ -81,11 +90,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.policy:
             try:
-                identity_client.policies.delete(i)
+                identity_client.delete_policy(i, ignore_missing=False)
             except Exception as e:
                 result += 1
                 LOG.error(
@@ -126,17 +137,20 @@ def take_action(
         if parsed_args.long:
             columns += ('Blob',)
             column_headers += ('Rules',)
-        data = self.app.client_manager.identity.policies.list()
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
+        data = identity_client.policies()
         return (
             column_headers,
-            (
+            [
                 utils.get_item_properties(
                     s,
                     columns,
                     formatters={},
                 )
                 for s in data
-            ),
+            ],
         )
 
 
@@ -163,19 +177,19 @@ 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
-        blob = None
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
+
+        kwargs = {}
 
         if parsed_args.rules:
-            blob = utils.read_blob_file_contents(parsed_args.rules)
+            kwargs['blob'] = utils.read_blob_file_contents(parsed_args.rules)
 
-        kwargs = {}
-        if blob:
-            kwargs['blob'] = blob
         if parsed_args.type:
             kwargs['type'] = parsed_args.type
 
-        identity_client.policies.update(parsed_args.policy, **kwargs)
+        identity_client.update_policy(parsed_args.policy, **kwargs)
 
 
 class ShowPolicy(command.ShowOne):
@@ -193,12 +207,9 @@ 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
-        policy = utils.find_resource(
-            identity_client.policies, parsed_args.policy
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
         )
+        policy = identity_client.get_policy(parsed_args.policy)
 
-        policy._info.pop('links')
-        policy._info.update({'rules': policy._info.pop('blob')})
-        col_headers, col_data = zip(*sorted(policy._info.items()))
-        return col_headers, col_data
+        return _format_policy(policy)

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

@@ -154,6 +154,21 @@ class IdentityTests(base.TestCase):
         'Region ID',
     ]
 
+    POLICY_FIELDS = [
+        'id',
+        'rules',
+        'type',
+    ]
+    POLICY_LIST_HEADERS = [
+        'ID',
+        'Type',
+    ]
+    POLICY_LIST_LONG_HEADERS = [
+        'ID',
+        'Type',
+        'Rules',
+    ]
+
     DOMAIN_NAME: ClassVar[str]
     DOMAIN_DESCRIPTION: ClassVar[str]
     PROJECT_NAME: ClassVar[str]
@@ -520,3 +535,30 @@ def _create_dummy_limit(self, add_clean_up=True):
 
         self.assert_show_fields(items, self.LIMIT_FIELDS)
         return limit_id
+
+    def _create_dummy_policy(self, add_clean_up=True):
+        # 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'policy create {f.name}')
+            items = self.parse_show(raw_output)
+            policy_id = self._extract_value_from_items('id', items)
+
+        if add_clean_up:
+            self.addCleanup(
+                self.openstack,
+                f'policy delete {policy_id}',
+            )
+        items = self.parse_show(raw_output)
+        self.assert_show_fields(items, self.POLICY_FIELDS)
+        return policy_id

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

@@ -0,0 +1,86 @@
+#    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 PolicyTests(common.IdentityTests):
+    def test_policy_create(self):
+        self._create_dummy_policy()
+
+    def test_policy_delete(self):
+        policy = self._create_dummy_policy(add_clean_up=False)
+        raw_output = self.openstack(f'policy delete {policy}')
+        self.assertEqual(0, len(raw_output))
+
+    def test_policy_multi_delete(self):
+        policy_1 = self._create_dummy_policy(add_clean_up=False)
+        policy_2 = self._create_dummy_policy(add_clean_up=False)
+        raw_output = self.openstack(f'policy delete {policy_1} {policy_2}')
+        self.assertEqual(0, len(raw_output))
+
+    def test_policy_show(self):
+        policy = self._create_dummy_policy(add_clean_up=True)
+        raw_output = self.openstack(f'policy show {policy}')
+        items = self.parse_show(raw_output)
+        self.assert_show_fields(items, self.POLICY_FIELDS)
+
+    def test_policy_list(self):
+        self._create_dummy_policy(add_clean_up=True)
+        raw_output = self.openstack('policy list')
+        items = self.parse_listing(raw_output)
+        self.assert_table_structure(items, self.POLICY_LIST_HEADERS)
+
+    def test_policy_list_long(self):
+        self._create_dummy_policy(add_clean_up=True)
+        raw_output = self.openstack('policy list --long')
+        items = self.parse_listing(raw_output)
+        self.assert_table_structure(items, self.POLICY_LIST_LONG_HEADERS)
+
+    def test_policy_set(self):
+        policy = self._create_dummy_policy(add_clean_up=True)
+        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'policy set {policy} --rules {f.name} --type text/json'
+            )
+        self.assertEqual(0, len(raw_output))
+        raw_output = self.openstack(f'policy show {policy}')
+        updated_value = self.parse_show_as_object(raw_output)
+        self.assertEqual('text/json', updated_value['type'])