openstack/nova
Code Issues Proposed changes

tests: Ensure all APIs have a request query schema

Browse Source 
Change-Id: Ib920c9846f69b3af2a525abe60b02135e998e03a
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2024-02-18 18:03:37 +00:00
parent 41b436bff7
commit 0021b840a2
2 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
nova/api/validation/__init__.py
View File

@ -193,6 +193,9 @@ def query_schema(query_params_schema, min_version=None,
# those additional parameters.
_strip_additional_query_parameters(query_params_schema, req)
return func(*args, **kwargs)
wrapper._query_schema = query_params_schema
return wrapper
return add_validator

24
nova/tests/unit/api/openstack/compute/test_schemas.py
View File

@ -25,19 +25,29 @@ class SchemaTest(test.NoDBTestCase):
self.meta_schema = validators._SchemaValidator.validator_org
def test_schemas(self):
missing_schemas = set()
missing_request_schemas = set()
missing_query_schemas = set()
invalid_schemas = set()
def _validate_func(func, method):
if method in ("POST", "PUT", "PATCH"):
# request body validation
if not hasattr(func, '_request_schema'):
missing_schemas.add(func.__qualname__)
missing_request_schemas.add(func.__qualname__)
else:
try:
self.meta_schema.check_schema(func._request_schema)
except jsonschema.exceptions.SchemaError:
invalid_schemas.add(func.__qualname__)
elif method in ("GET",):
# request query string validation
if not hasattr(func, '_query_schema'):
missing_query_schemas.add(func.__qualname__)
else:
try:
self.meta_schema.check_schema(func._query_schema)
except jsonschema.exceptions.SchemaError:
invalid_schemas.add(func.__qualname__)
for route in self.router.map.matchlist:
if 'controller' not in route.defaults:
@ -109,10 +119,16 @@ class SchemaTest(test.NoDBTestCase):
func = getattr(controller.controller, action)
_validate_func(func, method)
if missing_schemas:
if missing_request_schemas:
raise test.TestingException(
f"Found API resources without schemas: "
f"{sorted(missing_schemas)}"
f"{sorted(missing_request_schemas)}"
)
if missing_query_schemas:
raise test.TestingException(
f"Found API resources without query schemas: "
f"{sorted(missing_query_schemas)}"
)
if invalid_schemas: