"""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."""
checked_class = Day
default_ids = ('2024-01-01', '2024-01-02', '2024-01-03')
- def test_saving_and_caching(self) -> None:
- """Test storage of instances.
-
- We don't use the parent class's method here because the checked class
- has too different a handling of IDs.
- """
- kwargs = {'date': self.default_ids[0], 'comment': 'foo'}
- self.check_saving_and_caching(**kwargs)
-
- def test_Day_by_id(self) -> None:
- """Test .by_id()."""
- self.check_by_id()
-
def test_Day_by_date_range_filled(self) -> None:
"""Test Day.by_date_range_filled."""
date1, date2, date3 = self.default_ids
- day1, day2, day3 = self.check_all()
- # check date range is a closed interval
+ day1 = Day(date1)
+ day2 = Day(date2)
+ day3 = Day(date3)
+ 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.assertEqual(Day.by_date_range_filled(self.db_conn,
day5.date, day7.date),
[day5, day6, day7])
- self.check_storage([day1, day2, day3, day6])
+ 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()
-
- def test_Day_singularity(self) -> None:
- """Test pointers made for single object keep pointing to it."""
- self.check_singularity('day_comment', 'boo')
+ 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': []},
+ @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',
+ ) -> 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': [],
+ 'disables': [],
+ 'enables': [],
+ 'blockers': []}
+ 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}
+
+ def test_do_GET_day_basics(self) -> None:
+ """Test GET /day basics."""
+ # 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': []}
- retrieved = json_loads(response.read().decode())
- self.assertEqual(expected, retrieved)
+ 'processes': [],
+ '_library': {'Day': self.as_refs([day])}}
+ 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])
+ 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])
+ 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])
+ 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')
+ 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(self) -> None:
+ """Test GET /day displaying posted Todos (no tree structure)."""
+ # check GET with two Todos and Processes
+ 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]
+ 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