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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
|
from typing import List, Optional, Union
from unittest.mock import Mock
import pytest
from django.db.models import Manager, QuerySet
from django.db.models.fields.files import ImageFieldFile
from pydantic_core import ValidationError
from ninja import Schema
from ninja.schema import DjangoGetter, Field
class FakeManager(Manager):
def __init__(self, items):
self._items = items
def all(self):
return self._items
def __str__(self):
return "FakeManager"
class FakeQS(QuerySet):
def __init__(self, items):
self._result_cache = items
self._prefetch_related_lookups = False
def __str__(self):
return "FakeQS"
class Tag:
def __init__(self, id, title):
self.id = id
self.title = title
# mocking some users:
class Boss:
name = "Jane Jackson"
title = "CEO"
class User:
name = "John Smith"
group_set = FakeManager([1, 2, 3])
avatar = ImageFieldFile(None, Mock(), name=None)
boss: Optional[Boss] = Boss()
@property
def tags(self):
return FakeQS([Tag(1, "foo"), Tag(2, "bar")])
def get_boss_title(self):
return self.boss and self.boss.title
class TagSchema(Schema):
id: int
title: str
class UserSchema(Schema):
name: str
groups: List[int] = Field(..., alias="group_set")
tags: List[TagSchema]
avatar: Optional[str] = None
class UserWithBossSchema(UserSchema):
boss: Optional[str] = Field(None, alias="boss.name")
has_boss: bool
boss_title: Optional[str] = Field(None, alias="get_boss_title")
@staticmethod
def resolve_has_boss(obj):
return bool(obj.boss)
class UserWithInitialsSchema(UserWithBossSchema):
initials: str
def resolve_initials(self, obj):
return "".join(n[:1] for n in self.name.split())
class ResolveAttrSchema(Schema):
"The goal is to test that the resolve_xxx is not callable it should be a regular attribute"
id: str
resolve_attr: str
def test_schema():
user = User()
schema = UserSchema.from_orm(user)
assert schema.dict() == {
"name": "John Smith",
"groups": [1, 2, 3],
"tags": [{"id": 1, "title": "foo"}, {"id": 2, "title": "bar"}],
"avatar": None,
}
def test_schema_with_image():
user = User()
field = Mock()
field.storage.url = Mock(return_value="/smile.jpg")
user.avatar = ImageFieldFile(None, field, name="smile.jpg")
schema = UserSchema.from_orm(user)
assert schema.dict() == {
"name": "John Smith",
"groups": [1, 2, 3],
"tags": [{"id": 1, "title": "foo"}, {"id": 2, "title": "bar"}],
"avatar": "/smile.jpg",
}
def test_with_boss_schema():
user = User()
schema = UserWithBossSchema.from_orm(user)
assert schema.dict() == {
"name": "John Smith",
"boss": "Jane Jackson",
"has_boss": True,
"groups": [1, 2, 3],
"tags": [{"id": 1, "title": "foo"}, {"id": 2, "title": "bar"}],
"avatar": None,
"boss_title": "CEO",
}
user_without_boss = User()
user_without_boss.boss = None
schema = UserWithBossSchema.from_orm(user_without_boss)
assert schema.dict() == {
"name": "John Smith",
"boss": None,
"has_boss": False,
"boss_title": None,
"groups": [1, 2, 3],
"tags": [{"id": 1, "title": "foo"}, {"id": 2, "title": "bar"}],
"avatar": None,
}
SKIP_NON_STATIC_RESOLVES = True
@pytest.mark.skipif(SKIP_NON_STATIC_RESOLVES, reason="Lets deal with this later")
def test_with_initials_schema():
user = User()
schema = UserWithInitialsSchema.from_orm(user)
assert schema.dict() == {
"name": "John Smith",
"initials": "JS",
"boss": "Jane Jackson",
"has_boss": True,
"groups": [1, 2, 3],
"tags": [{"id": 1, "title": "foo"}, {"id": 2, "title": "bar"}],
"avatar": None,
"boss_title": "CEO",
}
def test_complex_alias_resolve():
class Top:
class Midddle:
def call(self):
return {"dict": [1, 10]}
m = Midddle()
class AliasSchema(Schema):
value: int = Field(..., alias="m.call.dict.1")
x = Top()
assert AliasSchema.from_orm(x).dict() == {"value": 10}
def test_with_attr_that_has_resolve():
class Obj:
id = "1"
resolve_attr = "2"
assert ResolveAttrSchema.from_orm(Obj()).dict() == {"id": "1", "resolve_attr": "2"}
def test_django_getter():
"Coverage for DjangoGetter __repr__ method"
class Somechema(Schema):
i: int
dg = DjangoGetter({"i": 1}, Somechema)
assert repr(dg) == "<DjangoGetter: {'i': 1}>"
def test_schema_validates_assignment_and_reassigns_the_value():
class ValidateAssignmentSchema(Schema):
str_var: str
model_config = {"validate_assignment": True}
schema_inst = ValidateAssignmentSchema(str_var="test_value")
schema_inst.str_var = "reassigned_value"
assert schema_inst.str_var == "reassigned_value"
try:
schema_inst.str_var = 5
raise AssertionError()
except ValidationError:
# We expect this error, all is okay
pass
@pytest.mark.parametrize("test_validate_assignment", [False, None])
def test_schema_skips_validation_when_validate_assignment_False(
test_validate_assignment: Union[bool, None],
):
class ValidateAssignmentSchema(Schema):
str_var: str
model_config = {"validate_assignment": test_validate_assignment}
schema_inst = ValidateAssignmentSchema(str_var="test_value")
try:
schema_inst.str_var = 5
assert schema_inst.str_var == 5
except ValidationError as ve:
raise AssertionError() from ve
|