1 """Test Todos module."""
2 from tests.utils import TestCaseSansDB, TestCaseWithDB, TestCaseWithServer
3 from plomtask.todos import Todo, TodoNode
4 from plomtask.processes import Process, ProcessStep
5 from plomtask.conditions import Condition
6 from plomtask.exceptions import (NotFoundException, BadFormatException,
10 class TestsWithDB(TestCaseWithDB, TestCaseSansDB):
11 """Tests requiring DB, but not server setup.
13 NB: We subclass TestCaseSansDB too, to pull in its .test_id_setting, which
14 for Todo wouldn't run without a DB being set up due to the need for
15 Processes with set IDs.
18 default_init_kwargs = {'process': None, 'is_done': False,
20 # solely used for TestCaseSansDB.test_id_setting
21 default_init_args = [None, False, '2024-01-01']
24 def setUp(self) -> None:
26 self.date1 = '2024-01-01'
27 self.date2 = '2024-01-02'
28 self.proc = Process(None)
29 self.proc.save(self.db_conn)
30 self.cond1 = Condition(None)
31 self.cond1.save(self.db_conn)
32 self.cond2 = Condition(None)
33 self.cond2.save(self.db_conn)
34 self.default_init_kwargs['process'] = self.proc
35 self.default_init_args[0] = self.proc
37 def test_Todo_init(self) -> None:
38 """Test creation of Todo and what they default to."""
39 process = Process(None)
40 with self.assertRaises(NotFoundException):
41 Todo(None, process, False, self.date1)
42 process.save(self.db_conn)
43 assert isinstance(self.cond1.id_, int)
44 assert isinstance(self.cond2.id_, int)
45 process.set_conditions(self.db_conn, [self.cond1.id_, self.cond2.id_])
46 process.set_enables(self.db_conn, [self.cond1.id_])
47 process.set_disables(self.db_conn, [self.cond2.id_])
48 todo_no_id = Todo(None, process, False, self.date1)
49 self.assertEqual(todo_no_id.conditions, [self.cond1, self.cond2])
50 self.assertEqual(todo_no_id.enables, [self.cond1])
51 self.assertEqual(todo_no_id.disables, [self.cond2])
52 todo_yes_id = Todo(5, process, False, self.date1)
53 self.assertEqual(todo_yes_id.conditions, [])
54 self.assertEqual(todo_yes_id.enables, [])
55 self.assertEqual(todo_yes_id.disables, [])
57 def test_Todo_by_id(self) -> None:
58 """Test findability of Todos."""
59 todo = Todo(1, self.proc, False, self.date1)
60 todo.save(self.db_conn)
61 self.assertEqual(Todo.by_id(self.db_conn, 1), todo)
62 with self.assertRaises(NotFoundException):
63 Todo.by_id(self.db_conn, 0)
64 with self.assertRaises(NotFoundException):
65 Todo.by_id(self.db_conn, 2)
67 def test_Todo_by_date(self) -> None:
68 """Test findability of Todos by date."""
69 t1 = Todo(None, self.proc, False, self.date1)
71 t2 = Todo(None, self.proc, False, self.date1)
73 self.assertEqual(Todo.by_date(self.db_conn, self.date1), [t1, t2])
74 self.assertEqual(Todo.by_date(self.db_conn, self.date2), [])
75 with self.assertRaises(BadFormatException):
76 self.assertEqual(Todo.by_date(self.db_conn, 'foo'), [])
78 def test_Todo_on_conditions(self) -> None:
79 """Test effect of Todos on Conditions."""
80 assert isinstance(self.cond1.id_, int)
81 assert isinstance(self.cond2.id_, int)
82 todo = Todo(None, self.proc, False, self.date1)
83 todo.save(self.db_conn)
84 todo.set_enables(self.db_conn, [self.cond1.id_])
85 todo.set_disables(self.db_conn, [self.cond2.id_])
87 self.assertEqual(self.cond1.is_active, True)
88 self.assertEqual(self.cond2.is_active, False)
90 self.assertEqual(self.cond1.is_active, True)
91 self.assertEqual(self.cond2.is_active, False)
93 def test_Todo_children(self) -> None:
94 """Test Todo.children relations."""
95 todo_1 = Todo(None, self.proc, False, self.date1)
96 todo_2 = Todo(None, self.proc, False, self.date1)
97 todo_2.save(self.db_conn)
98 with self.assertRaises(HandledException):
99 todo_1.add_child(todo_2)
100 todo_1.save(self.db_conn)
101 todo_3 = Todo(None, self.proc, False, self.date1)
102 with self.assertRaises(HandledException):
103 todo_1.add_child(todo_3)
104 todo_3.save(self.db_conn)
105 todo_1.add_child(todo_3)
106 todo_1.save(self.db_conn)
107 assert isinstance(todo_1.id_, int)
108 todo_retrieved = Todo.by_id(self.db_conn, todo_1.id_)
109 self.assertEqual(todo_retrieved.children, [todo_3])
110 with self.assertRaises(BadFormatException):
111 todo_3.add_child(todo_1)
113 def test_Todo_conditioning(self) -> None:
114 """Test Todo.doability conditions."""
115 assert isinstance(self.cond1.id_, int)
116 todo_1 = Todo(None, self.proc, False, self.date1)
117 todo_1.save(self.db_conn)
118 todo_2 = Todo(None, self.proc, False, self.date1)
119 todo_2.save(self.db_conn)
120 todo_2.add_child(todo_1)
121 with self.assertRaises(BadFormatException):
122 todo_2.is_done = True
123 todo_1.is_done = True
124 todo_2.is_done = True
125 todo_2.is_done = False
126 todo_2.set_conditions(self.db_conn, [self.cond1.id_])
127 with self.assertRaises(BadFormatException):
128 todo_2.is_done = True
129 self.cond1.is_active = True
130 todo_2.is_done = True
132 def test_Todo_step_tree(self) -> None:
133 """Test self-configuration of TodoStepsNode tree for Day view."""
134 todo_1 = Todo(None, self.proc, False, self.date1)
135 todo_1.save(self.db_conn)
136 assert isinstance(todo_1.id_, int)
138 node_0 = TodoNode(todo_1, False, [])
139 self.assertEqual(todo_1.get_step_tree(set()), node_0)
140 # test non_emtpy seen_todo does something
142 self.assertEqual(todo_1.get_step_tree({todo_1.id_}), node_0)
143 # test child shows up
144 todo_2 = Todo(None, self.proc, False, self.date1)
145 todo_2.save(self.db_conn)
146 assert isinstance(todo_2.id_, int)
147 todo_1.add_child(todo_2)
148 node_2 = TodoNode(todo_2, False, [])
149 node_0.children = [node_2]
151 self.assertEqual(todo_1.get_step_tree(set()), node_0)
152 # test child shows up with child
153 todo_3 = Todo(None, self.proc, False, self.date1)
154 todo_3.save(self.db_conn)
155 assert isinstance(todo_3.id_, int)
156 todo_2.add_child(todo_3)
157 node_3 = TodoNode(todo_3, False, [])
158 node_2.children = [node_3]
159 self.assertEqual(todo_1.get_step_tree(set()), node_0)
160 # test same todo can be child-ed multiple times at different locations
161 todo_1.add_child(todo_3)
162 node_4 = TodoNode(todo_3, True, [])
163 node_0.children += [node_4]
164 self.assertEqual(todo_1.get_step_tree(set()), node_0)
166 def test_Todo_create_with_children(self) -> None:
167 """Test parenthood guaranteeds of Todo.create_with_children."""
168 assert isinstance(self.proc.id_, int)
169 proc2 = Process(None)
170 proc2.save(self.db_conn)
171 assert isinstance(proc2.id_, int)
172 proc3 = Process(None)
173 proc3.save(self.db_conn)
174 assert isinstance(proc3.id_, int)
175 proc4 = Process(None)
176 proc4.save(self.db_conn)
177 assert isinstance(proc4.id_, int)
178 # make proc4 step of proc3
179 step = ProcessStep(None, proc3.id_, proc4.id_, None)
180 proc3.set_steps(self.db_conn, [step])
181 # give proc2 three steps; 2× proc1, 1× proc3
182 step1 = ProcessStep(None, proc2.id_, self.proc.id_, None)
183 step2 = ProcessStep(None, proc2.id_, self.proc.id_, None)
184 step3 = ProcessStep(None, proc2.id_, proc3.id_, None)
185 proc2.set_steps(self.db_conn, [step1, step2, step3])
186 # test mere creation does nothing
187 todo_ignore = Todo(None, proc2, False, self.date1)
188 todo_ignore.save(self.db_conn)
189 self.assertEqual(todo_ignore.children, [])
190 # test create_with_children on step-less does nothing
191 todo_1 = Todo.create_with_children(self.db_conn, self.proc.id_,
193 self.assertEqual(todo_1.children, [])
194 self.assertEqual(len(Todo.all(self.db_conn)), 2)
195 # test create_with_children adopts and creates, and down tree too
196 todo_2 = Todo.create_with_children(self.db_conn, proc2.id_, self.date1)
197 self.assertEqual(3, len(todo_2.children))
198 self.assertEqual(todo_1, todo_2.children[0])
199 self.assertEqual(self.proc, todo_2.children[2].process)
200 self.assertEqual(proc3, todo_2.children[1].process)
201 todo_3 = todo_2.children[1]
202 self.assertEqual(len(todo_3.children), 1)
203 self.assertEqual(todo_3.children[0].process, proc4)
205 def test_Todo_remove(self) -> None:
207 todo_1 = Todo(None, self.proc, False, self.date1)
208 todo_1.save(self.db_conn)
209 assert todo_1.id_ is not None
210 todo_0 = Todo(None, self.proc, False, self.date1)
211 todo_0.save(self.db_conn)
212 todo_0.add_child(todo_1)
213 todo_2 = Todo(None, self.proc, False, self.date1)
214 todo_2.save(self.db_conn)
215 todo_1.add_child(todo_2)
216 todo_1_id = todo_1.id_
217 todo_1.remove(self.db_conn)
218 with self.assertRaises(NotFoundException):
219 Todo.by_id(self.db_conn, todo_1_id)
220 self.assertEqual(todo_0.children, [])
221 self.assertEqual(todo_2.parents, [])
222 todo_2.comment = 'foo'
223 with self.assertRaises(HandledException):
224 todo_2.remove(self.db_conn)
227 with self.assertRaises(HandledException):
228 todo_2.remove(self.db_conn)
230 def test_Todo_autoremoval(self) -> None:
231 """"Test automatic removal for Todo.effort < 0."""
232 todo_1 = Todo(None, self.proc, False, self.date1)
233 todo_1.save(self.db_conn)
234 todo_1.comment = 'foo'
236 todo_1.save(self.db_conn)
237 assert todo_1.id_ is not None
238 Todo.by_id(self.db_conn, todo_1.id_)
240 todo_1_id = todo_1.id_
241 todo_1.save(self.db_conn)
242 with self.assertRaises(NotFoundException):
243 Todo.by_id(self.db_conn, todo_1_id)
246 class TestsWithServer(TestCaseWithServer):
247 """Tests against our HTTP server/handler (and database)."""
249 def test_do_POST_day(self) -> None:
250 """Test Todo posting of POST /day."""
253 proc = Process.by_id(self.db_conn, 1)
254 proc2 = Process.by_id(self.db_conn, 2)
255 form_data = {'day_comment': '', 'make_type': 'full'}
256 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
257 self.assertEqual(Todo.by_date(self.db_conn, '2024-01-01'), [])
258 form_data['new_todo'] = str(proc.id_)
259 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
260 todos = Todo.by_date(self.db_conn, '2024-01-01')
261 self.assertEqual(1, len(todos))
263 self.assertEqual(todo1.id_, 1)
264 self.assertEqual(todo1.process.id_, proc.id_)
265 self.assertEqual(todo1.is_done, False)
266 form_data['new_todo'] = str(proc2.id_)
267 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
268 todos = Todo.by_date(self.db_conn, '2024-01-01')
270 self.assertEqual(todo1.id_, 2)
271 self.assertEqual(todo1.process.id_, proc2.id_)
272 self.assertEqual(todo1.is_done, False)
274 def test_do_POST_todo(self) -> None:
275 """Test POST /todo."""
276 def post_and_reload(form_data: dict[str, object], status: int = 302,
277 redir_url: str = '/todo?id=1') -> Todo:
278 self.check_post(form_data, '/todo?id=1', status, redir_url)
279 return Todo.by_date(self.db_conn, '2024-01-01')[0]
282 self.check_post({'day_comment': '', 'new_todo': 1,
283 'make_type': 'full'},
284 '/day?date=2024-01-01&make_type=full', 302)
285 # test posting to bad URLs
286 self.check_post({}, '/todo=', 404)
287 self.check_post({}, '/todo?id=', 400)
288 self.check_post({}, '/todo?id=FOO', 400)
289 self.check_post({}, '/todo?id=0', 404)
290 # test posting naked entity
291 todo1 = post_and_reload({})
292 self.assertEqual(todo1.children, [])
293 self.assertEqual(todo1.parents, [])
294 self.assertEqual(todo1.is_done, False)
295 # test posting doneness
296 todo1 = post_and_reload({'done': ''})
297 self.assertEqual(todo1.is_done, True)
298 # test implicitly posting non-doneness
299 todo1 = post_and_reload({})
300 self.assertEqual(todo1.is_done, False)
301 # test malformed adoptions
302 self.check_post({'adopt': 'foo'}, '/todo?id=1', 400)
303 self.check_post({'adopt': 1}, '/todo?id=1', 400)
304 self.check_post({'adopt': 2}, '/todo?id=1', 404)
305 # test posting second todo of same process
306 self.check_post({'day_comment': '', 'new_todo': 1,
307 'make_type': 'full'},
308 '/day?date=2024-01-01&make_type=full', 302)
309 # test todo 1 adopting todo 2
310 todo1 = post_and_reload({'adopt': 2})
311 todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
312 self.assertEqual(todo1.children, [todo2])
313 self.assertEqual(todo1.parents, [])
314 self.assertEqual(todo2.children, [])
315 self.assertEqual(todo2.parents, [todo1])
316 # test todo1 cannot be set done with todo2 not done yet
317 todo1 = post_and_reload({'done': '', 'adopt': 2}, 400)
318 self.assertEqual(todo1.is_done, False)
319 # test todo1 un-adopting todo 2 by just not sending an adopt
320 todo1 = post_and_reload({}, 302)
321 todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
322 self.assertEqual(todo1.children, [])
323 self.assertEqual(todo1.parents, [])
324 self.assertEqual(todo2.children, [])
325 self.assertEqual(todo2.parents, [])
326 # test todo1 deletion
327 todo1 = post_and_reload({'delete': ''}, 302, '/')
329 def test_do_POST_day_todo_adoption(self) -> None:
330 """Test Todos posted to Day view may adopt existing Todos."""
331 form_data = self.post_process()
332 form_data = self.post_process(2, form_data | {'new_top_step': 1})
333 form_data = {'day_comment': '', 'new_todo': 1, 'make_type': 'full'}
334 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
335 form_data['new_todo'] = 2
336 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
337 todo1 = Todo.by_date(self.db_conn, '2024-01-01')[0]
338 todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
339 self.assertEqual(todo1.children, [])
340 self.assertEqual(todo1.parents, [todo2])
341 self.assertEqual(todo2.children, [todo1])
342 self.assertEqual(todo2.parents, [])
344 def test_do_POST_day_todo_multiple(self) -> None:
345 """Test multiple Todos can be posted to Day view."""
346 form_data = self.post_process()
347 form_data = self.post_process(2)
348 form_data = {'day_comment': '', 'new_todo': [1, 2],
350 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
351 todo1 = Todo.by_date(self.db_conn, '2024-01-01')[0]
352 todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
353 self.assertEqual(todo1.process.id_, 1)
354 self.assertEqual(todo2.process.id_, 2)
356 def test_do_POST_day_todo_multiple_inner_adoption(self) -> None:
357 """Test multiple Todos can be posted to Day view w. inner adoption."""
359 def key_order_func(t: Todo) -> int:
360 assert isinstance(t.process.id_, int)
363 def check_adoption(date: str, new_todos: list[int]) -> None:
364 form_data = {'day_comment': '', 'new_todo': new_todos,
366 self.check_post(form_data, f'/day?date={date}&make_type=full', 302)
367 day_todos = Todo.by_date(self.db_conn, date)
368 day_todos.sort(key=key_order_func)
371 self.assertEqual(todo1.children, [])
372 self.assertEqual(todo1.parents, [todo2])
373 self.assertEqual(todo2.children, [todo1])
374 self.assertEqual(todo2.parents, [])
376 def check_nesting_adoption(process_id: int, date: str,
377 new_top_steps: list[int]) -> None:
378 form_data = {'title': '', 'description': '', 'effort': 1,
380 form_data = self.post_process(1, form_data)
381 form_data['new_top_step'] = new_top_steps
382 form_data['step_of'] = []
383 form_data = self.post_process(process_id, form_data)
384 form_data = {'day_comment': '', 'new_todo': [process_id],
386 self.check_post(form_data, f'/day?date={date}&make_type=full', 302)
387 day_todos = Todo.by_date(self.db_conn, date)
388 day_todos.sort(key=key_order_func, reverse=True)
389 self.assertEqual(len(day_todos), 3)
390 todo1 = day_todos[0] # process of process_id
391 todo2 = day_todos[1] # process 2
392 todo3 = day_todos[2] # process 1
393 self.assertEqual(sorted(todo1.children), sorted([todo2, todo3]))
394 self.assertEqual(todo1.parents, [])
395 self.assertEqual(todo2.children, [todo3])
396 self.assertEqual(todo2.parents, [todo1])
397 self.assertEqual(todo3.children, [])
398 self.assertEqual(sorted(todo3.parents), sorted([todo2, todo1]))
400 form_data = self.post_process()
401 form_data = self.post_process(2, form_data | {'new_top_step': 1})
402 check_adoption('2024-01-01', [1, 2])
403 check_adoption('2024-01-02', [2, 1])
404 check_nesting_adoption(3, '2024-01-03', [1, 2])
405 check_nesting_adoption(4, '2024-01-04', [2, 1])
407 def test_do_POST_day_todo_doneness(self) -> None:
408 """Test Todo doneness can be posted to Day view."""
410 form_data = {'day_comment': '', 'new_todo': [1], 'make_type': 'full'}
411 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
412 todo = Todo.by_date(self.db_conn, '2024-01-01')[0]
413 form_data = {'day_comment': '', 'todo_id': [1], 'make_type': 'full'}
414 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
415 self.assertEqual(todo.is_done, False)
416 form_data = {'day_comment': '', 'todo_id': [1], 'done': [1],
418 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
419 self.assertEqual(todo.is_done, True)
421 def test_do_GET_todo(self) -> None:
422 """Test GET /todo response codes."""
424 form_data = {'day_comment': '', 'new_todo': 1, 'make_type': 'full'}
425 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
426 self.check_get('/todo', 400)
427 self.check_get('/todo?id=', 400)
428 self.check_get('/todo?id=foo', 400)
429 self.check_get('/todo?id=0', 404)
430 self.check_get('/todo?id=1', 200)