[lock] Refactor trigger classes to template and add integration tests (#12193)

This commit is contained in:
J. Nick Koston
2025-11-30 17:09:02 -06:00
committed by GitHub
parent 8308bc2911
commit 82e1238330
3 changed files with 80 additions and 13 deletions

View File

@@ -0,0 +1,17 @@
esphome:
name: lock-automations-test
host:
api: # Port will be automatically injected
logger:
level: DEBUG
lock:
- platform: template
id: test_lock
name: "Test Lock"
optimistic: true
on_lock:
- logger.log: "TRIGGER: on_lock fired"
on_unlock:
- logger.log: "TRIGGER: on_unlock fired"

View File

@@ -0,0 +1,58 @@
"""Integration test for lock automation triggers.
Tests that on_lock and on_unlock triggers work correctly.
"""
import asyncio
import pytest
from .types import APIClientConnectedFactory, RunCompiledFunction
@pytest.mark.asyncio
async def test_lock_automations(
yaml_config: str,
run_compiled: RunCompiledFunction,
api_client_connected: APIClientConnectedFactory,
) -> None:
"""Test lock on_lock and on_unlock triggers."""
loop = asyncio.get_running_loop()
# Futures for log line detection
on_lock_future: asyncio.Future[bool] = loop.create_future()
on_unlock_future: asyncio.Future[bool] = loop.create_future()
def check_output(line: str) -> None:
"""Check log output for trigger messages."""
if "TRIGGER: on_lock fired" in line and not on_lock_future.done():
on_lock_future.set_result(True)
elif "TRIGGER: on_unlock fired" in line and not on_unlock_future.done():
on_unlock_future.set_result(True)
async with (
run_compiled(yaml_config, line_callback=check_output),
api_client_connected() as client,
):
# Import here to avoid import errors when aioesphomeapi is not installed
from aioesphomeapi import LockCommand
# Get entities
entities = await client.list_entities_services()
lock = next(e for e in entities[0] if e.object_id == "test_lock")
# Test 1: Lock - should trigger on_lock
client.lock_command(key=lock.key, command=LockCommand.LOCK)
try:
await asyncio.wait_for(on_lock_future, timeout=5.0)
except TimeoutError:
pytest.fail("on_lock trigger did not fire")
# Test 2: Unlock - should trigger on_unlock
client.lock_command(key=lock.key, command=LockCommand.UNLOCK)
try:
await asyncio.wait_for(on_unlock_future, timeout=5.0)
except TimeoutError:
pytest.fail("on_unlock trigger did not fire")