plomlompom.com Git - plomtask/blob - tests/utils.py

   1 """Shared test utilities."""
   2 from __future__ import annotations
   3 from unittest import TestCase
   4 from typing import Mapping, Any, Callable
   5 from threading import Thread
   6 from http.client import HTTPConnection
   7 from datetime import datetime, timedelta
   8 from time import sleep
   9 from json import loads as json_loads
  10 from urllib.parse import urlencode
  11 from uuid import uuid4
  12 from os import remove as remove_file
  13 from plomtask.db import DatabaseFile, DatabaseConnection
  14 from plomtask.http import TaskHandler, TaskServer
  15 from plomtask.processes import Process, ProcessStep
  16 from plomtask.conditions import Condition
  17 from plomtask.days import Day
  18 from plomtask.dating import DATE_FORMAT
  19 from plomtask.todos import Todo
  20 from plomtask.versioned_attributes import VersionedAttribute, TIMESTAMP_FMT
  21 from plomtask.exceptions import NotFoundException, HandledException
  22
  23
  24 VERSIONED_VALS: dict[str,
  25                      list[str] | list[float]] = {'str': ['A', 'B'],
  26                                                  'float': [0.3, 1.1]}
  27
  28
  29 class TestCaseAugmented(TestCase):
  30     """Tester core providing helpful basic internal decorators and methods."""
  31     checked_class: Any
  32     default_init_kwargs: dict[str, Any] = {}
  33
  34     @staticmethod
  35     def _run_if_checked_class(f: Callable[..., None]) -> Callable[..., None]:
  36         def wrapper(self: TestCase) -> None:
  37             if hasattr(self, 'checked_class'):
  38                 f(self)
  39         return wrapper
  40
  41     @classmethod
  42     def _run_on_versioned_attributes(cls,
  43                                      f: Callable[..., None]
  44                                      ) -> Callable[..., None]:
  45         @cls._run_if_checked_class
  46         def wrapper(self: TestCase) -> None:
  47             assert isinstance(self, TestCaseAugmented)
  48             for attr_name in self.checked_class.to_save_versioned():
  49                 default = self.checked_class.versioned_defaults[attr_name]
  50                 owner = self.checked_class(None, **self.default_init_kwargs)
  51                 attr = getattr(owner, attr_name)
  52                 to_set = VERSIONED_VALS[attr.value_type_name]
  53                 f(self, owner, attr_name, attr, default, to_set)
  54         return wrapper
  55
  56     @classmethod
  57     def _make_from_defaults(cls, id_: float | str | None) -> Any:
  58         return cls.checked_class(id_, **cls.default_init_kwargs)
  59
  60
  61 class TestCaseSansDB(TestCaseAugmented):
  62     """Tests requiring no DB setup."""
  63     legal_ids: list[str] | list[int] = [1, 5]
  64     illegal_ids: list[str] | list[int] = [0]
  65
  66     @TestCaseAugmented._run_if_checked_class
  67     def test_id_validation(self) -> None:
  68         """Test .id_ validation/setting."""
  69         for id_ in self.illegal_ids:
  70             with self.assertRaises(HandledException):
  71                 self._make_from_defaults(id_)
  72         for id_ in self.legal_ids:
  73             obj = self._make_from_defaults(id_)
  74             self.assertEqual(obj.id_, id_)
  75
  76     @TestCaseAugmented._run_on_versioned_attributes
  77     def test_versioned_set(self,
  78                            _: Any,
  79                            __: str,
  80                            attr: VersionedAttribute,
  81                            default: str | float,
  82                            to_set: list[str] | list[float]
  83                            ) -> None:
  84         """Test VersionedAttribute.set() behaves as expected."""
  85         attr.set(default)
  86         self.assertEqual(list(attr.history.values()), [default])
  87         # check same value does not get set twice in a row,
  88         # and that not even its timestamp get updated
  89         timestamp = list(attr.history.keys())[0]
  90         attr.set(default)
  91         self.assertEqual(list(attr.history.values()), [default])
  92         self.assertEqual(list(attr.history.keys())[0], timestamp)
  93         # check that different value _will_ be set/added
  94         attr.set(to_set[0])
  95         timesorted_vals = [attr.history[t] for
  96                            t in sorted(attr.history.keys())]
  97         expected = [default, to_set[0]]
  98         self.assertEqual(timesorted_vals, expected)
  99         # check that a previously used value can be set if not most recent
 100         attr.set(default)
 101         timesorted_vals = [attr.history[t] for
 102                            t in sorted(attr.history.keys())]
 103         expected = [default, to_set[0], default]
 104         self.assertEqual(timesorted_vals, expected)
 105         # again check for same value not being set twice in a row, even for
 106         # later items
 107         attr.set(to_set[1])
 108         timesorted_vals = [attr.history[t] for
 109                            t in sorted(attr.history.keys())]
 110         expected = [default, to_set[0], default, to_set[1]]
 111         self.assertEqual(timesorted_vals, expected)
 112         attr.set(to_set[1])
 113         self.assertEqual(timesorted_vals, expected)
 114
 115     @TestCaseAugmented._run_on_versioned_attributes
 116     def test_versioned_newest(self,
 117                               _: Any,
 118                               __: str,
 119                               attr: VersionedAttribute,
 120                               default: str | float,
 121                               to_set: list[str] | list[float]
 122                               ) -> None:
 123         """Test VersionedAttribute.newest."""
 124         # check .newest on empty history returns .default
 125         self.assertEqual(attr.newest, default)
 126         # check newest element always returned
 127         for v in [to_set[0], to_set[1]]:
 128             attr.set(v)
 129             self.assertEqual(attr.newest, v)
 130         # check newest element returned even if also early value
 131         attr.set(default)
 132         self.assertEqual(attr.newest, default)
 133
 134     @TestCaseAugmented._run_on_versioned_attributes
 135     def test_versioned_at(self,
 136                           _: Any,
 137                           __: str,
 138                           attr: VersionedAttribute,
 139                           default: str | float,
 140                           to_set: list[str] | list[float]
 141                           ) -> None:
 142         """Test .at() returns values nearest to queried time, or default."""
 143         # check .at() return default on empty history
 144         timestamp_a = datetime.now().strftime(TIMESTAMP_FMT)
 145         self.assertEqual(attr.at(timestamp_a), default)
 146         # check value exactly at timestamp returned
 147         attr.set(to_set[0])
 148         timestamp_b = list(attr.history.keys())[0]
 149         self.assertEqual(attr.at(timestamp_b), to_set[0])
 150         # check earliest value returned if exists, rather than default
 151         self.assertEqual(attr.at(timestamp_a), to_set[0])
 152         # check reverts to previous value for timestamps not indexed
 153         sleep(0.00001)
 154         timestamp_between = datetime.now().strftime(TIMESTAMP_FMT)
 155         sleep(0.00001)
 156         attr.set(to_set[1])
 157         timestamp_c = sorted(attr.history.keys())[-1]
 158         self.assertEqual(attr.at(timestamp_c), to_set[1])
 159         self.assertEqual(attr.at(timestamp_between), to_set[0])
 160         sleep(0.00001)
 161         timestamp_after_c = datetime.now().strftime(TIMESTAMP_FMT)
 162         self.assertEqual(attr.at(timestamp_after_c), to_set[1])
 163
 164
 165 class TestCaseWithDB(TestCaseAugmented):
 166     """Module tests not requiring DB setup."""
 167     default_ids: tuple[int, int, int] | tuple[str, str, str] = (1, 2, 3)
 168
 169     def setUp(self) -> None:
 170         Condition.empty_cache()
 171         Day.empty_cache()
 172         Process.empty_cache()
 173         ProcessStep.empty_cache()
 174         Todo.empty_cache()
 175         self.db_file = DatabaseFile.create_at(f'test_db:{uuid4()}')
 176         self.db_conn = DatabaseConnection(self.db_file)
 177
 178     def tearDown(self) -> None:
 179         self.db_conn.close()
 180         remove_file(self.db_file.path)
 181
 182     def _load_from_db(self, id_: int | str) -> list[object]:
 183         db_found: list[object] = []
 184         for row in self.db_conn.row_where(self.checked_class.table_name,
 185                                           'id', id_):
 186             db_found += [self.checked_class.from_table_row(self.db_conn,
 187                                                            row)]
 188         return db_found
 189
 190     def _change_obj(self, obj: object) -> str:
 191         attr_name: str = self.checked_class.to_save_simples[-1]
 192         attr = getattr(obj, attr_name)
 193         new_attr: str | int | float | bool
 194         if isinstance(attr, (int, float)):
 195             new_attr = attr + 1
 196         elif isinstance(attr, str):
 197             new_attr = attr + '_'
 198         elif isinstance(attr, bool):
 199             new_attr = not attr
 200         setattr(obj, attr_name, new_attr)
 201         return attr_name
 202
 203     def check_identity_with_cache_and_db(self, content: list[Any]) -> None:
 204         """Test both cache and DB equal content."""
 205         expected_cache = {}
 206         for item in content:
 207             expected_cache[item.id_] = item
 208         self.assertEqual(self.checked_class.get_cache(), expected_cache)
 209         hashes_content = [hash(x) for x in content]
 210         db_found: list[Any] = []
 211         for item in content:
 212             assert isinstance(item.id_, type(self.default_ids[0]))
 213             db_found += self._load_from_db(item.id_)
 214         hashes_db_found = [hash(x) for x in db_found]
 215         self.assertEqual(sorted(hashes_content), sorted(hashes_db_found))
 216
 217     def check_by_date_range_with_limits(self,
 218                                         date_col: str,
 219                                         set_id_field: bool = True
 220                                         ) -> None:
 221         """Test .by_date_range_with_limits."""
 222         # pylint: disable=too-many-locals
 223         f = self.checked_class.by_date_range_with_limits
 224         # check illegal ranges
 225         legal_range = ('yesterday', 'tomorrow')
 226         for i in [0, 1]:
 227             for bad_date in ['foo', '2024-02-30', '2024-01-01 12:00:00']:
 228                 date_range = list(legal_range[:])
 229                 date_range[i] = bad_date
 230                 with self.assertRaises(HandledException):
 231                     f(self.db_conn, date_range, date_col)
 232         # check empty, translation of 'yesterday' and 'tomorrow'
 233         items, start, end = f(self.db_conn, legal_range, date_col)
 234         self.assertEqual(items, [])
 235         yesterday = datetime.now() + timedelta(days=-1)
 236         tomorrow = datetime.now() + timedelta(days=+1)
 237         self.assertEqual(start, yesterday.strftime(DATE_FORMAT))
 238         self.assertEqual(end, tomorrow.strftime(DATE_FORMAT))
 239         # prepare dated items for non-empty results
 240         kwargs_with_date = self.default_init_kwargs.copy()
 241         if set_id_field:
 242             kwargs_with_date['id_'] = None
 243         objs = []
 244         dates = ['2024-01-01', '2024-01-02', '2024-01-04']
 245         for date in ['2024-01-01', '2024-01-02', '2024-01-04']:
 246             kwargs_with_date['date'] = date
 247             obj = self.checked_class(**kwargs_with_date)
 248             objs += [obj]
 249         # check ranges still empty before saving
 250         date_range = [dates[0], dates[-1]]
 251         self.assertEqual(f(self.db_conn, date_range, date_col)[0], [])
 252         # check all objs displayed within closed interval
 253         for obj in objs:
 254             obj.save(self.db_conn)
 255         self.assertEqual(f(self.db_conn, date_range, date_col)[0], objs)
 256         # check that only displayed what exists within interval
 257         date_range = ['2023-12-20', '2024-01-03']
 258         expected = [objs[0], objs[1]]
 259         self.assertEqual(f(self.db_conn, date_range, date_col)[0], expected)
 260         date_range = ['2024-01-03', '2024-01-30']
 261         expected = [objs[2]]
 262         self.assertEqual(f(self.db_conn, date_range, date_col)[0], expected)
 263         # check that inverted interval displays nothing
 264         date_range = [dates[-1], dates[0]]
 265         self.assertEqual(f(self.db_conn, date_range, date_col)[0], [])
 266         # check that "today" is interpreted, and single-element interval
 267         today_date = datetime.now().strftime(DATE_FORMAT)
 268         kwargs_with_date['date'] = today_date
 269         obj_today = self.checked_class(**kwargs_with_date)
 270         obj_today.save(self.db_conn)
 271         date_range = ['today', 'today']
 272         items, start, end = f(self.db_conn, date_range, date_col)
 273         self.assertEqual(start, today_date)
 274         self.assertEqual(start, end)
 275         self.assertEqual(items, [obj_today])
 276
 277     @TestCaseAugmented._run_on_versioned_attributes
 278     def test_saving_versioned_attributes(self,
 279                                          owner: Any,
 280                                          attr_name: str,
 281                                          attr: VersionedAttribute,
 282                                          _: str | float,
 283                                          to_set: list[str] | list[float]
 284                                          ) -> None:
 285         """Test storage and initialization of versioned attributes."""
 286
 287         def retrieve_attr_vals(attr: VersionedAttribute) -> list[object]:
 288             attr_vals_saved: list[object] = []
 289             for row in self.db_conn.row_where(attr.table_name, 'parent',
 290                                               owner.id_):
 291                 attr_vals_saved += [row[2]]
 292             return attr_vals_saved
 293
 294         attr.set(to_set[0])
 295         # check that without attr.save() no rows in DB
 296         rows = self.db_conn.row_where(attr.table_name, 'parent', owner.id_)
 297         self.assertEqual([], rows)
 298         # fail saving attributes on non-saved owner
 299         with self.assertRaises(NotFoundException):
 300             attr.save(self.db_conn)
 301         # check owner.save() created entries as expected in attr table
 302         owner.save(self.db_conn)
 303         attr_vals_saved = retrieve_attr_vals(attr)
 304         self.assertEqual([to_set[0]], attr_vals_saved)
 305         # check changing attr val without save affects owner in memory …
 306         attr.set(to_set[1])
 307         cmp_attr = getattr(owner, attr_name)
 308         self.assertEqual(to_set, list(cmp_attr.history.values()))
 309         self.assertEqual(cmp_attr.history, attr.history)
 310         # … but does not yet affect DB
 311         attr_vals_saved = retrieve_attr_vals(attr)
 312         self.assertEqual([to_set[0]], attr_vals_saved)
 313         # check individual attr.save also stores new val to DB
 314         attr.save(self.db_conn)
 315         attr_vals_saved = retrieve_attr_vals(attr)
 316         self.assertEqual(to_set, attr_vals_saved)
 317
 318     @TestCaseAugmented._run_if_checked_class
 319     def test_saving_and_caching(self) -> None:
 320         """Test effects of .cache() and .save()."""
 321         id1 = self.default_ids[0]
 322         # check failure to cache without ID (if None-ID input possible)
 323         if isinstance(id1, int):
 324             obj0 = self._make_from_defaults(None)
 325             with self.assertRaises(HandledException):
 326                 obj0.cache()
 327         # check mere object init itself doesn't even store in cache
 328         obj1 = self._make_from_defaults(id1)
 329         self.assertEqual(self.checked_class.get_cache(), {})
 330         # check .cache() fills cache, but not DB
 331         obj1.cache()
 332         self.assertEqual(self.checked_class.get_cache(), {id1: obj1})
 333         found_in_db = self._load_from_db(id1)
 334         self.assertEqual(found_in_db, [])
 335         # check .save() sets ID (for int IDs), updates cache, and fills DB
 336         # (expect ID to be set to id1, despite obj1 already having that as ID:
 337         # it's generated by cursor.lastrowid on the DB table, and with obj1
 338         # not written there, obj2 should get it first!)
 339         id_input = None if isinstance(id1, int) else id1
 340         obj2 = self._make_from_defaults(id_input)
 341         obj2.save(self.db_conn)
 342         self.assertEqual(self.checked_class.get_cache(), {id1: obj2})
 343         # NB: we'll only compare hashes because obj2 itself disappears on
 344         # .from_table_row-trioggered database reload
 345         obj2_hash = hash(obj2)
 346         found_in_db += self._load_from_db(id1)
 347         self.assertEqual([hash(o) for o in found_in_db], [obj2_hash])
 348         # check we cannot overwrite obj2 with obj1 despite its same ID,
 349         # since it has disappeared now
 350         with self.assertRaises(HandledException):
 351             obj1.save(self.db_conn)
 352
 353     @TestCaseAugmented._run_if_checked_class
 354     def test_by_id(self) -> None:
 355         """Test .by_id()."""
 356         id1, id2, _ = self.default_ids
 357         # check failure if not yet saved
 358         obj1 = self._make_from_defaults(id1)
 359         with self.assertRaises(NotFoundException):
 360             self.checked_class.by_id(self.db_conn, id1)
 361         # check identity of cached and retrieved
 362         obj1.cache()
 363         self.assertEqual(obj1, self.checked_class.by_id(self.db_conn, id1))
 364         # check identity of saved and retrieved
 365         obj2 = self._make_from_defaults(id2)
 366         obj2.save(self.db_conn)
 367         self.assertEqual(obj2, self.checked_class.by_id(self.db_conn, id2))
 368
 369     @TestCaseAugmented._run_if_checked_class
 370     def test_by_id_or_create(self) -> None:
 371         """Test .by_id_or_create."""
 372         # check .by_id_or_create fails if wrong class
 373         if not self.checked_class.can_create_by_id:
 374             with self.assertRaises(HandledException):
 375                 self.checked_class.by_id_or_create(self.db_conn, None)
 376             return
 377         # check ID input of None creates, on saving, ID=1,2,… for int IDs
 378         if isinstance(self.default_ids[0], int):
 379             for n in range(2):
 380                 item = self.checked_class.by_id_or_create(self.db_conn, None)
 381                 self.assertEqual(item.id_, None)
 382                 item.save(self.db_conn)
 383                 self.assertEqual(item.id_, n+1)
 384         # check .by_id_or_create acts like normal instantiation (sans saving)
 385         id_ = self.default_ids[2]
 386         item = self.checked_class.by_id_or_create(self.db_conn, id_)
 387         self.assertEqual(item.id_, id_)
 388         with self.assertRaises(NotFoundException):
 389             self.checked_class.by_id(self.db_conn, item.id_)
 390         self.assertEqual(self.checked_class(item.id_), item)
 391
 392     @TestCaseAugmented._run_if_checked_class
 393     def test_from_table_row(self) -> None:
 394         """Test .from_table_row() properly reads in class directly from DB."""
 395         id_ = self.default_ids[0]
 396         obj = self._make_from_defaults(id_)
 397         obj.save(self.db_conn)
 398         assert isinstance(obj.id_, type(id_))
 399         for row in self.db_conn.row_where(self.checked_class.table_name,
 400                                           'id', obj.id_):
 401             # check .from_table_row reproduces state saved, no matter if obj
 402             # later changed (with caching even)
 403             # NB: we'll only compare hashes because obj itself disappears on
 404             # .from_table_row-triggered database reload
 405             hash_original = hash(obj)
 406             attr_name = self._change_obj(obj)
 407             obj.cache()
 408             to_cmp = getattr(obj, attr_name)
 409             retrieved = self.checked_class.from_table_row(self.db_conn, row)
 410             self.assertNotEqual(to_cmp, getattr(retrieved, attr_name))
 411             self.assertEqual(hash_original, hash(retrieved))
 412             # check cache contains what .from_table_row just produced
 413             self.assertEqual({retrieved.id_: retrieved},
 414                              self.checked_class.get_cache())
 415
 416     @TestCaseAugmented._run_on_versioned_attributes
 417     def test_versioned_history_from_row(self,
 418                                         owner: Any,
 419                                         _: str,
 420                                         attr: VersionedAttribute,
 421                                         default: str | float,
 422                                         to_set: list[str] | list[float]
 423                                         ) -> None:
 424         """"Test VersionedAttribute.history_from_row() knows its DB rows."""
 425         attr.set(to_set[0])
 426         attr.set(to_set[1])
 427         owner.save(self.db_conn)
 428         # make empty VersionedAttribute, fill from rows, compare to owner's
 429         for row in self.db_conn.row_where(owner.table_name, 'id', owner.id_):
 430             loaded_attr = VersionedAttribute(owner, attr.table_name, default)
 431             for row in self.db_conn.row_where(attr.table_name, 'parent',
 432                                               owner.id_):
 433                 loaded_attr.history_from_row(row)
 434             self.assertEqual(len(attr.history.keys()),
 435                              len(loaded_attr.history.keys()))
 436             for timestamp, value in attr.history.items():
 437                 self.assertEqual(value, loaded_attr.history[timestamp])
 438
 439     @TestCaseAugmented._run_if_checked_class
 440     def test_all(self) -> None:
 441         """Test .all() and its relation to cache and savings."""
 442         id1, id2, id3 = self.default_ids
 443         item1 = self._make_from_defaults(id1)
 444         item2 = self._make_from_defaults(id2)
 445         item3 = self._make_from_defaults(id3)
 446         # check .all() returns empty list on un-cached items
 447         self.assertEqual(self.checked_class.all(self.db_conn), [])
 448         # check that all() shows only cached/saved items
 449         item1.cache()
 450         item3.save(self.db_conn)
 451         self.assertEqual(sorted(self.checked_class.all(self.db_conn)),
 452                          sorted([item1, item3]))
 453         item2.save(self.db_conn)
 454         self.assertEqual(sorted(self.checked_class.all(self.db_conn)),
 455                          sorted([item1, item2, item3]))
 456
 457     @TestCaseAugmented._run_if_checked_class
 458     def test_singularity(self) -> None:
 459         """Test pointers made for single object keep pointing to it."""
 460         id1 = self.default_ids[0]
 461         obj = self._make_from_defaults(id1)
 462         obj.save(self.db_conn)
 463         # change object, expect retrieved through .by_id to carry change
 464         attr_name = self._change_obj(obj)
 465         new_attr = getattr(obj, attr_name)
 466         retrieved = self.checked_class.by_id(self.db_conn, id1)
 467         self.assertEqual(new_attr, getattr(retrieved, attr_name))
 468
 469     @TestCaseAugmented._run_on_versioned_attributes
 470     def test_versioned_singularity(self,
 471                                    owner: Any,
 472                                    attr_name: str,
 473                                    attr: VersionedAttribute,
 474                                    _: str | float,
 475                                    to_set: list[str] | list[float]
 476                                    ) -> None:
 477         """Test singularity of VersionedAttributes on saving."""
 478         owner.save(self.db_conn)
 479         # change obj, expect retrieved through .by_id to carry change
 480         attr.set(to_set[0])
 481         retrieved = self.checked_class.by_id(self.db_conn, owner.id_)
 482         attr_retrieved = getattr(retrieved, attr_name)
 483         self.assertEqual(attr.history, attr_retrieved.history)
 484
 485     @TestCaseAugmented._run_if_checked_class
 486     def test_remove(self) -> None:
 487         """Test .remove() effects on DB and cache."""
 488         id_ = self.default_ids[0]
 489         obj = self._make_from_defaults(id_)
 490         # check removal only works after saving
 491         with self.assertRaises(HandledException):
 492             obj.remove(self.db_conn)
 493         obj.save(self.db_conn)
 494         obj.remove(self.db_conn)
 495         # check access to obj fails after removal
 496         with self.assertRaises(HandledException):
 497             print(obj.id_)
 498         # check DB and cache now empty
 499         self.check_identity_with_cache_and_db([])
 500
 501
 502 class TestCaseWithServer(TestCaseWithDB):
 503     """Module tests against our HTTP server/handler (and database)."""
 504
 505     def setUp(self) -> None:
 506         super().setUp()
 507         self.httpd = TaskServer(self.db_file, ('localhost', 0), TaskHandler)
 508         self.server_thread = Thread(target=self.httpd.serve_forever)
 509         self.server_thread.daemon = True
 510         self.server_thread.start()
 511         self.conn = HTTPConnection(str(self.httpd.server_address[0]),
 512                                    self.httpd.server_address[1])
 513         self.httpd.set_json_mode()
 514
 515     def tearDown(self) -> None:
 516         self.httpd.shutdown()
 517         self.httpd.server_close()
 518         self.server_thread.join()
 519         super().tearDown()
 520
 521     @staticmethod
 522     def as_id_list(items: list[dict[str, object]]) -> list[int | str]:
 523         """Return list of only 'id' fields of items."""
 524         # NB: To tighten the mypy test, consider to, instead of returning
 525         # list[str | int], returnlist[int] | list[str]. But since so far to me
 526         # the only way to make that work seems to be to repaclement of the
 527         # currently active last line with complexity of the out-commented code
 528         # block beneath, I currently opt for the status quo.
 529         id_list = []
 530         for item in items:
 531             assert isinstance(item['id'], (int, str))
 532             id_list += [item['id']]
 533         return id_list
 534         # if id_list:
 535         #     if isinstance(id_list[0], int):
 536         #         for id_ in id_list:
 537         #             assert isinstance(id_, int)
 538         #         l_int: list[int] = [id_ for id_ in id_list
 539         #                             if isinstance(id_, int)]
 540         #         return l_int
 541         #     for id_ in id_list:
 542         #         assert isinstance(id_, str)
 543         #     l_str: list[str] = [id_ for id_ in id_list
 544         #                         if isinstance(id_, str)]
 545         #     return l_str
 546         # return []
 547
 548     @staticmethod
 549     def as_refs(items: list[dict[str, object]]
 550                 ) -> dict[str, dict[str, object]]:
 551         """Return dictionary of items by their 'id' fields."""
 552         refs = {}
 553         for item in items:
 554             refs[str(item['id'])] = item
 555         return refs
 556
 557     @staticmethod
 558     def cond_as_dict(id_: int = 1,
 559                      is_active: bool = False,
 560                      titles: None | list[str] = None,
 561                      descriptions: None | list[str] = None
 562                      ) -> dict[str, object]:
 563         """Return JSON of Condition to expect."""
 564         d = {'id': id_,
 565              'is_active': is_active,
 566              '_versioned': {
 567                  'title': {},
 568                  'description': {}}}
 569         titles = titles if titles else []
 570         descriptions = descriptions if descriptions else []
 571         assert isinstance(d['_versioned'], dict)
 572         for i, title in enumerate(titles):
 573             d['_versioned']['title'][i] = title
 574         for i, description in enumerate(descriptions):
 575             d['_versioned']['description'][i] = description
 576         return d
 577
 578     @staticmethod
 579     def todo_as_dict(id_: int = 1,
 580                      process_id: int = 1,
 581                      date: str = '2024-01-01',
 582                      conditions: None | list[int] = None,
 583                      disables: None | list[int] = None,
 584                      blockers: None | list[int] = None,
 585                      enables: None | list[int] = None
 586                      ) -> dict[str, object]:
 587         """Return JSON of Todo to expect."""
 588         # pylint: disable=too-many-arguments
 589         d = {'id': id_,
 590              'date': date,
 591              'process_id': process_id,
 592              'is_done': False,
 593              'calendarize': False,
 594              'comment': '',
 595              'children': [],
 596              'parents': [],
 597              'effort': None,
 598              'conditions': conditions if conditions else [],
 599              'disables': disables if disables else [],
 600              'blockers': blockers if blockers else [],
 601              'enables': enables if enables else []}
 602         return d
 603
 604     @staticmethod
 605     def proc_as_dict(id_: int = 1,
 606                      title: str = 'A',
 607                      description: str = '',
 608                      effort: float = 1.0,
 609                      conditions: None | list[int] = None,
 610                      disables: None | list[int] = None,
 611                      blockers: None | list[int] = None,
 612                      enables: None | list[int] = None
 613                      ) -> dict[str, object]:
 614         """Return JSON of Process to expect."""
 615         # pylint: disable=too-many-arguments
 616         d = {'id': id_,
 617              'calendarize': False,
 618              'suppressed_steps': [],
 619              'explicit_steps': [],
 620              '_versioned': {
 621                  'title': {0: title},
 622                  'description': {0: description},
 623                  'effort': {0: effort}},
 624              'conditions': conditions if conditions else [],
 625              'disables': disables if disables else [],
 626              'enables': enables if enables else [],
 627              'blockers': blockers if blockers else []}
 628         return d
 629
 630     def check_redirect(self, target: str) -> None:
 631         """Check that self.conn answers with a 302 redirect to target."""
 632         response = self.conn.getresponse()
 633         self.assertEqual(response.status, 302)
 634         self.assertEqual(response.getheader('Location'), target)
 635
 636     def check_get(self, target: str, expected_code: int) -> None:
 637         """Check that a GET to target yields expected_code."""
 638         self.conn.request('GET', target)
 639         self.assertEqual(self.conn.getresponse().status, expected_code)
 640
 641     def check_post(self, data: Mapping[str, object], target: str,
 642                    expected_code: int = 302, redir: str = '') -> None:
 643         """Check that POST of data to target yields expected_code."""
 644         encoded_form_data = urlencode(data, doseq=True).encode('utf-8')
 645         headers = {'Content-Type': 'application/x-www-form-urlencoded',
 646                    'Content-Length': str(len(encoded_form_data))}
 647         self.conn.request('POST', target,
 648                           body=encoded_form_data, headers=headers)
 649         if 302 == expected_code:
 650             redir = target if redir == '' else redir
 651             self.check_redirect(redir)
 652         else:
 653             self.assertEqual(self.conn.getresponse().status, expected_code)
 654
 655     def check_get_defaults(self, path: str) -> None:
 656         """Some standard model paths to test."""
 657         self.check_get(path, 200)
 658         self.check_get(f'{path}?id=', 200)
 659         self.check_get(f'{path}?id=foo', 400)
 660         self.check_get(f'/{path}?id=0', 500)
 661         self.check_get(f'{path}?id=1', 200)
 662
 663     def post_process(self, id_: int = 1,
 664                      form_data: dict[str, Any] | None = None
 665                      ) -> dict[str, Any]:
 666         """POST basic Process."""
 667         if not form_data:
 668             form_data = {'title': 'foo', 'description': 'foo', 'effort': 1.1}
 669         self.check_post(form_data, f'/process?id={id_}',
 670                         redir=f'/process?id={id_}')
 671         return form_data
 672
 673     def check_json_get(self, path: str, expected: dict[str, object]) -> None:
 674         """Compare JSON on GET path with expected.
 675
 676         To simplify comparison of VersionedAttribute histories, transforms
 677         timestamp keys of VersionedAttribute history keys into integers
 678         counting chronologically forward from 0.
 679         """
 680
 681         def rewrite_history_keys_in(item: Any) -> Any:
 682             if isinstance(item, dict):
 683                 if '_versioned' in item.keys():
 684                     for k in item['_versioned']:
 685                         vals = item['_versioned'][k].values()
 686                         history = {}
 687                         for i, val in enumerate(vals):
 688                             history[i] = val
 689                         item['_versioned'][k] = history
 690                 for k in list(item.keys()):
 691                     rewrite_history_keys_in(item[k])
 692             elif isinstance(item, list):
 693                 item[:] = [rewrite_history_keys_in(i) for i in item]
 694             return item
 695
 696         self.conn.request('GET', path)
 697         response = self.conn.getresponse()
 698         self.assertEqual(response.status, 200)
 699         retrieved = json_loads(response.read().decode())
 700         rewrite_history_keys_in(retrieved)
 701         # import pprint
 702         # pprint.pprint(expected)
 703         # pprint.pprint(retrieved)
 704         self.assertEqual(expected, retrieved)