"""Test Conditions module."""
-from unittest import TestCase
-from tests.utils import TestCaseWithDB, TestCaseWithServer
+from tests.utils import TestCaseWithDB, TestCaseWithServer, TestCaseSansDB
from plomtask.conditions import Condition
from plomtask.processes import Process
from plomtask.todos import Todo
-from plomtask.exceptions import NotFoundException, HandledException
+from plomtask.exceptions import HandledException
-class TestsSansDB(TestCase):
+class TestsSansDB(TestCaseSansDB):
"""Tests requiring no DB setup."""
-
- def test_Condition_id_setting(self) -> None:
- """Test .id_ being set and its legal range being enforced."""
- with self.assertRaises(HandledException):
- Condition(0)
- condition = Condition(5)
- self.assertEqual(condition.id_, 5)
+ checked_class = Condition
+ do_id_test = True
+ versioned_defaults_to_test = {'title': 'UNNAMED', 'description': ''}
class TestsWithDB(TestCaseWithDB):
"""Tests requiring DB, but not server setup."""
-
- def check_storage(self, content: list[Condition]) -> None:
- """Test cache and DB equal content."""
- expected_cache = {}
- for item in content:
- expected_cache[item.id_] = item
- self.assertEqual(Condition.get_cache(), expected_cache)
- db_found: list[Condition] = []
- for item in content:
- assert isinstance(item.id_, int)
- for row in self.db_conn.row_where(Condition.table_name, 'id',
- item.id_):
- db_found += [Condition.from_table_row(self.db_conn, row)]
- self.assertEqual(sorted(content), sorted(db_found))
-
- def test_Condition_saving_and_caching(self) -> None:
- """Test .save/.save_core."""
- c = Condition(None, False)
- c.title.set('title1')
- c.title.set('title2')
- c.description.set('desc1')
- c.description.set('desc2')
- # check object init itself doesn't store anything yet
- self.check_storage([])
- # check saving stores in cache and DB
- c.save(self.db_conn)
- self.check_storage([c])
- # check attributes set properly (and not unset by saving)
- self.assertEqual(c.id_, 1)
- self.assertEqual(c.is_active, False)
- self.assertEqual(sorted(c.title.history.values()),
- ['title1', 'title2'])
- self.assertEqual(sorted(c.description.history.values()),
- ['desc1', 'desc2'])
+ 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"""
- c = Condition(1, True)
- c.title.set('title1')
- c.title.set('title2')
- c.description.set('desc1')
- c.description.set('desc2')
- c.save(self.db_conn)
- assert isinstance(c.id_, int)
- for row in self.db_conn.row_where(Condition.table_name, 'id', c.id_):
- retrieved = Condition.from_table_row(self.db_conn, row)
- assert isinstance(retrieved, Condition)
- self.assertEqual(c, retrieved)
- self.assertEqual({c.id_: c}, Condition.get_cache())
- # pylint: disable=no-member
- self.assertEqual(sorted(retrieved.title.history.values()),
- ['title1', 'title2'])
- # pylint: disable=no-member
- self.assertEqual(sorted(retrieved.description.history.values()),
- ['desc1', 'desc2'])
+ 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."""
- # check failure if not yet saved
- c = Condition(3, False)
- with self.assertRaises(NotFoundException):
- Condition.by_id(self.db_conn, 3)
- # check identity of saved and retrieved
- c.save(self.db_conn)
- self.assertEqual(c, Condition.by_id(self.db_conn, 3))
- # check create=True acts like normal instantiation (sans saving)
- by_id_created = Condition.by_id(self.db_conn, 4, create=True)
- self.assertEqual(Condition(4), by_id_created)
- self.check_storage([c])
+ self.check_by_id()
def test_Condition_all(self) -> None:
"""Test .all()."""
- c_1 = Condition(None, False)
- # check pre-save .all() returns empty list
- self.assertEqual(Condition.all(self.db_conn), [])
- # check .save() fills .all() result
- c_1.save(self.db_conn)
- self.assertEqual(Condition.all(self.db_conn), [c_1])
- c_2 = Condition(None, True)
- c_2.save(self.db_conn)
- self.assertEqual(sorted(Condition.all(self.db_conn)),
- sorted([c_1, c_2]))
+ self.check_all()
def test_Condition_singularity(self) -> None:
"""Test pointers made for single object keep pointing to it."""
- c = Condition(None, False)
- c.save(self.db_conn)
- c.is_active = True
- retrieved = Condition.by_id(self.db_conn, 1)
- self.assertEqual(True, retrieved.is_active)
+ 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."""
- # check only saved item can be removed
- c = Condition(None, False)
- with self.assertRaises(HandledException):
- c.remove(self.db_conn)
- c.save(self.db_conn)
- c.remove(self.db_conn)
- self.check_storage([])
- # check guard against deleting dependencies of other classes
+ self.check_remove()
proc = Process(None)
+ proc.save(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')