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

openstackclient/network/v2/port.py

@@ -14,12 +14,14 @@
 """Port action implementations"""
 
 import argparse
+from collections.abc import Iterable, Sequence
 import copy
 import json
 import logging
-import typing as ty
+from typing import Any
 
 from cliff import columns as cliff_columns
+from openstack.network.v2 import port as _port
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
 from osc_lib import exceptions
@@ -27,6 +29,7 @@ from osc_lib import utils
 from osc_lib.utils import tags as _tag
 
 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
@@ -35,22 +38,22 @@ LOG = logging.getLogger(__name__)
 
 
 class AdminStateColumn(cliff_columns.FormattableColumn[bool]):
-    def human_readable(self):
+    def human_readable(self) -> str:
         return 'UP' if self._value else 'DOWN'
 
 
 class SubPortColumn(format_columns.ListDictColumn):
-    _value: ty.Any
+    _value: Any
 
-    def _retrieve_subports(self):
+    def _retrieve_subports(self) -> None:
         if isinstance(self._value, dict):
             self._value = self._value['sub_ports']
 
-    def human_readable(self):
+    def human_readable(self) -> str:
         self._retrieve_subports()
         return super().human_readable()
 
-    def machine_readable(self):
+    def machine_readable(self) -> Any:
         self._retrieve_subports()
         return super().machine_readable()
 
@@ -73,7 +76,9 @@ _list_formatters = copy.deepcopy(_formatters)
 _list_formatters.update({'trunk_details': SubPortColumn})
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _port.Port,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_data_mapping = {
         'admin_state_up': 'is_admin_state_up',
         'allowed_address_pairs': 'allowed_address_pairs',
@@ -104,6 +109,8 @@ def _get_columns(item):
         'port_security_enabled': 'is_port_security_enabled',
         'project_id': 'project_id',
         'propagate_uplink_status': 'propagate_uplink_status',
+        'pvlan_type': 'pvlan_type',
+        'pvlan_community': 'pvlan_community',
         'resource_request': 'resource_request',
         'revision_number': 'revision_number',
         'qos_network_policy_id': 'qos_network_policy_id',
@@ -127,7 +134,13 @@ class JSONKeyValueAction(argparse.Action):
     Ensures that ``dest`` is a dict
     """
 
-    def __call__(self, parser, namespace, values, option_string=None):
+    def __call__(
+        self,
+        parser: argparse.ArgumentParser,
+        namespace: argparse.Namespace,
+        values: Any,
+        option_string: str | None = None,
+    ) -> None:
         # Make sure we have an empty dict rather than None
         if getattr(namespace, self.dest, None) is None:
             setattr(namespace, self.dest, {})
@@ -148,8 +161,10 @@ class JSONKeyValueAction(argparse.Action):
                 raise argparse.ArgumentError(self, msg)
 
 
-def _get_attrs(client_manager, parsed_args):
-    attrs = {}
+def _get_attrs(
+    client_manager: Any, parsed_args: argparse.Namespace
+) -> dict[str, Any]:
+    attrs: dict[str, Any] = {}
 
     if parsed_args.description is not None:
         attrs['description'] = parsed_args.description
@@ -180,8 +195,6 @@ def _get_attrs(client_manager, parsed_args):
     if 'network' in parsed_args and parsed_args.network is not None:
         attrs['network_id'] = parsed_args.network
     if 'project' in parsed_args and parsed_args.project is not None:
-        # TODO(singhj): since 'project' logic is common among
-        # router, network, port etc., maybe move it to a common file.
         identity_client = client_manager.identity
         project_id = identity_common.find_project(
             identity_client,
@@ -247,10 +260,51 @@ def _get_attrs(client_manager, parsed_args):
     if parsed_args.trusted:
         attrs['trusted'] = True
 
+    if 'pvlan_type' in parsed_args and parsed_args.pvlan_type is not None:
+        attrs['pvlan_type'] = parsed_args.pvlan_type
+    if (
+        'pvlan_community' in parsed_args
+        and parsed_args.pvlan_community is not None
+    ):
+        attrs['pvlan_community'] = parsed_args.pvlan_community
+
+    _validate_pvlan_port(attrs)
+
     return attrs
 
 
-def _prepare_fixed_ips(client_manager, parsed_args):
+def _validate_pvlan_port(attrs: dict[str, Any]) -> None:
+    if (attrs.get('pvlan_type') or attrs.get('pvlan_community')) and attrs.get(
+        'port_security_enabled'
+    ) is False:
+        msg = _(
+            "PVLAN attributes cannot be set when port security is disabled."
+        )
+        raise exceptions.CommandError(msg)
+
+    if attrs.get('pvlan_type') == 'community' and not attrs.get(
+        'pvlan_community'
+    ):
+        msg = _(
+            "--pvlan-community is required when --pvlan-type is 'community'."
+        )
+        raise exceptions.CommandError(msg)
+
+
+def _validate_pvlan_network_port(attrs: dict[str, Any], network: Any) -> None:
+    if not (attrs.get('pvlan_type') or attrs.get('pvlan_community')):
+        return
+    if not network.pvlan:
+        msg = _(
+            "PVLAN attributes cannot be set on a port whose "
+            "network does not have PVLAN enabled."
+        )
+        raise exceptions.CommandError(msg)
+
+
+def _prepare_fixed_ips(
+    client_manager: Any, parsed_args: argparse.Namespace
+) -> None:
     """Fix and properly format fixed_ip option.
 
     Appropriately convert any subnet names to their respective ids.
@@ -281,7 +335,9 @@ def _prepare_fixed_ips(client_manager, parsed_args):
         parsed_args.fixed_ip = ips
 
 
-def _prepare_filter_fixed_ips(client_manager, parsed_args):
+def _prepare_filter_fixed_ips(
+    client_manager: Any, parsed_args: argparse.Namespace
+) -> list[str]:
     """Fix and properly format fixed_ip option for filtering.
 
     Appropriately convert any subnet names to their respective ids.
@@ -308,7 +364,9 @@ def _prepare_filter_fixed_ips(client_manager, parsed_args):
     return ips
 
 
-def _add_updatable_args(parser, create=False):
+def _add_updatable_args(
+    parser: argparse.ArgumentParser, create: bool = False
+) -> None:
     parser.add_argument(
         '--description',
         metavar='<description>',
@@ -430,11 +488,31 @@ def _add_updatable_args(parser, create=False):
             "which expect it in this dictionary (for example, Nova)."
         ),
     )
+    parser.add_argument(
+        '--pvlan-type',
+        metavar='<type>',
+        choices=['promiscuous', 'isolated', 'community'],
+        dest='pvlan_type',
+        help=_(
+            "Set Private VLAN type for this port. Requires PVLAN service "
+            "plugin. Default: promiscuous."
+        ),
+    )
+    parser.add_argument(
+        '--pvlan-community',
+        metavar='<community>',
+        dest='pvlan_community',
+        help=_(
+            "Set PVLAN community name for this port. "
+            "Only applies when pvlan-type is 'community'. "
+            "Requires PVLAN service plugin. Default: None."
+        ),
+    )
 
 
-# TODO(abhiraut): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
-def _convert_address_pairs(parsed_args):
+def _convert_address_pairs(
+    parsed_args: argparse.Namespace,
+) -> list[dict[str, Any]]:
     ops = []
     for opt in parsed_args.allowed_address_pairs:
         addr = {}
@@ -445,7 +523,9 @@ def _convert_address_pairs(parsed_args):
     return ops
 
 
-def _convert_extra_dhcp_options(parsed_args):
+def _convert_extra_dhcp_options(
+    parsed_args: argparse.Namespace,
+) -> list[dict[str, Any]]:
     dhcp_options = []
     for opt in parsed_args.extra_dhcp_options:
         option = {}
@@ -460,7 +540,7 @@ def _convert_extra_dhcp_options(parsed_args):
 
 # When we have multiple hints, we'll need to refactor this to allow
 # arbitrary combinations. But until then let's have it as simple as possible.
-def _validate_port_hints(hints):
+def _validate_port_hints(hints: dict[str, Any]) -> None:
     if hints not in (
         {},
         # by hint alias
@@ -477,7 +557,7 @@ def _validate_port_hints(hints):
 # When we have multiple hints, we'll need to refactor this to expand aliases
 # without losing other hints. But until then let's have it as simple as
 # possible.
-def _expand_port_hint_aliases(hints):
+def _expand_port_hint_aliases(hints: dict[str, Any]) -> dict[str, Any]:
     if hints == {'ovs-tx-steering': 'thread'}:
         return {'openvswitch': {'other_config': {'tx-steering': 'thread'}}}
     elif hints == {'ovs-tx-steering': 'hash'}:
@@ -489,7 +569,7 @@ def _expand_port_hint_aliases(hints):
 class CreatePort(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create a new port")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
 
         parser.add_argument(
@@ -635,7 +715,9 @@ class CreatePort(command.ShowOne, common.NeutronCommandWithExtraArgs):
         _tag.add_tag_option_to_parser_for_create(parser, _('port'))
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         network_client = self.app.client_manager.network
         network = network_client.find_network(
             parsed_args.network, ignore_missing=False
@@ -711,6 +793,8 @@ class CreatePort(command.ShowOne, common.NeutronCommandWithExtraArgs):
             self._parse_extra_properties(parsed_args.extra_properties)
         )
 
+        _validate_pvlan_network_port(attrs, network)
+
         with common.check_missing_extension_if_error(network_client, attrs):
             obj = network_client.create_port(**attrs)
 
@@ -727,7 +811,7 @@ class CreatePort(command.ShowOne, common.NeutronCommandWithExtraArgs):
 class DeletePort(command.Command):
     _description = _("Delete port(s)")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'port',
@@ -737,7 +821,7 @@ class DeletePort(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         client = self.app.client_manager.network
         result = 0
 
@@ -764,12 +848,10 @@ class DeletePort(command.Command):
             raise exceptions.CommandError(msg)
 
 
-# TODO(abhiraut): Use only the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class ListPort(command.Lister):
     _description = _("List ports")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--device-owner',
@@ -865,9 +947,12 @@ class ListPort(command.Lister):
             ),
         )
         _tag.add_tag_filtering_option_to_parser(parser, _('ports'))
+        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[Sequence[str], Iterable[tuple[Any, ...]]]:
         network_client = self.app.client_manager.network
         identity_client = self.app.client_manager.identity
 
@@ -894,7 +979,6 @@ class ListPort(command.Lister):
             column_headers.extend(
                 ['Security Groups', 'Device Owner', 'Tags', 'Trunk subports']
             )
-
         if parsed_args.device_owner is not None:
             filters['device_owner'] = parsed_args.device_owner
         if parsed_args.device_id is not None:
@@ -937,6 +1021,12 @@ class ListPort(command.Lister):
             )
         if parsed_args.security_groups:
             filters['security_group_ids'] = parsed_args.security_groups
+        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)
 
@@ -961,12 +1051,10 @@ class ListPort(command.Lister):
         )
 
 
-# TODO(abhiraut): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class SetPort(common.NeutronCommandWithExtraArgs):
     _description = _("Set port properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         _add_updatable_args(parser)
         admin_group = parser.add_mutually_exclusive_group()
@@ -1120,7 +1208,7 @@ class SetPort(common.NeutronCommandWithExtraArgs):
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         client = self.app.client_manager.network
 
         _prepare_fixed_ips(self.app.client_manager, parsed_args)
@@ -1209,6 +1297,10 @@ class SetPort(common.NeutronCommandWithExtraArgs):
             self._parse_extra_properties(parsed_args.extra_properties)
         )
 
+        if attrs.get('pvlan_type') or attrs.get('pvlan_community'):
+            network = client.find_network(obj.network_id, ignore_missing=False)
+            _validate_pvlan_network_port(attrs, network)
+
         if attrs:
             with common.check_missing_extension_if_error(
                 self.app.client_manager.network, attrs
@@ -1222,14 +1314,16 @@ class SetPort(common.NeutronCommandWithExtraArgs):
 class ShowPort(command.ShowOne):
     _description = _("Display port 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(
             'port', metavar="<port>", help=_("Port to display (name or ID)")
         )
         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
         obj = client.find_port(parsed_args.port, ignore_missing=False)
         display_columns, columns = _get_columns(obj)
@@ -1237,12 +1331,10 @@ class ShowPort(command.ShowOne):
         return (display_columns, data)
 
 
-# TODO(abhiraut): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class UnsetPort(common.NeutronUnsetCommandWithExtraArgs):
     _description = _("Unset port 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(
             '--fixed-ip',
@@ -1330,6 +1422,13 @@ class UnsetPort(common.NeutronUnsetCommandWithExtraArgs):
             default=False,
             help=_("Clear device owner for the port."),
         )
+        parser.add_argument(
+            '--pvlan-community',
+            action='store_true',
+            default=False,
+            dest='pvlan_community',
+            help=_("Clear PVLAN community name for the port."),
+        )
         _tag.add_tag_option_to_parser_for_unset(parser, _('port'))
         parser.add_argument(
             'port',
@@ -1339,7 +1438,7 @@ class UnsetPort(common.NeutronUnsetCommandWithExtraArgs):
 
         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_port(parsed_args.port, ignore_missing=False)
         # SDK ignores update() if it receives a modified obj and attrs
@@ -1400,6 +1499,8 @@ class UnsetPort(common.NeutronUnsetCommandWithExtraArgs):
             attrs['device_id'] = ''
         if parsed_args.device_owner:
             attrs['device_owner'] = ''
+        if parsed_args.pvlan_community:
+            attrs['pvlan_community'] = None
 
         attrs.update(
             self._parse_extra_properties(parsed_args.extra_properties)