"""Test Conditions module."""
-from unittest import TestCase
-from tests.utils import TestCaseWithDB, TestCaseWithServer
+from tests.utils import TestCaseWithDB, TestCaseWithServer, TestCaseSansDB
from plomtask.conditions import Condition
from plomtask.processes import Process
from plomtask.todos import Todo
-from plomtask.exceptions import NotFoundException, HandledException
+from plomtask.exceptions import HandledException
-class TestsSansDB(TestCase):
+class TestsSansDB(TestCaseSansDB):
"""Tests requiring no DB setup."""
-
- def test_Condition_id_setting(self) -> None:
- """Test .id_ being set and its legal range being enforced."""
- with self.assertRaises(HandledException):
- Condition(0)
- condition = Condition(5)
- self.assertEqual(condition.id_, 5)
+ 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 check_storage(self, content: list[Condition]) -> None:
- """Test cache and DB equal content."""
- expected_cache = {}
- for item in content:
- expected_cache[item.id_] = item
- self.assertEqual(Condition.get_cache(), expected_cache)
- db_found: list[Condition] = []
- for item in content:
- assert isinstance(item.id_, int)
- for row in self.db_conn.row_where(Condition.table_name, 'id',
- item.id_):
- db_found += [Condition.from_table_row(self.db_conn, row)]
- self.assertEqual(sorted(content), sorted(db_found))
-
- def test_Condition_saving_and_caching(self) -> None:
- """Test .save/.save_core."""
- c = Condition(None, False)
- c.title.set('title1')
- c.title.set('title2')
- c.description.set('desc1')
- c.description.set('desc2')
- # check object init itself doesn't store anything yet
- self.check_storage([])
- # check saving stores in cache and DB
- c.save(self.db_conn)
- self.check_storage([c])
- # check attributes set properly (and not unset by saving)
- self.assertEqual(c.id_, 1)
- self.assertEqual(c.is_active, False)
- self.assertEqual(sorted(c.title.history.values()),
- ['title1', 'title2'])
- self.assertEqual(sorted(c.description.history.values()),
- ['desc1', 'desc2'])
-
- def test_Condition_from_table_row(self) -> None:
- """Test .from_table_row() properly reads in class from DB"""
- c = Condition(1, True)
- c.title.set('title1')
- c.title.set('title2')
- c.description.set('desc1')
- c.description.set('desc2')
- c.save(self.db_conn)
- assert isinstance(c.id_, int)
- for row in self.db_conn.row_where(Condition.table_name, 'id', c.id_):
- retrieved = Condition.from_table_row(self.db_conn, row)
- assert isinstance(retrieved, Condition)
- self.assertEqual(c, retrieved)
- self.assertEqual({c.id_: c}, Condition.get_cache())
- # pylint: disable=no-member
- self.assertEqual(sorted(retrieved.title.history.values()),
- ['title1', 'title2'])
- # pylint: disable=no-member
- self.assertEqual(sorted(retrieved.description.history.values()),
- ['desc1', 'desc2'])
-
- def test_Condition_by_id(self) -> None:
- """Test .by_id(), including creation."""
- # check failure if not yet saved
- c = Condition(3, False)
- with self.assertRaises(NotFoundException):
- Condition.by_id(self.db_conn, 3)
- # check identity of saved and retrieved
- c.save(self.db_conn)
- self.assertEqual(c, Condition.by_id(self.db_conn, 3))
- # check create=True acts like normal instantiation (sans saving)
- by_id_created = Condition.by_id(self.db_conn, 4, create=True)
- self.assertEqual(Condition(4), by_id_created)
- self.check_storage([c])
-
- def test_Condition_all(self) -> None:
- """Test .all()."""
- c_1 = Condition(None, False)
- # check pre-save .all() returns empty list
- self.assertEqual(Condition.all(self.db_conn), [])
- # check .save() fills .all() result
- c_1.save(self.db_conn)
- self.assertEqual(Condition.all(self.db_conn), [c_1])
- c_2 = Condition(None, True)
- c_2.save(self.db_conn)
- self.assertEqual(sorted(Condition.all(self.db_conn)),
- sorted([c_1, c_2]))
-
- def test_Condition_singularity(self) -> None:
- """Test pointers made for single object keep pointing to it."""
- c = Condition(None, False)
- c.save(self.db_conn)
- c.is_active = True
- retrieved = Condition.by_id(self.db_conn, 1)
- self.assertEqual(True, retrieved.is_active)
-
- def test_Condition_remove(self) -> None:
+ def test_remove(self) -> None:
"""Test .remove() effects on DB and cache."""
- # check only saved item can be removed
- c = Condition(None, False)
- with self.assertRaises(HandledException):
- c.remove(self.db_conn)
- c.save(self.db_conn)
- c.remove(self.db_conn)
- self.check_storage([])
- # check guard against deleting dependencies of other classes
+ 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')
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, '/condition?id=1')
- self.assertEqual(1, len(Condition.all(self.db_conn)))
- form_data['delete'] = ''
- self.check_post(form_data, '/condition?id=', 404)
- self.check_post(form_data, '/condition?id=2', 404)
- self.check_post(form_data, '/condition?id=1', 302, '/conditions')
- self.assertEqual(0, len(Condition.all(self.db_conn)))
-
- def test_do_GET(self) -> None:
- """Test /condition and /conditions response codes."""
- form_data = {'title': 'foo', 'description': 'foo'}
- self.check_post(form_data, '/condition', 302, '/condition?id=1')
+ @classmethod
+ def GET_condition_dict(cls, cond: dict[str, object]) -> dict[str, object]:
+ """Return JSON of GET /condition to expect."""
+ return {'is_new': False,
+ 'enabled_processes': [],
+ 'disabled_processes': [],
+ 'enabling_processes': [],
+ 'disabling_processes': [],
+ 'condition': cond['id'],
+ '_library': {'Condition': cls.as_refs([cond])}}
+
+ @classmethod
+ def GET_conditions_dict(cls, conds: list[dict[str, object]]
+ ) -> dict[str, object]:
+ """Return JSON of GET /conditions to expect."""
+ library = {'Condition': cls.as_refs(conds)} if conds else {}
+ d: dict[str, object] = {'conditions': cls.as_id_list(conds),
+ 'sort_by': 'title',
+ 'pattern': '',
+ '_library': library}
+ return d
+
+ def test_fail_POST_condition(self) -> None:
+ """Test malformed/illegal POST /condition requests."""
+ # check invalid POST payloads
+ url = '/condition'
+ self.check_post({}, url, 400)
+ self.check_post({'title': ''}, url, 400)
+ self.check_post({'title': '', 'description': ''}, url, 400)
+ self.check_post({'title': '', 'is_active': False}, url, 400)
+ self.check_post({'description': '', 'is_active': False}, url, 400)
+ # check valid POST payload on bad paths
+ valid_payload = {'title': '', 'description': '', 'is_active': False}
+ self.check_post(valid_payload, '/condition?id=foo', 400)
+
+ def test_POST_condition(self) -> None:
+ """Test (valid) POST /condition and its effect on GET /condition[s]."""
+ # 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 = self.GET_condition_dict(cond)
+ self.check_json_get('/condition?id=1', expected_single)
+ # … full /conditions
+ expected_all = self.GET_conditions_dict([cond])
+ self.check_json_get('/conditions', expected_all)
+ # test (no) 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)
+ 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_GET_condition(self) -> None:
+ """More GET /condition testing, especially for Process relations."""
+ # check expected default status codes
self.check_get_defaults('/condition')
- self.check_get('/conditions', 200)
+ # make Condition and two Processes that among them establish all
+ # possible ConditionsRelations to it, …
+ cond_post = {'title': 'foo', 'description': 'oof', 'is_active': False}
+ self.check_post(cond_post, '/condition', 302, '/condition?id=1')
+ proc1_post = {'title': 'A', 'description': '', 'effort': 1.0,
+ 'conditions': [1], 'disables': [1]}
+ proc2_post = {'title': 'B', 'description': '', 'effort': 1.0,
+ 'enables': [1], 'blockers': [1]}
+ self.post_process(1, proc1_post)
+ self.post_process(2, proc2_post)
+ # … then check /condition displays all these properly.
+ cond = self.cond_as_dict(titles=['foo'], descriptions=['oof'])
+ assert isinstance(cond['id'], int)
+ proc1 = self.proc_as_dict(conditions=[cond['id']],
+ disables=[cond['id']])
+ proc2 = self.proc_as_dict(2, 'B',
+ blockers=[cond['id']],
+ enables=[cond['id']])
+ expected = self.GET_condition_dict(cond)
+ assert isinstance(expected['_library'], dict)
+ expected['enabled_processes'] = self.as_id_list([proc1])
+ expected['disabled_processes'] = self.as_id_list([proc2])
+ expected['enabling_processes'] = self.as_id_list([proc2])
+ expected['disabling_processes'] = self.as_id_list([proc1])
+ expected['_library']['Process'] = self.as_refs([proc1, proc2])
+ self.check_json_get('/condition?id=1', expected)
+
+ def test_GET_conditions(self) -> None:
+ """Test GET /conditions."""
+ # test empty result on empty DB, default-settings on empty params
+ expected = self.GET_conditions_dict([])
+ self.check_json_get('/conditions', expected)
+ # test on meaningless non-empty params (incl. entirely un-used key),
+ # that 'sort_by' default to 'title' (even if set to something else, as
+ # long as without handler) and 'pattern' get preserved
+ expected['pattern'] = 'bar' # preserved despite zero effect!
+ url = '/conditions?sort_by=foo&pattern=bar&foo=x'
+ self.check_json_get(url, expected)
+ # test non-empty result, automatic (positive) sorting by title
+ post1 = {'is_active': False, 'title': 'foo', 'description': 'oof'}
+ post2 = {'is_active': False, 'title': 'bar', 'description': 'rab'}
+ post3 = {'is_active': True, 'title': 'baz', 'description': 'zab'}
+ self.check_post(post1, '/condition', 302, '/condition?id=1')
+ self.check_post(post2, '/condition', 302, '/condition?id=2')
+ self.check_post(post3, '/condition', 302, '/condition?id=3')
+ cond1 = self.cond_as_dict(1, False, ['foo'], ['oof'])
+ cond2 = self.cond_as_dict(2, False, ['bar'], ['rab'])
+ cond3 = self.cond_as_dict(3, True, ['baz'], ['zab'])
+ expected = self.GET_conditions_dict([cond2, cond3, cond1])
+ self.check_json_get('/conditions', expected)
+ # 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['sort_by'] = '-title'
+ expected['conditions'] = self.as_id_list([cond1, cond3, cond2])
+ self.check_json_get('/conditions?sort_by=-title', expected)
+ expected['sort_by'] = 'is_active'
+ expected['conditions'] = self.as_id_list([cond1, cond2, cond3])
+ self.check_json_get('/conditions?sort_by=is_active', expected)
+ expected['sort_by'] = '-is_active'
+ expected['conditions'] = self.as_id_list([cond3, cond1, cond2])
+ self.check_json_get('/conditions?sort_by=-is_active', expected)
+ # test pattern matching on title
+ expected = self.GET_conditions_dict([cond2, cond3])
+ expected['pattern'] = 'ba'
+ self.check_json_get('/conditions?pattern=ba', expected)
+ # test pattern matching on description
+ assert isinstance(expected['_library'], dict)
+ expected['conditions'] = self.as_id_list([cond1])
+ expected['_library']['Condition'] = self.as_refs([cond1])
+ expected['pattern'] = 'of'
+ self.check_json_get('/conditions?pattern=of', expected)
projects / plomtask / blobdiff