Compare commits
3
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
caea163e17 | ||
|
|
3a7ab12ab2 | ||
|
|
46a0a3445c |
@@ -0,0 +1,465 @@
|
|||||||
|
"""Typed DAO layer for the schedule_rules and task_definitions tables.
|
||||||
|
|
||||||
|
All SQL for ``schedule_rules`` and ``task_definitions`` lives in this
|
||||||
|
module per the feature guardrails: callers get typed dataclasses back
|
||||||
|
and never see raw rows or SQL. Every method is async and runs through
|
||||||
|
:class:`~.db.NestQuestDatabase`, so each statement executes on the HA
|
||||||
|
executor and the event loop never blocks.
|
||||||
|
|
||||||
|
Guardrail mapping:
|
||||||
|
|
||||||
|
- ``schedule_rules`` deletion is delete-if-unreferenced: a rule still
|
||||||
|
referenced by any task definition is rejected (the done-condition),
|
||||||
|
not cascaded.
|
||||||
|
- ``task_definitions`` has no delete path at all: definitions are
|
||||||
|
deactivated, never hard-deleted, and history must survive.
|
||||||
|
- ``set_assignee`` changes future instances only — the DAO writes the
|
||||||
|
definition row and nothing else; reassignment never rewrites
|
||||||
|
existing instances or completion history (Feature 06 guardrail).
|
||||||
|
- Validation of rule well-formedness and child activeness lives partly
|
||||||
|
in the schema CHECKs (rule-type coherence) and partly in
|
||||||
|
:meth:`TaskDefinitionsDao.create` (active child, rule existence);
|
||||||
|
no permission checks here, that is the Feature 09 gate's job.
|
||||||
|
|
||||||
|
Concurrency: ``delete_rule_if_unreferenced`` performs its reference
|
||||||
|
check and DELETE inside one transaction under the connection-scoped
|
||||||
|
lock shared with :mod:`.dao_children`, so a definition referencing the
|
||||||
|
rule cannot appear between check and delete on this connection.
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import datetime
|
||||||
|
from dataclasses import dataclass
|
||||||
|
|
||||||
|
from .dao_children import _connection_lock
|
||||||
|
from .db import NestQuestDatabase
|
||||||
|
|
||||||
|
#: Sentinel distinguishing "argument omitted" from "explicit SQL NULL"
|
||||||
|
#: in update methods: passing ``None`` must mean clearing a nullable
|
||||||
|
#: column, not skipping it.
|
||||||
|
_UNSET = object()
|
||||||
|
|
||||||
|
#: Date-shape policy: schedule-rule dates are ISO YYYY-MM-DD. The
|
||||||
|
#: schema's lexical end>=start CHECK cannot prove a value is a real
|
||||||
|
#: calendar date, so the DAO validates the shape it accepts.
|
||||||
|
_DATE_FORMAT = "%Y-%m-%d"
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_date(value: str, field: str) -> None:
|
||||||
|
"""Raise ValueError unless ``value`` is a YYYY-MM-DD calendar date.
|
||||||
|
|
||||||
|
``datetime.date.fromisoformat`` accepts ISO dates but is lenient on
|
||||||
|
some builds (e.g. '2026-9-4'); strptime with an exact format is
|
||||||
|
strict, and strptime round-trips the parsed value to reject zero
|
||||||
|
padding ('2026-9-4' parses but its isoformat differs).
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
parsed = datetime.datetime.strptime(value, _DATE_FORMAT).date()
|
||||||
|
except (TypeError, ValueError):
|
||||||
|
raise ValueError(
|
||||||
|
f"{field} must be an ISO date (YYYY-MM-DD), got {value!r}"
|
||||||
|
) from None
|
||||||
|
if parsed.isoformat() != value:
|
||||||
|
raise ValueError(
|
||||||
|
f"{field} must be a strict YYYY-MM-DD date, got {value!r}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class ScheduleRuleRecord:
|
||||||
|
"""One row of ``schedule_rules``."""
|
||||||
|
|
||||||
|
id: int
|
||||||
|
rule_type: str
|
||||||
|
interval: int
|
||||||
|
weekday_set: str | None
|
||||||
|
day_of_month: int | None
|
||||||
|
nth_weekday: int | None
|
||||||
|
month: int | None
|
||||||
|
start_date: str
|
||||||
|
end_date: str | None
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class TaskDefinitionRecord:
|
||||||
|
"""One row of ``task_definitions``."""
|
||||||
|
|
||||||
|
id: int
|
||||||
|
title: str
|
||||||
|
description: str | None
|
||||||
|
icon: str | None
|
||||||
|
child_id: int
|
||||||
|
schedule_rule_id: int
|
||||||
|
due_time: str | None
|
||||||
|
is_active: bool
|
||||||
|
created_at: str
|
||||||
|
|
||||||
|
|
||||||
|
_RULE_COLUMNS = (
|
||||||
|
"id, rule_type, interval, weekday_set, day_of_month, nth_weekday, "
|
||||||
|
"month, start_date, end_date"
|
||||||
|
)
|
||||||
|
_DEFINITION_COLUMNS = (
|
||||||
|
"id, title, description, icon, child_id, schedule_rule_id, due_time, "
|
||||||
|
"is_active, created_at"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _rule_from_row(row: tuple) -> ScheduleRuleRecord:
|
||||||
|
return ScheduleRuleRecord(
|
||||||
|
id=row[0],
|
||||||
|
rule_type=row[1],
|
||||||
|
interval=row[2],
|
||||||
|
weekday_set=row[3],
|
||||||
|
day_of_month=row[4],
|
||||||
|
nth_weekday=row[5],
|
||||||
|
month=row[6],
|
||||||
|
start_date=row[7],
|
||||||
|
end_date=row[8],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _definition_from_row(row: tuple) -> TaskDefinitionRecord:
|
||||||
|
return TaskDefinitionRecord(
|
||||||
|
id=row[0],
|
||||||
|
title=row[1],
|
||||||
|
description=row[2],
|
||||||
|
icon=row[3],
|
||||||
|
child_id=row[4],
|
||||||
|
schedule_rule_id=row[5],
|
||||||
|
due_time=row[6],
|
||||||
|
is_active=bool(row[7]),
|
||||||
|
created_at=row[8],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class ScheduleRulesDao:
|
||||||
|
"""Typed async access to the ``schedule_rules`` table."""
|
||||||
|
|
||||||
|
def __init__(self, database: NestQuestDatabase) -> None:
|
||||||
|
self._database = database
|
||||||
|
|
||||||
|
async def create(
|
||||||
|
self,
|
||||||
|
rule_type: str,
|
||||||
|
start_date: str,
|
||||||
|
*,
|
||||||
|
interval: int = 1,
|
||||||
|
weekday_set: str | None = None,
|
||||||
|
day_of_month: int | None = None,
|
||||||
|
nth_weekday: int | None = None,
|
||||||
|
month: int | None = None,
|
||||||
|
end_date: str | None = None,
|
||||||
|
) -> ScheduleRuleRecord:
|
||||||
|
"""Insert one rule and return the record as stored.
|
||||||
|
|
||||||
|
Rule-type coherence (a weekly rule needs ``weekday_set``, a
|
||||||
|
yearly rule needs ``month``, etc.) is enforced by the schema
|
||||||
|
CHECKs and surfaces as :class:`sqlite3.IntegrityError`. Date
|
||||||
|
shape (strict YYYY-MM-DD) is validated here because the
|
||||||
|
schema's lexical end>=start CHECK cannot prove a real calendar
|
||||||
|
date.
|
||||||
|
"""
|
||||||
|
_validate_date(start_date, "start_date")
|
||||||
|
if end_date is not None:
|
||||||
|
_validate_date(end_date, "end_date")
|
||||||
|
result = await self._database.execute(
|
||||||
|
"INSERT INTO schedule_rules (rule_type, interval, weekday_set, "
|
||||||
|
"day_of_month, nth_weekday, month, start_date, end_date) "
|
||||||
|
"VALUES (?, ?, ?, ?, ?, ?, ?, ?)",
|
||||||
|
(
|
||||||
|
rule_type,
|
||||||
|
interval,
|
||||||
|
weekday_set,
|
||||||
|
day_of_month,
|
||||||
|
nth_weekday,
|
||||||
|
month,
|
||||||
|
start_date,
|
||||||
|
end_date,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
rule = await self.get(result.lastrowid)
|
||||||
|
assert rule is not None
|
||||||
|
return rule
|
||||||
|
|
||||||
|
async def get(self, rule_id: int) -> ScheduleRuleRecord | None:
|
||||||
|
"""Return the rule with ``rule_id``, or None."""
|
||||||
|
row = await self._database.fetch_one(
|
||||||
|
f"SELECT {_RULE_COLUMNS} FROM schedule_rules WHERE id = ?",
|
||||||
|
(rule_id,),
|
||||||
|
)
|
||||||
|
return _rule_from_row(row) if row is not None else None
|
||||||
|
|
||||||
|
async def update(
|
||||||
|
self,
|
||||||
|
rule_id: int,
|
||||||
|
*,
|
||||||
|
rule_type: str | None | object = _UNSET,
|
||||||
|
interval: int | None | object = _UNSET,
|
||||||
|
weekday_set: str | None | object = _UNSET,
|
||||||
|
day_of_month: int | None | object = _UNSET,
|
||||||
|
nth_weekday: int | None | object = _UNSET,
|
||||||
|
month: int | None | object = _UNSET,
|
||||||
|
start_date: str | None | object = _UNSET,
|
||||||
|
end_date: str | None | object = _UNSET,
|
||||||
|
) -> int:
|
||||||
|
"""Update the given fields; returns rows updated (0 if absent).
|
||||||
|
|
||||||
|
Arguments default to the module sentinel ``_UNSET`` meaning
|
||||||
|
"leave this column alone"; passing ``None`` explicitly writes
|
||||||
|
SQL NULL, so callers can reopen an ended rule (``end_date``
|
||||||
|
back to NULL) or clear nullable shape fields. Passing
|
||||||
|
``None``/a new value for a date field validates its shape.
|
||||||
|
Editing a rule that a definition references changes future
|
||||||
|
materializations only — this method touches no instances
|
||||||
|
(Feature 06/07 separation).
|
||||||
|
"""
|
||||||
|
date_args = (
|
||||||
|
("start_date", start_date),
|
||||||
|
("end_date", end_date),
|
||||||
|
)
|
||||||
|
for field, value in date_args:
|
||||||
|
if value is not _UNSET and value is not None:
|
||||||
|
_validate_date(value, field)
|
||||||
|
assignments: list[str] = []
|
||||||
|
parameters: list[object] = []
|
||||||
|
for column, value in (
|
||||||
|
("rule_type", rule_type),
|
||||||
|
("interval", interval),
|
||||||
|
("weekday_set", weekday_set),
|
||||||
|
("day_of_month", day_of_month),
|
||||||
|
("nth_weekday", nth_weekday),
|
||||||
|
("month", month),
|
||||||
|
("start_date", start_date),
|
||||||
|
("end_date", end_date),
|
||||||
|
):
|
||||||
|
if value is not _UNSET:
|
||||||
|
assignments.append(f"{column} = ?")
|
||||||
|
parameters.append(value)
|
||||||
|
if not assignments:
|
||||||
|
return 0
|
||||||
|
parameters.append(rule_id)
|
||||||
|
result = await self._database.execute(
|
||||||
|
f"UPDATE schedule_rules SET {', '.join(assignments)} "
|
||||||
|
"WHERE id = ?",
|
||||||
|
tuple(parameters),
|
||||||
|
)
|
||||||
|
return result.rowcount
|
||||||
|
|
||||||
|
async def delete_if_unreferenced(self, rule_id: int) -> bool:
|
||||||
|
"""Delete the rule only if no definition references it.
|
||||||
|
|
||||||
|
Returns True if the rule was deleted, False if it is still
|
||||||
|
referenced (or does not exist — distinguish via :meth:`get`).
|
||||||
|
The reference check and the DELETE run inside one transaction
|
||||||
|
under the connection lock, so a definition cannot start
|
||||||
|
referencing the rule between the check and the delete.
|
||||||
|
"""
|
||||||
|
async with _connection_lock(self._database):
|
||||||
|
async with self._database.transaction():
|
||||||
|
row = await self._database.fetch_one(
|
||||||
|
"SELECT 1 FROM task_definitions "
|
||||||
|
"WHERE schedule_rule_id = ? LIMIT 1",
|
||||||
|
(rule_id,),
|
||||||
|
)
|
||||||
|
if row is not None:
|
||||||
|
return False
|
||||||
|
result = await self._database.execute(
|
||||||
|
"DELETE FROM schedule_rules WHERE id = ?",
|
||||||
|
(rule_id,),
|
||||||
|
)
|
||||||
|
return result.rowcount > 0
|
||||||
|
|
||||||
|
|
||||||
|
class TaskDefinitionsDao:
|
||||||
|
"""Typed async access to the ``task_definitions`` table.
|
||||||
|
|
||||||
|
No delete method exists: definitions are deactivated via
|
||||||
|
:meth:`set_active`, never hard-deleted, so completion history keeps
|
||||||
|
its references (feature guardrail).
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, database: NestQuestDatabase) -> None:
|
||||||
|
self._database = database
|
||||||
|
|
||||||
|
async def create(
|
||||||
|
self,
|
||||||
|
title: str,
|
||||||
|
child_id: int,
|
||||||
|
schedule_rule_id: int,
|
||||||
|
created_at: str,
|
||||||
|
*,
|
||||||
|
description: str | None = None,
|
||||||
|
icon: str | None = None,
|
||||||
|
due_time: str | None = None,
|
||||||
|
is_active: bool = True,
|
||||||
|
) -> TaskDefinitionRecord:
|
||||||
|
"""Insert one definition and return the record as stored.
|
||||||
|
|
||||||
|
Validates the assignment target as part of the same serialized
|
||||||
|
transaction as the insert: the child must exist and be active,
|
||||||
|
and the rule must exist, AT INSERT TIME — a child deactivated
|
||||||
|
or a rule deleted concurrently cannot slip between the checks
|
||||||
|
and the INSERT, which would otherwise create an invalid
|
||||||
|
assignment or surface as a raw FK IntegrityError instead of
|
||||||
|
the documented ValueError. An INACTIVE child would pass the
|
||||||
|
schema foreign keys, which is why the activeness check lives
|
||||||
|
here.
|
||||||
|
"""
|
||||||
|
async with _connection_lock(self._database):
|
||||||
|
async with self._database.transaction():
|
||||||
|
await self._validate_assignable(
|
||||||
|
child_id, schedule_rule_id
|
||||||
|
)
|
||||||
|
result = await self._database.execute(
|
||||||
|
"INSERT INTO task_definitions (title, description, "
|
||||||
|
"icon, child_id, schedule_rule_id, due_time, "
|
||||||
|
"is_active, created_at) "
|
||||||
|
"VALUES (?, ?, ?, ?, ?, ?, ?, ?)",
|
||||||
|
(
|
||||||
|
title,
|
||||||
|
description,
|
||||||
|
icon,
|
||||||
|
child_id,
|
||||||
|
schedule_rule_id,
|
||||||
|
due_time,
|
||||||
|
int(is_active),
|
||||||
|
created_at,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
definition = await self.get(result.lastrowid)
|
||||||
|
assert definition is not None
|
||||||
|
return definition
|
||||||
|
|
||||||
|
async def _validate_assignable(
|
||||||
|
self, child_id: int, schedule_rule_id: int
|
||||||
|
) -> None:
|
||||||
|
"""Raise ValueError unless child (active) and rule both exist.
|
||||||
|
|
||||||
|
MUST be called inside the connection lock so the verdict cannot
|
||||||
|
go stale before the caller's INSERT commits.
|
||||||
|
"""
|
||||||
|
await self._validate_assignable_child(child_id)
|
||||||
|
rule = await self._database.fetch_one(
|
||||||
|
"SELECT 1 FROM schedule_rules WHERE id = ?",
|
||||||
|
(schedule_rule_id,),
|
||||||
|
)
|
||||||
|
if rule is None:
|
||||||
|
raise ValueError(
|
||||||
|
f"schedule rule {schedule_rule_id} does not exist"
|
||||||
|
)
|
||||||
|
|
||||||
|
async def get(self, definition_id: int) -> TaskDefinitionRecord | None:
|
||||||
|
"""Return the definition with ``definition_id``, or None."""
|
||||||
|
row = await self._database.fetch_one(
|
||||||
|
f"SELECT {_DEFINITION_COLUMNS} FROM task_definitions "
|
||||||
|
"WHERE id = ?",
|
||||||
|
(definition_id,),
|
||||||
|
)
|
||||||
|
return _definition_from_row(row) if row is not None else None
|
||||||
|
|
||||||
|
async def list_by_child(self, child_id: int) -> list[TaskDefinitionRecord]:
|
||||||
|
"""Return all definitions assigned to ``child_id``, newest first."""
|
||||||
|
rows = await self._database.fetch_all(
|
||||||
|
f"SELECT {_DEFINITION_COLUMNS} FROM task_definitions "
|
||||||
|
"WHERE child_id = ? ORDER BY id DESC",
|
||||||
|
(child_id,),
|
||||||
|
)
|
||||||
|
return [_definition_from_row(row) for row in rows]
|
||||||
|
|
||||||
|
async def list_active(self) -> list[TaskDefinitionRecord]:
|
||||||
|
"""Return all active definitions, oldest first (stable order)."""
|
||||||
|
rows = await self._database.fetch_all(
|
||||||
|
f"SELECT {_DEFINITION_COLUMNS} FROM task_definitions "
|
||||||
|
"WHERE is_active = 1 ORDER BY id"
|
||||||
|
)
|
||||||
|
return [_definition_from_row(row) for row in rows]
|
||||||
|
|
||||||
|
async def update(
|
||||||
|
self,
|
||||||
|
definition_id: int,
|
||||||
|
*,
|
||||||
|
title: str | None | object = _UNSET,
|
||||||
|
description: str | None | object = _UNSET,
|
||||||
|
icon: str | None | object = _UNSET,
|
||||||
|
due_time: str | None | object = _UNSET,
|
||||||
|
) -> int:
|
||||||
|
"""Update the given fields; returns rows updated (0 if absent).
|
||||||
|
|
||||||
|
Arguments default to the module sentinel ``_UNSET`` meaning
|
||||||
|
"leave this column alone"; passing ``None`` explicitly writes
|
||||||
|
SQL NULL, so callers can remove optional metadata
|
||||||
|
(description, icon, due_time). Assignment and activation are
|
||||||
|
deliberately NOT settable here: they have their own explicit
|
||||||
|
operations (:meth:`set_assignee`, :meth:`set_active`) so they
|
||||||
|
stay separately loggable and permission-gateable.
|
||||||
|
"""
|
||||||
|
assignments: list[str] = []
|
||||||
|
parameters: list[object] = []
|
||||||
|
for column, value in (
|
||||||
|
("title", title),
|
||||||
|
("description", description),
|
||||||
|
("icon", icon),
|
||||||
|
("due_time", due_time),
|
||||||
|
):
|
||||||
|
if value is not _UNSET:
|
||||||
|
assignments.append(f"{column} = ?")
|
||||||
|
parameters.append(value)
|
||||||
|
if not assignments:
|
||||||
|
return 0
|
||||||
|
parameters.append(definition_id)
|
||||||
|
result = await self._database.execute(
|
||||||
|
f"UPDATE task_definitions SET {', '.join(assignments)} "
|
||||||
|
"WHERE id = ?",
|
||||||
|
tuple(parameters),
|
||||||
|
)
|
||||||
|
return result.rowcount
|
||||||
|
|
||||||
|
async def set_active(self, definition_id: int, is_active: bool) -> int:
|
||||||
|
"""Deactivate/reactivate; returns rows updated (0 if absent).
|
||||||
|
|
||||||
|
Deactivating stops future instance generation but leaves
|
||||||
|
existing instances and completion history untouched.
|
||||||
|
"""
|
||||||
|
result = await self._database.execute(
|
||||||
|
"UPDATE task_definitions SET is_active = ? WHERE id = ?",
|
||||||
|
(int(is_active), definition_id),
|
||||||
|
)
|
||||||
|
return result.rowcount
|
||||||
|
|
||||||
|
async def set_assignee(
|
||||||
|
self, definition_id: int, child_id: int
|
||||||
|
) -> int:
|
||||||
|
"""Reassign the definition to ``child_id``; rows updated (0 if absent).
|
||||||
|
|
||||||
|
Validates the new assignee inside the same serialized
|
||||||
|
transaction as the UPDATE (existing and active AT ASSIGNMENT
|
||||||
|
TIME), so a child deactivated concurrently cannot become the
|
||||||
|
assignee. Changes future instances only: already-generated
|
||||||
|
instances and completion history are never rewritten here.
|
||||||
|
"""
|
||||||
|
async with _connection_lock(self._database):
|
||||||
|
async with self._database.transaction():
|
||||||
|
await self._validate_assignable_child(child_id)
|
||||||
|
result = await self._database.execute(
|
||||||
|
"UPDATE task_definitions SET child_id = ? "
|
||||||
|
"WHERE id = ?",
|
||||||
|
(child_id, definition_id),
|
||||||
|
)
|
||||||
|
return result.rowcount
|
||||||
|
|
||||||
|
async def _validate_assignable_child(self, child_id: int) -> None:
|
||||||
|
"""Raise ValueError unless the child exists and is active.
|
||||||
|
|
||||||
|
MUST be called inside the connection lock so the verdict cannot
|
||||||
|
go stale before the caller's UPDATE commits.
|
||||||
|
"""
|
||||||
|
child = await self._database.fetch_one(
|
||||||
|
"SELECT is_active FROM children WHERE id = ?", (child_id,)
|
||||||
|
)
|
||||||
|
if child is None:
|
||||||
|
raise ValueError(f"child {child_id} does not exist")
|
||||||
|
if not child[0]:
|
||||||
|
raise ValueError(
|
||||||
|
f"child {child_id} is inactive and cannot be assigned"
|
||||||
|
)
|
||||||
@@ -478,11 +478,15 @@ def test_children_and_admin_sql_lives_only_in_dao_module() -> None:
|
|||||||
|
|
||||||
allowed = {
|
allowed = {
|
||||||
"custom_components/nestquest/dao_children.py", # the DAO itself
|
"custom_components/nestquest/dao_children.py", # the DAO itself
|
||||||
|
"custom_components/nestquest/dao_rules.py", # validates child
|
||||||
|
# activeness on assignment (FK to children, done-condition
|
||||||
|
# 'validates that the assigned child is active')
|
||||||
"custom_components/nestquest/schema.py", # declares the DDL
|
"custom_components/nestquest/schema.py", # declares the DDL
|
||||||
"custom_components/nestquest/migrations.py", # applies the DDL
|
"custom_components/nestquest/migrations.py", # applies the DDL
|
||||||
"tests/test_schema.py", # tests the DDL
|
"tests/test_schema.py", # tests the DDL
|
||||||
"tests/test_migrations.py", # tests migration application
|
"tests/test_migrations.py", # tests migration application
|
||||||
"tests/test_dao_children.py", # this file, scanned separately
|
"tests/test_dao_children.py", # this file, scanned separately
|
||||||
|
"tests/test_dao_rules.py", # rules/definitions guard, own scope
|
||||||
}
|
}
|
||||||
sql_pattern = re.compile(
|
sql_pattern = re.compile(
|
||||||
r"(FROM|INTO|UPDATE|DELETE\s+FROM|JOIN)\s+"
|
r"(FROM|INTO|UPDATE|DELETE\s+FROM|JOIN)\s+"
|
||||||
|
|||||||
@@ -0,0 +1,862 @@
|
|||||||
|
"""Tests for dao_rules.py: typed DAO for schedule_rules and task_definitions."""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import sqlite3
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from custom_components.nestquest.dao_children import ChildrenDao
|
||||||
|
from custom_components.nestquest.dao_rules import (
|
||||||
|
ScheduleRuleRecord,
|
||||||
|
ScheduleRulesDao,
|
||||||
|
TaskDefinitionRecord,
|
||||||
|
TaskDefinitionsDao,
|
||||||
|
)
|
||||||
|
from custom_components.nestquest.db import NestQuestDatabase
|
||||||
|
from custom_components.nestquest.migrations import apply_migrations
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
|
||||||
|
NOW = "2026-09-14T12:00:00+00:00"
|
||||||
|
|
||||||
|
|
||||||
|
async def _prepare(path) -> tuple:
|
||||||
|
database = NestQuestDatabase(_make_hass_mock())
|
||||||
|
await database.open(path)
|
||||||
|
await apply_migrations(database)
|
||||||
|
rules = ScheduleRulesDao(database)
|
||||||
|
definitions = TaskDefinitionsDao(database)
|
||||||
|
children = ChildrenDao(database)
|
||||||
|
child = await children.create("Ada", NOW)
|
||||||
|
return database, rules, definitions, children, child
|
||||||
|
|
||||||
|
|
||||||
|
def _with_db(tmp_path, name):
|
||||||
|
"""Run an async body against a prepared database, closing it after."""
|
||||||
|
|
||||||
|
def _run_test(body):
|
||||||
|
async def _main():
|
||||||
|
database, rules, definitions, children, child = await _prepare(
|
||||||
|
tmp_path / name
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
return await body(database, rules, definitions, children, child)
|
||||||
|
finally:
|
||||||
|
await database.close()
|
||||||
|
|
||||||
|
return _run(_main())
|
||||||
|
|
||||||
|
return _run_test
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# schedule_rules: create / get
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_create_returns_typed_record(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create(
|
||||||
|
"weekly", "2026-09-14", weekday_set="0,2,4", interval=2
|
||||||
|
)
|
||||||
|
assert isinstance(rule, ScheduleRuleRecord)
|
||||||
|
assert rule.id == 1
|
||||||
|
assert rule.rule_type == "weekly"
|
||||||
|
assert rule.interval == 2
|
||||||
|
assert rule.weekday_set == "0,2,4"
|
||||||
|
assert rule.day_of_month is None
|
||||||
|
assert rule.nth_weekday is None
|
||||||
|
assert rule.month is None
|
||||||
|
assert rule.start_date == "2026-09-14"
|
||||||
|
assert rule.end_date is None
|
||||||
|
return rule
|
||||||
|
|
||||||
|
_with_db(tmp_path, "rule-create.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_create_monthly_with_day_of_month(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create(
|
||||||
|
"monthly", "2026-09-14", day_of_month=15, weekday_set=None
|
||||||
|
)
|
||||||
|
assert rule.day_of_month == 15
|
||||||
|
assert rule.weekday_set is None
|
||||||
|
return rule
|
||||||
|
|
||||||
|
_with_db(tmp_path, "rule-monthly.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_get_missing_returns_none(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
return await rules.get(999)
|
||||||
|
|
||||||
|
assert _with_db(tmp_path, "rule-get-missing.db")(_body) is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_create_coherence_enforced_by_schema(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
with pytest.raises(sqlite3.IntegrityError, match="CHECK"):
|
||||||
|
await rules.create("weekly", "2026-09-14", weekday_set=None)
|
||||||
|
return None
|
||||||
|
|
||||||
|
_with_db(tmp_path, "rule-coherence.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_create_rejects_malformed_dates(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
for bad in (
|
||||||
|
"not-a-date",
|
||||||
|
"2026-9-4",
|
||||||
|
"2026-13-01",
|
||||||
|
"2026-02-30",
|
||||||
|
"09-14",
|
||||||
|
"",
|
||||||
|
):
|
||||||
|
with pytest.raises(ValueError, match="YYYY-MM-DD"):
|
||||||
|
await rules.create("daily", bad)
|
||||||
|
with pytest.raises(ValueError, match="YYYY-MM-DD"):
|
||||||
|
await rules.create("daily", "2026-09-14", end_date=bad)
|
||||||
|
return None
|
||||||
|
|
||||||
|
_with_db(tmp_path, "rule-create-dates.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_create_end_before_start_rejected(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
with pytest.raises(sqlite3.IntegrityError, match="CHECK"):
|
||||||
|
await rules.create(
|
||||||
|
"daily", "2026-09-14", end_date="2026-09-13"
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
_with_db(tmp_path, "rule-dates.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# schedule_rules: update
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_update_fields_round_trip(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("weekly", "2026-09-14", weekday_set="0,2")
|
||||||
|
updated = await rules.update(
|
||||||
|
rule.id, weekday_set="1,3", interval=3, end_date="2026-12-31"
|
||||||
|
)
|
||||||
|
assert updated == 1
|
||||||
|
fetched = await rules.get(rule.id)
|
||||||
|
assert fetched.weekday_set == "1,3"
|
||||||
|
assert fetched.interval == 3
|
||||||
|
assert fetched.end_date == "2026-12-31"
|
||||||
|
assert fetched.rule_type == "weekly"
|
||||||
|
return fetched
|
||||||
|
|
||||||
|
_with_db(tmp_path, "rule-update.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_update_omitted_fields_untouched(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("weekly", "2026-09-14", weekday_set="0,2")
|
||||||
|
await rules.update(rule.id, interval=2)
|
||||||
|
fetched = await rules.get(rule.id)
|
||||||
|
assert fetched.weekday_set == "0,2"
|
||||||
|
assert fetched.start_date == "2026-09-14"
|
||||||
|
return fetched
|
||||||
|
|
||||||
|
_with_db(tmp_path, "rule-update-partial.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_update_no_fields_returns_zero(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
return await rules.update(rule.id)
|
||||||
|
|
||||||
|
assert _with_db(tmp_path, "rule-update-empty.db")(_body) == 0
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_update_missing_rule_returns_zero(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
return await rules.update(999, interval=2)
|
||||||
|
|
||||||
|
assert _with_db(tmp_path, "rule-update-missing.db")(_body) == 0
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_update_bad_type_rejected_by_check(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
with pytest.raises(sqlite3.IntegrityError, match="CHECK"):
|
||||||
|
await rules.update(rule.id, rule_type="sometimes")
|
||||||
|
return None
|
||||||
|
|
||||||
|
_with_db(tmp_path, "rule-update-bad-type.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_update_can_clear_nullable_fields(tmp_path) -> None:
|
||||||
|
"""Explicit None clears a nullable column; omitted leaves it alone.
|
||||||
|
|
||||||
|
A caller must be able to reopen an ended rule (end_date back to
|
||||||
|
NULL) and clear rule-shape fields; the _UNSET sentinel keeps
|
||||||
|
'omitted' distinct from 'write NULL'.
|
||||||
|
"""
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create(
|
||||||
|
"weekly",
|
||||||
|
"2026-09-14",
|
||||||
|
weekday_set="0,2",
|
||||||
|
end_date="2026-12-31",
|
||||||
|
month=3,
|
||||||
|
)
|
||||||
|
# Omitted: nothing changes.
|
||||||
|
await rules.update(rule.id, interval=2)
|
||||||
|
kept = await rules.get(rule.id)
|
||||||
|
assert kept.end_date == "2026-12-31"
|
||||||
|
assert kept.month == 3
|
||||||
|
# Explicit None: clears both.
|
||||||
|
await rules.update(rule.id, end_date=None, month=None)
|
||||||
|
cleared = await rules.get(rule.id)
|
||||||
|
assert cleared.end_date is None
|
||||||
|
assert cleared.month is None
|
||||||
|
assert cleared.interval == 2
|
||||||
|
return cleared
|
||||||
|
|
||||||
|
_with_db(tmp_path, "rule-update-clear.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_update_validates_date_shape(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
for bad in ("not-a-date", "2026-9-4", "2026-13-01", "09-14"):
|
||||||
|
with pytest.raises(ValueError, match="YYYY-MM-DD"):
|
||||||
|
await rules.update(rule.id, start_date=bad)
|
||||||
|
with pytest.raises(ValueError, match="YYYY-MM-DD"):
|
||||||
|
await rules.update(rule.id, end_date=bad)
|
||||||
|
# None is still allowed (clears the column) without validation.
|
||||||
|
await rules.update(rule.id, end_date=None)
|
||||||
|
return None
|
||||||
|
|
||||||
|
_with_db(tmp_path, "rule-update-dates.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# schedule_rules: delete-if-unreferenced
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_delete_unreferenced_succeeds(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
assert await rules.delete_if_unreferenced(rule.id) is True
|
||||||
|
return await rules.get(rule.id)
|
||||||
|
|
||||||
|
assert _with_db(tmp_path, "rule-delete-ok.db")(_body) is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_delete_referenced_is_rejected(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
await definitions.create("Brush teeth", child.id, rule.id, NOW)
|
||||||
|
assert await rules.delete_if_unreferenced(rule.id) is False
|
||||||
|
fetched = await rules.get(rule.id)
|
||||||
|
assert fetched is not None, (
|
||||||
|
"referenced rule must survive the delete attempt"
|
||||||
|
)
|
||||||
|
return fetched
|
||||||
|
|
||||||
|
_with_db(tmp_path, "rule-delete-referenced.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_delete_missing_returns_false(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
return await rules.delete_if_unreferenced(999)
|
||||||
|
|
||||||
|
assert _with_db(tmp_path, "rule-delete-missing.db")(_body) is False
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_delete_after_last_reference_removed_succeeds(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
definition = await definitions.create(
|
||||||
|
"Brush teeth", child.id, rule.id, NOW
|
||||||
|
)
|
||||||
|
assert await rules.delete_if_unreferenced(rule.id) is False
|
||||||
|
await definitions.set_active(definition.id, False)
|
||||||
|
# Deactivation is NOT deletion: the definition still references
|
||||||
|
# the rule, so the delete must still be rejected.
|
||||||
|
assert await rules.delete_if_unreferenced(rule.id) is False
|
||||||
|
return None
|
||||||
|
|
||||||
|
_with_db(tmp_path, "rule-delete-inactive-ref.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_rule_delete_concurrent_with_definition_create_is_safe(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
"""A racing definition creation cannot produce a dangling reference.
|
||||||
|
|
||||||
|
Both operations queue on the connection lock, so exactly one of two
|
||||||
|
safe outcomes happens: the create wins and the delete is rejected
|
||||||
|
(definition exists, rule exists), or the delete wins and the create
|
||||||
|
fails cleanly with ValueError (rule gone). A definition row
|
||||||
|
pointing at a deleted rule is impossible in either case.
|
||||||
|
|
||||||
|
BOTH orderings are forced: delete-first by starting the delete and
|
||||||
|
yielding; create-first by hooking ScheduleRulesDao.get so the
|
||||||
|
create's validation pauses mid-flight before the delete starts.
|
||||||
|
"""
|
||||||
|
async def _main(order: str):
|
||||||
|
database = NestQuestDatabase(_make_hass_mock())
|
||||||
|
await database.open(tmp_path / f"rule-delete-race-{order}.db")
|
||||||
|
try:
|
||||||
|
await apply_migrations(database)
|
||||||
|
children = ChildrenDao(database)
|
||||||
|
rules = ScheduleRulesDao(database)
|
||||||
|
definitions = TaskDefinitionsDao(database)
|
||||||
|
child = await children.create("Ada", NOW)
|
||||||
|
rule_a = await rules.create("daily", "2026-09-14")
|
||||||
|
|
||||||
|
if order == "create-first":
|
||||||
|
# Pause the create inside its rule validation: the hook
|
||||||
|
# blocks after the rule-lookup statement until the
|
||||||
|
# delete task has been scheduled, so the create holds
|
||||||
|
# the connection lock while the delete queues behind
|
||||||
|
# it — then the create proceeds and wins.
|
||||||
|
import custom_components.nestquest.dao_rules as dao_rules
|
||||||
|
|
||||||
|
original_validate = (
|
||||||
|
dao_rules.TaskDefinitionsDao._validate_assignable
|
||||||
|
)
|
||||||
|
release = asyncio.Event()
|
||||||
|
started = asyncio.Event()
|
||||||
|
|
||||||
|
async def _pausing_validate(self, child_id, rule_id):
|
||||||
|
# Run the real validation FIRST (this is the
|
||||||
|
# time-of-check), THEN pause: the delete task gets
|
||||||
|
# scheduled while the create sits between its
|
||||||
|
# passed validation and its INSERT. The serialized
|
||||||
|
# transaction must keep the delete queued until the
|
||||||
|
# insert commits, so the create must win the race
|
||||||
|
# and the delete must be rejected as referenced.
|
||||||
|
await original_validate(self, child_id, rule_id)
|
||||||
|
if rule_id == rule_a.id and not started.is_set():
|
||||||
|
started.set()
|
||||||
|
await release.wait()
|
||||||
|
|
||||||
|
dao_rules.TaskDefinitionsDao._validate_assignable = (
|
||||||
|
_pausing_validate
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
create_task = asyncio.ensure_future(
|
||||||
|
definitions.create(
|
||||||
|
"Brush teeth", child.id, rule_a.id, NOW
|
||||||
|
)
|
||||||
|
)
|
||||||
|
await started.wait()
|
||||||
|
delete_task = asyncio.ensure_future(
|
||||||
|
rules.delete_if_unreferenced(rule_a.id)
|
||||||
|
)
|
||||||
|
await asyncio.sleep(0)
|
||||||
|
started.clear()
|
||||||
|
release.set()
|
||||||
|
deleted, creation = await asyncio.gather(
|
||||||
|
delete_task, create_task, return_exceptions=True
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
dao_rules.TaskDefinitionsDao._validate_assignable = (
|
||||||
|
original_validate
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
async def _delete():
|
||||||
|
return await rules.delete_if_unreferenced(rule_a.id)
|
||||||
|
|
||||||
|
async def _create():
|
||||||
|
return await definitions.create(
|
||||||
|
"Brush teeth", child.id, rule_a.id, NOW
|
||||||
|
)
|
||||||
|
|
||||||
|
delete_task = asyncio.ensure_future(_delete())
|
||||||
|
await asyncio.sleep(0)
|
||||||
|
create_task = asyncio.ensure_future(_create())
|
||||||
|
deleted, creation = await asyncio.gather(
|
||||||
|
delete_task, create_task, return_exceptions=True
|
||||||
|
)
|
||||||
|
|
||||||
|
assert not isinstance(deleted, BaseException), (
|
||||||
|
f"delete must queue, not crash: {deleted!r}"
|
||||||
|
)
|
||||||
|
rule_row = await rules.get(rule_a.id)
|
||||||
|
if deleted:
|
||||||
|
# Delete won: the create must have failed cleanly.
|
||||||
|
assert isinstance(creation, ValueError), (
|
||||||
|
f"creating against a deleted rule must raise "
|
||||||
|
f"ValueError, got {creation!r}"
|
||||||
|
)
|
||||||
|
assert rule_row is None
|
||||||
|
else:
|
||||||
|
# Create won: the delete was rejected, both rows exist.
|
||||||
|
assert isinstance(creation, TaskDefinitionRecord), (
|
||||||
|
f"create must succeed, got {creation!r}"
|
||||||
|
)
|
||||||
|
assert rule_row is not None
|
||||||
|
return deleted
|
||||||
|
finally:
|
||||||
|
await database.close()
|
||||||
|
|
||||||
|
delete_won = _run(_main("delete-first"))
|
||||||
|
create_won = _run(_main("create-first"))
|
||||||
|
# delete-first: the delete acquires the lock before the create can
|
||||||
|
# validate, so the rule is gone and the create fails cleanly.
|
||||||
|
assert delete_won is True
|
||||||
|
# create-first: validation passed, the create holds the lock across
|
||||||
|
# its INSERT, so the queued delete must find the definition and be
|
||||||
|
# rejected — the create must NOT lose its rule after validating it.
|
||||||
|
assert create_won is False
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# task_definitions: create / get
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_create_returns_typed_record(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("weekly", "2026-09-14", weekday_set="0,2")
|
||||||
|
definition = await definitions.create(
|
||||||
|
"Brush teeth",
|
||||||
|
child.id,
|
||||||
|
rule.id,
|
||||||
|
NOW,
|
||||||
|
description="Morning and night",
|
||||||
|
icon="mdi:tooth",
|
||||||
|
due_time="08:00",
|
||||||
|
)
|
||||||
|
assert isinstance(definition, TaskDefinitionRecord)
|
||||||
|
assert definition.title == "Brush teeth"
|
||||||
|
assert definition.child_id == child.id
|
||||||
|
assert definition.schedule_rule_id == rule.id
|
||||||
|
assert definition.due_time == "08:00"
|
||||||
|
assert definition.is_active is True
|
||||||
|
assert definition.created_at == NOW
|
||||||
|
return definition
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-create.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_get_missing_returns_none(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
return await definitions.get(999)
|
||||||
|
|
||||||
|
assert _with_db(tmp_path, "definition-get-missing.db")(_body) is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_create_unknown_child_raises_value_error(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
with pytest.raises(ValueError, match="does not exist"):
|
||||||
|
await definitions.create("X", 999, rule.id, NOW)
|
||||||
|
return None
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-bad-child.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_create_inactive_child_raises_value_error(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
await children.set_active(child.id, False)
|
||||||
|
with pytest.raises(ValueError, match="inactive"):
|
||||||
|
await definitions.create("X", child.id, rule.id, NOW)
|
||||||
|
return None
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-inactive-child.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_create_unknown_rule_raises_value_error(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
with pytest.raises(ValueError, match="does not exist"):
|
||||||
|
await definitions.create("X", child.id, 999, NOW)
|
||||||
|
return None
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-bad-rule.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# task_definitions: list by child / list active
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_list_by_child_filters_and_orders(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
other_child = await children.create("Bo", NOW)
|
||||||
|
await definitions.create("A", child.id, rule.id, NOW)
|
||||||
|
await definitions.create("B", child.id, rule.id, NOW)
|
||||||
|
await definitions.create("C", other_child.id, rule.id, NOW)
|
||||||
|
mine = await definitions.list_by_child(child.id)
|
||||||
|
assert [d.title for d in mine] == ["B", "A"]
|
||||||
|
return mine
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-list-by-child.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_list_by_child_missing_child_returns_empty(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
return await definitions.list_by_child(999)
|
||||||
|
|
||||||
|
assert _with_db(tmp_path, "definition-list-missing.db")(_body) == []
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_list_active_excludes_inactive(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
first = await definitions.create("A", child.id, rule.id, NOW)
|
||||||
|
await definitions.create("B", child.id, rule.id, NOW)
|
||||||
|
await definitions.set_active(first.id, False)
|
||||||
|
active = await definitions.list_active()
|
||||||
|
assert [d.title for d in active] == ["B"]
|
||||||
|
assert all(d.is_active for d in active)
|
||||||
|
return active
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-list-active.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# task_definitions: update / set_active / set_assignee
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_update_fields_round_trip(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
definition = await definitions.create(
|
||||||
|
"A", child.id, rule.id, NOW, due_time="08:00"
|
||||||
|
)
|
||||||
|
assert await definitions.update(
|
||||||
|
definition.id,
|
||||||
|
title="A2",
|
||||||
|
description="New",
|
||||||
|
icon="mdi:star",
|
||||||
|
due_time="09:00",
|
||||||
|
) == 1
|
||||||
|
fetched = await definitions.get(definition.id)
|
||||||
|
assert fetched.title == "A2"
|
||||||
|
assert fetched.description == "New"
|
||||||
|
assert fetched.icon == "mdi:star"
|
||||||
|
assert fetched.due_time == "09:00"
|
||||||
|
return fetched
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-update.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_update_cannot_change_assignee_or_active(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
other = await children.create("Bo", NOW)
|
||||||
|
definition = await definitions.create("A", child.id, rule.id, NOW)
|
||||||
|
# title= / child_id= / is_active= are NOT update() parameters;
|
||||||
|
# this asserts the API shape: reassignment and activation have
|
||||||
|
# their own explicit methods.
|
||||||
|
import inspect
|
||||||
|
|
||||||
|
parameters = inspect.signature(definitions.update).parameters
|
||||||
|
assert set(parameters) == {
|
||||||
|
"definition_id",
|
||||||
|
"title",
|
||||||
|
"description",
|
||||||
|
"icon",
|
||||||
|
"due_time",
|
||||||
|
}
|
||||||
|
assert await definitions.update(
|
||||||
|
definition.id, title="A2"
|
||||||
|
) == 1
|
||||||
|
fetched = await definitions.get(definition.id)
|
||||||
|
assert fetched.child_id == child.id
|
||||||
|
assert fetched.is_active is True
|
||||||
|
return fetched
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-update-shape.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_update_no_fields_returns_zero(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
definition = await definitions.create("A", child.id, rule.id, NOW)
|
||||||
|
return await definitions.update(definition.id)
|
||||||
|
|
||||||
|
assert _with_db(tmp_path, "definition-update-empty.db")(_body) == 0
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_update_can_clear_optional_fields(tmp_path) -> None:
|
||||||
|
"""Explicit None removes description/icon/due_time; omitted keeps."""
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
definition = await definitions.create(
|
||||||
|
"A",
|
||||||
|
child.id,
|
||||||
|
rule.id,
|
||||||
|
NOW,
|
||||||
|
description="d",
|
||||||
|
icon="mdi:x",
|
||||||
|
due_time="08:00",
|
||||||
|
)
|
||||||
|
await definitions.update(definition.id, title="A2")
|
||||||
|
kept = await definitions.get(definition.id)
|
||||||
|
assert kept.description == "d"
|
||||||
|
assert kept.icon == "mdi:x"
|
||||||
|
await definitions.update(
|
||||||
|
definition.id, description=None, icon=None, due_time=None
|
||||||
|
)
|
||||||
|
cleared = await definitions.get(definition.id)
|
||||||
|
assert cleared.description is None
|
||||||
|
assert cleared.icon is None
|
||||||
|
assert cleared.due_time is None
|
||||||
|
assert cleared.title == "A2"
|
||||||
|
return cleared
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-update-clear.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_update_missing_returns_zero(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
return await definitions.update(999, title="X")
|
||||||
|
|
||||||
|
assert _with_db(tmp_path, "definition-update-missing.db")(_body) == 0
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_set_active_round_trip(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
definition = await definitions.create("A", child.id, rule.id, NOW)
|
||||||
|
assert await definitions.set_active(definition.id, False) == 1
|
||||||
|
fetched = await definitions.get(definition.id)
|
||||||
|
assert fetched.is_active is False
|
||||||
|
assert await definitions.set_active(definition.id, True) == 1
|
||||||
|
fetched = await definitions.get(definition.id)
|
||||||
|
assert fetched.is_active is True
|
||||||
|
return fetched
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-set-active.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_set_active_missing_returns_zero(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
return await definitions.set_active(999, False)
|
||||||
|
|
||||||
|
assert _with_db(tmp_path, "definition-set-active-missing.db")(_body) == 0
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_no_delete_method_exists(tmp_path) -> None:
|
||||||
|
"""Guardrail: definitions are deactivated, never hard-deleted."""
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
import inspect
|
||||||
|
|
||||||
|
methods = {
|
||||||
|
name
|
||||||
|
for name, _ in inspect.getmembers(
|
||||||
|
TaskDefinitionsDao, inspect.isfunction
|
||||||
|
)
|
||||||
|
}
|
||||||
|
assert "delete" not in methods
|
||||||
|
assert not any(name.startswith("delete") for name in methods)
|
||||||
|
return methods
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-no-delete.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_set_assignee_round_trip(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
other = await children.create("Bo", NOW)
|
||||||
|
definition = await definitions.create("A", child.id, rule.id, NOW)
|
||||||
|
assert await definitions.set_assignee(definition.id, other.id) == 1
|
||||||
|
fetched = await definitions.get(definition.id)
|
||||||
|
assert fetched.child_id == other.id
|
||||||
|
return fetched
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-set-assignee.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_set_assignee_inactive_child_raises(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
other = await children.create("Bo", NOW)
|
||||||
|
definition = await definitions.create("A", child.id, rule.id, NOW)
|
||||||
|
await children.set_active(other.id, False)
|
||||||
|
with pytest.raises(ValueError, match="inactive"):
|
||||||
|
await definitions.set_assignee(definition.id, other.id)
|
||||||
|
fetched = await definitions.get(definition.id)
|
||||||
|
assert fetched.child_id == child.id, (
|
||||||
|
"failed reassignment must leave the current assignee intact"
|
||||||
|
)
|
||||||
|
return fetched
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-assignee-inactive.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_set_assignee_unknown_child_raises(tmp_path) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
definition = await definitions.create("A", child.id, rule.id, NOW)
|
||||||
|
with pytest.raises(ValueError, match="does not exist"):
|
||||||
|
await definitions.set_assignee(definition.id, 999)
|
||||||
|
return None
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-assignee-unknown.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_set_assignee_missing_definition_returns_zero(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
other = await children.create("Bo", NOW)
|
||||||
|
return await definitions.set_assignee(999, other.id)
|
||||||
|
|
||||||
|
assert _with_db(tmp_path, "definition-assignee-missing.db")(_body) == 0
|
||||||
|
|
||||||
|
|
||||||
|
def test_definition_set_assignee_leaves_history_rows_alone(
|
||||||
|
tmp_path,
|
||||||
|
) -> None:
|
||||||
|
"""Reassignment writes the definition row only: any instances that
|
||||||
|
already exist keep their generation-time child_id (Feature 06
|
||||||
|
guardrail 'changes future instances only').
|
||||||
|
"""
|
||||||
|
async def _body(database, rules, definitions, children, child):
|
||||||
|
rule = await rules.create("daily", "2026-09-14")
|
||||||
|
other = await children.create("Bo", NOW)
|
||||||
|
definition = await definitions.create("A", child.id, rule.id, NOW)
|
||||||
|
# Simulate an already-generated instance (materialization owns
|
||||||
|
# this table, but its row shape proves reassignment isolation).
|
||||||
|
await database.execute(
|
||||||
|
"INSERT INTO task_instances (definition_id, child_id, "
|
||||||
|
"due_date, generated_at) VALUES (?, ?, ?, ?)",
|
||||||
|
(definition.id, child.id, "2026-09-15", NOW),
|
||||||
|
)
|
||||||
|
await definitions.set_assignee(definition.id, other.id)
|
||||||
|
row = await database.fetch_one(
|
||||||
|
"SELECT child_id FROM task_instances WHERE definition_id = ?",
|
||||||
|
(definition.id,),
|
||||||
|
)
|
||||||
|
assert row == (child.id,)
|
||||||
|
return None
|
||||||
|
|
||||||
|
_with_db(tmp_path, "definition-assignee-history.db")(_body)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# No SQL for these tables outside the DAO module
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_rules_and_definitions_sql_lives_only_in_dao_module() -> None:
|
||||||
|
"""Guardrail: schedule_rules/task_definitions SQL may appear only
|
||||||
|
in the DAO modules (and the schema DDL declarations). RECURSIVE
|
||||||
|
scan of package and tests, FROM/INTO/UPDATE/DELETE FROM/JOIN
|
||||||
|
pattern, with exact repo-relative exclusions justified by role:
|
||||||
|
schema.py declares the DDL, migrations.py applies it, and the
|
||||||
|
test files for exactly those layers verify DDL, not data paths.
|
||||||
|
"""
|
||||||
|
import re
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
package = Path(
|
||||||
|
__import__(
|
||||||
|
"custom_components.nestquest", fromlist=["__file__"]
|
||||||
|
).__file__
|
||||||
|
).parent
|
||||||
|
repo_root = package.parent.parent
|
||||||
|
scan_roots = [package, repo_root / "tests"]
|
||||||
|
|
||||||
|
allowed = {
|
||||||
|
"custom_components/nestquest/dao_rules.py", # this DAO
|
||||||
|
"custom_components/nestquest/schema.py", # declares the DDL
|
||||||
|
"custom_components/nestquest/migrations.py", # applies the DDL
|
||||||
|
"tests/test_schema.py", # tests the DDL
|
||||||
|
"tests/test_migrations.py", # tests migration application
|
||||||
|
"tests/test_dao_rules.py", # this file, scanned separately
|
||||||
|
# dao_children.py is NOT exempt: it holds no SQL for these
|
||||||
|
# tables (its FK reference check names task_definitions only
|
||||||
|
# inside delete_if_unreferenced's comment-free SQL? No — that
|
||||||
|
# lives HERE in dao_rules). Any future leak there must fail.
|
||||||
|
}
|
||||||
|
sql_pattern = re.compile(
|
||||||
|
r"(FROM|INTO|UPDATE|DELETE\s+FROM|JOIN)\s+[`'\"]*(\[)?"
|
||||||
|
r"(schedule_rules|task_definitions)\b",
|
||||||
|
re.IGNORECASE,
|
||||||
|
)
|
||||||
|
offenders: list[str] = []
|
||||||
|
for root in scan_roots:
|
||||||
|
for py in sorted(root.rglob("*.py")):
|
||||||
|
relative = py.relative_to(repo_root).as_posix()
|
||||||
|
if relative in allowed:
|
||||||
|
continue
|
||||||
|
if sql_pattern.search(py.read_text()):
|
||||||
|
offenders.append(relative)
|
||||||
|
assert offenders == [], (
|
||||||
|
f"SQL touching schedule_rules/task_definitions leaked into: "
|
||||||
|
f"{offenders}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_dao_rules_test_file_uses_dao_not_raw_table_sql() -> None:
|
||||||
|
"""This test module must exercise the DAO, not raw SQL, for these
|
||||||
|
tables. Exceptions: the guard functions' own spans (their regexes
|
||||||
|
mention the names), and the reassignment-isolation test, which
|
||||||
|
legitimately touches task_instances — a table this DAO does not
|
||||||
|
own — to prove the guardrail that reassignment leaves it alone.
|
||||||
|
"""
|
||||||
|
import ast
|
||||||
|
import re
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
path = Path(__file__)
|
||||||
|
text = path.read_text()
|
||||||
|
lines = text.splitlines(keepends=True)
|
||||||
|
tree = ast.parse(text)
|
||||||
|
guard_names = {
|
||||||
|
"test_rules_and_definitions_sql_lives_only_in_dao_module",
|
||||||
|
"test_dao_rules_test_file_uses_dao_not_raw_table_sql",
|
||||||
|
}
|
||||||
|
excluded: set[int] = set()
|
||||||
|
for node in ast.walk(tree):
|
||||||
|
if (
|
||||||
|
isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef))
|
||||||
|
and node.name in guard_names
|
||||||
|
):
|
||||||
|
excluded.update(
|
||||||
|
range(node.lineno, (node.end_lineno or node.lineno) + 1)
|
||||||
|
)
|
||||||
|
|
||||||
|
remaining = "".join(
|
||||||
|
line
|
||||||
|
for number, line in enumerate(lines, start=1)
|
||||||
|
if number not in excluded
|
||||||
|
)
|
||||||
|
sql_pattern = re.compile(
|
||||||
|
r"(SELECT\s[^\"']*?FROM|INSERT\s+INTO|UPDATE|DELETE\s+FROM|"
|
||||||
|
r"FROM|JOIN)\s+[`'\"]*(\[)?(schedule_rules|task_definitions)\b",
|
||||||
|
re.IGNORECASE,
|
||||||
|
)
|
||||||
|
assert sql_pattern.search(remaining) is None, (
|
||||||
|
"tests must go through the DAO, not raw SQL, for these tables"
|
||||||
|
)
|
||||||
Reference in New Issue
Block a user