"""Test Days module."""
from unittest import TestCase
from datetime import datetime
+from typing import Callable
from tests.utils import TestCaseWithDB, TestCaseWithServer
from plomtask.dating import date_in_n_days
from plomtask.days import Day
class TestsWithServer(TestCaseWithServer):
"""Tests against our HTTP server/handler (and database)."""
- @staticmethod
- def day_dict(date: str) -> dict[str, object]:
- """Return JSON of Process to expect."""
- return {'id': date, 'comment': '', 'todos': []}
-
@staticmethod
def todo_as_dict(id_: int = 1,
process_id: int = 1,
date: str = '2024-01-01',
+ conditions: None | list[int] = None,
+ disables: None | list[int] = None,
+ blockers: None | list[int] = None,
+ enables: None | list[int] = None
) -> dict[str, object]:
"""Return JSON of Process to expect."""
# pylint: disable=too-many-arguments
'children': [],
'parents': [],
'effort': None,
- 'conditions': [],
- 'disables': [],
- 'enables': [],
- 'blockers': []}
+ 'conditions': conditions if conditions else [],
+ 'disables': disables if disables else [],
+ 'blockers': blockers if blockers else [],
+ 'enables': enables if enables else []}
return d
@staticmethod
"""Return JSON of TodoNode to expect."""
return {'children': [], 'seen': False, 'todo': todo_id}
+ @staticmethod
+ def get_day_dict(date: str) -> dict[str, object]:
+ """Return JSON of GET /day to expect."""
+ day: dict[str, object] = {'id': date, 'comment': '', 'todos': []}
+ d: dict[str, object]
+ d = {'day': date,
+ 'top_nodes': [],
+ 'make_type': '',
+ 'enablers_for': {},
+ 'disablers_for': {},
+ 'conditions_present': [],
+ 'processes': [],
+ '_library': {'Day': TestsWithServer.as_refs([day])}}
+ return d
+
+ def post_day(self, params: str = '',
+ form_data: None | dict[str, object] = None,
+ redir_to: str = '',
+ status: int = 302,
+ ) -> None:
+ """POST /day?{params} with form_data."""
+ if not form_data:
+ form_data = {'day_comment': '', 'make_type': ''}
+ target = f'/day?{params}'
+ if not redir_to:
+ redir_to = f'{target}&make_type={form_data["make_type"]}'
+ self.check_post(form_data, target, status, redir_to)
+
def test_do_GET_day_basics(self) -> None:
- """Test GET /day basics."""
+ """Test GET /day basics (no Todos)."""
# check undefined day
date = date_in_n_days(0)
- day = self.day_dict(date)
- expected: dict[str, object]
- expected = {'day': date,
- 'top_nodes': [],
- 'make_type': '',
- 'enablers_for': {},
- 'disablers_for': {},
- 'conditions_present': [],
- 'processes': [],
- '_library': {'Day': self.as_refs([day])}}
+ expected = self.get_day_dict(date)
self.check_json_get('/day', expected)
# check "today", "yesterday", "tomorrow" days
self.check_json_get('/day?date=today', expected)
- day = self.day_dict(date_in_n_days(1))
- expected['day'] = day['id']
- assert isinstance(expected['_library'], dict)
- expected['_library']['Day'] = self.as_refs([day])
+ expected = self.get_day_dict(date_in_n_days(1))
self.check_json_get('/day?date=tomorrow', expected)
- day = self.day_dict(date_in_n_days(-1))
- expected['day'] = day['id']
- expected['_library']['Day'] = self.as_refs([day])
+ expected = self.get_day_dict(date_in_n_days(-1))
self.check_json_get('/day?date=yesterday', expected)
# check wrong day strings
self.check_get('/day?date=foo', 400)
self.check_get('/day?date=2024-02-30', 400)
# check defined day
date = '2024-01-01'
- day = self.day_dict(date)
- expected['day'] = day['id']
- expected['_library']['Day'] = self.as_refs([day])
+ expected = self.get_day_dict(date)
self.check_json_get(f'/day?date={date}', expected)
# check saved day
- post_day: dict[str, object] = {'day_comment': 'foo', 'make_type': ''}
- self.check_post(post_day, f'/day?date={date}', 302,
- f'/day?date={date}&make_type=')
- day['comment'] = post_day['day_comment']
- self.check_json_get(f'/day?date={date}', expected)
- # check GET parameter POST not affecting reply to non-parameter GET
- post_day['make_type'] = 'foo'
- self.check_post(post_day, f'/day?date={date}', 302,
- f'/day?date={date}&make_type=foo')
+ post: dict[str, object] = {'day_comment': 'foo', 'make_type': ''}
+ self.post_day(f'date={date}', post)
+ assert isinstance(expected['_library'], dict)
+ day = expected['_library']['Day'][date]
+ day['comment'] = post['day_comment']
self.check_json_get(f'/day?date={date}', expected)
+ # check GET parameter to GET requests affects immediate reply, but …
expected['make_type'] = 'bar'
self.check_json_get(f'/day?date={date}&make_type=bar', expected)
+ # … not any following, …
+ expected['make_type'] = ''
+ self.check_json_get(f'/day?date={date}', expected)
+ # … not even when part of a POST request
+ post['make_type'] = 'foo'
+ self.post_day(f'date={date}', post)
+ self.check_json_get(f'/day?date={date}', expected)
- def test_do_GET_day_with_todos(self) -> None:
- """Test GET /day displaying posted Todos (no tree structure)."""
- # check GET with two Todos and Processes
+ @staticmethod
+ def post_batch(list_of_args: list[list[object]],
+ names_of_simples: list[str],
+ names_of_versioneds: list[str],
+ f_as_dict: Callable[..., dict[str, object]],
+ f_to_post: Callable[..., None | dict[str, object]]
+ ) -> list[dict[str, object]]:
+ """Post expected=f_as_dict(*args) as input to f_to_post, for many."""
+ expecteds = []
+ for args in list_of_args:
+ expecteds += [f_as_dict(*args)]
+ for expected in expecteds:
+ assert isinstance(expected['_versioned'], dict)
+ post = {}
+ for name in names_of_simples:
+ post[name] = expected[name]
+ for name in names_of_versioneds:
+ post[name] = expected['_versioned'][name][0]
+ f_to_post(expected['id'], post)
+ return expecteds
+
+ def post_cond(self, id_: int, form_data: dict[str, object]) -> None:
+ """POST Condition of id_ with form_data."""
+ self.check_post(form_data, f'/condition?id={id_}', 302)
+
+ def test_do_GET_day_with_processes_and_todos(self) -> None:
+ """Test GET /day displaying Processes and Todos."""
date = '2024-01-01'
- day = self.day_dict(date)
- post_day: dict[str, object] = {'day_comment': '', 'make_type': ''}
- self.check_post(post_day, f'/day?date={date}', 302,
- f'/day?date={date}&make_type=')
- library: dict[str, object]
- library = {'Day': self.as_refs([day]), 'Process': {}, 'Todo': {}}
- expected: dict[str, object] = {'day': date,
- 'top_nodes': [],
- 'make_type': '',
- 'enablers_for': {},
- 'disablers_for': {},
- 'conditions_present': [],
- 'processes': [],
- '_library': library}
- self.post_process(1)
- post_proc2 = {'title': 'bar', 'description': 'rab', 'effort': 0.9}
- self.post_process(2, post_proc2)
- post_day['new_todo'] = [1, 2]
- self.check_post(post_day, f'/day?date={date}', 302,
- f'/day?date={date}&make_type=')
- proc1 = self.proc_as_dict(1, 'foo', 'foo', 1.1)
- proc2 = self.proc_as_dict(2, 'bar', 'rab', 0.9)
- library['Process'] = self.as_refs([proc1, proc2])
- expected['processes'] = self.as_id_list([proc1, proc2])
- t1 = self.todo_as_dict(1, 1, date)
- t2 = self.todo_as_dict(2, 2, date)
- library['Todo'] = self.as_refs([t1, t2])
- day['todos'] = self.as_id_list([t1, t2])
- n1 = self.todo_node_as_dict(1)
- n2 = self.todo_node_as_dict(2)
- expected['top_nodes'] = [n1, n2]
+ # check Processes get displayed in ['processes'] and ['_library']
+ procs_data = [[1, 'foo', 'oof', 1.1], [2, 'bar', 'rab', 0.9]]
+ procs_expected = self.post_batch(procs_data, [],
+ ['title', 'description', 'effort'],
+ self.proc_as_dict, self.post_process)
+ self.post_day(f'date={date}')
+ expected = self.get_day_dict(date)
+ assert isinstance(expected['_library'], dict)
+ expected['processes'] = self.as_id_list(procs_expected)
+ expected['_library']['Process'] = self.as_refs(procs_expected)
+ self.check_json_get(f'/day?date={date}', expected)
+ # post Todos of either process and check their display
+ post_day: dict[str, object]
+ post_day = {'day_comment': '', 'make_type': '', 'new_todo': [1, 2]}
+ self.post_day(f'date={date}', post_day)
+ todos = [self.todo_as_dict(1, 1, date), self.todo_as_dict(2, 2, date)]
+ expected['_library']['Todo'] = self.as_refs(todos)
+ expected['_library']['Day'][date]['todos'] = self.as_id_list(todos)
+ nodes = [self.todo_node_as_dict(1), self.todo_node_as_dict(2)]
+ expected['top_nodes'] = nodes
+ self.check_json_get(f'/day?date={date}', expected)
+ # add a comment to one Todo and set the other's doneness and effort
+ post_day['new_todo'] = []
+ post_day['todo_id'] = [1, 2]
+ post_day['done'] = [2]
+ post_day['comment'] = ['FOO', '']
+ post_day['effort'] = ['2.3', '']
+ self.post_day(f'date={date}', post_day)
+ expected['_library']['Todo']['1']['comment'] = 'FOO'
+ expected['_library']['Todo']['1']['effort'] = 2.3
+ expected['_library']['Todo']['2']['is_done'] = True
+ self.check_json_get(f'/day?date={date}', expected)
+
+ def test_do_GET_day_with_conditions(self) -> None:
+ """Test GET /day displaying Conditions and their relations."""
+ # add Process with Conditions and their Todos, check display
+ conds_data = [[1, False, ['A'], ['a']], [2, True, ['B'], ['b']]]
+ conds_expected = self.post_batch(conds_data, ['is_active'],
+ ['title', 'description'],
+ self.cond_as_dict, self.post_cond)
+ cond_names = ['conditions', 'disables', 'blockers', 'enables']
+ procs_data = [[1, 'foo', 'oof', 1.1, [1], [1], [2], [2]],
+ [2, 'bar', 'rab', 0.9, [2], [2], [1], [1]]]
+ procs_expected = self.post_batch(procs_data, cond_names,
+ ['title', 'description', 'effort'],
+ self.proc_as_dict, self.post_process)
+ date = '2024-01-01'
+ expected = self.get_day_dict(date)
+ assert isinstance(expected['_library'], dict)
+ expected['processes'] = self.as_id_list(procs_expected)
+ expected['_library']['Process'] = self.as_refs(procs_expected)
+ expected['_library']['Condition'] = self.as_refs(conds_expected)
+ self.post_day(f'date={date}')
+ self.check_json_get(f'/day?date={date}', expected)
+ # add Todos in relation to Conditions, check consequences
+ post_day: dict[str, object]
+ post_day = {'day_comment': '', 'make_type': '', 'new_todo': [1, 2]}
+ self.post_day(f'date={date}', post_day)
+ todos = [self.todo_as_dict(1, 1, date, [1], [1], [2], [2]),
+ self.todo_as_dict(2, 2, date, [2], [2], [1], [1])]
+ expected['_library']['Todo'] = self.as_refs(todos)
+ expected['_library']['Day'][date]['todos'] = self.as_id_list(todos)
+ nodes = [self.todo_node_as_dict(1), self.todo_node_as_dict(2)]
+ expected['top_nodes'] = nodes
+ expected['disablers_for'] = {'1': [1], '2': [2]}
+ expected['enablers_for'] = {'1': [2], '2': [1]}
+ expected['conditions_present'] = self.as_id_list(conds_expected)
self.check_json_get(f'/day?date={date}', expected)
def test_do_GET(self) -> None:
projects / plomtask / blobdiff