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

openstackclient/network/v2/fwaas/rule.py

@@ -0,0 +1,610 @@
+# Copyright 2016-2017 FUJITSU LIMITED
+# All Rights Reserved
+#
+#    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 argparse
+from collections.abc import Iterable, Sequence
+import logging
+from typing import Any
+
+from cliff import columns as cliff_columns
+from osc_lib.cli import identity as identity_utils
+from osc_lib import exceptions
+from osc_lib import utils
+from osc_lib.utils import columns as column_util
+
+from openstackclient import command
+from openstackclient.i18n import _
+from openstackclient.identity import common as identity_common
+
+
+LOG = logging.getLogger(__name__)
+
+
+_attr_map = (
+    ('id', 'ID', column_util.LIST_BOTH),
+    ('name', 'Name', column_util.LIST_BOTH),
+    ('enabled', 'Enabled', column_util.LIST_BOTH),
+    ('summary', 'Summary', column_util.LIST_SHORT_ONLY),
+    ('description', 'Description', column_util.LIST_LONG_ONLY),
+    ('firewall_policy_id', 'Firewall Policy', column_util.LIST_BOTH),
+    ('ip_version', 'IP Version', column_util.LIST_LONG_ONLY),
+    ('action', 'Action', column_util.LIST_LONG_ONLY),
+    ('protocol', 'Protocol', column_util.LIST_LONG_ONLY),
+    ('source_ip_address', 'Source IP Address', column_util.LIST_LONG_ONLY),
+    ('source_port', 'Source Port', column_util.LIST_LONG_ONLY),
+    (
+        'destination_ip_address',
+        'Destination IP Address',
+        column_util.LIST_LONG_ONLY,
+    ),
+    ('destination_port', 'Destination Port', column_util.LIST_LONG_ONLY),
+    ('shared', 'Shared', column_util.LIST_LONG_ONLY),
+    ('project_id', 'Project', column_util.LIST_LONG_ONLY),
+    (
+        'source_firewall_group_id',
+        'Source Firewall Group ID',
+        column_util.LIST_LONG_ONLY,
+    ),
+    (
+        'destination_firewall_group_id',
+        'Destination Firewall Group ID',
+        column_util.LIST_LONG_ONLY,
+    ),
+)
+
+_attr_map_dict = {x[0]: x[1] for x in _attr_map}
+
+
+def _convert_to_lowercase(string: str) -> str:
+    return string.lower()
+
+
+def _get_common_parser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
+    parser.add_argument(
+        '--description',
+        metavar='<description>',
+        help=_('Description of the firewall rule'),
+    )
+    parser.add_argument(
+        '--protocol',
+        type=_convert_to_lowercase,
+        help=_(
+            'IP protocol (ah, dccp, egp, esp, gre, icmp, igmp, '
+            'ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt, ipv6-opts, '
+            'ipv6-route, ospf, pgm, rsvp, sctp, tcp, udp, udplite, '
+            'vrrp and integer representations [0-255] or any; '
+            'default: any (all protocols))'
+        ),
+    )
+    parser.add_argument(
+        '--action',
+        choices=['allow', 'deny', 'reject'],
+        type=_convert_to_lowercase,
+        help=_('Action for the firewall rule'),
+    )
+    parser.add_argument(
+        '--ip-version',
+        metavar='<ip-version>',
+        choices=['4', '6'],
+        help=_('Set IP version 4 or 6 (default is 4)'),
+    )
+    src_ip_group = parser.add_mutually_exclusive_group()
+    src_ip_group.add_argument(
+        '--source-ip-address',
+        metavar='<source-ip-address>',
+        help=_('Source IP address or subnet'),
+    )
+    src_ip_group.add_argument(
+        '--no-source-ip-address',
+        action='store_true',
+        help=_('Detach source IP address'),
+    )
+    dst_ip_group = parser.add_mutually_exclusive_group()
+    dst_ip_group.add_argument(
+        '--destination-ip-address',
+        metavar='<destination-ip-address>',
+        help=_('Destination IP address or subnet'),
+    )
+    dst_ip_group.add_argument(
+        '--no-destination-ip-address',
+        action='store_true',
+        help=_('Detach destination IP address'),
+    )
+    src_port_group = parser.add_mutually_exclusive_group()
+    src_port_group.add_argument(
+        '--source-port',
+        metavar='<source-port>',
+        help=_(
+            'Source port number or range '
+            '(integer in [1, 65535] or range like 123:456)'
+        ),
+    )
+    src_port_group.add_argument(
+        '--no-source-port',
+        action='store_true',
+        help=_('Detach source port number or range'),
+    )
+    dst_port_group = parser.add_mutually_exclusive_group()
+    dst_port_group.add_argument(
+        '--destination-port',
+        metavar='<destination-port>',
+        help=_(
+            'Destination port number or range'
+            '(integer in [1, 65535] or range like 123:456)'
+        ),
+    )
+    dst_port_group.add_argument(
+        '--no-destination-port',
+        action='store_true',
+        help=_('Detach destination port number or range'),
+    )
+    shared_group = parser.add_mutually_exclusive_group()
+    shared_group.add_argument(
+        '--share',
+        action='store_true',
+        default=None,
+        dest='shared',
+        help=_(
+            'Share the firewall rule to be used in all projects '
+            '(by default, it is restricted to be used by the '
+            'current project).'
+        ),
+    )
+    shared_group.add_argument(
+        '--no-share',
+        action='store_false',
+        dest='shared',
+        help=_('Restrict use of the firewall rule to the current project'),
+    )
+    enable_group = parser.add_mutually_exclusive_group()
+    enable_group.add_argument(
+        '--enable-rule',
+        action='store_true',
+        default=None,
+        dest='enabled',
+        help=_('Enable this rule (default is enabled)'),
+    )
+    enable_group.add_argument(
+        '--disable-rule',
+        action='store_false',
+        dest='enabled',
+        help=_('Disable this rule'),
+    )
+    src_fwg_group = parser.add_mutually_exclusive_group()
+    src_fwg_group.add_argument(
+        '--source-firewall-group',
+        metavar='<source-firewall-group>',
+        help=_('Source firewall group (name or ID)'),
+    )
+    src_fwg_group.add_argument(
+        '--no-source-firewall-group',
+        action='store_true',
+        help=_('No associated source firewall group'),
+    )
+    dst_fwg_group = parser.add_mutually_exclusive_group()
+    dst_fwg_group.add_argument(
+        '--destination-firewall-group',
+        metavar='<destination-firewall-group>',
+        help=_('Destination firewall group (name or ID)'),
+    )
+    dst_fwg_group.add_argument(
+        '--no-destination-firewall-group',
+        action='store_true',
+        help=_('No associated destination firewall group'),
+    )
+    return parser
+
+
+def _get_common_attrs(
+    client_manager: Any,
+    parsed_args: argparse.Namespace,
+    is_create: bool = True,
+) -> dict[str, Any]:
+    attrs: dict[str, Any] = {}
+    client = client_manager.network
+    if parsed_args.name:
+        attrs['name'] = parsed_args.name
+    if parsed_args.description:
+        attrs['description'] = parsed_args.description
+    if parsed_args.protocol:
+        protocol = parsed_args.protocol
+        attrs['protocol'] = None if protocol == 'any' else protocol
+    if parsed_args.action:
+        attrs['action'] = parsed_args.action
+    if parsed_args.ip_version:
+        attrs['ip_version'] = str(parsed_args.ip_version)
+
+    if parsed_args.source_port:
+        attrs['source_port'] = parsed_args.source_port
+    if parsed_args.no_source_port:
+        attrs['source_port'] = None
+
+    if parsed_args.source_ip_address:
+        attrs['source_ip_address'] = parsed_args.source_ip_address
+    if parsed_args.no_source_ip_address:
+        attrs['source_ip_address'] = None
+
+    if parsed_args.destination_port:
+        attrs['destination_port'] = parsed_args.destination_port
+    if parsed_args.no_destination_port:
+        attrs['destination_port'] = None
+
+    if parsed_args.destination_ip_address:
+        attrs['destination_ip_address'] = parsed_args.destination_ip_address
+    if parsed_args.no_destination_ip_address:
+        attrs['destination_ip_address'] = None
+
+    if parsed_args.enabled is not None:
+        attrs['enabled'] = parsed_args.enabled
+
+    if parsed_args.shared is not None:
+        attrs['shared'] = parsed_args.shared
+
+    if parsed_args.source_firewall_group:
+        attrs['source_firewall_group_id'] = client.find_firewall_group(
+            parsed_args.source_firewall_group, ignore_missing=False
+        ).id
+    if parsed_args.no_source_firewall_group:
+        attrs['source_firewall_group_id'] = None
+
+    if parsed_args.destination_firewall_group:
+        attrs['destination_firewall_group_id'] = client.find_firewall_group(
+            parsed_args.destination_firewall_group, ignore_missing=False
+        ).id
+    if parsed_args.no_destination_firewall_group:
+        attrs['destination_firewall_group_id'] = None
+
+    return attrs
+
+
+class ProtocolColumn(cliff_columns.FormattableColumn[str | None]):
+    def human_readable(self) -> str:
+        return self._value if self._value else 'any'
+
+
+_formatters = {'protocol': ProtocolColumn}
+
+
+class CreateFirewallRule(command.ShowOne):
+    _description = _("Create a new firewall rule")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        _get_common_parser(parser)
+        # TODO(slaweq): Remove the deprecated --name option and make the
+        # positional name argument required (remove nargs='?') once the
+        # deprecation period is over.
+        parser.add_argument(
+            'positional_name',
+            nargs='?',
+            metavar='<name>',
+            default=None,
+            help=_('Name of the firewall rule'),
+        )
+        parser.add_argument(
+            '--name',
+            metavar='<name>',
+            help=_(
+                '(Deprecated, please pass name as a positional argument) '
+                'Name of the firewall rule'
+            ),
+        )
+        identity_utils.add_project_owner_option_to_parser(parser)
+        return parser
+
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        client = self.app.client_manager.network
+        # TODO(slaweq): Remove this --name deprecation handling once the
+        # deprecation period is over.
+        if parsed_args.positional_name and parsed_args.name:
+            msg = _(
+                "Cannot specify name as both a positional argument "
+                "and with the --name option."
+            )
+            raise exceptions.CommandError(msg)
+        if parsed_args.name:
+            LOG.warning(
+                'The --name option is deprecated for the "firewall group '
+                'rule create" command, please pass the name as a positional '
+                'argument instead.'
+            )
+        elif parsed_args.positional_name:
+            parsed_args.name = parsed_args.positional_name
+        attrs = _get_common_attrs(self.app.client_manager, parsed_args)
+        if 'project' in parsed_args and parsed_args.project is not None:
+            attrs['project_id'] = identity_common.find_project(
+                self.app.client_manager.identity,
+                parsed_args.project,
+                parsed_args.project_domain,
+            ).id
+        obj = client.create_firewall_rule(**attrs)
+        display_columns, columns = utils.get_osc_show_columns_for_sdk_resource(
+            obj, _attr_map_dict, ['location', 'tenant_id']
+        )
+        data = utils.get_dict_properties(obj, columns, formatters=_formatters)
+        return display_columns, data
+
+
+class DeleteFirewallRule(command.Command):
+    _description = _("Delete firewall rule(s)")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'firewall_rule',
+            metavar='<firewall-rule>',
+            nargs='+',
+            help=_('Firewall rule(s) to delete (name or ID)'),
+        )
+        return parser
+
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        client = self.app.client_manager.network
+        result = 0
+        for fwr in parsed_args.firewall_rule:
+            try:
+                fwr = client.find_firewall_rule(fwr, ignore_missing=False)
+                client.delete_firewall_rule(fwr.id)
+            except Exception as e:
+                result += 1
+                LOG.error(
+                    _(
+                        "Failed to delete Firewall rule with "
+                        "name or ID '%(firewall_rule)s': %(e)s"
+                    ),
+                    {'firewall_rule': fwr, 'e': e},
+                )
+
+        if result > 0:
+            total = len(parsed_args.firewall_rule)
+            msg = _(
+                "%(result)s of %(total)s firewall rule(s) failed to delete."
+            ) % {'result': result, 'total': total}
+            raise exceptions.CommandError(msg)
+
+
+class ListFirewallRule(command.Lister):
+    _description = _("List firewall rules that belong to a given tenant")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            '--long',
+            action='store_true',
+            default=False,
+            help=_("List additional fields in output"),
+        )
+        return parser
+
+    def extend_list(
+        self, data: Iterable[Any], parsed_args: argparse.Namespace
+    ) -> list[Any]:
+        ext_data = []
+        for d in data:
+            protocol = d['protocol'].upper() if d['protocol'] else 'ANY'
+            src_ip = 'none specified'
+            dst_ip = 'none specified'
+            src_port = '(none specified)'
+            dst_port = '(none specified)'
+            if d.get('source_ip_address'):
+                src_ip = str(d['source_ip_address']).lower()
+            if d.get('source_port'):
+                src_port = '(' + str(d['source_port']).lower() + ')'
+            if d.get('destination_ip_address'):
+                dst_ip = str(d['destination_ip_address']).lower()
+            if d.get('destination_port'):
+                dst_port = '(' + str(d['destination_port']).lower() + ')'
+            action = d['action'] if d.get('action') else 'no-action'
+            src = 'source(port): ' + src_ip + src_port
+            dst = 'dest(port): ' + dst_ip + dst_port
+            d['summary'] = ',\n '.join([protocol, src, dst, action])
+            ext_data.append(d)
+        return ext_data
+
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
+        client = self.app.client_manager.network
+        obj = client.firewall_rules()
+        obj_extend = self.extend_list(obj, parsed_args)
+        headers, columns = column_util.get_column_definitions(
+            list(_attr_map), long_listing=parsed_args.long
+        )
+        return (
+            headers,
+            (
+                utils.get_dict_properties(s, columns, formatters=_formatters)
+                for s in obj_extend
+            ),
+        )
+
+
+class SetFirewallRule(command.Command):
+    _description = _("Set firewall rule properties")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        _get_common_parser(parser)
+        parser.add_argument(
+            'firewall_rule',
+            metavar='<firewall-rule>',
+            help=_('Firewall rule to set (name or ID)'),
+        )
+        parser.add_argument(
+            '--name',
+            metavar='<name>',
+            help=_('Name of the firewall rule'),
+        )
+        return parser
+
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        client = self.app.client_manager.network
+        attrs = _get_common_attrs(
+            self.app.client_manager, parsed_args, is_create=False
+        )
+        fwr_id = client.find_firewall_rule(
+            parsed_args.firewall_rule, ignore_missing=False
+        ).id
+        try:
+            client.update_firewall_rule(fwr_id, **attrs)
+        except Exception as e:
+            msg = _("Failed to set firewall rule '%(rule)s': %(e)s") % {
+                'rule': parsed_args.firewall_rule,
+                'e': e,
+            }
+            raise exceptions.CommandError(msg)
+
+
+class ShowFirewallRule(command.ShowOne):
+    _description = _("Display firewall rule details")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'firewall_rule',
+            metavar='<firewall-rule>',
+            help=_('Firewall rule to display (name or ID)'),
+        )
+        return parser
+
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        client = self.app.client_manager.network
+        fwr_id = client.find_firewall_rule(
+            parsed_args.firewall_rule, ignore_missing=False
+        ).id
+        obj = client.get_firewall_rule(fwr_id)
+        display_columns, columns = utils.get_osc_show_columns_for_sdk_resource(
+            obj, _attr_map_dict, ['location', 'tenant_id']
+        )
+        data = utils.get_dict_properties(obj, columns, formatters=_formatters)
+        return (display_columns, data)
+
+
+class UnsetFirewallRule(command.Command):
+    _description = _("Unset firewall rule properties")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'firewall_rule',
+            metavar='<firewall-rule>',
+            help=_('Firewall rule to unset (name or ID)'),
+        )
+        parser.add_argument(
+            '--source-ip-address',
+            action='store_true',
+            help=_('Source IP address or subnet'),
+        )
+        parser.add_argument(
+            '--destination-ip-address',
+            action='store_true',
+            help=_('Destination IP address or subnet'),
+        )
+        parser.add_argument(
+            '--source-port',
+            action='store_true',
+            help=_(
+                'Source port number or range'
+                '(integer in [1, 65535] or range like 123:456)'
+            ),
+        )
+        parser.add_argument(
+            '--destination-port',
+            action='store_true',
+            help=_(
+                'Destination port number or range'
+                '(integer in [1, 65535] or range like 123:456)'
+            ),
+        )
+        parser.add_argument(
+            '--share',
+            action='store_true',
+            help=_(
+                '(Deprecated) Use "firewall rule set --no-share" instead. '
+                'Restrict use of the firewall rule to the current project'
+            ),
+        )
+        parser.add_argument(
+            '--enable-rule',
+            action='store_true',
+            help=_(
+                '(Deprecated) Use "firewall rule set --disable-rule" instead. '
+                'Disable this rule'
+            ),
+        )
+
+        parser.add_argument(
+            '--source-firewall-group',
+            action='store_true',
+            help=_('Source firewall group (name or ID)'),
+        )
+
+        parser.add_argument(
+            '--destination-firewall-group',
+            action='store_true',
+            help=_('Destination firewall group (name or ID)'),
+        )
+        return parser
+
+    def _get_attrs(
+        self, client_manager: Any, parsed_args: argparse.Namespace
+    ) -> dict[str, Any]:
+        attrs: dict[str, Any] = {}
+        if parsed_args.source_ip_address:
+            attrs['source_ip_address'] = None
+        if parsed_args.source_port:
+            attrs['source_port'] = None
+        if parsed_args.destination_ip_address:
+            attrs['destination_ip_address'] = None
+        if parsed_args.destination_port:
+            attrs['destination_port'] = None
+        if parsed_args.share:
+            LOG.warning(
+                'The --share option is deprecated, please use '
+                '"firewall rule set --no-share" instead.'
+            )
+            attrs['shared'] = False
+        if parsed_args.enable_rule:
+            LOG.warning(
+                'The --enable-rule option is deprecated, please use '
+                '"firewall rule set --disable-rule" instead.'
+            )
+            attrs['enabled'] = False
+        if parsed_args.source_firewall_group:
+            attrs['source_firewall_group_id'] = None
+        if parsed_args.destination_firewall_group:
+            attrs['destination_firewall_group_id'] = None
+        return attrs
+
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        client = self.app.client_manager.network
+        attrs = self._get_attrs(self.app.client_manager, parsed_args)
+        fwr_id = client.find_firewall_rule(
+            parsed_args.firewall_rule, ignore_missing=False
+        ).id
+        try:
+            client.update_firewall_rule(fwr_id, **attrs)
+        except Exception as e:
+            msg = _("Failed to unset firewall rule '%(rule)s': %(e)s") % {
+                'rule': parsed_args.firewall_rule,
+                'e': e,
+            }
+            raise exceptions.CommandError(msg)

openstackclient/network/v2/ip_availability.py

@@ -13,10 +13,16 @@
 
 """IP Availability Info implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
+from openstack.network.v2 import network_ip_availability as _ip_availability
 from osc_lib.cli import format_columns
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -25,19 +31,19 @@ _formatters = {
 }
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _ip_availability.NetworkIPAvailability,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['id', 'name', 'location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
     )
 
 
-# TODO(ankur-gupta-f): Use the SDK resource mapped attribute names once
-# the OSC minimum requirements include SDK 1.0.
 class ListIPAvailability(command.Lister):
     _description = _("List IP availability for network")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--ip-version',
@@ -60,9 +66,12 @@ class ListIPAvailability(command.Lister):
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         client = self.app.client_manager.network
 
         columns = (
@@ -81,7 +90,6 @@ class ListIPAvailability(command.Lister):
         filters = {}
         if parsed_args.ip_version:
             filters['ip_version'] = parsed_args.ip_version
-
         if parsed_args.project:
             identity_client = self.app.client_manager.identity
             project_id = identity_common.find_project(
@@ -90,6 +98,13 @@ class ListIPAvailability(command.Lister):
                 parsed_args.project_domain,
             ).id
             filters['project_id'] = project_id
+        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
+
         data = client.network_ip_availabilities(**filters)
         return (
             column_headers,
@@ -106,7 +121,7 @@ class ListIPAvailability(command.Lister):
 class ShowIPAvailability(command.ShowOne):
     _description = _("Show network IP availability details")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'network',
@@ -115,7 +130,9 @@ class ShowIPAvailability(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         client = self.app.client_manager.network
         network_id = client.find_network(
             parsed_args.network, ignore_missing=False