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
195
196
197
198
199
200
201
202
203
204
205
|
import json
from enum import Enum
from ipaddress import IPv4Address, IPv6Address
from typing import List, Union
import pytest
from django.http import HttpResponse
from pydantic import BaseModel, HttpUrl, ValidationError
from pydantic_core import Url
from ninja import Router
from ninja.responses import Response
from ninja.testing import TestClient
router = Router()
@router.get("/check_int", response=int)
def check_int(request):
return "1"
@router.get("/check_int2", response=int)
def check_int2(request):
return "str"
class User:
def __init__(self, id, user_name, password):
self.id = id
self.user_name = user_name
self.password = password
class MyEnum(Enum):
first = "first"
second = "second"
def to_camel(string: str) -> str:
words = string.split("_")
return words[0].lower() + "".join(word.capitalize() for word in words[1:])
class UserModel(BaseModel):
id: int
user_name: str
# skipping password output to responses
model_config = dict(
from_attributes=True,
alias_generator=to_camel,
populate_by_name=True,
)
@router.get("/check_model", response=UserModel)
def check_model(request):
return User(1, "John", "Password")
@router.get("/check_list_model", response=List[UserModel])
def check_list_model(request):
return [User(1, "John", "Password")]
@router.get("/check_model_alias", response=UserModel, by_alias=True)
def check_model_alias(request):
return User(1, "John", "Password")
@router.get("/check_union", response=Union[int, UserModel])
def check_union(request, q: int):
if q == 0:
return 1
if q == 1:
return User(1, "John", "Password")
return "invalid"
@router.get("/check_set_header")
def check_set_header(request, response: HttpResponse):
response["Cache-Control"] = "no-cache"
return 1
@router.get("/check_set_cookie")
def check_set_cookie(request, set: bool, response: HttpResponse):
if set:
response.set_cookie("test", "me")
return 1
@router.get("/check_del_cookie")
def check_del_cookie(request, response: HttpResponse):
response.delete_cookie("test")
return 1
client = TestClient(router)
@pytest.mark.parametrize(
"path,expected_response",
[
("/check_int", 1),
("/check_model", {"id": 1, "user_name": "John"}), # the password is skipped
(
"/check_list_model",
[{"id": 1, "user_name": "John"}],
), # the password is skipped
("/check_model", {"id": 1, "user_name": "John"}), # the password is skipped
("/check_model_alias", {"id": 1, "userName": "John"}), # result is camelCase
("/check_union?q=0", 1),
("/check_union?q=1", {"id": 1, "user_name": "John"}),
],
)
def test_responses(path, expected_response):
response = client.get(path)
assert response.status_code == 200, response.content
assert response.json() == expected_response
assert response.data == response.data == expected_response # Ensures cache works
def test_validates():
with pytest.raises(ValidationError):
client.get("/check_int2")
with pytest.raises(ValidationError):
client.get("/check_union?q=2")
def test_set_header():
response = client.get("/check_set_header")
assert response.status_code == 200
assert response.content == b"1"
assert response["Cache-Control"] == "no-cache"
def test_set_cookie():
response = client.get("/check_set_cookie?set=0")
assert "test" not in response.cookies
response = client.get("/check_set_cookie?set=1")
cookie = response.cookies.get("test")
assert cookie
assert cookie.value == "me"
def test_del_cookie():
response = client.get("/check_del_cookie")
cookie = response.cookies.get("test")
assert cookie
assert cookie["expires"] == "Thu, 01 Jan 1970 00:00:00 GMT"
assert cookie["max-age"] == 0
def test_ipv4address_encoding():
data = {"ipv4": IPv4Address("127.0.0.1")}
response = Response(data)
response_data = json.loads(response.content)
assert response_data["ipv4"] == str(data["ipv4"])
def test_ipv6address_encoding():
data = {"ipv6": IPv6Address("::1")}
response = Response(data)
response_data = json.loads(response.content)
assert response_data["ipv6"] == str(data["ipv6"])
def test_enum_encoding():
data = {"enum": MyEnum.first}
response = Response(data)
response_data = json.loads(response.content)
assert response_data["enum"] == str(data["enum"])
def test_pydantic_url():
data = {"url": Url("https://django-ninja.dev/")}
response = Response(data)
response_data = json.loads(response.content)
assert response_data == {"url": "https://django-ninja.dev/"}
def test_pydantic_httpurl():
data = {"url": HttpUrl("https://django-ninja.dev/")}
response = Response(data)
response_data = json.loads(response.content)
assert response_data == {"url": "https://django-ninja.dev/"}
class HttpUrlSchema(BaseModel):
url: HttpUrl
@router.get("/check_httpurl", response=HttpUrlSchema)
def check_httpurl(request):
return HttpUrlSchema(url="https://django-ninja.dev/")
def test_pydantic_httpurl_schema():
response = client.get("/check_httpurl")
assert response.status_code == 200
assert response.json() == {"url": "https://django-ninja.dev/"}
|
