"""Test Days module."""
from unittest import TestCase
from datetime import datetime
-from json import loads as json_loads
from tests.utils import TestCaseWithDB, TestCaseWithServer
from plomtask.dating import date_in_n_days
from plomtask.days import Day
-from plomtask.exceptions import BadFormatException
class TestsSansDB(TestCase):
"""Days module tests not requiring DB setup."""
+ legal_ids = ['2024-01-01']
+ illegal_ids = ['foo', '2024-02-30', '2024-02-01 23:00:00']
- def test_Day_valid_date(self) -> None:
- """Test Day's date format validation and parsing."""
- with self.assertRaises(BadFormatException):
- Day('foo')
- with self.assertRaises(BadFormatException):
- Day('2024-02-30')
- with self.assertRaises(BadFormatException):
- Day('2024-02-01 23:00:00')
- self.assertEqual(datetime(2024, 1, 1), Day('2024-01-01').datetime)
+ def test_Day_datetime_weekday_neighbor_dates(self) -> None:
+ """Test Day's date parsing."""
+ self.assertEqual(datetime(2024, 5, 1), Day('2024-05-01').datetime)
+ self.assertEqual('Sunday', Day('2024-03-17').weekday)
+ self.assertEqual('March', Day('2024-03-17').month_name)
+ self.assertEqual('2023-12-31', Day('2024-01-01').prev_date)
+ self.assertEqual('2023-03-01', Day('2023-02-28').next_date)
def test_Day_sorting(self) -> None:
"""Test sorting by .__lt__ and Day.__eq__."""
days = [day3, day1, day2]
self.assertEqual(sorted(days), [day1, day2, day3])
- def test_Day_weekday(self) -> None:
- """Test Day.weekday."""
- self.assertEqual(Day('2024-03-17').weekday, 'Sunday')
-
- def test_Day_neighbor_dates(self) -> None:
- """Test Day.prev_date and Day.next_date."""
- self.assertEqual(Day('2024-01-01').prev_date, '2023-12-31')
- self.assertEqual(Day('2023-02-28').next_date, '2023-03-01')
-
class TestsWithDB(TestCaseWithDB):
"""Tests requiring DB, but not server setup."""
day1 = Day(date1)
day2 = Day(date2)
day3 = Day(date3)
- day1.save(self.db_conn)
- day2.save(self.db_conn)
- day3.save(self.db_conn)
- # check date range is a closed interval
+ for day in [day1, day2, day3]:
+ day.save(self.db_conn)
+ # check date range includes limiter days
self.assertEqual(Day.by_date_range_filled(self.db_conn, date1, date3),
[day1, day2, day3])
# check first date range value excludes what's earlier
self.check_identity_with_cache_and_db([day1, day2, day3, day6])
# check 'today' is interpreted as today's date
today = Day(date_in_n_days(0))
- today.save(self.db_conn)
self.assertEqual(Day.by_date_range_filled(self.db_conn,
'today', 'today'),
[today])
-
- def test_Day_remove(self) -> None:
- """Test .remove() effects on DB and cache."""
- self.check_remove()
+ prev_day = Day(date_in_n_days(-1))
+ next_day = Day(date_in_n_days(1))
+ self.assertEqual(Day.by_date_range_filled(self.db_conn,
+ 'yesterday', 'tomorrow'),
+ [prev_day, today, next_day])
class TestsWithServer(TestCaseWithServer):
"""Tests against our HTTP server/handler (and database)."""
- def test_get_json(self) -> None:
- """Test /day for JSON response."""
- self.conn.request('GET', '/day?date=2024-01-01')
- response = self.conn.getresponse()
- self.assertEqual(response.status, 200)
- expected = {'day': {'id': '2024-01-01',
- 'comment': '',
- 'todos': []},
- 'top_nodes': [],
- 'make_type': '',
- 'enablers_for': {},
- 'disablers_for': {},
- 'conditions_present': [],
- 'processes': []}
- retrieved = json_loads(response.read().decode())
- self.assertEqual(expected, retrieved)
+ @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
+ d = {'id': id_,
+ 'date': date,
+ 'process_id': process_id,
+ 'is_done': False,
+ 'calendarize': False,
+ 'comment': '',
+ 'children': [],
+ 'parents': [],
+ 'effort': None,
+ 'conditions': conditions if conditions else [],
+ 'disables': disables if disables else [],
+ 'blockers': blockers if blockers else [],
+ 'enables': enables if enables else []}
+ return d
+
+ @staticmethod
+ def todo_node_as_dict(todo_id: int) -> dict[str, object]:
+ """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 (no Todos)."""
+ # check undefined day
+ date = date_in_n_days(0)
+ 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)
+ expected = self.get_day_dict(date_in_n_days(1))
+ self.check_json_get('/day?date=tomorrow', expected)
+ 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'
+ expected = self.get_day_dict(date)
+ self.check_json_get(f'/day?date={date}', expected)
+ # check saved day
+ 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 of a POST does not affect reply to param-free GET
+ post['make_type'] = 'foo'
+ self.post_day(f'date={date}', post)
+ self.check_json_get(f'/day?date={date}', expected)
+ expected['make_type'] = 'bar'
+ self.check_json_get(f'/day?date={date}&make_type=bar', expected)
+
+ def test_do_GET_day_with_todos_flat(self) -> None:
+ """Test GET /day displaying posted Todos (no tree structure)."""
+ # post two Todos of differing processes and check their display
+ date = '2024-01-01'
+ self.post_day(f'date={date}')
+ expected = self.get_day_dict(date)
+ post_proc1 = {'title': 'foo', 'description': 'oof', 'effort': 1.1}
+ post_proc2 = {'title': 'bar', 'description': 'rab', 'effort': 0.9}
+ procs: list[dict[str, object]] = [{}, {}]
+ for i, post in enumerate([post_proc1, post_proc2]):
+ self.post_process(i+1, post)
+ assert isinstance(post['title'], str)
+ assert isinstance(post['description'], str)
+ assert isinstance(post['effort'], float)
+ procs[i] = self.proc_as_dict(i+1, post['title'],
+ post['description'], post['effort'])
+ post_day: dict[str, object]
+ post_day = {'day_comment': '', 'make_type': '', 'new_todo': [1, 2]}
+ self.post_day(f'date={date}', post_day)
+ assert isinstance(expected['_library'], dict)
+ expected['_library']['Process'] = self.as_refs(procs)
+ expected['processes'] = self.as_id_list(procs)
+ 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
+ # pylint: disable=too-many-locals
+ post_cond1 = {'title': 'A', 'description': '', 'is_active': False}
+ post_cond2 = {'title': 'B', 'description': '', 'is_active': True}
+ conds: list[dict[str, object]] = [{}, {}]
+ for i, post in enumerate([post_cond1, post_cond2]):
+ self.check_post(post, f'/condition?id={i+1}', 302)
+ assert isinstance(post['is_active'], bool)
+ assert isinstance(post['title'], str)
+ assert isinstance(post['description'], str)
+ conds[i] = self.cond_as_dict(i+1, post['is_active'],
+ [post['title']],
+ [post['description']])
+ post_proc1 = {'title': 'foo', 'description': 'oof', 'effort': 1.1}
+ post_proc2 = {'title': 'bar', 'description': 'rab', 'effort': 0.9}
+ procs: list[dict[str, object]] = [{}, {}]
+ names_input = ('condition', 'disables', 'blocker', 'enables')
+ names_output = ('conditions', 'disables', 'blockers', 'enables')
+ cond_vals = ((1, 1, 2, 2), (2, 2, 1, 1))
+ for i, post in enumerate([post_proc1, post_proc2]):
+ assert isinstance(post['title'], str)
+ assert isinstance(post['description'], str)
+ assert isinstance(post['effort'], float)
+ procs[i] = self.proc_as_dict(i+1, post['title'],
+ post['description'], post['effort'])
+ for j, name_input in enumerate(names_input):
+ post[name_input] = [cond_vals[i][j]]
+ procs[i][names_output[j]] = [cond_vals[i][j]]
+ self.post_process(i+1, post)
+ date = '2024-01-01'
+ expected = self.get_day_dict(date)
+ expected['processes'] = self.as_id_list(procs)
+ assert isinstance(expected['_library'], dict)
+ expected['_library']['Process'] = self.as_refs(procs)
+ expected['_library']['Condition'] = self.as_refs(conds)
+ 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)
+ self.check_json_get(f'/day?date={date}', expected)
def test_do_GET(self) -> None:
"""Test /day and /calendar response codes, and / redirect."""
- self.check_get('/day', 200)
- self.check_get('/day?date=3000-01-01', 200)
- self.check_get('/day?date=FOO', 400)
self.check_get('/calendar', 200)
self.check_get('/calendar?start=&end=', 200)
self.check_get('/calendar?start=today&end=today', 200)
projects / plomtask / blobdiff