openstack/ironic
Code Issues Proposed changes

Validating fault value when querying with fault field

Browse Source 
This patch adds checking to fault field when querying node with it.
Bad request will be raised for invalid fault value.

Change-Id: Ifc2de52cbe897a7aab4910e1c00df1ae933bb9d8
Story: #1596107
Task: #10469
This commit is contained in:
Kaifeng Wang 2018-06-12 20:47:30 +08:00
parent bfbe14b873
commit 9a1dc718b1
3 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ironic/api/controllers/v1/utils.py
View File

@ -29,6 +29,7 @@ import wsme
from ironic.api.controllers.v1 import versions
from ironic.common import exception
from ironic.common import faults
from ironic.common.i18n import _
from ironic.common import states
from ironic.common import utils
@ -491,6 +492,13 @@ def check_allow_filter_by_fault(fault):
"should be %(base)s.%(opr)s") % {'base': versions.BASE_VERSION,
'opr': versions.MINOR_42_FAULT})
if fault is not None and fault not in faults.VALID_FAULTS:
msg = (_('Unrecognized fault "%(fault)s" is specified, allowed faults '
'are %(valid_faults)s') %
{'fault': fault, 'valid_faults': faults.VALID_FAULTS})
raise wsme.exc.ClientSideError(
msg, status_code=http_client.BAD_REQUEST)
def initial_node_provision_state():
"""Return node state to use by default when creating new nodes.

2
ironic/common/faults.py
View File

@ -23,3 +23,5 @@ CLEAN_FAILURE = 'clean failure'
RESCUE_ABORT_FAILURE = 'rescue abort failure'
""" Node is moved to maintenance due to failure of cleaning up during
rescue abort. """
VALID_FAULTS = (POWER_FAILURE, CLEAN_FAILURE, RESCUE_ABORT_FAILURE)

13
ironic/tests/unit/api/controllers/v1/test_node.py
View File

@ -1313,8 +1313,19 @@ class TestListNodes(test_api_base.BaseApiTest):
self.assertIn(node2.uuid, uuids)
self.assertNotIn(node1.uuid, uuids)
def test_get_nodes_by_fault_with_invalid_fault(self):
for url in ('/nodes?fault=somefake',
'/nodes/detail?fault=somefake'):
response = self.get_json(
url, headers={api_base.Version.string: "1.42"},
expect_errors=True)
self.assertEqual('application/json', response.content_type)
self.assertEqual(http_client.BAD_REQUEST, response.status_code)
self.assertTrue(response.json['error_message'])
def test_get_nodes_by_fault_not_allowed(self):
for url in ('/nodes?fault=test', '/nodes/detail?fault=test'):
for url in ('/nodes?fault=power failure',
'/nodes/detail?fault=power failure'):
response = self.get_json(
url, headers={api_base.Version.string: "1.41"},
expect_errors=True)