class TestsSansDB(TestCaseSansDB):
"""Tests requiring no DB setup."""
checked_class = Condition
- do_id_test = True
- 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_remove(self) -> None:
"""Test .remove() effects on DB and cache."""
proc = Process(None)
proc.save(self.db_conn)
todo = Todo(None, proc, False, '2024-01-01')
+ todo.save(self.db_conn)
+ # check condition can only be deleted if not depended upon
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.set_conditions(self.db_conn, [c.id_])
depender.save(self.db_conn)
with self.assertRaises(HandledException):
c.remove(self.db_conn)
- depender.set_conditions(self.db_conn, [], 'conditions')
+ depender.set_conditions(self.db_conn, [])
depender.save(self.db_conn)
c.remove(self.db_conn)
class TestsWithServer(TestCaseWithServer):
"""Module tests against our HTTP server/handler (and database)."""
- @staticmethod
- def cond_as_dict(id_: int = 1,
- is_active: bool = False,
- titles: None | list[str] = None,
- descriptions: None | list[str] = None
- ) -> dict[str, object]:
- """Return JSON of Condition to expect."""
- d = {'id': id_,
- 'is_active': is_active,
- '_versioned': {
- 'title': {},
- 'description': {}
- }
- }
- titles = titles if titles else []
- descriptions = descriptions if descriptions else []
- assert isinstance(d['_versioned'], dict)
- for i, title in enumerate(titles):
- d['_versioned']['title'][i] = title
- for i, description in enumerate(descriptions):
- d['_versioned']['description'][i] = description
- return d
+ @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])}}
- @staticmethod
- def proc_as_dict(id_: int = 1,
- title: str = 'A',
- enables: None | list[dict[str, object]] = None,
- disables: None | list[dict[str, object]] = None,
- conditions: None | list[dict[str, object]] = None,
- blockers: None | list[dict[str, object]] = None
- ) -> dict[str, object]:
- """Return JSON of Process to expect."""
- # pylint: disable=too-many-arguments
- d = {'id': id_,
- 'calendarize': False,
- 'suppressed_steps': [],
- 'explicit_steps': [],
- '_versioned': {
- 'title': {0: title},
- 'description': {0: ''},
- 'effort': {0: 1.0}
- },
- 'conditions': conditions if conditions else [],
- 'disables': disables if disables else [],
- 'enables': enables if enables else [],
- 'blockers': blockers if blockers else []}
+ @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_do_POST_condition(self) -> None:
- """Test POST /condition and its effect on GET /condition[s]."""
- # check empty POST fails
- self.check_post({}, '/condition', 400)
+ def test_fail_POST_condition(self) -> None:
+ """Test malformed/illegal POST /condition requests."""
+ # check incomplete 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')
+ self.check_post(post, '/condition', redir='/condition?id=1')
# … single /condition
- cond = self.cond_as_dict(titles=['foo'], descriptions=['oof'])
- expected_single: dict[str, object]
- expected_single = {'is_new': False,
- 'enabled_processes': [],
- 'disabled_processes': [],
- 'enabling_processes': [],
- 'disabling_processes': [],
- 'condition': cond}
+ expected_cond = self.cond_as_dict(titles=['foo'], descriptions=['oof'])
+ assert isinstance(expected_cond['_versioned'], dict)
+ expected_single = self.GET_condition_dict(expected_cond)
self.check_json_get('/condition?id=1', expected_single)
# … full /conditions
- expected_all: dict[str, object]
- expected_all = {'conditions': [cond],
- 'sort_by': 'title', 'pattern': ''}
+ expected_all = self.GET_conditions_dict([expected_cond])
self.check_json_get('/conditions', expected_all)
- # test effect of invalid POST to existing Condition on /condition
+ # 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)
- assert isinstance(expected_single['condition'], dict)
- expected_single['condition']['_versioned']['title'][1] = 'bar'
- expected_single['condition']['is_active'] = True
+ self.check_post(post, '/condition?id=1')
+ expected_cond['_versioned']['title'][1] = 'bar'
+ expected_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()
- expected_single['condition'] = cond
+ # test deletion POST's effect, both to return id=1 into empty single, …
+ self.check_post({'delete': ''}, '/condition?id=1', redir='/conditions')
+ expected_cond = self.cond_as_dict()
+ assert isinstance(expected_single['_library'], dict)
+ expected_single['_library']['Condition'] = self.as_refs(
+ [expected_cond])
self.check_json_get('/condition?id=1', expected_single)
- # … full /conditions
+ # … and full /conditions into empty list
expected_all['conditions'] = []
+ expected_all['_library'] = {}
self.check_json_get('/conditions', expected_all)
- def test_do_GET_condition(self) -> None:
+ def test_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,
- 'condition': [1], 'disables': [1]}
- self.post_process(1, proc_1_post)
- proc_2_post = {'title': 'B', 'description': '', 'effort': 1.0,
- 'enables': [1], 'blocker': [1]}
- self.post_process(2, proc_2_post)
- cond = self.cond_as_dict(titles=['foo'], descriptions=['oof'])
- proc_1 = self.proc_as_dict(conditions=[cond], disables=[cond])
- proc_2 = self.proc_as_dict(2, 'B', blockers=[cond], enables=[cond])
- expected_single = {'is_new': False,
- 'enabled_processes': [proc_1],
- 'disabled_processes': [proc_2],
- 'enabling_processes': [proc_2],
- 'disabling_processes': [proc_1],
- 'condition': cond}
- self.check_json_get('/condition?id=1', expected_single)
+ # 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', redir='/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_expected = self.cond_as_dict(titles=['foo'], descriptions=['oof'])
+ assert isinstance(cond_expected['id'], int)
+ proc1 = self.proc_as_dict(conditions=[cond_expected['id']],
+ disables=[cond_expected['id']])
+ proc2 = self.proc_as_dict(2, 'B',
+ blockers=[cond_expected['id']],
+ enables=[cond_expected['id']])
+ display_expected = self.GET_condition_dict(cond_expected)
+ assert isinstance(display_expected['_library'], dict)
+ display_expected['enabled_processes'] = self.as_id_list([proc1])
+ display_expected['disabled_processes'] = self.as_id_list([proc2])
+ display_expected['enabling_processes'] = self.as_id_list([proc2])
+ display_expected['disabling_processes'] = self.as_id_list([proc1])
+ display_expected['_library']['Process'] = self.as_refs([proc1, proc2])
+ self.check_json_get('/condition?id=1', display_expected)
- def test_do_GET_conditions(self) -> None:
+ def test_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': ''}
- 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
- self.check_json_get('/conditions?sort_by=foo&pattern=bar&foo=x',
- expected_json)
+ expected = self.GET_conditions_dict([])
+ self.check_json_get('/conditions', expected)
+ # test ignorance of meaningless non-empty params (incl. unknown 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!
+ expected['sort_by'] = 'title' # for clarity (actually already set)
+ url = '/conditions?sort_by=foo&pattern=bar&foo=x'
+ self.check_json_get(url, expected)
# 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': cons, 'sort_by': 'title', 'pattern': ''}
- self.check_json_get('/conditions', expected_json)
+ post_cond1 = {'is_active': False, 'title': 'foo', 'description': 'oof'}
+ post_cond2 = {'is_active': False, 'title': 'bar', 'description': 'rab'}
+ post_cond3 = {'is_active': True, 'title': 'baz', 'description': 'zab'}
+ self.check_post(post_cond1, '/condition', redir='/condition?id=1')
+ self.check_post(post_cond2, '/condition', redir='/condition?id=2')
+ self.check_post(post_cond3, '/condition', redir='/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_json['conditions'] = [cond_1, cond_3, cond_2]
- expected_json['sort_by'] = '-title'
- self.check_json_get('/conditions?sort_by=-title', expected_json)
- expected_json['conditions'] = [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'] = [cond_3, cond_1, cond_2]
- expected_json['sort_by'] = '-is_active'
- self.check_json_get('/conditions?sort_by=-is_active', expected_json)
+ expected['sort_by'] = '-title'
+ assert isinstance(expected['conditions'], list)
+ expected['conditions'].reverse()
+ 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'].reverse()
+ self.check_json_get('/conditions?sort_by=-is_active', expected)
# test pattern matching on title
- expected_json = {'conditions': [cond_2, cond_3],
- 'sort_by': 'title', 'pattern': 'ba'}
- self.check_json_get('/conditions?pattern=ba', expected_json)
+ expected = self.GET_conditions_dict([cond2, cond3])
+ expected['pattern'] = 'ba'
+ self.check_json_get('/conditions?pattern=ba', expected)
# test pattern matching on description
- expected_json['conditions'] = [cond_1]
- expected_json['pattern'] = 'oo'
- self.check_json_get('/conditions?pattern=oo', expected_json)
+ assert isinstance(expected['_library'], dict)
+ expected['pattern'] = 'of'
+ expected['conditions'] = self.as_id_list([cond1])
+ expected['_library']['Condition'] = self.as_refs([cond1])
+ self.check_json_get('/conditions?pattern=of', expected)