"""Test Processes module."""
-from unittest import TestCase
-from typing import Any
-from tests.utils import TestCaseWithDB, TestCaseWithServer
-from plomtask.processes import Process, ProcessStep
+from tests.utils import TestCaseWithDB, TestCaseWithServer, TestCaseSansDB
+from plomtask.processes import Process, ProcessStep, ProcessStepsNode
from plomtask.conditions import Condition
-from plomtask.exceptions import NotFoundException, HandledException
+from plomtask.exceptions import HandledException, NotFoundException
+from plomtask.todos import Todo
-class TestsSansDB(TestCase):
+class TestsSansDB(TestCaseSansDB):
"""Module tests not requiring DB setup."""
+ checked_class = Process
+
+ def test_Process_id_setting(self) -> None:
+ """Test .id_ being set and its legal range being enforced."""
+ self.check_id_setting()
def test_Process_versioned_defaults(self) -> None:
- """Test defaults of Process' VersionedAttributes."""
- self.assertEqual(Process(None).title.newest, 'UNNAMED')
- self.assertEqual(Process(None).description.newest, '')
- self.assertEqual(Process(None).effort.newest, 1.0)
+ """Test defaults of VersionedAttributes."""
+ self.check_versioned_defaults({
+ 'title': 'UNNAMED',
+ 'description': '',
+ 'effort': 1.0})
- def test_Process_legal_ID(self) -> None:
- """Test Process cannot be instantiated with id_=0."""
- with self.assertRaises(HandledException):
- Process(0)
+
+class TestsSansDBProcessStep(TestCaseSansDB):
+ """Module tests not requiring DB setup."""
+ checked_class = ProcessStep
+
+ def test_ProcessStep_id_setting(self) -> None:
+ """Test .id_ being set and its legal range being enforced."""
+ self.check_id_setting(2, 3, 4)
class TestsWithDB(TestCaseWithDB):
- """Mdule tests not requiring DB setup."""
-
- def setUp(self) -> None:
- super().setUp()
- self.proc1 = Process(None)
- self.proc1.save(self.db_conn)
- self.proc2 = Process(None)
- self.proc2.save(self.db_conn)
- self.proc3 = Process(None)
- self.proc3.save(self.db_conn)
-
- def test_Process_ids(self) -> None:
- """Test Process.save() re Process.id_."""
- self.assertEqual(self.proc1.id_,
- Process.by_id(self.db_conn, 1, create=False).id_)
- self.assertEqual(self.proc2.id_,
- Process.by_id(self.db_conn, 2, create=False).id_)
- proc5 = Process(5)
- proc5.save(self.db_conn)
- self.assertEqual(proc5.id_,
- Process.by_id(self.db_conn, 5, create=False).id_)
+ """Module tests requiring DB setup."""
+ checked_class = Process
+
+ def three_processes(self) -> tuple[Process, Process, Process]:
+ """Return three saved processes."""
+ p1, p2, p3 = Process(None), Process(None), Process(None)
+ for p in [p1, p2, p3]:
+ p.save(self.db_conn)
+ return p1, p2, p3
+
+ def test_Process_saving_and_caching(self) -> None:
+ """Test .save/.save_core."""
+ kwargs = {'id_': 1}
+ self.check_saving_and_caching(**kwargs)
+ p = Process(None)
+ p.title.set('t1')
+ p.title.set('t2')
+ p.description.set('d1')
+ p.description.set('d2')
+ p.effort.set(0.5)
+ p.effort.set(1.5)
+ c1, c2, c3 = Condition(None), Condition(None), Condition(None)
+ for c in [c1, c2, c3]:
+ c.save(self.db_conn)
+ assert isinstance(c1.id_, int)
+ assert isinstance(c2.id_, int)
+ assert isinstance(c3.id_, int)
+ p.set_conditions(self.db_conn, [c1.id_, c2.id_])
+ p.set_enables(self.db_conn, [c2.id_, c3.id_])
+ p.set_disables(self.db_conn, [c1.id_, c3.id_])
+ p.save(self.db_conn)
+ r = Process.by_id(self.db_conn, p.id_)
+ self.assertEqual(sorted(r.title.history.values()), ['t1', 't2'])
+ self.assertEqual(sorted(r.description.history.values()), ['d1', 'd2'])
+ self.assertEqual(sorted(r.effort.history.values()), [0.5, 1.5])
+ self.assertEqual(sorted(r.conditions), sorted([c1, c2]))
+ self.assertEqual(sorted(r.enables), sorted([c2, c3]))
+ self.assertEqual(sorted(r.disables), sorted([c1, c3]))
def test_Process_steps(self) -> None:
"""Test addition, nesting, and non-recursion of ProcessSteps"""
steps_proc += [step_tuple]
proc.set_steps(self.db_conn, steps_proc)
steps_proc[-1] = (expected_id, step_tuple[1], step_tuple[2])
- assert isinstance(self.proc2.id_, int)
- assert isinstance(self.proc3.id_, int)
- steps_proc1: list[tuple[int | None, int, int | None]] = []
- add_step(self.proc1, steps_proc1, (None, self.proc2.id_, None), 1)
- p_1_dict: dict[int, dict[str, Any]] = {1: {
- 'process': self.proc2, 'parent_id': None,
- 'is_explicit': True, 'steps': {}, 'seen': False
- }}
- self.assertEqual(self.proc1.get_steps(self.db_conn, None), p_1_dict)
- add_step(self.proc1, steps_proc1, (None, self.proc3.id_, None), 2)
- step_2 = self.proc1.explicit_steps[-1]
- assert isinstance(step_2.id_, int)
- p_1_dict[2] = {
- 'process': self.proc3, 'parent_id': None,
- 'is_explicit': True, 'steps': {}, 'seen': False
- }
- self.assertEqual(self.proc1.get_steps(self.db_conn, None), p_1_dict)
- steps_proc2: list[tuple[int | None, int, int | None]] = []
- add_step(self.proc2, steps_proc2, (None, self.proc3.id_, None), 3)
- p_1_dict[1]['steps'] = {3: {
- 'process': self.proc3, 'parent_id': None,
- 'is_explicit': False, 'steps': {}, 'seen': False
- }}
- self.assertEqual(self.proc1.get_steps(self.db_conn, None), p_1_dict)
- add_step(self.proc1, steps_proc1, (None, self.proc2.id_, step_2.id_),
- 4)
- p_1_dict[2]['steps'][4] = {
- 'process': self.proc2, 'parent_id': step_2.id_, 'seen': False,
- 'is_explicit': True, 'steps': {3: {
- 'process': self.proc3, 'parent_id': None,
- 'is_explicit': False, 'steps': {}, 'seen': True
- }}}
- self.assertEqual(self.proc1.get_steps(self.db_conn, None), p_1_dict)
- add_step(self.proc1, steps_proc1, (None, self.proc3.id_, 999), 5)
- p_1_dict[5] = {
- 'process': self.proc3, 'parent_id': None,
- 'is_explicit': True, 'steps': {}, 'seen': False
- }
- self.assertEqual(self.proc1.get_steps(self.db_conn, None), p_1_dict)
- add_step(self.proc1, steps_proc1, (None, self.proc3.id_, 3), 6)
- p_1_dict[6] = {
- 'process': self.proc3, 'parent_id': None,
- 'is_explicit': True, 'steps': {}, 'seen': False
- }
- self.assertEqual(self.proc1.get_steps(self.db_conn, None),
- p_1_dict)
- self.assertEqual(self.proc1.used_as_step_by(self.db_conn),
- [])
- self.assertEqual(self.proc2.used_as_step_by(self.db_conn),
- [self.proc1])
- self.assertEqual(self.proc3.used_as_step_by(self.db_conn),
- [self.proc1, self.proc2])
+ p1, p2, p3 = self.three_processes()
+ assert isinstance(p1.id_, int)
+ assert isinstance(p2.id_, int)
+ assert isinstance(p3.id_, int)
+ steps_p1: list[tuple[int | None, int, int | None]] = []
+ add_step(p1, steps_p1, (None, p2.id_, None), 1)
+ p1_dict: dict[int, ProcessStepsNode] = {}
+ p1_dict[1] = ProcessStepsNode(p2, None, True, {}, False)
+ self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict)
+ add_step(p1, steps_p1, (None, p3.id_, None), 2)
+ step_2 = p1.explicit_steps[-1]
+ p1_dict[2] = ProcessStepsNode(p3, None, True, {}, False)
+ self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict)
+ steps_p2: list[tuple[int | None, int, int | None]] = []
+ add_step(p2, steps_p2, (None, p3.id_, None), 3)
+ p1_dict[1].steps[3] = ProcessStepsNode(p3, None, False, {}, False)
+ self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict)
+ add_step(p1, steps_p1, (None, p2.id_, step_2.id_), 4)
+ step_3 = ProcessStepsNode(p3, None, False, {}, True)
+ p1_dict[2].steps[4] = ProcessStepsNode(p2, step_2.id_, True,
+ {3: step_3}, False)
+ self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict)
+ add_step(p1, steps_p1, (None, p3.id_, 999), 5)
+ p1_dict[5] = ProcessStepsNode(p3, None, True, {}, False)
+ self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict)
+ add_step(p1, steps_p1, (None, p3.id_, 3), 6)
+ p1_dict[6] = ProcessStepsNode(p3, None, True, {}, False)
+ self.assertEqual(p1.get_steps(self.db_conn, None), p1_dict)
+ self.assertEqual(p1.used_as_step_by(self.db_conn), [])
+ self.assertEqual(p2.used_as_step_by(self.db_conn), [p1])
+ self.assertEqual(p3.used_as_step_by(self.db_conn), [p1, p2])
def test_Process_conditions(self) -> None:
- """Test setting Process.conditions/fulfills/undoes."""
- for target in ('conditions', 'fulfills', 'undoes'):
- c1 = Condition(None, False)
+ """Test setting Process.conditions/enables/disables."""
+ p = Process(None)
+ p.save(self.db_conn)
+ for target in ('conditions', 'enables', 'disables'):
+ method = getattr(p, f'set_{target}')
+ c1, c2 = Condition(None), Condition(None)
c1.save(self.db_conn)
- assert isinstance(c1.id_, int)
- c2 = Condition(None, False)
c2.save(self.db_conn)
+ assert isinstance(c1.id_, int)
assert isinstance(c2.id_, int)
- self.proc1.set_conditions(self.db_conn, [], target)
- self.assertEqual(getattr(self.proc1, target), [])
- self.proc1.set_conditions(self.db_conn, [c1.id_], target)
- self.assertEqual(getattr(self.proc1, target), [c1])
- self.proc1.set_conditions(self.db_conn, [c2.id_], target)
- self.assertEqual(getattr(self.proc1, target), [c2])
- self.proc1.set_conditions(self.db_conn, [c1.id_, c2.id_], target)
- self.assertEqual(getattr(self.proc1, target), [c1, c2])
+ method(self.db_conn, [])
+ self.assertEqual(getattr(p, target), [])
+ method(self.db_conn, [c1.id_])
+ self.assertEqual(getattr(p, target), [c1])
+ method(self.db_conn, [c2.id_])
+ self.assertEqual(getattr(p, target), [c2])
+ method(self.db_conn, [c1.id_, c2.id_])
+ self.assertEqual(getattr(p, target), [c1, c2])
def test_Process_by_id(self) -> None:
- """Test Process.by_id()."""
- with self.assertRaises(NotFoundException):
- Process.by_id(self.db_conn, None, create=False)
- with self.assertRaises(NotFoundException):
- Process.by_id(self.db_conn, 0, create=False)
- self.assertNotEqual(self.proc1.id_,
- Process.by_id(self.db_conn, None, create=True).id_)
- self.assertEqual(Process(2).id_,
- Process.by_id(self.db_conn, 2, create=True).id_)
+ """Test .by_id(), including creation"""
+ self.check_by_id()
def test_Process_all(self) -> None:
- """Test Process.all()."""
- self.assertEqual({self.proc1.id_, self.proc2.id_, self.proc3.id_},
- set(p.id_ for p in Process.all(self.db_conn)))
-
- def test_ProcessStep_singularity(self) -> None:
- """Test pointers made for single object keep pointing to it."""
- assert isinstance(self.proc2.id_, int)
- self.proc1.set_steps(self.db_conn, [(None, self.proc2.id_, None)])
- step = self.proc1.explicit_steps[-1]
- assert isinstance(step.id_, int)
- step_retrieved = ProcessStep.by_id(self.db_conn, step.id_)
- step.parent_step_id = 99
- self.assertEqual(step.parent_step_id, step_retrieved.parent_step_id)
+ """Test .all()."""
+ self.check_all()
def test_Process_singularity(self) -> None:
"""Test pointers made for single object keep pointing to it."""
- assert isinstance(self.proc1.id_, int)
- assert isinstance(self.proc2.id_, int)
- self.proc1.set_steps(self.db_conn, [(None, self.proc2.id_, None)])
- p_retrieved = Process.by_id(self.db_conn, self.proc1.id_)
- self.assertEqual(self.proc1.explicit_steps, p_retrieved.explicit_steps)
+ self.check_singularity('conditions', [Condition(None)])
def test_Process_versioned_attributes_singularity(self) -> None:
"""Test behavior of VersionedAttributes on saving (with .title)."""
- assert isinstance(self.proc1.id_, int)
- self.proc1.title.set('named')
- p_loaded = Process.by_id(self.db_conn, self.proc1.id_)
- self.assertEqual(self.proc1.title.history, p_loaded.title.history)
+ self.check_versioned_singularity()
+
+ def test_Process_removal(self) -> None:
+ """Test removal of Processes and ProcessSteps."""
+ self.check_remove()
+ p1, p2, p3 = self.three_processes()
+ assert isinstance(p1.id_, int)
+ assert isinstance(p2.id_, int)
+ assert isinstance(p3.id_, int)
+ p2.set_steps(self.db_conn, [(None, p1.id_, None)])
+ with self.assertRaises(HandledException):
+ p1.remove(self.db_conn)
+ step = p2.explicit_steps[0]
+ p2.set_steps(self.db_conn, [])
+ with self.assertRaises(NotFoundException):
+ ProcessStep.by_id(self.db_conn, step.id_)
+ p1.remove(self.db_conn)
+ p2.set_steps(self.db_conn, [(None, p3.id_, None)])
+ step = p2.explicit_steps[0]
+ p2.remove(self.db_conn)
+ with self.assertRaises(NotFoundException):
+ ProcessStep.by_id(self.db_conn, step.id_)
+ todo = Todo(None, p3, False, '2024-01-01')
+ todo.save(self.db_conn)
+ with self.assertRaises(HandledException):
+ p3.remove(self.db_conn)
+ todo.remove(self.db_conn)
+ p3.remove(self.db_conn)
+
+
+class TestsWithDBForProcessStep(TestCaseWithDB):
+ """Module tests requiring DB setup."""
+ checked_class = ProcessStep
+
+ def test_ProcessStep_saving_and_caching(self) -> None:
+ """Test .save/.save_core."""
+ kwargs = {'id_': 1,
+ 'owner_id': 2,
+ 'step_process_id': 3,
+ 'parent_step_id': 4}
+ self.check_saving_and_caching(**kwargs)
+
+ def test_ProcessStep_from_table_row(self) -> None:
+ """Test .from_table_row() properly reads in class from DB"""
+ self.check_from_table_row(2, 3, None)
+
+ def test_ProcessStep_singularity(self) -> None:
+ """Test pointers made for single object keep pointing to it."""
+ self.check_singularity('parent_step_id', 1, 2, 3, None)
+
+ def test_ProcessStep_remove(self) -> None:
+ """Test .remove and unsetting of owner's .explicit_steps entry."""
+ p1 = Process(None)
+ p2 = Process(None)
+ p1.save(self.db_conn)
+ p2.save(self.db_conn)
+ assert isinstance(p2.id_, int)
+ p1.set_steps(self.db_conn, [(None, p2.id_, None)])
+ step = p1.explicit_steps[0]
+ step.remove(self.db_conn)
+ self.assertEqual(p1.explicit_steps, [])
+ self.check_storage([])
class TestsWithServer(TestCaseWithServer):
def test_do_POST_process(self) -> None:
"""Test POST /process and its effect on the database."""
self.assertEqual(0, len(Process.all(self.db_conn)))
- form_data = {'title': 'foo', 'description': 'foo', 'effort': 1.1}
- self.check_post(form_data, '/process?id=', 302, '/')
+ form_data = self.post_process()
self.assertEqual(1, len(Process.all(self.db_conn)))
self.check_post(form_data, '/process?id=FOO', 400)
- form_data['effort'] = 'foo'
- self.check_post(form_data, '/process?id=', 400)
+ self.check_post(form_data | {'effort': 'foo'}, '/process?id=', 400)
self.check_post({}, '/process?id=', 400)
- form_data = {'title': '', 'description': ''}
- self.check_post(form_data, '/process?id=', 400)
- form_data = {'title': '', 'effort': 1.1}
- self.check_post(form_data, '/process?id=', 400)
- form_data = {'description': '', 'effort': 1.0}
- self.check_post(form_data, '/process?id=', 400)
+ self.check_post({'title': '', 'description': ''}, '/process?id=', 400)
+ self.check_post({'title': '', 'effort': 1.1}, '/process?id=', 400)
+ self.check_post({'description': '', 'effort': 1.0},
+ '/process?id=', 400)
self.assertEqual(1, len(Process.all(self.db_conn)))
- form_data = {'title': 'foo', 'description': 'foo', 'effort': 1.0,
- 'condition': []}
- self.check_post(form_data, '/process?id=', 302, '/')
- form_data['condition'] = [1]
+ form_data = {'title': 'foo', 'description': 'foo', 'effort': 1.0}
+ self.post_process(2, form_data | {'condition': []})
+ self.check_post(form_data | {'condition': [1]}, '/process?id=', 404)
+ self.check_post({'title': 'foo', 'description': 'foo'},
+ '/condition', 302, '/condition?id=1')
+ self.post_process(3, form_data | {'condition': [1]})
+ self.post_process(4, form_data | {'disables': [1]})
+ self.post_process(5, form_data | {'enables': [1]})
+ form_data['delete'] = ''
self.check_post(form_data, '/process?id=', 404)
- form_data_cond = {'title': 'foo', 'description': 'foo'}
- self.check_post(form_data_cond, '/condition', 302, '/')
- self.check_post(form_data, '/process?id=', 302, '/')
- form_data['undoes'] = [1]
- self.check_post(form_data, '/process?id=', 302, '/')
- form_data['fulfills'] = [1]
- self.check_post(form_data, '/process?id=', 302, '/')
+ self.check_post(form_data, '/process?id=6', 404)
+ self.check_post(form_data, '/process?id=5', 302, '/processes')
def test_do_GET(self) -> None:
"""Test /process and /processes response codes."""
- self.check_get('/process', 200)
- self.check_get('/process?id=', 200)
- self.check_get('/process?id=0', 500)
- self.check_get('/process?id=FOO', 400)
+ self.post_process()
+ self.check_get_defaults('/process')
self.check_get('/processes', 200)
projects / plomtask / blobdiff