home · contact · privacy
Split BaseModel.by_id into .by_id and by_id_or_create, refactor tests.
[plomtask] / tests / days.py
1 """Test Days module."""
2 from unittest import TestCase
3 from datetime import datetime
4 from json import loads as json_loads
5 from tests.utils import TestCaseWithDB, TestCaseWithServer
6 from plomtask.dating import date_in_n_days
7 from plomtask.days import Day
8 from plomtask.exceptions import BadFormatException
9
10
11 class TestsSansDB(TestCase):
12     """Days module tests not requiring DB setup."""
13
14     def test_Day_valid_date(self) -> None:
15         """Test Day's date format validation and parsing."""
16         with self.assertRaises(BadFormatException):
17             Day('foo')
18         with self.assertRaises(BadFormatException):
19             Day('2024-02-30')
20         with self.assertRaises(BadFormatException):
21             Day('2024-02-01 23:00:00')
22         self.assertEqual(datetime(2024, 1, 1), Day('2024-01-01').datetime)
23
24     def test_Day_sorting(self) -> None:
25         """Test sorting by .__lt__ and Day.__eq__."""
26         day1 = Day('2024-01-01')
27         day2 = Day('2024-01-02')
28         day3 = Day('2024-01-03')
29         days = [day3, day1, day2]
30         self.assertEqual(sorted(days), [day1, day2, day3])
31
32     def test_Day_weekday(self) -> None:
33         """Test Day.weekday."""
34         self.assertEqual(Day('2024-03-17').weekday, 'Sunday')
35
36     def test_Day_neighbor_dates(self) -> None:
37         """Test Day.prev_date and Day.next_date."""
38         self.assertEqual(Day('2024-01-01').prev_date, '2023-12-31')
39         self.assertEqual(Day('2023-02-28').next_date, '2023-03-01')
40
41
42 class TestsWithDB(TestCaseWithDB):
43     """Tests requiring DB, but not server setup."""
44     checked_class = Day
45     default_ids = ('2024-01-01', '2024-01-02', '2024-01-03')
46
47     def test_saving_and_caching(self) -> None:
48         """Test storage of instances.
49
50         We don't use the parent class's method here because the checked class
51         has too different a handling of IDs.
52         """
53         kwargs = {'date': self.default_ids[0], 'comment': 'foo'}
54         self.check_saving_and_caching(**kwargs)
55
56     def test_Day_by_date_range_filled(self) -> None:
57         """Test Day.by_date_range_filled."""
58         date1, date2, date3 = self.default_ids
59         day1 = Day(date1)
60         day2 = Day(date2)
61         day3 = Day(date3)
62         day1.save(self.db_conn)
63         day2.save(self.db_conn)
64         day3.save(self.db_conn)
65         # check date range is a closed interval
66         self.assertEqual(Day.by_date_range_filled(self.db_conn, date1, date3),
67                          [day1, day2, day3])
68         # check first date range value excludes what's earlier
69         self.assertEqual(Day.by_date_range_filled(self.db_conn, date2, date3),
70                          [day2, day3])
71         # check second date range value excludes what's later
72         self.assertEqual(Day.by_date_range_filled(self.db_conn, date1, date2),
73                          [day1, day2])
74         # check swapped (impossible) date range returns emptiness
75         self.assertEqual(Day.by_date_range_filled(self.db_conn, date3, date1),
76                          [])
77         # check fill_gaps= instantiates unsaved dates within date range
78         # (but does not store them)
79         day5 = Day('2024-01-05')
80         day6 = Day('2024-01-06')
81         day6.save(self.db_conn)
82         day7 = Day('2024-01-07')
83         self.assertEqual(Day.by_date_range_filled(self.db_conn,
84                                                   day5.date, day7.date),
85                          [day5, day6, day7])
86         self.check_identity_with_cache_and_db([day1, day2, day3, day6])
87         # check 'today' is interpreted as today's date
88         today = Day(date_in_n_days(0))
89         today.save(self.db_conn)
90         self.assertEqual(Day.by_date_range_filled(self.db_conn,
91                                                   'today', 'today'),
92                          [today])
93
94     def test_Day_remove(self) -> None:
95         """Test .remove() effects on DB and cache."""
96         self.check_remove()
97
98
99 class TestsWithServer(TestCaseWithServer):
100     """Tests against our HTTP server/handler (and database)."""
101
102     def test_get_json(self) -> None:
103         """Test /day for JSON response."""
104         self.conn.request('GET', '/day?date=2024-01-01')
105         response = self.conn.getresponse()
106         self.assertEqual(response.status, 200)
107         expected = {'day': {'id': '2024-01-01',
108                             'comment': '',
109                             'todos': []},
110                     'top_nodes': [],
111                     'make_type': '',
112                     'enablers_for': {},
113                     'disablers_for': {},
114                     'conditions_present': [],
115                     'processes': []}
116         retrieved = json_loads(response.read().decode())
117         self.assertEqual(expected, retrieved)
118
119     def test_do_GET(self) -> None:
120         """Test /day and /calendar response codes, and / redirect."""
121         self.check_get('/day', 200)
122         self.check_get('/day?date=3000-01-01', 200)
123         self.check_get('/day?date=FOO', 400)
124         self.check_get('/calendar', 200)
125         self.check_get('/calendar?start=&end=', 200)
126         self.check_get('/calendar?start=today&end=today', 200)
127         self.check_get('/calendar?start=2024-01-01&end=2025-01-01', 200)
128         self.check_get('/calendar?start=foo', 400)
129
130     def test_do_POST_day(self) -> None:
131         """Test POST /day."""
132         form_data = {'day_comment': '', 'make_type': 'full'}
133         self.check_post(form_data, '/day', 400)
134         self.check_post(form_data, '/day?date=foo', 400)
135         self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
136         self.check_post({'foo': ''}, '/day?date=2024-01-01', 400)