X-Git-Url: https://plomlompom.com/repos/foo.html?a=blobdiff_plain;f=tests%2Fprocesses.py;h=c3b1144de7563d956e5fd3a6d6474cb6180e726a;hb=HEAD;hp=c718677f78e7afea5a95fdaa65e3c3981df96f1b;hpb=0ed3bc539d21d5536d0fc635760d88a2231587b9;p=plomtask diff --git a/tests/processes.py b/tests/processes.py index c718677..1b20e21 100644 --- a/tests/processes.py +++ b/tests/processes.py @@ -1,161 +1,238 @@ """Test Processes module.""" -from unittest import TestCase -from tests.utils import TestCaseWithDB, TestCaseWithServer +from typing import Any +from tests.utils import TestCaseWithDB, TestCaseWithServer, TestCaseSansDB from plomtask.processes import Process, ProcessStep, ProcessStepsNode from plomtask.conditions import Condition -from plomtask.exceptions import NotFoundException, HandledException +from plomtask.exceptions import HandledException, NotFoundException +from plomtask.todos import Todo -class TestsSansDB(TestCase): +class TestsSansDB(TestCaseSansDB): """Module tests not requiring DB setup.""" + checked_class = Process + versioned_defaults_to_test = {'title': 'UNNAMED', 'description': '', + 'effort': 1.0} - def test_Process_versioned_defaults(self) -> None: - """Test defaults of Process' VersionedAttributes.""" - self.assertEqual(Process(None).title.newest, 'UNNAMED') - self.assertEqual(Process(None).description.newest, '') - self.assertEqual(Process(None).effort.newest, 1.0) - def test_Process_legal_ID(self) -> None: - """Test Process cannot be instantiated with id_=0.""" - with self.assertRaises(HandledException): - Process(0) +class TestsSansDBProcessStep(TestCaseSansDB): + """Module tests not requiring DB setup.""" + checked_class = ProcessStep + default_init_args = [2, 3, 4] class TestsWithDB(TestCaseWithDB): - """Mdule tests not requiring DB setup.""" + """Module tests requiring DB setup.""" + checked_class = Process + test_versioneds = {'title': str, 'description': str, 'effort': float} - def setUp(self) -> None: - super().setUp() - self.proc1 = Process(None) - self.proc1.save(self.db_conn) - self.proc2 = Process(None) - self.proc2.save(self.db_conn) - self.proc3 = Process(None) - self.proc3.save(self.db_conn) - - def test_Process_ids(self) -> None: - """Test Process.save() re Process.id_.""" - self.assertEqual(self.proc1.id_, - Process.by_id(self.db_conn, 1, create=False).id_) - self.assertEqual(self.proc2.id_, - Process.by_id(self.db_conn, 2, create=False).id_) - proc5 = Process(5) - proc5.save(self.db_conn) - self.assertEqual(proc5.id_, - Process.by_id(self.db_conn, 5, create=False).id_) + def three_processes(self) -> tuple[Process, Process, Process]: + """Return three saved processes.""" + p1, p2, p3 = Process(None), Process(None), Process(None) + for p in [p1, p2, p3]: + p.save(self.db_conn) + return p1, p2, p3 + + def p_of_conditions(self) -> tuple[Process, list[Condition], + list[Condition], list[Condition]]: + """Return Process and its three Condition sets.""" + p = Process(None) + c1, c2, c3 = Condition(None), Condition(None), Condition(None) + for c in [c1, c2, c3]: + c.save(self.db_conn) + assert isinstance(c1.id_, int) + assert isinstance(c2.id_, int) + assert isinstance(c3.id_, int) + set_1 = [c1, c2] + set_2 = [c2, c3] + set_3 = [c1, c3] + p.set_conditions(self.db_conn, [c.id_ for c in set_1 + if isinstance(c.id_, int)]) + p.set_enables(self.db_conn, [c.id_ for c in set_2 + if isinstance(c.id_, int)]) + p.set_disables(self.db_conn, [c.id_ for c in set_3 + if isinstance(c.id_, int)]) + p.save(self.db_conn) + return p, set_1, set_2, set_3 + + def test_Process_conditions_saving(self) -> None: + """Test .save/.save_core.""" + p, set1, set2, set3 = self.p_of_conditions() + assert p.id_ is not None + r = Process.by_id(self.db_conn, p.id_) + self.assertEqual(sorted(r.conditions), sorted(set1)) + self.assertEqual(sorted(r.enables), sorted(set2)) + self.assertEqual(sorted(r.disables), sorted(set3)) + + def test_from_table_row(self) -> None: + """Test .from_table_row() properly reads in class from DB.""" + super().test_from_table_row() + p, set1, set2, set3 = self.p_of_conditions() + p.save(self.db_conn) + assert isinstance(p.id_, int) + for row in self.db_conn.row_where(self.checked_class.table_name, + 'id', p.id_): + r = Process.from_table_row(self.db_conn, row) + self.assertEqual(sorted(r.conditions), sorted(set1)) + self.assertEqual(sorted(r.enables), sorted(set2)) + self.assertEqual(sorted(r.disables), sorted(set3)) def test_Process_steps(self) -> None: """Test addition, nesting, and non-recursion of ProcessSteps""" - def add_step(proc: Process, - steps_proc: list[tuple[int | None, int, int | None]], - step_tuple: tuple[int | None, int, int | None], - expected_id: int) -> None: - steps_proc += [step_tuple] - proc.set_steps(self.db_conn, steps_proc) - steps_proc[-1] = (expected_id, step_tuple[1], step_tuple[2]) - assert isinstance(self.proc2.id_, int) - assert isinstance(self.proc3.id_, int) - steps_proc1: list[tuple[int | None, int, int | None]] = [] - add_step(self.proc1, steps_proc1, (None, self.proc2.id_, None), 1) - p_1_dict: dict[int, ProcessStepsNode] = {} - p_1_dict[1] = ProcessStepsNode(self.proc2, None, True, {}, False) - self.assertEqual(self.proc1.get_steps(self.db_conn, None), p_1_dict) - add_step(self.proc1, steps_proc1, (None, self.proc3.id_, None), 2) - step_2 = self.proc1.explicit_steps[-1] - assert isinstance(step_2.id_, int) - p_1_dict[2] = ProcessStepsNode(self.proc3, None, True, {}, False) - self.assertEqual(self.proc1.get_steps(self.db_conn, None), p_1_dict) - steps_proc2: list[tuple[int | None, int, int | None]] = [] - add_step(self.proc2, steps_proc2, (None, self.proc3.id_, None), 3) - p_1_dict[1].steps[3] = ProcessStepsNode(self.proc3, None, - False, {}, False) - self.assertEqual(self.proc1.get_steps(self.db_conn, None), p_1_dict) - add_step(self.proc1, steps_proc1, (None, self.proc2.id_, step_2.id_), - 4) - step_3 = ProcessStepsNode(self.proc3, None, False, {}, True) - p_1_dict[2].steps[4] = ProcessStepsNode(self.proc2, step_2.id_, True, - {3: step_3}, False) - self.assertEqual(self.proc1.get_steps(self.db_conn, None), p_1_dict) - add_step(self.proc1, steps_proc1, (None, self.proc3.id_, 999), 5) - p_1_dict[5] = ProcessStepsNode(self.proc3, None, True, {}, False) - self.assertEqual(self.proc1.get_steps(self.db_conn, None), p_1_dict) - add_step(self.proc1, steps_proc1, (None, self.proc3.id_, 3), 6) - p_1_dict[6] = ProcessStepsNode(self.proc3, None, True, {}, False) - self.assertEqual(self.proc1.get_steps(self.db_conn, None), - p_1_dict) - self.assertEqual(self.proc1.used_as_step_by(self.db_conn), - []) - self.assertEqual(self.proc2.used_as_step_by(self.db_conn), - [self.proc1]) - self.assertEqual(self.proc3.used_as_step_by(self.db_conn), - [self.proc1, self.proc2]) + # pylint: disable=too-many-locals + # pylint: disable=too-many-statements + p1, p2, p3 = self.three_processes() + assert isinstance(p1.id_, int) + assert isinstance(p2.id_, int) + assert isinstance(p3.id_, int) + steps_p1: list[ProcessStep] = [] + # add step of process p2 as first (top-level) step to p1 + s_p2_to_p1 = ProcessStep(None, p1.id_, p2.id_, None) + steps_p1 += [s_p2_to_p1] + p1.set_steps(self.db_conn, steps_p1) + p1_dict: dict[int, ProcessStepsNode] = {} + p1_dict[1] = ProcessStepsNode(p2, None, True, {}) + self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict) + # add step of process p3 as second (top-level) step to p1 + s_p3_to_p1 = ProcessStep(None, p1.id_, p3.id_, None) + steps_p1 += [s_p3_to_p1] + p1.set_steps(self.db_conn, steps_p1) + p1_dict[2] = ProcessStepsNode(p3, None, True, {}) + self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict) + # add step of process p3 as first (top-level) step to p2, + steps_p2: list[ProcessStep] = [] + s_p3_to_p2 = ProcessStep(None, p2.id_, p3.id_, None) + steps_p2 += [s_p3_to_p2] + p2.set_steps(self.db_conn, steps_p2) + # expect it as implicit sub-step of p1's second (p3) step + p2_dict = {3: ProcessStepsNode(p3, None, False, {})} + p1_dict[1].steps[3] = p2_dict[3] + self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict) + # add step of process p2 as explicit sub-step to p1's second sub-step + s_p2_to_p1_first = ProcessStep(None, p1.id_, p2.id_, s_p3_to_p1.id_) + steps_p1 += [s_p2_to_p1_first] + p1.set_steps(self.db_conn, steps_p1) + seen_3 = ProcessStepsNode(p3, None, False, {}, False) + p1_dict[1].steps[3].seen = True + p1_dict[2].steps[4] = ProcessStepsNode(p2, s_p3_to_p1.id_, True, + {3: seen_3}) + self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict) + # add step of process p3 as explicit sub-step to non-existing p1 + # sub-step (of id=999), expect it to become another p1 top-level step + s_p3_to_p1_999 = ProcessStep(None, p1.id_, p3.id_, 999) + steps_p1 += [s_p3_to_p1_999] + p1.set_steps(self.db_conn, steps_p1) + p1_dict[5] = ProcessStepsNode(p3, None, True, {}) + self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict) + # add step of process p3 as explicit sub-step to p1's implicit p3 + # sub-step, expect it to become another p1 top-level step + s_p3_to_p1_impl_p3 = ProcessStep(None, p1.id_, p3.id_, s_p3_to_p2.id_) + steps_p1 += [s_p3_to_p1_impl_p3] + p1.set_steps(self.db_conn, steps_p1) + p1_dict[6] = ProcessStepsNode(p3, None, True, {}) + self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict) + self.assertEqual(p1.used_as_step_by(self.db_conn), []) + self.assertEqual(p2.used_as_step_by(self.db_conn), [p1]) + self.assertEqual(p3.used_as_step_by(self.db_conn), [p1, p2]) + # # add step of process p3 as explicit sub-step to p1's first sub-step, + # # expect it to eliminate implicit p3 sub-step + # s_p3_to_p1_first_explicit = ProcessStep(None, p1.id_, p3.id_, + # s_p2_to_p1.id_) + # p1_dict[1].steps = {7: ProcessStepsNode(p3, 1, True, {})} + # p1_dict[2].steps[4].steps[3].seen = False + # steps_p1 += [s_p3_to_p1_first_explicit] + # p1.set_steps(self.db_conn, steps_p1) + # self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict) + # ensure implicit steps non-top explicit steps are shown + s_p3_to_p2_first = ProcessStep(None, p2.id_, p3.id_, s_p3_to_p2.id_) + steps_p2 += [s_p3_to_p2_first] + p2.set_steps(self.db_conn, steps_p2) + p1_dict[1].steps[3].steps[7] = ProcessStepsNode(p3, 3, False, {}, True) + p1_dict[2].steps[4].steps[3].steps[7] = ProcessStepsNode(p3, 3, False, + {}, False) + self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict) + # ensure suppressed step nodes are hidden + assert isinstance(s_p3_to_p2.id_, int) + p1.set_step_suppressions(self.db_conn, [s_p3_to_p2.id_]) + p1_dict[1].steps[3].steps = {} + p1_dict[1].steps[3].is_suppressed = True + p1_dict[2].steps[4].steps[3].steps = {} + p1_dict[2].steps[4].steps[3].is_suppressed = True + self.assertEqual(p1.get_steps(self.db_conn), p1_dict) def test_Process_conditions(self) -> None: """Test setting Process.conditions/enables/disables.""" + p = Process(None) + p.save(self.db_conn) for target in ('conditions', 'enables', 'disables'): - c1 = Condition(None, False) + method = getattr(p, f'set_{target}') + c1, c2 = Condition(None), Condition(None) c1.save(self.db_conn) - assert isinstance(c1.id_, int) - c2 = Condition(None, False) c2.save(self.db_conn) + assert isinstance(c1.id_, int) assert isinstance(c2.id_, int) - self.proc1.set_conditions(self.db_conn, [], target) - self.assertEqual(getattr(self.proc1, target), []) - self.proc1.set_conditions(self.db_conn, [c1.id_], target) - self.assertEqual(getattr(self.proc1, target), [c1]) - self.proc1.set_conditions(self.db_conn, [c2.id_], target) - self.assertEqual(getattr(self.proc1, target), [c2]) - self.proc1.set_conditions(self.db_conn, [c1.id_, c2.id_], target) - self.assertEqual(getattr(self.proc1, target), [c1, c2]) - - def test_Process_by_id(self) -> None: - """Test Process.by_id().""" + method(self.db_conn, []) + self.assertEqual(getattr(p, target), []) + method(self.db_conn, [c1.id_]) + self.assertEqual(getattr(p, target), [c1]) + method(self.db_conn, [c2.id_]) + self.assertEqual(getattr(p, target), [c2]) + method(self.db_conn, [c1.id_, c2.id_]) + self.assertEqual(getattr(p, target), [c1, c2]) + + def test_remove(self) -> None: + """Test removal of Processes and ProcessSteps.""" + super().test_remove() + p1, p2, p3 = self.three_processes() + assert isinstance(p1.id_, int) + assert isinstance(p2.id_, int) + assert isinstance(p3.id_, int) + step = ProcessStep(None, p2.id_, p1.id_, None) + p2.set_steps(self.db_conn, [step]) + step_id = step.id_ + with self.assertRaises(HandledException): + p1.remove(self.db_conn) + p2.set_steps(self.db_conn, []) with self.assertRaises(NotFoundException): - Process.by_id(self.db_conn, None, create=False) + assert step_id is not None + ProcessStep.by_id(self.db_conn, step_id) + p1.remove(self.db_conn) + step = ProcessStep(None, p2.id_, p3.id_, None) + p2.set_steps(self.db_conn, [step]) + step_id = step.id_ + p2.remove(self.db_conn) with self.assertRaises(NotFoundException): - Process.by_id(self.db_conn, 0, create=False) - self.assertNotEqual(self.proc1.id_, - Process.by_id(self.db_conn, None, create=True).id_) - self.assertEqual(Process(2).id_, - Process.by_id(self.db_conn, 2, create=True).id_) - - def test_Process_all(self) -> None: - """Test Process.all().""" - self.assertEqual({self.proc1.id_, self.proc2.id_, self.proc3.id_}, - set(p.id_ for p in Process.all(self.db_conn))) - - def test_ProcessStep_singularity(self) -> None: - """Test pointers made for single object keep pointing to it.""" - assert isinstance(self.proc2.id_, int) - self.proc1.set_steps(self.db_conn, [(None, self.proc2.id_, None)]) - step = self.proc1.explicit_steps[-1] - assert isinstance(step.id_, int) - step_retrieved = ProcessStep.by_id(self.db_conn, step.id_) - step.parent_step_id = 99 - self.assertEqual(step.parent_step_id, step_retrieved.parent_step_id) - - def test_Process_singularity(self) -> None: - """Test pointers made for single object keep pointing to it, and - subsequent retrievals don't overload relations.""" - assert isinstance(self.proc1.id_, int) - assert isinstance(self.proc2.id_, int) - c1 = Condition(None, False) - c1.save(self.db_conn) - assert isinstance(c1.id_, int) - self.proc1.set_conditions(self.db_conn, [c1.id_]) - self.proc1.set_steps(self.db_conn, [(None, self.proc2.id_, None)]) - self.proc1.save(self.db_conn) - p_retrieved = Process.by_id(self.db_conn, self.proc1.id_) - self.assertEqual(self.proc1.explicit_steps, p_retrieved.explicit_steps) - self.assertEqual(self.proc1.conditions, p_retrieved.conditions) - self.proc1.save(self.db_conn) - - def test_Process_versioned_attributes_singularity(self) -> None: - """Test behavior of VersionedAttributes on saving (with .title).""" - assert isinstance(self.proc1.id_, int) - self.proc1.title.set('named') - p_loaded = Process.by_id(self.db_conn, self.proc1.id_) - self.assertEqual(self.proc1.title.history, p_loaded.title.history) + assert step_id is not None + ProcessStep.by_id(self.db_conn, step_id) + todo = Todo(None, p3, False, '2024-01-01') + todo.save(self.db_conn) + with self.assertRaises(HandledException): + p3.remove(self.db_conn) + todo.remove(self.db_conn) + p3.remove(self.db_conn) + + +class TestsWithDBForProcessStep(TestCaseWithDB): + """Module tests requiring DB setup.""" + checked_class = ProcessStep + default_init_kwargs = {'owner_id': 1, 'step_process_id': 2, + 'parent_step_id': 3} + + def setUp(self) -> None: + super().setUp() + self.p1 = Process(1) + self.p1.save(self.db_conn) + + def test_remove(self) -> None: + """Test .remove and unsetting of owner's .explicit_steps entry.""" + p2 = Process(2) + p2.save(self.db_conn) + assert isinstance(self.p1.id_, int) + assert isinstance(p2.id_, int) + step = ProcessStep(None, self.p1.id_, p2.id_, None) + self.p1.set_steps(self.db_conn, [step]) + step.remove(self.db_conn) + self.assertEqual(self.p1.explicit_steps, []) + self.check_identity_with_cache_and_db([]) class TestsWithServer(TestCaseWithServer): @@ -164,37 +241,270 @@ class TestsWithServer(TestCaseWithServer): def test_do_POST_process(self) -> None: """Test POST /process and its effect on the database.""" self.assertEqual(0, len(Process.all(self.db_conn))) - form_data = {'title': 'foo', 'description': 'foo', 'effort': 1.1} - self.check_post(form_data, '/process?id=', 302, '/') + form_data = self.post_process() self.assertEqual(1, len(Process.all(self.db_conn))) self.check_post(form_data, '/process?id=FOO', 400) - form_data['effort'] = 'foo' - self.check_post(form_data, '/process?id=', 400) + self.check_post(form_data | {'effort': 'foo'}, '/process?id=', 400) self.check_post({}, '/process?id=', 400) - form_data = {'title': '', 'description': ''} - self.check_post(form_data, '/process?id=', 400) - form_data = {'title': '', 'effort': 1.1} - self.check_post(form_data, '/process?id=', 400) - form_data = {'description': '', 'effort': 1.0} - self.check_post(form_data, '/process?id=', 400) + self.check_post({'title': '', 'description': ''}, '/process?id=', 400) + self.check_post({'title': '', 'effort': 1.1}, '/process?id=', 400) + self.check_post({'description': '', 'effort': 1.0}, + '/process?id=', 400) self.assertEqual(1, len(Process.all(self.db_conn))) - form_data = {'title': 'foo', 'description': 'foo', 'effort': 1.0, - 'condition': []} - self.check_post(form_data, '/process?id=', 302, '/') - form_data['condition'] = [1] + form_data = {'title': 'foo', 'description': 'foo', 'effort': 1.0} + self.post_process(2, form_data | {'conditions': []}) + self.check_post(form_data | {'conditions': [1]}, '/process?id=', 404) + self.check_post({'title': 'foo', 'description': 'foo', + 'is_active': False}, + '/condition', 302, '/condition?id=1') + self.post_process(3, form_data | {'conditions': [1]}) + self.post_process(4, form_data | {'disables': [1]}) + self.post_process(5, form_data | {'enables': [1]}) + form_data['delete'] = '' self.check_post(form_data, '/process?id=', 404) - form_data_cond = {'title': 'foo', 'description': 'foo'} - self.check_post(form_data_cond, '/condition', 302, '/') - self.check_post(form_data, '/process?id=', 302, '/') - form_data['disables'] = [1] - self.check_post(form_data, '/process?id=', 302, '/') - form_data['enables'] = [1] - self.check_post(form_data, '/process?id=', 302, '/') + self.check_post(form_data, '/process?id=6', 404) + self.check_post(form_data, '/process?id=5', 302, '/processes') + + def test_do_POST_process_steps(self) -> None: + """Test behavior of ProcessStep posting.""" + # pylint: disable=too-many-statements + form_data_1 = self.post_process(1) + self.post_process(2) + self.post_process(3) + # post first (top-level) step of process 2 to process 1 + form_data_1['new_top_step'] = [2] + self.post_process(1, form_data_1) + retrieved_process = Process.by_id(self.db_conn, 1) + self.assertEqual(len(retrieved_process.explicit_steps), 1) + retrieved_step = retrieved_process.explicit_steps[0] + retrieved_step_id = retrieved_step.id_ + self.assertEqual(retrieved_step.step_process_id, 2) + self.assertEqual(retrieved_step.owner_id, 1) + self.assertEqual(retrieved_step.parent_step_id, None) + # post empty steps list to process, expect clean slate, and old step to + # completely disappear + form_data_1['new_top_step'] = [] + self.post_process(1, form_data_1) + retrieved_process = Process.by_id(self.db_conn, 1) + self.assertEqual(retrieved_process.explicit_steps, []) + assert retrieved_step_id is not None + with self.assertRaises(NotFoundException): + ProcessStep.by_id(self.db_conn, retrieved_step_id) + # post new first (top_level) step of process 3 to process 1 + form_data_1['new_top_step'] = [3] + self.post_process(1, form_data_1) + retrieved_process = Process.by_id(self.db_conn, 1) + retrieved_step = retrieved_process.explicit_steps[0] + self.assertEqual(retrieved_step.step_process_id, 3) + self.assertEqual(retrieved_step.owner_id, 1) + self.assertEqual(retrieved_step.parent_step_id, None) + # post to process steps list without keeps, expect clean slate + form_data_1['new_top_step'] = [] + form_data_1['steps'] = [retrieved_step.id_] + self.post_process(1, form_data_1) + retrieved_process = Process.by_id(self.db_conn, 1) + self.assertEqual(retrieved_process.explicit_steps, []) + # post to process empty steps list but keep, expect 400 + form_data_1['steps'] = [] + form_data_1['keep_step'] = [retrieved_step_id] + self.check_post(form_data_1, '/process?id=1', 400, '/process?id=1') + # post to process steps list with keep on non-created step, expect 400 + form_data_1['steps'] = [retrieved_step_id] + form_data_1['keep_step'] = [retrieved_step_id] + self.check_post(form_data_1, '/process?id=1', 400, '/process?id=1') + # post to process steps list with keep and process ID, expect 200 + form_data_1[f'step_{retrieved_step_id}_process_id'] = [2] + self.post_process(1, form_data_1) + retrieved_process = Process.by_id(self.db_conn, 1) + self.assertEqual(len(retrieved_process.explicit_steps), 1) + retrieved_step = retrieved_process.explicit_steps[0] + self.assertEqual(retrieved_step.step_process_id, 2) + self.assertEqual(retrieved_step.owner_id, 1) + self.assertEqual(retrieved_step.parent_step_id, None) + # post nonsense, expect 400 and preservation of previous state + form_data_1['steps'] = ['foo'] + form_data_1['keep_step'] = [] + self.check_post(form_data_1, '/process?id=1', 400, '/process?id=1') + retrieved_process = Process.by_id(self.db_conn, 1) + self.assertEqual(len(retrieved_process.explicit_steps), 1) + retrieved_step = retrieved_process.explicit_steps[0] + self.assertEqual(retrieved_step.step_process_id, 2) + self.assertEqual(retrieved_step.owner_id, 1) + self.assertEqual(retrieved_step.parent_step_id, None) + # post to process steps list with keep and process ID, expect 200 + form_data_1['new_top_step'] = [3] + form_data_1['steps'] = [retrieved_step.id_] + form_data_1['keep_step'] = [retrieved_step.id_] + self.post_process(1, form_data_1) + retrieved_process = Process.by_id(self.db_conn, 1) + self.assertEqual(len(retrieved_process.explicit_steps), 2) + retrieved_step_0 = retrieved_process.explicit_steps[1] + self.assertEqual(retrieved_step_0.step_process_id, 3) + self.assertEqual(retrieved_step_0.owner_id, 1) + self.assertEqual(retrieved_step_0.parent_step_id, None) + retrieved_step_1 = retrieved_process.explicit_steps[0] + self.assertEqual(retrieved_step_1.step_process_id, 2) + self.assertEqual(retrieved_step_1.owner_id, 1) + self.assertEqual(retrieved_step_1.parent_step_id, None) + # post to process steps list with keeps etc., but trigger recursion + form_data_1['new_top_step'] = [] + form_data_1['steps'] = [retrieved_step_0.id_, retrieved_step_1.id_] + form_data_1['keep_step'] = [retrieved_step_0.id_, retrieved_step_1.id_] + form_data_1[f'step_{retrieved_step_0.id_}_process_id'] = [2] + form_data_1[f'step_{retrieved_step_1.id_}_process_id'] = [1] + self.check_post(form_data_1, '/process?id=1', 400, '/process?id=1') + # check previous status preserved despite failed steps setting + retrieved_process = Process.by_id(self.db_conn, 1) + self.assertEqual(len(retrieved_process.explicit_steps), 2) + retrieved_step_0 = retrieved_process.explicit_steps[0] + self.assertEqual(retrieved_step_0.step_process_id, 2) + self.assertEqual(retrieved_step_0.owner_id, 1) + self.assertEqual(retrieved_step_0.parent_step_id, None) + retrieved_step_1 = retrieved_process.explicit_steps[1] + self.assertEqual(retrieved_step_1.step_process_id, 3) + self.assertEqual(retrieved_step_1.owner_id, 1) + self.assertEqual(retrieved_step_1.parent_step_id, None) + # post sub-step to step + form_data_1[f'step_{retrieved_step_0.id_}_process_id'] = [3] + form_data_1[f'new_step_to_{retrieved_step_0.id_}'] = [3] + self.post_process(1, form_data_1) + retrieved_process = Process.by_id(self.db_conn, 1) + self.assertEqual(len(retrieved_process.explicit_steps), 3) + retrieved_step_0 = retrieved_process.explicit_steps[1] + self.assertEqual(retrieved_step_0.step_process_id, 2) + self.assertEqual(retrieved_step_0.owner_id, 1) + self.assertEqual(retrieved_step_0.parent_step_id, None) + retrieved_step_1 = retrieved_process.explicit_steps[0] + self.assertEqual(retrieved_step_1.step_process_id, 3) + self.assertEqual(retrieved_step_1.owner_id, 1) + self.assertEqual(retrieved_step_1.parent_step_id, None) + retrieved_step_2 = retrieved_process.explicit_steps[2] + self.assertEqual(retrieved_step_2.step_process_id, 3) + self.assertEqual(retrieved_step_2.owner_id, 1) + self.assertEqual(retrieved_step_2.parent_step_id, retrieved_step_1.id_) def test_do_GET(self) -> None: """Test /process and /processes response codes.""" self.check_get('/process', 200) self.check_get('/process?id=', 200) - self.check_get('/process?id=0', 500) - self.check_get('/process?id=FOO', 400) + self.check_get('/process?id=1', 200) + self.check_get_defaults('/process') self.check_get('/processes', 200) + + def test_fail_GET_process(self) -> None: + """Test invalid GET /process params.""" + # check for invalid IDs + self.check_get('/process?id=foo', 400) + self.check_get('/process?id=0', 500) + # check we catch invalid base64 + self.check_get('/process?title_b64=foo', 400) + # check failure on references to unknown processes; we create Process + # of ID=1 here so we know the 404 comes from step_to=2 etc. (that tie + # the Process displayed by /process to others), not from not finding + # the main Process itself + self.post_process(1) + self.check_get('/process?id=1&step_to=2', 404) + self.check_get('/process?id=1&has_step=2', 404) + + @classmethod + def GET_processes_dict(cls, procs: list[dict[str, object]] + ) -> dict[str, object]: + """Return JSON of GET /processes to expect.""" + library = {'Process': cls.as_refs(procs)} if procs else {} + d: dict[str, object] = {'processes': cls.as_id_list(procs), + 'sort_by': 'title', + 'pattern': '', + '_library': library} + return d + + @staticmethod + def procstep_as_dict(id_: int, + owner_id: int, + step_process_id: int, + parent_step_id: int | None = None + ) -> dict[str, object]: + """Return JSON of Process to expect.""" + return {'id': id_, + 'owner_id': owner_id, + 'step_process_id': step_process_id, + 'parent_step_id': parent_step_id} + + def test_GET_processes(self) -> None: + """Test GET /processes.""" + # pylint: disable=too-many-statements + # test empty result on empty DB, default-settings on empty params + expected = self.GET_processes_dict([]) + self.check_json_get('/processes', expected) + # test on meaningless non-empty params (incl. entirely un-used key), + # that 'sort_by' default to 'title' (even if set to something else, as + # long as without handler) and 'pattern' get preserved + expected['pattern'] = 'bar' # preserved despite zero effect! + url = '/processes?sort_by=foo&pattern=bar&foo=x' + self.check_json_get(url, expected) + # test non-empty result, automatic (positive) sorting by title + post1: dict[str, Any] + post2: dict[str, Any] + post3: dict[str, Any] + post1 = {'title': 'foo', 'description': 'oof', 'effort': 1.0} + post2 = {'title': 'bar', 'description': 'rab', 'effort': 1.1} + post2['new_top_step'] = 1 + post3 = {'title': 'baz', 'description': 'zab', 'effort': 0.9} + post3['new_top_step'] = 1 + self.post_process(1, post1) + self.post_process(2, post2) + self.post_process(3, post3) + post3['new_top_step'] = 2 + post3['keep_step'] = 2 + post3['steps'] = [2] + post3['step_2_process_id'] = 1 + self.post_process(3, post3) + proc1 = self.proc_as_dict(1, post1['title'], + post1['description'], post1['effort']) + proc2 = self.proc_as_dict(2, post2['title'], + post2['description'], post2['effort']) + proc3 = self.proc_as_dict(3, post3['title'], + post3['description'], post3['effort']) + proc2['explicit_steps'] = [1] + proc3['explicit_steps'] = [2, 3] + step1 = self.procstep_as_dict(1, 2, 1) + step2 = self.procstep_as_dict(2, 3, 1) + step3 = self.procstep_as_dict(3, 3, 2) + expected = self.GET_processes_dict([proc2, proc3, proc1]) + assert isinstance(expected['_library'], dict) + expected['_library']['ProcessStep'] = self.as_refs([step1, step2, + step3]) + self.check_json_get('/processes', expected) + # test other sortings + expected['sort_by'] = '-title' + expected['processes'] = self.as_id_list([proc1, proc3, proc2]) + self.check_json_get('/processes?sort_by=-title', expected) + expected['sort_by'] = 'effort' + expected['processes'] = self.as_id_list([proc3, proc1, proc2]) + self.check_json_get('/processes?sort_by=effort', expected) + expected['sort_by'] = '-effort' + expected['processes'] = self.as_id_list([proc2, proc1, proc3]) + self.check_json_get('/processes?sort_by=-effort', expected) + expected['sort_by'] = 'steps' + expected['processes'] = self.as_id_list([proc1, proc2, proc3]) + self.check_json_get('/processes?sort_by=steps', expected) + expected['sort_by'] = '-steps' + expected['processes'] = self.as_id_list([proc3, proc2, proc1]) + self.check_json_get('/processes?sort_by=-steps', expected) + expected['sort_by'] = 'owners' + expected['processes'] = self.as_id_list([proc3, proc2, proc1]) + self.check_json_get('/processes?sort_by=owners', expected) + expected['sort_by'] = '-owners' + expected['processes'] = self.as_id_list([proc1, proc2, proc3]) + self.check_json_get('/processes?sort_by=-owners', expected) + # test pattern matching on title + expected = self.GET_processes_dict([proc2, proc3]) + assert isinstance(expected['_library'], dict) + expected['pattern'] = 'ba' + expected['_library']['ProcessStep'] = self.as_refs([step1, step2, + step3]) + self.check_json_get('/processes?pattern=ba', expected) + # test pattern matching on description + expected['processes'] = self.as_id_list([proc1]) + expected['_library'] = {'Process': self.as_refs([proc1])} + expected['pattern'] = 'of' + self.check_json_get('/processes?pattern=of', expected)