from unittest import mock
from werkzeug.exceptions import HTTPException, BadRequest
import pytest
from marshmallow import Schema
from flask import Flask
from webargs import fields, ValidationError, missing
from webargs.flaskparser import parser, abort
from webargs.core import json
from .apps.flask_app import app
from webargs.testing import CommonTestCase
class TestFlaskParser(CommonTestCase):
def create_app(self):
return app
def test_parsing_view_args(self, testapp):
res = testapp.get("/echo_view_arg/42")
assert res.json == {"view_arg": 42}
def test_parsing_invalid_view_arg(self, testapp):
res = testapp.get("/echo_view_arg/foo", expect_errors=True)
assert res.status_code == 422
assert res.json == {"view_args": {"view_arg": ["Not a valid integer."]}}
def test_use_args_with_view_args_parsing(self, testapp):
res = testapp.get("/echo_view_arg_use_args/42")
assert res.json == {"view_arg": 42}
def test_use_args_on_a_method_view(self, testapp):
res = testapp.post_json("/echo_method_view_use_args", {"val": 42})
assert res.json == {"val": 42}
def test_use_kwargs_on_a_method_view(self, testapp):
res = testapp.post_json("/echo_method_view_use_kwargs", {"val": 42})
assert res.json == {"val": 42}
def test_use_kwargs_with_missing_data(self, testapp):
res = testapp.post_json("/echo_use_kwargs_missing", {"username": "foo"})
assert res.json == {"username": "foo"}
# regression test for https://github.com/marshmallow-code/webargs/issues/145
def test_nested_many_with_data_key(self, testapp):
post_with_raw_fieldname_args = (
"/echo_nested_many_data_key",
{"x_field": [{"id": 42}]},
)
res = testapp.post_json(*post_with_raw_fieldname_args, expect_errors=True)
assert res.status_code == 422
res = testapp.post_json("/echo_nested_many_data_key", {"X-Field": [{"id": 24}]})
assert res.json == {"x_field": [{"id": 24}]}
res = testapp.post_json("/echo_nested_many_data_key", {})
assert res.json == {}
# regression test for
# https://github.com/marshmallow-code/webargs/issues/500
def test_parsing_unexpected_headers_when_raising(self, testapp):
res = testapp.get(
"/echo_headers_raising", expect_errors=True, headers={"X-Unexpected": "foo"}
)
assert res.status_code == 422
assert "headers" in res.json
assert "X-Unexpected" in set(res.json["headers"].keys())
@mock.patch("webargs.flaskparser.abort")
def test_abort_called_on_validation_error(mock_abort):
# error handling must raise an error to be valid
mock_abort.side_effect = BadRequest("foo")
app = Flask("testapp")
def validate(x):
return x == 42
argmap = {"value": fields.Field(validate=validate)}
with app.test_request_context(
"/foo",
method="post",
data=json.dumps({"value": 41}),
content_type="application/json",
):
with pytest.raises(HTTPException):
parser.parse(argmap)
mock_abort.assert_called()
abort_args, abort_kwargs = mock_abort.call_args
assert abort_args[0] == 422
expected_msg = "Invalid value."
assert abort_kwargs["messages"]["json"]["value"] == [expected_msg]
assert type(abort_kwargs["exc"]) == ValidationError
@pytest.mark.parametrize("mimetype", [None, "application/json"])
def test_load_json_returns_missing_if_no_data(mimetype):
req = mock.Mock()
req.mimetype = mimetype
req.get_data.return_value = ""
schema = Schema.from_dict({"foo": fields.Field()})()
assert parser.load_json(req, schema) is missing
def test_abort_with_message():
with pytest.raises(HTTPException) as excinfo:
abort(400, message="custom error message")
assert excinfo.value.data["message"] == "custom error message"
def test_abort_has_serializable_data():
with pytest.raises(HTTPException) as excinfo:
abort(400, message="custom error message")
serialized_error = json.dumps(excinfo.value.data)
error = json.loads(serialized_error)
assert isinstance(error, dict)
assert error["message"] == "custom error message"
with pytest.raises(HTTPException) as excinfo:
abort(
400,
message="custom error message",
exc=ValidationError("custom error message"),
)
serialized_error = json.dumps(excinfo.value.data)
error = json.loads(serialized_error)
assert isinstance(error, dict)
assert error["message"] == "custom error message"