Add "--marker" and "--limit" options to "snapshot list"

Add "--marker" and "--limit" options to
"snapshot list" command in volume v2 (v2 only).

Change-Id: Ib60840b9b83dfe5e599e4037e8ec308844a9448b
Closes-Bug: #1605475

Author: Huanxuan Ao

doc/source/command-objects/snapshot.rst

@@ -68,6 +68,9 @@ List snapshots
 
     os snapshot list
         [--all-projects]
+        [--long]
+        [--limit <limit>]
+        [--marker <marker>]
 
 .. option:: --all-projects
 
@@ -77,6 +80,18 @@ List snapshots
 
     List additional fields in output
 
+.. option:: --limit <limit>
+
+    Maximum number of snapshots to display
+
+    *Volume version 2 only*
+
+.. option:: --marker <marker>
+
+    The last snapshot ID of the previous page
+
+    *Volume version 2 only*
+
 snapshot set
 ------------
 

openstackclient/tests/volume/v2/test_snapshot.py

@@ -12,6 +12,7 @@
 #   under the License.
 #
 
+import argparse
 import mock
 from mock import call
 
@@ -260,16 +261,33 @@ def test_snapshot_list_without_options(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
+
+        self.snapshots_mock.list.assert_called_once_with(
+            limit=None, marker=None, search_opts={'all_tenants': False})
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, list(data))
 
     def test_snapshot_list_with_options(self):
-        arglist = ["--long"]
-        verifylist = [("long", True), ('all_projects', False)]
+        arglist = [
+            "--long",
+            "--limit", "2",
+            "--marker", self.snapshots[0].id,
+        ]
+        verifylist = [
+            ("long", True),
+            ("limit", 2),
+            ("marker", self.snapshots[0].id),
+            ('all_projects', False),
+        ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
 
+        self.snapshots_mock.list.assert_called_once_with(
+            limit=2,
+            marker=self.snapshots[0].id,
+            search_opts={'all_tenants': False}
+        )
         self.assertEqual(self.columns_long, columns)
         self.assertEqual(self.data_long, list(data))
 
@@ -285,9 +303,21 @@ def test_snapshot_list_all_projects(self):
 
         columns, data = self.cmd.take_action(parsed_args)
 
+        self.snapshots_mock.list.assert_called_once_with(
+            limit=None, marker=None, search_opts={'all_tenants': True})
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, list(data))
 
+    def test_snapshot_list_negative_limit(self):
+        arglist = [
+            "--limit", "-2",
+        ]
+        verifylist = [
+            ("limit", -2),
+        ]
+        self.assertRaises(argparse.ArgumentTypeError, self.check_parser,
+                          self.cmd, arglist, verifylist)
+
 
 class TestSnapshotSet(TestSnapshot):
 

openstackclient/volume/v2/snapshot.py

@@ -134,6 +134,18 @@ def get_parser(self, prog_name):
             default=False,
             help=_('List additional fields in output'),
         )
+        parser.add_argument(
+            '--marker',
+            metavar='<marker>',
+            help=_('The last snapshot ID of the previous page'),
+        )
+        parser.add_argument(
+            '--limit',
+            type=int,
+            action=parseractions.NonNegativeAction,
+            metavar='<limit>',
+            help=_('Maximum number of snapshots to display'),
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -174,7 +186,10 @@ def _format_volume_id(volume_id):
         }
 
         data = self.app.client_manager.volume.volume_snapshots.list(
-            search_opts=search_opts)
+            search_opts=search_opts,
+            marker=parsed_args.marker,
+            limit=parsed_args.limit,
+        )
         return (column_headers,
                 (utils.get_item_properties(
                     s, columns,

releasenotes/notes/bug-1605475-84e649fb8c675737.yaml

@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Add ``--limit`` and ``--marker`` options to ``snapshot list`` command.
+    [Bug `1605475 <https://bugs.launchpad.net/bugs/1605475>`_]