1 """Test Days module."""
2 from unittest import TestCase
3 from datetime import datetime
4 from tests.utils import TestCaseWithDB, TestCaseWithServer
5 from plomtask.days import Day, todays_date
6 from plomtask.exceptions import (BadFormatException, NotFoundException,
10 class TestsSansDB(TestCase):
11 """Days module tests not requiring DB setup."""
13 def test_Day_valid_date(self) -> None:
14 """Test Day's date format validation and parsing."""
15 with self.assertRaises(BadFormatException):
17 with self.assertRaises(BadFormatException):
19 with self.assertRaises(BadFormatException):
20 Day('2024-02-01 23:00:00')
21 self.assertEqual(datetime(2024, 1, 1), Day('2024-01-01').datetime)
23 def test_Day_sorting(self) -> None:
24 """Test sorting by .__lt__ and Day.__eq__."""
25 day1 = Day('2024-01-01')
26 day2 = Day('2024-01-02')
27 day3 = Day('2024-01-03')
28 days = [day3, day1, day2]
29 self.assertEqual(sorted(days), [day1, day2, day3])
31 def test_Day_weekday(self) -> None:
32 """Test Day.weekday."""
33 self.assertEqual(Day('2024-03-17').weekday, 'Sunday')
35 def test_Day_neighbor_dates(self) -> None:
36 """Test Day.prev_date and Day.next_date."""
37 self.assertEqual(Day('2024-01-01').prev_date, '2023-12-31')
38 self.assertEqual(Day('2023-02-28').next_date, '2023-03-01')
41 class TestsWithDB(TestCaseWithDB):
42 """Tests requiring DB, but not server setup."""
44 def check_storage(self, content: list[Day]) -> None:
45 """Test cache and DB equal content."""
48 expected_cache[item.id_] = item
49 self.assertEqual(Day.get_cache(), expected_cache)
50 db_found: list[Day] = []
52 assert isinstance(item.id_, str)
53 for row in self.db_conn.row_where(Day.table_name, 'id', item.id_):
54 db_found += [Day.from_table_row(self.db_conn, row)]
55 self.assertEqual(sorted(content), sorted(db_found))
57 def test_Day_saving_and_caching(self) -> None:
58 """Test .save/.save_core."""
61 day = Day(date, comment)
62 # check object init itself doesn't store anything yet
63 self.check_storage([])
64 # check saving stores in cache and DB
65 day.save(self.db_conn)
66 self.check_storage([day])
67 # check attributes set properly (and not unset by saving)
68 self.assertEqual(day.id_, date)
69 self.assertEqual(day.comment, comment)
71 def test_Day_from_table_row(self) -> None:
72 """Test .from_table_row() properly reads in class from DB"""
73 day = Day('2024-01-01')
74 day.save(self.db_conn)
75 assert isinstance(day.id_, str)
76 for row in self.db_conn.row_where(Day.table_name, 'id', day.id_):
77 retrieved = Day.from_table_row(self.db_conn, row)
78 self.assertEqual(day, retrieved)
79 self.assertEqual({day.id_: day}, Day.get_cache())
81 def test_Day_by_id(self) -> None:
85 # check failure if not yet saved
87 with self.assertRaises(NotFoundException):
88 Day.by_id(self.db_conn, date1)
89 # check identity of saved and retrieved
90 day1.save(self.db_conn)
91 self.assertEqual(day1, Day.by_id(self.db_conn, date1))
92 # check create=True acts like normal instantiation (sans saving)
93 by_id_created = Day.by_id(self.db_conn, date2, create=True)
94 self.assertEqual(Day(date2), by_id_created)
95 self.check_storage([day1])
97 def test_Day_all(self) -> None:
98 """Test Day.all(), especially in regards to date range filtering."""
105 # check pre-save .all() returns empty list
106 self.assertEqual(Day.all(self.db_conn), [])
107 # check that all() shows all saved, but no unsaved items
108 day1.save(self.db_conn)
109 day3.save(self.db_conn)
110 self.assertEqual(Day.all(self.db_conn),
112 day2.save(self.db_conn)
113 self.assertEqual(Day.all(self.db_conn),
115 # check empty date range values show everything
116 self.assertEqual(Day.all(self.db_conn, ('', '')),
118 # check date range is a closed interval
119 self.assertEqual(Day.all(self.db_conn, (date1, date3)),
121 # check first date range value excludes what's earlier
122 self.assertEqual(Day.all(self.db_conn, (date2, date3)),
124 self.assertEqual(Day.all(self.db_conn, (date3, '')),
126 # check second date range value excludes what's later
127 self.assertEqual(Day.all(self.db_conn, ('', date2)),
129 # check swapped (impossible) date range returns emptiness
130 self.assertEqual(Day.all(self.db_conn, (date3, date1)),
132 # check fill_gaps= instantiates unsaved dates within date range
133 # (but does not store them)
134 day4 = Day('2024-01-04')
135 day5 = Day('2024-01-05')
136 day6 = Day('2024-01-06')
137 day6.save(self.db_conn)
138 self.assertEqual(Day.all(self.db_conn, (date2, '2024-01-07'),
140 [day2, day3, day4, day5, day6])
141 self.check_storage([day1, day2, day3, day6])
142 # check 'today' is interpreted as today's date
143 today = Day(todays_date())
144 today.save(self.db_conn)
145 self.assertEqual(Day.all(self.db_conn, ('today', 'today')), [today])
147 def test_Day_remove(self) -> None:
148 """Test .remove() effects on DB and cache."""
151 with self.assertRaises(HandledException):
152 day.remove(self.db_conn)
153 day.save(self.db_conn)
154 day.remove(self.db_conn)
155 self.check_storage([])
157 def test_Day_singularity(self) -> None:
158 """Test pointers made for single object keep pointing to it."""
159 day = Day('2024-01-01')
160 day.save(self.db_conn)
161 retrieved_day = Day.by_id(self.db_conn, '2024-01-01')
163 self.assertEqual(retrieved_day.comment, 'foo')
166 class TestsWithServer(TestCaseWithServer):
167 """Tests against our HTTP server/handler (and database)."""
169 def test_do_GET(self) -> None:
170 """Test /day and /calendar response codes, and / redirect."""
171 self.check_get('/day', 200)
172 self.check_get('/day?date=3000-01-01', 200)
173 self.check_get('/day?date=FOO', 400)
174 self.check_get('/calendar', 200)
175 self.check_get('/calendar?start=&end=', 200)
176 self.check_get('/calendar?start=today&end=today', 200)
177 self.check_get('/calendar?start=2024-01-01&end=2025-01-01', 200)
178 self.check_get('/calendar?start=foo', 400)
180 def test_do_POST_day(self) -> None:
181 """Test POST /day."""
182 form_data = {'comment': ''}
183 self.check_post(form_data, '/day', 400)
184 self.check_post(form_data, '/day?date=foo', 400)
185 self.check_post(form_data, '/day?date=2024-01-01', 302)
186 self.check_post({'foo': ''}, '/day?date=2024-01-01', 400)