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

openstackclient/network/v2/taas/tap_mirror.py

@@ -0,0 +1,237 @@
+#    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 logging
+
+from osc_lib.cli import identity as identity_utils
+from osc_lib import exceptions
+from osc_lib import utils as osc_utils
+from osc_lib.utils import columns as column_util
+
+from openstackclient import command
+from openstackclient.i18n import _
+from openstackclient.identity import common
+from openstackclient.network.v2 import port as osc_port
+from openstackclient.network.v2.taas import tap_service
+
+LOG = logging.getLogger(__name__)
+
+TAP_MIRROR = 'tap_mirror'
+TAP_MIRRORS = f'{TAP_MIRROR}s'
+
+_attr_map = [
+    ('id', 'ID', column_util.LIST_BOTH),
+    ('tenant_id', 'Tenant', column_util.LIST_LONG_ONLY),
+    ('name', 'Name', column_util.LIST_BOTH),
+    ('port_id', 'Port', column_util.LIST_BOTH),
+    ('directions', 'Directions', column_util.LIST_LONG_ONLY),
+    ('remote_ip', 'Remote IP', column_util.LIST_BOTH),
+    ('mirror_type', 'Mirror Type', column_util.LIST_LONG_ONLY),
+]
+
+
+def _get_columns(item):
+    column_map: dict[str, str] = {}
+    hidden_columns = ['location', 'tenant_id']
+    return osc_utils.get_osc_show_columns_for_sdk_resource(
+        item, column_map, hidden_columns
+    )
+
+
+class CreateTapMirror(command.ShowOne):
+    _description = _("Create a new tap mirror.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        identity_utils.add_project_owner_option_to_parser(parser)
+        tap_service._add_updatable_args(parser)
+        parser.add_argument(
+            '--port',
+            dest='port_id',
+            required=True,
+            metavar="PORT",
+            help=_('Port (name or ID) to which the Tap Mirror is connected.'),
+        )
+        parser.add_argument(
+            '--directions',
+            dest='directions',
+            action=osc_port.JSONKeyValueAction,
+            required=True,
+            help=_(
+                'Dictionary of direction and tunnel_id. Valid directions are: '
+                'IN and OUT.'
+            ),
+        )
+        parser.add_argument(
+            '--remote-ip',
+            dest='remote_ip',
+            required=True,
+            help=_(
+                'Remote IP address for the tap mirror (remote end of the '
+                'GRE or ERSPAN v1 tunnel).'
+            ),
+        )
+        parser.add_argument(
+            '--mirror-type',
+            dest='mirror_type',
+            required=True,
+            help=_('Mirror type. Valid values are: gre and erspanv1.'),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        attrs = {}
+        if parsed_args.name is not None:
+            attrs['name'] = parsed_args.name
+        if parsed_args.description is not None:
+            attrs['description'] = parsed_args.description
+        if parsed_args.port_id is not None:
+            port_id = client.find_port(
+                parsed_args.port_id, ignore_missing=False
+            ).id
+            attrs['port_id'] = port_id
+        if parsed_args.directions is not None:
+            attrs['directions'] = parsed_args.directions
+        if parsed_args.remote_ip is not None:
+            attrs['remote_ip'] = parsed_args.remote_ip
+        if parsed_args.mirror_type is not None:
+            attrs['mirror_type'] = parsed_args.mirror_type
+        if 'project' in parsed_args and parsed_args.project is not None:
+            attrs['project_id'] = common.find_project(
+                self.app.client_manager.identity,
+                parsed_args.project,
+                parsed_args.project_domain,
+            ).id
+        obj = client.create_tap_mirror(**attrs)
+        display_columns, columns = tap_service._get_columns(obj)
+        data = osc_utils.get_dict_properties(obj, columns)
+        return display_columns, data
+
+
+class ListTapMirror(command.Lister):
+    _description = _("List tap mirrors.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        identity_utils.add_project_owner_option_to_parser(parser)
+
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        params = {}
+        if parsed_args.project is not None:
+            params['project_id'] = common.find_project(
+                self.app.client_manager.identity,
+                parsed_args.project,
+                parsed_args.project_domain,
+            ).id
+        objs = client.tap_mirrors(retrieve_all=True, params=params)
+        headers, columns = column_util.get_column_definitions(
+            _attr_map, long_listing=True
+        )
+        return (
+            headers,
+            (osc_utils.get_dict_properties(s, columns) for s in objs),
+        )
+
+
+class ShowTapMirror(command.ShowOne):
+    _description = _("Show tap mirror details.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            TAP_MIRROR,
+            metavar=f"<{TAP_MIRROR}>",
+            help=_("Tap mirror to display (name or ID)."),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        id = client.find_tap_mirror(
+            parsed_args.tap_mirror, ignore_missing=False
+        ).id
+        obj = client.get_tap_mirror(id)
+        display_columns, columns = tap_service._get_columns(obj)
+        data = osc_utils.get_dict_properties(obj, columns)
+        return display_columns, data
+
+
+class DeleteTapMirror(command.Command):
+    _description = _("Delete a tap mirror.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            TAP_MIRROR,
+            metavar=f"<{TAP_MIRROR}>",
+            nargs="+",
+            help=_("Tap mirror to delete (name or ID)."),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        fails = 0
+        for id_or_name in parsed_args.tap_mirror:
+            try:
+                id = client.find_tap_mirror(
+                    id_or_name, ignore_missing=False
+                ).id
+
+                client.delete_tap_mirror(id)
+                LOG.warning("Tap Mirror %(id)s deleted", {'id': id})
+            except Exception as e:
+                fails += 1
+                LOG.error(
+                    "Failed to delete Tap Mirror with name or ID "
+                    "'%(id_or_name)s': %(e)s",
+                    {'id_or_name': id_or_name, 'e': e},
+                )
+        if fails > 0:
+            msg = _("Failed to delete %(fails)s of %(total)s Tap Mirror.") % {
+                'fails': fails,
+                'total': len(parsed_args.tap_mirror),
+            }
+            raise exceptions.CommandError(msg)
+
+
+class UpdateTapMirror(command.ShowOne):
+    _description = _("Update a tap mirror.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            TAP_MIRROR,
+            metavar=f"<{TAP_MIRROR}>",
+            help=_("Tap mirror to modify (name or ID)."),
+        )
+        tap_service._add_updatable_args(parser)
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        original_t_s = client.find_tap_mirror(
+            parsed_args.tap_mirror, ignore_missing=False
+        ).id
+        attrs = {}
+        if parsed_args.name is not None:
+            attrs['name'] = parsed_args.name
+        if parsed_args.description is not None:
+            attrs['description'] = parsed_args.description
+        obj = client.update_tap_mirror(original_t_s, **attrs)
+        display_columns, columns = tap_service._get_columns(obj)
+        data = osc_utils.get_dict_properties(obj, columns)
+        return display_columns, data

openstackclient/network/v2/taas/tap_service.py

@@ -0,0 +1,211 @@
+# All Rights Reserved 2020
+#
+#    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 logging
+
+from osc_lib.cli import identity as identity_utils
+from osc_lib import exceptions
+from osc_lib import utils as osc_utils
+from osc_lib.utils import columns as column_util
+
+from openstackclient import command
+from openstackclient.i18n import _
+from openstackclient.identity import common
+
+LOG = logging.getLogger(__name__)
+
+TAP_SERVICE = 'tap_service'
+TAP_SERVICES = f'{TAP_SERVICE}s'
+
+_attr_map = [
+    ('id', 'ID', column_util.LIST_BOTH),
+    ('tenant_id', 'Tenant', column_util.LIST_LONG_ONLY),
+    ('name', 'Name', column_util.LIST_BOTH),
+    ('port_id', 'Port', column_util.LIST_BOTH),
+    ('status', 'Status', column_util.LIST_BOTH),
+]
+
+
+def _add_updatable_args(parser):
+    parser.add_argument('--name', help=_('Name of the tap service.'))
+    parser.add_argument(
+        '--description', help=_('Description of the tap service.')
+    )
+
+
+def _get_columns(item):
+    column_map: dict[str, str] = {}
+    hidden_columns = ['location', 'tenant_id']
+    return osc_utils.get_osc_show_columns_for_sdk_resource(
+        item, column_map, hidden_columns
+    )
+
+
+class CreateTapService(command.ShowOne):
+    _description = _("Create a new tap service.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        identity_utils.add_project_owner_option_to_parser(parser)
+        _add_updatable_args(parser)
+        parser.add_argument(
+            '--port',
+            dest='port_id',
+            required=True,
+            metavar="PORT",
+            help=_('Port (name or ID) to connect to the tap service.'),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        attrs = {}
+        if parsed_args.name is not None:
+            attrs['name'] = parsed_args.name
+        if parsed_args.description is not None:
+            attrs['description'] = parsed_args.description
+        if parsed_args.port_id is not None:
+            port_id = client.find_port(
+                parsed_args.port_id, ignore_missing=False
+            ).id
+            attrs['port_id'] = port_id
+        if 'project' in parsed_args and parsed_args.project is not None:
+            attrs['project_id'] = common.find_project(
+                self.app.client_manager.identity,
+                parsed_args.project,
+                parsed_args.project_domain,
+            ).id
+        obj = client.create_tap_service(**attrs)
+        display_columns, columns = _get_columns(obj)
+        data = osc_utils.get_dict_properties(obj, columns)
+        return display_columns, data
+
+
+class ListTapService(command.Lister):
+    _description = _("List tap services.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        identity_utils.add_project_owner_option_to_parser(parser)
+
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        params = {}
+        if parsed_args.project is not None:
+            params['project_id'] = common.find_project(
+                self.app.client_manager.identity,
+                parsed_args.project,
+                parsed_args.project_domain,
+            ).id
+        objs = client.tap_services(retrieve_all=True, params=params)
+        headers, columns = column_util.get_column_definitions(
+            _attr_map, long_listing=True
+        )
+        return (
+            headers,
+            (osc_utils.get_dict_properties(s, columns) for s in objs),
+        )
+
+
+class ShowTapService(command.ShowOne):
+    _description = _("Show tap service details.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            TAP_SERVICE,
+            metavar=f"<{TAP_SERVICE}>",
+            help=_("Tap service to display (name or ID)."),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        id = client.find_tap_service(
+            parsed_args.tap_service, ignore_missing=False
+        ).id
+        obj = client.get_tap_service(id)
+        display_columns, columns = _get_columns(obj)
+        data = osc_utils.get_dict_properties(obj, columns)
+        return display_columns, data
+
+
+class DeleteTapService(command.Command):
+    _description = _("Delete a tap service.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            TAP_SERVICE,
+            metavar=f"<{TAP_SERVICE}>",
+            nargs="+",
+            help=_("Tap service to delete (name or ID)."),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        fails = 0
+        for id_or_name in parsed_args.tap_service:
+            try:
+                id = client.find_tap_service(
+                    id_or_name, ignore_missing=False
+                ).id
+
+                client.delete_tap_service(id)
+                LOG.warning("Tap service %(id)s deleted", {'id': id})
+            except Exception as e:
+                fails += 1
+                LOG.error(
+                    "Failed to delete tap service with name or ID "
+                    "'%(id_or_name)s': %(e)s",
+                    {'id_or_name': id_or_name, 'e': e},
+                )
+        if fails > 0:
+            msg = _("Failed to delete %(fails)s of %(total)s tap service.") % {
+                'fails': fails,
+                'total': len(parsed_args.tap_service),
+            }
+            raise exceptions.CommandError(msg)
+
+
+class UpdateTapService(command.ShowOne):
+    _description = _("Update a tap service.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            TAP_SERVICE,
+            metavar=f"<{TAP_SERVICE}>",
+            help=_("Tap service to modify (name or ID)."),
+        )
+        _add_updatable_args(parser)
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        original_t_s = client.find_tap_service(
+            parsed_args.tap_service, ignore_missing=False
+        ).id
+        attrs = {}
+        if parsed_args.name is not None:
+            attrs['name'] = parsed_args.name
+        if parsed_args.description is not None:
+            attrs['description'] = parsed_args.description
+        obj = client.update_tap_service(original_t_s, **attrs)
+        display_columns, columns = _get_columns(obj)
+        data = osc_utils.get_dict_properties(obj, columns)
+        return display_columns, data

openstackclient/object/v1/account.py

@@ -15,8 +15,8 @@
 
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/object/v1/container.py

@@ -19,9 +19,9 @@ import logging
 
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.common import pagination
 from openstackclient.i18n import _
 

openstackclient/object/v1/object.py

@@ -19,10 +19,10 @@ import logging
 
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.common import pagination
 from openstackclient.i18n import _
 

openstackclient/shell.py

@@ -26,16 +26,27 @@ from osc_lib import shell
 import openstackclient
 from openstackclient.common import clientmanager
 
-
 DEFAULT_DOMAIN = 'default'
+# list of modules that were originally out-of-tree and are now in
+# core OSC
+IGNORED_MODULES = (
+    'neutron_taas.taas_client.osc',
+    'neutronclient.osc.v2.taas',
+)
 
 
 class OpenStackShell(shell.OpenStackShell):
+    client_manager: clientmanager.ClientManager
+
     def __init__(self):
+        command_manager = commandmanager.CommandManager(
+            'openstack.cli', ignored_modules=IGNORED_MODULES
+        )
+
         super().__init__(
             description=__doc__.strip(),
             version=openstackclient.__version__,
-            command_manager=commandmanager.CommandManager('openstack.cli'),
+            command_manager=command_manager,
             deferred_help=True,
         )
 
@@ -48,8 +59,10 @@ class OpenStackShell(shell.OpenStackShell):
         # about them
         warnings.filterwarnings('ignore', module='openstack')
 
-    def build_option_parser(self, description, version):
-        parser = super().build_option_parser(description, version)
+    def build_option_parser(self, description, version, argparse_kwargs=None):
+        parser = super().build_option_parser(
+            description, version, argparse_kwargs
+        )
         parser = clientmanager.build_plugin_option_parser(parser)
         parser = auth.build_auth_plugins_option_parser(parser)
         return parser
@@ -65,10 +78,7 @@ class OpenStackShell(shell.OpenStackShell):
             self._auth_type = 'password'
 
     def _load_plugins(self):
-        """Load plugins via stevedore
-
-        osc-lib has no opinion on what plugins should be loaded
-        """
+        """Load plugins via stevedore."""
         # Loop through extensions to get API versions
         for mod in clientmanager.PLUGIN_MODULES:
             default_version = getattr(mod, 'DEFAULT_API_VERSION', None)

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

@@ -10,35 +10,54 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+
 from openstackclient.tests.functional.identity.v3 import common
 
 
 class CatalogTests(common.IdentityTests):
-    def test_catalog_list(self):
+    """Functional tests for catalog commands"""
+
+    def test_catalog(self):
+        """Test catalog list and show functionality"""
+        # Create a test service for isolated testing
+        _dummy_service_name = self._create_dummy_service(add_clean_up=True)
+
+        # list catalogs
         raw_output = self.openstack('catalog list')
         items = self.parse_listing(raw_output)
         self.assert_table_structure(items, ['Name', 'Type', 'Endpoints'])
 
-    def test_catalog_show(self):
-        """test catalog show command
-
-        The output example:
-        +-----------+----------------------------------------+
-        | Field     | Value                                  |
-        +-----------+----------------------------------------+
-        | endpoints | test1                                  |
-        |           |   public: http://localhost:5000/v2.0   |
-        |           | test1                                  |
-        |           |   internal: http://localhost:5000/v2.0 |
-        |           | test1                                  |
-        |           |   admin: http://localhost:35357/v2.0   |
-        |           |                                        |
-        | id        | e1e68b5ba21a43a39ff1cf58e736c3aa       |
-        | name      | keystone                               |
-        | type      | identity                               |
-        +-----------+----------------------------------------+
-        """
-        raw_output = self.openstack('catalog show {}'.format('identity'))
+        # Verify created service appears in catalog
+        service_names = [
+            item.get('Name') for item in items if item.get('Name')
+        ]
+        self.assertIn(
+            _dummy_service_name,
+            service_names,
+            "Created dummy service should be present in catalog",
+        )
+
+        # show service (by name)
+        raw_output = self.openstack(f'catalog show {_dummy_service_name}')
         items = self.parse_show(raw_output)
-        # items may have multiple endpoint urls with empty key
-        self.assert_show_fields(items, ['endpoints', 'name', 'type', '', 'id'])
+        self.assert_show_fields(items, ['endpoints', 'name', 'type', 'id'])
+
+        # Extract the type from the dummy service
+        _dummy_service_type = next(
+            (item['type'] for item in items if 'type' in item), None
+        )
+
+        # show service (by type)
+        raw_output = self.openstack(f'catalog show {_dummy_service_type}')
+        items = self.parse_show(raw_output)
+        self.assert_show_fields(items, ['endpoints', 'name', 'type', 'id'])
+
+        # show service (non-existent)
+        result = self.openstack(
+            'catalog show nonexistent-service-xyz', fail_ok=True
+        )
+        self.assertEqual(
+            '',
+            result.strip(),
+            "Non-existent service should return empty result",
+        )

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

@@ -100,6 +100,53 @@ class LimitTestCase(common.IdentityTests):
         self.assert_show_fields(items, self.LIMIT_FIELDS)
         registered_limit_id = self._create_dummy_registered_limit()
 
+    def test_limit_create_with_project_domain(self):
+        registered_limit_id = self._create_dummy_registered_limit()
+        raw_output = self.openstack(
+            f'registered limit show {registered_limit_id}',
+            cloud=SYSTEM_CLOUD,
+        )
+        items = self.parse_show(raw_output)
+        service_id = self._extract_value_from_items('service_id', items)
+        resource_name = self._extract_value_from_items('resource_name', items)
+
+        raw_output = self.openstack(f'service show {service_id}')
+        items = self.parse_show(raw_output)
+        service_name = self._extract_value_from_items('name', items)
+
+        project_name = self._create_dummy_project()
+        raw_output = self.openstack(
+            f'project show {project_name}',
+            cloud=SYSTEM_CLOUD,
+        )
+        items = self.parse_show(raw_output)
+        domain_id = self._extract_value_from_items('domain_id', items)
+
+        params = {
+            'project_name': project_name,
+            'project_domain': domain_id,
+            'service_name': service_name,
+            'resource_name': resource_name,
+            'resource_limit': 15,
+        }
+        raw_output = self.openstack(
+            'limit create'
+            ' --project {project_name}'
+            ' --project-domain {project_domain}'
+            ' --service {service_name}'
+            ' --resource-limit {resource_limit}'
+            ' {resource_name}'.format(**params),
+            cloud=SYSTEM_CLOUD,
+        )
+        items = self.parse_show(raw_output)
+        limit_id = self._extract_value_from_items('id', items)
+        self.addCleanup(
+            self.openstack, f'limit delete {limit_id}', cloud=SYSTEM_CLOUD
+        )
+
+        self.assert_show_fields(items, self.LIMIT_FIELDS)
+        registered_limit_id = self._create_dummy_registered_limit()
+
     def test_limit_create_with_service_id(self):
         self._create_dummy_limit()