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
357
358
359
|
import time
from exchangelib.errors import ErrorInternalServerError, ErrorItemNotFound
from exchangelib.folders import FolderCollection, Inbox
from exchangelib.items import ASSOCIATED, SHALLOW, Message
from exchangelib.queryset import DoesNotExist, MultipleObjectsReturned, QuerySet
from .test_basics import BaseItemTest
class ItemQuerySetTest(BaseItemTest):
TEST_FOLDER = "inbox"
FOLDER_CLASS = Inbox
ITEM_CLASS = Message
def test_querysets(self):
test_items = []
for i in range(4):
item = self.get_test_item()
item.subject = f"Item {i}"
item.save()
test_items.append(item)
qs = QuerySet(folder_collection=FolderCollection(account=self.account, folders=[self.test_folder])).filter(
categories__contains=self.categories
)
test_cat = self.categories[0]
self.assertEqual(
{(i.subject, i.categories[0]) for i in qs},
{("Item 0", test_cat), ("Item 1", test_cat), ("Item 2", test_cat), ("Item 3", test_cat)},
)
self.assertEqual([(i.subject, i.categories[0]) for i in qs.none()], [])
self.assertEqual(
[(i.subject, i.categories[0]) for i in qs.filter(subject__startswith="Item 2")], [("Item 2", test_cat)]
)
self.assertEqual(
{(i.subject, i.categories[0]) for i in qs.exclude(subject__startswith="Item 2")},
{("Item 0", test_cat), ("Item 1", test_cat), ("Item 3", test_cat)},
)
self.assertEqual(
{(i.subject, i.categories) for i in qs.only("subject")},
{("Item 0", None), ("Item 1", None), ("Item 2", None), ("Item 3", None)},
)
self.assertEqual(
[(i.subject, i.categories[0]) for i in qs.order_by("subject")],
[("Item 0", test_cat), ("Item 1", test_cat), ("Item 2", test_cat), ("Item 3", test_cat)],
)
self.assertEqual( # Test '-some_field' syntax for reverse sorting
[(i.subject, i.categories[0]) for i in qs.order_by("-subject")],
[("Item 3", test_cat), ("Item 2", test_cat), ("Item 1", test_cat), ("Item 0", test_cat)],
)
self.assertEqual( # Test ordering on a field that we don't need to fetch
[(i.subject, i.categories[0]) for i in qs.order_by("-subject").only("categories")],
[(None, test_cat), (None, test_cat), (None, test_cat), (None, test_cat)],
)
self.assertEqual(
[(i.subject, i.categories[0]) for i in qs.order_by("subject").reverse()],
[("Item 3", test_cat), ("Item 2", test_cat), ("Item 1", test_cat), ("Item 0", test_cat)],
)
with self.assertRaises(TypeError):
list(qs.values([]))
self.assertEqual(
list(qs.order_by("subject").values("subject")),
[{"subject": "Item 0"}, {"subject": "Item 1"}, {"subject": "Item 2"}, {"subject": "Item 3"}],
)
# Test .values() in combinations of 'id' and 'changekey', which are handled specially
self.assertEqual(list(qs.order_by("subject").values("id")), [{"id": i.id} for i in test_items])
self.assertEqual(
list(qs.order_by("subject").values("changekey")), [{"changekey": i.changekey} for i in test_items]
)
self.assertEqual(
list(qs.order_by("subject").values("id", "changekey")),
[{k: getattr(i, k) for k in ("id", "changekey")} for i in test_items],
)
self.assertEqual(set(qs.values_list("subject")), {("Item 0",), ("Item 1",), ("Item 2",), ("Item 3",)})
# Test .values_list() in combinations of 'id' and 'changekey', which are handled specially
self.assertEqual(list(qs.order_by("subject").values_list("id")), [(i.id,) for i in test_items])
self.assertEqual(list(qs.order_by("subject").values_list("changekey")), [(i.changekey,) for i in test_items])
self.assertEqual(
list(qs.order_by("subject").values_list("id", "changekey")), [(i.id, i.changekey) for i in test_items]
)
self.assertEqual({i.subject for i in qs.only("subject")}, {"Item 0", "Item 1", "Item 2", "Item 3"})
# Test .only() in combinations of 'id' and 'changekey', which are handled specially
self.assertEqual([(i.id,) for i in qs.order_by("subject").only("id")], [(i.id,) for i in test_items])
self.assertEqual(
[(i.changekey,) for i in qs.order_by("subject").only("changekey")], [(i.changekey,) for i in test_items]
)
self.assertEqual(
[(i.id, i.changekey) for i in qs.order_by("subject").only("id", "changekey")],
[(i.id, i.changekey) for i in test_items],
)
with self.assertRaises(ValueError):
list(qs.values_list("id", "changekey", flat=True))
with self.assertRaises(AttributeError):
list(qs.values_list("id", xxx=True))
self.assertEqual(list(qs.order_by("subject").values_list("id", flat=True)), [i.id for i in test_items])
self.assertEqual(
list(qs.order_by("subject").values_list("changekey", flat=True)), [i.changekey for i in test_items]
)
self.assertEqual(set(qs.values_list("subject", flat=True)), {"Item 0", "Item 1", "Item 2", "Item 3"})
self.assertEqual(qs.values_list("subject", flat=True).get(subject="Item 2"), "Item 2")
self.assertEqual(
{(i.subject, i.categories[0]) for i in qs.exclude(subject__startswith="Item 2")},
{("Item 0", test_cat), ("Item 1", test_cat), ("Item 3", test_cat)},
)
# Test that we can sort on a field that we don't want
self.assertEqual(
[i.categories[0] for i in qs.only("categories").order_by("subject")],
[test_cat, test_cat, test_cat, test_cat],
)
self.assertEqual(qs.get(subject="Item 3").subject, "Item 3")
with self.assertRaises(DoesNotExist):
qs.get(subject="Item XXX")
with self.assertRaises(MultipleObjectsReturned):
qs.get(subject__startswith="Item")
# len() and count()
self.assertEqual(qs.count(), 4)
# Indexing and slicing
self.assertIsInstance(qs[0], self.ITEM_CLASS)
self.assertEqual(len(list(qs[1:3])), 2)
self.assertEqual(qs.count(), 4)
with self.assertRaises(IndexError):
print(qs[99999])
# Exists
self.assertEqual(qs.exists(), True)
self.assertEqual(qs.filter(subject="Test XXX").exists(), False)
self.assertEqual(qs.filter(subject__startswith="Item").delete(), [True, True, True, True])
def test_queryset_failure(self):
qs = QuerySet(folder_collection=FolderCollection(account=self.account, folders=[self.test_folder])).filter(
categories__contains=self.categories
)
with self.assertRaises(ValueError):
qs.order_by("XXX")
with self.assertRaises(ValueError):
qs.values("XXX")
with self.assertRaises(ValueError):
qs.values_list("XXX")
with self.assertRaises(ValueError):
qs.only("XXX")
with self.assertRaises(ValueError):
qs.reverse() # We can't reverse when we haven't defined an order yet
def test_cached_queryset_corner_cases(self):
test_items = []
for i in range(4):
item = self.get_test_item()
item.subject = f"Item {i}"
item.save()
test_items.append(item)
qs = (
QuerySet(folder_collection=FolderCollection(account=self.account, folders=[self.test_folder]))
.filter(categories__contains=self.categories)
.order_by("subject")
)
with self.assertRaises(MultipleObjectsReturned):
qs.get() # Get with a full cache
self.assertEqual(qs[2].subject, "Item 2") # Index with a full cache
self.assertEqual(qs[-2].subject, "Item 2") # Negative index with a full cache
qs.delete() # Delete with a full cache
self.assertEqual(qs.count(), 0) # QuerySet is empty after delete
self.assertEqual(list(qs.none()), [])
def test_queryset_get_by_id(self):
item = self.get_test_item().save()
with self.assertRaises(ValueError):
list(self.test_folder.filter(id__in=[item.id]))
with self.assertRaises(ValueError):
list(self.test_folder.get(id=item.id, changekey=item.changekey, subject="XXX"))
with self.assertRaises(ValueError):
list(self.test_folder.get(id=None, changekey=item.changekey))
# Test a simple get()
get_item = self.test_folder.get(id=item.id, changekey=item.changekey)
self.assertEqual(item.id, get_item.id)
self.assertEqual(item.changekey, get_item.changekey)
self.assertEqual(item.subject, get_item.subject)
self.assertEqual(item.body, get_item.body)
# Test get() with ID only
get_item = self.test_folder.get(id=item.id)
self.assertEqual(item.id, get_item.id)
self.assertEqual(item.changekey, get_item.changekey)
self.assertEqual(item.subject, get_item.subject)
self.assertEqual(item.body, get_item.body)
get_item = self.test_folder.get(id=item.id, changekey=None)
self.assertEqual(item.id, get_item.id)
self.assertEqual(item.changekey, get_item.changekey)
self.assertEqual(item.subject, get_item.subject)
self.assertEqual(item.body, get_item.body)
item_id = item.id
item.delete()
with self.assertRaises(ErrorItemNotFound):
self.test_folder.get(id=item_id, changekey=None)
item = self.get_test_item().save()
# Test a get() from queryset
get_item = self.test_folder.all().get(id=item.id, changekey=item.changekey)
self.assertEqual(item.id, get_item.id)
self.assertEqual(item.changekey, get_item.changekey)
self.assertEqual(item.subject, get_item.subject)
self.assertEqual(item.body, get_item.body)
# Test a get() with only()
get_item = self.test_folder.all().only("subject").get(id=item.id, changekey=item.changekey)
self.assertEqual(item.id, get_item.id)
self.assertEqual(item.changekey, get_item.changekey)
self.assertEqual(item.subject, get_item.subject)
self.assertIsNone(get_item.body)
def test_paging(self):
# Test that paging services work correctly. Default EWS paging size is 1000 items. Our default is 100 items.
items = []
for _ in range(11):
i = self.get_test_item()
del i.attachments[:]
items.append(i)
self.test_folder.bulk_create(items=items)
ids = self.test_folder.filter(categories__contains=self.categories).values_list("id", "changekey")
ids.page_size = 10
self.bulk_delete(ids)
def test_slicing(self):
# Test that slicing works correctly
items = []
for i in range(4):
item = self.get_test_item()
item.subject = f"Subj {i}"
del item.attachments[:]
items.append(item)
self.test_folder.bulk_create(items=items)
qs = self.test_folder.filter(categories__contains=self.categories).only("subject").order_by("subject")
# Test positive index
self.assertEqual(qs._copy_self()[0].subject, "Subj 0")
# Test positive index
self.assertEqual(qs._copy_self()[3].subject, "Subj 3")
# Test negative index
self.assertEqual(qs._copy_self()[-2].subject, "Subj 2")
# Test positive slice
self.assertEqual([i.subject for i in qs._copy_self()[0:2]], ["Subj 0", "Subj 1"])
# Test positive slice
self.assertEqual([i.subject for i in qs._copy_self()[2:4]], ["Subj 2", "Subj 3"])
# Test positive open slice
self.assertEqual([i.subject for i in qs._copy_self()[:2]], ["Subj 0", "Subj 1"])
# Test positive open slice
self.assertEqual([i.subject for i in qs._copy_self()[2:]], ["Subj 2", "Subj 3"])
# Test negative slice
self.assertEqual([i.subject for i in qs._copy_self()[-3:-1]], ["Subj 1", "Subj 2"])
# Test negative slice
self.assertEqual([i.subject for i in qs._copy_self()[1:-1]], ["Subj 1", "Subj 2"])
# Test negative open slice
self.assertEqual([i.subject for i in qs._copy_self()[:-2]], ["Subj 0", "Subj 1"])
# Test negative open slice
self.assertEqual([i.subject for i in qs._copy_self()[-2:]], ["Subj 2", "Subj 3"])
# Test positive slice with step
self.assertEqual([i.subject for i in qs._copy_self()[0:4:2]], ["Subj 0", "Subj 2"])
# Test negative slice with step
self.assertEqual([i.subject for i in qs._copy_self()[4:0:-2]], ["Subj 3", "Subj 1"])
def test_delete_via_queryset(self):
self.get_test_item().save()
qs = self.test_folder.filter(categories__contains=self.categories)
self.assertEqual(qs.count(), 1)
qs.delete()
self.assertEqual(qs.count(), 0)
def test_send_via_queryset(self):
self.get_test_item().save()
qs = self.test_folder.filter(categories__contains=self.categories)
to_folder = self.account.sent
to_folder_qs = to_folder.filter(categories__contains=self.categories)
self.assertEqual(qs.count(), 1)
self.assertEqual(to_folder_qs.count(), 0)
qs.send(copy_to_folder=to_folder)
time.sleep(5) # Requests are supposed to be transactional, but apparently not...
self.assertEqual(qs.count(), 0)
self.assertEqual(to_folder_qs.count(), 1)
def test_send_with_no_copy_via_queryset(self):
self.get_test_item().save()
qs = self.test_folder.filter(categories__contains=self.categories)
to_folder = self.account.sent
to_folder_qs = to_folder.filter(categories__contains=self.categories)
self.assertEqual(qs.count(), 1)
self.assertEqual(to_folder_qs.count(), 0)
qs.send(save_copy=False)
time.sleep(5) # Requests are supposed to be transactional, but apparently not...
self.assertEqual(qs.count(), 0)
self.assertEqual(to_folder_qs.count(), 0)
def test_copy_via_queryset(self):
self.get_test_item().save()
qs = self.test_folder.filter(categories__contains=self.categories)
to_folder = self.account.trash
to_folder_qs = to_folder.filter(categories__contains=self.categories)
self.assertEqual(qs.count(), 1)
self.assertEqual(to_folder_qs.count(), 0)
qs.copy(to_folder=to_folder)
self.assertEqual(qs.count(), 1)
self.assertEqual(to_folder_qs.count(), 1)
def test_move_via_queryset(self):
self.get_test_item().save()
qs = self.test_folder.filter(categories__contains=self.categories)
to_folder = self.account.trash
to_folder_qs = to_folder.filter(categories__contains=self.categories)
self.assertEqual(qs.count(), 1)
self.assertEqual(to_folder_qs.count(), 0)
qs.move(to_folder=to_folder)
self.assertEqual(qs.count(), 0)
self.assertEqual(to_folder_qs.count(), 1)
def test_mark_as_junk_via_queryset(self):
self.get_test_item().save()
qs = self.test_folder.filter(categories__contains=self.categories)
qs.mark_as_junk(is_junk=False, move_item=False)
self.assertEqual(self.test_folder.filter(categories__contains=self.categories).count(), 1)
qs.mark_as_junk(is_junk=True, move_item=False)
self.assertEqual(self.test_folder.filter(categories__contains=self.categories).count(), 1)
qs.mark_as_junk(is_junk=True, move_item=True)
# Does not work in O365
# self.assertEqual(self.account.junk.filter(categories__contains=self.categories).count(), 1)
# self.account.junk.filter(categories__contains=self.categories).mark_as_junk(is_junk=False, move_item=True)
self.assertEqual(self.account.inbox.filter(categories__contains=self.categories).count(), 1)
def test_archive_via_queryset(self):
self.get_test_item().save()
qs = self.test_folder.filter(categories__contains=self.categories)
to_folder = self.account.trash
try:
qs.archive(to_folder=to_folder)
self.assertEqual(qs.count(), 0)
self.assertEqual(to_folder.filter(categories__contains=self.categories).count(), 1)
except ErrorInternalServerError as e:
# O365 is apparently unable to archive anymore
self.assertEqual(
str(e),
"An internal server error occurred. The operation failed., Unable to cast object of type "
"'Microsoft.Exchange.Services.Core.Types.MoveItemRequest' to type "
"'Microsoft.Exchange.Services.Core.ILegacyServiceCommandFactory'.",
)
def test_depth(self):
self.assertGreaterEqual(self.test_folder.all().depth(ASSOCIATED).count(), 0)
self.assertGreaterEqual(self.test_folder.all().depth(SHALLOW).count(), 0)
def test_empty_in_sequence(self):
# 'Q(foo_in=[])' should always match nothing. We interpret it to mean "is foo contained in the empty set?"
# which is always false.
item = self.get_test_item().save()
qs = self.test_folder.filter(categories__contains=self.categories)
self.assertEqual(qs.filter(subject__in=[item.subject]).count(), 1)
self.assertEqual(qs.filter(subject__in=[]).count(), 0)
|
