Debian Codegraph @

tests/test_models/test_timestamped_model.py

raw
1 from __future__ import annotations
2
3 from collections.abc import Iterable
4 from datetime import datetime, timedelta, timezone
5
6 import time_machine
7 from django.test import TestCase
8
9 from tests.models import TimeStamp, TimeStampWithStatusModel
10
11
12 class TimeStampedModelTests(TestCase):
13 def test_created(self) -> None:
14 with time_machine.travel(datetime(2016, 1, 1, tzinfo=timezone.utc)):
15 t1 = TimeStamp.objects.create()
16 self.assertEqual(t1.created, datetime(2016, 1, 1, tzinfo=timezone.utc))
17
18 def test_created_sets_modified(self) -> None:
19 '''
20 Ensure that on creation that modified is set exactly equal to created.
21 '''
22 t1 = TimeStamp.objects.create()
23 self.assertEqual(t1.created, t1.modified)
24
25 def test_modified(self) -> None:
26 with time_machine.travel(datetime(2016, 1, 1, tzinfo=timezone.utc)):
27 t1 = TimeStamp.objects.create()
28
29 with time_machine.travel(datetime(2016, 1, 2, tzinfo=timezone.utc)):
30 t1.save()
31
32 self.assertEqual(t1.modified, datetime(2016, 1, 2, tzinfo=timezone.utc))
33
34 def test_overriding_created_via_object_creation_also_uses_creation_date_for_modified(self) -> None:
35 """
36 Setting the created date when first creating an object
37 should be permissible.
38 """
39 different_date = datetime.today() - timedelta(weeks=52)
40 t1 = TimeStamp.objects.create(created=different_date)
41 self.assertEqual(t1.created, different_date)
42 self.assertEqual(t1.modified, different_date)
43
44 def test_overriding_modified_via_object_creation(self) -> None:
45 """
46 Setting the modified date explicitly should be possible when
47 first creating an object, but not thereafter.
48 """
49 different_date = datetime.today() - timedelta(weeks=52)
50 t1 = TimeStamp.objects.create(modified=different_date)
51 self.assertEqual(t1.modified, different_date)
52 self.assertNotEqual(t1.created, different_date)
53
54 def test_overriding_created_after_object_created(self) -> None:
55 """
56 The created date may be changed post-create
57 """
58 t1 = TimeStamp.objects.create()
59 different_date = datetime.today() - timedelta(weeks=52)
60 t1.created = different_date
61 t1.save()
62 self.assertEqual(t1.created, different_date)
63
64 def test_overriding_modified_after_object_created(self) -> None:
65 """
66 The modified date should always be updated when the object
67 is saved, regardless of attempts to change it.
68 """
69 t1 = TimeStamp.objects.create()
70 different_date = datetime.today() - timedelta(weeks=52)
71 t1.modified = different_date
72 t1.save()
73 self.assertNotEqual(t1.modified, different_date)
74
75 def test_overrides_using_save(self) -> None:
76 """
77 The first time an object is saved, allow modification of both
78 created and modified fields.
79 After that, only created may be modified manually.
80 """
81 t1 = TimeStamp()
82 different_date = datetime.today() - timedelta(weeks=52)
83 t1.created = different_date
84 t1.modified = different_date
85 t1.save()
86 self.assertEqual(t1.created, different_date)
87 self.assertEqual(t1.modified, different_date)
88 different_date2 = datetime.today() - timedelta(weeks=26)
89 t1.created = different_date2
90 t1.modified = different_date2
91 t1.save()
92 self.assertEqual(t1.created, different_date2)
93 self.assertNotEqual(t1.modified, different_date2)
94 self.assertNotEqual(t1.modified, different_date)
95
96 def test_save_with_update_fields_overrides_modified_provided_within_a(self) -> None:
97 """
98 Tests if the save method updated modified field
99 accordingly when update_fields is used as an argument
100 and modified is provided
101 """
102 tests = (
103 ['modified'], # list
104 ('modified',), # tuple
105 {'modified'}, # set
106 )
107
108 for update_fields in tests:
109 with self.subTest(update_fields=update_fields):
110 with time_machine.travel(datetime(2020, 1, 1, tzinfo=timezone.utc)):
111 t1 = TimeStamp.objects.create()
112
113 with time_machine.travel(datetime(2020, 1, 2, tzinfo=timezone.utc)):
114 t1.save(update_fields=update_fields)
115 self.assertEqual(t1.modified, datetime(2020, 1, 2, tzinfo=timezone.utc))
116
117 def test_save_is_skipped_for_empty_update_fields_iterable(self) -> None:
118 tests: Iterable[Iterable[str]] = (
119 [], # list
120 (), # tuple
121 set(), # set
122 )
123
124 for update_fields in tests:
125 with self.subTest(update_fields=update_fields):
126 with time_machine.travel(datetime(2020, 1, 1, tzinfo=timezone.utc)):
127 t1 = TimeStamp.objects.create()
128
129 with time_machine.travel(datetime(2020, 1, 2, tzinfo=timezone.utc)):
130 t1.test_field = 1
131 t1.save(update_fields=update_fields)
132
133 t1.refresh_from_db()
134 self.assertEqual(t1.test_field, 0)
135 self.assertEqual(t1.modified, datetime(2020, 1, 1, tzinfo=timezone.utc))
136
137 def test_save_updates_modified_value_when_update_fields_explicitly_set_to_none(self) -> None:
138 with time_machine.travel(datetime(2020, 1, 1, tzinfo=timezone.utc)):
139 t1 = TimeStamp.objects.create()
140
141 with time_machine.travel(datetime(2020, 1, 2, tzinfo=timezone.utc)):
142 t1.save(update_fields=None)
143
144 self.assertEqual(t1.modified, datetime(2020, 1, 2, tzinfo=timezone.utc))
145
146 def test_model_inherit_timestampmodel_and_statusmodel(self) -> None:
147 with time_machine.travel(datetime(2020, 1, 1, tzinfo=timezone.utc)):
148 t1 = TimeStampWithStatusModel.objects.create()
149
150 with time_machine.travel(datetime(2020, 1, 2, tzinfo=timezone.utc)):
151 t1.save(update_fields=['test_field', 'status'])
152
153 self.assertEqual(t1.modified, datetime(2020, 1, 2, tzinfo=timezone.utc))