From 7fe796242661ac9676bba745698f374a109b9440 Mon Sep 17 00:00:00 2001 From: Christian Heller Date: Sat, 22 Jun 2024 04:52:26 +0200 Subject: [PATCH] Expand GET /process and /processes tests. --- tests/processes.py | 122 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 122 insertions(+) diff --git a/tests/processes.py b/tests/processes.py index 2f3ebcc..1b20e21 100644 --- a/tests/processes.py +++ b/tests/processes.py @@ -1,4 +1,5 @@ """Test Processes module.""" +from typing import Any from tests.utils import TestCaseWithDB, TestCaseWithServer, TestCaseSansDB from plomtask.processes import Process, ProcessStep, ProcessStepsNode from plomtask.conditions import Condition @@ -384,5 +385,126 @@ class TestsWithServer(TestCaseWithServer): 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=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) -- 2.30.2