X-Git-Url: https://plomlompom.com/repos/%7B%7Bdb.prefix%7D%7D/task?a=blobdiff_plain;f=tests%2Futils.py;h=55c948a409dbf1b2c43f775c0d39106ba3ed510d;hb=25b71c6f0b10db05907128daf50c6e543e514c35;hp=a826c16a5adb1d24222ef1f4b42f5cefc711baf8;hpb=f8148a40996d64878431ac59d47650741e1d79c5;p=plomtask diff --git a/tests/utils.py b/tests/utils.py index a826c16..55c948a 100644 --- a/tests/utils.py +++ b/tests/utils.py @@ -1,11 +1,13 @@ """Shared test utilities.""" +from __future__ import annotations from unittest import TestCase +from typing import Mapping, Any, Callable from threading import Thread from http.client import HTTPConnection +from json import loads as json_loads from urllib.parse import urlencode -from datetime import datetime +from uuid import uuid4 from os import remove as remove_file -from typing import Mapping, Any from plomtask.db import DatabaseFile, DatabaseConnection from plomtask.http import TaskHandler, TaskServer from plomtask.processes import Process, ProcessStep @@ -15,10 +17,37 @@ from plomtask.todos import Todo from plomtask.exceptions import NotFoundException, HandledException +class TestCaseSansDB(TestCase): + """Tests requiring no DB setup.""" + checked_class: Any + do_id_test: bool = False + default_init_args: list[Any] = [] + versioned_defaults_to_test: dict[str, str | float] = {} + + def test_id_setting(self) -> None: + """Test .id_ being set and its legal range being enforced.""" + if not self.do_id_test: + return + with self.assertRaises(HandledException): + self.checked_class(0, *self.default_init_args) + obj = self.checked_class(5, *self.default_init_args) + self.assertEqual(obj.id_, 5) + + def test_versioned_defaults(self) -> None: + """Test defaults of VersionedAttributes.""" + if len(self.versioned_defaults_to_test) == 0: + return + obj = self.checked_class(1, *self.default_init_args) + for k, v in self.versioned_defaults_to_test.items(): + self.assertEqual(getattr(obj, k).newest, v) + + class TestCaseWithDB(TestCase): """Module tests not requiring DB setup.""" checked_class: Any - default_ids: tuple[int | str, int | str, int | str] + default_ids: tuple[int | str, int | str, int | str] = (1, 2, 3) + default_init_kwargs: dict[str, Any] = {} + test_versioneds: dict[str, type] = {} def setUp(self) -> None: Condition.empty_cache() @@ -26,108 +55,199 @@ class TestCaseWithDB(TestCase): Process.empty_cache() ProcessStep.empty_cache() Todo.empty_cache() - timestamp = datetime.now().timestamp() - self.db_file = DatabaseFile(f'test_db:{timestamp}') - self.db_file.remake() + self.db_file = DatabaseFile.create_at(f'test_db:{uuid4()}') self.db_conn = DatabaseConnection(self.db_file) def tearDown(self) -> None: self.db_conn.close() remove_file(self.db_file.path) - def check_storage(self, content: list[Any]) -> None: - """Test cache and DB equal content.""" + @staticmethod + def _within_checked_class(f: Callable[..., None]) -> Callable[..., None]: + def wrapper(self: TestCaseWithDB) -> None: + if hasattr(self, 'checked_class'): + f(self) + return wrapper + + @_within_checked_class + def test_saving_and_caching(self) -> None: + """Test storage and initialization of instances and attributes.""" + self.check_saving_and_caching(id_=1, **self.default_init_kwargs) + obj = self.checked_class(None, **self.default_init_kwargs) + obj.save(self.db_conn) + self.assertEqual(obj.id_, 2) + for attr_name, type_ in self.test_versioneds.items(): + owner = self.checked_class(None) + vals: list[Any] = ['t1', 't2'] if type_ == str else [0.9, 1.1] + attr = getattr(owner, attr_name) + attr.set(vals[0]) + attr.set(vals[1]) + owner.save(self.db_conn) + retrieved = owner.__class__.by_id(self.db_conn, owner.id_) + attr = getattr(retrieved, attr_name) + self.assertEqual(sorted(attr.history.values()), vals) + + def check_identity_with_cache_and_db(self, content: list[Any]) -> None: + """Test both cache and DB equal content.""" expected_cache = {} for item in content: expected_cache[item.id_] = item self.assertEqual(self.checked_class.get_cache(), expected_cache) + hashes_content = [hash(x) for x in content] db_found: list[Any] = [] for item in content: - assert isinstance(item.id_, (str, int)) + assert isinstance(item.id_, type(self.default_ids[0])) for row in self.db_conn.row_where(self.checked_class.table_name, 'id', item.id_): db_found += [self.checked_class.from_table_row(self.db_conn, row)] - self.assertEqual(sorted(content), sorted(db_found)) + hashes_db_found = [hash(x) for x in db_found] + self.assertEqual(sorted(hashes_content), sorted(hashes_db_found)) - def check_saving_and_caching(self, **kwargs: Any) -> Any: + def check_saving_and_caching(self, **kwargs: Any) -> None: """Test instance.save in its core without relations.""" obj = self.checked_class(**kwargs) # pylint: disable=not-callable # check object init itself doesn't store anything yet - self.check_storage([]) - # check saving stores in cache and DB + self.check_identity_with_cache_and_db([]) + # check saving sets core attributes properly obj.save(self.db_conn) - self.check_storage([obj]) - # check core attributes set properly (and not unset by saving) for key, value in kwargs.items(): self.assertEqual(getattr(obj, key), value) + # check saving stored properly in cache and DB + self.check_identity_with_cache_and_db([obj]) - def check_by_id(self) -> None: - """Test .by_id(), including creation.""" + @_within_checked_class + def test_by_id(self) -> None: + """Test .by_id().""" + id1, id2, _ = self.default_ids # check failure if not yet saved - id1, id2 = self.default_ids[0], self.default_ids[1] - obj = self.checked_class(id1) # pylint: disable=not-callable + obj1 = self.checked_class(id1, **self.default_init_kwargs) with self.assertRaises(NotFoundException): self.checked_class.by_id(self.db_conn, id1) + # check identity of cached and retrieved + obj1.cache() + self.assertEqual(obj1, self.checked_class.by_id(self.db_conn, id1)) # check identity of saved and retrieved + obj2 = self.checked_class(id2, **self.default_init_kwargs) + obj2.save(self.db_conn) + self.assertEqual(obj2, self.checked_class.by_id(self.db_conn, id2)) + # obj1.save(self.db_conn) + # self.check_identity_with_cache_and_db([obj1, obj2]) + + @_within_checked_class + def test_by_id_or_create(self) -> None: + """Test .by_id_or_create.""" + # check .by_id_or_create acts like normal instantiation (sans saving) + id_ = self.default_ids[0] + if not self.checked_class.can_create_by_id: + with self.assertRaises(HandledException): + self.checked_class.by_id_or_create(self.db_conn, id_) + # check .by_id_or_create fails if wrong class + else: + by_id_created = self.checked_class.by_id_or_create(self.db_conn, + id_) + with self.assertRaises(NotFoundException): + self.checked_class.by_id(self.db_conn, id_) + self.assertEqual(self.checked_class(id_), by_id_created) + + @_within_checked_class + def test_from_table_row(self) -> None: + """Test .from_table_row() properly reads in class directly from DB.""" + id_ = self.default_ids[0] + obj = self.checked_class(id_, **self.default_init_kwargs) obj.save(self.db_conn) - self.assertEqual(obj, self.checked_class.by_id(self.db_conn, id1)) - # check create=True acts like normal instantiation (sans saving) - by_id_created = self.checked_class.by_id(self.db_conn, id2, - create=True) - # pylint: disable=not-callable - self.assertEqual(self.checked_class(id2), by_id_created) - self.check_storage([obj]) - - def check_from_table_row(self, id_: int | str) -> None: - """Test .from_table_row() properly reads in class from DB""" - obj = self.checked_class(id_) # pylint: disable=not-callable - obj.save(self.db_conn) - assert isinstance(obj.id_, (str, int)) + assert isinstance(obj.id_, type(self.default_ids[0])) for row in self.db_conn.row_where(self.checked_class.table_name, 'id', obj.id_): + # check .from_table_row reproduces state saved, no matter if obj + # later changed (with caching even) + hash_original = hash(obj) + attr_name = self.checked_class.to_save[-1] + attr = getattr(obj, attr_name) + if isinstance(attr, (int, float)): + setattr(obj, attr_name, attr + 1) + elif isinstance(attr, str): + setattr(obj, attr_name, attr + "_") + elif isinstance(attr, bool): + setattr(obj, attr_name, not attr) + obj.cache() + to_cmp = getattr(obj, attr_name) retrieved = self.checked_class.from_table_row(self.db_conn, row) - self.assertEqual(obj, retrieved) - self.assertEqual({obj.id_: obj}, self.checked_class.get_cache()) - - def check_all(self) -> tuple[Any, Any, Any]: - """Test .all().""" - # pylint: disable=not-callable - item1 = self.checked_class(self.default_ids[0]) - item2 = self.checked_class(self.default_ids[1]) - item3 = self.checked_class(self.default_ids[2]) - # check pre-save .all() returns empty list + self.assertNotEqual(to_cmp, getattr(retrieved, attr_name)) + self.assertEqual(hash_original, hash(retrieved)) + # check cache contains what .from_table_row just produced + self.assertEqual({retrieved.id_: retrieved}, + self.checked_class.get_cache()) + + def check_versioned_from_table_row(self, attr_name: str, + type_: type) -> None: + """Test .from_table_row() reads versioned attributes from DB.""" + owner = self.checked_class(None) + vals: list[Any] = ['t1', 't2'] if type_ == str else [0.9, 1.1] + attr = getattr(owner, attr_name) + attr.set(vals[0]) + attr.set(vals[1]) + owner.save(self.db_conn) + for row in self.db_conn.row_where(owner.table_name, 'id', owner.id_): + retrieved = owner.__class__.from_table_row(self.db_conn, row) + attr = getattr(retrieved, attr_name) + self.assertEqual(sorted(attr.history.values()), vals) + + @_within_checked_class + def test_all(self) -> None: + """Test .all() and its relation to cache and savings.""" + id_1, id_2, id_3 = self.default_ids + item1 = self.checked_class(id_1, **self.default_init_kwargs) + item2 = self.checked_class(id_2, **self.default_init_kwargs) + item3 = self.checked_class(id_3, **self.default_init_kwargs) + # check .all() returns empty list on un-cached items self.assertEqual(self.checked_class.all(self.db_conn), []) - # check that all() shows all saved, but no unsaved items - item1.save(self.db_conn) + # check that all() shows only cached/saved items + item1.cache() item3.save(self.db_conn) self.assertEqual(sorted(self.checked_class.all(self.db_conn)), sorted([item1, item3])) item2.save(self.db_conn) self.assertEqual(sorted(self.checked_class.all(self.db_conn)), sorted([item1, item2, item3])) - return item1, item2, item3 - def check_singularity(self, defaulting_field: str, - non_default_value: Any) -> None: + @_within_checked_class + def test_singularity(self) -> None: """Test pointers made for single object keep pointing to it.""" id1 = self.default_ids[0] - obj = self.checked_class(id1) # pylint: disable=not-callable + obj = self.checked_class(id1, **self.default_init_kwargs) obj.save(self.db_conn) - setattr(obj, defaulting_field, non_default_value) + attr_name = self.checked_class.to_save[-1] + attr = getattr(obj, attr_name) + new_attr: str | int | float | bool + if isinstance(attr, (int, float)): + new_attr = attr + 1 + elif isinstance(attr, str): + new_attr = attr + '_' + elif isinstance(attr, bool): + new_attr = not attr + setattr(obj, attr_name, new_attr) retrieved = self.checked_class.by_id(self.db_conn, id1) - self.assertEqual(non_default_value, - getattr(retrieved, defaulting_field)) + self.assertEqual(new_attr, getattr(retrieved, attr_name)) - def check_remove(self) -> None: + def check_versioned_singularity(self) -> None: + """Test singularity of VersionedAttributes on saving (with .title).""" + obj = self.checked_class(None) # pylint: disable=not-callable + obj.save(self.db_conn) + assert isinstance(obj.id_, int) + obj.title.set('named') + retrieved = self.checked_class.by_id(self.db_conn, obj.id_) + self.assertEqual(obj.title.history, retrieved.title.history) + + def check_remove(self, *args: Any) -> None: """Test .remove() effects on DB and cache.""" id_ = self.default_ids[0] - obj = self.checked_class(id_) # pylint: disable=not-callable + obj = self.checked_class(id_, *args) # pylint: disable=not-callable with self.assertRaises(HandledException): obj.remove(self.db_conn) obj.save(self.db_conn) obj.remove(self.db_conn) - self.check_storage([]) + self.check_identity_with_cache_and_db([]) class TestCaseWithServer(TestCaseWithDB): @@ -141,6 +261,7 @@ class TestCaseWithServer(TestCaseWithDB): self.server_thread.start() self.conn = HTTPConnection(str(self.httpd.server_address[0]), self.httpd.server_address[1]) + self.httpd.set_json_mode() def tearDown(self) -> None: self.httpd.shutdown() @@ -188,5 +309,34 @@ class TestCaseWithServer(TestCaseWithDB): """POST basic Process.""" if not form_data: form_data = {'title': 'foo', 'description': 'foo', 'effort': 1.1} - self.check_post(form_data, '/process?id=', 302, f'/process?id={id_}') + self.check_post(form_data, f'/process?id={id_}', 302, + f'/process?id={id_}') return form_data + + def check_json_get(self, path: str, expected: dict[str, object]) -> None: + """Compare JSON on GET path with expected. + + To simplify comparison of VersionedAttribute histories, transforms + timestamp keys of VersionedAttribute history keys into integers + counting chronologically forward from 0. + """ + def rewrite_history_keys_in(item: Any) -> Any: + if isinstance(item, dict): + if '_versioned' in item.keys(): + for k in item['_versioned']: + vals = item['_versioned'][k].values() + history = {} + for i, val in enumerate(vals): + history[i] = val + item['_versioned'][k] = history + for k in list(item.keys()): + rewrite_history_keys_in(item[k]) + elif isinstance(item, list): + item[:] = [rewrite_history_keys_in(i) for i in item] + return item + self.conn.request('GET', path) + response = self.conn.getresponse() + self.assertEqual(response.status, 200) + retrieved = json_loads(response.read().decode()) + rewrite_history_keys_in(retrieved) + self.assertEqual(expected, retrieved)