mirror of
https://github.com/home-assistant/core.git
synced 2026-02-22 10:55:50 +00:00
491 lines
16 KiB
Python
491 lines
16 KiB
Python
"""Define tests for the Brother Printer config flow."""
|
|
|
|
from ipaddress import ip_address
|
|
from unittest.mock import AsyncMock
|
|
|
|
from brother import SnmpError, UnsupportedModelError
|
|
import pytest
|
|
|
|
from homeassistant.components.brother.const import (
|
|
CONF_COMMUNITY,
|
|
DOMAIN,
|
|
SECTION_ADVANCED_SETTINGS,
|
|
)
|
|
from homeassistant.config_entries import SOURCE_USER, SOURCE_ZEROCONF
|
|
from homeassistant.const import CONF_HOST, CONF_PORT, CONF_TYPE
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.data_entry_flow import FlowResultType
|
|
from homeassistant.helpers.service_info.zeroconf import ZeroconfServiceInfo
|
|
|
|
from . import init_integration
|
|
|
|
from tests.common import MockConfigEntry
|
|
|
|
CONFIG = {
|
|
CONF_HOST: "127.0.0.1",
|
|
CONF_TYPE: "laser",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
}
|
|
|
|
pytestmark = pytest.mark.usefixtures("mock_setup_entry")
|
|
|
|
|
|
@pytest.mark.parametrize("host", ["example.local", "127.0.0.1", "2001:db8::1428:57ab"])
|
|
async def test_create_entry(
|
|
hass: HomeAssistant, host: str, mock_brother_client: AsyncMock
|
|
) -> None:
|
|
"""Test that the user step works with printer hostname/IPv4/IPv6."""
|
|
config = CONFIG.copy()
|
|
config[CONF_HOST] = host
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": SOURCE_USER}
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "user"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
flow_id=result["flow_id"],
|
|
user_input=config,
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.CREATE_ENTRY
|
|
assert result["title"] == "HL-L2340DW 0123456789"
|
|
assert result["data"][CONF_HOST] == host
|
|
assert result["data"][CONF_TYPE] == "laser"
|
|
assert result["data"][SECTION_ADVANCED_SETTINGS][CONF_PORT] == 161
|
|
assert result["data"][SECTION_ADVANCED_SETTINGS][CONF_COMMUNITY] == "public"
|
|
assert result["result"].unique_id == "0123456789"
|
|
|
|
|
|
async def test_invalid_hostname(
|
|
hass: HomeAssistant, mock_brother_client: AsyncMock
|
|
) -> None:
|
|
"""Test invalid hostname in user_input."""
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": SOURCE_USER}
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "user"
|
|
assert result["errors"] == {}
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
{
|
|
CONF_HOST: "invalid/hostname",
|
|
CONF_TYPE: "laser",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["errors"] == {CONF_HOST: "wrong_host"}
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
CONFIG,
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.CREATE_ENTRY
|
|
assert result["title"] == "HL-L2340DW 0123456789"
|
|
assert result["data"][CONF_HOST] == "127.0.0.1"
|
|
assert result["data"][CONF_TYPE] == "laser"
|
|
assert result["data"][SECTION_ADVANCED_SETTINGS][CONF_PORT] == 161
|
|
assert result["data"][SECTION_ADVANCED_SETTINGS][CONF_COMMUNITY] == "public"
|
|
assert result["result"].unique_id == "0123456789"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("exc", "base_error"),
|
|
[
|
|
(ConnectionError, "cannot_connect"),
|
|
(TimeoutError, "cannot_connect"),
|
|
(SnmpError("SNMP error"), "snmp_error"),
|
|
],
|
|
)
|
|
async def test_errors(
|
|
hass: HomeAssistant, exc: Exception, base_error: str, mock_brother_client: AsyncMock
|
|
) -> None:
|
|
"""Test connection to host error."""
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": SOURCE_USER}
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "user"
|
|
assert result["errors"] == {}
|
|
|
|
mock_brother_client.async_update.side_effect = exc
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
CONFIG,
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["errors"] == {"base": base_error}
|
|
|
|
mock_brother_client.async_update.side_effect = None
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
CONFIG,
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.CREATE_ENTRY
|
|
assert result["title"] == "HL-L2340DW 0123456789"
|
|
assert result["data"][CONF_HOST] == "127.0.0.1"
|
|
assert result["data"][CONF_TYPE] == "laser"
|
|
assert result["data"][SECTION_ADVANCED_SETTINGS][CONF_PORT] == 161
|
|
assert result["data"][SECTION_ADVANCED_SETTINGS][CONF_COMMUNITY] == "public"
|
|
assert result["result"].unique_id == "0123456789"
|
|
|
|
|
|
async def test_unsupported_model_error(
|
|
hass: HomeAssistant, mock_brother: AsyncMock, mock_brother_client: AsyncMock
|
|
) -> None:
|
|
"""Test unsupported printer model error."""
|
|
mock_brother.create.side_effect = UnsupportedModelError("error")
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": SOURCE_USER}, data=CONFIG
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "unsupported_model"
|
|
|
|
|
|
async def test_device_exists_abort(
|
|
hass: HomeAssistant,
|
|
mock_brother_client: AsyncMock,
|
|
mock_config_entry: MockConfigEntry,
|
|
) -> None:
|
|
"""Test we abort config flow if Brother printer already configured."""
|
|
await init_integration(hass, mock_config_entry)
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": SOURCE_USER}, data=CONFIG
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "already_configured"
|
|
|
|
|
|
@pytest.mark.parametrize("exc", [ConnectionError, TimeoutError, SnmpError("error")])
|
|
async def test_zeroconf_exception(
|
|
hass: HomeAssistant, exc: Exception, mock_brother_client: AsyncMock
|
|
) -> None:
|
|
"""Test we abort zeroconf flow on exception."""
|
|
mock_brother_client.async_update.side_effect = exc
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_ZEROCONF},
|
|
data=ZeroconfServiceInfo(
|
|
ip_address=ip_address("127.0.0.1"),
|
|
ip_addresses=[ip_address("127.0.0.1")],
|
|
hostname="example.local.",
|
|
name="Brother Printer",
|
|
port=None,
|
|
properties={},
|
|
type="mock_type",
|
|
),
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "cannot_connect"
|
|
|
|
|
|
async def test_zeroconf_unsupported_model(
|
|
hass: HomeAssistant, mock_brother: AsyncMock, mock_brother_client: AsyncMock
|
|
) -> None:
|
|
"""Test unsupported printer model error."""
|
|
mock_brother.create.side_effect = UnsupportedModelError("error")
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_ZEROCONF},
|
|
data=ZeroconfServiceInfo(
|
|
ip_address=ip_address("127.0.0.1"),
|
|
ip_addresses=[ip_address("127.0.0.1")],
|
|
hostname="example.local.",
|
|
name="Brother Printer",
|
|
port=None,
|
|
properties={"product": "MFC-8660DN"},
|
|
type="mock_type",
|
|
),
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "unsupported_model"
|
|
|
|
|
|
async def test_zeroconf_device_exists_abort(
|
|
hass: HomeAssistant,
|
|
mock_brother_client: AsyncMock,
|
|
mock_config_entry: MockConfigEntry,
|
|
) -> None:
|
|
"""Test we abort zeroconf flow if Brother printer already configured."""
|
|
await init_integration(hass, mock_config_entry)
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_ZEROCONF},
|
|
data=ZeroconfServiceInfo(
|
|
ip_address=ip_address("127.0.0.1"),
|
|
ip_addresses=[ip_address("127.0.0.1")],
|
|
hostname="example.local.",
|
|
name="Brother Printer",
|
|
port=None,
|
|
properties={},
|
|
type="mock_type",
|
|
),
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "already_configured"
|
|
|
|
# Test config entry got updated with latest IP
|
|
assert mock_config_entry.data[CONF_HOST] == "127.0.0.1"
|
|
|
|
|
|
async def test_zeroconf_no_probe_existing_device(
|
|
hass: HomeAssistant, mock_brother_client: AsyncMock
|
|
) -> None:
|
|
"""Test we do not probe the device is the host is already configured."""
|
|
entry = MockConfigEntry(domain=DOMAIN, unique_id="0123456789", data=CONFIG)
|
|
entry.add_to_hass(hass)
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_ZEROCONF},
|
|
data=ZeroconfServiceInfo(
|
|
ip_address=ip_address("127.0.0.1"),
|
|
ip_addresses=[ip_address("127.0.0.1")],
|
|
hostname="example.local.",
|
|
name="Brother Printer",
|
|
port=None,
|
|
properties={},
|
|
type="mock_type",
|
|
),
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "already_configured"
|
|
mock_brother_client.async_update.assert_not_called()
|
|
|
|
|
|
async def test_zeroconf_confirm_create_entry(
|
|
hass: HomeAssistant, mock_brother_client: AsyncMock
|
|
) -> None:
|
|
"""Test zeroconf confirmation and create config entry."""
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_ZEROCONF},
|
|
data=ZeroconfServiceInfo(
|
|
ip_address=ip_address("127.0.0.1"),
|
|
ip_addresses=[ip_address("127.0.0.1")],
|
|
hostname="example.local.",
|
|
name="Brother Printer",
|
|
port=None,
|
|
properties={},
|
|
type="mock_type",
|
|
),
|
|
)
|
|
|
|
assert result["step_id"] == "zeroconf_confirm"
|
|
assert result["description_placeholders"]["model"] == "HL-L2340DW"
|
|
assert result["description_placeholders"]["serial_number"] == "0123456789"
|
|
assert result["type"] is FlowResultType.FORM
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
CONF_TYPE: "laser",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.CREATE_ENTRY
|
|
assert result["title"] == "HL-L2340DW 0123456789"
|
|
assert result["data"][CONF_HOST] == "127.0.0.1"
|
|
assert result["data"][CONF_TYPE] == "laser"
|
|
assert result["data"][SECTION_ADVANCED_SETTINGS][CONF_PORT] == 161
|
|
assert result["data"][SECTION_ADVANCED_SETTINGS][CONF_COMMUNITY] == "public"
|
|
assert result["result"].unique_id == "0123456789"
|
|
|
|
|
|
async def test_reconfigure_successful(
|
|
hass: HomeAssistant,
|
|
mock_brother_client: AsyncMock,
|
|
mock_config_entry: MockConfigEntry,
|
|
) -> None:
|
|
"""Test starting a reconfigure flow."""
|
|
await init_integration(hass, mock_config_entry)
|
|
|
|
result = await mock_config_entry.start_reconfigure_flow(hass)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
CONF_HOST: "10.10.10.10",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "reconfigure_successful"
|
|
assert mock_config_entry.data == {
|
|
CONF_HOST: "10.10.10.10",
|
|
CONF_TYPE: "laser",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
}
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("exc", "base_error"),
|
|
[
|
|
(ConnectionError, "cannot_connect"),
|
|
(TimeoutError, "cannot_connect"),
|
|
(SnmpError("error"), "snmp_error"),
|
|
],
|
|
)
|
|
async def test_reconfigure_not_successful(
|
|
hass: HomeAssistant,
|
|
exc: Exception,
|
|
base_error: str,
|
|
mock_brother_client: AsyncMock,
|
|
mock_config_entry: MockConfigEntry,
|
|
) -> None:
|
|
"""Test starting a reconfigure flow but no connection found."""
|
|
await init_integration(hass, mock_config_entry)
|
|
|
|
result = await mock_config_entry.start_reconfigure_flow(hass)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
|
|
mock_brother_client.async_update.side_effect = exc
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
CONF_HOST: "10.10.10.10",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
assert result["errors"] == {"base": base_error}
|
|
|
|
mock_brother_client.async_update.side_effect = None
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
CONF_HOST: "10.10.10.10",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "reconfigure_successful"
|
|
assert mock_config_entry.data == {
|
|
CONF_HOST: "10.10.10.10",
|
|
CONF_TYPE: "laser",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
}
|
|
|
|
|
|
async def test_reconfigure_invalid_hostname(
|
|
hass: HomeAssistant,
|
|
mock_brother_client: AsyncMock,
|
|
mock_config_entry: MockConfigEntry,
|
|
) -> None:
|
|
"""Test starting a reconfigure flow but no connection found."""
|
|
await init_integration(hass, mock_config_entry)
|
|
|
|
result = await mock_config_entry.start_reconfigure_flow(hass)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
CONF_HOST: "invalid/hostname",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
assert result["errors"] == {CONF_HOST: "wrong_host"}
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
CONF_HOST: "10.10.10.10",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "reconfigure_successful"
|
|
assert mock_config_entry.data == {
|
|
CONF_HOST: "10.10.10.10",
|
|
CONF_TYPE: "laser",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
}
|
|
|
|
|
|
async def test_reconfigure_not_the_same_device(
|
|
hass: HomeAssistant,
|
|
mock_brother_client: AsyncMock,
|
|
mock_config_entry: MockConfigEntry,
|
|
) -> None:
|
|
"""Test starting the reconfiguration process, but with a different printer."""
|
|
await init_integration(hass, mock_config_entry)
|
|
|
|
result = await mock_config_entry.start_reconfigure_flow(hass)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
|
|
mock_brother_client.serial = "9876543210"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
CONF_HOST: "10.10.10.10",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.FORM
|
|
assert result["step_id"] == "reconfigure"
|
|
assert result["errors"] == {"base": "another_device"}
|
|
|
|
mock_brother_client.serial = "0123456789"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
CONF_HOST: "11.11.11.11",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
},
|
|
)
|
|
|
|
assert result["type"] is FlowResultType.ABORT
|
|
assert result["reason"] == "reconfigure_successful"
|
|
assert mock_config_entry.data == {
|
|
CONF_HOST: "11.11.11.11",
|
|
CONF_TYPE: "laser",
|
|
SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
|
|
}
|