home · contact · privacy
Refactor Days tests.
[plomtask] / tests / days.py
index 3524a660b023b2aedcd8c4568181f9b5a77e947d..f67c80adfa96d144585af2b59f0f59b0efa7d607 100644 (file)
@@ -9,8 +9,8 @@ from plomtask.exceptions import BadFormatException, NotFoundException
 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 +20,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,21 +31,57 @@ 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."""
 
-    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'))
+    def check_storage(self, content: list[Day]) -> None:
+        """Test cache and DB equal content."""
+        expected_cache = {}
+        for item in content:
+            expected_cache[item.id_] = item
+        self.assertEqual(Day.get_cache(), expected_cache)
+        db_found: list[Day] = []
+        for item in content:
+            assert isinstance(item.id_, str)
+            for row in self.db_conn.row_where(Day.table_name, 'id', item.id_):
+                db_found += [Day.from_table_row(self.db_conn, row)]
+        self.assertEqual(sorted(content), sorted(db_found))
+
+    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.check_storage([])
+        # check saving stores in cache and DB
+        day.save(self.db_conn)
+        self.check_storage([day])
+        # 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_date(self.db_conn, '2024-01-02')
-        self.assertEqual(Day('2024-01-02'),
-                         Day.by_date(self.db_conn, '2024-01-02', create=True))
+            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.check_storage([day1])
 
     def test_Day_all(self) -> None:
         """Test Day.all(), especially in regards to date range filtering."""
@@ -56,24 +92,32 @@ class TestsWithDB(TestCaseWithDB):
         day2 = Day(date2)
         day3 = Day(date3)
         day1.save(self.db_conn)
-        day2.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 a closed interval
         self.assertEqual(Day.all(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)),
                          [day2, day3])
         self.assertEqual(Day.all(self.db_conn, (date3, '')),
                          [day3])
-        self.assertEqual(Day.all(self.db_conn, (date1, '')),
-                         [day1, day2, day3])
+        # check second date range value excludes what's later
         self.assertEqual(Day.all(self.db_conn, ('', date2)),
                          [day1, day2])
+        # check swapped (impossible) date range returns emptiness
         self.assertEqual(Day.all(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')
@@ -81,20 +125,25 @@ class TestsWithDB(TestCaseWithDB):
         self.assertEqual(Day.all(self.db_conn, (date2, '2024-01-07'),
                                  fill_gaps=True),
                          [day2, day3, day4, day5, day6])
+        self.check_storage([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_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."""
+        date = '2024-01-01'
+        day = Day(date)
+        day.save(self.db_conn)
+        day.remove(self.db_conn)
+        self.check_storage([])
 
     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')
+        retrieved_day = Day.by_id(self.db_conn, '2024-01-01')
         day.comment = 'foo'
         self.assertEqual(retrieved_day.comment, 'foo')
 
@@ -118,5 +167,5 @@ class TestsWithServer(TestCaseWithServer):
         form_data = {'comment': ''}
         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', 302)
         self.check_post({'foo': ''}, '/day?date=2024-01-01', 400)