af6a4bb6cf
* First step of an EnOcean integration refactoring, including code reorganisation and support of a setup config flow * Moved title to root of strings file * Fixed pre-commit checks failures * Fixed linter errors * Updated formatted string format in logs * Removed leftover comment * Multiple changes after PR change requests. Using an import flow for yaml config, removed unnecessary logs, added proper unload in __init__ and EnOceanDongle Replaced config state machine by several flows. Serial port validity check done in the EnOceanDongle class asynchronously, removed unique ID from config flow Multiple cosmetic changes * Multiple changes after PR change requests * Added variable to store default value, as setdefault was caught returning None when the empty dict literal was passed as an argument * Literal used directly * Added tests for EnOcean config flows, changed static methods to bundle methods for bundle * Updated variable name * Added missing mock to test, replaced repeated magic strings by constants * Changed imports to avoid an unused import warning from pylint on DOMAIN * Adding pylint exception for unused import * Added proper propagation of setup and unload to platforms, removed dead code, some syntax changes * Removed setup_entry forwarding as the entities can only be configured using yaml * Removed forwarding of unload * Enabled code coverage for config flow only * Clean up coveragerc Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
159 lines
6 KiB
Python
159 lines
6 KiB
Python
"""Tests for EnOcean config flow."""
|
|
from homeassistant import data_entry_flow
|
|
from homeassistant.components.enocean.config_flow import EnOceanFlowHandler
|
|
from homeassistant.components.enocean.const import DOMAIN
|
|
from homeassistant.const import CONF_DEVICE
|
|
|
|
from tests.async_mock import Mock, patch
|
|
from tests.common import MockConfigEntry
|
|
|
|
DONGLE_VALIDATE_PATH_METHOD = "homeassistant.components.enocean.dongle.validate_path"
|
|
DONGLE_DETECT_METHOD = "homeassistant.components.enocean.dongle.detect"
|
|
|
|
|
|
async def test_user_flow_cannot_create_multiple_instances(hass):
|
|
"""Test that the user flow aborts if an instance is already configured."""
|
|
entry = MockConfigEntry(
|
|
domain=DOMAIN, data={CONF_DEVICE: "/already/configured/path"}
|
|
)
|
|
entry.add_to_hass(hass)
|
|
|
|
with patch(DONGLE_VALIDATE_PATH_METHOD, Mock(return_value=True)):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": "user"}
|
|
)
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_ABORT
|
|
assert result["reason"] == "single_instance_allowed"
|
|
|
|
|
|
async def test_user_flow_with_detected_dongle(hass):
|
|
"""Test the user flow with a detected ENOcean dongle."""
|
|
FAKE_DONGLE_PATH = "/fake/dongle"
|
|
|
|
with patch(DONGLE_DETECT_METHOD, Mock(return_value=[FAKE_DONGLE_PATH])):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": "user"}
|
|
)
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["step_id"] == "detect"
|
|
devices = result["data_schema"].schema.get("device").container
|
|
assert FAKE_DONGLE_PATH in devices
|
|
assert EnOceanFlowHandler.MANUAL_PATH_VALUE in devices
|
|
|
|
|
|
async def test_user_flow_with_no_detected_dongle(hass):
|
|
"""Test the user flow with a detected ENOcean dongle."""
|
|
with patch(DONGLE_DETECT_METHOD, Mock(return_value=[])):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": "user"}
|
|
)
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["step_id"] == "manual"
|
|
|
|
|
|
async def test_detection_flow_with_valid_path(hass):
|
|
"""Test the detection flow with a valid path selected."""
|
|
USER_PROVIDED_PATH = "/user/provided/path"
|
|
|
|
with patch(DONGLE_VALIDATE_PATH_METHOD, Mock(return_value=True)):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": "detect"}, data={CONF_DEVICE: USER_PROVIDED_PATH}
|
|
)
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
|
assert result["data"][CONF_DEVICE] == USER_PROVIDED_PATH
|
|
|
|
|
|
async def test_detection_flow_with_custom_path(hass):
|
|
"""Test the detection flow with custom path selected."""
|
|
USER_PROVIDED_PATH = EnOceanFlowHandler.MANUAL_PATH_VALUE
|
|
FAKE_DONGLE_PATH = "/fake/dongle"
|
|
|
|
with patch(DONGLE_VALIDATE_PATH_METHOD, Mock(return_value=True)):
|
|
with patch(DONGLE_DETECT_METHOD, Mock(return_value=[FAKE_DONGLE_PATH])):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": "detect"},
|
|
data={CONF_DEVICE: USER_PROVIDED_PATH},
|
|
)
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["step_id"] == "manual"
|
|
|
|
|
|
async def test_detection_flow_with_invalid_path(hass):
|
|
"""Test the detection flow with an invalid path selected."""
|
|
USER_PROVIDED_PATH = "/invalid/path"
|
|
FAKE_DONGLE_PATH = "/fake/dongle"
|
|
|
|
with patch(DONGLE_VALIDATE_PATH_METHOD, Mock(return_value=False)):
|
|
with patch(DONGLE_DETECT_METHOD, Mock(return_value=[FAKE_DONGLE_PATH])):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": "detect"},
|
|
data={CONF_DEVICE: USER_PROVIDED_PATH},
|
|
)
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["step_id"] == "detect"
|
|
assert CONF_DEVICE in result["errors"]
|
|
|
|
|
|
async def test_manual_flow_with_valid_path(hass):
|
|
"""Test the manual flow with a valid path."""
|
|
USER_PROVIDED_PATH = "/user/provided/path"
|
|
|
|
with patch(DONGLE_VALIDATE_PATH_METHOD, Mock(return_value=True)):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": "manual"}, data={CONF_DEVICE: USER_PROVIDED_PATH}
|
|
)
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
|
assert result["data"][CONF_DEVICE] == USER_PROVIDED_PATH
|
|
|
|
|
|
async def test_manual_flow_with_invalid_path(hass):
|
|
"""Test the manual flow with an invalid path."""
|
|
USER_PROVIDED_PATH = "/user/provided/path"
|
|
|
|
with patch(
|
|
DONGLE_VALIDATE_PATH_METHOD, Mock(return_value=False),
|
|
):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": "manual"}, data={CONF_DEVICE: USER_PROVIDED_PATH}
|
|
)
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["step_id"] == "manual"
|
|
assert CONF_DEVICE in result["errors"]
|
|
|
|
|
|
async def test_import_flow_with_valid_path(hass):
|
|
"""Test the import flow with a valid path."""
|
|
DATA_TO_IMPORT = {CONF_DEVICE: "/valid/path/to/import"}
|
|
|
|
with patch(DONGLE_VALIDATE_PATH_METHOD, Mock(return_value=True)):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": "import"}, data=DATA_TO_IMPORT
|
|
)
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
|
assert result["data"][CONF_DEVICE] == DATA_TO_IMPORT[CONF_DEVICE]
|
|
|
|
|
|
async def test_import_flow_with_invalid_path(hass):
|
|
"""Test the import flow with an invalid path."""
|
|
DATA_TO_IMPORT = {CONF_DEVICE: "/invalid/path/to/import"}
|
|
|
|
with patch(
|
|
DONGLE_VALIDATE_PATH_METHOD, Mock(return_value=False),
|
|
):
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": "import"}, data=DATA_TO_IMPORT
|
|
)
|
|
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_ABORT
|
|
assert result["reason"] == "invalid_dongle_path"
|