292 lines
11 KiB
Python
292 lines
11 KiB
Python
# coding: utf-8
|
|
#
|
|
# Copyright 2013 Red Hat, Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from http import client as http_client
|
|
from unittest import mock
|
|
|
|
from pecan import rest
|
|
|
|
from ironic.api.controllers.v1 import types
|
|
from ironic.api import expose
|
|
from ironic.api import types as atypes
|
|
from ironic.common import exception
|
|
from ironic.common import utils
|
|
from ironic.tests import base
|
|
from ironic.tests.unit.api import base as api_base
|
|
|
|
|
|
class TestMacAddressType(base.TestCase):
|
|
|
|
def test_valid_mac_addr(self):
|
|
test_mac = 'aa:bb:cc:11:22:33'
|
|
with mock.patch.object(utils, 'validate_and_normalize_mac') as m_mock:
|
|
types.MacAddressType.validate(test_mac)
|
|
m_mock.assert_called_once_with(test_mac)
|
|
|
|
def test_invalid_mac_addr(self):
|
|
self.assertRaises(exception.InvalidMAC,
|
|
types.MacAddressType.validate, 'invalid-mac')
|
|
|
|
|
|
class TestUuidType(base.TestCase):
|
|
|
|
def test_valid_uuid(self):
|
|
test_uuid = '1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e'
|
|
self.assertEqual(test_uuid, types.UuidType.validate(test_uuid))
|
|
|
|
def test_invalid_uuid(self):
|
|
self.assertRaises(exception.InvalidUUID,
|
|
types.UuidType.validate, 'invalid-uuid')
|
|
|
|
|
|
@mock.patch("ironic.api.request")
|
|
class TestNameType(base.TestCase):
|
|
|
|
def test_valid_name(self, mock_pecan_req):
|
|
mock_pecan_req.version.minor = 10
|
|
test_name = 'hal-9000'
|
|
self.assertEqual(test_name, types.NameType.validate(test_name))
|
|
|
|
def test_invalid_name(self, mock_pecan_req):
|
|
mock_pecan_req.version.minor = 10
|
|
self.assertRaises(exception.InvalidName,
|
|
types.NameType.validate, '-this is not valid-')
|
|
|
|
|
|
@mock.patch("ironic.api.request")
|
|
class TestUuidOrNameType(base.TestCase):
|
|
|
|
def test_valid_uuid(self, mock_pecan_req):
|
|
mock_pecan_req.version.minor = 10
|
|
test_uuid = '1a1a1a1a-2b2b-3c3c-4d4d-5e5e5e5e5e5e'
|
|
self.assertTrue(types.UuidOrNameType.validate(test_uuid))
|
|
|
|
def test_valid_name(self, mock_pecan_req):
|
|
mock_pecan_req.version.minor = 10
|
|
test_name = 'dc16-database5'
|
|
self.assertTrue(types.UuidOrNameType.validate(test_name))
|
|
|
|
def test_invalid_uuid_or_name(self, mock_pecan_req):
|
|
mock_pecan_req.version.minor = 10
|
|
self.assertRaises(exception.InvalidUuidOrName,
|
|
types.UuidOrNameType.validate, 'inval#uuid%or*name')
|
|
|
|
|
|
class MyBaseType(object):
|
|
"""Helper class, patched by objects of type MyPatchType"""
|
|
mandatory = atypes.wsattr(str, mandatory=True)
|
|
|
|
|
|
class MyPatchType(types.JsonPatchType):
|
|
"""Helper class for TestJsonPatchType tests."""
|
|
_api_base = MyBaseType
|
|
_extra_non_removable_attrs = {'/non_removable'}
|
|
|
|
@staticmethod
|
|
def internal_attrs():
|
|
return ['/internal']
|
|
|
|
|
|
class MyTest(rest.RestController):
|
|
"""Helper class for TestJsonPatchType tests."""
|
|
|
|
@expose.validate([MyPatchType])
|
|
@expose.expose([str], body=[MyPatchType])
|
|
def patch(self, patch):
|
|
return patch
|
|
|
|
|
|
class MyRoot(rest.RestController):
|
|
test = MyTest()
|
|
|
|
|
|
class TestJsonPatchType(api_base.BaseApiTest):
|
|
|
|
root_controller = ('ironic.tests.unit.api.controllers.v1.'
|
|
'test_types.MyRoot')
|
|
|
|
def setUp(self):
|
|
super(TestJsonPatchType, self).setUp()
|
|
|
|
def _patch_json(self, params, expect_errors=False):
|
|
return self.app.patch_json('/test', params=params,
|
|
headers={'Accept': 'application/json'},
|
|
expect_errors=expect_errors)
|
|
|
|
def test_valid_patches(self):
|
|
valid_patches = [{'path': '/extra/foo', 'op': 'remove'},
|
|
{'path': '/extra/foo', 'op': 'add', 'value': 'bar'},
|
|
{'path': '/str', 'op': 'replace', 'value': 'bar'},
|
|
{'path': '/bool', 'op': 'add', 'value': True},
|
|
{'path': '/int', 'op': 'add', 'value': 1},
|
|
{'path': '/float', 'op': 'add', 'value': 0.123},
|
|
{'path': '/list', 'op': 'add', 'value': [1, 2]},
|
|
{'path': '/none', 'op': 'add', 'value': None},
|
|
{'path': '/empty_dict', 'op': 'add', 'value': {}},
|
|
{'path': '/empty_list', 'op': 'add', 'value': []},
|
|
{'path': '/dict', 'op': 'add',
|
|
'value': {'cat': 'meow'}}]
|
|
ret = self._patch_json(valid_patches, False)
|
|
self.assertEqual(http_client.OK, ret.status_int)
|
|
self.assertCountEqual(valid_patches, ret.json)
|
|
|
|
def test_cannot_update_internal_attr(self):
|
|
patch = [{'path': '/internal', 'op': 'replace', 'value': 'foo'}]
|
|
ret = self._patch_json(patch, True)
|
|
self.assertEqual(http_client.BAD_REQUEST, ret.status_int)
|
|
self.assertTrue(ret.json['error_message'])
|
|
|
|
def test_cannot_update_internal_dict_attr(self):
|
|
patch = [{'path': '/internal/test', 'op': 'replace',
|
|
'value': 'foo'}]
|
|
ret = self._patch_json(patch, True)
|
|
self.assertEqual(http_client.BAD_REQUEST, ret.status_int)
|
|
self.assertTrue(ret.json['error_message'])
|
|
|
|
def test_mandatory_attr(self):
|
|
patch = [{'op': 'replace', 'path': '/mandatory', 'value': 'foo'}]
|
|
ret = self._patch_json(patch, False)
|
|
self.assertEqual(http_client.OK, ret.status_int)
|
|
self.assertEqual(patch, ret.json)
|
|
|
|
def test_cannot_remove_mandatory_attr(self):
|
|
patch = [{'op': 'remove', 'path': '/mandatory'}]
|
|
ret = self._patch_json(patch, True)
|
|
self.assertEqual(http_client.BAD_REQUEST, ret.status_int)
|
|
self.assertTrue(ret.json['error_message'])
|
|
|
|
def test_cannot_remove_extra_non_removable_attr(self):
|
|
patch = [{'op': 'remove', 'path': '/non_removable'}]
|
|
ret = self._patch_json(patch, True)
|
|
self.assertEqual(http_client.BAD_REQUEST, ret.status_int)
|
|
self.assertTrue(ret.json['error_message'])
|
|
|
|
def test_missing_required_fields_path(self):
|
|
missing_path = [{'op': 'remove'}]
|
|
ret = self._patch_json(missing_path, True)
|
|
self.assertEqual(http_client.BAD_REQUEST, ret.status_int)
|
|
self.assertTrue(ret.json['error_message'])
|
|
|
|
def test_missing_required_fields_op(self):
|
|
missing_op = [{'path': '/foo'}]
|
|
ret = self._patch_json(missing_op, True)
|
|
self.assertEqual(http_client.BAD_REQUEST, ret.status_int)
|
|
self.assertTrue(ret.json['error_message'])
|
|
|
|
def test_invalid_op(self):
|
|
patch = [{'path': '/foo', 'op': 'invalid'}]
|
|
ret = self._patch_json(patch, True)
|
|
self.assertEqual(http_client.BAD_REQUEST, ret.status_int)
|
|
self.assertTrue(ret.json['error_message'])
|
|
|
|
def test_invalid_path(self):
|
|
patch = [{'path': 'invalid-path', 'op': 'remove'}]
|
|
ret = self._patch_json(patch, True)
|
|
self.assertEqual(http_client.BAD_REQUEST, ret.status_int)
|
|
self.assertTrue(ret.json['error_message'])
|
|
|
|
def test_cannot_add_with_no_value(self):
|
|
patch = [{'path': '/extra/foo', 'op': 'add'}]
|
|
ret = self._patch_json(patch, True)
|
|
self.assertEqual(http_client.BAD_REQUEST, ret.status_int)
|
|
self.assertTrue(ret.json['error_message'])
|
|
|
|
def test_cannot_replace_with_no_value(self):
|
|
patch = [{'path': '/foo', 'op': 'replace'}]
|
|
ret = self._patch_json(patch, True)
|
|
self.assertEqual(http_client.BAD_REQUEST, ret.status_int)
|
|
self.assertTrue(ret.json['error_message'])
|
|
|
|
|
|
class TestBooleanType(base.TestCase):
|
|
|
|
def test_valid_true_values(self):
|
|
v = types.BooleanType()
|
|
self.assertTrue(v.validate("true"))
|
|
self.assertTrue(v.validate("TRUE"))
|
|
self.assertTrue(v.validate("True"))
|
|
self.assertTrue(v.validate("t"))
|
|
self.assertTrue(v.validate("1"))
|
|
self.assertTrue(v.validate("y"))
|
|
self.assertTrue(v.validate("yes"))
|
|
self.assertTrue(v.validate("on"))
|
|
|
|
def test_valid_false_values(self):
|
|
v = types.BooleanType()
|
|
self.assertFalse(v.validate("false"))
|
|
self.assertFalse(v.validate("FALSE"))
|
|
self.assertFalse(v.validate("False"))
|
|
self.assertFalse(v.validate("f"))
|
|
self.assertFalse(v.validate("0"))
|
|
self.assertFalse(v.validate("n"))
|
|
self.assertFalse(v.validate("no"))
|
|
self.assertFalse(v.validate("off"))
|
|
|
|
def test_invalid_value(self):
|
|
v = types.BooleanType()
|
|
self.assertRaises(exception.Invalid, v.validate, "invalid-value")
|
|
self.assertRaises(exception.Invalid, v.validate, "01")
|
|
|
|
|
|
class TestJsonType(base.TestCase):
|
|
|
|
def test_valid_values(self):
|
|
vt = types.jsontype
|
|
value = vt.validate("hello")
|
|
self.assertEqual("hello", value)
|
|
value = vt.validate(10)
|
|
self.assertEqual(10, value)
|
|
value = vt.validate(0.123)
|
|
self.assertEqual(0.123, value)
|
|
value = vt.validate(True)
|
|
self.assertTrue(value)
|
|
value = vt.validate([1, 2, 3])
|
|
self.assertEqual([1, 2, 3], value)
|
|
value = vt.validate({'foo': 'bar'})
|
|
self.assertEqual({'foo': 'bar'}, value)
|
|
value = vt.validate(None)
|
|
self.assertIsNone(value)
|
|
|
|
def test_invalid_values(self):
|
|
vt = types.jsontype
|
|
self.assertRaises(exception.Invalid, vt.validate, object())
|
|
|
|
def test_apimultitype_tostring(self):
|
|
vts = str(types.jsontype)
|
|
self.assertIn(str(str), vts)
|
|
self.assertIn(str(int), vts)
|
|
self.assertIn(str(float), vts)
|
|
self.assertIn(str(types.BooleanType), vts)
|
|
self.assertIn(str(list), vts)
|
|
self.assertIn(str(dict), vts)
|
|
self.assertIn(str(None), vts)
|
|
|
|
|
|
class TestListType(base.TestCase):
|
|
|
|
def test_list_type(self):
|
|
v = types.ListType()
|
|
self.assertEqual(['foo', 'bar'], v.validate('foo,bar'))
|
|
self.assertNotEqual(['bar', 'foo'], v.validate('foo,bar'))
|
|
|
|
self.assertEqual(['cat', 'meow'], v.validate("cat , meow"))
|
|
self.assertEqual(['spongebob', 'squarepants'],
|
|
v.validate("SpongeBob,SquarePants"))
|
|
self.assertEqual(['foo', 'bar'], v.validate("foo, ,,bar"))
|
|
self.assertEqual(['foo', 'bar'], v.validate("foo,foo,foo,bar"))
|
|
self.assertIsInstance(v.validate('foo,bar'), list)
|