Fix bug: AttributeError arises while sorting with standard attributes

Common neutron resource(e.g, Port) consists of:
1. Resource Attributes, e.g: Port.mac_address, etc.
2. Standard Attributes, e.g: created_at, and are shared among all
   neutron resources.
The `sort` opt only supports limited attributes. We need to filter
attributes that are defined with `is_sort_key=True` and it's preferred
to explicitly warn CLI & API users of illegal sort keys rather than
just accept without check, pass forward and then hit a internal error
which's quite confusing.

Depends-on: https://review.opendev.org/#/c/660097/
Change-Id: I8d206f909b09f1279dfcdc25c39989a67bff93d5
Closes-Bug: #1659175
This commit is contained in:
pandatt 2019-04-19 11:29:54 +08:00
parent 36517c6016
commit 335ac4e2d9
3 changed files with 26 additions and 3 deletions

View File

@ -233,7 +233,9 @@ def get_sorts(request, attr_info):
msg = _("The number of sort_keys and sort_dirs must be same")
raise exc.HTTPBadRequest(explanation=msg)
valid_dirs = [constants.SORT_DIRECTION_ASC, constants.SORT_DIRECTION_DESC]
absent_keys = [x for x in sort_keys if x not in attr_info]
valid_sort_keys = set(attr for attr, schema in attr_info.items()
if schema.get('is_sort_key', False))
absent_keys = [x for x in sort_keys if x not in valid_sort_keys]
if absent_keys:
msg = _("%s is invalid attribute for sort_keys") % absent_keys
raise exc.HTTPBadRequest(explanation=msg)

View File

@ -1562,7 +1562,10 @@ class SortingTestCase(base.BaseTestCase):
def test_get_sorts(self):
path = '/?sort_key=foo&sort_dir=desc&sort_key=bar&sort_dir=asc'
request = webob.Request.blank(path)
attr_info = {'foo': {'key': 'val'}, 'bar': {'key': 'val'}}
attr_info = {
'foo': {'key': 'val', 'is_sort_key': True},
'bar': {'key': 'val', 'is_sort_key': True}
}
expect_val = [('foo', False), ('bar', True)]
actual_val = api_common.get_sorts(request, attr_info)
self.assertEqual(expect_val, actual_val)
@ -1570,11 +1573,23 @@ class SortingTestCase(base.BaseTestCase):
def test_get_sorts_with_project_id(self):
path = '/?sort_key=project_id&sort_dir=desc'
request = webob.Request.blank(path)
attr_info = {'tenant_id': {'key': 'val'}}
attr_info = {'tenant_id': {'key': 'val', 'is_sort_key': True}}
expect_val = [('project_id', False)]
actual_val = api_common.get_sorts(request, attr_info)
self.assertEqual(expect_val, actual_val)
def test_get_sorts_with_non_sort_key(self):
path = '/?sort_key=created_at&sort_dir=desc'
request = webob.Request.blank(path)
attr_info = {
'foo': {'key': 'val', 'is_sort_key': True},
'bar': {'key': 'val', 'is_sort_key': True},
'created_at': {'key': 'val'}
}
self.assertRaises(exc.HTTPBadRequest,
api_common.get_sorts,
request, attr_info)
class FiltersTestCase(base.BaseTestCase):
def test_all_skip_args(self):

View File

@ -0,0 +1,6 @@
---
fixes:
- |
Add sort-keys validation logic to method ``get_sorts`` in
``neutron.api.api_common``. See the link below for more:
https://bugs.launchpad.net/neutron/+bug/1659175