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

openstackclient/network/v2/subnet.py

@@ -20,6 +20,7 @@ import logging
 from typing import Any
 
 from cliff import columns as cliff_columns
+from openstack.network.v2 import subnet as _subnet
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
 from osc_lib import exceptions
@@ -27,6 +28,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
@@ -166,7 +168,9 @@ def _get_common_parse_arguments(
     )
 
 
-def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns(
+    item: _subnet.Subnet,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         'is_dhcp_enabled': 'enable_dhcp',
         'subnet_pool_id': 'subnetpool_id',
@@ -302,8 +306,6 @@ def _get_attrs(
     return attrs
 
 
-# TODO(abhiraut): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class CreateSubnet(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create a subnet")
 
@@ -490,8 +492,6 @@ class DeleteSubnet(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 ListSubnet(command.Lister):
     _description = _("List subnets")
 
@@ -581,6 +581,7 @@ class ListSubnet(command.Lister):
             ),
         )
         _tag.add_tag_filtering_option_to_parser(parser, _('subnets'))
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(
@@ -588,7 +589,9 @@ class ListSubnet(command.Lister):
     ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         identity_client = self.app.client_manager.identity
         network_client = self.app.client_manager.network
+
         filters = {}
+
         if parsed_args.ip_version:
             filters['ip_version'] = parsed_args.ip_version
         if parsed_args.dhcp:
@@ -622,7 +625,14 @@ class ListSubnet(command.Lister):
                 parsed_args.subnet_pool, ignore_missing=False
             ).id
             filters['subnetpool_id'] = subnetpool_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
         _tag.get_tag_filtering_args(parsed_args, filters)
+
         data = network_client.subnets(**filters)
 
         headers: tuple[str, ...] = ('ID', 'Name', 'Network', 'Subnet')
@@ -664,8 +674,6 @@ class ListSubnet(command.Lister):
         )
 
 
-# TODO(abhiraut): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class SetSubnet(common.NeutronCommandWithExtraArgs):
     _description = _("Set subnet properties")
 

openstackclient/network/v2/subnet_pool.py

@@ -18,6 +18,7 @@ from collections.abc import Iterable, Sequence
 import logging
 from typing import Any
 
+from openstack.network.v2 import subnet_pool as _subnet_pool
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
 from osc_lib import exceptions
@@ -25,15 +26,17 @@ 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
 
-
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns(
+    item: _subnet_pool.SubnetPool,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         'default_prefix_length': 'default_prefixlen',
         'is_shared': 'shared',
@@ -156,8 +159,6 @@ def _add_default_options(parser: argparse.ArgumentParser) -> None:
     )
 
 
-# TODO(rtheis): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class CreateSubnetPool(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create subnet pool")
 
@@ -270,8 +271,6 @@ class DeleteSubnetPool(command.Command):
             raise exceptions.CommandError(msg)
 
 
-# TODO(rtheis): Use only the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class ListSubnetPool(command.Lister):
     _description = _("List subnet pools")
 
@@ -334,6 +333,7 @@ class ListSubnetPool(command.Lister):
             ),
         )
         _tag.add_tag_filtering_option_to_parser(parser, _('subnet pools'))
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(
@@ -366,7 +366,14 @@ class ListSubnetPool(command.Lister):
                 parsed_args.address_scope, ignore_missing=False
             )
             filters['address_scope_id'] = address_scope.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
         _tag.get_tag_filtering_args(parsed_args, filters)
+
         data = network_client.subnet_pools(**filters)
 
         headers: tuple[str, ...] = ('ID', 'Name', 'Prefixes')
@@ -400,8 +407,6 @@ class ListSubnetPool(command.Lister):
         )
 
 
-# TODO(rtheis): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class SetSubnetPool(common.NeutronCommandWithExtraArgs):
     _description = _("Set subnet pool properties")
 

openstackclient/network/v2/taas/tap_flow.py

@@ -17,6 +17,7 @@ import logging
 from collections.abc import Iterable, Sequence
 from typing import Any
 
+from openstack.network.v2 import tap_flow as _tap_flow
 from osc_lib.cli import format_columns
 from osc_lib.cli import identity as identity_utils
 from osc_lib import exceptions
@@ -26,7 +27,6 @@ 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.taas import tap_service
 
 LOG = logging.getLogger(__name__)
 
@@ -55,6 +55,16 @@ def _add_updatable_args(parser: argparse.ArgumentParser) -> None:
     )
 
 
+def _get_columns(
+    item: _tap_flow.TapFlow,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
+    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 CreateTapFlow(command.ShowOne):
     _description = _("Create a new tap flow.")
 
@@ -125,7 +135,7 @@ class CreateTapFlow(command.ShowOne):
                 parsed_args.project_domain,
             ).id
         obj = client.create_tap_flow(**attrs)
-        display_columns, columns = tap_service._get_columns(obj)
+        display_columns, columns = _get_columns(obj)
         data = osc_utils.get_dict_properties(obj, columns)
         return display_columns, data
 
@@ -185,7 +195,7 @@ class ShowTapFlow(command.ShowOne):
             parsed_args.tap_flow, ignore_missing=False
         ).id
         obj = client.get_tap_flow(id)
-        display_columns, columns = tap_service._get_columns(obj)
+        display_columns, columns = _get_columns(obj)
         data = osc_utils.get_dict_properties(obj, columns)
         return display_columns, data
 

openstackclient/network/v2/taas/tap_mirror.py

@@ -15,6 +15,7 @@ import logging
 from collections.abc import Iterable, Sequence
 from typing import Any
 
+from openstack.network.v2 import tap_mirror as _tap_mirror
 from osc_lib.cli import identity as identity_utils
 from osc_lib import exceptions
 from osc_lib import utils as osc_utils
@@ -42,7 +43,9 @@ _attr_map = [
 ]
 
 
-def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns(
+    item: _tap_mirror.TapMirror,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map: dict[str, str] = {}
     hidden_columns = ['location', 'tenant_id']
     return osc_utils.get_osc_show_columns_for_sdk_resource(
@@ -118,7 +121,7 @@ class CreateTapMirror(command.ShowOne):
                 parsed_args.project_domain,
             ).id
         obj = client.create_tap_mirror(**attrs)
-        display_columns, columns = tap_service._get_columns(obj)
+        display_columns, columns = _get_columns(obj)
         data = osc_utils.get_dict_properties(obj, columns)
         return display_columns, data
 
@@ -173,7 +176,7 @@ class ShowTapMirror(command.ShowOne):
             parsed_args.tap_mirror, ignore_missing=False
         ).id
         obj = client.get_tap_mirror(id)
-        display_columns, columns = tap_service._get_columns(obj)
+        display_columns, columns = _get_columns(obj)
         data = osc_utils.get_dict_properties(obj, columns)
         return display_columns, data
 
@@ -243,6 +246,6 @@ class UpdateTapMirror(command.ShowOne):
         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)
+        display_columns, columns = _get_columns(obj)
         data = osc_utils.get_dict_properties(obj, columns)
         return display_columns, data

openstackclient/network/v2/taas/tap_service.py

@@ -17,6 +17,7 @@ import logging
 from collections.abc import Iterable, Sequence
 from typing import Any
 
+from openstack.network.v2 import tap_service as _tap_service
 from osc_lib.cli import identity as identity_utils
 from osc_lib import exceptions
 from osc_lib import utils as osc_utils
@@ -47,7 +48,9 @@ def _add_updatable_args(parser: argparse.ArgumentParser) -> None:
     )
 
 
-def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns(
+    item: _tap_service.TapService,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map: dict[str, str] = {}
     hidden_columns = ['location', 'tenant_id']
     return osc_utils.get_osc_show_columns_for_sdk_resource(

openstackclient/object/v1/container.py

@@ -132,7 +132,9 @@ class ListContainer(command.Lister):
             metavar="<prefix>",
             help=_("Filter list using <prefix>"),
         )
-        pagination.add_marker_pagination_option_to_parser(parser)
+        pagination.add_marker_pagination_option_to_parser(
+            parser, include_max_items=False
+        )
         parser.add_argument(
             "--end-marker",
             metavar="<end-marker>",

openstackclient/object/v1/object.py

@@ -146,7 +146,9 @@ class ListObject(command.Lister):
             metavar="<delimiter>",
             help=_("Roll up items with <delimiter>"),
         )
-        pagination.add_marker_pagination_option_to_parser(parser)
+        pagination.add_marker_pagination_option_to_parser(
+            parser, include_max_items=False
+        )
         parser.add_argument(
             "--end-marker",
             metavar="<end-marker>",

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

@@ -10,7 +10,9 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+import json
 import os
+import tempfile
 from typing import ClassVar
 
 import fixtures
@@ -75,6 +77,10 @@ class IdentityTests(base.TestCase):
     ]
     ENDPOINT_LIST_PROJECT_HEADERS = ['ID', 'Name']
 
+    MAPPING_FIELDS = ['id', 'rules', 'schema_version']
+
+    MAPPING_LIST_HEADERS = ['ID', 'schema_version']
+
     IDENTITY_PROVIDER_FIELDS = [
         'description',
         'enabled',
@@ -371,6 +377,34 @@ class IdentityTests(base.TestCase):
         self.assert_show_fields(items, self.ENDPOINT_FIELDS)
         return endpoint['id']
 
+    def _create_dummy_mapping(self, add_clean_up=True):
+        mapping = data_utils.rand_name('Mapping')
+        # 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'mapping create {mapping} --rules {f.name} --schema-version 1.0'
+            )
+
+        if add_clean_up:
+            self.addCleanup(
+                self.openstack,
+                f'mapping delete {mapping}',
+            )
+        items = self.parse_show(raw_output)
+        self.assert_show_fields(items, self.MAPPING_FIELDS)
+        return mapping
+
     def _create_dummy_idp(self, add_clean_up=True):
         identity_provider = data_utils.rand_name('IdentityProvider')
         description = data_utils.rand_name('description')

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

@@ -107,7 +107,7 @@ class ApplicationCredentialTests(common.IdentityTests):
         secret = data_utils.rand_name('secret')
         description = data_utils.rand_name('description')
         tomorrow = (
-            datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
+            datetime.datetime.now(datetime.UTC).replace(tzinfo=None)
             + datetime.timedelta(days=1)
         ).strftime('%Y-%m-%dT%H:%M:%S%z')
         role1, role2 = self._create_role_assignments()

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

@@ -0,0 +1,81 @@
+#    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 MappingTests(common.IdentityTests):
+    def test_mapping_create(self):
+        self._create_dummy_mapping()
+
+    def test_mapping_delete(self):
+        mapping = self._create_dummy_mapping(add_clean_up=False)
+        raw_output = self.openstack(f'mapping delete {mapping}')
+        self.assertEqual(0, len(raw_output))
+
+    def test_mapping_multi_delete(self):
+        mapping_1 = self._create_dummy_mapping(add_clean_up=False)
+        mapping_2 = self._create_dummy_mapping(add_clean_up=False)
+        raw_output = self.openstack(f'mapping delete {mapping_1} {mapping_2}')
+        self.assertEqual(0, len(raw_output))
+
+    def test_mapping_show(self):
+        mapping = self._create_dummy_mapping(add_clean_up=True)
+        raw_output = self.openstack(f'mapping show {mapping}')
+        items = self.parse_show(raw_output)
+        self.assert_show_fields(items, self.MAPPING_FIELDS)
+
+    def test_mapping_list(self):
+        self._create_dummy_mapping(add_clean_up=True)
+        raw_output = self.openstack('mapping list')
+        items = self.parse_listing(raw_output)
+        self.assert_table_structure(items, self.MAPPING_LIST_HEADERS)
+
+    def test_mapping_set(self):
+        mapping = self._create_dummy_mapping(add_clean_up=True)
+        new_schema_version = '2.0'
+        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'mapping set {mapping} --rules {f.name} --schema-version {new_schema_version}'
+            )
+        self.assertEqual(0, len(raw_output))
+        raw_output = self.openstack(f'mapping show {mapping}')
+        updated_value = self.parse_show_as_object(raw_output)
+        self.assertEqual('2.0', updated_value['schema_version'])

openstackclient/tests/functional/volume/v3/test_volume_group.py

@@ -0,0 +1,163 @@
+#    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.
+
+from typing import ClassVar
+import uuid
+
+from openstackclient.tests.functional.volume.v3 import common
+
+
+class VolumeGroupTests(common.BaseVolumeTests):
+    """Functional tests for volume group."""
+
+    API_VERSION = '3.13'
+    GROUP_TYPE_NAME = uuid.uuid4().hex
+    GROUP_TYPE_ID: ClassVar[str]
+    VOLUME_TYPE_ID: ClassVar[str]
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cmd_output = cls.openstack(
+            '--os-volume-api-version '
+            + cls.API_VERSION
+            + ' volume group type create '
+            + cls.GROUP_TYPE_NAME,
+            parse_output=True,
+        )
+        cls.GROUP_TYPE_ID = cmd_output['ID']
+
+        volume_type_name = uuid.uuid4().hex
+        cmd_output = cls.openstack(
+            'volume type create ' + volume_type_name,
+            parse_output=True,
+        )
+        cls.VOLUME_TYPE_ID = cmd_output['id']
+
+    @classmethod
+    def tearDownClass(cls):
+        try:
+            raw_output = cls.openstack(
+                'volume type delete ' + cls.VOLUME_TYPE_ID
+            )
+            cls.assertOutput('', raw_output)
+            raw_output = cls.openstack(
+                '--os-volume-api-version '
+                + cls.API_VERSION
+                + ' volume group type delete '
+                + cls.GROUP_TYPE_NAME
+            )
+            cls.assertOutput('', raw_output)
+        finally:
+            super().tearDownClass()
+
+    def test_volume_group(self):
+        # create volume group
+        name = uuid.uuid4().hex
+        description = 'description-' + uuid.uuid4().hex
+        cmd_output = self.openstack(
+            '--os-volume-api-version '
+            + self.API_VERSION
+            + ' volume group create '
+            + '--volume-group-type '
+            + self.GROUP_TYPE_NAME
+            + ' --volume-type '
+            + self.VOLUME_TYPE_ID
+            + ' --name '
+            + name
+            + ' --description '
+            + description,
+            parse_output=True,
+        )
+        group_id = cmd_output['ID']
+        self.addCleanup(
+            self.wait_for_delete,
+            '--os-volume-api-version ' + self.API_VERSION + ' volume group',
+            group_id,
+            name_field='ID',
+        )
+        self.addCleanup(
+            self.openstack,
+            '--os-volume-api-version '
+            + self.API_VERSION
+            + ' volume group delete '
+            + group_id,
+            fail_ok=True,
+        )
+        self.assertIsNotNone(group_id)
+        self.assertEqual(name, cmd_output['Name'])
+        self.assertEqual(description, cmd_output['Description'])
+        self.assertEqual(self.GROUP_TYPE_ID, cmd_output['Group Type'])
+        self.assertIn(self.VOLUME_TYPE_ID, cmd_output['Volume Types'])
+
+        # show volume group
+        cmd_output = self.openstack(
+            '--os-volume-api-version '
+            + self.API_VERSION
+            + ' volume group show '
+            + group_id,
+            parse_output=True,
+        )
+        self.assertEqual(group_id, cmd_output['ID'])
+        self.assertEqual(name, cmd_output['Name'])
+        self.assertEqual(description, cmd_output['Description'])
+
+        # list volume group
+        cmd_output = self.openstack(
+            '--os-volume-api-version '
+            + self.API_VERSION
+            + ' volume group list',
+            parse_output=True,
+        )
+        self.assertIn(group_id, [group['ID'] for group in cmd_output])
+        self.assertIn(name, [group['Name'] for group in cmd_output])
+
+        # set volume group
+        new_name = uuid.uuid4().hex
+        new_description = 'description-' + uuid.uuid4().hex
+        self.openstack(
+            '--os-volume-api-version '
+            + self.API_VERSION
+            + ' volume group set '
+            + '--name '
+            + new_name
+            + ' --description '
+            + new_description
+            + ' '
+            + group_id,
+        )
+
+        # show updated volume group
+        cmd_output = self.openstack(
+            '--os-volume-api-version '
+            + self.API_VERSION
+            + ' volume group show '
+            + group_id,
+            parse_output=True,
+        )
+        self.assertEqual(group_id, cmd_output['ID'])
+        self.assertEqual(new_name, cmd_output['Name'])
+        self.assertEqual(new_description, cmd_output['Description'])
+
+        # delete volume group
+        raw_output = self.openstack(
+            '--os-volume-api-version '
+            + self.API_VERSION
+            + ' volume group delete '
+            + group_id,
+        )
+        self.assertOutput('', raw_output)
+        self.wait_for_delete(
+            '--os-volume-api-version ' + self.API_VERSION + ' volume group',
+            group_id,
+            name_field='ID',
+        )

openstackclient/tests/unit/common/test_limits.py

@@ -16,7 +16,7 @@ from openstackclient.tests.unit.compute.v2 import fakes as compute_fakes
 from openstackclient.tests.unit.volume.v3 import fakes as volume_fakes
 
 
-class TestComputeLimits(compute_fakes.TestComputev2):
+class TestComputeLimits(compute_fakes.TestCompute):
     absolute_columns = ['Name', 'Value']
     rate_columns = ["Verb", "URI", "Value", "Remain", "Unit", "Next Available"]