openstack
/
masakari
Code Issues Proposed changes

Fix versioned schema validation 

Makes API microversion bounds respected on the schema validator.
Adds extra tests that check this.

This fixes the new 'enabled' flag for which we used the bounds.
No need to backport currently. No impact on stable.

Change-Id: I57f83cebdc02eee892d6269836566b6d07c609f9
This commit is contained in:
Radosław Piliszek 2021-03-10 14:42:53 +00:00
parent 4e031c6f26
commit 3f49bcd2b3
2 changed files with 90 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
masakari/api/validation/__init__.py
View File

@ -21,7 +21,7 @@ Request Body validating middleware.
import functools
from masakari.api import api_version_request as api_version
from masakari.api.validation import validators
from masakari.api.validation.validators import _SchemaValidator
def schema(request_body_schema, min_version=None, max_version=None):
@ -45,13 +45,13 @@ def schema(request_body_schema, min_version=None, max_version=None):
else:
ver = args[1].api_version_request
ver.matches(min_ver, max_ver)
# Only validate against the schema if it lies within
# the version range specified. Note that if both min
# and max are not specified the validator will always
# the version range specified. Note that, if both min
# and max are not specified, the validator will always
# be run.
schema_validator = validators._SchemaValidator(request_body_schema)
schema_validator.validate(kwargs['body'])
if ver.matches(min_ver, max_ver):
schema_validator = _SchemaValidator(request_body_schema)
schema_validator.validate(kwargs['body'])
return func(*args, **kwargs)
return wrapper

86
masakari/tests/unit/test_api_validation.py
View File

@ -28,8 +28,10 @@ from masakari import test
class FakeRequest(object):
api_version_request = api_version.APIVersionRequest("1.0")
environ = {}
def __init__(self, version=None):
if version is None:
version = '1.0'
self.api_version_request = api_version.APIVersionRequest(version)
class ValidationRegex(test.NoDBTestCase):
@ -552,3 +554,83 @@ class DatetimeTestCase(APIValidationTestCase):
self.post(body={
'foo': '2016-01-14T01:00:00Z'}, req=FakeRequest()
))
class VersionedApiValidationTestCase(APIValidationTestCase):
def setUp(self):
super(__class__, self).setUp()
schema_pre13 = {
'type': 'object',
'properties': {
'foo': {
'type': 'string',
},
},
'additionalProperties': False,
}
schema_post13 = {
'type': 'object',
'properties': {
'bar': {
'type': 'boolean',
},
},
'additionalProperties': False,
}
@validation.schema(request_body_schema=schema_pre13,
min_version='1.1',
max_version='1.2')
@validation.schema(request_body_schema=schema_post13,
min_version='1.3')
def post(req, body):
return 'Validation succeeded.'
self.post = post
def check_validation_error(self, body, req):
try:
self.post(body=body, req=req)
except exception.ValidationError as ex:
self.assertEqual(http.BAD_REQUEST, ex.kwargs['code'])
except Exception as ex:
self.fail('An unexpected exception happens: %s' % ex)
else:
self.fail('Any exception does not happen.')
def test_validate_with_proper_microversions(self):
self.assertEqual('Validation succeeded.',
self.post(body={
'foo': 'ahappystring'}, req=FakeRequest('1.1')
))
self.assertEqual('Validation succeeded.',
self.post(body={
'foo': 'ahappystring'}, req=FakeRequest('1.2')
))
self.assertEqual('Validation succeeded.',
self.post(body={
'bar': True}, req=FakeRequest('1.3')
))
self.assertEqual('Validation succeeded.',
self.post(body={
'bar': True}, req=FakeRequest('1.10')
))
self.assertEqual('Validation succeeded.',
self.post(body={
'whatever': None}, req=FakeRequest('1.0')
))
def test_validate_with_improper_microversions(self):
self.check_validation_error(body={'bar': False},
req=FakeRequest('1.1'))
self.check_validation_error(body={'bar': False},
req=FakeRequest('1.2'))
self.check_validation_error(body={'foo': 'asadstring'},
req=FakeRequest('1.3'))
self.check_validation_error(body={'foo': 'asadstring'},
req=FakeRequest('1.10'))
self.check_validation_error(body={'foo': 'asadstring'},
req=FakeRequest('2.0'))