1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
from __future__ import annotations
import pytest
from pydantic import BaseModel, ValidationError
from flask_openapi3 import APIView, OpenAPI
from flask_openapi3.blueprint import APIBlueprint
class BaseRequest(BaseModel):
"""Base description"""
test_int: int
test_str: str
class GoodResponse(BaseRequest): ...
class BadResponse(BaseModel):
test_int: str
test_str: str
def test_no_validate_response(request):
"""
Response validation defaults to no validation
Response doesn't match schema and doesn't raise any errors
"""
test_app = OpenAPI(request.node.name)
test_app.config["TESTING"] = True
@test_app.post("/test", responses={201: BadResponse})
def endpoint_test(body: BaseRequest):
return body.model_dump(), 201
with test_app.test_client() as client:
resp = client.post("/test", json={"test_int": 1, "test_str": "s"})
assert resp.status_code == 201
def test_app_level_validate_response(request):
"""
Validation turned on at app level
"""
test_app = OpenAPI(request.node.name, validate_response=True)
test_app.config["TESTING"] = True
@test_app.post("/test", responses={201: BadResponse})
def endpoint_test(body: BaseRequest):
return body.model_dump(), 201
with test_app.test_client() as client:
with pytest.raises(ValidationError):
_ = client.post("/test", json={"test_int": 1, "test_str": "s"})
def test_app_api_level_validate_response(request):
"""
Validation turned on at app level
"""
test_app = OpenAPI(request.node.name)
test_app.config["TESTING"] = True
@test_app.post("/test", responses={201: BadResponse}, validate_response=True)
def endpoint_test(body: BaseRequest):
return body.model_dump(), 201
with test_app.test_client() as client:
with pytest.raises(ValidationError):
_ = client.post("/test", json={"test_int": 1, "test_str": "s"})
def test_abp_level_no_validate_response(request):
"""
Validation turned on at app level
"""
test_app = OpenAPI(request.node.name)
test_app.config["TESTING"] = True
test_abp = APIBlueprint("abp", __name__)
@test_abp.post("/test", responses={201: BadResponse})
def endpoint_test(body: BaseRequest):
return body.model_dump(), 201
test_app.register_api(test_abp)
with test_app.test_client() as client:
resp = client.post("/test", json={"test_int": 1, "test_str": "s"})
assert resp.status_code == 201
def test_abp_level_validate_response(request):
"""
Validation turned on at app level
"""
test_app = OpenAPI(request.node.name)
test_app.config["TESTING"] = True
test_abp = APIBlueprint("abp", __name__, validate_response=True)
@test_abp.post("/test", responses={201: BadResponse})
def endpoint_test(body: BaseRequest):
return body.model_dump(), 201
test_app.register_api(test_abp)
with test_app.test_client() as client:
with pytest.raises(ValidationError):
_ = client.post("/test", json={"test_int": 1, "test_str": "s"})
def test_abp_api_level_validate_response(request):
"""
Validation turned on at app level
"""
test_app = OpenAPI(request.node.name)
test_app.config["TESTING"] = True
test_abp = APIBlueprint("abp", __name__)
@test_abp.post("/test", responses={201: BadResponse}, validate_response=True)
def endpoint_test(body: BaseRequest):
return body.model_dump(), 201
test_app.register_api(test_abp)
with test_app.test_client() as client:
with pytest.raises(ValidationError):
_ = client.post("/test", json={"test_int": 1, "test_str": "s"})
def test_apiview_no_validate_response(request):
"""
Response validation defaults to no validation
Response doesn't match schema and doesn't raise any errors
"""
test_app = OpenAPI(request.node.name)
test_app.config["TESTING"] = True
test_api_view = APIView("")
@test_api_view.route("/test")
class TestAPI:
@test_api_view.doc(responses={201: BadResponse})
def post(self, body: BaseRequest):
return body.model_dump(), 201
test_app.register_api_view(test_api_view)
with test_app.test_client() as client:
resp = client.post("/test", json={"test_int": 1, "test_str": "s"})
assert resp.status_code == 201
def test_apiview_app_level_validate_response(request):
"""
Validation turned on at app level
"""
test_app = OpenAPI(request.node.name, validate_response=True)
test_app.config["TESTING"] = True
test_api_view = APIView("")
@test_api_view.route("/test")
class TestAPI:
@test_api_view.doc(responses={201: BadResponse})
def post(self, body: BaseRequest):
return body.model_dump(), 201
test_app.register_api_view(test_api_view)
with test_app.test_client() as client:
with pytest.raises(ValidationError):
_ = client.post("/test", json={"test_int": 1, "test_str": "s"})
def test_apiview_api_level_validate_response(request):
"""
Validation turned on at app level
"""
test_app = OpenAPI(request.node.name)
test_app.config["TESTING"] = True
test_api_view = APIView("")
@test_api_view.route("/test")
class TestAPI:
@test_api_view.doc(responses={201: BadResponse}, validate_response=True)
def post(self, body: BaseRequest):
return body.model_dump(), 201
test_app.register_api_view(test_api_view)
with test_app.test_client() as client:
with pytest.raises(ValidationError):
_ = client.post("/test", json={"test_int": 1, "test_str": "s"})
|
