"""Test Conditions module."""
-from tests.utils import TestCaseWithDB, TestCaseWithServer, TestCaseSansDB
+from typing import Any
+from tests.utils import (TestCaseSansDB, TestCaseWithDB, TestCaseWithServer,
+ Expected)
from plomtask.conditions import Condition
from plomtask.processes import Process
from plomtask.todos import Todo
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_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')
+ 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')
+ assert isinstance(c.id_, int)
+ depender.set_condition_relations(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_condition_relations(self.db_conn, [], [], [], [])
depender.save(self.db_conn)
c.remove(self.db_conn)
+class ExpectedGetConditions(Expected):
+ """Builder of expectations for GET /conditions."""
+ _default_dict = {'sort_by': 'title', 'pattern': ''}
+
+ def recalc(self) -> None:
+ """Update internal dictionary by subclass-specific rules."""
+ super().recalc()
+ self._fields['conditions'] = self.as_ids(self.lib_all('Condition'))
+
+
+class ExpectedGetCondition(Expected):
+ """Builder of expectations for GET /condition."""
+ _on_empty_make_temp = ('Condition', 'cond_as_dict')
+
+ def __init__(self, id_: int, *args: Any, **kwargs: Any) -> None:
+ self._fields = {'condition': id_}
+ super().__init__(*args, **kwargs)
+
+ def recalc(self) -> None:
+ """Update internal dictionary by subclass-specific rules."""
+ super().recalc()
+ for p_field, c_field in [('conditions', 'enabled_processes'),
+ ('disables', 'disabling_processes'),
+ ('blockers', 'disabled_processes'),
+ ('enables', 'enabling_processes')]:
+ self._fields[c_field] = self.as_ids([
+ p for p in self.lib_all('Process')
+ if self._fields['condition'] in p[p_field]])
+ self._fields['is_new'] = False
+
+
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,
- 'title': {'history': {}, 'parent_id': id_},
- 'description': {'history': {}, 'parent_id': id_}}
- titles = titles if titles else []
- descriptions = descriptions if descriptions else []
- for i, title in enumerate(titles):
- assert isinstance(d['title'], dict)
- d['title']['history'][f'[{i}]'] = title
- for i, description in enumerate(descriptions):
- assert isinstance(d['description'], dict)
- d['description']['history'][f'[{i}]'] = description
- return d
-
- @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': [],
- 'title': {'history': {'[0]': title}, 'parent_id': id_},
- 'effort': {'history': {'[0]': 1.0}, 'parent_id': id_},
- 'description': {'history': {'[0]': ''}, 'parent_id': id_},
- 'conditions': conditions if conditions else [],
- 'disables': disables if disables else [],
- 'enables': enables if enables else [],
- 'blockers': blockers if blockers else []}
- 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)
- # test valid POST's effect on …
+ 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]."""
+ exp_single = ExpectedGetCondition(1)
+ exp_all = ExpectedGetConditions()
+ all_exps = [exp_single, exp_all]
+ # test valid POST's effect on single /condition and full /conditions
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'])
- expected_single: dict[str, object]
- expected_single = {'is_new': False,
- 'enabled_processes': [],
- 'disabled_processes': [],
- 'enabling_processes': [],
- 'disabling_processes': [],
- 'condition': 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': ''}
- self.check_json_get('/conditions', expected_all)
- # test effect of invalid POST to existing Condition on /condition
+ self.post_exp_cond(all_exps, 1, post, '', '?id=1')
+ self.check_json_get('/condition?id=1', exp_single)
+ self.check_json_get('/conditions', exp_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)
+ self.check_json_get('/condition?id=1', exp_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)
- expected_single['condition']['title']['history']['[1]'] = 'bar'
- expected_single['condition']['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
- self.check_json_get('/condition?id=1', expected_single)
- # … full /conditions
- expected_all['conditions'] = []
- self.check_json_get('/conditions', expected_all)
-
- def test_do_GET_condition(self) -> None:
+ self.post_exp_cond(all_exps, 1, post, '?id=1', '?id=1')
+ self.check_json_get('/condition?id=1', exp_single)
+ self.check_json_get('/conditions', exp_all)
+ # test deletion POST's effect, both to return id=1 into empty single,
+ # full /conditions into empty list
+ self.post_exp_cond(all_exps, 1, {'delete': ''}, '?id=1', 's')
+ self.check_json_get('/condition?id=1', exp_single)
+ self.check_json_get('/conditions', exp_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')
- # 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)
-
- def test_do_GET_conditions(self) -> None:
+ # make Condition and two Processes that among them establish all
+ # possible ConditionsRelations to it, check /condition displays all
+ exp = ExpectedGetCondition(1)
+ cond_post = {'title': 'foo', 'description': 'oof', 'is_active': False}
+ self.post_exp_cond([exp], 1, cond_post, '', '?id=1')
+ proc1_post = {'title': 'A', 'description': '', 'effort': 1.1,
+ 'conditions': [1], 'disables': [1]}
+ proc2_post = {'title': 'B', 'description': '', 'effort': 0.9,
+ 'enables': [1], 'blockers': [1]}
+ self.post_exp_process([exp], proc1_post, 1)
+ self.post_exp_process([exp], proc2_post, 2)
+ self.check_json_get('/condition?id=1', exp)
+
+ 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)
+ exp = ExpectedGetConditions()
+ self.check_json_get('/conditions', exp)
+ # 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
+ exp.set('pattern', 'bar') # preserved despite zero effect!
+ exp.set('sort_by', 'title') # for clarity (already default)
+ self.check_json_get('/conditions?sort_by=foo&pattern=bar&foo=x', exp)
# 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'}
+ for i, post in enumerate([post_cond1, post_cond2, post_cond3]):
+ self.post_exp_cond([exp], i+1, post, '', f'?id={i+1}')
+ exp.set('pattern', '')
+ exp.force('conditions', [2, 3, 1])
+ self.check_json_get('/conditions', exp)
# 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)
+ exp.set('sort_by', '-title')
+ exp.force('conditions', [1, 3, 2])
+ self.check_json_get('/conditions?sort_by=-title', exp)
+ exp.set('sort_by', 'is_active')
+ exp.force('conditions', [1, 2, 3])
+ self.check_json_get('/conditions?sort_by=is_active', exp)
+ exp.set('sort_by', '-is_active')
+ exp.force('conditions', [3, 2, 1])
+ self.check_json_get('/conditions?sort_by=-is_active', exp)
# 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)
+ exp.set('sort_by', 'title')
+ exp.set('pattern', 'ba')
+ exp.force('conditions', [2, 3])
+ exp.lib_del('Condition', 1)
+ self.check_json_get('/conditions?pattern=ba', exp)
# test pattern matching on description
- expected_json['conditions'] = [cond_1]
- expected_json['pattern'] = 'oo'
- self.check_json_get('/conditions?pattern=oo', expected_json)
+ exp.set('pattern', 'of')
+ exp.lib_wipe('Condition')
+ exp.set_cond_from_post(1, post_cond1)
+ exp.force('conditions', [1])
+ self.check_json_get('/conditions?pattern=of', exp)
projects / plomtask / blobdiff
![[plomtask]](/repos/%7B%7Bdb.prefix%7D%7D/static/git-favicon.png?p=plomtask;a=tree;hb=HEAD){kind=link}
