1 """Test Processes module."""
2 from tests.utils import TestCaseWithDB, TestCaseWithServer, TestCaseSansDB
3 from plomtask.processes import Process, ProcessStep, ProcessStepsNode
4 from plomtask.conditions import Condition
5 from plomtask.exceptions import HandledException, NotFoundException
6 from plomtask.todos import Todo
9 class TestsSansDB(TestCaseSansDB):
10 """Module tests not requiring DB setup."""
11 checked_class = Process
13 def test_Process_id_setting(self) -> None:
14 """Test .id_ being set and its legal range being enforced."""
15 self.check_id_setting()
17 def test_Process_versioned_defaults(self) -> None:
18 """Test defaults of VersionedAttributes."""
19 self.check_versioned_defaults({
25 class TestsSansDBProcessStep(TestCaseSansDB):
26 """Module tests not requiring DB setup."""
27 checked_class = ProcessStep
29 def test_ProcessStep_id_setting(self) -> None:
30 """Test .id_ being set and its legal range being enforced."""
31 self.check_id_setting(2, 3, 4)
34 class TestsWithDB(TestCaseWithDB):
35 """Module tests requiring DB setup."""
36 checked_class = Process
38 def three_processes(self) -> tuple[Process, Process, Process]:
39 """Return three saved processes."""
40 p1, p2, p3 = Process(None), Process(None), Process(None)
41 for p in [p1, p2, p3]:
45 def p_of_conditions(self) -> tuple[Process, list[Condition],
46 list[Condition], list[Condition]]:
47 """Return Process and its three Condition sets."""
49 c1, c2, c3 = Condition(None), Condition(None), Condition(None)
50 for c in [c1, c2, c3]:
52 assert isinstance(c1.id_, int)
53 assert isinstance(c2.id_, int)
54 assert isinstance(c3.id_, int)
58 p.set_conditions(self.db_conn, [c.id_ for c in set_1
59 if isinstance(c.id_, int)])
60 p.set_enables(self.db_conn, [c.id_ for c in set_2
61 if isinstance(c.id_, int)])
62 p.set_disables(self.db_conn, [c.id_ for c in set_3
63 if isinstance(c.id_, int)])
65 return p, set_1, set_2, set_3
67 def test_Process_saving_and_caching(self) -> None:
68 """Test .save/.save_core."""
70 self.check_saving_and_caching(**kwargs)
71 self.check_saving_of_versioned('title', str)
72 self.check_saving_of_versioned('description', str)
73 self.check_saving_of_versioned('effort', float)
74 p, set1, set2, set3 = self.p_of_conditions()
76 r = Process.by_id(self.db_conn, p.id_)
77 self.assertEqual(sorted(r.conditions), sorted(set1))
78 self.assertEqual(sorted(r.enables), sorted(set2))
79 self.assertEqual(sorted(r.disables), sorted(set3))
81 def test_Process_from_table_row(self) -> None:
82 """Test .from_table_row() properly reads in class from DB"""
83 self.check_from_table_row()
84 self.check_versioned_from_table_row('title', str)
85 self.check_versioned_from_table_row('description', str)
86 self.check_versioned_from_table_row('effort', float)
87 p, set1, set2, set3 = self.p_of_conditions()
89 assert isinstance(p.id_, int)
90 for row in self.db_conn.row_where(self.checked_class.table_name,
92 # pylint: disable=no-member
93 r = Process.from_table_row(self.db_conn, row)
94 self.assertEqual(sorted(r.conditions), sorted(set1))
95 self.assertEqual(sorted(r.enables), sorted(set2))
96 self.assertEqual(sorted(r.disables), sorted(set3))
98 def test_Process_steps(self) -> None:
99 """Test addition, nesting, and non-recursion of ProcessSteps"""
100 def add_step(proc: Process,
101 steps_proc: list[tuple[int | None, int, int | None]],
102 step_tuple: tuple[int | None, int, int | None],
103 expected_id: int) -> None:
104 steps_proc += [step_tuple]
105 proc.set_steps(self.db_conn, steps_proc)
106 steps_proc[-1] = (expected_id, step_tuple[1], step_tuple[2])
107 p1, p2, p3 = self.three_processes()
108 assert isinstance(p1.id_, int)
109 assert isinstance(p2.id_, int)
110 assert isinstance(p3.id_, int)
111 steps_p1: list[tuple[int | None, int, int | None]] = []
112 add_step(p1, steps_p1, (None, p2.id_, None), 1)
113 p1_dict: dict[int, ProcessStepsNode] = {}
114 p1_dict[1] = ProcessStepsNode(p2, None, True, {}, False)
115 self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict)
116 add_step(p1, steps_p1, (None, p3.id_, None), 2)
117 step_2 = p1.explicit_steps[-1]
118 p1_dict[2] = ProcessStepsNode(p3, None, True, {}, False)
119 self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict)
120 steps_p2: list[tuple[int | None, int, int | None]] = []
121 add_step(p2, steps_p2, (None, p3.id_, None), 3)
122 p1_dict[1].steps[3] = ProcessStepsNode(p3, None, False, {}, False)
123 self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict)
124 add_step(p1, steps_p1, (None, p2.id_, step_2.id_), 4)
125 step_3 = ProcessStepsNode(p3, None, False, {}, True)
126 p1_dict[2].steps[4] = ProcessStepsNode(p2, step_2.id_, True,
128 self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict)
129 add_step(p1, steps_p1, (None, p3.id_, 999), 5)
130 p1_dict[5] = ProcessStepsNode(p3, None, True, {}, False)
131 self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict)
132 add_step(p1, steps_p1, (None, p3.id_, 3), 6)
133 p1_dict[6] = ProcessStepsNode(p3, None, True, {}, False)
134 self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict)
135 self.assertEqual(p1.used_as_step_by(self.db_conn), [])
136 self.assertEqual(p2.used_as_step_by(self.db_conn), [p1])
137 self.assertEqual(p3.used_as_step_by(self.db_conn), [p1, p2])
139 def test_Process_conditions(self) -> None:
140 """Test setting Process.conditions/enables/disables."""
143 for target in ('conditions', 'enables', 'disables'):
144 method = getattr(p, f'set_{target}')
145 c1, c2 = Condition(None), Condition(None)
146 c1.save(self.db_conn)
147 c2.save(self.db_conn)
148 assert isinstance(c1.id_, int)
149 assert isinstance(c2.id_, int)
150 method(self.db_conn, [])
151 self.assertEqual(getattr(p, target), [])
152 method(self.db_conn, [c1.id_])
153 self.assertEqual(getattr(p, target), [c1])
154 method(self.db_conn, [c2.id_])
155 self.assertEqual(getattr(p, target), [c2])
156 method(self.db_conn, [c1.id_, c2.id_])
157 self.assertEqual(getattr(p, target), [c1, c2])
159 def test_Process_by_id(self) -> None:
160 """Test .by_id(), including creation"""
163 def test_Process_all(self) -> None:
167 def test_Process_singularity(self) -> None:
168 """Test pointers made for single object keep pointing to it."""
169 self.check_singularity('conditions', [Condition(None)])
171 def test_Process_versioned_attributes_singularity(self) -> None:
172 """Test behavior of VersionedAttributes on saving (with .title)."""
173 self.check_versioned_singularity()
175 def test_Process_removal(self) -> None:
176 """Test removal of Processes and ProcessSteps."""
178 p1, p2, p3 = self.three_processes()
179 assert isinstance(p1.id_, int)
180 assert isinstance(p2.id_, int)
181 assert isinstance(p3.id_, int)
182 p2.set_steps(self.db_conn, [(None, p1.id_, None)])
183 with self.assertRaises(HandledException):
184 p1.remove(self.db_conn)
185 step = p2.explicit_steps[0]
186 p2.set_steps(self.db_conn, [])
187 with self.assertRaises(NotFoundException):
188 ProcessStep.by_id(self.db_conn, step.id_)
189 p1.remove(self.db_conn)
190 p2.set_steps(self.db_conn, [(None, p3.id_, None)])
191 step = p2.explicit_steps[0]
192 p2.remove(self.db_conn)
193 with self.assertRaises(NotFoundException):
194 ProcessStep.by_id(self.db_conn, step.id_)
195 todo = Todo(None, p3, False, '2024-01-01')
196 todo.save(self.db_conn)
197 with self.assertRaises(HandledException):
198 p3.remove(self.db_conn)
199 todo.remove(self.db_conn)
200 p3.remove(self.db_conn)
203 class TestsWithDBForProcessStep(TestCaseWithDB):
204 """Module tests requiring DB setup."""
205 checked_class = ProcessStep
207 def test_ProcessStep_saving_and_caching(self) -> None:
208 """Test .save/.save_core."""
211 'step_process_id': 3,
213 self.check_saving_and_caching(**kwargs)
215 def test_ProcessStep_from_table_row(self) -> None:
216 """Test .from_table_row() properly reads in class from DB"""
217 self.check_from_table_row(2, 3, None)
219 def test_ProcessStep_singularity(self) -> None:
220 """Test pointers made for single object keep pointing to it."""
221 self.check_singularity('parent_step_id', 1, 2, 3, None)
223 def test_ProcessStep_remove(self) -> None:
224 """Test .remove and unsetting of owner's .explicit_steps entry."""
227 p1.save(self.db_conn)
228 p2.save(self.db_conn)
229 assert isinstance(p2.id_, int)
230 p1.set_steps(self.db_conn, [(None, p2.id_, None)])
231 step = p1.explicit_steps[0]
232 step.remove(self.db_conn)
233 self.assertEqual(p1.explicit_steps, [])
234 self.check_storage([])
237 class TestsWithServer(TestCaseWithServer):
238 """Module tests against our HTTP server/handler (and database)."""
240 def test_do_POST_process(self) -> None:
241 """Test POST /process and its effect on the database."""
242 self.assertEqual(0, len(Process.all(self.db_conn)))
243 form_data = self.post_process()
244 self.assertEqual(1, len(Process.all(self.db_conn)))
245 self.check_post(form_data, '/process?id=FOO', 400)
246 self.check_post(form_data | {'effort': 'foo'}, '/process?id=', 400)
247 self.check_post({}, '/process?id=', 400)
248 self.check_post({'title': '', 'description': ''}, '/process?id=', 400)
249 self.check_post({'title': '', 'effort': 1.1}, '/process?id=', 400)
250 self.check_post({'description': '', 'effort': 1.0},
252 self.assertEqual(1, len(Process.all(self.db_conn)))
253 form_data = {'title': 'foo', 'description': 'foo', 'effort': 1.0}
254 self.post_process(2, form_data | {'condition': []})
255 self.check_post(form_data | {'condition': [1]}, '/process?id=', 404)
256 self.check_post({'title': 'foo', 'description': 'foo'},
257 '/condition', 302, '/condition?id=1')
258 self.post_process(3, form_data | {'condition': [1]})
259 self.post_process(4, form_data | {'disables': [1]})
260 self.post_process(5, form_data | {'enables': [1]})
261 form_data['delete'] = ''
262 self.check_post(form_data, '/process?id=', 404)
263 self.check_post(form_data, '/process?id=6', 404)
264 self.check_post(form_data, '/process?id=5', 302, '/processes')
266 def test_do_GET(self) -> None:
267 """Test /process and /processes response codes."""
269 self.check_get_defaults('/process')
270 self.check_get('/processes', 200)