"""Test Conditions module."""
-from tests.utils import TestCaseWithDB, TestCaseWithServer
+from json import loads as json_loads
+from tests.utils import TestCaseWithDB, TestCaseWithServer, TestCaseSansDB
from plomtask.conditions import Condition
from plomtask.processes import Process
-from plomtask.exceptions import NotFoundException, HandledException
+from plomtask.todos import Todo
+from plomtask.exceptions import HandledException
+
+
+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 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)
+ """Test .by_id(), including creation."""
+ self.check_by_id()
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])
+ self.check_all()
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_Condition_removal(self) -> None:
- """Test removal of Condition."""
- cond = Condition(None, False)
- cond.save(self.db_conn)
- assert isinstance(cond.id_, int)
+ 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:
+ """Test .remove() effects on DB and cache."""
+ self.check_remove()
proc = Process(None)
proc.save(self.db_conn)
- proc.set_conditions(self.db_conn, [cond.id_], 'conditions')
- proc.save(self.db_conn)
- with self.assertRaises(HandledException):
- cond.remove(self.db_conn)
- proc.set_conditions(self.db_conn, [], 'conditions')
- proc.save(self.db_conn)
- cond.remove(self.db_conn)
- self.assertEqual(Condition.all(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):
def test_do_POST_condition(self) -> None:
"""Test POST /condition and its effect on the database."""
- form_data = {'title': 'foo', 'description': 'foo'}
+
+ 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)
+
+ # 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 = {'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)
+ # … full /conditions
+ expected_all = {'conditions': [cond], 'sort_by': 'title', 'pattern': ''}
+ check('/conditions', expected_all)
+ # test effect of invalid POST to existing Condition on /condition
+ self.check_post({}, '/condition?id=1', 400)
+ check('/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)
+ # … full /conditions
+ expected_all['conditions'] = []
+ check('/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')
- 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."""
- self.check_get('/condition', 200)
- self.check_get('/condition?id=', 200)
- self.check_get('/condition?id=0', 500)
- self.check_get('/condition?id=FOO', 400)
- self.check_get('/conditions', 200)
+ self.check_get_defaults('/condition')
+
+ 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)
+ # 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)
+ # 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)
+ # test pattern matching on title
+ expected_json = {'conditions': [cond_2, cond_3],
+ 'sort_by': 'title', 'pattern': 'ba'}
+ check('?pattern=ba', expected_json)
+ # test pattern matching on description
+ expected_json['conditions'] = [cond_1]
+ expected_json['pattern'] = 'oo'
+ check('?pattern=oo', expected_json)
projects / plomtask / blobdiff