Add Risco integration (#36930)
* Risco integration * Fix lint errors * Raise ConfigEntryNotReady if can't connect * Gracefully handle shutdown * pass session to pyrisco * minor change to init * Fix retries * Add exception log * Remove retries * Address code review comments * Remove log
This commit is contained in:
1 parent
83b9c6188d
commit
1b8d9f7cc4
13 files changed
+706
No files matched your search
@@ -0,0 +1 @@
|
||||
"""Tests for the Risco integration."""
|
||||
@@ -0,0 +1,237 @@
|
||||
"""Tests for the Risco alarm control panel device."""
|
||||
import pytest
|
||||
|
||||
from homeassistant.components.alarm_control_panel import DOMAIN as ALARM_DOMAIN
|
||||
from homeassistant.components.risco import CannotConnectError, UnauthorizedError
|
||||
from homeassistant.components.risco.const import DOMAIN
|
||||
from homeassistant.const import (
|
||||
CONF_PASSWORD,
|
||||
CONF_PIN,
|
||||
CONF_USERNAME,
|
||||
SERVICE_ALARM_ARM_AWAY,
|
||||
SERVICE_ALARM_ARM_CUSTOM_BYPASS,
|
||||
SERVICE_ALARM_ARM_HOME,
|
||||
SERVICE_ALARM_ARM_NIGHT,
|
||||
SERVICE_ALARM_DISARM,
|
||||
STATE_ALARM_ARMED_AWAY,
|
||||
STATE_ALARM_ARMED_HOME,
|
||||
STATE_ALARM_ARMING,
|
||||
STATE_ALARM_DISARMED,
|
||||
STATE_ALARM_TRIGGERED,
|
||||
STATE_UNKNOWN,
|
||||
)
|
||||
from homeassistant.helpers.entity_component import async_update_entity
|
||||
|
||||
from tests.async_mock import AsyncMock, MagicMock, PropertyMock, patch
|
||||
from tests.common import MockConfigEntry
|
||||
|
||||
TEST_CONFIG = {
|
||||
CONF_USERNAME: "test-username",
|
||||
CONF_PASSWORD: "test-password",
|
||||
CONF_PIN: "1234",
|
||||
}
|
||||
TEST_SITE_UUID = "test-site-uuid"
|
||||
TEST_SITE_NAME = "test-site-name"
|
||||
FIRST_ENTITY_ID = "alarm_control_panel.risco_test_site_name_partition_0"
|
||||
SECOND_ENTITY_ID = "alarm_control_panel.risco_test_site_name_partition_1"
|
||||
|
||||
|
||||
def _partition_mock():
|
||||
return MagicMock(
|
||||
triggered=False,
|
||||
arming=False,
|
||||
armed=False,
|
||||
disarmed=False,
|
||||
partially_armed=False,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def two_part_alarm():
|
||||
"""Fixture to mock alarm with two partitions."""
|
||||
partition_mocks = {0: _partition_mock(), 1: _partition_mock()}
|
||||
alarm_mock = MagicMock()
|
||||
with patch.object(
|
||||
partition_mocks[0], "id", new_callable=PropertyMock(return_value=0)
|
||||
), patch.object(
|
||||
partition_mocks[1], "id", new_callable=PropertyMock(return_value=1)
|
||||
), patch.object(
|
||||
alarm_mock,
|
||||
"partitions",
|
||||
new_callable=PropertyMock(return_value=partition_mocks),
|
||||
), patch(
|
||||
"homeassistant.components.risco.RiscoAPI.get_state",
|
||||
AsyncMock(return_value=alarm_mock),
|
||||
):
|
||||
yield alarm_mock
|
||||
|
||||
|
||||
async def _setup_risco(hass, alarm=MagicMock()):
|
||||
config_entry = MockConfigEntry(domain=DOMAIN, data=TEST_CONFIG)
|
||||
with patch(
|
||||
"homeassistant.components.risco.RiscoAPI.login", return_value=True,
|
||||
), patch(
|
||||
"homeassistant.components.risco.RiscoAPI.site_uuid",
|
||||
new_callable=PropertyMock(return_value=TEST_SITE_UUID),
|
||||
), patch(
|
||||
"homeassistant.components.risco.RiscoAPI.site_name",
|
||||
new_callable=PropertyMock(return_value=TEST_SITE_NAME),
|
||||
), patch(
|
||||
"homeassistant.components.risco.RiscoAPI.close", AsyncMock()
|
||||
):
|
||||
config_entry.add_to_hass(hass)
|
||||
await hass.config_entries.async_setup(config_entry.entry_id)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
return config_entry
|
||||
|
||||
|
||||
async def test_cannot_connect(hass):
|
||||
"""Test connection error."""
|
||||
|
||||
with patch(
|
||||
"homeassistant.components.risco.RiscoAPI.login", side_effect=CannotConnectError,
|
||||
):
|
||||
config_entry = MockConfigEntry(domain=DOMAIN, data=TEST_CONFIG)
|
||||
config_entry.add_to_hass(hass)
|
||||
await hass.config_entries.async_setup(config_entry.entry_id)
|
||||
await hass.async_block_till_done()
|
||||
registry = await hass.helpers.entity_registry.async_get_registry()
|
||||
assert not registry.async_is_registered(FIRST_ENTITY_ID)
|
||||
assert not registry.async_is_registered(SECOND_ENTITY_ID)
|
||||
|
||||
|
||||
async def test_unauthorized(hass):
|
||||
"""Test unauthorized error."""
|
||||
|
||||
with patch(
|
||||
"homeassistant.components.risco.RiscoAPI.login", side_effect=UnauthorizedError,
|
||||
):
|
||||
config_entry = MockConfigEntry(domain=DOMAIN, data=TEST_CONFIG)
|
||||
config_entry.add_to_hass(hass)
|
||||
await hass.config_entries.async_setup(config_entry.entry_id)
|
||||
await hass.async_block_till_done()
|
||||
registry = await hass.helpers.entity_registry.async_get_registry()
|
||||
assert not registry.async_is_registered(FIRST_ENTITY_ID)
|
||||
assert not registry.async_is_registered(SECOND_ENTITY_ID)
|
||||
|
||||
|
||||
async def test_setup(hass, two_part_alarm):
|
||||
"""Test entity setup."""
|
||||
registry = await hass.helpers.entity_registry.async_get_registry()
|
||||
|
||||
assert not registry.async_is_registered(FIRST_ENTITY_ID)
|
||||
assert not registry.async_is_registered(SECOND_ENTITY_ID)
|
||||
|
||||
await _setup_risco(hass, two_part_alarm)
|
||||
|
||||
assert registry.async_is_registered(FIRST_ENTITY_ID)
|
||||
assert registry.async_is_registered(SECOND_ENTITY_ID)
|
||||
|
||||
registry = await hass.helpers.device_registry.async_get_registry()
|
||||
device = registry.async_get_device({(DOMAIN, TEST_SITE_UUID + "_0")}, {})
|
||||
assert device is not None
|
||||
assert device.manufacturer == "Risco"
|
||||
|
||||
device = registry.async_get_device({(DOMAIN, TEST_SITE_UUID + "_1")}, {})
|
||||
assert device is not None
|
||||
assert device.manufacturer == "Risco"
|
||||
|
||||
|
||||
async def _check_state(hass, alarm, property, state, entity_id, partition_id):
|
||||
with patch.object(alarm.partitions[partition_id], property, return_value=True):
|
||||
await async_update_entity(hass, entity_id)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert hass.states.get(entity_id).state == state
|
||||
|
||||
|
||||
async def test_states(hass, two_part_alarm):
|
||||
"""Test the various alarm states."""
|
||||
await _setup_risco(hass, two_part_alarm)
|
||||
|
||||
assert hass.states.get(FIRST_ENTITY_ID).state == STATE_UNKNOWN
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "triggered", STATE_ALARM_TRIGGERED, FIRST_ENTITY_ID, 0
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "triggered", STATE_ALARM_TRIGGERED, SECOND_ENTITY_ID, 1
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "arming", STATE_ALARM_ARMING, FIRST_ENTITY_ID, 0
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "arming", STATE_ALARM_ARMING, SECOND_ENTITY_ID, 1
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "armed", STATE_ALARM_ARMED_AWAY, FIRST_ENTITY_ID, 0
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "armed", STATE_ALARM_ARMED_AWAY, SECOND_ENTITY_ID, 1
|
||||
)
|
||||
await _check_state(
|
||||
hass,
|
||||
two_part_alarm,
|
||||
"partially_armed",
|
||||
STATE_ALARM_ARMED_HOME,
|
||||
FIRST_ENTITY_ID,
|
||||
0,
|
||||
)
|
||||
await _check_state(
|
||||
hass,
|
||||
two_part_alarm,
|
||||
"partially_armed",
|
||||
STATE_ALARM_ARMED_HOME,
|
||||
SECOND_ENTITY_ID,
|
||||
1,
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "disarmed", STATE_ALARM_DISARMED, FIRST_ENTITY_ID, 0
|
||||
)
|
||||
await _check_state(
|
||||
hass, two_part_alarm, "disarmed", STATE_ALARM_DISARMED, SECOND_ENTITY_ID, 1
|
||||
)
|
||||
|
||||
|
||||
async def _test_servie_call(hass, service, method, entity_id, partition_id):
|
||||
with patch(
|
||||
"homeassistant.components.risco.RiscoAPI." + method, AsyncMock()
|
||||
) as set_mock:
|
||||
await _call_alarm_service(hass, service, entity_id)
|
||||
set_mock.assert_awaited_once_with(partition_id)
|
||||
|
||||
|
||||
async def _call_alarm_service(hass, service, entity_id):
|
||||
data = {"entity_id": entity_id}
|
||||
|
||||
await hass.services.async_call(
|
||||
ALARM_DOMAIN, service, service_data=data, blocking=True
|
||||
)
|
||||
|
||||
|
||||
async def test_sets(hass, two_part_alarm):
|
||||
"""Test settings the various modes."""
|
||||
await _setup_risco(hass, two_part_alarm)
|
||||
|
||||
await _test_servie_call(hass, SERVICE_ALARM_DISARM, "disarm", FIRST_ENTITY_ID, 0)
|
||||
await _test_servie_call(hass, SERVICE_ALARM_DISARM, "disarm", SECOND_ENTITY_ID, 1)
|
||||
await _test_servie_call(hass, SERVICE_ALARM_ARM_AWAY, "arm", FIRST_ENTITY_ID, 0)
|
||||
await _test_servie_call(hass, SERVICE_ALARM_ARM_AWAY, "arm", SECOND_ENTITY_ID, 1)
|
||||
await _test_servie_call(
|
||||
hass, SERVICE_ALARM_ARM_HOME, "partial_arm", FIRST_ENTITY_ID, 0
|
||||
)
|
||||
await _test_servie_call(
|
||||
hass, SERVICE_ALARM_ARM_HOME, "partial_arm", SECOND_ENTITY_ID, 1
|
||||
)
|
||||
await _test_servie_call(
|
||||
hass, SERVICE_ALARM_ARM_NIGHT, "partial_arm", FIRST_ENTITY_ID, 0
|
||||
)
|
||||
await _test_servie_call(
|
||||
hass, SERVICE_ALARM_ARM_NIGHT, "partial_arm", SECOND_ENTITY_ID, 1
|
||||
)
|
||||
await _test_servie_call(
|
||||
hass, SERVICE_ALARM_ARM_CUSTOM_BYPASS, "partial_arm", FIRST_ENTITY_ID, 0
|
||||
)
|
||||
await _test_servie_call(
|
||||
hass, SERVICE_ALARM_ARM_CUSTOM_BYPASS, "partial_arm", SECOND_ENTITY_ID, 1
|
||||
)
|
||||
@@ -0,0 +1,113 @@
|
||||
"""Test the Risco config flow."""
|
||||
from homeassistant import config_entries, setup
|
||||
from homeassistant.components.risco.config_flow import (
|
||||
CannotConnectError,
|
||||
UnauthorizedError,
|
||||
)
|
||||
from homeassistant.components.risco.const import DOMAIN
|
||||
|
||||
from tests.async_mock import AsyncMock, PropertyMock, patch
|
||||
|
||||
TEST_SITE_NAME = "test-site-name"
|
||||
TEST_DATA = {
|
||||
"username": "test-username",
|
||||
"password": "test-password",
|
||||
"pin": "1234",
|
||||
}
|
||||
|
||||
|
||||
async def test_form(hass):
|
||||
"""Test we get the form."""
|
||||
await setup.async_setup_component(hass, "persistent_notification", {})
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": config_entries.SOURCE_USER}
|
||||
)
|
||||
assert result["type"] == "form"
|
||||
assert result["errors"] == {}
|
||||
|
||||
with patch(
|
||||
"homeassistant.components.risco.config_flow.RiscoAPI.login", return_value=True,
|
||||
), patch(
|
||||
"homeassistant.components.risco.config_flow.RiscoAPI.site_name",
|
||||
new_callable=PropertyMock(return_value=TEST_SITE_NAME),
|
||||
), patch(
|
||||
"homeassistant.components.risco.config_flow.RiscoAPI.close", AsyncMock()
|
||||
) as mock_close, patch(
|
||||
"homeassistant.components.risco.async_setup", return_value=True
|
||||
) as mock_setup, patch(
|
||||
"homeassistant.components.risco.async_setup_entry", return_value=True,
|
||||
) as mock_setup_entry:
|
||||
result2 = await hass.config_entries.flow.async_configure(
|
||||
result["flow_id"], TEST_DATA
|
||||
)
|
||||
|
||||
assert result2["type"] == "create_entry"
|
||||
assert result2["title"] == TEST_SITE_NAME
|
||||
assert result2["data"] == TEST_DATA
|
||||
await hass.async_block_till_done()
|
||||
assert len(mock_setup.mock_calls) == 1
|
||||
assert len(mock_setup_entry.mock_calls) == 1
|
||||
mock_close.assert_awaited_once()
|
||||
|
||||
|
||||
async def test_form_invalid_auth(hass):
|
||||
"""Test we handle invalid auth."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": config_entries.SOURCE_USER}
|
||||
)
|
||||
|
||||
with patch(
|
||||
"homeassistant.components.risco.config_flow.RiscoAPI.login",
|
||||
side_effect=UnauthorizedError,
|
||||
), patch(
|
||||
"homeassistant.components.risco.config_flow.RiscoAPI.close", AsyncMock()
|
||||
) as mock_close:
|
||||
result2 = await hass.config_entries.flow.async_configure(
|
||||
result["flow_id"], TEST_DATA
|
||||
)
|
||||
|
||||
assert result2["type"] == "form"
|
||||
assert result2["errors"] == {"base": "invalid_auth"}
|
||||
mock_close.assert_awaited_once()
|
||||
|
||||
|
||||
async def test_form_cannot_connect(hass):
|
||||
"""Test we handle cannot connect error."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": config_entries.SOURCE_USER}
|
||||
)
|
||||
|
||||
with patch(
|
||||
"homeassistant.components.risco.config_flow.RiscoAPI.login",
|
||||
side_effect=CannotConnectError,
|
||||
), patch(
|
||||
"homeassistant.components.risco.config_flow.RiscoAPI.close", AsyncMock()
|
||||
) as mock_close:
|
||||
result2 = await hass.config_entries.flow.async_configure(
|
||||
result["flow_id"], TEST_DATA
|
||||
)
|
||||
|
||||
assert result2["type"] == "form"
|
||||
assert result2["errors"] == {"base": "cannot_connect"}
|
||||
mock_close.assert_awaited_once()
|
||||
|
||||
|
||||
async def test_form_exception(hass):
|
||||
"""Test we handle unknown exception."""
|
||||
result = await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": config_entries.SOURCE_USER}
|
||||
)
|
||||
|
||||
with patch(
|
||||
"homeassistant.components.risco.config_flow.RiscoAPI.login",
|
||||
side_effect=Exception,
|
||||
), patch(
|
||||
"homeassistant.components.risco.config_flow.RiscoAPI.close", AsyncMock()
|
||||
) as mock_close:
|
||||
result2 = await hass.config_entries.flow.async_configure(
|
||||
result["flow_id"], TEST_DATA
|
||||
)
|
||||
|
||||
assert result2["type"] == "form"
|
||||
assert result2["errors"] == {"base": "unknown"}
|
||||
mock_close.assert_awaited_once()
|
||||
Reference in new issue
Block a user