74e7f7c879
* Update roomba config flow to walk users though pairing * Remove YAML support * adjust tests * increase cover * pylint * pylint
506 lines
17 KiB
Python
506 lines
17 KiB
Python
"""Test the iRobot Roomba config flow."""
|
|
from unittest.mock import MagicMock, PropertyMock, patch
|
|
|
|
from roombapy import RoombaConnectionError
|
|
from roombapy.roomba import RoombaInfo
|
|
|
|
from homeassistant import config_entries, data_entry_flow, setup
|
|
from homeassistant.components.roomba.const import (
|
|
CONF_BLID,
|
|
CONF_CONTINUOUS,
|
|
CONF_DELAY,
|
|
DOMAIN,
|
|
)
|
|
from homeassistant.const import CONF_HOST, CONF_PASSWORD
|
|
|
|
from tests.common import MockConfigEntry
|
|
|
|
MOCK_IP = "1.2.3.4"
|
|
VALID_CONFIG = {CONF_HOST: "1.2.3.4", CONF_BLID: "blid", CONF_PASSWORD: "password"}
|
|
|
|
|
|
def _create_mocked_roomba(
|
|
roomba_connected=None, master_state=None, connect=None, disconnect=None
|
|
):
|
|
mocked_roomba = MagicMock()
|
|
type(mocked_roomba).roomba_connected = PropertyMock(return_value=roomba_connected)
|
|
type(mocked_roomba).master_state = PropertyMock(return_value=master_state)
|
|
type(mocked_roomba).connect = MagicMock(side_effect=connect)
|
|
type(mocked_roomba).disconnect = MagicMock(side_effect=disconnect)
|
|
return mocked_roomba
|
|
|
|
|
|
def _mocked_discovery(*_):
|
|
roomba_discovery = MagicMock()
|
|
|
|
roomba = RoombaInfo(
|
|
hostname="iRobot-blid",
|
|
robot_name="robot_name",
|
|
ip=MOCK_IP,
|
|
mac="mac",
|
|
firmware="firmware",
|
|
sku="sku",
|
|
capabilities="capabilities",
|
|
)
|
|
|
|
roomba_discovery.get_all = MagicMock(return_value=[roomba])
|
|
return roomba_discovery
|
|
|
|
|
|
def _mocked_failed_discovery(*_):
|
|
roomba_discovery = MagicMock()
|
|
roomba_discovery.get_all = MagicMock(return_value=[])
|
|
return roomba_discovery
|
|
|
|
|
|
def _mocked_getpassword(*_):
|
|
roomba_password = MagicMock()
|
|
roomba_password.get_password = MagicMock(return_value="password")
|
|
return roomba_password
|
|
|
|
|
|
def _mocked_failed_getpassword(*_):
|
|
roomba_password = MagicMock()
|
|
roomba_password.get_password = MagicMock(return_value=None)
|
|
return roomba_password
|
|
|
|
|
|
async def test_form_user_discovery_and_password_fetch(hass):
|
|
"""Test we can discovery and fetch the password."""
|
|
await setup.async_setup_component(hass, "persistent_notification", {})
|
|
|
|
mocked_roomba = _create_mocked_roomba(
|
|
roomba_connected=True,
|
|
master_state={"state": {"reported": {"name": "myroomba"}}},
|
|
)
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaDiscovery", _mocked_discovery
|
|
):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": config_entries.SOURCE_USER}
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["errors"] is None
|
|
assert result["step_id"] == "init"
|
|
|
|
result2 = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
{CONF_HOST: MOCK_IP},
|
|
)
|
|
await hass.async_block_till_done()
|
|
assert result2["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result2["errors"] is None
|
|
assert result2["step_id"] == "link"
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.Roomba",
|
|
return_value=mocked_roomba,
|
|
), patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaPassword",
|
|
_mocked_getpassword,
|
|
), patch(
|
|
"homeassistant.components.roomba.async_setup", return_value=True
|
|
) as mock_setup, patch(
|
|
"homeassistant.components.roomba.async_setup_entry",
|
|
return_value=True,
|
|
) as mock_setup_entry:
|
|
result3 = await hass.config_entries.flow.async_configure(
|
|
result2["flow_id"],
|
|
{},
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result3["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
|
assert result3["title"] == "robot_name"
|
|
assert result3["result"].unique_id == "blid"
|
|
assert result3["data"] == {
|
|
CONF_BLID: "blid",
|
|
CONF_CONTINUOUS: True,
|
|
CONF_DELAY: 1,
|
|
CONF_HOST: MOCK_IP,
|
|
CONF_PASSWORD: "password",
|
|
}
|
|
assert len(mock_setup.mock_calls) == 1
|
|
assert len(mock_setup_entry.mock_calls) == 1
|
|
|
|
|
|
async def test_form_user_discovery_skips_known(hass):
|
|
"""Test discovery proceeds to manual if all discovered are already known."""
|
|
await setup.async_setup_component(hass, "persistent_notification", {})
|
|
|
|
entry = MockConfigEntry(domain=DOMAIN, data=VALID_CONFIG, unique_id="blid")
|
|
entry.add_to_hass(hass)
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaDiscovery", _mocked_discovery
|
|
):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": config_entries.SOURCE_USER}
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["errors"] is None
|
|
assert result["step_id"] == "manual"
|
|
|
|
|
|
async def test_form_user_failed_discovery_aborts_already_configured(hass):
|
|
"""Test if we manually configure an existing host we abort."""
|
|
await setup.async_setup_component(hass, "persistent_notification", {})
|
|
|
|
entry = MockConfigEntry(domain=DOMAIN, data=VALID_CONFIG, unique_id="blid")
|
|
entry.add_to_hass(hass)
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaDiscovery",
|
|
_mocked_failed_discovery,
|
|
):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": config_entries.SOURCE_USER}
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["errors"] is None
|
|
assert result["step_id"] == "manual"
|
|
|
|
result2 = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
{CONF_HOST: MOCK_IP, CONF_BLID: "blid"},
|
|
)
|
|
await hass.async_block_till_done()
|
|
assert result2["type"] == data_entry_flow.RESULT_TYPE_ABORT
|
|
assert result2["reason"] == "already_configured"
|
|
|
|
|
|
async def test_form_user_discovery_manual_and_auto_password_fetch(hass):
|
|
"""Test discovery skipped and we can auto fetch the password."""
|
|
await setup.async_setup_component(hass, "persistent_notification", {})
|
|
|
|
mocked_roomba = _create_mocked_roomba(
|
|
roomba_connected=True,
|
|
master_state={"state": {"reported": {"name": "myroomba"}}},
|
|
)
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaDiscovery", _mocked_discovery
|
|
):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": config_entries.SOURCE_USER}
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["errors"] is None
|
|
assert result["step_id"] == "init"
|
|
|
|
result2 = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
{CONF_HOST: None},
|
|
)
|
|
await hass.async_block_till_done()
|
|
assert result2["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result2["errors"] is None
|
|
assert result2["step_id"] == "manual"
|
|
|
|
result3 = await hass.config_entries.flow.async_configure(
|
|
result2["flow_id"],
|
|
{CONF_HOST: MOCK_IP, CONF_BLID: "blid"},
|
|
)
|
|
await hass.async_block_till_done()
|
|
assert result3["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result3["errors"] is None
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.Roomba",
|
|
return_value=mocked_roomba,
|
|
), patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaPassword",
|
|
_mocked_getpassword,
|
|
), patch(
|
|
"homeassistant.components.roomba.async_setup", return_value=True
|
|
) as mock_setup, patch(
|
|
"homeassistant.components.roomba.async_setup_entry",
|
|
return_value=True,
|
|
) as mock_setup_entry:
|
|
result4 = await hass.config_entries.flow.async_configure(
|
|
result3["flow_id"],
|
|
{},
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result4["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
|
assert result4["title"] == "myroomba"
|
|
assert result4["result"].unique_id == "blid"
|
|
assert result4["data"] == {
|
|
CONF_BLID: "blid",
|
|
CONF_CONTINUOUS: True,
|
|
CONF_DELAY: 1,
|
|
CONF_HOST: MOCK_IP,
|
|
CONF_PASSWORD: "password",
|
|
}
|
|
assert len(mock_setup.mock_calls) == 1
|
|
assert len(mock_setup_entry.mock_calls) == 1
|
|
|
|
|
|
async def test_form_user_discovery_manual_and_auto_password_fetch_but_cannot_connect(
|
|
hass,
|
|
):
|
|
"""Test discovery skipped and we can auto fetch the password then we fail to connect."""
|
|
await setup.async_setup_component(hass, "persistent_notification", {})
|
|
|
|
mocked_roomba = _create_mocked_roomba(
|
|
connect=RoombaConnectionError,
|
|
roomba_connected=True,
|
|
master_state={"state": {"reported": {"name": "myroomba"}}},
|
|
)
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaDiscovery", _mocked_discovery
|
|
):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": config_entries.SOURCE_USER}
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["errors"] is None
|
|
assert result["step_id"] == "init"
|
|
|
|
result2 = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
{CONF_HOST: None},
|
|
)
|
|
await hass.async_block_till_done()
|
|
assert result2["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result2["errors"] is None
|
|
assert result2["step_id"] == "manual"
|
|
|
|
result3 = await hass.config_entries.flow.async_configure(
|
|
result2["flow_id"],
|
|
{CONF_HOST: MOCK_IP, CONF_BLID: "blid"},
|
|
)
|
|
await hass.async_block_till_done()
|
|
assert result3["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result3["errors"] is None
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.Roomba",
|
|
return_value=mocked_roomba,
|
|
), patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaPassword",
|
|
_mocked_getpassword,
|
|
), patch(
|
|
"homeassistant.components.roomba.async_setup", return_value=True
|
|
) as mock_setup, patch(
|
|
"homeassistant.components.roomba.async_setup_entry",
|
|
return_value=True,
|
|
) as mock_setup_entry:
|
|
result4 = await hass.config_entries.flow.async_configure(
|
|
result3["flow_id"],
|
|
{},
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result4["type"] == data_entry_flow.RESULT_TYPE_ABORT
|
|
assert result4["reason"] == "cannot_connect"
|
|
assert len(mock_setup.mock_calls) == 0
|
|
assert len(mock_setup_entry.mock_calls) == 0
|
|
|
|
|
|
async def test_form_user_discovery_fails_and_auto_password_fetch(hass):
|
|
"""Test discovery fails and we can auto fetch the password."""
|
|
await setup.async_setup_component(hass, "persistent_notification", {})
|
|
|
|
mocked_roomba = _create_mocked_roomba(
|
|
roomba_connected=True,
|
|
master_state={"state": {"reported": {"name": "myroomba"}}},
|
|
)
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaDiscovery",
|
|
_mocked_failed_discovery,
|
|
):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": config_entries.SOURCE_USER}
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["errors"] is None
|
|
assert result["step_id"] == "manual"
|
|
|
|
result2 = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
{CONF_HOST: MOCK_IP, CONF_BLID: "blid"},
|
|
)
|
|
await hass.async_block_till_done()
|
|
assert result2["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result2["errors"] is None
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.Roomba",
|
|
return_value=mocked_roomba,
|
|
), patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaPassword",
|
|
_mocked_getpassword,
|
|
), patch(
|
|
"homeassistant.components.roomba.async_setup", return_value=True
|
|
) as mock_setup, patch(
|
|
"homeassistant.components.roomba.async_setup_entry",
|
|
return_value=True,
|
|
) as mock_setup_entry:
|
|
result3 = await hass.config_entries.flow.async_configure(
|
|
result2["flow_id"],
|
|
{},
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result3["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
|
assert result3["title"] == "myroomba"
|
|
assert result3["result"].unique_id == "blid"
|
|
assert result3["data"] == {
|
|
CONF_BLID: "blid",
|
|
CONF_CONTINUOUS: True,
|
|
CONF_DELAY: 1,
|
|
CONF_HOST: MOCK_IP,
|
|
CONF_PASSWORD: "password",
|
|
}
|
|
assert len(mock_setup.mock_calls) == 1
|
|
assert len(mock_setup_entry.mock_calls) == 1
|
|
|
|
|
|
async def test_form_user_discovery_fails_and_password_fetch_fails(hass):
|
|
"""Test discovery fails and password fetch fails."""
|
|
await setup.async_setup_component(hass, "persistent_notification", {})
|
|
|
|
mocked_roomba = _create_mocked_roomba(
|
|
roomba_connected=True,
|
|
master_state={"state": {"reported": {"name": "myroomba"}}},
|
|
)
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaDiscovery",
|
|
_mocked_failed_discovery,
|
|
):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": config_entries.SOURCE_USER}
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["errors"] is None
|
|
assert result["step_id"] == "manual"
|
|
|
|
result2 = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
{CONF_HOST: MOCK_IP, CONF_BLID: "blid"},
|
|
)
|
|
await hass.async_block_till_done()
|
|
assert result2["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result2["errors"] is None
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaPassword",
|
|
_mocked_failed_getpassword,
|
|
):
|
|
result3 = await hass.config_entries.flow.async_configure(
|
|
result2["flow_id"],
|
|
{},
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.Roomba",
|
|
return_value=mocked_roomba,
|
|
), patch(
|
|
"homeassistant.components.roomba.async_setup", return_value=True
|
|
) as mock_setup, patch(
|
|
"homeassistant.components.roomba.async_setup_entry",
|
|
return_value=True,
|
|
) as mock_setup_entry:
|
|
result4 = await hass.config_entries.flow.async_configure(
|
|
result3["flow_id"],
|
|
{CONF_PASSWORD: "password"},
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result4["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
|
assert result4["title"] == "myroomba"
|
|
assert result4["result"].unique_id == "blid"
|
|
assert result4["data"] == {
|
|
CONF_BLID: "blid",
|
|
CONF_CONTINUOUS: True,
|
|
CONF_DELAY: 1,
|
|
CONF_HOST: MOCK_IP,
|
|
CONF_PASSWORD: "password",
|
|
}
|
|
assert len(mock_setup.mock_calls) == 1
|
|
assert len(mock_setup_entry.mock_calls) == 1
|
|
|
|
|
|
async def test_form_user_discovery_fails_and_password_fetch_fails_and_cannot_connect(
|
|
hass,
|
|
):
|
|
"""Test discovery fails and password fetch fails then we cannot connect."""
|
|
await setup.async_setup_component(hass, "persistent_notification", {})
|
|
|
|
mocked_roomba = _create_mocked_roomba(
|
|
connect=RoombaConnectionError,
|
|
roomba_connected=True,
|
|
master_state={"state": {"reported": {"name": "myroomba"}}},
|
|
)
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaDiscovery",
|
|
_mocked_failed_discovery,
|
|
):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": config_entries.SOURCE_USER}
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["errors"] is None
|
|
assert result["step_id"] == "manual"
|
|
|
|
result2 = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"],
|
|
{CONF_HOST: MOCK_IP, CONF_BLID: "blid"},
|
|
)
|
|
await hass.async_block_till_done()
|
|
assert result2["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result2["errors"] is None
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.RoombaPassword",
|
|
_mocked_failed_getpassword,
|
|
):
|
|
result3 = await hass.config_entries.flow.async_configure(
|
|
result2["flow_id"],
|
|
{},
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
with patch(
|
|
"homeassistant.components.roomba.config_flow.Roomba",
|
|
return_value=mocked_roomba,
|
|
), patch(
|
|
"homeassistant.components.roomba.async_setup", return_value=True
|
|
) as mock_setup, patch(
|
|
"homeassistant.components.roomba.async_setup_entry",
|
|
return_value=True,
|
|
) as mock_setup_entry:
|
|
result4 = await hass.config_entries.flow.async_configure(
|
|
result3["flow_id"],
|
|
{CONF_PASSWORD: "password"},
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert result4["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result4["errors"] == {"base": "cannot_connect"}
|
|
assert len(mock_setup.mock_calls) == 0
|
|
assert len(mock_setup_entry.mock_calls) == 0
|