"""Test Processes module."""
-from unittest import TestCase
-from http.client import HTTPConnection
-from urllib.parse import urlencode
-from tests.utils import TestCaseWithDB, TestCaseWithServer
-from plomtask.processes import Process
+from tests.utils import TestCaseWithDB, TestCaseWithServer, TestCaseSansDB
+from plomtask.processes import Process, ProcessStep, ProcessStepsNode
+from plomtask.conditions import Condition
+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_versioned_defaults(self):
- """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)
+ 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 VersionedAttributes."""
+ self.check_versioned_defaults({
+ 'title': 'UNNAMED',
+ 'description': '',
+ 'effort': 1.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 test_Process_save(self):
- """Test Process.save()."""
- p_saved = Process(None)
- p_saved.save(self.db_conn)
- self.assertEqual(p_saved.id_,
- Process.by_id(self.db_conn, 1, create=False).id_)
- p_saved = Process(0)
- p_saved.save(self.db_conn)
- self.assertEqual(p_saved.id_,
- Process.by_id(self.db_conn, 2, create=False).id_)
- p_saved = Process(5)
- p_saved.save(self.db_conn)
- self.assertEqual(p_saved.id_,
- Process.by_id(self.db_conn, 5, create=False).id_)
- p_saved.title.set('named')
- p_loaded = Process.by_id(self.db_conn, p_saved.id_)
- self.assertNotEqual(p_saved.title.history, p_loaded.title.history)
- p_saved.save(self.db_conn)
- p_loaded = Process.by_id(self.db_conn, p_saved.id_)
- self.assertEqual(p_saved.title.history, p_loaded.title.history)
-
- def test_Process_by_id(self):
- """Test Process.by_id()."""
- self.assertEqual(None, Process.by_id(self.db_conn, None, create=False))
- self.assertEqual(None, Process.by_id(self.db_conn, 0, create=False))
- self.assertEqual(None, Process.by_id(self.db_conn, 1, create=False))
- self.assertNotEqual(Process(1).id_,
- Process.by_id(self.db_conn, None, create=True).id_)
- self.assertNotEqual(Process(1).id_,
- Process.by_id(self.db_conn, 0, create=True).id_)
- self.assertEqual(Process(1).id_,
- Process.by_id(self.db_conn, 1, create=True).id_)
- self.assertEqual(Process(2).id_,
- Process.by_id(self.db_conn, 2, create=True).id_)
-
- def test_Process_all(self):
- """Test Process.all()."""
- p_1 = Process(None)
- p_1.save(self.db_conn)
- p_2 = Process(None)
- p_2.save(self.db_conn)
- self.assertEqual({p_1.id_, p_2.id_},
- set(p.id_ for p in Process.all(self.db_conn)))
+ """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"""
+ def add_step(proc: Process,
+ steps_proc: list[tuple[int | None, int, int | None]],
+ step_tuple: tuple[int | None, int, int | None],
+ expected_id: int) -> None:
+ steps_proc += [step_tuple]
+ proc.set_steps(self.db_conn, steps_proc)
+ steps_proc[-1] = (expected_id, step_tuple[1], step_tuple[2])
+ 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/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)
+ c2.save(self.db_conn)
+ assert isinstance(c1.id_, int)
+ assert isinstance(c2.id_, int)
+ 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 .by_id(), including creation"""
+ self.check_by_id()
+
+ def test_Process_all(self) -> None:
+ """Test .all()."""
+ self.check_all()
+
+ def test_Process_singularity(self) -> None:
+ """Test pointers made for single object keep pointing to it."""
+ self.check_singularity('conditions', [Condition(None)])
+
+ def test_Process_versioned_attributes_singularity(self) -> None:
+ """Test behavior of VersionedAttributes on saving (with .title)."""
+ 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):
"""Module tests against our HTTP server/handler (and database)."""
- def test_do_POST_process(self):
+ def test_do_POST_process(self) -> None:
"""Test POST /process and its effect on the database."""
- def post_data_to_expect(form_data: dict, to_: str, expect: int):
- encoded_form_data = urlencode(form_data).encode('utf-8')
- headers = {'Content-Type': 'application/x-www-form-urlencoded',
- 'Content-Length': str(len(encoded_form_data))}
- http_conn.request('POST', to_,
- body=encoded_form_data, headers=headers)
- self.assertEqual(http_conn.getresponse().status, expect)
- http_conn = HTTPConnection(*self.httpd.server_address)
+ self.assertEqual(0, len(Process.all(self.db_conn)))
+ form_data = self.post_process()
+ self.assertEqual(1, len(Process.all(self.db_conn)))
+ self.check_post(form_data, '/process?id=FOO', 400)
+ self.check_post(form_data | {'effort': 'foo'}, '/process?id=', 400)
+ self.check_post({}, '/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}
- post_data_to_expect(form_data, '/process?id=FOO', 400)
- form_data['effort'] = 'foo'
- post_data_to_expect(form_data, '/process?id=', 400)
- form_data['effort'] = None
- post_data_to_expect(form_data, '/process?id=', 400)
- form_data = {'title': None, 'description': 1, 'effort': 1.0}
- post_data_to_expect(form_data, '/process?id=', 302)
- retrieved = Process.by_id(self.db_conn, 1)
- self.assertEqual(retrieved.title.newest, 'None')
- self.assertEqual([p.id_ for p in Process.all(self.db_conn)],
- [retrieved.id_])
-
- def test_do_GET(self):
+ 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)
+ 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."""
- http_conn = HTTPConnection(*self.httpd.server_address)
- http_conn.request('GET', '/process')
- self.assertEqual(http_conn.getresponse().status, 200)
- http_conn.request('GET', '/process?id=')
- self.assertEqual(http_conn.getresponse().status, 200)
- http_conn.request('GET', '/process?id=0')
- self.assertEqual(http_conn.getresponse().status, 200)
- http_conn.request('GET', '/process?id=FOO')
- self.assertEqual(http_conn.getresponse().status, 400)
- http_conn.request('GET', '/processes')
- self.assertEqual(http_conn.getresponse().status, 200)
+ self.post_process()
+ self.check_get_defaults('/process')
+ self.check_get('/processes', 200)
projects / plomtask / blobdiff