openstack/ironic
Code Issues Proposed changes

Merge "Disable meaningless sort keys in list command"

Browse Source
This commit is contained in:
Jenkins 2015-05-26 08:02:25 +00:00 committed by Gerrit Code Review
commit f0f9fa5a4d
6 changed files with 47 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
ironic/api/controllers/v1/chassis.py
View File

@ -28,6 +28,7 @@ from ironic.api.controllers.v1 import types
from ironic.api.controllers.v1 import utils as api_utils
from ironic.api import expose
from ironic.common import exception
from ironic.common.i18n import _
from ironic import objects
@ -147,6 +148,8 @@ class ChassisController(rest.RestController):
'detail': ['GET'],
}
invalid_sort_key_list = ['extra']
def _get_chassis_collection(self, marker, limit, sort_key, sort_dir,
expand=False, resource_url=None):
limit = api_utils.validate_limit(limit)
@ -155,6 +158,12 @@ class ChassisController(rest.RestController):
if marker:
marker_obj = objects.Chassis.get_by_uuid(pecan.request.context,
marker)
if sort_key in self.invalid_sort_key_list:
raise exception.InvalidParameterValue(_(
"The sort_key value %(key)s is an invalid field for sorting")
% {'key': sort_key})
chassis = objects.Chassis.list(pecan.request.context, limit,
marker_obj, sort_key=sort_key,
sort_dir=sort_dir)

9
ironic/api/controllers/v1/node.py
View File

@ -786,6 +786,9 @@ class NodesController(rest.RestController):
'validate': ['GET'],
}
invalid_sort_key_list = ['properties', 'driver_info', 'extra',
'instance_info', 'driver_internal_info']
def _get_nodes_collection(self, chassis_uuid, instance_uuid, associated,
maintenance, marker, limit, sort_key, sort_dir,
expand=False, resource_url=None):
@ -800,6 +803,12 @@ class NodesController(rest.RestController):
if marker:
marker_obj = objects.Node.get_by_uuid(pecan.request.context,
marker)
if sort_key in self.invalid_sort_key_list:
raise exception.InvalidParameterValue(_(
"The sort_key value %(key)s is an invalid field for sorting")
% {'key': sort_key})
if instance_uuid:
nodes = self._get_nodes_by_instance(instance_uuid)
else:

7
ironic/api/controllers/v1/port.py
View File

@ -176,6 +176,8 @@ class PortsController(rest.RestController):
'detail': ['GET'],
}
invalid_sort_key_list = ['extra']
def _get_ports_collection(self, node_ident, address, marker, limit,
sort_key, sort_dir, expand=False,
resource_url=None):
@ -191,6 +193,11 @@ class PortsController(rest.RestController):
marker_obj = objects.Port.get_by_uuid(pecan.request.context,
marker)
if sort_key in self.invalid_sort_key_list:
raise exception.InvalidParameterValue(_(
"The sort_key value %(key)s is an invalid field for sorting"
) % {'key': sort_key})
if node_ident:
# FIXME(comstud): Since all we need is the node ID, we can
# make this more efficient by only querying

13
ironic/tests/api/v1/test_chassis.py
View File

@ -128,12 +128,13 @@ class TestListChassis(api_base.FunctionalTest):
self.assertEqual(sorted(ch_list), uuids)
def test_sort_key_invalid(self):
invalid_key = 'foo'
response = self.get_json('/chassis?sort_key=%s' % invalid_key,
expect_errors=True)
self.assertEqual(400, response.status_int)
self.assertEqual('application/json', response.content_type)
self.assertIn(invalid_key, response.json['error_message'])
invalid_keys_list = ['foo', 'extra']
for invalid_key in invalid_keys_list:
response = self.get_json('/chassis?sort_key=%s' % invalid_key,
expect_errors=True)
self.assertEqual(400, response.status_int)
self.assertEqual('application/json', response.content_type)
self.assertIn(invalid_key, response.json['error_message'])
def test_nodes_subresource_link(self):
chassis = obj_utils.create_test_chassis(self.context)

14
ironic/tests/api/v1/test_nodes.py
View File

@ -285,12 +285,14 @@ class TestListNodes(test_api_base.FunctionalTest):
self.assertEqual(sorted(nodes), uuids)
def test_sort_key_invalid(self):
invalid_key = 'foo'
response = self.get_json('/nodes?sort_key=%s' % invalid_key,
expect_errors=True)
self.assertEqual(400, response.status_int)
self.assertEqual('application/json', response.content_type)
self.assertIn(invalid_key, response.json['error_message'])
invalid_keys_list = ['foo', 'properties', 'driver_info', 'extra',
'instance_info', 'driver_internal_info']
for invalid_key in invalid_keys_list:
response = self.get_json('/nodes?sort_key=%s' % invalid_key,
expect_errors=True)
self.assertEqual(400, response.status_int)
self.assertEqual('application/json', response.content_type)
self.assertIn(invalid_key, response.json['error_message'])
def test_ports_subresource_link(self):
node = obj_utils.create_test_node(self.context)

13
ironic/tests/api/v1/test_ports.py
View File

@ -196,12 +196,13 @@ class TestListPorts(api_base.FunctionalTest):
self.assertEqual(sorted(ports), uuids)
def test_sort_key_invalid(self):
invalid_key = 'foo'
response = self.get_json('/ports?sort_key=%s' % invalid_key,
expect_errors=True)
self.assertEqual(400, response.status_int)
self.assertEqual('application/json', response.content_type)
self.assertIn(invalid_key, response.json['error_message'])
invalid_keys_list = ['foo', 'extra']
for invalid_key in invalid_keys_list:
response = self.get_json('/ports?sort_key=%s' % invalid_key,
expect_errors=True)
self.assertEqual(400, response.status_int)
self.assertEqual('application/json', response.content_type)
self.assertIn(invalid_key, response.json['error_message'])
@mock.patch.object(api_utils, 'get_rpc_node')
def test_get_all_by_node_name_ok(self, mock_get_rpc_node):