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
9 class TestsSansDB(TestCase):
10 """Days module tests not requiring DB setup."""
12 def test_Day_valid_date(self) -> None:
13 """Test Day's date format validation and parsing."""
14 with self.assertRaises(BadFormatException):
16 with self.assertRaises(BadFormatException):
18 with self.assertRaises(BadFormatException):
19 Day('2024-02-01 23:00:00')
20 self.assertEqual(datetime(2024, 1, 1), Day('2024-01-01').datetime)
22 def test_Day_sorting(self) -> None:
23 """Test sorting by .__lt__ and Day.__eq__."""
24 day1 = Day('2024-01-01')
25 day2 = Day('2024-01-02')
26 day3 = Day('2024-01-03')
27 days = [day3, day1, day2]
28 self.assertEqual(sorted(days), [day1, day2, day3])
30 def test_Day_weekday(self) -> None:
31 """Test Day.weekday."""
32 self.assertEqual(Day('2024-03-17').weekday, 'Sunday')
34 def test_Day_neighbor_dates(self) -> None:
35 """Test Day.prev_date and Day.next_date."""
36 self.assertEqual(Day('2024-01-01').prev_date, '2023-12-31')
37 self.assertEqual(Day('2023-02-28').next_date, '2023-03-01')
40 class TestsWithDB(TestCaseWithDB):
41 """Tests requiring DB, but not server setup."""
43 def test_Day_saving_and_caching(self) -> None:
44 """Test .save/.save_core."""
47 day = Day(date, comment)
48 # check object init itself doesn't store anything yet
49 self.assertEqual({}, Day.get_cache())
50 self.assertEqual([], Day.all(self.db_conn))
51 # check saving stores in cache and DB
52 day.save(self.db_conn)
53 assert isinstance(day.id_, str)
54 for row in self.db_conn.row_where(Day.table_name, 'id', day.id_):
55 self.assertEqual(day, Day.from_table_row(self.db_conn, row))
56 self.assertEqual({day.id_: day}, Day.get_cache())
57 # check attributes set properly (and not unset by saving)
58 self.assertEqual(day.id_, date)
59 self.assertEqual(day.comment, comment)
61 def test_Day_by_id(self) -> None:
65 # check failure if not yet saved
67 with self.assertRaises(NotFoundException):
68 Day.by_id(self.db_conn, date1)
69 # check identity of saved and retrieved
70 day1.save(self.db_conn)
71 self.assertEqual(day1, Day.by_id(self.db_conn, date1))
72 # check create=True acts like normal instantiation (sans saving)
73 by_id_created = Day.by_id(self.db_conn, date2, create=True)
74 self.assertEqual(Day(date2), by_id_created)
75 self.assertEqual({day1.id_: day1}, Day.get_cache())
76 self.assertEqual([day1], Day.all(self.db_conn))
78 def test_Day_all(self) -> None:
79 """Test Day.all(), especially in regards to date range filtering."""
86 day1.save(self.db_conn)
87 day3.save(self.db_conn)
88 # check that all() shows all saved, but no unsaved items
89 self.assertEqual(Day.all(self.db_conn),
91 day2.save(self.db_conn)
92 self.assertEqual(Day.all(self.db_conn),
94 # check empty date range values show everything
95 self.assertEqual(Day.all(self.db_conn, ('', '')),
97 # check date range is open interval
98 self.assertEqual(Day.all(self.db_conn, (date1, date3)),
100 # check first date range value excludes what's earlier
101 self.assertEqual(Day.all(self.db_conn, (date2, date3)),
103 self.assertEqual(Day.all(self.db_conn, (date3, '')),
105 # check second date range value excludes what's later
106 self.assertEqual(Day.all(self.db_conn, ('', date2)),
108 # check swapped (impossible) date range returns emptiness
109 self.assertEqual(Day.all(self.db_conn, (date3, date1)),
111 # check fill_gaps= instantiates unsaved dates within date range
112 # (but does not store them)
113 day4 = Day('2024-01-04')
114 day5 = Day('2024-01-05')
115 day6 = Day('2024-01-06')
116 day6.save(self.db_conn)
117 self.assertEqual(Day.all(self.db_conn, (date2, '2024-01-07'),
119 [day2, day3, day4, day5, day6])
120 self.assertEqual(Day.get_cache().keys(),
121 {date1, date2, date3, day6.date})
122 assert isinstance(day4.id_, str)
123 assert isinstance(day5.id_, str)
124 self.assertEqual(self.db_conn.row_where(Day.table_name,
126 self.assertEqual(self.db_conn.row_where(Day.table_name,
128 # check 'today' is interpreted as today's date
129 today = Day(todays_date())
130 today.save(self.db_conn)
131 self.assertEqual(Day.all(self.db_conn, ('today', 'today')), [today])
133 def test_Day_remove(self) -> None:
134 """Test .remove() effects on DB and cache."""
137 day.save(self.db_conn)
138 day.remove(self.db_conn)
139 assert isinstance(day.id_, str)
140 self.assertEqual(self.db_conn.row_where(Day.table_name,
142 self.assertEqual(Day.get_cache(), {})
144 def test_Day_singularity(self) -> None:
145 """Test pointers made for single object keep pointing to it."""
146 day = Day('2024-01-01')
147 day.save(self.db_conn)
148 retrieved_day = Day.by_id(self.db_conn, '2024-01-01')
150 self.assertEqual(retrieved_day.comment, 'foo')
153 class TestsWithServer(TestCaseWithServer):
154 """Tests against our HTTP server/handler (and database)."""
156 def test_do_GET(self) -> None:
157 """Test /day and /calendar response codes, and / redirect."""
158 self.check_get('/day', 200)
159 self.check_get('/day?date=3000-01-01', 200)
160 self.check_get('/day?date=FOO', 400)
161 self.check_get('/calendar', 200)
162 self.check_get('/calendar?start=&end=', 200)
163 self.check_get('/calendar?start=today&end=today', 200)
164 self.check_get('/calendar?start=2024-01-01&end=2025-01-01', 200)
165 self.check_get('/calendar?start=foo', 400)
167 def test_do_POST_day(self) -> None:
168 """Test POST /day."""
169 form_data = {'comment': ''}
170 self.check_post(form_data, '/day', 400)
171 self.check_post(form_data, '/day?date=foo', 400)
172 self.check_post(form_data, '/day?date=2024-01-01', 302)
173 self.check_post({'foo': ''}, '/day?date=2024-01-01', 400)