| 1 |
from __future__ import annotations |
| 2 |
|
| 3 |
from datetime import datetime, timezone |
| 4 |
|
| 5 |
import time_machine |
| 6 |
from django.test import TestCase |
| 7 |
|
| 8 |
from model_utils.fields import MonitorField |
| 9 |
from tests.models import DoubleMonitored, Monitored, MonitorWhen, MonitorWhenEmpty |
| 10 |
|
| 11 |
|
| 12 |
class MonitorFieldTests(TestCase): |
| 13 |
def setUp(self) -> None: |
| 14 |
with time_machine.travel(datetime(2016, 1, 1, 10, 0, 0, tzinfo=timezone.utc)): |
| 15 |
self.instance = Monitored(name='Charlie') |
| 16 |
self.created = self.instance.name_changed |
| 17 |
|
| 18 |
def test_save_no_change(self) -> None: |
| 19 |
self.instance.save() |
| 20 |
self.assertEqual(self.instance.name_changed, self.created) |
| 21 |
|
| 22 |
def test_save_changed(self) -> None: |
| 23 |
with time_machine.travel(datetime(2016, 1, 1, 12, 0, 0, tzinfo=timezone.utc)): |
| 24 |
self.instance.name = 'Maria' |
| 25 |
self.instance.save() |
| 26 |
self.assertEqual(self.instance.name_changed, datetime(2016, 1, 1, 12, 0, 0, tzinfo=timezone.utc)) |
| 27 |
|
| 28 |
def test_double_save(self) -> None: |
| 29 |
self.instance.name = 'Jose' |
| 30 |
self.instance.save() |
| 31 |
changed = self.instance.name_changed |
| 32 |
self.instance.save() |
| 33 |
self.assertEqual(self.instance.name_changed, changed) |
| 34 |
|
| 35 |
def test_no_monitor_arg(self) -> None: |
| 36 |
with self.assertRaises(TypeError): |
| 37 |
MonitorField() # type: ignore[call-arg] |
| 38 |
|
| 39 |
def test_monitor_default_is_none_when_nullable(self) -> None: |
| 40 |
self.assertIsNone(self.instance.name_changed_nullable) |
| 41 |
expected_datetime = datetime(2022, 1, 18, 12, 0, 0, tzinfo=timezone.utc) |
| 42 |
|
| 43 |
self.instance.name = "Jose" |
| 44 |
with time_machine.travel(expected_datetime, tick=False): |
| 45 |
self.instance.save() |
| 46 |
|
| 47 |
self.assertEqual(self.instance.name_changed_nullable, expected_datetime) |
| 48 |
|
| 49 |
|
| 50 |
class MonitorWhenFieldTests(TestCase): |
| 51 |
""" |
| 52 |
Will record changes only when name is 'Jose' or 'Maria' |
| 53 |
""" |
| 54 |
def setUp(self) -> None: |
| 55 |
with time_machine.travel(datetime(2016, 1, 1, 10, 0, 0, tzinfo=timezone.utc)): |
| 56 |
self.instance = MonitorWhen(name='Charlie') |
| 57 |
self.created = self.instance.name_changed |
| 58 |
|
| 59 |
def test_save_no_change(self) -> None: |
| 60 |
self.instance.save() |
| 61 |
self.assertEqual(self.instance.name_changed, self.created) |
| 62 |
|
| 63 |
def test_save_changed_to_Jose(self) -> None: |
| 64 |
with time_machine.travel(datetime(2016, 1, 1, 12, 0, 0, tzinfo=timezone.utc)): |
| 65 |
self.instance.name = 'Jose' |
| 66 |
self.instance.save() |
| 67 |
self.assertEqual(self.instance.name_changed, datetime(2016, 1, 1, 12, 0, 0, tzinfo=timezone.utc)) |
| 68 |
|
| 69 |
def test_save_changed_to_Maria(self) -> None: |
| 70 |
with time_machine.travel(datetime(2016, 1, 1, 12, 0, 0, tzinfo=timezone.utc)): |
| 71 |
self.instance.name = 'Maria' |
| 72 |
self.instance.save() |
| 73 |
self.assertEqual(self.instance.name_changed, datetime(2016, 1, 1, 12, 0, 0, tzinfo=timezone.utc)) |
| 74 |
|
| 75 |
def test_save_changed_to_Pedro(self) -> None: |
| 76 |
self.instance.name = 'Pedro' |
| 77 |
self.instance.save() |
| 78 |
self.assertEqual(self.instance.name_changed, self.created) |
| 79 |
|
| 80 |
def test_double_save(self) -> None: |
| 81 |
self.instance.name = 'Jose' |
| 82 |
self.instance.save() |
| 83 |
changed = self.instance.name_changed |
| 84 |
self.instance.save() |
| 85 |
self.assertEqual(self.instance.name_changed, changed) |
| 86 |
|
| 87 |
|
| 88 |
class MonitorWhenEmptyFieldTests(TestCase): |
| 89 |
""" |
| 90 |
Monitor should never be updated id when is an empty list. |
| 91 |
""" |
| 92 |
def setUp(self) -> None: |
| 93 |
self.instance = MonitorWhenEmpty(name='Charlie') |
| 94 |
self.created = self.instance.name_changed |
| 95 |
|
| 96 |
def test_save_no_change(self) -> None: |
| 97 |
self.instance.save() |
| 98 |
self.assertEqual(self.instance.name_changed, self.created) |
| 99 |
|
| 100 |
def test_save_changed_to_Jose(self) -> None: |
| 101 |
self.instance.name = 'Jose' |
| 102 |
self.instance.save() |
| 103 |
self.assertEqual(self.instance.name_changed, self.created) |
| 104 |
|
| 105 |
def test_save_changed_to_Maria(self) -> None: |
| 106 |
self.instance.name = 'Maria' |
| 107 |
self.instance.save() |
| 108 |
self.assertEqual(self.instance.name_changed, self.created) |
| 109 |
|
| 110 |
|
| 111 |
class MonitorDoubleFieldTests(TestCase): |
| 112 |
|
| 113 |
def setUp(self) -> None: |
| 114 |
DoubleMonitored.objects.create(name='Charlie', name2='Charlie2') |
| 115 |
|
| 116 |
def test_recursion_error_with_only(self) -> None: |
| 117 |
# Any field passed to only() is generating a recursion error |
| 118 |
list(DoubleMonitored.objects.only('id')) |
| 119 |
|
| 120 |
def test_recursion_error_with_defer(self) -> None: |
| 121 |
# Only monitored fields passed to defer() are failing |
| 122 |
list(DoubleMonitored.objects.defer('name')) |
| 123 |
|
| 124 |
def test_monitor_still_works_with_deferred_fields_filtered_out_of_save_initial(self) -> None: |
| 125 |
obj = DoubleMonitored.objects.defer('name').get(name='Charlie') |
| 126 |
with time_machine.travel(datetime(2016, 12, 1, tzinfo=timezone.utc)): |
| 127 |
obj.name = 'Charlie2' |
| 128 |
obj.save() |
| 129 |
self.assertEqual(obj.name_changed, datetime(2016, 12, 1, tzinfo=timezone.utc)) |