X-Git-Url: https://plomlompom.com/repos/%7B%7B%20web_path%20%7D%7D/decks/%7B%7Bdeck_id%7D%7D/cards/%7B%7Bcard_id%7D%7D/form?a=blobdiff_plain;f=tests%2Fdays.py;h=4e70e097b5d1c53c709d43fb1b42462fe186c248;hb=e87f540aa7b550881462cb88380a773b328c0a3d;hp=3da78ee0bc71b0dda15e87d7af609a50d55e5c74;hpb=49edaa072a3574f2303828e62c6a72f0d0bcec2c;p=plomtask diff --git a/tests/days.py b/tests/days.py index 3da78ee..4e70e09 100644 --- a/tests/days.py +++ b/tests/days.py @@ -2,22 +2,22 @@ from unittest import TestCase from datetime import datetime from tests.utils import TestCaseWithDB, TestCaseWithServer -from plomtask.days import Day, todays_date -from plomtask.exceptions import BadFormatException, NotFoundException +from plomtask.dating import date_in_n_days +from plomtask.days import Day 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__.""" @@ -27,137 +27,163 @@ class TestsSansDB(TestCase): 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_Day_saving_and_caching(self) -> None: - """Test .save/.save_core.""" - date = '2024-01-01' - comment = 'comment' - day = Day(date, comment) - # check object init itself doesn't store anything yet - self.assertEqual({}, Day.get_cache()) - self.assertEqual([], Day.all(self.db_conn)) - # check saving stores in cache and DB - day.save(self.db_conn) - assert isinstance(day.id_, str) - for row in self.db_conn.row_where(Day.table_name, 'id', day.id_): - self.assertEqual(day, Day.from_table_row(self.db_conn, row)) - self.assertEqual({day.id_: day}, Day.get_cache()) - # check attributes set properly (and not unset by saving) - self.assertEqual(day.id_, date) - self.assertEqual(day.comment, comment) - - def test_Day_by_id(self) -> None: - """Test .by_id().""" - date1 = '2024-01-01' - date2 = '2024-01-02' - # check failure if not yet saved - day1 = Day(date1) - with self.assertRaises(NotFoundException): - Day.by_id(self.db_conn, date1) - # check identity of saved and retrieved - day1.save(self.db_conn) - self.assertEqual(day1, Day.by_id(self.db_conn, date1)) - # check create=True acts like normal instantiation (sans saving) - by_id_created = Day.by_id(self.db_conn, date2, create=True) - self.assertEqual(Day(date2), by_id_created) - self.assertEqual({day1.id_: day1}, Day.get_cache()) - self.assertEqual([day1], Day.all(self.db_conn)) - - def test_Day_all(self) -> None: - """Test Day.all(), especially in regards to date range filtering.""" - date1 = '2024-01-01' - date2 = '2024-01-02' - date3 = '2024-01-03' + def test_Day_by_date_range_filled(self) -> None: + """Test Day.by_date_range_filled.""" + date1, date2, date3 = self.default_ids day1 = Day(date1) day2 = Day(date2) day3 = Day(date3) - day1.save(self.db_conn) - day3.save(self.db_conn) - # check that all() shows all saved, but no unsaved items - self.assertEqual(Day.all(self.db_conn), - [day1, day3]) - day2.save(self.db_conn) - self.assertEqual(Day.all(self.db_conn), - [day1, day2, day3]) - # check empty date range values show everything - self.assertEqual(Day.all(self.db_conn, ('', '')), - [day1, day2, day3]) - # check date range is open interval - self.assertEqual(Day.all(self.db_conn, (date1, 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.all(self.db_conn, (date2, date3)), + self.assertEqual(Day.by_date_range_filled(self.db_conn, date2, date3), [day2, day3]) - self.assertEqual(Day.all(self.db_conn, (date3, '')), - [day3]) # check second date range value excludes what's later - self.assertEqual(Day.all(self.db_conn, ('', date2)), + self.assertEqual(Day.by_date_range_filled(self.db_conn, date1, date2), [day1, day2]) # check swapped (impossible) date range returns emptiness - self.assertEqual(Day.all(self.db_conn, (date3, date1)), + self.assertEqual(Day.by_date_range_filled(self.db_conn, date3, date1), []) # check fill_gaps= instantiates unsaved dates within date range # (but does not store them) - day4 = Day('2024-01-04') day5 = Day('2024-01-05') day6 = Day('2024-01-06') day6.save(self.db_conn) - self.assertEqual(Day.all(self.db_conn, (date2, '2024-01-07'), - fill_gaps=True), - [day2, day3, day4, day5, day6]) - self.assertEqual(Day.get_cache().keys(), - {date1, date2, date3, day6.date}) - assert isinstance(day4.id_, str) - assert isinstance(day5.id_, str) - self.assertEqual(self.db_conn.row_where(Day.table_name, - 'id', day4.id_), []) - self.assertEqual(self.db_conn.row_where(Day.table_name, - 'id', day5.id_), []) + day7 = Day('2024-01-07') + self.assertEqual(Day.by_date_range_filled(self.db_conn, + day5.date, day7.date), + [day5, day6, day7]) + self.check_identity_with_cache_and_db([day1, day2, day3, day6]) # check 'today' is interpreted as today's date - today = Day(todays_date()) - today.save(self.db_conn) - self.assertEqual(Day.all(self.db_conn, ('today', 'today')), [today]) - - def test_Day_remove(self) -> None: - """Test .remove() effects on DB and cache.""" - date = '2024-01-01' - day = Day(date) - day.save(self.db_conn) - day.remove(self.db_conn) - assert isinstance(day.id_, str) - self.assertEqual(self.db_conn.row_where(Day.table_name, - 'id', day.id_), []) - self.assertEqual(Day.get_cache(), {}) - - def test_Day_singularity(self) -> None: - """Test pointers made for single object keep pointing to it.""" - day = Day('2024-01-01') - day.save(self.db_conn) - retrieved_day = Day.by_id(self.db_conn, '2024-01-01') - day.comment = 'foo' - self.assertEqual(retrieved_day.comment, 'foo') + today = Day(date_in_n_days(0)) + self.assertEqual(Day.by_date_range_filled(self.db_conn, + 'today', 'today'), + [today]) + 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).""" + @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(self) -> None: + """Test GET /day basics.""" + # pylint: disable=too-many-statements + # 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])}} + 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) + # check GET with two Todos and Processes + expected['make_type'] = '' + form_data = self.post_process(1) + form_data['title'] = 'bar' + form_data['description'] = 'rab' + form_data['effort'] = 0.9 + self.post_process(2, form_data) + post_day['new_todo'] = [1, 2] + self.check_post(post_day, f'/day?date={date}', 302, + f'/day?date={date}&make_type=foo') + proc1 = self.proc_as_dict(1, 'foo', 'foo', 1.1) + proc2 = self.proc_as_dict(2, 'bar', 'rab', 0.9) + expected['_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) + expected['_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) @@ -166,8 +192,8 @@ class TestsWithServer(TestCaseWithServer): def test_do_POST_day(self) -> None: """Test POST /day.""" - form_data = {'comment': ''} + form_data = {'day_comment': '', 'make_type': 'full'} self.check_post(form_data, '/day', 400) self.check_post(form_data, '/day?date=foo', 400) - self.check_post(form_data, '/day?date=2024-01-01', 302) + self.check_post(form_data, '/day?date=2024-01-01&make_type=full', 302) self.check_post({'foo': ''}, '/day?date=2024-01-01', 400)