1
0
mirror of https://github.com/esphome/esphome.git synced 2025-07-13 10:33:13 +01:00
Files
esphome/tests/integration/test_host_mode_empty_string_options.py

115 lines
4.9 KiB
Python

"""Integration test for protobuf encoding of empty string options in select entities."""
from __future__ import annotations
import asyncio
from aioesphomeapi import EntityState, SelectInfo
import pytest
from .types import APIClientConnectedFactory, RunCompiledFunction
@pytest.mark.asyncio
async def test_host_mode_empty_string_options(
yaml_config: str,
run_compiled: RunCompiledFunction,
api_client_connected: APIClientConnectedFactory,
) -> None:
"""Test that select entities with empty string options are correctly encoded in protobuf messages.
This tests the fix for the bug where the force parameter was not passed in encode_string,
causing empty strings in repeated fields to be skipped during encoding but included in
size calculation, leading to protobuf decoding errors.
"""
# Write, compile and run the ESPHome device, then connect to API
loop = asyncio.get_running_loop()
async with run_compiled(yaml_config), api_client_connected() as client:
# Verify we can get device info
device_info = await client.device_info()
assert device_info is not None
assert device_info.name == "host-empty-string-test"
# Get list of entities - this will encode ListEntitiesSelectResponse messages
# with empty string options that would trigger the bug
entity_info, services = await client.list_entities_services()
# Find our select entities
select_entities = [e for e in entity_info if isinstance(e, SelectInfo)]
assert len(select_entities) == 3, (
f"Expected 3 select entities, got {len(select_entities)}"
)
# Verify each select entity by name and check their options
selects_by_name = {e.name: e for e in select_entities}
# Check "Select Empty First" - empty string at beginning
assert "Select Empty First" in selects_by_name
empty_first = selects_by_name["Select Empty First"]
assert len(empty_first.options) == 4
assert empty_first.options[0] == "" # Empty string at beginning
assert empty_first.options[1] == "Option A"
assert empty_first.options[2] == "Option B"
assert empty_first.options[3] == "Option C"
# Check "Select Empty Middle" - empty string in middle
assert "Select Empty Middle" in selects_by_name
empty_middle = selects_by_name["Select Empty Middle"]
assert len(empty_middle.options) == 5
assert empty_middle.options[0] == "Option 1"
assert empty_middle.options[1] == "Option 2"
assert empty_middle.options[2] == "" # Empty string in middle
assert empty_middle.options[3] == "Option 3"
assert empty_middle.options[4] == "Option 4"
# Check "Select Empty Last" - empty string at end
assert "Select Empty Last" in selects_by_name
empty_last = selects_by_name["Select Empty Last"]
assert len(empty_last.options) == 4
assert empty_last.options[0] == "Choice X"
assert empty_last.options[1] == "Choice Y"
assert empty_last.options[2] == "Choice Z"
assert empty_last.options[3] == "" # Empty string at end
# If we got here without protobuf decoding errors, the fix is working
# The bug would have caused "Invalid protobuf message" errors with trailing bytes
# Also verify we can receive state updates for select entities
# This ensures empty strings work properly in state messages too
states: dict[int, EntityState] = {}
states_received_future: asyncio.Future[None] = loop.create_future()
expected_select_keys = {empty_first.key, empty_middle.key, empty_last.key}
received_select_keys = set()
def on_state(state: EntityState) -> None:
"""Track state changes."""
states[state.key] = state
# Track which select entities we've received states for
if state.key in expected_select_keys:
received_select_keys.add(state.key)
# Once we have all select states, we're done
if (
received_select_keys == expected_select_keys
and not states_received_future.done()
):
states_received_future.set_result(None)
client.subscribe_states(on_state)
# Wait for initial states with timeout
try:
await asyncio.wait_for(states_received_future, timeout=5.0)
except asyncio.TimeoutError:
pytest.fail(
f"Did not receive states for all select entities. "
f"Expected keys: {expected_select_keys}, Received: {received_select_keys}"
)
# Verify we received states for all select entities
assert empty_first.key in states
assert empty_middle.key in states
assert empty_last.key in states
# The main test is that we got here without protobuf errors
# The select entities with empty string options were properly encoded