Add the morning summary blueprint
Iterates present children from the Feature 10 presence sensors, lists what each owes today from the remaining sensor, omits absent children entirely. Blueprint inputs (time, notify service, send toggle); the notify target is the household's choice, never hard-coded. PyYAML and Jinja2 join the dev-only dependencies for blueprint template tests.
This commit is contained in:
@@ -0,0 +1,382 @@
|
||||
"""Tests for the NestQuest automation blueprints.
|
||||
|
||||
The blueprints are YAML data consumed by Home Assistant's blueprint
|
||||
engine; the integration itself never imports yaml or jinja2. These
|
||||
tests therefore exercise them exactly the way HA would: parse the YAML
|
||||
(with a loader that understands ``!input`` tags), then render the
|
||||
message template with a plain jinja2 environment over a fixture state
|
||||
set shaped like HA's template state objects.
|
||||
|
||||
The harness is mock-only (see conftest.py), so the fixtures model just
|
||||
the surface the templates touch: ``states.binary_sensor`` /
|
||||
``states.sensor`` lists of objects carrying ``entity_id``, ``state`` and
|
||||
``attributes``. Jinja's ``search``/``match`` selectattr tests are
|
||||
Home Assistant additions, registered here explicitly.
|
||||
|
||||
Rendering policy under test (settled for the morning summary): a
|
||||
PRESENT child always appears — with remaining quests owed, or as "all
|
||||
clear" at zero remaining — and a child who is not present that day is
|
||||
omitted entirely, never listed with zero quests.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
from pathlib import Path
|
||||
from types import SimpleNamespace
|
||||
|
||||
import jinja2
|
||||
import yaml
|
||||
|
||||
from custom_components.nestquest.const import DEFAULT_MORNING_SUMMARY_TIME
|
||||
|
||||
REPO_ROOT = Path(__file__).parent.parent
|
||||
BLUEPRINT_DIR = (
|
||||
REPO_ROOT / "custom_components" / "nestquest" / "blueprints" / "automation"
|
||||
)
|
||||
|
||||
MORNING_TITLE = "NestQuest morning summary"
|
||||
|
||||
|
||||
class BlueprintInput(str):
|
||||
"""Marker for a parsed blueprint ``!input <name>`` reference."""
|
||||
|
||||
|
||||
def _input_constructor(loader: yaml.SafeLoader, node: yaml.Node) -> BlueprintInput:
|
||||
return BlueprintInput(loader.construct_scalar(node))
|
||||
|
||||
|
||||
class _BlueprintLoader(yaml.SafeLoader):
|
||||
"""SafeLoader extended with Home Assistant's ``!input`` blueprint tag."""
|
||||
|
||||
|
||||
_BlueprintLoader.add_constructor("!input", _input_constructor)
|
||||
|
||||
|
||||
def load_blueprints() -> dict[str, dict]:
|
||||
"""Parse every automation blueprint, asserting the directory exists."""
|
||||
assert BLUEPRINT_DIR.is_dir(), f"missing blueprint directory {BLUEPRINT_DIR}"
|
||||
paths = sorted(BLUEPRINT_DIR.glob("*.yaml"))
|
||||
assert paths, f"no blueprints under {BLUEPRINT_DIR}"
|
||||
return {
|
||||
path.stem: yaml.load(path.read_text(encoding="utf-8"), Loader=_BlueprintLoader)
|
||||
for path in paths
|
||||
}
|
||||
|
||||
|
||||
def iter_strings(node: object):
|
||||
"""Yield every string value in a parsed YAML structure, recursively."""
|
||||
if isinstance(node, str):
|
||||
yield node
|
||||
elif isinstance(node, dict):
|
||||
for value in node.values():
|
||||
yield from iter_strings(value)
|
||||
elif isinstance(node, list):
|
||||
for value in node:
|
||||
yield from iter_strings(value)
|
||||
|
||||
|
||||
def morning_summary() -> dict:
|
||||
"""Return the parsed morning-summary blueprint."""
|
||||
blueprints = load_blueprints()
|
||||
assert "morning_summary" in blueprints, "morning_summary.yaml is missing"
|
||||
return blueprints["morning_summary"]
|
||||
|
||||
|
||||
def morning_action(bp: dict) -> dict:
|
||||
"""Return the single notify action of a summary blueprint."""
|
||||
actions = bp["actions"]
|
||||
assert isinstance(actions, list) and len(actions) == 1
|
||||
return actions[0]
|
||||
|
||||
|
||||
class TemplateState:
|
||||
"""Stand-in for an HA template state object: entity_id/state/attributes."""
|
||||
|
||||
def __init__(self, entity_id: str, state: str, attributes: dict | None = None):
|
||||
self.entity_id = entity_id
|
||||
self.state = state
|
||||
self.attributes = dict(attributes or {})
|
||||
|
||||
|
||||
def make_states(binary_sensors=(), sensors=()) -> SimpleNamespace:
|
||||
"""Build the ``states`` fixture: per-domain lists of TemplateState."""
|
||||
return SimpleNamespace(
|
||||
binary_sensor=list(binary_sensors),
|
||||
sensor=list(sensors),
|
||||
)
|
||||
|
||||
|
||||
def make_template_environment() -> jinja2.Environment:
|
||||
"""A plain jinja2 environment with HA's regex tests and bool filter."""
|
||||
env = jinja2.Environment()
|
||||
env.tests["match"] = lambda value, pattern: re.match(pattern, value) is not None
|
||||
env.tests["search"] = lambda value, pattern: re.search(pattern, value) is not None
|
||||
|
||||
def _bool(value, default=False):
|
||||
if isinstance(value, str):
|
||||
return value.strip().lower() in ("true", "on", "open", "yes", "1")
|
||||
return bool(value) or default
|
||||
|
||||
env.filters["bool"] = _bool
|
||||
return env
|
||||
|
||||
|
||||
def render(template: str, **variables) -> str:
|
||||
"""Render a template the way HA would substitute its variables."""
|
||||
return make_template_environment().from_string(template).render(**variables)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# YAML parsing and blueprint shape.
|
||||
# ---------------------------------------------------------------------------
|
||||
def test_blueprints_parse_and_declare_valid_shape() -> None:
|
||||
"""Every blueprint parses and carries the required blueprint keys."""
|
||||
blueprints = load_blueprints()
|
||||
assert blueprints, "no blueprints found"
|
||||
for name, bp in blueprints.items():
|
||||
assert isinstance(bp, dict), f"{name} did not parse to a mapping"
|
||||
spec = bp["blueprint"]
|
||||
assert isinstance(spec["name"], str) and spec["name"].strip()
|
||||
assert spec["domain"] == "automation"
|
||||
assert isinstance(spec["input"], dict) and spec["input"]
|
||||
for key in ("triggers", "conditions", "actions"):
|
||||
assert isinstance(bp[key], list) and bp[key], f"{name}: empty {key}"
|
||||
|
||||
|
||||
def test_morning_summary_declares_inputs_with_selectors() -> None:
|
||||
"""The three blueprint inputs exist, carry selectors, and default sanely."""
|
||||
inputs = morning_summary()["blueprint"]["input"]
|
||||
expected = {"morning_time", "notify_target", "send_summary"}
|
||||
assert set(inputs) == expected
|
||||
for name, spec in inputs.items():
|
||||
assert isinstance(spec["selector"], dict) and spec["selector"], name
|
||||
assert inputs["morning_time"]["default"] == DEFAULT_MORNING_SUMMARY_TIME
|
||||
assert inputs["send_summary"]["default"] is True
|
||||
assert "time" in inputs["morning_time"]["selector"]
|
||||
assert "text" in inputs["notify_target"]["selector"]
|
||||
assert "boolean" in inputs["send_summary"]["selector"]
|
||||
|
||||
|
||||
def test_morning_summary_wires_inputs_not_literals() -> None:
|
||||
"""Time trigger, toggle condition, and notify action all use !input."""
|
||||
bp = morning_summary()
|
||||
assert bp["variables"]["send_summary"] == BlueprintInput("send_summary")
|
||||
|
||||
trigger = bp["triggers"][0]
|
||||
assert trigger["trigger"] == "time"
|
||||
assert trigger["at"] == BlueprintInput("morning_time")
|
||||
|
||||
condition = bp["conditions"][0]
|
||||
assert condition["condition"] == "template"
|
||||
assert "send_summary" in condition["value_template"]
|
||||
|
||||
action = morning_action(bp)
|
||||
assert action["action"] == BlueprintInput("notify_target")
|
||||
assert action["title"] == MORNING_TITLE
|
||||
assert isinstance(action["message"], str) and action["message"].strip()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Entity-reference discipline (Feature 10 shapes only).
|
||||
# ---------------------------------------------------------------------------
|
||||
#: Entity shapes Feature 10 actually creates (sensor.py, binary_sensor.py).
|
||||
ALLOWED_ENTITY_SHAPES: tuple[re.Pattern, ...] = tuple(
|
||||
re.compile(pattern)
|
||||
for pattern in (
|
||||
r"sensor\.nestquest_[a-z0-9_]+_quests_due_today",
|
||||
r"sensor\.nestquest_[a-z0-9_]+_quests_remaining_today",
|
||||
r"sensor\.nestquest_[a-z0-9_]+_quests_completed_today",
|
||||
r"sensor\.nestquest_[a-z0-9_]+_completion_pct_today",
|
||||
r"sensor\.nestquest_[a-z0-9_]+_next_quest",
|
||||
r"binary_sensor\.nestquest_[a-z0-9_]+_all_done",
|
||||
r"binary_sensor\.nestquest_[a-z0-9_]+_present_today",
|
||||
r"sensor\.nestquest_household_quests_due_today",
|
||||
r"sensor\.nestquest_household_quests_completed_today",
|
||||
r"sensor\.nestquest_cycle_day",
|
||||
)
|
||||
)
|
||||
|
||||
#: An unescaped, id-like entity reference: any found must be a full
|
||||
#: match for one of the Feature 10 shapes above.
|
||||
_ENTITY_LITERAL_RE = re.compile(r"(?<![\\\w])(?:sensor|binary_sensor)\.[A-Za-z0-9_]+")
|
||||
|
||||
#: A domain-dot mention, ignoring the template's escaped-dot regexes
|
||||
#: (one backslash is stripped so ``binary_sensor\\.`` counts too).
|
||||
_MENTION_RE = re.compile(r"(?:sensor|binary_sensor)\.([A-Za-z0-9_]+)")
|
||||
|
||||
|
||||
def test_entity_literals_match_feature_10_shapes() -> None:
|
||||
"""Every id-like entity string in the YAML is a Feature 10 shape."""
|
||||
for name, bp in load_blueprints().items():
|
||||
for value in iter_strings(bp):
|
||||
for literal in _ENTITY_LITERAL_RE.findall(value):
|
||||
assert any(
|
||||
shape.fullmatch(literal) for shape in ALLOWED_ENTITY_SHAPES
|
||||
), f"{name}: invented entity {literal!r}"
|
||||
# The validator itself must separate Feature 10 ids from lookalikes.
|
||||
assert any(
|
||||
shape.fullmatch("binary_sensor.nestquest_alice_present_today")
|
||||
for shape in ALLOWED_ENTITY_SHAPES
|
||||
)
|
||||
assert any(
|
||||
shape.fullmatch("sensor.nestquest_bob_quests_remaining_today")
|
||||
for shape in ALLOWED_ENTITY_SHAPES
|
||||
)
|
||||
for foreign in (
|
||||
"binary_sensor.someone_else_present_today",
|
||||
"binary_sensor.nestquest_alice_at_home",
|
||||
"sensor.nestquest_alice_streak",
|
||||
"vacuum.nestquest_robot",
|
||||
):
|
||||
assert not any(shape.fullmatch(foreign) for shape in ALLOWED_ENTITY_SHAPES)
|
||||
|
||||
|
||||
def test_domain_mentions_are_nestquest_prefixed() -> None:
|
||||
"""Every sensor/binary_sensor mention (regex or literal) is nestquest_."""
|
||||
for name, bp in load_blueprints().items():
|
||||
for value in iter_strings(bp):
|
||||
flattened = value.replace("\\", "")
|
||||
for tail in _MENTION_RE.findall(flattened):
|
||||
assert tail.startswith("nestquest_"), (
|
||||
f"{name}: non-nestquest entity mention in {value!r}"
|
||||
)
|
||||
|
||||
|
||||
def test_presence_regex_selects_only_nestquest_present_sensors() -> None:
|
||||
"""The extracted presence regex matches only Feature 10 presence ids."""
|
||||
message = morning_action(morning_summary())["message"]
|
||||
match = re.search(
|
||||
r"\^(binary_sensor\\\\\.nestquest_\.\*_present_today\$)", message
|
||||
)
|
||||
assert match is not None, "presence pattern missing from the template"
|
||||
pattern = match.group(1).replace("\\\\", "\\")
|
||||
assert pattern.endswith("$")
|
||||
assert re.search(pattern, "binary_sensor.nestquest_alice_present_today")
|
||||
assert re.search(pattern, "binary_sensor.nestquest_dave_all_done") is None
|
||||
assert re.search(pattern, "binary_sensor.motion_present_today") is None
|
||||
assert re.search(pattern, "binary_sensor.nestquest_erin_present_today_2") is None
|
||||
|
||||
|
||||
def test_morning_summary_never_hard_codes_notify_target() -> None:
|
||||
"""No notify service literal outside input descriptions; the choice is text."""
|
||||
bp = morning_summary()
|
||||
spec = bp["blueprint"]
|
||||
assert "hard-code" in spec["description"]
|
||||
assert not re.search(r"notify\.[a-z_]+", spec["description"])
|
||||
|
||||
outside_input = {k: v for k, v in bp.items() if k != "blueprint"}
|
||||
for value in iter_strings(outside_input):
|
||||
assert not re.search(r"notify\.[a-z_.]+", value), value
|
||||
|
||||
target_description = spec["input"]["notify_target"]["description"]
|
||||
assert re.search(r"notify\.[a-z_]+", target_description), (
|
||||
"the input description should show a placeholder example"
|
||||
)
|
||||
assert morning_action(bp)["action"] == BlueprintInput("notify_target")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Message rendering against fixture state sets.
|
||||
# ---------------------------------------------------------------------------
|
||||
def morning_fixture() -> SimpleNamespace:
|
||||
"""Two children — Alice present (2 owed), Bob absent — plus decoys."""
|
||||
return make_states(
|
||||
binary_sensors=[
|
||||
TemplateState("binary_sensor.nestquest_alice_present_today", "on"),
|
||||
TemplateState("binary_sensor.nestquest_bob_present_today", "off"),
|
||||
TemplateState("binary_sensor.motion_present_today", "on"),
|
||||
TemplateState("binary_sensor.nestquest_dave_all_done", "on"),
|
||||
TemplateState("binary_sensor.nestquest_erin_present_today", "unavailable"),
|
||||
],
|
||||
sensors=[
|
||||
TemplateState(
|
||||
"sensor.nestquest_alice_quests_due_today",
|
||||
"3",
|
||||
{"child_name": "Alice"},
|
||||
),
|
||||
TemplateState("sensor.nestquest_alice_quests_remaining_today", "2"),
|
||||
TemplateState(
|
||||
"sensor.nestquest_bob_quests_due_today",
|
||||
"2",
|
||||
{"child_name": "Bob"},
|
||||
),
|
||||
TemplateState("sensor.nestquest_bob_quests_remaining_today", "1"),
|
||||
TemplateState("sensor.nestquest_household_quests_due_today", "5"),
|
||||
TemplateState("sensor.nestquest_carol_unrelated", "7"),
|
||||
],
|
||||
)
|
||||
|
||||
|
||||
def test_morning_summary_lists_present_child_and_omits_absent() -> None:
|
||||
"""Present Alice appears with her count; absent Bob and decoys never do."""
|
||||
message = morning_action(morning_summary())["message"]
|
||||
rendered = render(message, states=morning_fixture())
|
||||
assert rendered == "Alice owes 2 quest(s) today."
|
||||
assert "Bob" not in rendered
|
||||
for absent in ("motion", "Dave", "Erin", "household", "carol"):
|
||||
assert absent not in rendered
|
||||
|
||||
|
||||
def test_morning_summary_present_child_zero_remaining_is_all_clear() -> None:
|
||||
"""A present child always appears — zero remaining reads as all clear."""
|
||||
states = make_states(
|
||||
binary_sensors=[
|
||||
TemplateState("binary_sensor.nestquest_carol_present_today", "on"),
|
||||
TemplateState("binary_sensor.nestquest_alice_present_today", "on"),
|
||||
],
|
||||
sensors=[
|
||||
TemplateState(
|
||||
"sensor.nestquest_carol_quests_due_today",
|
||||
"2",
|
||||
{"child_name": "Carol"},
|
||||
),
|
||||
TemplateState("sensor.nestquest_carol_quests_remaining_today", "0"),
|
||||
TemplateState(
|
||||
"sensor.nestquest_alice_quests_due_today",
|
||||
"3",
|
||||
{"child_name": "Alice"},
|
||||
),
|
||||
TemplateState("sensor.nestquest_alice_quests_remaining_today", "2"),
|
||||
],
|
||||
)
|
||||
rendered = render(morning_action(morning_summary())["message"], states=states)
|
||||
assert "Alice owes 2 quest(s) today." in rendered
|
||||
assert "Carol is all clear today (0 quests remaining)." in rendered
|
||||
|
||||
|
||||
def test_morning_summary_present_child_without_sensors_is_flagged() -> None:
|
||||
"""A present child with no Feature 10 sensors still gets a line."""
|
||||
states = make_states(
|
||||
binary_sensors=[
|
||||
TemplateState("binary_sensor.nestquest_frances_present_today", "on")
|
||||
],
|
||||
sensors=[],
|
||||
)
|
||||
rendered = render(morning_action(morning_summary())["message"], states=states)
|
||||
assert rendered == "Frances's quest count is unavailable today."
|
||||
|
||||
|
||||
def test_morning_summary_no_present_children() -> None:
|
||||
"""With nobody present the body says so rather than listing zeros."""
|
||||
states = make_states(
|
||||
binary_sensors=[
|
||||
TemplateState("binary_sensor.nestquest_alice_present_today", "off")
|
||||
],
|
||||
sensors=[
|
||||
TemplateState(
|
||||
"sensor.nestquest_alice_quests_due_today",
|
||||
"3",
|
||||
{"child_name": "Alice"},
|
||||
),
|
||||
TemplateState("sensor.nestquest_alice_quests_remaining_today", "3"),
|
||||
],
|
||||
)
|
||||
rendered = render(morning_action(morning_summary())["message"], states=states)
|
||||
assert rendered == "No children present today."
|
||||
|
||||
|
||||
def test_morning_summary_send_summary_toggle_renders() -> None:
|
||||
"""The enable condition renders truthy/false from the input value."""
|
||||
condition = morning_summary()["conditions"][0]
|
||||
assert render(condition["value_template"], send_summary=True).strip() == "True"
|
||||
assert render(condition["value_template"], send_summary=False).strip() == "False"
|
||||
Reference in New Issue
Block a user