feat: add pagination to user and project list

Add --limit and --marker options to the ``openstack user list`` and
``openstack project list`` commands so callers can paginate through
large result sets using marker-based pagination.

Assisted-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Change-Id: Icfca16585aed13af490427b2f80b36be651d3b4b
Closes-Bug: #2153377
Signed-off-by: Sam Morrison <sorrison@gmail.com>

Author: sorrison

openstackclient/identity/v3/project.py

@@ -27,6 +27,7 @@
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common
 from openstackclient.identity.v3 import tag
@@ -297,6 +298,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             help=_('List only disabled projects'),
         )
         tag.add_tag_filtering_option_to_parser(parser, _('projects'))
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(
@@ -348,6 +350,11 @@ def take_action(
         if parsed_args.is_enabled is not None:
             kwargs['is_enabled'] = parsed_args.is_enabled
 
+        if parsed_args.limit is not None:
+            kwargs['limit'] = parsed_args.limit
+        if parsed_args.marker is not None:
+            kwargs['marker'] = parsed_args.marker
+
         tag.get_tag_filtering_args(parsed_args, kwargs)
 
         if parsed_args.my_projects:

openstackclient/identity/v3/user.py

@@ -27,6 +27,7 @@
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
@@ -448,11 +449,18 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
                 '--project and --group'
             ),
         )
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
+        if parsed_args.project and (
+            parsed_args.limit is not None or parsed_args.marker is not None
+        ):
+            msg = _('--limit and --marker are not supported with --project')
+            raise exceptions.CommandError(msg)
+
         identity_client = sdk_utils.ensure_service_version(
             self.app.client_manager.sdk_connection.identity, '3'
         )
@@ -475,6 +483,12 @@ def take_action(
         if parsed_args.is_enabled is not None:
             enabled = parsed_args.is_enabled
 
+        pagination_kwargs: dict[str, Any] = {}
+        if parsed_args.limit is not None:
+            pagination_kwargs['limit'] = parsed_args.limit
+        if parsed_args.marker is not None:
+            pagination_kwargs['marker'] = parsed_args.marker
+
         if parsed_args.project:
             if domain is not None:
                 project = identity_client.find_project(
@@ -509,16 +523,19 @@ def take_action(
             data = identity_client.group_users(
                 domain_id=domain,
                 group=group,
+                **pagination_kwargs,
             )
         else:
             if parsed_args.is_enabled is not None:
                 data = identity_client.users(
                     domain_id=domain,
                     is_enabled=enabled,
+                    **pagination_kwargs,
                 )
             else:
                 data = identity_client.users(
                     domain_id=domain,
+                    **pagination_kwargs,
                 )
 
         # Column handling

openstackclient/tests/unit/identity/v3/test_project.py

@@ -1273,6 +1273,29 @@ def test_project_list_with_option_enabled(self):
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.datalist, tuple(data))
 
+    def test_project_list_with_pagination(self):
+        self.identity_sdk_client.projects.return_value = [self.project]
+
+        arglist = [
+            '--limit',
+            '2',
+            '--marker',
+            'some-marker',
+        ]
+        verifylist = [
+            ('limit', 2),
+            ('marker', 'some-marker'),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        kwargs = {'limit': 2, 'marker': 'some-marker'}
+        self.identity_sdk_client.projects.assert_called_with(**kwargs)
+
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.datalist, tuple(data))
+
 
 class TestProjectSet(identity_fakes.TestIdentityv3):
     domain = sdk_fakes.generate_fake_resource(_domain.Domain)

openstackclient/tests/unit/identity/v3/test_user.py

@@ -1034,6 +1034,73 @@ def test_user_list_with_option_enabled(self):
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.datalist, tuple(data))
 
+    def test_user_list_with_pagination(self):
+        arglist = [
+            '--limit',
+            '2',
+            '--marker',
+            'some-marker',
+        ]
+        verifylist = [
+            ('limit', 2),
+            ('marker', 'some-marker'),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        kwargs = {
+            'domain_id': None,
+            'limit': 2,
+            'marker': 'some-marker',
+        }
+        self.identity_sdk_client.users.assert_called_with(**kwargs)
+
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.datalist, tuple(data))
+
+    def test_user_list_with_pagination_and_group(self):
+        arglist = [
+            '--group',
+            self.group.name,
+            '--limit',
+            '5',
+        ]
+        verifylist = [
+            ('group', self.group.name),
+            ('limit', 5),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        kwargs = {
+            'domain_id': None,
+            'group': self.group.id,
+            'limit': 5,
+        }
+        self.identity_sdk_client.group_users.assert_called_with(**kwargs)
+
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.datalist, tuple(data))
+
+    def test_user_list_pagination_with_project_fails(self):
+        arglist = [
+            '--project',
+            self.project.name,
+            '--limit',
+            '2',
+        ]
+        verifylist = [
+            ('project', self.project.name),
+            ('limit', 2),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.assertRaises(
+            exceptions.CommandError, self.cmd.take_action, parsed_args
+        )
+
 
 class TestUserSet(identity_fakes.TestIdentityv3):
     project = sdk_fakes.generate_fake_resource(_project.Project)

releasenotes/notes/add-pagination-to-user-and-project-list-7d41e0dc417f85d4.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Added ``--limit`` and ``--marker`` options to the
+    ``openstack user list`` and ``openstack project list`` commands to enable
+    marker-based pagination through large result sets.