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
|
from typing import List, Union
import pytest
from pydantic import ValidationError
from ninja import NinjaAPI, Schema
from ninja.errors import ConfigError
from ninja.responses import codes_2xx, codes_3xx
from ninja.testing import TestClient
pytestmark = pytest.mark.filterwarnings("ignore::DeprecationWarning")
api = NinjaAPI()
@api.get("/check_int", response={200: int})
def check_int(request):
return 200, "1"
@api.get("/check_int2", response={200: int})
def check_int2(request):
return 200, "str"
@api.get("/check_single_with_status", response=int)
def check_single_with_status(request, code: int):
return code, 1
@api.get("/check_response_schema", response={400: int})
def check_response_schema(request):
return 200, 1
@api.get("/check_no_content", response={204: None})
def check_no_content(request, return_code: bool):
if return_code:
return 204, None
return # None
@api.get(
"/check_multiple_codes",
response={codes_2xx: int, codes_3xx: str, ...: float},
)
def check_multiple_codes(request, code: int):
return code, "1"
class User:
def __init__(self, id, name, password):
self.id = id
self.name = name
self.password = password
class UserModel(Schema):
id: int
name: str
# skipping password output to responses
class ErrorModel(Schema):
detail: str
@api.get("/check_model", response={200: UserModel, 202: UserModel})
def check_model(request):
return 202, User(1, "John", "Password")
@api.get("/check_list_model", response={200: List[UserModel]})
def check_list_model(request):
return 200, [User(1, "John", "Password")]
@api.get("/check_union", response={200: Union[int, UserModel], 400: ErrorModel})
def check_union(request, q: int):
if q == 0:
return 200, 1
if q == 1:
return 200, User(1, "John", "Password")
if q == 2:
return 400, {"detail": "error"}
return "invalid"
client = TestClient(api)
@pytest.mark.parametrize(
"path,expected_status,expected_response",
[
("/check_int", 200, 1),
("/check_single_with_status?code=200", 200, 1),
("/check_model", 202, {"id": 1, "name": "John"}), # ! the password is skipped
("/check_list_model", 200, [{"id": 1, "name": "John"}]),
("/check_union?q=0", 200, 1),
("/check_union?q=1", 200, {"id": 1, "name": "John"}),
("/check_union?q=2", 400, {"detail": "error"}),
("/check_multiple_codes?code=200", 200, 1),
("/check_multiple_codes?code=201", 201, 1),
("/check_multiple_codes?code=202", 202, 1),
("/check_multiple_codes?code=206", 206, 1),
("/check_multiple_codes?code=300", 300, "1"),
("/check_multiple_codes?code=308", 308, "1"),
("/check_multiple_codes?code=400", 400, 1.0),
("/check_multiple_codes?code=500", 500, 1.0),
],
)
def test_responses(path, expected_status, expected_response):
response = client.get(path)
assert response.status_code == expected_status, response.content
assert response.json() == expected_response
def test_schema():
checks = [
("/api/check_int", {200}),
("/api/check_int2", {200}),
("/api/check_single_with_status", {200}),
("/api/check_response_schema", {400}),
("/api/check_model", {200, 202}),
("/api/check_list_model", {200}),
("/api/check_union", {200, 400}),
]
schema = api.get_openapi_schema()
# checking codes
for path, codes in checks:
responses = schema["paths"][path]["get"]["responses"]
responses_codes = set(responses.keys())
assert codes == responses_codes, f"{codes} != {responses_codes}"
# checking model
check_model_responses = schema["paths"]["/api/check_model"]["get"]["responses"]
assert check_model_responses == {
200: {
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/UserModel"}
}
},
"description": "OK",
},
202: {
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/UserModel"}
}
},
"description": "Accepted",
},
}
def test_no_content():
response = client.get("/check_no_content?return_code=1")
assert response.status_code == 204
assert response.content == b""
response = client.get("/check_no_content?return_code=0")
assert response.status_code == 204
assert response.content == b""
schema = api.get_openapi_schema()
details = schema["paths"]["/api/check_no_content"]["get"]["responses"]
assert details == {204: {"description": "No Content"}}
def test_validates():
with pytest.raises(ValidationError):
client.get("/check_int2")
with pytest.raises(ValidationError):
client.get("/check_union?q=3")
with pytest.raises(ConfigError):
client.get("/check_response_schema")
with pytest.raises(ConfigError):
client.get("/check_single_with_status?code=300")
|
