home · contact · privacy
Refactor request handler delete or retrieving items on POST.
[plomtask] / tests / conditions.py
index 478124650bd7dd72d984920de105cab3dce033dd..25a044fe88d87019334a70a9befd18c8e60818da 100644 (file)
 """Test Conditions module."""
-from tests.utils import TestCaseWithDB, TestCaseWithServer
+from tests.utils import TestCaseWithDB, TestCaseWithServer, TestCaseSansDB
 from plomtask.conditions import Condition
-from plomtask.exceptions import NotFoundException
+from plomtask.processes import Process
+from plomtask.todos import Todo
+from plomtask.exceptions import HandledException
+
+
+class TestsSansDB(TestCaseSansDB):
+    """Tests requiring no DB setup."""
+    checked_class = Condition
+    versioned_defaults_to_test = {'title': 'UNNAMED', 'description': ''}
 
 
 class TestsWithDB(TestCaseWithDB):
     """Tests requiring DB, but not server setup."""
+    checked_class = Condition
+    default_init_kwargs = {'is_active': False}
+    test_versioneds = {'title': str, 'description': str}
 
-    def test_Condition_by_id(self) -> None:
-        """Test creation and findability."""
-        condition = Condition(None, False)
-        condition.save(self.db_conn)
-        self.assertEqual(Condition.by_id(self.db_conn, 1), condition)
-        with self.assertRaises(NotFoundException):
-            self.assertEqual(Condition.by_id(self.db_conn, 0), condition)
-        with self.assertRaises(NotFoundException):
-            self.assertEqual(Condition.by_id(self.db_conn, 2), condition)
-
-    def test_Condition_all(self) -> None:
-        """Test .all()."""
-        self.assertEqual(Condition.all(self.db_conn), [])
-        condition_1 = Condition(None, False)
-        condition_1.save(self.db_conn)
-        self.assertEqual(Condition.all(self.db_conn), [condition_1])
-        condition_2 = Condition(None, False)
-        condition_2.save(self.db_conn)
-        self.assertEqual(Condition.all(self.db_conn), [condition_1,
-                                                       condition_2])
-
-    def test_Condition_singularity(self) -> None:
-        """Test pointers made for single object keep pointing to it."""
-        condition_1 = Condition(None, False)
-        condition_1.save(self.db_conn)
-        condition_1.is_active = True
-        condition_retrieved = Condition.by_id(self.db_conn, 1)
-        self.assertEqual(True, condition_retrieved.is_active)
+    def test_remove(self) -> None:
+        """Test .remove() effects on DB and cache."""
+        super().test_remove()
+        proc = Process(None)
+        proc.save(self.db_conn)
+        todo = Todo(None, proc, False, '2024-01-01')
+        for depender in (proc, todo):
+            assert hasattr(depender, 'save')
+            assert hasattr(depender, 'set_conditions')
+            c = Condition(None)
+            c.save(self.db_conn)
+            depender.save(self.db_conn)
+            depender.set_conditions(self.db_conn, [c.id_], 'conditions')
+            depender.save(self.db_conn)
+            with self.assertRaises(HandledException):
+                c.remove(self.db_conn)
+            depender.set_conditions(self.db_conn, [], 'conditions')
+            depender.save(self.db_conn)
+            c.remove(self.db_conn)
 
 
 class TestsWithServer(TestCaseWithServer):
     """Module tests against our HTTP server/handler (and database)."""
 
     def test_do_POST_condition(self) -> None:
-        """Test POST /condition and its effect on the database."""
-        form_data = {'title': 'foo', 'description': 'foo'}
-        self.check_post(form_data, '/condition', 302, '/')
-        self.assertEqual(1, len(Condition.all(self.db_conn)))
-
-    def test_do_GET(self) -> None:
-        """Test /condition and /conditions response codes."""
-        self.check_get('/condition', 200)
-        self.check_get('/condition?id=', 200)
-        self.check_get('/condition?id=0', 400)
-        self.check_get('/condition?id=FOO', 400)
-        self.check_get('/conditions', 200)
+        """Test POST /condition and its effect on GET /condition[s]."""
+        # check empty POST fails
+        self.check_post({}, '/condition', 400)
+        # test valid POST's effect on …
+        post = {'title': 'foo', 'description': 'oof', 'is_active': False}
+        self.check_post(post, '/condition', 302, '/condition?id=1')
+        # … single /condition
+        cond = self.cond_as_dict(titles=['foo'], descriptions=['oof'])
+        assert isinstance(cond['_versioned'], dict)
+        expected_single: dict[str, object]
+        expected_single = {'is_new': False,
+                           'enabled_processes': [],
+                           'disabled_processes': [],
+                           'enabling_processes': [],
+                           'disabling_processes': [],
+                           'condition': cond['id'],
+                           '_library': {'Condition': self.as_refs([cond])}}
+        self.check_json_get('/condition?id=1', expected_single)
+        # … full /conditions
+        expected_all: dict[str, object]
+        expected_all = {'conditions': self.as_id_list([cond]),
+                        'sort_by': 'title', 'pattern': '',
+                        '_library': {'Condition': self.as_refs([cond])}}
+        self.check_json_get('/conditions', expected_all)
+        # test effect of invalid POST to existing Condition on /condition
+        self.check_post({}, '/condition?id=1', 400)
+        self.check_json_get('/condition?id=1', expected_single)
+        # test effect of POST changing title and activeness
+        post = {'title': 'bar', 'description': 'oof', 'is_active': True}
+        self.check_post(post, '/condition?id=1', 302)
+        cond['_versioned']['title'][1] = 'bar'
+        cond['is_active'] = True
+        self.check_json_get('/condition?id=1', expected_single)
+        # test deletion POST's effect on …
+        self.check_post({'delete': ''}, '/condition?id=1', 302, '/conditions')
+        cond = self.cond_as_dict()
+        assert isinstance(expected_single['_library'], dict)
+        assert isinstance(expected_single['_library']['Condition'], dict)
+        expected_single['_library']['Condition'] = self.as_refs([cond])
+        self.check_json_get('/condition?id=1', expected_single)
+        # … full /conditions
+        expected_all['conditions'] = []
+        expected_all['_library'] = {}
+        self.check_json_get('/conditions', expected_all)
+
+    def test_do_GET_condition(self) -> None:
+        """More GET /condition testing, especially for Process relations."""
+        # check expected default status codes
+        self.check_get_defaults('/condition')
+        # check display of process relations
+        form_data = {'title': 'foo', 'description': 'oof', 'is_active': False}
+        self.check_post(form_data, '/condition', 302, '/condition?id=1')
+        proc_1_post = {'title': 'A', 'description': '', 'effort': 1.0,
+                       'conditions': [1], 'disables': [1]}
+        self.post_process(1, proc_1_post)
+        proc_2_post = {'title': 'B', 'description': '', 'effort': 1.0,
+                       'enables': [1], 'blockers': [1]}
+        self.post_process(2, proc_2_post)
+        cond = self.cond_as_dict(titles=['foo'], descriptions=['oof'])
+        assert isinstance(cond['id'], int)
+        proc_1 = self.proc_as_dict(conditions=[cond['id']],
+                                   disables=[cond['id']])
+        proc_2 = self.proc_as_dict(2, 'B',
+                                   blockers=[cond['id']],
+                                   enables=[cond['id']])
+        expected = {'is_new': False,
+                    'enabled_processes': self.as_id_list([proc_1]),
+                    'disabled_processes': self.as_id_list([proc_2]),
+                    'enabling_processes': self.as_id_list([proc_2]),
+                    'disabling_processes': self.as_id_list([proc_1]),
+                    'condition': cond['id'],
+                    '_library': {'Condition': self.as_refs([cond]),
+                                 'Process': self.as_refs([proc_1, proc_2])}}
+        self.check_json_get('/condition?id=1', expected)
+
+    def test_do_GET_conditions(self) -> None:
+        """Test GET /conditions."""
+        # test empty result on empty DB, default-settings on empty params
+        expected_json: dict[str, object] = {'conditions': [],
+                                            'sort_by': 'title',
+                                            'pattern': '',
+                                            '_library': {}}
+        self.check_json_get('/conditions', expected_json)
+        # test on meaningless non-empty params (incl. entirely un-used key)
+        expected_json = {'conditions': [],
+                         'sort_by': 'title',  # nonsense "foo" defaulting
+                         'pattern': 'bar',  # preserved despite zero effect
+                         '_library': {}}
+        self.check_json_get('/conditions?sort_by=foo&pattern=bar&foo=x',
+                            expected_json)
+        # test non-empty result, automatic (positive) sorting by title
+        post_1 = {'title': 'foo', 'description': 'oof', 'is_active': False}
+        self.check_post(post_1, '/condition', 302, '/condition?id=1')
+        post_2 = {'title': 'bar', 'description': 'rab', 'is_active': False}
+        self.check_post(post_2, '/condition', 302, '/condition?id=2')
+        post_3 = {'title': 'baz', 'description': 'zab', 'is_active': True}
+        self.check_post(post_3, '/condition', 302, '/condition?id=3')
+        cond_1 = self.cond_as_dict(titles=['foo'], descriptions=['oof'])
+        cond_2 = self.cond_as_dict(2, titles=['bar'], descriptions=['rab'])
+        cond_3 = self.cond_as_dict(3, True, ['baz'], ['zab'])
+        cons = [cond_2, cond_3, cond_1]
+        expected_json = {'conditions': self.as_id_list(cons),
+                         'sort_by': 'title',
+                         'pattern': '',
+                         '_library': {'Condition': self.as_refs(cons)}}
+        self.check_json_get('/conditions', expected_json)
+        # test other sortings
+        # (NB: by .is_active has two items of =False, their order currently
+        # is not explicitly made predictable, so mail fail until we do)
+        expected_json['conditions'] = self.as_id_list([cond_1, cond_3, cond_2])
+        expected_json['sort_by'] = '-title'
+        self.check_json_get('/conditions?sort_by=-title', expected_json)
+        expected_json['conditions'] = self.as_id_list([cond_1, cond_2, cond_3])
+        expected_json['sort_by'] = 'is_active'
+        self.check_json_get('/conditions?sort_by=is_active', expected_json)
+        expected_json['conditions'] = self.as_id_list([cond_3, cond_1, cond_2])
+        expected_json['sort_by'] = '-is_active'
+        self.check_json_get('/conditions?sort_by=-is_active', expected_json)
+        # test pattern matching on title
+        cons = [cond_2, cond_3]
+        expected_json = {'conditions': self.as_id_list(cons),
+                         'sort_by': 'title', 'pattern': 'ba',
+                         '_library': {'Condition': self.as_refs(cons)}}
+        self.check_json_get('/conditions?pattern=ba', expected_json)
+        # test pattern matching on description
+        expected_json['conditions'] = self.as_id_list([cond_1])
+        assert isinstance(expected_json['_library'], dict)
+        expected_json['_library']['Condition'] = self.as_refs([cond_1])
+        expected_json['pattern'] = 'oo'
+        self.check_json_get('/conditions?pattern=oo', expected_json)