home · contact · privacy
Enable server to alternatively output response ctx as JSON, for debugging and testing...
[plomtask] / tests / days.py
index 3524a660b023b2aedcd8c4568181f9b5a77e947d..901667f4c6e0276a2800bf4b21b15b03a17be2fb 100644 (file)
@@ -1,16 +1,18 @@
 """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.days import Day, todays_date
-from plomtask.exceptions import BadFormatException, NotFoundException
+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."""
 
-    def test_Day_dates(self) -> None:
-        """Test Day's date format."""
+    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):
@@ -20,7 +22,7 @@ class TestsSansDB(TestCase):
         self.assertEqual(datetime(2024, 1, 1), Day('2024-01-01').datetime)
 
     def test_Day_sorting(self) -> None:
-        """Test Day.__lt__."""
+        """Test sorting by .__lt__ and Day.__eq__."""
         day1 = Day('2024-01-01')
         day2 = Day('2024-01-02')
         day3 = Day('2024-01-03')
@@ -31,77 +33,96 @@ class TestsSansDB(TestCase):
         """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_by_date(self) -> None:
-        """Test Day.by_date()."""
-        with self.assertRaises(NotFoundException):
-            Day.by_date(self.db_conn, '2024-01-01')
-        Day('2024-01-01').save(self.db_conn)
-        self.assertEqual(Day('2024-01-01'),
-                         Day.by_date(self.db_conn, '2024-01-01'))
-        with self.assertRaises(NotFoundException):
-            Day.by_date(self.db_conn, '2024-01-02')
-        self.assertEqual(Day('2024-01-02'),
-                         Day.by_date(self.db_conn, '2024-01-02', create=True))
-
-    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'
-        day1 = Day(date1)
-        day2 = Day(date2)
-        day3 = Day(date3)
-        day1.save(self.db_conn)
-        day2.save(self.db_conn)
-        day3.save(self.db_conn)
-        self.assertEqual(Day.all(self.db_conn),
-                         [day1, day2, day3])
-        self.assertEqual(Day.all(self.db_conn, ('', '')),
-                         [day1, day2, day3])
-        self.assertEqual(Day.all(self.db_conn, (date1, date3)),
+    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_from_table_row(self) -> None:
+        """Test .from_table_row() properly reads in class from DB"""
+        self.check_from_table_row()
+
+    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
+        self.assertEqual(Day.by_date_range_filled(self.db_conn, date1, date3),
                          [day1, day2, day3])
-        self.assertEqual(Day.all(self.db_conn, (date2, date3)),
+        # check first date range value excludes what's earlier
+        self.assertEqual(Day.by_date_range_filled(self.db_conn, date2, date3),
                          [day2, day3])
-        self.assertEqual(Day.all(self.db_conn, (date3, '')),
-                         [day3])
-        self.assertEqual(Day.all(self.db_conn, (date1, '')),
-                         [day1, day2, day3])
-        self.assertEqual(Day.all(self.db_conn, ('', date2)),
+        # check second date range value excludes what's later
+        self.assertEqual(Day.by_date_range_filled(self.db_conn, date1, date2),
                          [day1, day2])
-        self.assertEqual(Day.all(self.db_conn, (date3, date1)),
+        # check swapped (impossible) date range returns emptiness
+        self.assertEqual(Day.by_date_range_filled(self.db_conn, date3, date1),
                          [])
-        day4 = Day('2024-01-04')
+        # check fill_gaps= instantiates unsaved dates within date range
+        # (but does not store them)
         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])
-        today = Day(todays_date())
+        day7 = Day('2024-01-07')
+        self.assertEqual(Day.by_date_range_filled(self.db_conn,
+                                                  day5.date, day7.date),
+                         [day5, day6, day7])
+        self.check_storage([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.all(self.db_conn, ('today', 'today')), [today])
+        self.assertEqual(Day.by_date_range_filled(self.db_conn,
+                                                  'today', 'today'),
+                         [today])
 
-    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')
+    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."""
-        day = Day('2024-01-01')
-        day.save(self.db_conn)
-        retrieved_day = Day.by_date(self.db_conn, '2024-01-01')
-        day.comment = 'foo'
-        self.assertEqual(retrieved_day.comment, 'foo')
+        self.check_singularity('day_comment', 'boo')
 
 
 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)
+
     def test_do_GET(self) -> None:
         """Test /day and /calendar response codes, and / redirect."""
         self.check_get('/day', 200)
@@ -115,8 +136,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)