"""Test Conditions module."""
-from json import loads as json_loads
from tests.utils import TestCaseWithDB, TestCaseWithServer, TestCaseSansDB
from plomtask.conditions import Condition
from plomtask.processes import Process
class TestsSansDB(TestCaseSansDB):
"""Tests requiring no DB setup."""
checked_class = Condition
- do_id_test = True
versioned_defaults_to_test = {'title': 'UNNAMED', 'description': ''}
default_init_kwargs = {'is_active': False}
test_versioneds = {'title': str, 'description': str}
- def test_Condition_from_table_row(self) -> None:
- """Test .from_table_row() properly reads in class from DB"""
- self.check_from_table_row()
- self.check_versioned_from_table_row('title', str)
- self.check_versioned_from_table_row('description', str)
-
- def test_Condition_by_id(self) -> None:
- """Test .by_id(), including creation."""
- self.check_by_id()
-
- def test_Condition_all(self) -> None:
- """Test .all()."""
- self.check_all()
-
- def test_Condition_singularity(self) -> None:
- """Test pointers made for single object keep pointing to it."""
- self.check_singularity('is_active', True)
-
- def test_Condition_versioned_attributes_singularity(self) -> None:
- """Test behavior of VersionedAttributes on saving (with .title)."""
- self.check_versioned_singularity()
-
- def test_Condition_remove(self) -> None:
+ def test_remove(self) -> None:
"""Test .remove() effects on DB and cache."""
- self.check_remove()
+ super().test_remove()
proc = Process(None)
proc.save(self.db_conn)
todo = Todo(None, proc, False, '2024-01-01')
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."""
-
- def check(path: str, expected: dict[str, object]) -> None:
- self.conn.request('GET', path)
- response = self.conn.getresponse()
- self.assertEqual(response.status, 200)
- retrieved = json_loads(response.read().decode())
- self.blank_history_keys_in(retrieved)
- self.assertEqual(expected, retrieved)
+ @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)
- # check empty POST fails
- self.check_post({}, '/condition', 400)
+ def test_do_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 = {'id': 1, 'is_active': False,
- 'title': {'parent_id': 1, 'history': {'[0]': 'foo'}},
- 'description': {'parent_id': 1, 'history': {'[0]': 'oof'}}}
- expected_single = {'is_new': False,
- 'enabled_processes': [],
- 'disabled_processes': [],
- 'enabling_processes': [],
- 'disabling_processes': [],
- 'condition': cond}
- check('/condition?id=1', expected_single)
+ 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 = {'conditions': [cond], 'sort_by': 'title', 'pattern': ''}
- check('/conditions', expected_all)
- # test effect of invalid POST to existing Condition on /condition
+ 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)
- check('/condition?id=1', expected_single)
+ 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['title']['history'] = {}
- cond['description']['history'] = {}
- check('/condition?id=1', expected_single)
+ 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'] = []
- check('/conditions', expected_all)
+ expected_all['_library'] = {}
+ self.check_json_get('/conditions', expected_all)
def test_do_GET_condition(self) -> None:
- """Test GET /condition."""
- form_data = {'title': 'foo', 'description': 'foo', 'is_active': False}
- self.check_post(form_data, '/condition', 302, '/condition?id=1')
+ """More GET /condition testing, especially for Process relations."""
+ # check expected default status codes
self.check_get_defaults('/condition')
+ # 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_do_GET_conditions(self) -> None:
"""Test GET /conditions."""
-
- def check(params: str, expected_json: dict[str, object]) -> None:
- self.conn.request('GET', f'/conditions{params}')
- response = self.conn.getresponse()
- self.assertEqual(response.status, 200)
- retrieved_json = json_loads(response.read().decode())
- self.blank_history_keys_in(retrieved_json)
- self.assertEqual(expected_json, retrieved_json)
-
# test empty result on empty DB, default-settings on empty params
- expected_json: dict[str, object] = {'conditions': [],
- 'sort_by': 'title',
- 'pattern': ''}
- check('', 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
- check('?sort_by=foo&pattern=bar&foo=x', expected_json)
+ 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
- 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 = {'id': 1, 'is_active': False,
- 'title': {'history': {'[0]': 'foo'},
- 'parent_id': 1},
- 'description': {'history': {'[0]': 'oof'},
- 'parent_id': 1}}
- cond_2 = {'id': 2, 'is_active': False,
- 'title': {'history': {'[0]': 'bar'},
- 'parent_id': 2},
- 'description': {'history': {'[0]': 'rab'},
- 'parent_id': 2}}
- cond_3 = {'id': 3, 'is_active': True,
- 'title': {'history': {'[0]': 'baz'},
- 'parent_id': 3},
- 'description': {'history': {'[0]': 'zab'},
- 'parent_id': 3}}
- cons = [cond_2, cond_3, cond_1]
- expected_json = {'conditions': cons, 'sort_by': 'title', 'pattern': ''}
- check('', expected_json)
+ 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_json['conditions'] = [cond_1, cond_3, cond_2]
- expected_json['sort_by'] = '-title'
- check('?sort_by=-title', expected_json)
- expected_json['conditions'] = [cond_1, cond_2, cond_3]
- expected_json['sort_by'] = 'is_active'
- check('?sort_by=is_active', expected_json)
- expected_json['conditions'] = [cond_3, cond_1, cond_2]
- expected_json['sort_by'] = '-is_active'
- check('?sort_by=-is_active', expected_json)
+ expected['conditions'] = self.as_id_list([cond1, cond3, cond2])
+ expected['sort_by'] = '-title'
+ self.check_json_get('/conditions?sort_by=-title', expected)
+ expected['conditions'] = self.as_id_list([cond1, cond2, cond3])
+ expected['sort_by'] = 'is_active'
+ self.check_json_get('/conditions?sort_by=is_active', expected)
+ expected['conditions'] = self.as_id_list([cond3, cond1, cond2])
+ expected['sort_by'] = '-is_active'
+ 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'}
- check('?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'
- check('?pattern=oo', expected_json)
+ assert isinstance(expected['_library'], dict)
+ expected['conditions'] = self.as_id_list([cond1])
+ expected['_library']['Condition'] = self.as_refs([cond1])
+ expected['pattern'] = 'oo'
+ self.check_json_get('/conditions?pattern=oo', expected)