"""Test Processes module."""
from unittest import TestCase
-from http.client import HTTPConnection
-from urllib.parse import urlencode
+from typing import Any
from tests.utils import TestCaseWithDB, TestCaseWithServer
-from plomtask.processes import Process
+from plomtask.processes import Process, ProcessStep
+from plomtask.conditions import Condition
+from plomtask.exceptions import NotFoundException, BadFormatException
class TestsSansDB(TestCase):
"""Module tests not requiring DB setup."""
- def test_Process_versioned_defaults(self):
+ 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)
+ def test_Process_legal_ID(self) -> None:
+ """Test Process cannot be instantiated with id_=0."""
+ with self.assertRaises(BadFormatException):
+ Process(0)
+
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_,
+ def setUp(self) -> None:
+ super().setUp()
+ self.proc1 = Process(None)
+ self.proc1.save_without_steps(self.db_conn)
+ self.proc2 = Process(None)
+ self.proc2.save_without_steps(self.db_conn)
+ self.proc3 = Process(None)
+ self.proc3.save_without_steps(self.db_conn)
+
+ def test_Process_ids(self) -> None:
+ """Test Process.save_without_steps() re Process.id_."""
+ self.assertEqual(self.proc1.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_,
+ self.assertEqual(self.proc2.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_,
+ proc5 = Process(5)
+ proc5.save_without_steps(self.db_conn)
+ self.assertEqual(proc5.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):
+
+ def test_Process_steps(self) -> None:
+ """Test addition, nesting, and non-recursion of ProcessSteps"""
+ assert self.proc2.id_ is not None
+ assert self.proc3.id_ is not None
+ self.proc1.add_step(self.db_conn, None, self.proc2.id_, None)
+ 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)
+ s_b = self.proc1.add_step(self.db_conn, None, self.proc3.id_, None)
+ 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)
+ s_c = self.proc2.add_step(self.db_conn, None, self.proc3.id_, None)
+ assert s_c.id_ is not None
+ 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)
+ self.proc1.add_step(self.db_conn, None, self.proc2.id_, s_b.id_)
+ p_1_dict[2]['steps'][4] = {
+ 'process': self.proc2, 'parent_id': s_b.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)
+ self.proc1.add_step(self.db_conn, None, self.proc3.id_, 999)
+ 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)
+ self.proc1.add_step(self.db_conn, None, self.proc3.id_, 3)
+ 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])
+
+ def test_Process_conditions(self) -> None:
+ """Test setting Process.conditions/fulfills/undoes."""
+ for target in ('conditions', 'fulfills', 'undoes'):
+ c1 = Condition(None, False)
+ c1.save(self.db_conn)
+ assert c1.id_ is not None
+ c2 = Condition(None, False)
+ c2.save(self.db_conn)
+ assert c2.id_ is not None
+ 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])
+
+ def test_Process_by_id(self) -> None:
"""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_,
+ 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.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):
+ def test_Process_all(self) -> None:
"""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_},
+ 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 self.proc2.id_ is not None
+ step = self.proc1.add_step(self.db_conn, None, self.proc2.id_, None)
+ assert step.id_ is not None
+ 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)
+
+ def test_Process_singularity(self) -> None:
+ """Test pointers made for single object keep pointing to it."""
+ assert self.proc2.id_ is not None
+ self.proc1.add_step(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)
+
+ def test_Process_versioned_attributes_singularity(self) -> None:
+ """Test behavior of VersionedAttributes on saving (with .title)."""
+ 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)
+
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)
- form_data = {'title': 'foo', 'description': 'foo', 'effort': 1.0}
- post_data_to_expect(form_data, '/process?id=FOO', 400)
+ 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, '/')
+ self.assertEqual(1, len(Process.all(self.db_conn)))
+ self.check_post(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.check_post(form_data, '/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.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]
+ 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, '/')
+
+ 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.check_get('/process', 200)
+ self.check_get('/process?id=', 200)
+ self.check_get('/process?id=0', 400)
+ self.check_get('/process?id=FOO', 400)
+ self.check_get('/processes', 200)