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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
|
import pytest
from bson import ObjectId
from beanie import PydanticObjectId, WriteRules
from beanie.exceptions import StateManagementIsTurnedOff, StateNotSaved
from beanie.odm.utils.parsing import parse_obj
from beanie.odm.utils.pydantic import IS_PYDANTIC_V2, parse_model
from tests.odm.models import (
DocumentWithTurnedOffStateManagement,
DocumentWithTurnedOnReplaceObjects,
DocumentWithTurnedOnSavePrevious,
DocumentWithTurnedOnStateManagement,
DocumentWithTurnedOnStateManagementWithCustomId,
HouseWithRevision,
InternalDoc,
LockWithRevision,
StateAndDecimalFieldModel,
WindowWithRevision,
)
@pytest.fixture
def state():
if IS_PYDANTIC_V2:
internal = InternalDoc().model_dump()
else:
internal = InternalDoc().dict()
return {
"num_1": 1,
"num_2": 2,
"_id": ObjectId(),
"internal": internal,
}
@pytest.fixture
def state_without_id():
if IS_PYDANTIC_V2:
internal = InternalDoc().model_dump()
else:
internal = InternalDoc().dict()
return {
"num_1": 1,
"num_2": 2,
"internal": internal,
}
@pytest.fixture
def doc_default(state):
return parse_obj(DocumentWithTurnedOnStateManagement, state)
@pytest.fixture
def doc_replace(state):
return parse_obj(DocumentWithTurnedOnReplaceObjects, state)
@pytest.fixture
def doc_previous(state):
return parse_obj(DocumentWithTurnedOnSavePrevious, state)
@pytest.fixture
async def saved_doc_default(doc_default):
await doc_default.insert()
return doc_default
@pytest.fixture
async def saved_doc_previous(doc_previous):
await doc_previous.insert()
return doc_previous
@pytest.fixture
def windows_not_inserted():
return [
WindowWithRevision(x=10, y=10, lock=LockWithRevision(k=10)),
WindowWithRevision(x=11, y=11, lock=LockWithRevision(k=11)),
]
@pytest.fixture
def house_not_inserted(windows_not_inserted):
return HouseWithRevision(windows=windows_not_inserted)
@pytest.fixture
async def house(house_not_inserted):
return await house_not_inserted.insert(link_rule=WriteRules.WRITE)
class TestStateManagement:
async def test_use_state_management_property(self):
assert (
DocumentWithTurnedOnStateManagement.use_state_management() is True
)
assert (
DocumentWithTurnedOffStateManagement.use_state_management()
is False
)
async def test_state_with_decimal_field(
self,
):
await StateAndDecimalFieldModel(amt=10.01).insert()
await StateAndDecimalFieldModel.all().to_list()
async def test_parse_object_with_saving_state(self):
if IS_PYDANTIC_V2:
internal = InternalDoc().model_dump()
else:
internal = InternalDoc().dict()
obj = {
"num_1": 1,
"num_2": 2,
"_id": ObjectId(),
"internal": internal,
}
doc = parse_obj(DocumentWithTurnedOnStateManagement, obj)
assert doc.get_saved_state() == obj
assert doc.get_previous_saved_state() is None
class TestSaveState:
async def test_save_state(self):
doc = DocumentWithTurnedOnStateManagement(
num_1=1, num_2=2, internal=InternalDoc(num=1, string="s")
)
assert doc.get_saved_state() is None
assert doc.get_previous_saved_state() is None
doc.id = PydanticObjectId()
doc._save_state()
assert doc.get_saved_state() == {
"num_1": 1,
"num_2": 2,
"internal": {"num": 1, "string": "s", "lst": [1, 2, 3, 4, 5]},
"_id": doc.id,
}
assert doc.get_previous_saved_state() is None
doc.num_1 = 2
doc.num_2 = 3
doc._save_state()
assert doc.get_saved_state() == {
"num_1": 2,
"num_2": 3,
"internal": {"num": 1, "string": "s", "lst": [1, 2, 3, 4, 5]},
"_id": doc.id,
}
assert doc.get_previous_saved_state() is None
async def test_save_state_with_custom_id_type(self):
doc = DocumentWithTurnedOnStateManagementWithCustomId(
id=0,
num_1=1,
num_2=2,
)
with pytest.raises(StateNotSaved):
await doc.save_changes()
doc.num_1 = 2
with pytest.raises(StateNotSaved):
await doc.save_changes()
async def test_save_state_with_previous(self):
doc = DocumentWithTurnedOnSavePrevious(
num_1=1, num_2=2, internal=InternalDoc(num=1, string="s")
)
assert doc.get_saved_state() is None
assert doc.get_previous_saved_state() is None
doc.id = PydanticObjectId()
doc._save_state()
assert doc.get_saved_state() == {
"num_1": 1,
"num_2": 2,
"internal": {"num": 1, "string": "s", "lst": [1, 2, 3, 4, 5]},
"_id": doc.id,
}
assert doc.get_previous_saved_state() is None
doc.num_1 = 2
doc.num_2 = 3
doc._save_state()
assert doc.get_saved_state() == {
"num_1": 2,
"num_2": 3,
"internal": {"num": 1, "string": "s", "lst": [1, 2, 3, 4, 5]},
"_id": doc.id,
}
assert doc.get_previous_saved_state() == {
"num_1": 1,
"num_2": 2,
"internal": {"num": 1, "string": "s", "lst": [1, 2, 3, 4, 5]},
"_id": doc.id,
}
class TestIsChanged:
async def test_state_management_off(self):
doc = DocumentWithTurnedOffStateManagement(num_1=1, num_2=2)
with pytest.raises(StateManagementIsTurnedOff):
doc.is_changed
async def test_state_management_on_not_changed(self):
doc = DocumentWithTurnedOnStateManagement(
num_1=1, num_2=2, internal=InternalDoc()
)
with pytest.raises(StateNotSaved):
doc.is_changed
async def test_state_management_on_changed(self, doc_default):
assert doc_default.is_changed is False
doc_default.num_1 = 10
assert doc_default.is_changed is True
class TestHasChanged:
async def test_state_management_off(self):
doc = DocumentWithTurnedOffStateManagement(num_1=1, num_2=2)
with pytest.raises(StateManagementIsTurnedOff):
doc.has_changed
async def test_state_management_on_not_changed(self):
doc = DocumentWithTurnedOnStateManagement(
num_1=1, num_2=2, internal=InternalDoc()
)
with pytest.raises(StateNotSaved):
doc.has_changed
async def test_save_previous_on_not_changed(self):
doc = DocumentWithTurnedOnSavePrevious(
num_1=1, num_2=2, internal=InternalDoc()
)
with pytest.raises(StateNotSaved):
doc.has_changed
async def test_save_previous_on_changed(self, doc_previous):
assert doc_previous.has_changed is False
doc_previous.num_1 = 10
doc_previous._save_state()
assert doc_previous.has_changed is True
class TestGetChanges:
async def test_valid(self, doc_default):
doc_default.internal.num = 1000
doc_default.internal.string = "new_value"
doc_default.internal.lst.append(100)
assert doc_default.get_changes() == {
"internal.num": 1000,
"internal.string": "new_value",
"internal.lst": [1, 2, 3, 4, 5, 100],
}
doc_default._save_state()
assert doc_default.get_changes() == {}
async def test_whole(self, doc_default):
doc_default.internal = {"num": 1000, "string": "new_value"}
assert doc_default.get_changes() == {
"internal.num": 1000,
"internal.string": "new_value",
}
async def test_replace(self, doc_replace):
doc_replace.internal.num = 1000
doc_replace.internal.string = "new_value"
assert doc_replace.get_changes() == {
"internal": {
"num": 1000,
"string": "new_value",
"lst": [1, 2, 3, 4, 5],
}
}
async def test_replace_whole(self, doc_replace):
doc_replace.internal = {"num": 1000, "string": "new_value"}
assert doc_replace.get_changes() == {
"internal": {
"num": 1000,
"string": "new_value",
}
}
class TestGetPreviousChanges:
async def test_get_previous_changes(self, doc_previous):
doc_previous.internal.num = 1000
doc_previous.internal.string = "new_value"
doc_previous.internal.lst.append(100)
assert doc_previous.get_previous_changes() == {}
doc_previous._save_state()
assert doc_previous.get_previous_changes() == {
"internal.num": 1000,
"internal.string": "new_value",
"internal.lst": [1, 2, 3, 4, 5, 100],
}
class TestRollback:
async def test_rollback(self, doc_default, state):
doc_default.num_1 = 100
doc_default.rollback()
assert doc_default.num_1 == state["num_1"]
class TestQueries:
async def test_save_changes(self, saved_doc_default):
assert saved_doc_default.get_saved_state()["num_1"] == 1
assert saved_doc_default.get_previous_saved_state() is None
saved_doc_default.num_1 = 10000
saved_doc_default.internal.change_private()
assert (
saved_doc_default.internal.get_private() == "PRIVATE_CHANGED"
)
await saved_doc_default.save_changes()
assert saved_doc_default.get_saved_state()["num_1"] == 10000
assert saved_doc_default.get_previous_saved_state() is None
assert (
saved_doc_default.internal.get_private() == "PRIVATE_CHANGED"
)
new_doc = await DocumentWithTurnedOnStateManagement.get(
saved_doc_default.id
)
assert new_doc.num_1 == 10000
async def test_save_changes_previous(self, saved_doc_previous):
assert saved_doc_previous.get_saved_state()["num_1"] == 1
assert saved_doc_previous.get_previous_saved_state()["num_1"] == 1
saved_doc_previous.num_1 = 10000
saved_doc_previous.internal.change_private()
assert (
saved_doc_previous.internal.get_private() == "PRIVATE_CHANGED"
)
await saved_doc_previous.save_changes()
assert saved_doc_previous.get_saved_state()["num_1"] == 10000
assert saved_doc_previous.get_previous_saved_state()["num_1"] == 1
assert (
saved_doc_previous.internal.get_private() == "PRIVATE_CHANGED"
)
new_doc = await DocumentWithTurnedOnSavePrevious.get(
saved_doc_previous.id
)
assert new_doc.num_1 == 10000
async def test_fetch_save_changes(self, house):
data = await HouseWithRevision.all(fetch_links=True).to_list()
house = data[0]
window_0 = house.windows[0]
window_0.x = 10000
window_0.lock.k = 10000
await window_0.save_changes()
async def test_find_one(self, saved_doc_default, state):
new_doc = await DocumentWithTurnedOnStateManagement.get(
saved_doc_default.id
)
assert new_doc.get_saved_state() == state
assert new_doc.get_previous_saved_state() is None
new_doc = await DocumentWithTurnedOnStateManagement.find_one(
DocumentWithTurnedOnStateManagement.id == saved_doc_default.id
)
assert new_doc.get_saved_state() == state
assert new_doc.get_previous_saved_state() is None
async def test_find_many(self):
docs = []
for i in range(10):
docs.append(
DocumentWithTurnedOnStateManagement(
num_1=i, num_2=i + 1, internal=InternalDoc()
)
)
await DocumentWithTurnedOnStateManagement.insert_many(docs)
found_docs = await DocumentWithTurnedOnStateManagement.find(
DocumentWithTurnedOnStateManagement.num_1 > 4
).to_list()
for doc in found_docs:
assert doc.get_saved_state() is not None
assert doc.get_previous_saved_state() is None
async def test_insert(self, state_without_id):
doc = parse_model(
DocumentWithTurnedOnStateManagement, state_without_id
)
assert doc.get_saved_state() is None
await doc.insert()
new_state = doc.get_saved_state()
assert new_state["_id"] is not None
del new_state["_id"]
assert new_state == state_without_id
async def test_replace(self, saved_doc_default):
saved_doc_default.num_1 = 100
await saved_doc_default.replace()
assert saved_doc_default.get_saved_state()["num_1"] == 100
assert saved_doc_default.get_previous_saved_state() is None
async def test_replace_save_previous(self, saved_doc_previous):
saved_doc_previous.num_1 = 100
await saved_doc_previous.replace()
assert saved_doc_previous.get_saved_state()["num_1"] == 100
assert saved_doc_previous.get_previous_saved_state()["num_1"] == 1
async def test_exclude_revision_id(self, saved_doc_previous):
saved_doc_previous.num_1 = 100
await saved_doc_previous.replace()
assert saved_doc_previous.get_saved_state()["num_1"] == 100
assert saved_doc_previous.get_previous_saved_state()["num_1"] == 1
assert (
saved_doc_previous.get_saved_state().get("revision_id") is None
)
assert (
saved_doc_previous.get_saved_state().get(
"previous_revision_id"
)
is None
)
assert (
saved_doc_previous.get_previous_saved_state().get(
"revision_id"
)
is None
)
assert (
saved_doc_previous.get_previous_saved_state().get(
"previous_revision_id"
)
is None
)
|
