Add pagination (limit and marker) to stack-list

Add support for ``limit`` and ``marker`` on stack-list and remove
unnecessary ``page_size`` parameter.

When using ``limit`` and/or ``marker``, stack-list will keep previous
behavior and list all stacks starting from ``marker`` up to ``limit``,
even if limit exceeds API limit restrictions, by using multiple calls
to /stacks endpoint.

Partial-Bug: 1268816
Change-Id: Ifb08c1aadd3629d60ddc56ffc507c99b9dba80ce

1 files changed, 14 insertions, 21 deletions

diff --git a/heatclient/v1/stacks.py b/heatclient/v1/stacks.py
index 258d313..d6d2737 100644
--- a/heatclient/v1/stacks.py
+++ b/heatclient/v1/stacks.py
@@ -67,7 +67,6 @@ class StackManager(base.BaseManager):
     def list(self, **kwargs):
         """Get a list of stacks.
 
-        :param page_size: number of items to request in each paginated request
         :param limit: maximum number of stacks to return
         :param marker: begin returning stacks that appear later in the stack
                        list than that represented by this stack id
@@ -75,32 +74,26 @@ class StackManager(base.BaseManager):
                         structure of a stack object
         :rtype: list of :class:`Stack`
         """
-        absolute_limit = kwargs.get('limit')
-
-        def paginate(qp, seen=0):
-            sort_qp = sorted(qp.items(), key=lambda x: x[0])
-            url = '/stacks?%s' % urlutils.urlencode(sort_qp)
-
-            stacks = self._list(url, "stacks")
+        def paginate(params):
+            '''Paginate stacks, even if more than API limit.'''
+            current_limit = int(params.get('limit') or 0)
+            url = '/stacks?%s' % urlutils.urlencode(params)
+            stacks = self._list(url, 'stacks')
             for stack in stacks:
-                seen += 1
-                if absolute_limit is not None and seen > absolute_limit:
-                    return
                 yield stack
 
-            page_size = qp.get('limit')
-            if (page_size and len(stacks) == page_size and
-                    (absolute_limit is None or 0 < seen < absolute_limit)):
-                qp['marker'] = stack.id
-                for stack in paginate(qp, seen):
+            num_stacks = len(stacks)
+            remaining_limit = current_limit - num_stacks
+            if remaining_limit > 0 and num_stacks > 0:
+                params['limit'] = remaining_limit
+                params['marker'] = stack.id
+                for stack in paginate(params):
                     yield stack
 
         params = {}
-        if 'page_size' in kwargs:
-            params['limit'] = kwargs['page_size']
-
-        if 'marker' in kwargs:
-            params['marker'] = kwargs['marker']
+        for key, value in kwargs.iteritems():
+            if value:
+                params[key] = value
 
         filters = kwargs.get('filters', {})
         properties = filters.pop('properties', {})