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

openstackclient/network/v2/security_group.py

@@ -9,29 +9,34 @@
 #   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #   License for the specific language governing permissions and limitations
 #   under the License.
-#
 
 """Security Group action implementations"""
 
 import argparse
-import typing as ty
+from collections.abc import Iterable, Sequence
+import logging
+from typing import Any, cast
 
 from cliff import columns as cliff_columns
+from openstack.network.v2 import security_group as _security_group
+from osc_lib import exceptions
 from osc_lib import utils
 from osc_lib.utils import tags as _tag
 
-from openstackclient.api import compute_v2
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
-from openstackclient.network import utils as network_utils
+
+LOG = logging.getLogger(__name__)
 
 
-def _format_network_security_group_rules(sg_rules):
-    # For readability and to align with formatting compute security group
-    # rules, trim keys with caller known (e.g. security group and tenant ID)
-    # or empty values.
+def _format_network_security_group_rules(
+    sg_rules: list[dict[str, Any]],
+) -> str:
+    # For readability, trim keys with caller known (e.g. security group and
+    # tenant ID) or empty values.
     for sg_rule in sg_rules:
         empty_keys = [k for k, v in sg_rule.items() if not v]
         for key in empty_keys:
@@ -39,54 +44,22 @@ def _format_network_security_group_rules(sg_rules):
         sg_rule.pop('security_group_id', None)
         sg_rule.pop('tenant_id', None)
         sg_rule.pop('project_id', None)
-    return utils.format_list_of_dicts(sg_rules)
-
-
-def _format_compute_security_group_rule(sg_rule):
-    info = network_utils.transform_compute_security_group_rule(sg_rule)
-    # Trim parent security group ID since caller has this information.
-    info.pop('parent_group_id', None)
-    # Trim keys with empty string values.
-    keys_to_trim = [
-        'ip_protocol',
-        'ip_range',
-        'port_range',
-        'remote_security_group',
-    ]
-    for key in keys_to_trim:
-        if key in info and not info[key]:
-            info.pop(key)
-    return utils.format_dict(info)
+    return utils.format_list_of_dicts(sg_rules) or ""
 
 
-def _format_compute_security_group_rules(sg_rules):
-    rules = []
-    for sg_rule in sg_rules:
-        rules.append(_format_compute_security_group_rule(sg_rule))
-    return utils.format_list(rules, separator='\n')
-
-
-class NetworkSecurityGroupRulesColumn(cliff_columns.FormattableColumn[ty.Any]):
-    def human_readable(self):
+class NetworkSecurityGroupRulesColumn(cliff_columns.FormattableColumn[Any]):
+    def human_readable(self) -> str:
         return _format_network_security_group_rules(self._value)
 
 
-class ComputeSecurityGroupRulesColumn(cliff_columns.FormattableColumn[ty.Any]):
-    def human_readable(self):
-        return _format_compute_security_group_rules(self._value)
-
-
-_formatters_network = {
+_formatters = {
     'security_group_rules': NetworkSecurityGroupRulesColumn,
 }
 
 
-_formatters_compute = {
-    'rules': ComputeSecurityGroupRulesColumn,
-}
-
-
-def _get_columns(item):
+def _get_columns(
+    item: _security_group.SecurityGroup,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     # We still support Nova managed security groups, where we have tenant_id.
     column_map = {
         'security_group_rules': 'rules',
@@ -97,14 +70,11 @@ def _get_columns(item):
     )
 
 
-# TODO(abhiraut): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
-class CreateSecurityGroup(
-    common.NetworkAndComputeShowOne, common.NeutronCommandWithExtraArgs
-):
+class CreateSecurityGroup(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create a new security group")
 
-    def update_parser_common(self, parser):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "name", metavar="<name>", help=_("New security group name")
         )
@@ -113,13 +83,10 @@ class CreateSecurityGroup(
             metavar="<description>",
             help=_("Security group description"),
         )
-        return parser
-
-    def update_parser_network(self, parser):
         parser.add_argument(
             '--project',
             metavar='<project>',
-            help=self.enhance_help_neutron(_("Owner's project (name or ID)")),
+            help=_("Owner's project (name or ID)"),
         )
         stateful_group = parser.add_mutually_exclusive_group()
         stateful_group.add_argument(
@@ -134,21 +101,20 @@ class CreateSecurityGroup(
             default=None,
             help=_("Security group is stateless"),
         )
-        identity_common.add_project_domain_option_to_parser(
-            parser, enhance_help=self.enhance_help_neutron
-        )
-        _tag.add_tag_option_to_parser_for_create(
-            parser, _('security group'), enhance_help=self.enhance_help_neutron
-        )
+        identity_common.add_project_domain_option_to_parser(parser)
+        _tag.add_tag_option_to_parser_for_create(parser, _('security group'))
         return parser
 
-    def _get_description(self, parsed_args):
+    def _get_description(self, parsed_args: argparse.Namespace) -> str:
         if parsed_args.description is not None:
-            return parsed_args.description
+            return cast(str, parsed_args.description)
         else:
-            return parsed_args.name
+            return cast(str, parsed_args.name)
 
-    def take_action_network(self, client, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        client = self.app.client_manager.network
         # Build the create attributes.
         attrs = {}
         attrs['name'] = parsed_args.name
@@ -175,33 +141,16 @@ class CreateSecurityGroup(
         _tag.update_tags_for_set(client, obj, parsed_args)
         display_columns, property_columns = _get_columns(obj)
         data = utils.get_item_properties(
-            obj, property_columns, formatters=_formatters_network
-        )
-        return (display_columns, data)
-
-    def take_action_compute(self, client, parsed_args):
-        description = self._get_description(parsed_args)
-        obj = compute_v2.create_security_group(
-            client,
-            parsed_args.name,
-            description,
-        )
-        display_columns = ('description', 'id', 'name', 'project_id', 'rules')
-        property_columns = ('description', 'id', 'name', 'tenant_id', 'rules')
-        data = utils.get_dict_properties(
-            obj, property_columns, formatters=_formatters_compute
+            obj, property_columns, formatters=_formatters
         )
         return (display_columns, data)
 
 
-class DeleteSecurityGroup(common.NetworkAndComputeDelete):
+class DeleteSecurityGroup(command.Command):
     _description = _("Delete security group(s)")
 
-    # Used by base class to find resources in parsed_args.
-    resource = 'group'
-    r = None
-
-    def update_parser_common(self, parser):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'group',
             metavar='<group>',
@@ -210,18 +159,34 @@ class DeleteSecurityGroup(common.NetworkAndComputeDelete):
         )
         return parser
 
-    def take_action_network(self, client, parsed_args):
-        obj = client.find_security_group(self.r, ignore_missing=False)
-        client.delete_security_group(obj)
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        client = self.app.client_manager.network
+        result = 0
+
+        for group in parsed_args.group:
+            try:
+                obj = client.find_security_group(group, ignore_missing=False)
+                client.delete_security_group(obj)
+            except Exception as e:
+                result += 1
+                LOG.error(
+                    _(
+                        "Failed to delete security group with "
+                        "name or ID '%(group)s': %(e)s"
+                    ),
+                    {'group': group, 'e': e},
+                )
 
-    def take_action_compute(self, client, parsed_args):
-        security_group = compute_v2.find_security_group(client, self.r)
-        compute_v2.delete_security_group(client, security_group['id'])
+        if result > 0:
+            total = len(parsed_args.group)
+            msg = _("%(result)s of %(total)s groups failed to delete.") % {
+                'result': result,
+                'total': total,
+            }
+            raise exceptions.CommandError(msg)
 
 
-# TODO(rauta): Use the SDK resource mapped attribute names once
-# the OSC minimum requirements include SDK 1.0.
-class ListSecurityGroup(common.NetworkAndComputeLister):
+class ListSecurityGroup(command.Lister):
     _description = _("List security groups")
     FIELDS_TO_RETRIEVE = [
         'id',
@@ -232,30 +197,17 @@ class ListSecurityGroup(common.NetworkAndComputeLister):
         'shared',
     ]
 
-    def update_parser_network(self, parser):
-        if not self.is_docs_build:
-            # Maintain and hide the argument for backwards compatibility.
-            # Network will always return all projects for an admin.
-            parser.add_argument(
-                '--all-projects',
-                action='store_true',
-                default=False,
-                help=argparse.SUPPRESS,
-            )
-
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             '--project',
             metavar='<project>',
-            help=self.enhance_help_neutron(
-                _(
-                    "List only security groups with the specified project "
-                    "(name or ID)"
-                )
+            help=_(
+                "List only security groups with the specified project "
+                "(name or ID)"
             ),
         )
-        identity_common.add_project_domain_option_to_parser(
-            parser, enhance_help=self.enhance_help_neutron
-        )
+        identity_common.add_project_domain_option_to_parser(parser)
 
         shared_group = parser.add_mutually_exclusive_group()
         shared_group.add_argument(
@@ -273,24 +225,16 @@ class ListSecurityGroup(common.NetworkAndComputeLister):
             help=_("List only security groups not shared between projects"),
         )
 
-        _tag.add_tag_filtering_option_to_parser(
-            parser, _('security group'), enhance_help=self.enhance_help_neutron
-        )
-        return parser
-
-    def update_parser_compute(self, parser):
-        parser.add_argument(
-            '--all-projects',
-            action='store_true',
-            default=False,
-            help=self.enhance_help_nova_network(
-                _("Display information from all projects (admin only)")
-            ),
-        )
+        _tag.add_tag_filtering_option_to_parser(parser, _('security group'))
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
-    def take_action_network(self, client, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        client = self.app.client_manager.network
         filters = {}
+
         if parsed_args.project:
             identity_client = self.app.client_manager.identity
             project_id = identity_common.find_project(
@@ -302,6 +246,12 @@ class ListSecurityGroup(common.NetworkAndComputeLister):
 
         if parsed_args.shared is not None:
             filters['shared'] = parsed_args.shared
+        if parsed_args.marker is not None:
+            filters['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            filters['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            filters['max_items'] = parsed_args.max_items
 
         _tag.get_tag_filtering_args(parsed_args, filters)
         data = client.security_groups(
@@ -335,36 +285,12 @@ class ListSecurityGroup(common.NetworkAndComputeLister):
             ),
         )
 
-    def take_action_compute(self, client, parsed_args):
-        data = compute_v2.list_security_groups(
-            # TODO(dtroyer): add limit, marker
-            client,
-            all_projects=parsed_args.all_projects,
-        )
-
-        columns: tuple[str, ...] = ("id", "name", "description")
-        column_headers: tuple[str, ...] = ("ID", "Name", "Description")
-        if parsed_args.all_projects:
-            columns += ('tenant_id',)
-            column_headers += ('Project',)
-        return (
-            column_headers,
-            (
-                utils.get_dict_properties(
-                    s,
-                    columns,
-                )
-                for s in data
-            ),
-        )
-
 
-class SetSecurityGroup(
-    common.NetworkAndComputeCommand, common.NeutronCommandWithExtraArgs
-):
+class SetSecurityGroup(common.NeutronCommandWithExtraArgs):
     _description = _("Set security group properties")
 
-    def update_parser_common(self, parser):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'group',
             metavar='<group>',
@@ -391,15 +317,11 @@ class SetSecurityGroup(
             default=None,
             help=_("Security group is stateless"),
         )
+        _tag.add_tag_option_to_parser_for_set(parser, _('security group'))
         return parser
 
-    def update_parser_network(self, parser):
-        _tag.add_tag_option_to_parser_for_set(
-            parser, _('security group'), enhance_help=self.enhance_help_neutron
-        )
-        return parser
-
-    def take_action_network(self, client, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        client = self.app.client_manager.network
         obj = client.find_security_group(
             parsed_args.group, ignore_missing=False
         )
@@ -423,29 +345,12 @@ class SetSecurityGroup(
         # tags is a subresource and it needs to be updated separately.
         _tag.update_tags_for_set(client, obj, parsed_args)
 
-    def take_action_compute(self, client, parsed_args):
-        security_group = compute_v2.find_security_group(
-            client, parsed_args.group
-        )
 
-        params = {}
-        if parsed_args.name is not None:
-            params['name'] = parsed_args.name
-        if parsed_args.description is not None:
-            params['description'] = parsed_args.description
-
-        # NOTE(rtheis): Previous behavior did not raise a CommandError
-        # if there were no updates. Maintain this behavior and issue
-        # the update.
-        compute_v2.update_security_group(
-            client, security_group['id'], **params
-        )
-
-
-class ShowSecurityGroup(common.NetworkAndComputeShowOne):
+class ShowSecurityGroup(command.ShowOne):
     _description = _("Display security group details")
 
-    def update_parser_common(self, parser):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'group',
             metavar='<group>',
@@ -453,22 +358,16 @@ class ShowSecurityGroup(common.NetworkAndComputeShowOne):
         )
         return parser
 
-    def take_action_network(self, client, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        client = self.app.client_manager.network
         obj = client.find_security_group(
             parsed_args.group, ignore_missing=False
         )
         display_columns, property_columns = _get_columns(obj)
         data = utils.get_item_properties(
-            obj, property_columns, formatters=_formatters_network
-        )
-        return (display_columns, data)
-
-    def take_action_compute(self, client, parsed_args):
-        obj = compute_v2.find_security_group(client, parsed_args.group)
-        display_columns = ('description', 'id', 'name', 'project_id', 'rules')
-        property_columns = ('description', 'id', 'name', 'tenant_id', 'rules')
-        data = utils.get_dict_properties(
-            obj, property_columns, formatters=_formatters_compute
+            obj, property_columns, formatters=_formatters
         )
         return (display_columns, data)
 
@@ -476,7 +375,7 @@ class ShowSecurityGroup(common.NetworkAndComputeShowOne):
 class UnsetSecurityGroup(command.Command):
     _description = _("Unset security group properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'group',
@@ -486,7 +385,7 @@ class UnsetSecurityGroup(command.Command):
         _tag.add_tag_option_to_parser_for_unset(parser, _('security group'))
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         client = self.app.client_manager.network
         obj = client.find_security_group(
             parsed_args.group, ignore_missing=False