Files
connexion/tests/test_json_validation.py
Robbe Sneyders 1ab5400c0b Move JSON response body validation to middleware (#1591)
* Extract boilerplate code into Routed base classes

* Use typing_extensions for Python 3.7 Protocol support

* Use Mock instead of AsyncMock

* Extract response validation to middleware

* Refactor Request validation to match Response validation

* Factor out shared functionality

* Fix typo in TextResponseBodyValidator class name

* Fix string formatting

* Use correct schema to check nullability in response validation
2022-10-03 23:01:21 +02:00

131 lines
4.3 KiB
Python

import json
import pathlib
import pytest
from connexion import App
from connexion.json_schema import Draft4RequestValidator
from connexion.spec import Specification
from connexion.validators import JSONRequestBodyValidator
from jsonschema.validators import _utils, extend
from conftest import build_app_from_fixture
SPECS = ["swagger.yaml", "openapi.yaml"]
@pytest.mark.parametrize("spec", SPECS)
def test_validator_map(json_validation_spec_dir, spec):
def validate_type(validator, types, instance, schema):
types = _utils.ensure_list(types)
errors = Draft4RequestValidator.VALIDATORS["type"](
validator, types, instance, schema
)
yield from errors
if "string" in types and "minLength" not in schema:
errors = Draft4RequestValidator.VALIDATORS["minLength"](
validator, 1, instance, schema
)
yield from errors
MinLengthRequestValidator = extend(Draft4RequestValidator, {"type": validate_type})
class MyJSONBodyValidator(JSONRequestBodyValidator):
def __init__(self, *args, **kwargs):
super().__init__(*args, validator=MinLengthRequestValidator, **kwargs)
validator_map = {"body": {"application/json": MyJSONBodyValidator}}
app = App(__name__, specification_dir=json_validation_spec_dir)
app.add_api(spec, validate_responses=True, validator_map=validator_map)
app_client = app.app.test_client()
res = app_client.post(
"/v1.0/minlength",
data=json.dumps({"foo": "bar"}),
content_type="application/json",
) # type: flask.Response
assert res.status_code == 200
res = app_client.post(
"/v1.0/minlength", data=json.dumps({"foo": ""}), content_type="application/json"
) # type: flask.Response
assert res.status_code == 400
@pytest.mark.parametrize("spec", SPECS)
def test_readonly(json_validation_spec_dir, spec):
app = build_app_from_fixture(
json_validation_spec_dir, spec, validate_responses=True
)
app_client = app.app.test_client()
res = app_client.get("/v1.0/user") # type: flask.Response
assert res.status_code == 200
assert json.loads(res.data.decode()).get("user_id") == 7
res = app_client.post(
"/v1.0/user",
data=json.dumps({"name": "max", "password": "1234"}),
content_type="application/json",
) # type: flask.Response
assert res.status_code == 200
assert json.loads(res.data.decode()).get("user_id") == 8
res = app_client.post(
"/v1.0/user",
data=json.dumps({"user_id": 9, "name": "max"}),
content_type="application/json",
) # type: flask.Response
assert res.status_code == 400
@pytest.mark.parametrize("spec", SPECS)
def test_writeonly(json_validation_spec_dir, spec):
app = build_app_from_fixture(
json_validation_spec_dir, spec, validate_responses=True
)
app_client = app.app.test_client()
res = app_client.post(
"/v1.0/user",
data=json.dumps({"name": "max", "password": "1234"}),
content_type="application/json",
) # type: flask.Response
assert res.status_code == 200
assert "password" not in json.loads(res.data.decode())
res = app_client.get("/v1.0/user") # type: flask.Response
assert res.status_code == 200
assert "password" not in json.loads(res.data.decode())
res = app_client.get("/v1.0/user_with_password") # type: flask.Response
assert res.status_code == 500
assert (
json.loads(res.data.decode())["title"]
== "Response body does not conform to specification"
)
@pytest.mark.parametrize("spec", SPECS)
def test_nullable_default(json_validation_spec_dir, spec):
spec_path = pathlib.Path(json_validation_spec_dir) / spec
Specification.load(spec_path)
@pytest.mark.parametrize("spec", ["openapi.yaml"])
def test_multipart_form_json(json_validation_spec_dir, spec):
app = build_app_from_fixture(
json_validation_spec_dir, spec, validate_responses=True
)
app_client = app.app.test_client()
res = app_client.post(
"/v1.0/multipart_form_json",
data={"x": json.dumps({"name": "joe", "age": 20})},
content_type="multipart/form-data",
)
assert res.status_code == 200
assert json.loads(res.data.decode())["name"] == "joe-reply"
assert json.loads(res.data.decode())["age"] == 30