plomlompom.com Git - plomtask/blob - tests/todos.py

   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,
   7                                  HandledException)
   8
   9
  10 class TestsWithDB(TestCaseWithDB):
  11     """Tests requiring DB, but not server setup."""
  12     checked_class = Todo
  13
  14     def setUp(self) -> None:
  15         super().setUp()
  16         self.date1 = '2024-01-01'
  17         self.date2 = '2024-01-02'
  18         self.proc = Process(None)
  19         self.proc.save(self.db_conn)
  20         self.cond1 = Condition(None)
  21         self.cond1.save(self.db_conn)
  22         self.cond2 = Condition(None)
  23         self.cond2.save(self.db_conn)
  24
  25     def test_Todo_init(self) -> None:
  26         """Test creation of Todo and what they default to."""
  27         process = Process(None)
  28         with self.assertRaises(NotFoundException):
  29             Todo(None, process, False, self.date1)
  30         process.save(self.db_conn)
  31         assert isinstance(self.cond1.id_, int)
  32         assert isinstance(self.cond2.id_, int)
  33         process.set_conditions(self.db_conn, [self.cond1.id_, self.cond2.id_])
  34         process.set_enables(self.db_conn, [self.cond1.id_])
  35         process.set_disables(self.db_conn, [self.cond2.id_])
  36         todo_no_id = Todo(None, process, False, self.date1)
  37         self.assertEqual(todo_no_id.conditions, [self.cond1, self.cond2])
  38         self.assertEqual(todo_no_id.enables, [self.cond1])
  39         self.assertEqual(todo_no_id.disables, [self.cond2])
  40         todo_yes_id = Todo(5, process, False, self.date1)
  41         self.assertEqual(todo_yes_id.conditions, [])
  42         self.assertEqual(todo_yes_id.enables, [])
  43         self.assertEqual(todo_yes_id.disables, [])
  44
  45     def test_Todo_saving_and_caching(self) -> None:
  46         """Test .save."""
  47         kwargs = {'id_': 1,
  48                   'process': self.proc,
  49                   'is_done': False,
  50                   'date': self.date1}
  51         self.check_saving_and_caching(**kwargs)
  52         todo = Todo(None, self.proc, False, self.date1)
  53         todo.save(self.db_conn)
  54         self.assertEqual(todo.id_, 2)
  55
  56     def test_Todo_by_id(self) -> None:
  57         """Test findability of Todos."""
  58         todo = Todo(1, self.proc, False, self.date1)
  59         todo.save(self.db_conn)
  60         self.assertEqual(Todo.by_id(self.db_conn, 1), todo)
  61         with self.assertRaises(NotFoundException):
  62             Todo.by_id(self.db_conn, 0)
  63         with self.assertRaises(NotFoundException):
  64             Todo.by_id(self.db_conn, 2)
  65
  66     def test_Todo_by_date(self) -> None:
  67         """Test findability of Todos by date."""
  68         t1 = Todo(None, self.proc, False, self.date1)
  69         t1.save(self.db_conn)
  70         t2 = Todo(None, self.proc, False, self.date1)
  71         t2.save(self.db_conn)
  72         self.assertEqual(Todo.by_date(self.db_conn, self.date1), [t1, t2])
  73         self.assertEqual(Todo.by_date(self.db_conn, self.date2), [])
  74         self.assertEqual(Todo.by_date(self.db_conn, 'foo'), [])
  75
  76     def test_Todo_on_conditions(self) -> None:
  77         """Test effect of Todos on Conditions."""
  78         assert isinstance(self.cond1.id_, int)
  79         assert isinstance(self.cond2.id_, int)
  80         todo = Todo(None, self.proc, False, self.date1)
  81         todo.save(self.db_conn)
  82         todo.set_enables(self.db_conn, [self.cond1.id_])
  83         todo.set_disables(self.db_conn, [self.cond2.id_])
  84         todo.is_done = True
  85         self.assertEqual(self.cond1.is_active, True)
  86         self.assertEqual(self.cond2.is_active, False)
  87         todo.is_done = False
  88         self.assertEqual(self.cond1.is_active, True)
  89         self.assertEqual(self.cond2.is_active, False)
  90
  91     def test_Todo_enablers_disablers(self) -> None:
  92         """Test Todo.enablers_for_at/disablers_for_at."""
  93         assert isinstance(self.cond1.id_, int)
  94         assert isinstance(self.cond2.id_, int)
  95         todo1 = Todo(None, self.proc, False, self.date1)
  96         todo1.save(self.db_conn)
  97         todo1.set_enables(self.db_conn, [self.cond1.id_])
  98         todo1.set_disables(self.db_conn, [self.cond2.id_])
  99         todo1.save(self.db_conn)
 100         todo2 = Todo(None, self.proc, False, self.date1)
 101         todo2.save(self.db_conn)
 102         todo2.set_enables(self.db_conn, [self.cond2.id_])
 103         todo2.save(self.db_conn)
 104         todo3 = Todo(None, self.proc, False, self.date2)
 105         todo3.save(self.db_conn)
 106         todo3.set_enables(self.db_conn, [self.cond2.id_])
 107         todo3.save(self.db_conn)
 108         enablers = Todo.enablers_for_at(self.db_conn, self.cond1, self.date1)
 109         self.assertEqual(enablers, [todo1])
 110         enablers = Todo.enablers_for_at(self.db_conn, self.cond1, self.date2)
 111         self.assertEqual(enablers, [])
 112         disablers = Todo.disablers_for_at(self.db_conn, self.cond1, self.date1)
 113         self.assertEqual(disablers, [])
 114         disablers = Todo.disablers_for_at(self.db_conn, self.cond1, self.date2)
 115         self.assertEqual(disablers, [])
 116         enablers = Todo.enablers_for_at(self.db_conn, self.cond2, self.date1)
 117         self.assertEqual(enablers, [todo2])
 118         enablers = Todo.enablers_for_at(self.db_conn, self.cond2, self.date2)
 119         self.assertEqual(enablers, [todo3])
 120         disablers = Todo.disablers_for_at(self.db_conn, self.cond2, self.date1)
 121         self.assertEqual(disablers, [todo1])
 122         disablers = Todo.disablers_for_at(self.db_conn, self.cond2, self.date2)
 123         self.assertEqual(disablers, [])
 124
 125     def test_Todo_children(self) -> None:
 126         """Test Todo.children relations."""
 127         todo_1 = Todo(None, self.proc, False, self.date1)
 128         todo_2 = Todo(None, self.proc, False, self.date1)
 129         todo_2.save(self.db_conn)
 130         with self.assertRaises(HandledException):
 131             todo_1.add_child(todo_2)
 132         todo_1.save(self.db_conn)
 133         todo_3 = Todo(None, self.proc, False, self.date1)
 134         with self.assertRaises(HandledException):
 135             todo_1.add_child(todo_3)
 136         todo_3.save(self.db_conn)
 137         todo_1.add_child(todo_3)
 138         todo_1.save(self.db_conn)
 139         assert isinstance(todo_1.id_, int)
 140         todo_retrieved = Todo.by_id(self.db_conn, todo_1.id_)
 141         self.assertEqual(todo_retrieved.children, [todo_3])
 142         with self.assertRaises(BadFormatException):
 143             todo_3.add_child(todo_1)
 144
 145     def test_Todo_conditioning(self) -> None:
 146         """Test Todo.doability conditions."""
 147         assert isinstance(self.cond1.id_, int)
 148         todo_1 = Todo(None, self.proc, False, self.date1)
 149         todo_1.save(self.db_conn)
 150         todo_2 = Todo(None, self.proc, False, self.date1)
 151         todo_2.save(self.db_conn)
 152         todo_2.add_child(todo_1)
 153         with self.assertRaises(BadFormatException):
 154             todo_2.is_done = True
 155         todo_1.is_done = True
 156         todo_2.is_done = True
 157         todo_2.is_done = False
 158         todo_2.set_conditions(self.db_conn, [self.cond1.id_])
 159         with self.assertRaises(BadFormatException):
 160             todo_2.is_done = True
 161         self.cond1.is_active = True
 162         todo_2.is_done = True
 163
 164     def test_Todo_step_tree(self) -> None:
 165         """Test self-configuration of TodoStepsNode tree for Day view."""
 166         assert isinstance(self.cond1.id_, int)
 167         assert isinstance(self.cond2.id_, int)
 168         todo_1 = Todo(None, self.proc, False, self.date1)
 169         todo_1.save(self.db_conn)
 170         assert isinstance(todo_1.id_, int)
 171         # test minimum
 172         node_0 = TodoStepsNode(todo_1, True, [], False, False)
 173         self.assertEqual(todo_1.get_step_tree(set(), set()), node_0)
 174         # test non_emtpy seen_todo does something
 175         node_0.seen = True
 176         self.assertEqual(todo_1.get_step_tree({todo_1.id_}, set()), node_0)
 177         # test child shows up
 178         todo_2 = Todo(None, self.proc, False, self.date1)
 179         todo_2.save(self.db_conn)
 180         assert isinstance(todo_2.id_, int)
 181         todo_1.add_child(todo_2)
 182         node_2 = TodoStepsNode(todo_2, True, [], False, False)
 183         node_0.children = [node_2]
 184         node_0.seen = False
 185         self.assertEqual(todo_1.get_step_tree(set(), set()), node_0)
 186         # test child shows up with child
 187         todo_3 = Todo(None, self.proc, False, self.date1)
 188         todo_3.save(self.db_conn)
 189         assert isinstance(todo_3.id_, int)
 190         todo_2.add_child(todo_3)
 191         node_3 = TodoStepsNode(todo_3, True, [], False, False)
 192         node_2.children = [node_3]
 193         self.assertEqual(todo_1.get_step_tree(set(), set()), node_0)
 194         # test same todo can be child-ed multiple times at different locations
 195         todo_1.add_child(todo_3)
 196         node_4 = TodoStepsNode(todo_3, True, [], True, False)
 197         node_0.children += [node_4]
 198         self.assertEqual(todo_1.get_step_tree(set(), set()), node_0)
 199         # test condition shows up
 200         todo_1.set_conditions(self.db_conn, [self.cond1.id_])
 201         node_5 = TodoStepsNode(self.cond1, False, [], False, False)
 202         node_0.children += [node_5]
 203         self.assertEqual(todo_1.get_step_tree(set(), set()), node_0)
 204         # test second condition shows up
 205         todo_2.set_conditions(self.db_conn, [self.cond2.id_])
 206         node_6 = TodoStepsNode(self.cond2, False, [], False, False)
 207         node_2.children += [node_6]
 208         self.assertEqual(todo_1.get_step_tree(set(), set()), node_0)
 209         # test second condition is not hidden if fulfilled by non-sibling
 210         todo_1.set_enables(self.db_conn, [self.cond2.id_])
 211         self.assertEqual(todo_1.get_step_tree(set(), set()), node_0)
 212         # test second condition is hidden if fulfilled by sibling
 213         todo_3.set_enables(self.db_conn, [self.cond2.id_])
 214         node_2.children.remove(node_6)
 215         self.assertEqual(todo_1.get_step_tree(set(), set()), node_0)
 216
 217     def test_Todo_unsatisfied_steps(self) -> None:
 218         """Test options of satisfying unfulfilled Process.explicit_steps."""
 219         assert isinstance(self.proc.id_, int)
 220         todo_1 = Todo(None, self.proc, False, self.date1)
 221         todo_1.save(self.db_conn)
 222         proc2 = Process(None)
 223         proc2.save(self.db_conn)
 224         assert isinstance(proc2.id_, int)
 225         proc3 = Process(None)
 226         proc3.save(self.db_conn)
 227         assert isinstance(proc3.id_, int)
 228         proc4 = Process(None)
 229         proc4.save(self.db_conn)
 230         assert isinstance(proc4.id_, int)
 231         proc3.set_steps(self.db_conn, [(None, proc4.id_, None)])
 232         proc2.set_steps(self.db_conn, [(None, self.proc.id_, None),
 233                                        (None, self.proc.id_, None),
 234                                        (None, proc3.id_, None)])
 235         todo_2 = Todo(None, proc2, False, self.date1)
 236         todo_2.save(self.db_conn)
 237         # test empty adoption does nothing
 238         todo_2.adopt_from([])
 239         self.assertEqual(todo_2.children, [])
 240         # test basic adoption
 241         todo_2.adopt_from([todo_1])
 242         self.assertEqual(todo_2.children, [todo_1])
 243         self.assertEqual(todo_1.parents, [todo_2])
 244         # test making missing children
 245         todo_2.make_missing_children(self.db_conn)
 246         todo_3 = Todo.by_id(self.db_conn, 3)
 247         todo_4 = Todo.by_id(self.db_conn, 4)
 248         self.assertEqual(todo_2.children, [todo_1, todo_3, todo_4])
 249         self.assertEqual(todo_3.process, self.proc)
 250         self.assertEqual(todo_3.parents, [todo_2])
 251         self.assertEqual(todo_3.children, [])
 252         self.assertEqual(todo_4.process, proc3)
 253         self.assertEqual(todo_4.parents, [todo_2])
 254         # test .make_missing_children doesn't further than top-level
 255         self.assertEqual(todo_4.children, [])
 256         # test .make_missing_children lower down the tree
 257         todo_4.make_missing_children(self.db_conn)
 258         todo_5 = Todo.by_id(self.db_conn, 5)
 259         self.assertEqual(todo_5.process, proc4)
 260         self.assertEqual(todo_4.children, [todo_5])
 261         self.assertEqual(todo_5.parents, [todo_4])
 262
 263     def test_Todo_singularity(self) -> None:
 264         """Test pointers made for single object keep pointing to it."""
 265         self.check_singularity('is_done', True, self.proc, False, self.date1)
 266
 267     def test_Todo_remove(self) -> None:
 268         """Test removal."""
 269         todo_1 = Todo(None, self.proc, False, self.date1)
 270         todo_1.save(self.db_conn)
 271         todo_0 = Todo(None, self.proc, False, self.date1)
 272         todo_0.save(self.db_conn)
 273         todo_0.add_child(todo_1)
 274         todo_2 = Todo(None, self.proc, False, self.date1)
 275         todo_2.save(self.db_conn)
 276         todo_1.add_child(todo_2)
 277         todo_1.remove(self.db_conn)
 278         with self.assertRaises(NotFoundException):
 279             Todo.by_id(self.db_conn, todo_1.id_)
 280         self.assertEqual(todo_0.children, [])
 281         self.assertEqual(todo_2.parents, [])
 282
 283
 284 class TestsWithServer(TestCaseWithServer):
 285     """Tests against our HTTP server/handler (and database)."""
 286
 287     def test_do_POST_day(self) -> None:
 288         """Test Todo posting of POST /day."""
 289         self.post_process()
 290         self.post_process(2)
 291         proc = Process.by_id(self.db_conn, 1)
 292         proc2 = Process.by_id(self.db_conn, 2)
 293         form_data = {'comment': ''}
 294         self.check_post(form_data, '/day?date=2024-01-01', 302)
 295         self.assertEqual(Todo.by_date(self.db_conn, '2024-01-01'), [])
 296         form_data['new_todo'] = str(proc.id_)
 297         self.check_post(form_data, '/day?date=2024-01-01', 302)
 298         todos = Todo.by_date(self.db_conn, '2024-01-01')
 299         self.assertEqual(1, len(todos))
 300         todo1 = todos[0]
 301         self.assertEqual(todo1.id_, 1)
 302         self.assertEqual(todo1.process.id_, proc.id_)
 303         self.assertEqual(todo1.is_done, False)
 304         form_data['new_todo'] = str(proc2.id_)
 305         self.check_post(form_data, '/day?date=2024-01-01', 302)
 306         todos = Todo.by_date(self.db_conn, '2024-01-01')
 307         todo1 = todos[1]
 308         self.assertEqual(todo1.id_, 2)
 309         self.assertEqual(todo1.process.id_, proc2.id_)
 310         self.assertEqual(todo1.is_done, False)
 311
 312     def test_do_POST_todo(self) -> None:
 313         """Test POST /todo."""
 314         def post_and_reload(form_data: dict[str, object], status: int = 302,
 315                             redir_url: str = '/todo?id=1') -> Todo:
 316             self.check_post(form_data, '/todo?id=1', status, redir_url)
 317             return Todo.by_date(self.db_conn, '2024-01-01')[0]
 318         # test minimum
 319         self.post_process()
 320         self.check_post({'comment': '', 'new_todo': 1},
 321                         '/day?date=2024-01-01', 302)
 322         # test posting to bad URLs
 323         self.check_post({}, '/todo=', 404)
 324         self.check_post({}, '/todo?id=', 400)
 325         self.check_post({}, '/todo?id=FOO', 400)
 326         self.check_post({}, '/todo?id=0', 404)
 327         # test posting naked entity
 328         todo1 = post_and_reload({})
 329         self.assertEqual(todo1.children, [])
 330         self.assertEqual(todo1.parents, [])
 331         self.assertEqual(todo1.is_done, False)
 332         # test posting doneness
 333         todo1 = post_and_reload({'done': ''})
 334         self.assertEqual(todo1.is_done, True)
 335         # test implicitly posting non-doneness
 336         todo1 = post_and_reload({})
 337         self.assertEqual(todo1.is_done, False)
 338         # test malformed adoptions
 339         self.check_post({'adopt': 'foo'}, '/todo?id=1', 400)
 340         self.check_post({'adopt': 1}, '/todo?id=1', 400)
 341         self.check_post({'adopt': 2}, '/todo?id=1', 404)
 342         # test posting second todo of same process
 343         self.check_post({'comment': '', 'new_todo': 1},
 344                         '/day?date=2024-01-01', 302)
 345         # test todo 1 adopting todo 2
 346         todo1 = post_and_reload({'adopt': 2})
 347         todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
 348         self.assertEqual(todo1.children, [todo2])
 349         self.assertEqual(todo1.parents, [])
 350         self.assertEqual(todo2.children, [])
 351         self.assertEqual(todo2.parents, [todo1])
 352         # test todo1 cannot be set done with todo2 not done yet
 353         todo1 = post_and_reload({'done': '', 'adopt': 2}, 400)
 354         self.assertEqual(todo1.is_done, False)
 355         # test todo1 un-adopting todo 2 by just not sending an adopt
 356         todo1 = post_and_reload({}, 302)
 357         todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
 358         self.assertEqual(todo1.children, [])
 359         self.assertEqual(todo1.parents, [])
 360         self.assertEqual(todo2.children, [])
 361         self.assertEqual(todo2.parents, [])
 362         # test todo1 deletion
 363         todo1 = post_and_reload({'delete': ''}, 302, '/')
 364
 365     def test_do_POST_day_todo_adoption(self) -> None:
 366         """Test Todos posted to Day view may adopt existing Todos."""
 367         form_data = self.post_process()
 368         form_data = self.post_process(2, form_data | {'new_top_step': 1})
 369         form_data = {'comment': '', 'new_todo': 1}
 370         self.check_post(form_data, '/day?date=2024-01-01', 302)
 371         form_data['new_todo'] = 2
 372         self.check_post(form_data, '/day?date=2024-01-01', 302)
 373         todo1 = Todo.by_date(self.db_conn, '2024-01-01')[0]
 374         todo2 = Todo.by_date(self.db_conn, '2024-01-01')[1]
 375         self.assertEqual(todo1.children, [])
 376         self.assertEqual(todo1.parents, [todo2])
 377         self.assertEqual(todo2.children, [todo1])
 378         self.assertEqual(todo2.parents, [])
 379
 380     def test_do_GET_todo(self) -> None:
 381         """Test GET /todo response codes."""
 382         self.post_process()
 383         form_data = {'comment': '', 'new_todo': 1}
 384         self.check_post(form_data, '/day?date=2024-01-01', 302)
 385         self.check_get('/todo', 400)
 386         self.check_get('/todo?id=', 400)
 387         self.check_get('/todo?id=foo', 400)
 388         self.check_get('/todo?id=0', 404)
 389         self.check_get('/todo?id=1', 200)