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
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from datetime import datetime
from typing import Any
from pytest import raises
from elasticsearch.dsl import (
Date,
Document,
InnerDoc,
Integer,
Nested,
Object,
Text,
mapped_field,
)
from elasticsearch.dsl.exceptions import ValidationException
class Author(InnerDoc):
name: str
email: str
def clean(self) -> None:
if not self.name:
raise ValidationException("name is missing")
if not self.email:
raise ValidationException("email is missing")
elif self.name.lower() not in self.email:
raise ValidationException("Invalid email!")
class BlogPost(Document):
authors = Nested(Author, required=True)
created = Date()
inner = Object()
class BlogPostWithStatus(Document):
published: bool = mapped_field(init=False)
class AutoNowDate(Date):
def clean(self, data: Any) -> Any:
if data is None:
data = datetime.now()
return super().clean(data)
class Log(Document):
timestamp = AutoNowDate(required=True)
data = Text()
def test_required_int_can_be_0() -> None:
class DT(Document):
i = Integer(required=True)
dt = DT(i=0)
dt.full_clean()
def test_required_field_cannot_be_empty_list() -> None:
class DT(Document):
i = Integer(required=True)
dt = DT(i=[])
with raises(ValidationException):
dt.full_clean()
def test_validation_works_for_lists_of_values() -> None:
class DT(Document):
i = Date(required=True)
dt = DT(i=[datetime.now(), "not date"])
with raises(ValidationException):
dt.full_clean()
dt = DT(i=[datetime.now(), datetime.now()])
dt.full_clean()
def test_field_with_custom_clean() -> None:
l = Log()
l.full_clean()
assert isinstance(l.timestamp, datetime)
def test_empty_object() -> None:
d = BlogPost(authors=[{"name": "Honza", "email": "honza@elastic.co"}])
d.inner = {} # type: ignore[assignment]
d.full_clean()
def test_missing_required_field_raises_validation_exception() -> None:
d = BlogPost()
with raises(ValidationException):
d.full_clean()
d = BlogPost()
d.authors.append({"name": "Honza"})
with raises(ValidationException):
d.full_clean()
d = BlogPost()
d.authors.append({"name": "Honza", "email": "honza@elastic.co"})
d.full_clean()
def test_boolean_doesnt_treat_false_as_empty() -> None:
d = BlogPostWithStatus()
with raises(ValidationException):
d.full_clean()
d.published = False
d.full_clean()
d.published = True
d.full_clean()
def test_custom_validation_on_nested_gets_run() -> None:
d = BlogPost(authors=[Author(name="Honza", email="king@example.com")], created=None)
assert isinstance(d.authors[0], Author) # type: ignore[index]
with raises(ValidationException):
d.full_clean()
def test_accessing_known_fields_returns_empty_value() -> None:
d = BlogPost()
assert [] == d.authors
d.authors.append({})
assert None is d.authors[0].name # type: ignore[index]
assert None is d.authors[0].email
def test_empty_values_are_not_serialized() -> None:
d = BlogPost(authors=[{"name": "Honza", "email": "honza@elastic.co"}], created=None)
d.full_clean()
assert d.to_dict() == {"authors": [{"name": "Honza", "email": "honza@elastic.co"}]}
|
