mirror of
https://github.com/home-assistant/core.git
synced 2026-09-07 14:01:20 +01:00
Christophe GagnierandMoustachauve
d4c7e19419
Co-authored-by: Moustachauve <2206577+Moustachauve@users.noreply.github.com>
295 lines
10 KiB
Python
295 lines
10 KiB
Python
"""Tests for the Hot Spring config flow."""
|
|
|
|
import dataclasses
|
|
from ipaddress import ip_address
|
|
from unittest.mock import MagicMock
|
|
|
|
from hotspring import HotSpringConnectionError, HotSpringError, Spa
|
|
import pytest
|
|
|
|
from homeassistant.components.hotspring.const import DOMAIN
|
|
from homeassistant.config_entries import SOURCE_USER, SOURCE_ZEROCONF
|
|
from homeassistant.const import CONF_HOST
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.data_entry_flow import FlowResultType
|
|
from homeassistant.helpers.service_info.zeroconf import ZeroconfServiceInfo
|
|
|
|
from tests.common import MockConfigEntry, get_schema_suggested_value
|
|
|
|
MOCK_ZEROCONF_DATA = ZeroconfServiceInfo(
|
|
ip_address=ip_address("192.168.1.100"),
|
|
ip_addresses=[ip_address("192.168.1.100")],
|
|
hostname="Watkins_SpaAABBCCDDEEFF.local.",
|
|
name="Watkins_SpaAABBCCDDEEFF._ws._tcp.local.",
|
|
port=80,
|
|
properties={},
|
|
type="_ws._tcp.local.",
|
|
)
|
|
|
|
|
|
@pytest.mark.usefixtures("mock_setup_entry", "mock_hotspring")
|
|
async def test_full_user_flow_implementation(hass: HomeAssistant) -> None:
|
|
"""Test the full manual user flow from start to finish."""
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_USER},
|
|
)
|
|
|
|
assert result["step_id"] == "user"
|
|
assert result["type"] is FlowResultType.FORM
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], user_input={CONF_HOST: "192.168.1.100"}
|
|
)
|
|
|
|
assert result["title"] == "ConnectedSpa_DDEEFF"
|
|
assert result["type"] is FlowResultType.CREATE_ENTRY
|
|
assert result["data"] == {CONF_HOST: "192.168.1.100"}
|
|
assert result["result"].unique_id == "AA:BB:CC:DD:EE:FF"
|
|
|
|
|
|
@pytest.mark.usefixtures("mock_hotspring")
|
|
async def test_user_device_exists_abort(
|
|
hass: HomeAssistant,
|
|
mock_config_entry: MockConfigEntry,
|
|
) -> None:
|
|
"""Test we abort the config flow if Hot Spring spa is already configured."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_USER},
|
|
)
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], user_input={CONF_HOST: "192.168.1.200"}
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "already_configured"
|
|
assert mock_config_entry.data[CONF_HOST] == "192.168.1.200"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"exception",
|
|
[HotSpringConnectionError, HotSpringError],
|
|
)
|
|
@pytest.mark.usefixtures("mock_setup_entry")
|
|
async def test_form_cannot_connect(
|
|
hass: HomeAssistant, mock_hotspring: MagicMock, exception: type[Exception]
|
|
) -> None:
|
|
"""Test we show user form on Hot Spring connection error and recover."""
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_USER},
|
|
)
|
|
|
|
assert result["step_id"] == "user"
|
|
assert result["type"] is FlowResultType.FORM
|
|
|
|
mock_hotspring.update.side_effect = exception
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], user_input={CONF_HOST: "192.168.1.100"}
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "user"
|
|
assert result["errors"] == {"base": "cannot_connect"}
|
|
|
|
mock_hotspring.update.side_effect = None
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], user_input={CONF_HOST: "192.168.1.100"}
|
|
)
|
|
|
|
assert result["title"] == "ConnectedSpa_DDEEFF"
|
|
assert result["type"] is FlowResultType.CREATE_ENTRY
|
|
assert result["data"] == {CONF_HOST: "192.168.1.100"}
|
|
assert result["result"].unique_id == "AA:BB:CC:DD:EE:FF"
|
|
|
|
|
|
@pytest.mark.usefixtures("mock_setup_entry")
|
|
async def test_form_no_mac_address(
|
|
hass: HomeAssistant, mock_hotspring: MagicMock, device_fixture: Spa
|
|
) -> None:
|
|
"""Test we show user form on missing MAC address and recover."""
|
|
device_fixture.info.root_topic = "unknownTopic123"
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_USER},
|
|
)
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], user_input={CONF_HOST: "192.168.1.100"}
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "user"
|
|
assert result["errors"] == {"base": "cannot_connect"}
|
|
|
|
device_fixture.info.root_topic = "mySpaAABBCCDDEEFF"
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], user_input={CONF_HOST: "192.168.1.100"}
|
|
)
|
|
|
|
assert result["title"] == "ConnectedSpa_DDEEFF"
|
|
assert result["type"] is FlowResultType.CREATE_ENTRY
|
|
assert result["data"] == {CONF_HOST: "192.168.1.100"}
|
|
assert result["result"].unique_id == "AA:BB:CC:DD:EE:FF"
|
|
|
|
|
|
@pytest.mark.usefixtures("mock_setup_entry", "mock_hotspring")
|
|
async def test_full_zeroconf_flow_implementation(hass: HomeAssistant) -> None:
|
|
"""Test the full zeroconf flow from start to finish."""
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_ZEROCONF},
|
|
data=MOCK_ZEROCONF_DATA,
|
|
)
|
|
|
|
assert result["step_id"] == "zeroconf_confirm"
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["description_placeholders"] == {"name": "ConnectedSpa_DDEEFF"}
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], user_input={}
|
|
)
|
|
|
|
assert result["title"] == "ConnectedSpa_DDEEFF"
|
|
assert result["type"] is FlowResultType.CREATE_ENTRY
|
|
assert result["data"] == {CONF_HOST: "192.168.1.100"}
|
|
assert result["result"].unique_id == "AA:BB:CC:DD:EE:FF"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"exception",
|
|
[HotSpringConnectionError, HotSpringError],
|
|
)
|
|
async def test_zeroconf_connection_error(
|
|
hass: HomeAssistant, mock_hotspring: MagicMock, exception: type[Exception]
|
|
) -> None:
|
|
"""Test we abort zeroconf flow on Hot Spring connection error."""
|
|
mock_hotspring.update.side_effect = exception
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_ZEROCONF},
|
|
data=MOCK_ZEROCONF_DATA,
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "cannot_connect"
|
|
|
|
|
|
@pytest.mark.usefixtures("mock_hotspring")
|
|
async def test_zeroconf_device_already_configured(
|
|
hass: HomeAssistant,
|
|
mock_config_entry: MockConfigEntry,
|
|
) -> None:
|
|
"""Test we abort zeroconf flow and update host if already configured."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_ZEROCONF},
|
|
data=dataclasses.replace(
|
|
MOCK_ZEROCONF_DATA,
|
|
ip_address=ip_address("192.168.1.200"),
|
|
ip_addresses=[ip_address("192.168.1.200")],
|
|
),
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "already_configured"
|
|
assert mock_config_entry.data[CONF_HOST] == "192.168.1.200"
|
|
|
|
|
|
@pytest.mark.usefixtures("mock_setup_entry")
|
|
async def test_full_reconfigure_flow_success(
|
|
hass: HomeAssistant,
|
|
mock_config_entry: MockConfigEntry,
|
|
mock_hotspring: MagicMock,
|
|
) -> None:
|
|
"""Test the full reconfigure flow from start to finish."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
|
|
result = await mock_config_entry.start_reconfigure_flow(hass)
|
|
|
|
assert result["step_id"] == "user"
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["data_schema"] is not None
|
|
assert (
|
|
get_schema_suggested_value(result["data_schema"].schema, CONF_HOST)
|
|
== "192.168.1.100"
|
|
)
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], user_input={CONF_HOST: "192.168.1.200"}
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "reconfigure_successful"
|
|
|
|
assert mock_config_entry.data[CONF_HOST] == "192.168.1.200"
|
|
|
|
|
|
async def test_full_reconfigure_flow_unique_id_mismatch(
|
|
hass: HomeAssistant,
|
|
mock_config_entry: MockConfigEntry,
|
|
mock_hotspring: MagicMock,
|
|
device_fixture: Spa,
|
|
) -> None:
|
|
"""Test reconfiguration failure when the unique ID changes."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
device_fixture.info.root_topic = "mySpa112233445566"
|
|
|
|
result = await mock_config_entry.start_reconfigure_flow(hass)
|
|
|
|
assert result["step_id"] == "user"
|
|
assert result["type"] is FlowResultType.FORM
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], user_input={CONF_HOST: "192.168.1.200"}
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "unique_id_mismatch"
|
|
|
|
|
|
@pytest.mark.usefixtures("mock_setup_entry")
|
|
async def test_full_reconfigure_flow_connection_error_and_success(
|
|
hass: HomeAssistant,
|
|
mock_config_entry: MockConfigEntry,
|
|
mock_hotspring: MagicMock,
|
|
) -> None:
|
|
"""Test reconfigure flow with connection error and recovery."""
|
|
mock_config_entry.add_to_hass(hass)
|
|
|
|
result = await mock_config_entry.start_reconfigure_flow(hass)
|
|
|
|
assert result["step_id"] == "user"
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["data_schema"] is not None
|
|
assert (
|
|
get_schema_suggested_value(result["data_schema"].schema, CONF_HOST)
|
|
== "192.168.1.100"
|
|
)
|
|
|
|
mock_hotspring.update.side_effect = HotSpringConnectionError
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], user_input={CONF_HOST: "192.168.1.200"}
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "user"
|
|
assert result["errors"] == {"base": "cannot_connect"}
|
|
assert result["data_schema"] is not None
|
|
assert (
|
|
get_schema_suggested_value(result["data_schema"].schema, CONF_HOST)
|
|
== "192.168.1.200"
|
|
)
|
|
|
|
mock_hotspring.update.side_effect = None
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], user_input={CONF_HOST: "192.168.1.200"}
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "reconfigure_successful"
|
|
assert mock_config_entry.data[CONF_HOST] == "192.168.1.200"
|