1 """Test Todos module."""
2 from tests.utils import TestCaseWithDB, TestCaseWithServer
3 from plomtask.todos import Todo, TodoStepsNode
4 from plomtask.processes import Process
5 from plomtask.conditions import Condition
6 from plomtask.exceptions import (NotFoundException, BadFormatException,
10 class TestsWithDB(TestCaseWithDB):
11 """Tests requiring DB, but not server setup."""
13 def setUp(self) -> None:
15 self.date1 = '2024-01-01'
16 self.date2 = '2024-01-02'
17 self.proc = Process(None)
18 self.proc.save(self.db_conn)
19 self.cond1 = Condition(None)
20 self.cond1.save(self.db_conn)
21 self.cond2 = Condition(None)
22 self.cond2.save(self.db_conn)
24 def test_Todo_by_id(self) -> None:
25 """Test creation and findability of Todos."""
26 process_unsaved = Process(None)
27 todo = Todo(None, process_unsaved, False, self.date1)
28 with self.assertRaises(NotFoundException):
29 todo.save(self.db_conn)
30 process_unsaved.save(self.db_conn)
31 todo.save(self.db_conn)
32 self.assertEqual(Todo.by_id(self.db_conn, 1), todo)
33 with self.assertRaises(NotFoundException):
34 self.assertEqual(Todo.by_id(self.db_conn, 0), todo)
35 with self.assertRaises(NotFoundException):
36 self.assertEqual(Todo.by_id(self.db_conn, 2), todo)
38 def test_Todo_by_date(self) -> None:
39 """Test findability of Todos by date."""
40 t1 = Todo(None, self.proc, False, self.date1)
42 t2 = Todo(None, self.proc, False, self.date1)
44 self.assertEqual(Todo.by_date(self.db_conn, self.date1), [t1, t2])
45 self.assertEqual(Todo.by_date(self.db_conn, self.date2), [])
46 self.assertEqual(Todo.by_date(self.db_conn, 'foo'), [])
48 def test_Todo_from_process(self) -> None:
49 """Test spawning of Todo attributes from Process."""
50 assert isinstance(self.cond1.id_, int)
51 assert isinstance(self.cond2.id_, int)
52 self.proc.set_conditions(self.db_conn, [self.cond1.id_])
53 todo = Todo(None, self.proc, False, self.date1)
54 self.assertEqual(todo.conditions, [self.cond1])
55 todo.set_conditions(self.db_conn, [self.cond2.id_])
56 self.assertEqual(todo.conditions, [self.cond2])
57 self.assertEqual(self.proc.conditions, [self.cond1])
58 self.proc.set_enables(self.db_conn, [self.cond1.id_])
59 todo = Todo(None, self.proc, False, self.date1)
60 self.assertEqual(todo.enables, [self.cond1])
61 todo.set_enables(self.db_conn, [self.cond2.id_])
62 self.assertEqual(todo.enables, [self.cond2])
63 self.assertEqual(self.proc.enables, [self.cond1])
64 self.proc.set_disables(self.db_conn, [self.cond1.id_])
65 todo = Todo(None, self.proc, False, self.date1)
66 self.assertEqual(todo.disables, [self.cond1])
67 todo.set_disables(self.db_conn, [self.cond2.id_])
68 self.assertEqual(todo.disables, [self.cond2])
69 self.assertEqual(self.proc.disables, [self.cond1])
71 def test_Todo_on_conditions(self) -> None:
72 """Test effect of Todos on Conditions."""
73 assert isinstance(self.cond1.id_, int)
74 assert isinstance(self.cond2.id_, int)
75 todo = Todo(None, self.proc, False, self.date1)
76 todo.save(self.db_conn)
77 todo.set_enables(self.db_conn, [self.cond1.id_])
78 todo.set_disables(self.db_conn, [self.cond2.id_])
80 self.assertEqual(self.cond1.is_active, True)
81 self.assertEqual(self.cond2.is_active, False)
83 self.assertEqual(self.cond1.is_active, True)
84 self.assertEqual(self.cond2.is_active, False)
86 def test_Todo_enablers_disablers(self) -> None:
87 """Test Todo.enablers_for_at/disablers_for_at."""
88 assert isinstance(self.cond1.id_, int)
89 assert isinstance(self.cond2.id_, int)
90 todo1 = Todo(None, self.proc, False, self.date1)
91 todo1.save(self.db_conn)
92 todo1.set_enables(self.db_conn, [self.cond1.id_])
93 todo1.set_disables(self.db_conn, [self.cond2.id_])
94 todo1.save(self.db_conn)
95 todo2 = Todo(None, self.proc, False, self.date1)
96 todo2.save(self.db_conn)
97 todo2.set_enables(self.db_conn, [self.cond2.id_])
98 todo2.save(self.db_conn)
99 todo3 = Todo(None, self.proc, False, self.date2)
100 todo3.save(self.db_conn)
101 todo3.set_enables(self.db_conn, [self.cond2.id_])
102 todo3.save(self.db_conn)
103 enablers = Todo.enablers_for_at(self.db_conn, self.cond1, self.date1)
104 self.assertEqual(enablers, [todo1])
105 enablers = Todo.enablers_for_at(self.db_conn, self.cond1, self.date2)
106 self.assertEqual(enablers, [])
107 disablers = Todo.disablers_for_at(self.db_conn, self.cond1, self.date1)
108 self.assertEqual(disablers, [])
109 disablers = Todo.disablers_for_at(self.db_conn, self.cond1, self.date2)
110 self.assertEqual(disablers, [])
111 enablers = Todo.enablers_for_at(self.db_conn, self.cond2, self.date1)
112 self.assertEqual(enablers, [todo2])
113 enablers = Todo.enablers_for_at(self.db_conn, self.cond2, self.date2)
114 self.assertEqual(enablers, [todo3])
115 disablers = Todo.disablers_for_at(self.db_conn, self.cond2, self.date1)
116 self.assertEqual(disablers, [todo1])
117 disablers = Todo.disablers_for_at(self.db_conn, self.cond2, self.date2)
118 self.assertEqual(disablers, [])
120 def test_Todo_children(self) -> None:
121 """Test Todo.children relations."""
122 todo_1 = Todo(None, self.proc, False, self.date1)
123 todo_2 = Todo(None, self.proc, False, self.date1)
124 todo_2.save(self.db_conn)
125 with self.assertRaises(HandledException):
126 todo_1.add_child(todo_2)
127 todo_1.save(self.db_conn)
128 todo_3 = Todo(None, self.proc, False, self.date1)
129 with self.assertRaises(HandledException):
130 todo_1.add_child(todo_3)
131 todo_3.save(self.db_conn)
132 todo_1.add_child(todo_3)
133 todo_1.save(self.db_conn)
134 assert isinstance(todo_1.id_, int)
135 todo_retrieved = Todo.by_id(self.db_conn, todo_1.id_)
136 self.assertEqual(todo_retrieved.children, [todo_3])
137 with self.assertRaises(BadFormatException):
138 todo_3.add_child(todo_1)
140 def test_Todo_conditioning(self) -> None:
141 """Test Todo.doability conditions."""
142 assert isinstance(self.cond1.id_, int)
143 todo_1 = Todo(None, self.proc, False, self.date1)
144 todo_1.save(self.db_conn)
145 todo_2 = Todo(None, self.proc, False, self.date1)
146 todo_2.save(self.db_conn)
147 todo_2.add_child(todo_1)
148 with self.assertRaises(BadFormatException):
149 todo_2.is_done = True
150 todo_1.is_done = True
151 todo_2.is_done = True
152 todo_2.is_done = False
153 todo_2.set_conditions(self.db_conn, [self.cond1.id_])
154 with self.assertRaises(BadFormatException):
155 todo_2.is_done = True
156 self.cond1.is_active = True
157 todo_2.is_done = True
159 def test_Todo_step_tree(self) -> None:
160 """Test self-configuration of TodoStepsNode tree for Day view."""
161 assert isinstance(self.cond1.id_, int)
162 assert isinstance(self.cond2.id_, int)
163 todo_1 = Todo(None, self.proc, False, self.date1)
164 todo_1.save(self.db_conn)
165 assert isinstance(todo_1.id_, int)
167 tree_expected = TodoStepsNode(todo_1, True, [], False)
168 self.assertEqual(todo_1.get_step_tree(set(), set()), tree_expected)
169 # test non_emtpy seen_todo does something
170 tree_expected = TodoStepsNode(todo_1, True, [], True)
171 self.assertEqual(todo_1.get_step_tree({todo_1.id_}, set()),
173 # test child shows up
174 todo_2 = Todo(None, self.proc, False, self.date1)
175 todo_2.save(self.db_conn)
176 assert isinstance(todo_2.id_, int)
177 todo_1.add_child(todo_2)
178 node_todo_2 = TodoStepsNode(todo_2, True, [], False)
179 tree_expected = TodoStepsNode(todo_1, True, [node_todo_2], False)
180 self.assertEqual(todo_1.get_step_tree(set(), set()), tree_expected)
181 # test child shows up with child
182 todo_3 = Todo(None, self.proc, False, self.date1)
183 todo_3.save(self.db_conn)
184 assert isinstance(todo_3.id_, int)
185 todo_2.add_child(todo_3)
186 node_todo_3 = TodoStepsNode(todo_3, True, [], False)
187 node_todo_2 = TodoStepsNode(todo_2, True, [node_todo_3], False)
188 tree_expected = TodoStepsNode(todo_1, True, [node_todo_2], False)
189 self.assertEqual(todo_1.get_step_tree(set(), set()), tree_expected)
190 # test same todo can be child-ed multiple times at different locations
191 todo_1.add_child(todo_3)
192 node_todo_4 = TodoStepsNode(todo_3, True, [], True)
193 tree_expected = TodoStepsNode(todo_1, True,
194 [node_todo_2, node_todo_4], False)
195 self.assertEqual(todo_1.get_step_tree(set(), set()), tree_expected)
196 # test condition shows up
197 todo_1.set_conditions(self.db_conn, [self.cond1.id_])
198 node_cond_1 = TodoStepsNode(self.cond1, False, [], False)
199 tree_expected = TodoStepsNode(todo_1, True,
200 [node_todo_2, node_todo_4, node_cond_1],
202 self.assertEqual(todo_1.get_step_tree(set(), set()), tree_expected)
203 # test second condition shows up
204 todo_2.set_conditions(self.db_conn, [self.cond2.id_])
205 node_cond_2 = TodoStepsNode(self.cond2, False, [], False)
206 node_todo_2 = TodoStepsNode(todo_2, True,
207 [node_todo_3, node_cond_2], False)
208 tree_expected = TodoStepsNode(todo_1, True,
209 [node_todo_2, node_todo_4, node_cond_1],
211 self.assertEqual(todo_1.get_step_tree(set(), set()), tree_expected)
212 # test second condition is not hidden if fulfilled by non-sibling
213 todo_1.set_enables(self.db_conn, [self.cond2.id_])
214 self.assertEqual(todo_1.get_step_tree(set(), set()), tree_expected)
215 # test second condition is hidden if fulfilled by sibling
216 todo_3.set_enables(self.db_conn, [self.cond2.id_])
217 node_todo_2 = TodoStepsNode(todo_2, True, [node_todo_3], False)
218 tree_expected = TodoStepsNode(todo_1, True,
219 [node_todo_2, node_todo_4, node_cond_1],
221 self.assertEqual(todo_1.get_step_tree(set(), set()), tree_expected)
223 def test_Todo_singularity(self) -> None:
224 """Test pointers made for single object keep pointing to it."""
225 todo = Todo(None, self.proc, False, self.date1)
226 todo.save(self.db_conn)
227 retrieved_todo = Todo.by_id(self.db_conn, 1)
229 self.assertEqual(retrieved_todo.is_done, True)
230 retrieved_todo = Todo.by_date(self.db_conn, self.date1)[0]
231 retrieved_todo.is_done = False
232 self.assertEqual(todo.is_done, False)
235 class TestsWithServer(TestCaseWithServer):
236 """Tests against our HTTP server/handler (and database)."""
238 def test_do_POST_day(self) -> None:
239 """Test Todo posting of POST /day."""
240 form_data = {'title': '', 'description': '', 'effort': 1}
241 self.check_post(form_data, '/process?id=', 302, '/')
242 self.check_post(form_data, '/process?id=', 302, '/')
243 proc = Process.by_id(self.db_conn, 1)
244 proc2 = Process.by_id(self.db_conn, 2)
245 form_data = {'comment': ''}
246 self.check_post(form_data, '/day?date=2024-01-01', 302, '/')
247 self.assertEqual(Todo.by_date(self.db_conn, '2024-01-01'), [])
248 form_data['new_todo'] = str(proc.id_)
249 self.check_post(form_data, '/day?date=2024-01-01', 302, '/')
250 todos = Todo.by_date(self.db_conn, '2024-01-01')
251 self.assertEqual(1, len(todos))
253 self.assertEqual(todo1.id_, 1)
254 self.assertEqual(todo1.process.id_, proc.id_)
255 self.assertEqual(todo1.is_done, False)
256 form_data['new_todo'] = str(proc2.id_)
257 self.check_post(form_data, '/day?date=2024-01-01', 302, '/')
258 todos = Todo.by_date(self.db_conn, '2024-01-01')
260 self.assertEqual(todo1.id_, 2)
261 self.assertEqual(todo1.process.id_, proc2.id_)
262 self.assertEqual(todo1.is_done, False)
264 def test_do_POST_todo(self) -> None:
265 """Test POST /todo."""
266 def post_and_reload(form_data: dict[str, object],
267 status: int = 302) -> Todo:
268 self.check_post(form_data, '/todo?id=1', status, '/')
269 self.db_conn.cached_todos = {}
270 return Todo.by_date(self.db_conn, '2024-01-01')[0]
272 form_data = {'title': '', 'description': '', 'effort': 1}
273 self.check_post(form_data, '/process', 302)
274 form_data = {'comment': '', 'new_todo': 1}
275 self.check_post(form_data, '/day?date=2024-01-01', 302)
276 # test posting to bad URLs
278 self.check_post(form_data, '/todo=', 404)
279 self.check_post(form_data, '/todo?id=', 400)
280 self.check_post(form_data, '/todo?id=FOO', 400)
281 self.check_post(form_data, '/todo?id=0', 404)
282 # test posting naked entity
283 todo1 = post_and_reload(form_data)
284 self.assertEqual(todo1.children, [])
285 self.assertEqual(todo1.parents, [])
286 self.assertEqual(todo1.is_done, False)
287 # test posting doneness
288 form_data = {'done': ''}
289 todo1 = post_and_reload(form_data)
290 self.assertEqual(todo1.is_done, True)
291 # test implicitly posting non-doneness
293 todo1 = post_and_reload(form_data)
294 self.assertEqual(todo1.is_done, False)
295 # test malformed adoptions
296 form_data = {'adopt': 'foo'}
297 self.check_post(form_data, '/todo?id=1', 400)
298 form_data = {'adopt': 1}
299 self.check_post(form_data, '/todo?id=1', 400)
300 form_data = {'adopt': 2}
301 self.check_post(form_data, '/todo?id=1', 404)
302 # test posting second todo of same process
303 form_data = {'comment': '', 'new_todo': 1}
304 self.check_post(form_data, '/day?date=2024-01-01', 302)
305 # test todo 1 adopting todo 2
306 form_data = {'adopt': 2}
307 todo1 = post_and_reload(form_data)
308 todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
309 self.assertEqual(todo1.children, [todo2])
310 self.assertEqual(todo1.parents, [])
311 self.assertEqual(todo2.children, [])
312 self.assertEqual(todo2.parents, [todo1])
313 # test todo1 cannot be set done with todo2 not done yet
314 form_data = {'done': '', 'adopt': 2}
315 todo1 = post_and_reload(form_data, 400)
316 self.assertEqual(todo1.is_done, False)
317 # test todo1 un-adopting todo 2 by just not sending an adopt
319 todo1 = post_and_reload(form_data, 302)
320 todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
321 self.assertEqual(todo1.children, [])
322 self.assertEqual(todo1.parents, [])
323 self.assertEqual(todo2.children, [])
324 self.assertEqual(todo2.parents, [])
326 def test_do_GET_todo(self) -> None:
327 """Test GET /todo response codes."""
328 form_data = {'title': '', 'description': '', 'effort': 1}
329 self.check_post(form_data, '/process?id=', 302, '/')
330 form_data = {'comment': '', 'new_todo': 1}
331 self.check_post(form_data, '/day?date=2024-01-01', 302, '/')
332 self.check_get('/todo', 400)
333 self.check_get('/todo?id=', 400)
334 self.check_get('/todo?id=foo', 400)
335 self.check_get('/todo?id=0', 404)
336 self.check_get('/todo?id=1', 200)