openstack
/
openstacksdk
Code Issues Proposed changes

Add limit and marker to QueryParameters class 

After moving to resource2, we've sort of lost the ability to set limits
and markers on list calls while adding query mappings to Resource
subclasses via the QueryParameters class. Every accepted query parameter
must be listed there, so because we didn't have limit and marker in
there, we were only supporting unbounded list requests even though
Resource.list is capable of accepting limit and marker arguments.

This change adds limit and marker into the default mapping since they're
so widely used.

Change-Id: I31901b03974b198af3d7231003d985a1ae54062f
This commit is contained in:
Brian Curtin 2016-10-10 09:56:51 -04:00
parent 95ba61263e
commit b5f756b813
7 changed files with 23 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
openstack/resource2.py
View File

@ -190,8 +190,12 @@ class QueryParameters(object):
:param mappings: Key-value pairs where the key is the client-side
name we'll accept here and the value is the name
the server expects, e.g, changes_since=changes-since
By default, both limit and marker are included in the initial mapping
as they're the most common query parameters used for listing resources.
"""
self._mapping = dict({name: name for name in names}, **mappings)
self._mapping = {"limit": "limit", "marker": "marker"}
self._mapping.update(dict({name: name for name in names}, **mappings))
def _transpose(self, query):
"""Transpose the keys in query based on the mapping

4
openstack/tests/unit/compute/v2/test_flavor.py
View File

@ -47,7 +47,9 @@ class TestFlavor(testtools.TestCase):
self.assertDictEqual({"sort_key": "sort_key",
"sort_dir": "sort_dir",
"min_disk": "minDisk",
"min_ram": "minRam"},
"min_ram": "minRam",
"limit": "limit",
"marker": "marker"},
sot._query_mapping._mapping)
def test_make_basic(self):

4
openstack/tests/unit/compute/v2/test_image.py
View File

@ -56,7 +56,9 @@ class TestImage(testtools.TestCase):
"type": "type",
"min_disk": "minDisk",
"min_ram": "minRam",
"changes_since": "changes-since"},
"changes_since": "changes-since",
"limit": "limit",
"marker": "marker"},
sot._query_mapping._mapping)
def test_make_basic(self):

4
openstack/tests/unit/compute/v2/test_server.py
View File

@ -83,7 +83,9 @@ class TestServer(testtools.TestCase):
"status": "status",
"host": "host",
"all_tenants": "all_tenants",
"changes_since": "changes-since"},
"changes_since": "changes-since",
"limit": "limit",
"marker": "marker"},
sot._query_mapping._mapping)
def test_make_it(self):

3
openstack/tests/unit/compute/v2/test_server_group.py
View File

@ -37,7 +37,8 @@ class TestServerGroup(testtools.TestCase):
self.assertTrue(sot.allow_delete)
self.assertTrue(sot.allow_list)
self.assertDictEqual({"all_projects": "all_projects"},
self.assertDictEqual({"all_projects": "all_projects",
"limit": "limit", "marker": "marker"},
sot._query_mapping._mapping)
def test_make_it(self):

4
openstack/tests/unit/key_manager/v1/test_secret.py
View File

@ -58,7 +58,9 @@ class TestSecret(testtools.TestCase):
"updated": "updated",
"expiration": "expiration",
"sort": "sort",
"algorithm": "alg"},
"algorithm": "alg",
"limit": "limit",
"marker": "marker"},
sot._query_mapping._mapping)
def test_make_it(self):

5
openstack/tests/unit/test_resource2.py
View File

@ -350,7 +350,10 @@ class TestQueryParameters(base.TestCase):
sot = resource2.QueryParameters(location, **mapping)
self.assertEqual({"location": "location", "first_name": "first-name"},
self.assertEqual({"location": "location",
"first_name": "first-name",
"limit": "limit",
"marker": "marker"},
sot._mapping)
def test_transpose_unmapped(self):