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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
"""
Regression tests for old `rest_framework_filters.FilterSet` functionality.
Code in this repository is occasionally made obsolete with improvements to the
underlying django-filter library. This module contains old tests that verify
that the FilterSet continue to behave as expected.
"""
import datetime
from django.test import TestCase, override_settings
from django.utils.dateparse import parse_datetime, parse_time
from rest_framework import serializers
from rest_framework.renderers import JSONRenderer
from rest_framework_filters import AutoFilter, FilterSet
from .testapp.filters import CoverFilter, PostFilter, UserFilter
from .testapp.models import Cover, Note, Person, Post, User
today = datetime.date.today()
def add_timedelta(time, timedelta):
dt = datetime.datetime.combine(datetime.datetime.today(), time)
dt += timedelta
return dt.time()
class PersonSerializer(serializers.ModelSerializer):
class Meta:
model = Person
fields = ['date_joined', 'time_joined', 'datetime_joined']
class PersonFilter(FilterSet):
date_joined = AutoFilter(field_name='date_joined', lookups='__all__')
time_joined = AutoFilter(field_name='time_joined', lookups='__all__')
datetime_joined = AutoFilter(field_name='datetime_joined', lookups='__all__')
class Meta:
model = Person
fields = []
class InLookupPersonFilter(FilterSet):
pk = AutoFilter('id', lookups='__all__')
name = AutoFilter('name', lookups='__all__')
class Meta:
model = Person
fields = []
class IsoDatetimeTests(TestCase):
@classmethod
def setUpTestData(cls):
john = Person.objects.create(name="John")
# Created at least one second apart
mark = Person.objects.create(name="Mark", best_friend=john)
mark.time_joined = add_timedelta(mark.time_joined, datetime.timedelta(seconds=1))
mark.datetime_joined += datetime.timedelta(seconds=1)
mark.save()
def test_implicit_date_filters(self):
john = Person.objects.get(name="John")
# Mark was created at least one second after John.
# mark = Person.objects.get(name="Mark")
# Figure out what the date strings should look like based on the
# serializer output.
data = PersonSerializer(john).data
date_str = JSONRenderer().render(data['date_joined']).decode('utf-8').strip('"')
# Adjust for imprecise rendering of time
offset = parse_datetime(data['datetime_joined']) + datetime.timedelta(seconds=0.6)
datetime_str = JSONRenderer().render(offset)
datetime_str = datetime_str.decode('utf-8').strip('"')
# Adjust for imprecise rendering of time
offset = datetime.datetime.combine(today, parse_time(data['time_joined']))
offset += datetime.timedelta(seconds=0.6)
time_str = JSONRenderer().render(offset.time()).decode('utf-8').strip('"')
# DateField
GET = {
'date_joined__lte': date_str,
}
f = PersonFilter(GET, queryset=Person.objects.all())
self.assertEqual(len(list(f.qs)), 2)
p = list(f.qs)[0]
# DateTimeField
GET = {
'datetime_joined__lte': datetime_str,
}
f = PersonFilter(GET, queryset=Person.objects.all())
self.assertEqual(len(list(f.qs)), 1)
p = list(f.qs)[0]
self.assertEqual(p.name, "John")
# TimeField
GET = {
'time_joined__lte': time_str,
}
f = PersonFilter(GET, queryset=Person.objects.all())
self.assertEqual(len(list(f.qs)), 1)
p = list(f.qs)[0]
self.assertEqual(p.name, "John")
@override_settings(USE_TZ=True, TIME_ZONE='UTC')
def test_datetime_timezone_awareness(self):
# Issue #24 - coorectly handle datetime strings terminating in 'Z'.
# Figure out what the date strings should look like based on the serializer output
john = Person.objects.get(name="John")
data = PersonSerializer(john).data
offset = parse_datetime(data['datetime_joined']) + datetime.timedelta(seconds=0.6)
datetime_str = JSONRenderer().render(offset)
datetime_str = datetime_str.decode('utf-8').strip('"')
# DRF appends a 'Z' to timezone aware UTC datetimes when rendering:
# https://github.com/tomchristie/django-rest-framework/blob/3.2.0/rest_framework/fields.py#L1002-L1006
self.assertTrue(datetime_str.endswith('Z'))
GET = {
'datetime_joined__lte': datetime_str,
}
f = PersonFilter(GET, queryset=Person.objects.all())
self.assertEqual(len(list(f.qs)), 1)
p = list(f.qs)[0]
self.assertEqual(p.name, "John")
class BooleanFilterTests(TestCase):
@classmethod
def setUpTestData(cls):
User.objects.create(username="user1",
email="user1@example.org",
is_active=True,
last_login=today)
User.objects.create(username="user2",
email="user2@example.org",
is_active=False)
def test_boolean_filter(self):
# Capitalized True
GET = {'is_active': 'True'}
filterset = UserFilter(GET, queryset=User.objects.all())
results = list(filterset.qs)
self.assertEqual(len(results), 1)
self.assertEqual(results[0].username, 'user1')
# Lowercase True
GET = {'is_active': 'true'}
filterset = UserFilter(GET, queryset=User.objects.all())
results = list(filterset.qs)
self.assertEqual(len(results), 1)
self.assertEqual(results[0].username, 'user1')
# Uppercase True
GET = {'is_active': 'TRUE'}
filterset = UserFilter(GET, queryset=User.objects.all())
results = list(filterset.qs)
self.assertEqual(len(results), 1)
self.assertEqual(results[0].username, 'user1')
# Capitalized False
GET = {'is_active': 'False'}
filterset = UserFilter(GET, queryset=User.objects.all())
results = list(filterset.qs)
self.assertEqual(len(results), 1)
self.assertEqual(results[0].username, 'user2')
# Lowercase False
GET = {'is_active': 'false'}
filterset = UserFilter(GET, queryset=User.objects.all())
results = list(filterset.qs)
self.assertEqual(len(results), 1)
self.assertEqual(results[0].username, 'user2')
# Uppercase False
GET = {'is_active': 'FALSE'}
filterset = UserFilter(GET, queryset=User.objects.all())
results = list(filterset.qs)
self.assertEqual(len(results), 1)
self.assertEqual(results[0].username, 'user2')
class InLookupTests(TestCase):
@classmethod
def setUpTestData(cls):
john = Person.objects.create(name="John")
Person.objects.create(name="Mark", best_friend=john)
User.objects.create(username="user1",
email="user1@example.org",
is_active=True,
last_login=today)
User.objects.create(username="user2",
email="user2@example.org",
is_active=False)
def test_inset_number_filter(self):
p1 = Person.objects.get(name="John").pk
p2 = Person.objects.get(name="Mark").pk
ALL_GET = {
'pk__in': '{:d},{:d}'.format(p1, p2),
}
f = InLookupPersonFilter(ALL_GET, queryset=Person.objects.all())
f = [x.pk for x in f.qs]
self.assertEqual(len(f), 2)
self.assertIn(p1, f)
self.assertIn(p2, f)
INVALID_GET = {
'pk__in': '{:d},c{:d}'.format(p1, p2),
}
f = InLookupPersonFilter(INVALID_GET, queryset=Person.objects.all())
self.assertFalse(f.is_valid())
self.assertEqual(f.qs.count(), 2)
EXTRA_GET = {
'pk__in': '{:d},{:d},{:d}'.format(p1, p2, p1 * p2),
}
f = InLookupPersonFilter(EXTRA_GET, queryset=Person.objects.all())
f = [x.pk for x in f.qs]
self.assertEqual(len(f), 2)
self.assertIn(p1, f)
self.assertIn(p2, f)
DISORDERED_GET = {
'pk__in': '{:d},{:d},{:d}'.format(p2, p2 * p1, p1),
}
f = InLookupPersonFilter(DISORDERED_GET, queryset=Person.objects.all())
f = [x.pk for x in f.qs]
self.assertEqual(len(f), 2)
self.assertIn(p1, f)
self.assertIn(p2, f)
def test_inset_char_filter(self):
p1 = Person.objects.get(name="John").name
p2 = Person.objects.get(name="Mark").name
ALL_GET = {
'name__in': '{},{}'.format(p1, p2),
}
f = InLookupPersonFilter(ALL_GET, queryset=Person.objects.all())
f = [x.name for x in f.qs]
self.assertEqual(len(f), 2)
self.assertIn(p1, f)
self.assertIn(p2, f)
NONEXISTENT_GET = {
'name__in': '{},Foo{}'.format(p1, p2),
}
f = InLookupPersonFilter(NONEXISTENT_GET, queryset=Person.objects.all())
self.assertEqual(len(list(f.qs)), 1)
EXTRA_GET = {
'name__in': '{},{},{}'.format(p1, p2, p1 + p2),
}
f = InLookupPersonFilter(EXTRA_GET, queryset=Person.objects.all())
f = [x.name for x in f.qs]
self.assertEqual(len(f), 2)
self.assertIn(p1, f)
self.assertIn(p2, f)
DISORDERED_GET = {
'name__in': '{},{},{}'.format(p2, p2 + p1, p1),
}
f = InLookupPersonFilter(DISORDERED_GET, queryset=Person.objects.all())
f = [x.name for x in f.qs]
self.assertEqual(len(f), 2)
self.assertIn(p1, f)
self.assertIn(p2, f)
class IsNullLookupTests(TestCase):
@classmethod
def setUpTestData(cls):
User.objects.create(username="user1",
email="user1@example.org",
is_active=True,
last_login=today)
User.objects.create(username="user2",
email="user2@example.org",
is_active=False)
def test_isnull_override(self):
import django_filters.filters
self.assertIsInstance(
UserFilter.base_filters['last_login__isnull'],
django_filters.filters.BooleanFilter,
)
GET = {'last_login__isnull': 'false'}
filterset = UserFilter(GET, queryset=User.objects.all())
filter_ = filterset.filters['last_login__isnull']
self.assertIsInstance(filter_, django_filters.filters.BooleanFilter)
results = list(filterset.qs)
self.assertEqual(len(results), 1)
self.assertEqual(results[0].username, 'user1')
GET = {'last_login__isnull': 'true'}
filterset = UserFilter(GET, queryset=User.objects.all())
filter_ = filterset.filters['last_login__isnull']
self.assertIsInstance(filter_, django_filters.filters.BooleanFilter)
results = list(filterset.qs)
self.assertEqual(len(results), 1)
self.assertEqual(results[0].username, 'user2')
class FilterMethodTests(TestCase):
@classmethod
def setUpTestData(cls):
user = User.objects.create(username="user1", email="user1@example.org")
note1 = Note.objects.create(title="Test 1", content="Test content 1", author=user)
note2 = Note.objects.create(title="Test 2", content="Test content 2", author=user)
post1 = Post.objects.create(note=note1, content="Test content in post 1")
post2 = Post.objects.create(note=note2,
content="Test content in post 2",
publish_date=today)
Cover.objects.create(post=post1, comment="Cover 1")
Cover.objects.create(post=post2, comment="Cover 2")
def test_method_filter(self):
GET = {
'is_published': 'true',
}
filterset = PostFilter(GET, queryset=Post.objects.all())
results = list(filterset.qs)
self.assertEqual(len(results), 1)
self.assertEqual(results[0].content, "Test content in post 2")
def test_related_method_filter(self):
# Missing MethodFilter methods are silently ignored, returning the unfiltered qs.
GET = {
'post__is_published': 'true',
}
filterset = CoverFilter(GET, queryset=Cover.objects.all())
results = list(filterset.qs)
self.assertEqual(len(results), 1)
self.assertEqual(results[0].comment, "Cover 2")
|
