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_validation,
14 which 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']
23 def setUp(self) -> None:
25 self.date1 = '2024-01-01'
26 self.date2 = '2024-01-02'
27 self.proc = Process(None)
28 self.proc.save(self.db_conn)
29 self.cond1 = Condition(None)
30 self.cond1.save(self.db_conn)
31 self.cond2 = Condition(None)
32 self.cond2.save(self.db_conn)
33 self.default_init_kwargs['process'] = self.proc
34 self.default_init_args[0] = self.proc
36 def test_Todo_init(self) -> None:
37 """Test creation of Todo and what they default to."""
38 process = Process(None)
39 with self.assertRaises(NotFoundException):
40 Todo(None, process, False, self.date1)
41 process.save(self.db_conn)
42 assert isinstance(self.cond1.id_, int)
43 assert isinstance(self.cond2.id_, int)
44 process.set_conditions(self.db_conn, [self.cond1.id_, self.cond2.id_])
45 process.set_enables(self.db_conn, [self.cond1.id_])
46 process.set_disables(self.db_conn, [self.cond2.id_])
47 todo_no_id = Todo(None, process, False, self.date1)
48 self.assertEqual(todo_no_id.conditions, [self.cond1, self.cond2])
49 self.assertEqual(todo_no_id.enables, [self.cond1])
50 self.assertEqual(todo_no_id.disables, [self.cond2])
51 todo_yes_id = Todo(5, process, False, self.date1)
52 self.assertEqual(todo_yes_id.conditions, [])
53 self.assertEqual(todo_yes_id.enables, [])
54 self.assertEqual(todo_yes_id.disables, [])
56 def test_Todo_by_date(self) -> None:
57 """Test findability of Todos by date."""
58 t1 = Todo(None, self.proc, False, self.date1)
60 t2 = Todo(None, self.proc, False, self.date1)
62 self.assertEqual(Todo.by_date(self.db_conn, self.date1), [t1, t2])
63 self.assertEqual(Todo.by_date(self.db_conn, self.date2), [])
64 with self.assertRaises(BadFormatException):
65 self.assertEqual(Todo.by_date(self.db_conn, 'foo'), [])
67 def test_Todo_on_conditions(self) -> None:
68 """Test effect of Todos on Conditions."""
69 assert isinstance(self.cond1.id_, int)
70 assert isinstance(self.cond2.id_, int)
71 todo = Todo(None, self.proc, False, self.date1)
72 todo.save(self.db_conn)
73 todo.set_enables(self.db_conn, [self.cond1.id_])
74 todo.set_disables(self.db_conn, [self.cond2.id_])
76 self.assertEqual(self.cond1.is_active, True)
77 self.assertEqual(self.cond2.is_active, False)
79 self.assertEqual(self.cond1.is_active, True)
80 self.assertEqual(self.cond2.is_active, False)
82 def test_Todo_children(self) -> None:
83 """Test Todo.children relations."""
84 todo_1 = Todo(None, self.proc, False, self.date1)
85 todo_2 = Todo(None, self.proc, False, self.date1)
86 todo_2.save(self.db_conn)
87 with self.assertRaises(HandledException):
88 todo_1.add_child(todo_2)
89 todo_1.save(self.db_conn)
90 todo_3 = Todo(None, self.proc, False, self.date1)
91 with self.assertRaises(HandledException):
92 todo_1.add_child(todo_3)
93 todo_3.save(self.db_conn)
94 todo_1.add_child(todo_3)
95 todo_1.save(self.db_conn)
96 assert isinstance(todo_1.id_, int)
97 todo_retrieved = Todo.by_id(self.db_conn, todo_1.id_)
98 self.assertEqual(todo_retrieved.children, [todo_3])
99 with self.assertRaises(BadFormatException):
100 todo_3.add_child(todo_1)
102 def test_Todo_conditioning(self) -> None:
103 """Test Todo.doability conditions."""
104 assert isinstance(self.cond1.id_, int)
105 todo_1 = Todo(None, self.proc, False, self.date1)
106 todo_1.save(self.db_conn)
107 todo_2 = Todo(None, self.proc, False, self.date1)
108 todo_2.save(self.db_conn)
109 todo_2.add_child(todo_1)
110 with self.assertRaises(BadFormatException):
111 todo_2.is_done = True
112 todo_1.is_done = True
113 todo_2.is_done = True
114 todo_2.is_done = False
115 todo_2.set_conditions(self.db_conn, [self.cond1.id_])
116 with self.assertRaises(BadFormatException):
117 todo_2.is_done = True
118 self.cond1.is_active = True
119 todo_2.is_done = True
121 def test_Todo_step_tree(self) -> None:
122 """Test self-configuration of TodoStepsNode tree for Day view."""
123 todo_1 = Todo(None, self.proc, False, self.date1)
124 todo_1.save(self.db_conn)
125 assert isinstance(todo_1.id_, int)
127 node_0 = TodoNode(todo_1, False, [])
128 self.assertEqual(todo_1.get_step_tree(set()), node_0)
129 # test non_emtpy seen_todo does something
131 self.assertEqual(todo_1.get_step_tree({todo_1.id_}), node_0)
132 # test child shows up
133 todo_2 = Todo(None, self.proc, False, self.date1)
134 todo_2.save(self.db_conn)
135 assert isinstance(todo_2.id_, int)
136 todo_1.add_child(todo_2)
137 node_2 = TodoNode(todo_2, False, [])
138 node_0.children = [node_2]
140 self.assertEqual(todo_1.get_step_tree(set()), node_0)
141 # test child shows up with child
142 todo_3 = Todo(None, self.proc, False, self.date1)
143 todo_3.save(self.db_conn)
144 assert isinstance(todo_3.id_, int)
145 todo_2.add_child(todo_3)
146 node_3 = TodoNode(todo_3, False, [])
147 node_2.children = [node_3]
148 self.assertEqual(todo_1.get_step_tree(set()), node_0)
149 # test same todo can be child-ed multiple times at different locations
150 todo_1.add_child(todo_3)
151 node_4 = TodoNode(todo_3, True, [])
152 node_0.children += [node_4]
153 self.assertEqual(todo_1.get_step_tree(set()), node_0)
155 def test_Todo_create_with_children(self) -> None:
156 """Test parenthood guaranteeds of Todo.create_with_children."""
157 assert isinstance(self.proc.id_, int)
158 proc2 = Process(None)
159 proc2.save(self.db_conn)
160 assert isinstance(proc2.id_, int)
161 proc3 = Process(None)
162 proc3.save(self.db_conn)
163 assert isinstance(proc3.id_, int)
164 proc4 = Process(None)
165 proc4.save(self.db_conn)
166 assert isinstance(proc4.id_, int)
167 # make proc4 step of proc3
168 step = ProcessStep(None, proc3.id_, proc4.id_, None)
169 proc3.set_steps(self.db_conn, [step])
170 # give proc2 three steps; 2× proc1, 1× proc3
171 step1 = ProcessStep(None, proc2.id_, self.proc.id_, None)
172 step2 = ProcessStep(None, proc2.id_, self.proc.id_, None)
173 step3 = ProcessStep(None, proc2.id_, proc3.id_, None)
174 proc2.set_steps(self.db_conn, [step1, step2, step3])
175 # test mere creation does nothing
176 todo_ignore = Todo(None, proc2, False, self.date1)
177 todo_ignore.save(self.db_conn)
178 self.assertEqual(todo_ignore.children, [])
179 # test create_with_children on step-less does nothing
180 todo_1 = Todo.create_with_children(self.db_conn, self.proc.id_,
182 self.assertEqual(todo_1.children, [])
183 self.assertEqual(len(Todo.all(self.db_conn)), 2)
184 # test create_with_children adopts and creates, and down tree too
185 todo_2 = Todo.create_with_children(self.db_conn, proc2.id_, self.date1)
186 self.assertEqual(3, len(todo_2.children))
187 self.assertEqual(todo_1, todo_2.children[0])
188 self.assertEqual(self.proc, todo_2.children[2].process)
189 self.assertEqual(proc3, todo_2.children[1].process)
190 todo_3 = todo_2.children[1]
191 self.assertEqual(len(todo_3.children), 1)
192 self.assertEqual(todo_3.children[0].process, proc4)
194 def test_Todo_remove(self) -> None:
196 todo_1 = Todo(None, self.proc, False, self.date1)
197 todo_1.save(self.db_conn)
198 assert todo_1.id_ is not None
199 todo_0 = Todo(None, self.proc, False, self.date1)
200 todo_0.save(self.db_conn)
201 todo_0.add_child(todo_1)
202 todo_2 = Todo(None, self.proc, False, self.date1)
203 todo_2.save(self.db_conn)
204 todo_1.add_child(todo_2)
205 todo_1_id = todo_1.id_
206 todo_1.remove(self.db_conn)
207 with self.assertRaises(NotFoundException):
208 Todo.by_id(self.db_conn, todo_1_id)
209 self.assertEqual(todo_0.children, [])
210 self.assertEqual(todo_2.parents, [])
211 todo_2.comment = 'foo'
212 with self.assertRaises(HandledException):
213 todo_2.remove(self.db_conn)
216 with self.assertRaises(HandledException):
217 todo_2.remove(self.db_conn)
219 def test_Todo_autoremoval(self) -> None:
220 """"Test automatic removal for Todo.effort < 0."""
221 todo_1 = Todo(None, self.proc, False, self.date1)
222 todo_1.save(self.db_conn)
223 todo_1.comment = 'foo'
225 todo_1.save(self.db_conn)
226 assert todo_1.id_ is not None
227 Todo.by_id(self.db_conn, todo_1.id_)
229 todo_1_id = todo_1.id_
230 todo_1.save(self.db_conn)
231 with self.assertRaises(NotFoundException):
232 Todo.by_id(self.db_conn, todo_1_id)
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."""
242 proc = Process.by_id(self.db_conn, 1)
243 proc2 = Process.by_id(self.db_conn, 2)
244 form_data = {'day_comment': '', 'make_type': 'full'}
245 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
246 self.assertEqual(Todo.by_date(self.db_conn, '2024-01-01'), [])
247 form_data['new_todo'] = str(proc.id_)
248 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
249 todos = Todo.by_date(self.db_conn, '2024-01-01')
250 self.assertEqual(1, len(todos))
252 self.assertEqual(todo1.id_, 1)
253 self.assertEqual(todo1.process.id_, proc.id_)
254 self.assertEqual(todo1.is_done, False)
255 form_data['new_todo'] = str(proc2.id_)
256 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
257 todos = Todo.by_date(self.db_conn, '2024-01-01')
259 self.assertEqual(todo1.id_, 2)
260 self.assertEqual(todo1.process.id_, proc2.id_)
261 self.assertEqual(todo1.is_done, False)
263 def test_do_POST_todo(self) -> None:
264 """Test POST /todo."""
265 def post_and_reload(form_data: dict[str, object], status: int = 302,
266 redir_url: str = '/todo?id=1') -> Todo:
267 self.check_post(form_data, '/todo?id=1', status, redir_url)
268 return Todo.by_date(self.db_conn, '2024-01-01')[0]
271 self.check_post({'day_comment': '', 'new_todo': 1,
272 'make_type': 'full'},
273 '/day?date=2024-01-01&make_type=full', 302)
274 # test posting to bad URLs
275 self.check_post({}, '/todo=', 404)
276 self.check_post({}, '/todo?id=', 400)
277 self.check_post({}, '/todo?id=FOO', 400)
278 self.check_post({}, '/todo?id=0', 404)
279 # test posting naked entity
280 todo1 = post_and_reload({})
281 self.assertEqual(todo1.children, [])
282 self.assertEqual(todo1.parents, [])
283 self.assertEqual(todo1.is_done, False)
284 # test posting doneness
285 todo1 = post_and_reload({'done': ''})
286 self.assertEqual(todo1.is_done, True)
287 # test implicitly posting non-doneness
288 todo1 = post_and_reload({})
289 self.assertEqual(todo1.is_done, False)
290 # test malformed adoptions
291 self.check_post({'adopt': 'foo'}, '/todo?id=1', 400)
292 self.check_post({'adopt': 1}, '/todo?id=1', 400)
293 self.check_post({'adopt': 2}, '/todo?id=1', 404)
294 # test posting second todo of same process
295 self.check_post({'day_comment': '', 'new_todo': 1,
296 'make_type': 'full'},
297 '/day?date=2024-01-01&make_type=full', 302)
298 # test todo 1 adopting todo 2
299 todo1 = post_and_reload({'adopt': 2})
300 todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
301 self.assertEqual(todo1.children, [todo2])
302 self.assertEqual(todo1.parents, [])
303 self.assertEqual(todo2.children, [])
304 self.assertEqual(todo2.parents, [todo1])
305 # test todo1 cannot be set done with todo2 not done yet
306 todo1 = post_and_reload({'done': '', 'adopt': 2}, 400)
307 self.assertEqual(todo1.is_done, False)
308 # test todo1 un-adopting todo 2 by just not sending an adopt
309 todo1 = post_and_reload({}, 302)
310 todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
311 self.assertEqual(todo1.children, [])
312 self.assertEqual(todo1.parents, [])
313 self.assertEqual(todo2.children, [])
314 self.assertEqual(todo2.parents, [])
315 # test todo1 deletion
316 todo1 = post_and_reload({'delete': ''}, 302, '/')
318 def test_do_POST_day_todo_adoption(self) -> None:
319 """Test Todos posted to Day view may adopt existing Todos."""
320 form_data = self.post_process()
321 form_data = self.post_process(2, form_data | {'new_top_step': 1})
322 form_data = {'day_comment': '', 'new_todo': 1, 'make_type': 'full'}
323 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
324 form_data['new_todo'] = 2
325 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
326 todo1 = Todo.by_date(self.db_conn, '2024-01-01')[0]
327 todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
328 self.assertEqual(todo1.children, [])
329 self.assertEqual(todo1.parents, [todo2])
330 self.assertEqual(todo2.children, [todo1])
331 self.assertEqual(todo2.parents, [])
333 def test_do_POST_day_todo_multiple(self) -> None:
334 """Test multiple Todos can be posted to Day view."""
335 form_data = self.post_process()
336 form_data = self.post_process(2)
337 form_data = {'day_comment': '', 'new_todo': [1, 2],
339 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
340 todo1 = Todo.by_date(self.db_conn, '2024-01-01')[0]
341 todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
342 self.assertEqual(todo1.process.id_, 1)
343 self.assertEqual(todo2.process.id_, 2)
345 def test_do_POST_day_todo_multiple_inner_adoption(self) -> None:
346 """Test multiple Todos can be posted to Day view w. inner adoption."""
348 def key_order_func(t: Todo) -> int:
349 assert isinstance(t.process.id_, int)
352 def check_adoption(date: str, new_todos: list[int]) -> None:
353 form_data = {'day_comment': '', 'new_todo': new_todos,
355 self.check_post(form_data, f'/day?date={date}&make_type=full', 302)
356 day_todos = Todo.by_date(self.db_conn, date)
357 day_todos.sort(key=key_order_func)
360 self.assertEqual(todo1.children, [])
361 self.assertEqual(todo1.parents, [todo2])
362 self.assertEqual(todo2.children, [todo1])
363 self.assertEqual(todo2.parents, [])
365 def check_nesting_adoption(process_id: int, date: str,
366 new_top_steps: list[int]) -> None:
367 form_data = {'title': '', 'description': '', 'effort': 1,
369 form_data = self.post_process(1, form_data)
370 form_data['new_top_step'] = new_top_steps
371 form_data['step_of'] = []
372 form_data = self.post_process(process_id, form_data)
373 form_data = {'day_comment': '', 'new_todo': [process_id],
375 self.check_post(form_data, f'/day?date={date}&make_type=full', 302)
376 day_todos = Todo.by_date(self.db_conn, date)
377 day_todos.sort(key=key_order_func, reverse=True)
378 self.assertEqual(len(day_todos), 3)
379 todo1 = day_todos[0] # process of process_id
380 todo2 = day_todos[1] # process 2
381 todo3 = day_todos[2] # process 1
382 self.assertEqual(sorted(todo1.children), sorted([todo2, todo3]))
383 self.assertEqual(todo1.parents, [])
384 self.assertEqual(todo2.children, [todo3])
385 self.assertEqual(todo2.parents, [todo1])
386 self.assertEqual(todo3.children, [])
387 self.assertEqual(sorted(todo3.parents), sorted([todo2, todo1]))
389 form_data = self.post_process()
390 form_data = self.post_process(2, form_data | {'new_top_step': 1})
391 check_adoption('2024-01-01', [1, 2])
392 check_adoption('2024-01-02', [2, 1])
393 check_nesting_adoption(3, '2024-01-03', [1, 2])
394 check_nesting_adoption(4, '2024-01-04', [2, 1])
396 def test_do_POST_day_todo_doneness(self) -> None:
397 """Test Todo doneness can be posted to Day view."""
399 form_data = {'day_comment': '', 'new_todo': [1], 'make_type': 'full'}
400 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
401 todo = Todo.by_date(self.db_conn, '2024-01-01')[0]
402 form_data = {'day_comment': '', 'todo_id': [1], 'make_type': 'full'}
403 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
404 self.assertEqual(todo.is_done, False)
405 form_data = {'day_comment': '', 'todo_id': [1], 'done': [1],
407 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
408 self.assertEqual(todo.is_done, True)
410 def test_do_GET_todo(self) -> None:
411 """Test GET /todo response codes."""
413 form_data = {'day_comment': '', 'new_todo': 1, 'make_type': 'full'}
414 self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302)
415 self.check_get('/todo', 400)
416 self.check_get('/todo?id=', 400)
417 self.check_get('/todo?id=foo', 400)
418 self.check_get('/todo?id=0', 404)
419 self.check_get('/todo?id=1', 200)