488 lines
16 KiB
Python
488 lines
16 KiB
Python
"""Test config flow."""
|
|
|
|
import pytest
|
|
import voluptuous as vol
|
|
|
|
from homeassistant import data_entry_flow
|
|
from homeassistant.components import mqtt
|
|
from homeassistant.components.mqtt.discovery import async_start
|
|
from homeassistant.setup import async_setup_component
|
|
|
|
from tests.async_mock import patch
|
|
from tests.common import MockConfigEntry
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def mock_finish_setup():
|
|
"""Mock out the finish setup method."""
|
|
with patch(
|
|
"homeassistant.components.mqtt.MQTT.async_connect", return_value=True
|
|
) as mock_finish:
|
|
yield mock_finish
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_try_connection():
|
|
"""Mock the try connection method."""
|
|
with patch("homeassistant.components.mqtt.config_flow.try_connection") as mock_try:
|
|
yield mock_try
|
|
|
|
|
|
async def test_user_connection_works(hass, mock_try_connection, mock_finish_setup):
|
|
"""Test we can finish a config flow."""
|
|
mock_try_connection.return_value = True
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
"mqtt", context={"source": "user"}
|
|
)
|
|
assert result["type"] == "form"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], {"broker": "127.0.0.1"}
|
|
)
|
|
|
|
assert result["type"] == "create_entry"
|
|
assert result["result"].data == {
|
|
"broker": "127.0.0.1",
|
|
"port": 1883,
|
|
"discovery": False,
|
|
}
|
|
# Check we tried the connection
|
|
assert len(mock_try_connection.mock_calls) == 1
|
|
# Check config entry got setup
|
|
assert len(mock_finish_setup.mock_calls) == 1
|
|
|
|
|
|
async def test_user_connection_fails(hass, mock_try_connection, mock_finish_setup):
|
|
"""Test if connection cannot be made."""
|
|
mock_try_connection.return_value = False
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
"mqtt", context={"source": "user"}
|
|
)
|
|
assert result["type"] == "form"
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], {"broker": "127.0.0.1"}
|
|
)
|
|
|
|
assert result["type"] == "form"
|
|
assert result["errors"]["base"] == "cannot_connect"
|
|
|
|
# Check we tried the connection
|
|
assert len(mock_try_connection.mock_calls) == 1
|
|
# Check config entry did not setup
|
|
assert len(mock_finish_setup.mock_calls) == 0
|
|
|
|
|
|
async def test_manual_config_set(hass, mock_try_connection, mock_finish_setup):
|
|
"""Test we ignore entry if manual config available."""
|
|
assert await async_setup_component(hass, "mqtt", {"mqtt": {"broker": "bla"}})
|
|
await hass.async_block_till_done()
|
|
assert len(mock_finish_setup.mock_calls) == 1
|
|
|
|
mock_try_connection.return_value = True
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
"mqtt", context={"source": "user"}
|
|
)
|
|
assert result["type"] == "abort"
|
|
|
|
|
|
async def test_user_single_instance(hass):
|
|
"""Test we only allow a single config flow."""
|
|
MockConfigEntry(domain="mqtt").add_to_hass(hass)
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
"mqtt", context={"source": "user"}
|
|
)
|
|
assert result["type"] == "abort"
|
|
assert result["reason"] == "single_instance_allowed"
|
|
|
|
|
|
async def test_hassio_single_instance(hass):
|
|
"""Test we only allow a single config flow."""
|
|
MockConfigEntry(domain="mqtt").add_to_hass(hass)
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
"mqtt", context={"source": "hassio"}
|
|
)
|
|
assert result["type"] == "abort"
|
|
assert result["reason"] == "single_instance_allowed"
|
|
|
|
|
|
async def test_hassio_confirm(hass, mock_try_connection, mock_finish_setup):
|
|
"""Test we can finish a config flow."""
|
|
mock_try_connection.return_value = True
|
|
|
|
result = await hass.config_entries.flow.async_init(
|
|
"mqtt",
|
|
data={
|
|
"addon": "Mock Addon",
|
|
"host": "mock-broker",
|
|
"port": 1883,
|
|
"username": "mock-user",
|
|
"password": "mock-pass",
|
|
"protocol": "3.1.1",
|
|
},
|
|
context={"source": "hassio"},
|
|
)
|
|
assert result["type"] == "form"
|
|
assert result["step_id"] == "hassio_confirm"
|
|
assert result["description_placeholders"] == {"addon": "Mock Addon"}
|
|
|
|
result = await hass.config_entries.flow.async_configure(
|
|
result["flow_id"], {"discovery": True}
|
|
)
|
|
|
|
assert result["type"] == "create_entry"
|
|
assert result["result"].data == {
|
|
"broker": "mock-broker",
|
|
"port": 1883,
|
|
"username": "mock-user",
|
|
"password": "mock-pass",
|
|
"protocol": "3.1.1",
|
|
"discovery": True,
|
|
}
|
|
# Check we tried the connection
|
|
assert len(mock_try_connection.mock_calls) == 1
|
|
# Check config entry got setup
|
|
assert len(mock_finish_setup.mock_calls) == 1
|
|
|
|
|
|
async def test_option_flow(hass, mqtt_mock, mock_try_connection):
|
|
"""Test config flow options."""
|
|
mock_try_connection.return_value = True
|
|
config_entry = hass.config_entries.async_entries(mqtt.DOMAIN)[0]
|
|
await async_start(hass, "homeassistant", config_entry)
|
|
config_entry.data = {
|
|
mqtt.CONF_BROKER: "test-broker",
|
|
mqtt.CONF_PORT: 1234,
|
|
}
|
|
|
|
mqtt_mock.async_connect.reset_mock()
|
|
|
|
result = await hass.config_entries.options.async_init(config_entry.entry_id)
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["step_id"] == "broker"
|
|
|
|
result = await hass.config_entries.options.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
mqtt.CONF_BROKER: "another-broker",
|
|
mqtt.CONF_PORT: 2345,
|
|
mqtt.CONF_USERNAME: "user",
|
|
mqtt.CONF_PASSWORD: "pass",
|
|
},
|
|
)
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["step_id"] == "options"
|
|
|
|
await hass.async_block_till_done()
|
|
assert mqtt_mock.async_connect.call_count == 0
|
|
|
|
result = await hass.config_entries.options.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
mqtt.CONF_DISCOVERY: True,
|
|
"birth_topic": "ha_state/online",
|
|
"birth_payload": "online",
|
|
"birth_qos": 1,
|
|
"birth_retain": True,
|
|
"will_topic": "ha_state/offline",
|
|
"will_payload": "offline",
|
|
"will_qos": 2,
|
|
"will_retain": True,
|
|
},
|
|
)
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
|
assert result["data"] is None
|
|
assert config_entry.data == {
|
|
mqtt.CONF_BROKER: "another-broker",
|
|
mqtt.CONF_PORT: 2345,
|
|
mqtt.CONF_USERNAME: "user",
|
|
mqtt.CONF_PASSWORD: "pass",
|
|
mqtt.CONF_DISCOVERY: True,
|
|
mqtt.CONF_BIRTH_MESSAGE: {
|
|
mqtt.ATTR_TOPIC: "ha_state/online",
|
|
mqtt.ATTR_PAYLOAD: "online",
|
|
mqtt.ATTR_QOS: 1,
|
|
mqtt.ATTR_RETAIN: True,
|
|
},
|
|
mqtt.CONF_WILL_MESSAGE: {
|
|
mqtt.ATTR_TOPIC: "ha_state/offline",
|
|
mqtt.ATTR_PAYLOAD: "offline",
|
|
mqtt.ATTR_QOS: 2,
|
|
mqtt.ATTR_RETAIN: True,
|
|
},
|
|
}
|
|
|
|
await hass.async_block_till_done()
|
|
assert mqtt_mock.async_connect.call_count == 1
|
|
|
|
|
|
def get_default(schema, key):
|
|
"""Get default value for key in voluptuous schema."""
|
|
for k in schema.keys():
|
|
if k == key:
|
|
if k.default == vol.UNDEFINED:
|
|
return None
|
|
return k.default()
|
|
|
|
|
|
def get_suggested(schema, key):
|
|
"""Get suggested value for key in voluptuous schema."""
|
|
for k in schema.keys():
|
|
if k == key:
|
|
if k.description is None or "suggested_value" not in k.description:
|
|
return None
|
|
return k.description["suggested_value"]
|
|
|
|
|
|
async def test_option_flow_default_suggested_values(
|
|
hass, mqtt_mock, mock_try_connection
|
|
):
|
|
"""Test config flow options has default/suggested values."""
|
|
mock_try_connection.return_value = True
|
|
config_entry = hass.config_entries.async_entries(mqtt.DOMAIN)[0]
|
|
await async_start(hass, "homeassistant", config_entry)
|
|
config_entry.data = {
|
|
mqtt.CONF_BROKER: "test-broker",
|
|
mqtt.CONF_PORT: 1234,
|
|
mqtt.CONF_USERNAME: "user",
|
|
mqtt.CONF_PASSWORD: "pass",
|
|
mqtt.CONF_DISCOVERY: True,
|
|
mqtt.CONF_BIRTH_MESSAGE: {
|
|
mqtt.ATTR_TOPIC: "ha_state/online",
|
|
mqtt.ATTR_PAYLOAD: "online",
|
|
mqtt.ATTR_QOS: 1,
|
|
mqtt.ATTR_RETAIN: True,
|
|
},
|
|
mqtt.CONF_WILL_MESSAGE: {
|
|
mqtt.ATTR_TOPIC: "ha_state/offline",
|
|
mqtt.ATTR_PAYLOAD: "offline",
|
|
mqtt.ATTR_QOS: 2,
|
|
mqtt.ATTR_RETAIN: False,
|
|
},
|
|
}
|
|
|
|
# Test default/suggested values from config
|
|
result = await hass.config_entries.options.async_init(config_entry.entry_id)
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["step_id"] == "broker"
|
|
defaults = {
|
|
mqtt.CONF_BROKER: "test-broker",
|
|
mqtt.CONF_PORT: 1234,
|
|
}
|
|
suggested = {
|
|
mqtt.CONF_USERNAME: "user",
|
|
mqtt.CONF_PASSWORD: "pass",
|
|
}
|
|
for k, v in defaults.items():
|
|
assert get_default(result["data_schema"].schema, k) == v
|
|
for k, v in suggested.items():
|
|
assert get_suggested(result["data_schema"].schema, k) == v
|
|
|
|
result = await hass.config_entries.options.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
mqtt.CONF_BROKER: "another-broker",
|
|
mqtt.CONF_PORT: 2345,
|
|
mqtt.CONF_USERNAME: "us3r",
|
|
mqtt.CONF_PASSWORD: "p4ss",
|
|
},
|
|
)
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["step_id"] == "options"
|
|
defaults = {
|
|
mqtt.CONF_DISCOVERY: True,
|
|
"birth_qos": 1,
|
|
"birth_retain": True,
|
|
"will_qos": 2,
|
|
"will_retain": False,
|
|
}
|
|
suggested = {
|
|
"birth_topic": "ha_state/online",
|
|
"birth_payload": "online",
|
|
"will_topic": "ha_state/offline",
|
|
"will_payload": "offline",
|
|
}
|
|
for k, v in defaults.items():
|
|
assert get_default(result["data_schema"].schema, k) == v
|
|
for k, v in suggested.items():
|
|
assert get_suggested(result["data_schema"].schema, k) == v
|
|
|
|
result = await hass.config_entries.options.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
mqtt.CONF_DISCOVERY: False,
|
|
"birth_topic": "ha_state/onl1ne",
|
|
"birth_payload": "onl1ne",
|
|
"birth_qos": 2,
|
|
"birth_retain": False,
|
|
"will_topic": "ha_state/offl1ne",
|
|
"will_payload": "offl1ne",
|
|
"will_qos": 1,
|
|
"will_retain": True,
|
|
},
|
|
)
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
|
|
|
# Test updated default/suggested values from config
|
|
result = await hass.config_entries.options.async_init(config_entry.entry_id)
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["step_id"] == "broker"
|
|
defaults = {
|
|
mqtt.CONF_BROKER: "another-broker",
|
|
mqtt.CONF_PORT: 2345,
|
|
}
|
|
suggested = {
|
|
mqtt.CONF_USERNAME: "us3r",
|
|
mqtt.CONF_PASSWORD: "p4ss",
|
|
}
|
|
for k, v in defaults.items():
|
|
assert get_default(result["data_schema"].schema, k) == v
|
|
for k, v in suggested.items():
|
|
assert get_suggested(result["data_schema"].schema, k) == v
|
|
|
|
result = await hass.config_entries.options.async_configure(
|
|
result["flow_id"],
|
|
user_input={mqtt.CONF_BROKER: "another-broker", mqtt.CONF_PORT: 2345},
|
|
)
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
|
|
assert result["step_id"] == "options"
|
|
defaults = {
|
|
mqtt.CONF_DISCOVERY: False,
|
|
"birth_qos": 2,
|
|
"birth_retain": False,
|
|
"will_qos": 1,
|
|
"will_retain": True,
|
|
}
|
|
suggested = {
|
|
"birth_topic": "ha_state/onl1ne",
|
|
"birth_payload": "onl1ne",
|
|
"will_topic": "ha_state/offl1ne",
|
|
"will_payload": "offl1ne",
|
|
}
|
|
for k, v in defaults.items():
|
|
assert get_default(result["data_schema"].schema, k) == v
|
|
for k, v in suggested.items():
|
|
assert get_suggested(result["data_schema"].schema, k) == v
|
|
|
|
result = await hass.config_entries.options.async_configure(
|
|
result["flow_id"],
|
|
user_input={
|
|
mqtt.CONF_DISCOVERY: True,
|
|
"birth_topic": "ha_state/onl1ne",
|
|
"birth_payload": "onl1ne",
|
|
"birth_qos": 2,
|
|
"birth_retain": False,
|
|
"will_topic": "ha_state/offl1ne",
|
|
"will_payload": "offl1ne",
|
|
"will_qos": 1,
|
|
"will_retain": True,
|
|
},
|
|
)
|
|
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
|
|
|
|
|
async def test_options_user_connection_fails(hass, mock_try_connection):
|
|
"""Test if connection cannot be made."""
|
|
config_entry = MockConfigEntry(domain=mqtt.DOMAIN)
|
|
config_entry.add_to_hass(hass)
|
|
config_entry.data = {
|
|
mqtt.CONF_BROKER: "test-broker",
|
|
mqtt.CONF_PORT: 1234,
|
|
}
|
|
|
|
mock_try_connection.return_value = False
|
|
|
|
result = await hass.config_entries.options.async_init(config_entry.entry_id)
|
|
assert result["type"] == "form"
|
|
|
|
result = await hass.config_entries.options.async_configure(
|
|
result["flow_id"],
|
|
user_input={mqtt.CONF_BROKER: "bad-broker", mqtt.CONF_PORT: 2345},
|
|
)
|
|
|
|
assert result["type"] == "form"
|
|
assert result["errors"]["base"] == "cannot_connect"
|
|
|
|
# Check we tried the connection
|
|
assert len(mock_try_connection.mock_calls) == 1
|
|
# Check config entry did not update
|
|
assert config_entry.data == {
|
|
mqtt.CONF_BROKER: "test-broker",
|
|
mqtt.CONF_PORT: 1234,
|
|
}
|
|
|
|
|
|
async def test_options_bad_birth_message_fails(hass, mock_try_connection):
|
|
"""Test bad birth message."""
|
|
config_entry = MockConfigEntry(domain=mqtt.DOMAIN)
|
|
config_entry.add_to_hass(hass)
|
|
config_entry.data = {
|
|
mqtt.CONF_BROKER: "test-broker",
|
|
mqtt.CONF_PORT: 1234,
|
|
}
|
|
|
|
mock_try_connection.return_value = True
|
|
|
|
result = await hass.config_entries.options.async_init(config_entry.entry_id)
|
|
assert result["type"] == "form"
|
|
|
|
result = await hass.config_entries.options.async_configure(
|
|
result["flow_id"],
|
|
user_input={mqtt.CONF_BROKER: "another-broker", mqtt.CONF_PORT: 2345},
|
|
)
|
|
|
|
assert result["type"] == "form"
|
|
assert result["step_id"] == "options"
|
|
|
|
result = await hass.config_entries.options.async_configure(
|
|
result["flow_id"], user_input={"birth_topic": "ha_state/online/#"},
|
|
)
|
|
assert result["type"] == "form"
|
|
assert result["errors"]["base"] == "bad_birth"
|
|
|
|
# Check config entry did not update
|
|
assert config_entry.data == {
|
|
mqtt.CONF_BROKER: "test-broker",
|
|
mqtt.CONF_PORT: 1234,
|
|
}
|
|
|
|
|
|
async def test_options_bad_will_message_fails(hass, mock_try_connection):
|
|
"""Test bad will message."""
|
|
config_entry = MockConfigEntry(domain=mqtt.DOMAIN)
|
|
config_entry.add_to_hass(hass)
|
|
config_entry.data = {
|
|
mqtt.CONF_BROKER: "test-broker",
|
|
mqtt.CONF_PORT: 1234,
|
|
}
|
|
|
|
mock_try_connection.return_value = True
|
|
|
|
result = await hass.config_entries.options.async_init(config_entry.entry_id)
|
|
assert result["type"] == "form"
|
|
|
|
result = await hass.config_entries.options.async_configure(
|
|
result["flow_id"],
|
|
user_input={mqtt.CONF_BROKER: "another-broker", mqtt.CONF_PORT: 2345},
|
|
)
|
|
|
|
assert result["type"] == "form"
|
|
assert result["step_id"] == "options"
|
|
|
|
result = await hass.config_entries.options.async_configure(
|
|
result["flow_id"], user_input={"will_topic": "ha_state/offline/#"},
|
|
)
|
|
assert result["type"] == "form"
|
|
assert result["errors"]["base"] == "bad_will"
|
|
|
|
# Check config entry did not update
|
|
assert config_entry.data == {
|
|
mqtt.CONF_BROKER: "test-broker",
|
|
mqtt.CONF_PORT: 1234,
|
|
}
|