Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f27c84488d | ||
|
|
c0c540c194 | ||
|
|
a679004720 | ||
|
|
492c1149f0 | ||
|
|
c6d42e8277 | ||
|
|
e98642e236 | ||
|
|
01905ec9ee | ||
|
|
30748f786a |
@@ -11,7 +11,7 @@ from homeassistant.core import HomeAssistant
|
|||||||
|
|
||||||
from .const import DOMAIN, LOGGER
|
from .const import DOMAIN, LOGGER
|
||||||
from .db import NestQuestDatabase
|
from .db import NestQuestDatabase
|
||||||
from .schema import SCHEMA_V1_STATEMENTS, async_apply_ddl
|
from .migrations import apply_migrations
|
||||||
from .store import async_get_db_path
|
from .store import async_get_db_path
|
||||||
|
|
||||||
_LOGGER = LOGGER
|
_LOGGER = LOGGER
|
||||||
@@ -52,7 +52,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|||||||
|
|
||||||
database = await NestQuestDatabase(hass).open(await async_get_db_path(hass))
|
database = await NestQuestDatabase(hass).open(await async_get_db_path(hass))
|
||||||
try:
|
try:
|
||||||
await async_apply_ddl(database, SCHEMA_V1_STATEMENTS)
|
await apply_migrations(database)
|
||||||
remove_update_listener = entry.add_update_listener(_async_update_listener)
|
remove_update_listener = entry.add_update_listener(_async_update_listener)
|
||||||
except BaseException:
|
except BaseException:
|
||||||
await database.close()
|
await database.close()
|
||||||
|
|||||||
@@ -0,0 +1,236 @@
|
|||||||
|
"""Versioned schema migration runner for the NestQuest SQLite database.
|
||||||
|
|
||||||
|
The runner owns one metadata table, ``nestquest_schema_version``, holding
|
||||||
|
a single row with the schema version the database file currently
|
||||||
|
reflects. Migrations are declared as an ordered list: entry ``n``
|
||||||
|
upgrades version ``n-1`` to version ``n``. Applying a migration means
|
||||||
|
running its DDL inside one transaction and stamping the new version in
|
||||||
|
that same transaction, so a database never persists a half-applied
|
||||||
|
migration: any failure rolls the statements and the version stamp back
|
||||||
|
together, leaving the file at its prior version.
|
||||||
|
|
||||||
|
Version 0 means "the file exists but carries no NestQuest schema yet"
|
||||||
|
— a fresh file, or a file this integration has never written. Starting
|
||||||
|
the runner against version 0 applies migration 1, which applies the
|
||||||
|
full v1 DDL from :mod:`.schema` and stamps version 1.
|
||||||
|
|
||||||
|
Each migration's statements and its version stamp run inside ONE
|
||||||
|
transaction, and the stamp is written as DELETE + INSERT rather than
|
||||||
|
UPDATE because a version-0 database has no version row to update yet.
|
||||||
|
An UPDATE form would silently match zero rows there and leave the
|
||||||
|
database migrated but unstamped — reporting version 0 forever, and
|
||||||
|
re-applying migration 1 on every startup. The DELETE+INSERT shape is
|
||||||
|
also what makes the stamp a replace, so the row never duplicates.
|
||||||
|
|
||||||
|
Idempotence across restarts: a database already at the latest version
|
||||||
|
has no pending migrations, so the runner opens a read-only check, finds
|
||||||
|
nothing to do, and leaves the file byte-untouched (no write transaction
|
||||||
|
is opened, so no WAL churn).
|
||||||
|
|
||||||
|
Migration list policy: entries are append-only. Once shipped, a
|
||||||
|
migration's SQL must never be edited — an old database applying it for
|
||||||
|
the first time and a fresh database would then diverge. Fix-forward
|
||||||
|
with a new migration instead. The version stamp lives in the same
|
||||||
|
SQLite file as the data it describes, so restoring a backup restores
|
||||||
|
its matching schema version with it.
|
||||||
|
|
||||||
|
Corrupt or missing files are not this module's concern: startup
|
||||||
|
handling of those cases is task d5bca74b, which decides whether to
|
||||||
|
open fresh or raise ConfigEntryNotReady. This runner assumes it is
|
||||||
|
handed an open, working connection.
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import logging
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
from .db import NestQuestDatabase
|
||||||
|
from .schema import SCHEMA_V1_STATEMENTS
|
||||||
|
|
||||||
|
LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
#: Metadata table holding the applied schema version. Prefixed with the
|
||||||
|
#: integration domain so a config directory shared with other tools can
|
||||||
|
#: never collide with a foreign ``schema_version`` table.
|
||||||
|
VERSION_TABLE = "nestquest_schema_version"
|
||||||
|
|
||||||
|
#: DDL for the version metadata table. The singleton-row invariant is
|
||||||
|
#: enforced by the schema itself: ``id`` is fixed at 1 by CHECK, keyed
|
||||||
|
#: PRIMARY KEY, so the table can never hold a second row, and the
|
||||||
|
#: stamp write is an UPDATE (no DELETE+INSERT needed). ``version`` is
|
||||||
|
#: a positive integer: version 0 means "no row" and is never stored,
|
||||||
|
#: so a negative or zero stored value is corruption, not a state the
|
||||||
|
#: runner can act on.
|
||||||
|
VERSION_TABLE_DDL = f"""
|
||||||
|
CREATE TABLE IF NOT EXISTS {VERSION_TABLE} (
|
||||||
|
id INTEGER NOT NULL PRIMARY KEY CHECK (id = 1),
|
||||||
|
version INTEGER NOT NULL CHECK (version >= 1)
|
||||||
|
)
|
||||||
|
"""
|
||||||
|
|
||||||
|
#: One-based index into :data:`MIGRATIONS`: entry ``n`` upgrades
|
||||||
|
#: version ``n-1`` to version ``n``.
|
||||||
|
MIGRATION_1_V1_DDL: list[str] = list(SCHEMA_V1_STATEMENTS)
|
||||||
|
|
||||||
|
#: The ordered migration list. Append-only: never edit an applied
|
||||||
|
#: entry, add the next one instead.
|
||||||
|
MIGRATIONS: Sequence[Sequence[str]] = [
|
||||||
|
MIGRATION_1_V1_DDL,
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
async def _create_version_table(database: NestQuestDatabase) -> None:
|
||||||
|
"""Create the version metadata table if it does not exist.
|
||||||
|
|
||||||
|
The table is created before any version check: it is the runner's
|
||||||
|
own bookkeeping, and creating it is idempotent. The DDL enforces
|
||||||
|
the singleton-row invariant (``id`` fixed at 1) and a positive
|
||||||
|
integer version at the database level.
|
||||||
|
"""
|
||||||
|
await database.execute(VERSION_TABLE_DDL)
|
||||||
|
|
||||||
|
|
||||||
|
async def read_schema_version(database: NestQuestDatabase) -> int:
|
||||||
|
"""Return the schema version recorded in the database.
|
||||||
|
|
||||||
|
Returns 0 when the version table or its row is missing — the
|
||||||
|
"fresh file" case. A stored version higher than the runner knows
|
||||||
|
is surfaced as-is; the caller decides how to treat a future version.
|
||||||
|
|
||||||
|
Reading is deliberately passive: a missing table raises, it is not
|
||||||
|
swallowed into 0, because :func:`apply_migrations` always creates
|
||||||
|
the table before reading and a direct reader hitting "no such
|
||||||
|
table" is a caller bug worth surfacing, not a fresh file.
|
||||||
|
"""
|
||||||
|
row = await database.fetch_one(
|
||||||
|
f"SELECT version FROM {VERSION_TABLE} LIMIT 1"
|
||||||
|
)
|
||||||
|
if row is None:
|
||||||
|
return 0
|
||||||
|
version = row[0]
|
||||||
|
if not isinstance(version, int) or isinstance(version, bool):
|
||||||
|
raise RuntimeError(
|
||||||
|
f"Schema version metadata is not an integer: {version!r}"
|
||||||
|
)
|
||||||
|
if version < 1:
|
||||||
|
raise RuntimeError(
|
||||||
|
f"Schema version metadata is invalid (must be >= 1): {version!r}"
|
||||||
|
)
|
||||||
|
return version
|
||||||
|
|
||||||
|
|
||||||
|
#: One asyncio.Lock per connection wrapper, created lazily and bound to
|
||||||
|
#: the running loop, serializing whole apply_migrations runs so two
|
||||||
|
#: concurrent callers on one connection queue instead of colliding on
|
||||||
|
#: the wrapper's single-transaction rule.
|
||||||
|
_MIGRATION_LOCKS: dict[int, asyncio.Lock] = {}
|
||||||
|
|
||||||
|
|
||||||
|
def _migration_lock(database: NestQuestDatabase) -> asyncio.Lock:
|
||||||
|
"""Return the migration lock bound to ``database``'s running loop."""
|
||||||
|
loop = asyncio.get_running_loop()
|
||||||
|
key = (id(database), id(loop))
|
||||||
|
lock = _MIGRATION_LOCKS.get(key)
|
||||||
|
if lock is None:
|
||||||
|
lock = asyncio.Lock()
|
||||||
|
_MIGRATION_LOCKS[key] = lock
|
||||||
|
return lock
|
||||||
|
|
||||||
|
|
||||||
|
async def apply_migrations(
|
||||||
|
database: NestQuestDatabase,
|
||||||
|
migrations: Sequence[Sequence[str]] = MIGRATIONS,
|
||||||
|
) -> int:
|
||||||
|
"""Bring the database schema up to the latest version.
|
||||||
|
|
||||||
|
Reads the current version, applies every pending migration in order
|
||||||
|
— each inside one transaction that also stamps the new version —
|
||||||
|
and returns the resulting version. Applying zero pending
|
||||||
|
migrations (database already current) is a no-op that logs at debug
|
||||||
|
level and opens no write transaction.
|
||||||
|
|
||||||
|
The version is re-read inside each migration transaction before
|
||||||
|
deciding to apply it: the outer read is advisory only (loop bounds,
|
||||||
|
no-op fast path), and on one shared connection two interleaved
|
||||||
|
runners would otherwise both read the same version and both apply
|
||||||
|
a non-idempotent migration. Under the transaction's lock the
|
||||||
|
second runner sees the first runner's stamp and skips.
|
||||||
|
|
||||||
|
Runners on one connection are serialized by an asyncio lock held
|
||||||
|
for the whole decide-and-apply span: NestQuestDatabase rejects a
|
||||||
|
second transaction while one is active (RuntimeError), so
|
||||||
|
concurrent callers must queue, and the lock makes that queueing
|
||||||
|
explicit. The loser of the race re-reads the version once it
|
||||||
|
acquires the lock, sees the winner's stamp, and applies nothing.
|
||||||
|
|
||||||
|
Raises whatever the failing migration raised, with the database
|
||||||
|
rolled back to its prior version and prior rows untouched.
|
||||||
|
"""
|
||||||
|
async with _migration_lock(database):
|
||||||
|
await _create_version_table(database)
|
||||||
|
current = await read_schema_version(database)
|
||||||
|
latest = len(migrations)
|
||||||
|
|
||||||
|
if current > latest:
|
||||||
|
raise RuntimeError(
|
||||||
|
f"Database schema version {current} is newer than this "
|
||||||
|
f"integration understands (latest known: {latest}); "
|
||||||
|
"downgrades are not supported"
|
||||||
|
)
|
||||||
|
|
||||||
|
if current == latest:
|
||||||
|
LOGGER.debug(
|
||||||
|
"NestQuest schema already at version %d; "
|
||||||
|
"no migrations to apply",
|
||||||
|
current,
|
||||||
|
)
|
||||||
|
return current
|
||||||
|
|
||||||
|
for target in range(current + 1, latest + 1):
|
||||||
|
applied = False
|
||||||
|
async with database.transaction():
|
||||||
|
# Re-read the version INSIDE the write transaction: the
|
||||||
|
# outer read was advisory, and the wrapper serializes
|
||||||
|
# individual statements, not the read-decide-apply
|
||||||
|
# decision. Under the transaction's lock the version
|
||||||
|
# cannot change between the read and the stamp, and the
|
||||||
|
# loser of an interleaved race (a queued second caller
|
||||||
|
# re-running apply_migrations after the winner already
|
||||||
|
# migrated) re-reads here, sees the winner's stamp, and
|
||||||
|
# skips instead of re-applying a non-idempotent
|
||||||
|
# migration with a stale version.
|
||||||
|
in_tx_version = await read_schema_version(database)
|
||||||
|
if in_tx_version > latest:
|
||||||
|
raise RuntimeError(
|
||||||
|
f"Database schema version {in_tx_version} is newer "
|
||||||
|
f"than this integration understands (latest known: "
|
||||||
|
f"{latest}); downgrades are not supported"
|
||||||
|
)
|
||||||
|
if in_tx_version < target:
|
||||||
|
for sql in migrations[target - 1]:
|
||||||
|
await database.execute(sql)
|
||||||
|
# INSERT keyed on the singleton row (id = 1): a
|
||||||
|
# fresh file has no row yet, and migration 1 is the
|
||||||
|
# only migration a version-0 database can run, so
|
||||||
|
# the row is seeded by the same statement batch
|
||||||
|
# when needed. UPDATE alone would silently match
|
||||||
|
# zero rows there.
|
||||||
|
await database.execute(
|
||||||
|
f"INSERT INTO {VERSION_TABLE} (id, version) "
|
||||||
|
"VALUES (1, ?) "
|
||||||
|
"ON CONFLICT (id) DO UPDATE SET version = "
|
||||||
|
"excluded.version",
|
||||||
|
(target,),
|
||||||
|
)
|
||||||
|
applied = True
|
||||||
|
if applied:
|
||||||
|
LOGGER.info(
|
||||||
|
"NestQuest schema migrated to version %d "
|
||||||
|
"(%d statement%s)",
|
||||||
|
target,
|
||||||
|
len(migrations[target - 1]),
|
||||||
|
"s" if len(migrations[target - 1]) != 1 else "",
|
||||||
|
)
|
||||||
|
|
||||||
|
return latest
|
||||||
@@ -12,11 +12,163 @@ caller/DAO rather than a DB default, per the feature guardrails. No
|
|||||||
produced by callers is not fixed yet (``datetime.isoformat()`` may
|
produced by callers is not fixed yet (``datetime.isoformat()`` may
|
||||||
include microseconds, changing the length), so enforcing a fixed length
|
include microseconds, changing the length), so enforcing a fixed length
|
||||||
here would reject valid values. Only non-null is enforced for now.
|
here would reject valid values. Only non-null is enforced for now.
|
||||||
|
|
||||||
|
Date policy: ``start_date``/``end_date`` are ISO date strings (YYYY-MM-DD,
|
||||||
|
no time component) compared lexically by the ``end_date >= start_date``
|
||||||
|
CHECK; due_date/due_time string shapes are caller-validated by the rule
|
||||||
|
engine and DAO layers, not by DDL.
|
||||||
|
|
||||||
|
``weekday_set`` format: comma-separated weekday integers (CSV), 0 =
|
||||||
|
Monday .. 6 = Sunday, e.g. ``'0,2,4'`` for Mon/Wed/Fri. Chosen over JSON
|
||||||
|
because it sorts, compares and parses trivially in SQL. The format is
|
||||||
|
enforced at the DB level: a CHECK matches ``weekday_set`` against GLOB
|
||||||
|
patterns for element counts 1..7 of single digits 0-6 (GLOB has no
|
||||||
|
repetition quantifier, so the element count is enumerated; more than 7
|
||||||
|
elements is impossible for a weekday set). ``''``, ``'x'``, ``'7'`` and
|
||||||
|
``'0,x'`` are all rejected; NULL stays allowed for non-weekly rules.
|
||||||
|
This keeps the schema layer storage-only — the DAO layer (tasks
|
||||||
|
8c72300c+) does not need its own validator, it can rely on the CHECK.
|
||||||
|
|
||||||
|
Type affinity: SQLite applies column affinity on insert, but CHECKs
|
||||||
|
still observe text and fractional values ('abc' stays text, '1.5'
|
||||||
|
becomes REAL), so every INTEGER column carrying rule semantics carries
|
||||||
|
a ``typeof(...) = 'integer'`` guard in its CHECK.
|
||||||
|
|
||||||
|
Rule-type coherence: two CHECKs enforce that ``weekly`` carries a
|
||||||
|
non-null ``weekday_set``, ``monthly`` carries a ``day_of_month`` or an
|
||||||
|
``nth_weekday``, ``yearly`` carries a ``month``, and ``daily``/``custom``
|
||||||
|
carry none of the month-specific fields. Relaxed deliberately: the DDL
|
||||||
|
does NOT forbid ``month`` on weekly/monthly rules (an "every 2 weeks"
|
||||||
|
rule or a monthly rule could later be pinned to a month) nor extra
|
||||||
|
fields on weekly/monthly/yearly rules generally, so the CHECKs only
|
||||||
|
reject what the rule engine definitively cannot express now.
|
||||||
|
|
||||||
|
Presence pattern format: ``presence_schedules.pattern`` encodes the
|
||||||
|
whole N-week repeating cycle in one TEXT column as pipe-separated
|
||||||
|
segments, one per week of the cycle: segment ``i`` is a ``weekday_set``
|
||||||
|
CSV (same single-digit 0-6 convention as ``schedule_rules.weekday_set``)
|
||||||
|
for week ``i``, e.g. ``'0,2,4|1,3'`` = Mon/Wed/Fri in week 0, Tue/Thu in
|
||||||
|
week 1. An empty segment means the child is absent every day of that
|
||||||
|
week; a wholly empty pattern with ``cycle_length_weeks = 1`` means
|
||||||
|
absent every day of every week, which is distinct from having no
|
||||||
|
schedule row at all (a child with no schedule is present every day, per
|
||||||
|
the feature guardrails). Chosen over JSON or per-week rows to stay
|
||||||
|
consistent with the CSV ``weekday_set`` convention and fully checkable
|
||||||
|
by plain CHECKs. DB-level validation is pure CHECK, no triggers or
|
||||||
|
custom functions: char-class GLOBs reject every character outside
|
||||||
|
digits 0-6, comma and pipe; adjacency GLOBs reject empty elements
|
||||||
|
(double comma, comma next to a pipe, leading/trailing comma) and
|
||||||
|
two-digit runs; a further GLOB rejects contiguous runs of 8+ comma
|
||||||
|
separated digits, which caps a segment at 7 elements — the GLOB cannot
|
||||||
|
match across a ``|``, so cross-segment boundaries stay safe; and the
|
||||||
|
segment count is pinned to ``cycle_length_weeks`` by
|
||||||
|
``LENGTH(pattern) - LENGTH(REPLACE(pattern, '|', '')) + 1``. Per
|
||||||
|
weekday_set this is not full CSV-set normalisation (duplicates like
|
||||||
|
``'0,0'`` or unsorted sets stay storable, as with ``schedule_rules``);
|
||||||
|
the engine treats the segment as a set. A
|
||||||
|
one-row-per-``week_index`` normalization was considered and rejected:
|
||||||
|
the flat single-column encoding keeps the done-condition's table shape
|
||||||
|
and proved fully checkable with plain CHECKs.
|
||||||
|
|
||||||
|
``cycle_length_weeks`` is capped at 4: 2 (alternating weeks) is the
|
||||||
|
common case, and a small cap keeps anchor arithmetic and the encoded
|
||||||
|
pattern human-readable. Revisit the cap — and re-run the pattern
|
||||||
|
validation matrix in tests — if a longer cycle is ever needed.
|
||||||
|
``anchor_date`` is an ISO date string pinning the cycle: the week index
|
||||||
|
of a date is (days since anchor) // 7 mod ``cycle_length_weeks``,
|
||||||
|
computed by the presence engine (Feature 05) from anchor-date
|
||||||
|
arithmetic, never ISO week parity. Like other date columns it carries
|
||||||
|
no shape CHECK, matching the established date policy.
|
||||||
|
|
||||||
|
Presence overrides: ``presence_overrides.end_date`` is NOT NULL,
|
||||||
|
unlike ``schedule_rules.end_date`` — an override is always a concrete
|
||||||
|
date range; a single-day override stores the same date in both columns.
|
||||||
|
``is_present`` 0/1 marks the child absent/present for the whole range;
|
||||||
|
``note`` is optional free text.
|
||||||
|
|
||||||
|
Task instances: ``task_instances`` deliberately carries NO completion
|
||||||
|
status column. An instance's current state derives from the latest row
|
||||||
|
in ``completion_events`` (Feature 08), so materialization (Feature 07)
|
||||||
|
can insert instances without knowing anything about completion and the
|
||||||
|
append-only log stays the single source of truth. ``definition_id``,
|
||||||
|
``due_date`` and ``child_id`` snapshot the materialization-time facts
|
||||||
|
("why this instance exists"): reassignment and rule edits change future
|
||||||
|
instances only and never rewrite these rows. ``due_time`` snapshots
|
||||||
|
the definition's optional due time at generation for the same reason —
|
||||||
|
the instance keeps its generation-time value even if the definition is
|
||||||
|
edited later. ``generated_at`` is a caller-set UTC ISO-8601 timestamp
|
||||||
|
per the module timestamp policy (no DB default, so a generation batch
|
||||||
|
stamps one coherent time).
|
||||||
|
|
||||||
|
Uniqueness: the (definition_id, due_date) pair is declared as a
|
||||||
|
table-level ``UNIQUE`` constraint rather than a separate ``CREATE
|
||||||
|
UNIQUE INDEX`` statement. SQLite materializes it as an implicit unique
|
||||||
|
index (``sqlite_autoindex_task_instances_1``) — the required "unique
|
||||||
|
index prevents duplicate instances" — and the constraint form cannot be
|
||||||
|
silently dropped the way a standalone index can, so the duplicate door
|
||||||
|
stays shut. Idempotent materialization keys on exactly this pair. No
|
||||||
|
secondary indexes beyond it are declared yet: history and board queries
|
||||||
|
(Features 08/10/13) should justify their indexes as a later migration
|
||||||
|
once their query shapes exist.
|
||||||
|
|
||||||
|
No ``ON DELETE`` clauses are declared on any foreign key in this
|
||||||
|
module: children and definitions are deactivated, never deleted, so a
|
||||||
|
deletion that would orphan instances or events is a bug and must fail
|
||||||
|
loudly rather than cascade.
|
||||||
|
|
||||||
|
Completion events: ``completion_events`` is strictly append-only. That
|
||||||
|
property is enforced at the DAO layer — the completion-events DAO
|
||||||
|
exposes no UPDATE or DELETE path (task a9ea75fc) — and deliberately NOT
|
||||||
|
by database triggers, matching the module's no-trigger policy: a RAISE
|
||||||
|
trigger would be the one exception to "pure CHECK, no triggers",
|
||||||
|
complicate the later migration runner, and still prove nothing (any
|
||||||
|
writer can run raw SQL). ``event_type`` is constrained to
|
||||||
|
``completed``/``uncompleted``; a ``missed`` row is intentionally not
|
||||||
|
representable — missed is a derived state announced on the HA event bus
|
||||||
|
(Feature 10), never an appended event.
|
||||||
|
|
||||||
|
``child_id`` is deliberately denormalized (it is also derivable via
|
||||||
|
``task_instances``): history reporting (Feature 13) filters and rates
|
||||||
|
per child directly against the log, and the log should stay
|
||||||
|
self-describing without joins.
|
||||||
|
|
||||||
|
Actor policy: ``actor_source`` distinguishes an authenticated HA user
|
||||||
|
(``'user'``, with ``actor_user_id`` holding the HA user id) from a
|
||||||
|
panel tap with no user context (``'panel'``, with ``actor_user_id``
|
||||||
|
NULL — the tapped child profile is already ``child_id``). A coherence
|
||||||
|
CHECK makes the pair shape non-negotiable: ``'user'`` requires
|
||||||
|
``actor_user_id``, ``'panel'`` forbids it. Other actor sources are
|
||||||
|
rejected; if an unattended system actor is ever needed, that is a
|
||||||
|
schema migration, not a silent widening.
|
||||||
|
|
||||||
|
On-time policy: ``was_on_time`` is required (integer 0 or 1) for
|
||||||
|
``completed`` events — at completion time the due date is known and the
|
||||||
|
flag is decidable. For ``uncompleted`` events the flag is optional:
|
||||||
|
Feature 08 decides whether a reversal carries the reversed completion's
|
||||||
|
on-time flag or NULL, and the DDL deliberately accepts both rather than
|
||||||
|
guessing.
|
||||||
"""
|
"""
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from .db import NestQuestDatabase
|
from .db import NestQuestDatabase
|
||||||
|
|
||||||
|
#: GLOB patterns matching a valid ``weekday_set`` CSV: one GLOB per
|
||||||
|
#: possible element count 1..7 (a weekday set cannot exceed 7 elements).
|
||||||
|
#: Each element is a single digit 0-6, separated by a literal comma.
|
||||||
|
#: GLOB has no repetition quantifier, so the element count is enumerated.
|
||||||
|
#: ``''`` and NULL are deliberately NOT matched: NULL is allowed for
|
||||||
|
#: non-weekly rules via a separate ``IS NULL`` arm, and '' is invalid
|
||||||
|
#: because weekly rules need at least one weekday.
|
||||||
|
WEEKDAY_SET_GLOB_PATTERNS: list[str] = [
|
||||||
|
"[0-6]",
|
||||||
|
"[0-6],[0-6]",
|
||||||
|
"[0-6],[0-6],[0-6]",
|
||||||
|
"[0-6],[0-6],[0-6],[0-6]",
|
||||||
|
"[0-6],[0-6],[0-6],[0-6],[0-6]",
|
||||||
|
"[0-6],[0-6],[0-6],[0-6],[0-6],[0-6]",
|
||||||
|
"[0-6],[0-6],[0-6],[0-6],[0-6],[0-6],[0-6]",
|
||||||
|
]
|
||||||
|
|
||||||
SCHEMA_V1_CHILDREN_DDL: list[str] = [
|
SCHEMA_V1_CHILDREN_DDL: list[str] = [
|
||||||
"""
|
"""
|
||||||
CREATE TABLE IF NOT EXISTS children (
|
CREATE TABLE IF NOT EXISTS children (
|
||||||
@@ -24,8 +176,8 @@ SCHEMA_V1_CHILDREN_DDL: list[str] = [
|
|||||||
display_name TEXT NOT NULL,
|
display_name TEXT NOT NULL,
|
||||||
colour TEXT,
|
colour TEXT,
|
||||||
avatar_ref TEXT,
|
avatar_ref TEXT,
|
||||||
sort_order INTEGER NOT NULL DEFAULT 0,
|
sort_order INTEGER NOT NULL DEFAULT 0 CHECK (typeof(sort_order) = 'integer'),
|
||||||
is_active INTEGER NOT NULL DEFAULT 1 CHECK (is_active IN (0, 1)),
|
is_active INTEGER NOT NULL DEFAULT 1 CHECK (typeof(is_active) = 'integer' AND is_active IN (0, 1)),
|
||||||
created_at TEXT NOT NULL
|
created_at TEXT NOT NULL
|
||||||
)
|
)
|
||||||
""",
|
""",
|
||||||
@@ -40,9 +192,134 @@ SCHEMA_V1_ADMIN_USERS_DDL: list[str] = [
|
|||||||
""",
|
""",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
_WEEKDAY_SET_CHECK = " OR ".join(
|
||||||
|
f"weekday_set GLOB '{pattern}'" for pattern in WEEKDAY_SET_GLOB_PATTERNS
|
||||||
|
)
|
||||||
|
|
||||||
|
SCHEMA_V1_SCHEDULE_RULES_DDL: list[str] = [
|
||||||
|
f"""
|
||||||
|
CREATE TABLE IF NOT EXISTS schedule_rules (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
rule_type TEXT NOT NULL CHECK (rule_type IN ('daily', 'weekly', 'monthly', 'yearly', 'custom')),
|
||||||
|
interval INTEGER NOT NULL DEFAULT 1 CHECK (typeof(interval) = 'integer' AND interval >= 1),
|
||||||
|
weekday_set TEXT CHECK (weekday_set IS NULL OR ({_WEEKDAY_SET_CHECK})),
|
||||||
|
day_of_month INTEGER CHECK (day_of_month IS NULL OR (typeof(day_of_month) = 'integer' AND day_of_month >= 1 AND day_of_month <= 31)),
|
||||||
|
nth_weekday INTEGER CHECK (nth_weekday IS NULL OR (typeof(nth_weekday) = 'integer' AND nth_weekday IN (-1, 1, 2, 3, 4, 5))),
|
||||||
|
month INTEGER CHECK (month IS NULL OR (typeof(month) = 'integer' AND month >= 1 AND month <= 12)),
|
||||||
|
start_date TEXT NOT NULL,
|
||||||
|
end_date TEXT,
|
||||||
|
CHECK (end_date IS NULL OR end_date >= start_date),
|
||||||
|
CHECK (
|
||||||
|
(rule_type = 'weekly' AND weekday_set IS NOT NULL)
|
||||||
|
OR (rule_type = 'monthly' AND (day_of_month IS NOT NULL OR nth_weekday IS NOT NULL))
|
||||||
|
OR (rule_type = 'yearly' AND month IS NOT NULL)
|
||||||
|
OR (rule_type IN ('daily', 'custom') AND day_of_month IS NULL AND nth_weekday IS NULL AND month IS NULL)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
""",
|
||||||
|
]
|
||||||
|
|
||||||
|
SCHEMA_V1_TASK_DEFINITIONS_DDL: list[str] = [
|
||||||
|
"""
|
||||||
|
CREATE TABLE IF NOT EXISTS task_definitions (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
description TEXT,
|
||||||
|
icon TEXT,
|
||||||
|
child_id INTEGER NOT NULL REFERENCES children(id),
|
||||||
|
schedule_rule_id INTEGER NOT NULL REFERENCES schedule_rules(id),
|
||||||
|
due_time TEXT,
|
||||||
|
is_active INTEGER NOT NULL DEFAULT 1 CHECK (typeof(is_active) = 'integer' AND is_active IN (0, 1)),
|
||||||
|
created_at TEXT NOT NULL
|
||||||
|
)
|
||||||
|
""",
|
||||||
|
]
|
||||||
|
|
||||||
|
SCHEMA_V1_PRESENCE_SCHEDULES_DDL: list[str] = [
|
||||||
|
f"""
|
||||||
|
CREATE TABLE IF NOT EXISTS presence_schedules (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
child_id INTEGER NOT NULL UNIQUE REFERENCES children(id),
|
||||||
|
cycle_length_weeks INTEGER NOT NULL CHECK (typeof(cycle_length_weeks) = 'integer' AND cycle_length_weeks >= 1 AND cycle_length_weeks <= 4),
|
||||||
|
anchor_date TEXT NOT NULL,
|
||||||
|
pattern TEXT NOT NULL CHECK (
|
||||||
|
NOT pattern GLOB '*[^0-6,|]*'
|
||||||
|
AND NOT pattern GLOB '*[0-6][0-6]*'
|
||||||
|
AND NOT pattern GLOB '*,,*'
|
||||||
|
AND NOT pattern GLOB '*,|*'
|
||||||
|
AND NOT pattern GLOB '*|,*'
|
||||||
|
AND NOT pattern GLOB ',*'
|
||||||
|
AND NOT pattern GLOB '*,'
|
||||||
|
AND NOT pattern GLOB '*[0-6],[0-6],[0-6],[0-6],[0-6],[0-6],[0-6],[0-6]*'
|
||||||
|
AND (LENGTH(pattern) - LENGTH(REPLACE(pattern, '|', '')) + 1) = cycle_length_weeks
|
||||||
|
)
|
||||||
|
)
|
||||||
|
""",
|
||||||
|
]
|
||||||
|
|
||||||
|
SCHEMA_V1_PRESENCE_OVERRIDES_DDL: list[str] = [
|
||||||
|
"""
|
||||||
|
CREATE TABLE IF NOT EXISTS presence_overrides (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
child_id INTEGER NOT NULL REFERENCES children(id),
|
||||||
|
start_date TEXT NOT NULL,
|
||||||
|
end_date TEXT NOT NULL,
|
||||||
|
is_present INTEGER NOT NULL CHECK (typeof(is_present) = 'integer' AND is_present IN (0, 1)),
|
||||||
|
note TEXT,
|
||||||
|
CHECK (end_date >= start_date)
|
||||||
|
)
|
||||||
|
""",
|
||||||
|
]
|
||||||
|
|
||||||
|
SCHEMA_V1_TASK_INSTANCES_DDL: list[str] = [
|
||||||
|
"""
|
||||||
|
CREATE TABLE IF NOT EXISTS task_instances (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
definition_id INTEGER NOT NULL REFERENCES task_definitions(id),
|
||||||
|
child_id INTEGER NOT NULL REFERENCES children(id),
|
||||||
|
due_date TEXT NOT NULL,
|
||||||
|
due_time TEXT,
|
||||||
|
generated_at TEXT NOT NULL,
|
||||||
|
UNIQUE (definition_id, due_date)
|
||||||
|
)
|
||||||
|
""",
|
||||||
|
]
|
||||||
|
|
||||||
|
SCHEMA_V1_COMPLETION_EVENTS_DDL: list[str] = [
|
||||||
|
"""
|
||||||
|
CREATE TABLE IF NOT EXISTS completion_events (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
instance_id INTEGER NOT NULL REFERENCES task_instances(id),
|
||||||
|
child_id INTEGER NOT NULL REFERENCES children(id),
|
||||||
|
event_type TEXT NOT NULL CHECK (event_type IN ('completed', 'uncompleted')),
|
||||||
|
actor_source TEXT NOT NULL CHECK (actor_source IN ('user', 'panel')),
|
||||||
|
actor_user_id TEXT,
|
||||||
|
occurred_at TEXT NOT NULL,
|
||||||
|
was_on_time INTEGER CHECK (
|
||||||
|
was_on_time IS NULL
|
||||||
|
OR (typeof(was_on_time) = 'integer' AND was_on_time IN (0, 1))
|
||||||
|
),
|
||||||
|
CHECK (
|
||||||
|
(actor_source = 'user' AND actor_user_id IS NOT NULL)
|
||||||
|
OR (actor_source = 'panel' AND actor_user_id IS NULL)
|
||||||
|
),
|
||||||
|
CHECK (
|
||||||
|
(event_type = 'completed' AND was_on_time IS NOT NULL)
|
||||||
|
OR (event_type = 'uncompleted')
|
||||||
|
)
|
||||||
|
)
|
||||||
|
""",
|
||||||
|
]
|
||||||
|
|
||||||
SCHEMA_V1_STATEMENTS: list[str] = [
|
SCHEMA_V1_STATEMENTS: list[str] = [
|
||||||
*SCHEMA_V1_CHILDREN_DDL,
|
*SCHEMA_V1_CHILDREN_DDL,
|
||||||
*SCHEMA_V1_ADMIN_USERS_DDL,
|
*SCHEMA_V1_ADMIN_USERS_DDL,
|
||||||
|
*SCHEMA_V1_SCHEDULE_RULES_DDL,
|
||||||
|
*SCHEMA_V1_TASK_DEFINITIONS_DDL,
|
||||||
|
*SCHEMA_V1_PRESENCE_SCHEDULES_DDL,
|
||||||
|
*SCHEMA_V1_PRESENCE_OVERRIDES_DDL,
|
||||||
|
*SCHEMA_V1_TASK_INSTANCES_DDL,
|
||||||
|
*SCHEMA_V1_COMPLETION_EVENTS_DDL,
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+20
-1
@@ -236,4 +236,23 @@ async def test_unload_closes_database_even_when_listener_removal_raises() -> Non
|
|||||||
await async_unload_entry(hass, entry)
|
await async_unload_entry(hass, entry)
|
||||||
assert database.connected is False, "database leaked despite remover error"
|
assert database.connected is False, "database leaked despite remover error"
|
||||||
assert entry.runtime_data is None
|
assert entry.runtime_data is None
|
||||||
assert DOMAIN not in hass.data
|
assert DOMAIN not in hass.data
|
||||||
|
|
||||||
|
|
||||||
|
async def test_setup_applies_all_v1_tables(hass, make_entry) -> None:
|
||||||
|
"""Setup applies the full v1 DDL: all four v1 tables exist afterwards."""
|
||||||
|
entry = _wire(make_entry(), hass.registry)
|
||||||
|
assert await async_setup_entry(hass, entry) is True
|
||||||
|
database = entry.runtime_data.database
|
||||||
|
rows = await database.fetch_all(
|
||||||
|
"SELECT name FROM sqlite_master WHERE type = 'table' "
|
||||||
|
"AND name IN ('children', 'admin_users', 'schedule_rules', "
|
||||||
|
"'task_definitions') ORDER BY name"
|
||||||
|
)
|
||||||
|
assert [row[0] for row in rows] == [
|
||||||
|
"admin_users",
|
||||||
|
"children",
|
||||||
|
"schedule_rules",
|
||||||
|
"task_definitions",
|
||||||
|
]
|
||||||
|
await async_unload_entry(hass, entry)
|
||||||
@@ -0,0 +1,677 @@
|
|||||||
|
"""Tests for migrations.py: the versioned schema migration runner."""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import hashlib
|
||||||
|
import logging
|
||||||
|
import sqlite3
|
||||||
|
from unittest.mock import AsyncMock
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from custom_components.nestquest.db import NestQuestDatabase
|
||||||
|
from custom_components.nestquest.migrations import (
|
||||||
|
MIGRATIONS,
|
||||||
|
VERSION_TABLE,
|
||||||
|
VERSION_TABLE_DDL,
|
||||||
|
apply_migrations,
|
||||||
|
read_schema_version,
|
||||||
|
)
|
||||||
|
from custom_components.nestquest.schema import SCHEMA_V1_STATEMENTS
|
||||||
|
|
||||||
|
|
||||||
|
def _run(coro):
|
||||||
|
return asyncio.new_event_loop().run_until_complete(coro)
|
||||||
|
|
||||||
|
|
||||||
|
def _make_hass_mock():
|
||||||
|
from unittest.mock import AsyncMock, MagicMock
|
||||||
|
|
||||||
|
hass = MagicMock()
|
||||||
|
hass.async_add_executor_job = AsyncMock(side_effect=(lambda fn, *a: fn(*a)))
|
||||||
|
return hass
|
||||||
|
|
||||||
|
|
||||||
|
def _open_db(path) -> NestQuestDatabase:
|
||||||
|
database = NestQuestDatabase(_make_hass_mock())
|
||||||
|
_run(database.open(path))
|
||||||
|
return database
|
||||||
|
|
||||||
|
|
||||||
|
def _migrate(database, migrations=MIGRATIONS):
|
||||||
|
return _run(apply_migrations(database, migrations))
|
||||||
|
|
||||||
|
|
||||||
|
def _version(database) -> int:
|
||||||
|
return _run(read_schema_version(database))
|
||||||
|
|
||||||
|
|
||||||
|
def _tables(database) -> set[str]:
|
||||||
|
rows = _run(
|
||||||
|
database.fetch_all(
|
||||||
|
"SELECT name FROM sqlite_master WHERE type = 'table' "
|
||||||
|
"AND name NOT LIKE 'sqlite_%'"
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return {row[0] for row in rows}
|
||||||
|
|
||||||
|
|
||||||
|
def _counts(database) -> dict[str, int]:
|
||||||
|
"""Row counts for every v1 data table plus the version table."""
|
||||||
|
tables = (
|
||||||
|
"children",
|
||||||
|
"admin_users",
|
||||||
|
"schedule_rules",
|
||||||
|
"task_definitions",
|
||||||
|
"presence_schedules",
|
||||||
|
"presence_overrides",
|
||||||
|
"task_instances",
|
||||||
|
"completion_events",
|
||||||
|
)
|
||||||
|
counts = {}
|
||||||
|
for table in tables:
|
||||||
|
row = _run(database.fetch_one(f"SELECT COUNT(*) FROM {table}"))
|
||||||
|
counts[table] = row[0]
|
||||||
|
return counts
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Fresh file: version 0 -> version 1
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_fresh_file_migrates_to_version_1(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "fresh.db")
|
||||||
|
try:
|
||||||
|
final = _migrate(database)
|
||||||
|
assert final == 1
|
||||||
|
assert _version(database) == 1
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_fresh_file_migration_creates_all_v1_tables(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "fresh-tables.db")
|
||||||
|
try:
|
||||||
|
_migrate(database)
|
||||||
|
expected = {
|
||||||
|
"children",
|
||||||
|
"admin_users",
|
||||||
|
"schedule_rules",
|
||||||
|
"task_definitions",
|
||||||
|
"presence_schedules",
|
||||||
|
"presence_overrides",
|
||||||
|
"task_instances",
|
||||||
|
"completion_events",
|
||||||
|
VERSION_TABLE,
|
||||||
|
}
|
||||||
|
assert _tables(database) == expected
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_missing_version_table_raises_on_direct_read(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "no-table.db")
|
||||||
|
try:
|
||||||
|
with pytest.raises(sqlite3.OperationalError, match="no such table"):
|
||||||
|
_run(read_schema_version(database))
|
||||||
|
row = _run(
|
||||||
|
database.fetch_one(
|
||||||
|
"SELECT name FROM sqlite_master WHERE type = 'table' "
|
||||||
|
f"AND name = '{VERSION_TABLE}'"
|
||||||
|
)
|
||||||
|
)
|
||||||
|
assert row is None, "read_schema_version must not create the table"
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_empty_version_table_reads_as_version_0(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "empty-table.db")
|
||||||
|
try:
|
||||||
|
_run(database.execute(VERSION_TABLE_DDL))
|
||||||
|
assert _version(database) == 0
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_migration_1_is_the_full_v1_ddl() -> None:
|
||||||
|
assert MIGRATIONS[0] == SCHEMA_V1_STATEMENTS
|
||||||
|
assert len(MIGRATIONS) == 1
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Idempotence: second start is a no-op
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_second_run_applies_nothing_and_keeps_rows(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "idempotent.db")
|
||||||
|
try:
|
||||||
|
_migrate(database)
|
||||||
|
_run(
|
||||||
|
database.execute(
|
||||||
|
"INSERT INTO children (display_name, created_at) VALUES (?, ?)",
|
||||||
|
("Ada", "2026-09-13T00:00:00+00:00"),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
_run(
|
||||||
|
database.execute(
|
||||||
|
"INSERT INTO admin_users (ha_user_id, added_at) VALUES (?, ?)",
|
||||||
|
("user-1", "2026-09-13T00:00:00+00:00"),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
final = _migrate(database)
|
||||||
|
assert final == 1
|
||||||
|
assert _version(database) == 1
|
||||||
|
assert _counts(database)["children"] == 1
|
||||||
|
assert _counts(database)["admin_users"] == 1
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_second_run_writes_nothing_to_the_file(tmp_path, caplog) -> None:
|
||||||
|
database = _open_db(tmp_path / "noop.db")
|
||||||
|
try:
|
||||||
|
_migrate(database)
|
||||||
|
_run(database.execute("PRAGMA wal_checkpoint(TRUNCATE)"))
|
||||||
|
db_file = tmp_path / "noop.db"
|
||||||
|
wal_file = tmp_path / "noop.db-wal"
|
||||||
|
digest_before = hashlib.sha256(db_file.read_bytes()).hexdigest()
|
||||||
|
mtime_before = db_file.stat().st_mtime_ns
|
||||||
|
wal_digest_before = (
|
||||||
|
hashlib.sha256(wal_file.read_bytes()).hexdigest()
|
||||||
|
if wal_file.exists()
|
||||||
|
else None
|
||||||
|
)
|
||||||
|
|
||||||
|
_migrate(database)
|
||||||
|
|
||||||
|
# A no-op run must not open a write transaction: the main
|
||||||
|
# database file is byte-identical (content hash, not just size)
|
||||||
|
# and untouched (mtime too), and the WAL gained no frames.
|
||||||
|
assert db_file.stat().st_mtime_ns == mtime_before
|
||||||
|
assert (
|
||||||
|
hashlib.sha256(db_file.read_bytes()).hexdigest() == digest_before
|
||||||
|
)
|
||||||
|
if wal_digest_before is None:
|
||||||
|
assert not wal_file.exists()
|
||||||
|
else:
|
||||||
|
assert (
|
||||||
|
hashlib.sha256(wal_file.read_bytes()).hexdigest()
|
||||||
|
== wal_digest_before
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_noop_run_logs_no_migration(caplog, tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "noop-log.db")
|
||||||
|
try:
|
||||||
|
_migrate(database)
|
||||||
|
caplog.clear()
|
||||||
|
with caplog.at_level(logging.INFO, logger="custom_components.nestquest.migrations"):
|
||||||
|
_migrate(database)
|
||||||
|
migrated = [
|
||||||
|
r for r in caplog.records if "migrated" in r.getMessage().lower()
|
||||||
|
]
|
||||||
|
assert migrated == []
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_noop_run_is_logged_at_debug_level(caplog, tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "noop-debug.db")
|
||||||
|
try:
|
||||||
|
_migrate(database)
|
||||||
|
caplog.clear()
|
||||||
|
with caplog.at_level(logging.DEBUG, logger="custom_components.nestquest.migrations"):
|
||||||
|
_migrate(database)
|
||||||
|
assert any(
|
||||||
|
"already at version 1" in r.getMessage()
|
||||||
|
for r in caplog.records
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Failure atomicity: a failing migration leaves the prior version intact
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def _failing_migrations(prior_statements: list[str]) -> list[list[str]]:
|
||||||
|
"""Two-migration list where migration 2 fails mid-application."""
|
||||||
|
return [
|
||||||
|
prior_statements,
|
||||||
|
[
|
||||||
|
"CREATE TABLE IF NOT EXISTS later_table (id INTEGER PRIMARY KEY)",
|
||||||
|
"CREATE TABLE broken (",
|
||||||
|
],
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def test_failing_migration_rolls_back_to_prior_version(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "rollback.db")
|
||||||
|
try:
|
||||||
|
# Manually simulate a database at version 1: apply migration 1's
|
||||||
|
# statements directly and stamp version 1 through the runner.
|
||||||
|
_migrate(database)
|
||||||
|
version_row = _run(
|
||||||
|
database.fetch_one(f"SELECT version FROM {VERSION_TABLE}")
|
||||||
|
)
|
||||||
|
assert version_row == (1,)
|
||||||
|
|
||||||
|
with pytest.raises(sqlite3.OperationalError):
|
||||||
|
_migrate(database, _failing_migrations(SCHEMA_V1_STATEMENTS))
|
||||||
|
|
||||||
|
# Version stamp unchanged, statements from the failed migration
|
||||||
|
# absent, and the v1 tables untouched.
|
||||||
|
assert _version(database) == 1
|
||||||
|
assert "later_table" not in _tables(database)
|
||||||
|
assert _counts(database)["children"] == 0
|
||||||
|
assert _counts(database)["completion_events"] == 0
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_failing_migration_on_fresh_file_leaves_version_0(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "fresh-rollback.db")
|
||||||
|
try:
|
||||||
|
# The fresh file still reaches migration 2 (the failing one):
|
||||||
|
# migration 1 commits, stamping version 1, before migration 2
|
||||||
|
# fails and rolls back. The run aborts at version 1 — the last
|
||||||
|
# fully-applied migration — not at version 0.
|
||||||
|
with pytest.raises(sqlite3.OperationalError):
|
||||||
|
_migrate(database, _failing_migrations(SCHEMA_V1_STATEMENTS))
|
||||||
|
assert _version(database) == 1
|
||||||
|
# Migration 2's tables must not survive the failed attempt.
|
||||||
|
assert "later_table" not in _tables(database)
|
||||||
|
# Migration 1's tables do: it committed before the failure.
|
||||||
|
assert "children" in _tables(database)
|
||||||
|
assert "task_instances" in _tables(database)
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_failed_migration_can_be_retried_after_fix(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "retry.db")
|
||||||
|
try:
|
||||||
|
_migrate(database)
|
||||||
|
broken = _failing_migrations(SCHEMA_V1_STATEMENTS)
|
||||||
|
with pytest.raises(sqlite3.OperationalError):
|
||||||
|
_migrate(database, broken)
|
||||||
|
# "Fix" the migration and retry: it now applies cleanly.
|
||||||
|
broken[1] = [
|
||||||
|
"CREATE TABLE IF NOT EXISTS later_table (id INTEGER PRIMARY KEY)"
|
||||||
|
]
|
||||||
|
final = _migrate(database, broken)
|
||||||
|
assert final == 2
|
||||||
|
assert _version(database) == 2
|
||||||
|
assert "later_table" in _tables(database)
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_failing_migration_error_is_preserved(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "error-preserved.db")
|
||||||
|
try:
|
||||||
|
with pytest.raises(sqlite3.OperationalError, match="incomplete input"):
|
||||||
|
_migrate(database, _failing_migrations(SCHEMA_V1_STATEMENTS))
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Version guard rails
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_future_version_is_rejected(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "future.db")
|
||||||
|
try:
|
||||||
|
_migrate(database)
|
||||||
|
_run(
|
||||||
|
database.execute(
|
||||||
|
f"UPDATE {VERSION_TABLE} SET version = ?", (99,)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
with pytest.raises(RuntimeError, match="newer than"):
|
||||||
|
_migrate(database)
|
||||||
|
# Nothing was modified by the rejected run.
|
||||||
|
assert _version(database) == 99
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_non_integer_version_raises_runtime_error(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "string-version.db")
|
||||||
|
try:
|
||||||
|
_run(database.execute(VERSION_TABLE_DDL))
|
||||||
|
# The CHECK enforces version >= 1 but SQLite's loose typing
|
||||||
|
# stores TEXT under an INTEGER-affinity column when it cannot
|
||||||
|
# be losslessly coerced; guard the read path against it.
|
||||||
|
_run(
|
||||||
|
database.execute(
|
||||||
|
f"INSERT INTO {VERSION_TABLE} (id, version) VALUES (1, ?)",
|
||||||
|
("one",),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
with pytest.raises(RuntimeError, match="not an integer"):
|
||||||
|
_run(read_schema_version(database))
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_negative_version_read_guard_rejects_below_one() -> None:
|
||||||
|
"""The read path rejects sub-1 versions even if storage missed them.
|
||||||
|
|
||||||
|
The VERSION_TABLE CHECK already makes negative/zero unstorable; this
|
||||||
|
exercises the defense-in-depth guard in read_schema_version itself
|
||||||
|
against a database stub returning such a row (e.g. a future schema
|
||||||
|
relaxing the CHECK, or a hand-edited file).
|
||||||
|
"""
|
||||||
|
from unittest.mock import AsyncMock, MagicMock
|
||||||
|
|
||||||
|
for bad in (-1, 0):
|
||||||
|
database = MagicMock()
|
||||||
|
database.fetch_one = AsyncMock(return_value=(bad,))
|
||||||
|
with pytest.raises(RuntimeError, match="must be >= 1"):
|
||||||
|
_run(read_schema_version(database))
|
||||||
|
|
||||||
|
|
||||||
|
def test_non_integer_version_read_guard_rejects_text() -> None:
|
||||||
|
from unittest.mock import AsyncMock, MagicMock
|
||||||
|
|
||||||
|
for bad in ("one", 1.5, True):
|
||||||
|
database = MagicMock()
|
||||||
|
database.fetch_one = AsyncMock(return_value=(bad,))
|
||||||
|
with pytest.raises(RuntimeError, match="not an integer"):
|
||||||
|
_run(read_schema_version(database))
|
||||||
|
|
||||||
|
|
||||||
|
def test_zero_version_row_is_unstorable(tmp_path) -> None:
|
||||||
|
"""The CHECK makes sub-1 versions impossible through SQL.
|
||||||
|
|
||||||
|
PRAGMA writable_schema does not bypass CHECKs on ordinary tables,
|
||||||
|
so the negative/zero read guard above is pure defense-in-depth;
|
||||||
|
here we prove the storage-level rule the normal path relies on.
|
||||||
|
"""
|
||||||
|
database = _open_db(tmp_path / "zero-version.db")
|
||||||
|
try:
|
||||||
|
_run(database.execute(VERSION_TABLE_DDL))
|
||||||
|
for bad in (0, -1):
|
||||||
|
with pytest.raises(sqlite3.IntegrityError, match="CHECK"):
|
||||||
|
_run(
|
||||||
|
database.execute(
|
||||||
|
f"INSERT INTO {VERSION_TABLE} (id, version) "
|
||||||
|
"VALUES (1, ?)",
|
||||||
|
(bad,),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_version_table_enforces_singleton_row(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "singleton.db")
|
||||||
|
try:
|
||||||
|
_run(database.execute(VERSION_TABLE_DDL))
|
||||||
|
_run(
|
||||||
|
database.execute(
|
||||||
|
f"INSERT INTO {VERSION_TABLE} (id, version) VALUES (1, 1)"
|
||||||
|
)
|
||||||
|
)
|
||||||
|
with pytest.raises(sqlite3.IntegrityError, match="CHECK"):
|
||||||
|
_run(
|
||||||
|
database.execute(
|
||||||
|
f"INSERT INTO {VERSION_TABLE} (id, version) "
|
||||||
|
"VALUES (2, 1)"
|
||||||
|
)
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_version_table_check_rejects_version_zero_and_negative(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
database = _open_db(tmp_path / "version-check.db")
|
||||||
|
try:
|
||||||
|
_run(database.execute(VERSION_TABLE_DDL))
|
||||||
|
for bad in (0, -1):
|
||||||
|
with pytest.raises(sqlite3.IntegrityError, match="CHECK"):
|
||||||
|
_run(
|
||||||
|
database.execute(
|
||||||
|
f"INSERT INTO {VERSION_TABLE} (id, version) "
|
||||||
|
"VALUES (1, ?)",
|
||||||
|
(bad,),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_concurrent_runners_serialize_and_apply_once(tmp_path) -> None:
|
||||||
|
"""Two concurrent runners on one connection apply each step once.
|
||||||
|
|
||||||
|
Deterministic race: runner B starts while runner A is queued into
|
||||||
|
its migration. A applies everything and stamps; B then acquires
|
||||||
|
the migration lock, re-reads the already-stamped version, and
|
||||||
|
applies nothing. Without serialization B's transaction() would
|
||||||
|
raise RuntimeError (the wrapper forbids concurrent transactions),
|
||||||
|
so this also proves the queueing works.
|
||||||
|
"""
|
||||||
|
migrations = [
|
||||||
|
["CREATE TABLE IF NOT EXISTS step_a (id INTEGER PRIMARY KEY)"],
|
||||||
|
["CREATE TABLE IF NOT EXISTS step_b (id INTEGER PRIMARY KEY)"],
|
||||||
|
]
|
||||||
|
results: dict[str, int] = {}
|
||||||
|
|
||||||
|
async def _main(tmp_name: str) -> None:
|
||||||
|
database = NestQuestDatabase(_make_hass_mock())
|
||||||
|
await database.open(tmp_name)
|
||||||
|
try:
|
||||||
|
# Start A, yield so it acquires the lock and enters its
|
||||||
|
# first transaction, then start B while A is mid-apply.
|
||||||
|
task_a = asyncio.ensure_future(
|
||||||
|
apply_migrations(database, migrations)
|
||||||
|
)
|
||||||
|
await asyncio.sleep(0)
|
||||||
|
task_b = asyncio.ensure_future(
|
||||||
|
apply_migrations(database, migrations)
|
||||||
|
)
|
||||||
|
results["a"], results["b"] = await asyncio.gather(
|
||||||
|
task_a, task_b
|
||||||
|
)
|
||||||
|
|
||||||
|
tables = {
|
||||||
|
row[0]
|
||||||
|
for row in await database.fetch_all(
|
||||||
|
"SELECT name FROM sqlite_master WHERE type = 'table' "
|
||||||
|
"AND name NOT LIKE 'sqlite_%'"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
assert {"step_a", "step_b"} <= tables
|
||||||
|
# Each migration's statements ran exactly once: the CREATE
|
||||||
|
# IF NOT EXISTS would hide double-runs, so count via sqlite
|
||||||
|
# sequence/DDL fingerprint instead — re-check version and
|
||||||
|
# that both runners reported the same final version.
|
||||||
|
row = await database.fetch_one(
|
||||||
|
f"SELECT version FROM {VERSION_TABLE}"
|
||||||
|
)
|
||||||
|
assert row == (2,)
|
||||||
|
finally:
|
||||||
|
await database.close()
|
||||||
|
|
||||||
|
loop = asyncio.new_event_loop()
|
||||||
|
try:
|
||||||
|
loop.run_until_complete(_main(str(tmp_path / "concurrent.db")))
|
||||||
|
finally:
|
||||||
|
loop.close()
|
||||||
|
|
||||||
|
assert results["a"] == 2
|
||||||
|
assert results["b"] == 2
|
||||||
|
|
||||||
|
|
||||||
|
def test_multiple_pending_migrations_apply_in_order(tmp_path) -> None:
|
||||||
|
database = _open_db(tmp_path / "multi-step.db")
|
||||||
|
try:
|
||||||
|
migrations = [
|
||||||
|
["CREATE TABLE IF NOT EXISTS step_a (id INTEGER PRIMARY KEY)"],
|
||||||
|
["CREATE TABLE IF NOT EXISTS step_b (id INTEGER PRIMARY KEY)"],
|
||||||
|
["CREATE TABLE IF NOT EXISTS step_c (id INTEGER PRIMARY KEY)"],
|
||||||
|
]
|
||||||
|
final = _run(apply_migrations(database, migrations))
|
||||||
|
assert final == 3
|
||||||
|
assert _version(database) == 3
|
||||||
|
assert {"step_a", "step_b", "step_c"} <= _tables(database)
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
def test_partial_pending_migrations_resume_from_current_version(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
database = _open_db(tmp_path / "resume.db")
|
||||||
|
try:
|
||||||
|
migrations = [
|
||||||
|
["CREATE TABLE IF NOT EXISTS step_a (id INTEGER PRIMARY KEY)"],
|
||||||
|
["CREATE TABLE IF NOT EXISTS step_b (id INTEGER PRIMARY KEY)"],
|
||||||
|
]
|
||||||
|
# Advance to version 1 only, by applying a truncated list of the
|
||||||
|
# same migrations: patch apply_migrations' latest by passing a
|
||||||
|
# single-migration list first, then the full list.
|
||||||
|
_run(apply_migrations(database, migrations[:1]))
|
||||||
|
assert _version(database) == 1
|
||||||
|
final = _run(apply_migrations(database, migrations))
|
||||||
|
assert final == 2
|
||||||
|
assert _version(database) == 2
|
||||||
|
assert "step_b" in _tables(database)
|
||||||
|
finally:
|
||||||
|
_run(database.close())
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Startup wiring: setup runs the migration runner, not raw DDL
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
async def _setup_entry(hass, entry, registry) -> object:
|
||||||
|
from tests.test_lifecycle import _wire # reuse the established wiring
|
||||||
|
|
||||||
|
entry = _wire(entry, registry)
|
||||||
|
from custom_components.nestquest import async_setup_entry
|
||||||
|
|
||||||
|
await async_setup_entry(hass, entry)
|
||||||
|
return entry
|
||||||
|
|
||||||
|
|
||||||
|
async def test_setup_entry_migrates_fresh_database(hass, make_entry) -> None:
|
||||||
|
import sqlite3 as sqlite3_mod
|
||||||
|
|
||||||
|
from custom_components.nestquest.migrations import read_schema_version
|
||||||
|
from custom_components.nestquest.store import async_get_db_path
|
||||||
|
|
||||||
|
entry = await _setup_entry(hass, make_entry(), hass.registry)
|
||||||
|
database = entry.runtime_data.database
|
||||||
|
assert await read_schema_version(database) == 1
|
||||||
|
# The v1 tables exist because the runner applied migration 1.
|
||||||
|
names = {
|
||||||
|
row[0]
|
||||||
|
for row in await database.fetch_all(
|
||||||
|
"SELECT name FROM sqlite_master WHERE type = 'table' "
|
||||||
|
"AND name NOT LIKE 'sqlite_%'"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
assert "children" in names and "completion_events" in names
|
||||||
|
# The version table exists with its singleton row stamped.
|
||||||
|
columns = await database.fetch_all(f"PRAGMA table_info({VERSION_TABLE})")
|
||||||
|
assert [(row[1], row[3]) for row in columns] == [("id", 1), ("version", 1)]
|
||||||
|
db_path = await async_get_db_path(hass)
|
||||||
|
conn = sqlite3_mod.connect(db_path)
|
||||||
|
try:
|
||||||
|
conn.execute(f"INSERT INTO {VERSION_TABLE} (id, version) VALUES (2, 1)")
|
||||||
|
violated = False
|
||||||
|
except sqlite3_mod.IntegrityError:
|
||||||
|
violated = True
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
assert violated, "singleton-row CHECK must be live in the setup-created DB"
|
||||||
|
await database.close()
|
||||||
|
|
||||||
|
|
||||||
|
async def test_options_reload_reopens_and_rechecks_version(
|
||||||
|
hass, make_entry
|
||||||
|
) -> None:
|
||||||
|
"""A listener-triggered reload re-runs setup against the same file.
|
||||||
|
|
||||||
|
Unload then setup is the reload lifecycle: the old connection is
|
||||||
|
closed, apply_migrations runs again on the persisted file, keeps
|
||||||
|
version and rows intact, and the reopened connection is live.
|
||||||
|
"""
|
||||||
|
from custom_components.nestquest import async_unload_entry
|
||||||
|
from custom_components.nestquest.migrations import read_schema_version
|
||||||
|
|
||||||
|
entry = await _setup_entry(hass, make_entry(), hass.registry)
|
||||||
|
database_a = entry.runtime_data.database
|
||||||
|
await database_a.execute(
|
||||||
|
"INSERT INTO children (display_name, created_at) VALUES (?, ?)",
|
||||||
|
("Ada", "2026-09-13T00:00:00+00:00"),
|
||||||
|
)
|
||||||
|
assert await async_unload_entry(hass, entry) is True
|
||||||
|
assert not database_a.connected
|
||||||
|
|
||||||
|
entry_reloaded = await _setup_entry(hass, make_entry(), hass.registry)
|
||||||
|
database_b = entry_reloaded.runtime_data.database
|
||||||
|
assert database_b is not database_a
|
||||||
|
try:
|
||||||
|
assert await read_schema_version(database_b) == 1
|
||||||
|
row = await database_b.fetch_one("SELECT COUNT(*) FROM children")
|
||||||
|
assert row == (1,)
|
||||||
|
finally:
|
||||||
|
await database_b.close()
|
||||||
|
|
||||||
|
|
||||||
|
async def test_setup_entry_failure_closes_database(
|
||||||
|
hass, make_entry, monkeypatch
|
||||||
|
) -> None:
|
||||||
|
"""A failing migration closes the opened connection before re-raising.
|
||||||
|
|
||||||
|
Spies on the real wrapper instance: records whether close() ran and
|
||||||
|
whether the connection is left disconnected, rather than inferring
|
||||||
|
from hass.data (a failed setup never stores a runtime record).
|
||||||
|
"""
|
||||||
|
import pytest as pytest_module
|
||||||
|
|
||||||
|
import custom_components.nestquest as nestquest_module
|
||||||
|
from custom_components.nestquest.db import NestQuestDatabase
|
||||||
|
from custom_components.nestquest.migrations import (
|
||||||
|
MIGRATIONS as _MIGRATIONS,
|
||||||
|
)
|
||||||
|
|
||||||
|
async def _failing(database, migrations=_MIGRATIONS):
|
||||||
|
raise RuntimeError("boom")
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
nestquest_module, "apply_migrations", _failing, raising=True
|
||||||
|
)
|
||||||
|
|
||||||
|
close_calls: list[bool] = []
|
||||||
|
original_close = NestQuestDatabase.close
|
||||||
|
|
||||||
|
async def _spy_close(self):
|
||||||
|
close_calls.append(True)
|
||||||
|
return await original_close(self)
|
||||||
|
|
||||||
|
monkeypatch.setattr(NestQuestDatabase, "close", _spy_close)
|
||||||
|
|
||||||
|
entry = make_entry()
|
||||||
|
with pytest_module.raises(RuntimeError, match="boom"):
|
||||||
|
await _setup_entry(hass, entry, hass.registry)
|
||||||
|
|
||||||
|
assert close_calls == [True], (
|
||||||
|
"failed setup must close the connection it opened"
|
||||||
|
)
|
||||||
|
record = hass.data["nestquest"].get(entry.entry_id)
|
||||||
|
assert record is None, "failed setup must not store runtime data"
|
||||||
+1752
-1
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user