495 lines
15 KiB
Python
495 lines
15 KiB
Python
"""The tests for the MQTT button platform."""
|
|
import copy
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
from homeassistant.components import button, mqtt
|
|
from homeassistant.const import (
|
|
ATTR_ENTITY_ID,
|
|
ATTR_FRIENDLY_NAME,
|
|
STATE_UNKNOWN,
|
|
Platform,
|
|
)
|
|
from homeassistant.setup import async_setup_component
|
|
|
|
from .test_common import (
|
|
help_test_availability_when_connection_lost,
|
|
help_test_availability_without_topic,
|
|
help_test_custom_availability_payload,
|
|
help_test_default_availability_payload,
|
|
help_test_discovery_broken,
|
|
help_test_discovery_removal,
|
|
help_test_discovery_update,
|
|
help_test_discovery_update_attr,
|
|
help_test_discovery_update_unchanged,
|
|
help_test_entity_debug_info_message,
|
|
help_test_entity_device_info_remove,
|
|
help_test_entity_device_info_update,
|
|
help_test_entity_device_info_with_connection,
|
|
help_test_entity_device_info_with_identifier,
|
|
help_test_entity_id_update_discovery_update,
|
|
help_test_publishing_with_custom_encoding,
|
|
help_test_reloadable,
|
|
help_test_setting_attribute_via_mqtt_json_message,
|
|
help_test_setting_attribute_with_template,
|
|
help_test_setting_blocked_attribute_via_mqtt_json_message,
|
|
help_test_setup_manual_entity_from_yaml,
|
|
help_test_unique_id,
|
|
help_test_unload_config_entry_with_platform,
|
|
help_test_update_with_json_attrs_bad_json,
|
|
help_test_update_with_json_attrs_not_dict,
|
|
)
|
|
|
|
DEFAULT_CONFIG = {
|
|
mqtt.DOMAIN: {button.DOMAIN: {"name": "test", "command_topic": "test-topic"}}
|
|
}
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def button_platform_only():
|
|
"""Only setup the button platform to speed up tests."""
|
|
with patch("homeassistant.components.mqtt.PLATFORMS", [Platform.BUTTON]):
|
|
yield
|
|
|
|
|
|
@pytest.mark.freeze_time("2021-11-08 13:31:44+00:00")
|
|
async def test_sending_mqtt_commands(hass, mqtt_mock_entry_with_yaml_config):
|
|
"""Test the sending MQTT commands."""
|
|
assert await async_setup_component(
|
|
hass,
|
|
mqtt.DOMAIN,
|
|
{
|
|
mqtt.DOMAIN: {
|
|
button.DOMAIN: {
|
|
"command_topic": "command-topic",
|
|
"name": "test",
|
|
"object_id": "test_button",
|
|
"payload_press": "beer press",
|
|
"qos": "2",
|
|
}
|
|
}
|
|
},
|
|
)
|
|
await hass.async_block_till_done()
|
|
mqtt_mock = await mqtt_mock_entry_with_yaml_config()
|
|
|
|
state = hass.states.get("button.test_button")
|
|
assert state.state == STATE_UNKNOWN
|
|
assert state.attributes.get(ATTR_FRIENDLY_NAME) == "test"
|
|
|
|
await hass.services.async_call(
|
|
button.DOMAIN,
|
|
button.SERVICE_PRESS,
|
|
{ATTR_ENTITY_ID: "button.test_button"},
|
|
blocking=True,
|
|
)
|
|
|
|
mqtt_mock.async_publish.assert_called_once_with(
|
|
"command-topic", "beer press", 2, False
|
|
)
|
|
mqtt_mock.async_publish.reset_mock()
|
|
state = hass.states.get("button.test_button")
|
|
assert state.state == "2021-11-08T13:31:44+00:00"
|
|
|
|
|
|
async def test_command_template(hass, mqtt_mock_entry_with_yaml_config):
|
|
"""Test the sending of MQTT commands through a command template."""
|
|
assert await async_setup_component(
|
|
hass,
|
|
mqtt.DOMAIN,
|
|
{
|
|
mqtt.DOMAIN: {
|
|
button.DOMAIN: {
|
|
"command_topic": "command-topic",
|
|
"command_template": '{ "{{ value }}": "{{ entity_id }}" }',
|
|
"name": "test",
|
|
"payload_press": "milky_way_press",
|
|
}
|
|
}
|
|
},
|
|
)
|
|
await hass.async_block_till_done()
|
|
mqtt_mock = await mqtt_mock_entry_with_yaml_config()
|
|
|
|
state = hass.states.get("button.test")
|
|
assert state.state == STATE_UNKNOWN
|
|
assert state.attributes.get(ATTR_FRIENDLY_NAME) == "test"
|
|
|
|
await hass.services.async_call(
|
|
button.DOMAIN,
|
|
button.SERVICE_PRESS,
|
|
{ATTR_ENTITY_ID: "button.test"},
|
|
blocking=True,
|
|
)
|
|
|
|
mqtt_mock.async_publish.assert_called_once_with(
|
|
"command-topic", '{ "milky_way_press": "button.test" }', 0, False
|
|
)
|
|
mqtt_mock.async_publish.reset_mock()
|
|
|
|
|
|
async def test_availability_when_connection_lost(
|
|
hass, mqtt_mock_entry_with_yaml_config
|
|
):
|
|
"""Test availability after MQTT disconnection."""
|
|
await help_test_availability_when_connection_lost(
|
|
hass, mqtt_mock_entry_with_yaml_config, button.DOMAIN, DEFAULT_CONFIG
|
|
)
|
|
|
|
|
|
async def test_availability_without_topic(hass, mqtt_mock_entry_with_yaml_config):
|
|
"""Test availability without defined availability topic."""
|
|
await help_test_availability_without_topic(
|
|
hass, mqtt_mock_entry_with_yaml_config, button.DOMAIN, DEFAULT_CONFIG
|
|
)
|
|
|
|
|
|
async def test_default_availability_payload(hass, mqtt_mock_entry_with_yaml_config):
|
|
"""Test availability by default payload with defined topic."""
|
|
config = {
|
|
mqtt.DOMAIN: {
|
|
button.DOMAIN: {
|
|
"name": "test",
|
|
"command_topic": "command-topic",
|
|
"payload_press": 1,
|
|
}
|
|
}
|
|
}
|
|
|
|
await help_test_default_availability_payload(
|
|
hass,
|
|
mqtt_mock_entry_with_yaml_config,
|
|
button.DOMAIN,
|
|
config,
|
|
True,
|
|
"state-topic",
|
|
"1",
|
|
)
|
|
|
|
|
|
async def test_custom_availability_payload(hass, mqtt_mock_entry_with_yaml_config):
|
|
"""Test availability by custom payload with defined topic."""
|
|
config = {
|
|
mqtt.DOMAIN: {
|
|
button.DOMAIN: {
|
|
"name": "test",
|
|
"command_topic": "command-topic",
|
|
"payload_press": 1,
|
|
}
|
|
}
|
|
}
|
|
|
|
await help_test_custom_availability_payload(
|
|
hass,
|
|
mqtt_mock_entry_with_yaml_config,
|
|
button.DOMAIN,
|
|
config,
|
|
True,
|
|
"state-topic",
|
|
"1",
|
|
)
|
|
|
|
|
|
async def test_setting_attribute_via_mqtt_json_message(
|
|
hass, mqtt_mock_entry_with_yaml_config
|
|
):
|
|
"""Test the setting of attribute via MQTT with JSON payload."""
|
|
await help_test_setting_attribute_via_mqtt_json_message(
|
|
hass, mqtt_mock_entry_with_yaml_config, button.DOMAIN, DEFAULT_CONFIG
|
|
)
|
|
|
|
|
|
async def test_setting_blocked_attribute_via_mqtt_json_message(
|
|
hass, mqtt_mock_entry_no_yaml_config
|
|
):
|
|
"""Test the setting of attribute via MQTT with JSON payload."""
|
|
await help_test_setting_blocked_attribute_via_mqtt_json_message(
|
|
hass, mqtt_mock_entry_no_yaml_config, button.DOMAIN, DEFAULT_CONFIG, None
|
|
)
|
|
|
|
|
|
async def test_setting_attribute_with_template(hass, mqtt_mock_entry_with_yaml_config):
|
|
"""Test the setting of attribute via MQTT with JSON payload."""
|
|
await help_test_setting_attribute_with_template(
|
|
hass, mqtt_mock_entry_with_yaml_config, button.DOMAIN, DEFAULT_CONFIG
|
|
)
|
|
|
|
|
|
async def test_update_with_json_attrs_not_dict(
|
|
hass, mqtt_mock_entry_with_yaml_config, caplog
|
|
):
|
|
"""Test attributes get extracted from a JSON result."""
|
|
await help_test_update_with_json_attrs_not_dict(
|
|
hass,
|
|
mqtt_mock_entry_with_yaml_config,
|
|
caplog,
|
|
button.DOMAIN,
|
|
DEFAULT_CONFIG,
|
|
)
|
|
|
|
|
|
async def test_update_with_json_attrs_bad_json(
|
|
hass, mqtt_mock_entry_with_yaml_config, caplog
|
|
):
|
|
"""Test attributes get extracted from a JSON result."""
|
|
await help_test_update_with_json_attrs_bad_json(
|
|
hass,
|
|
mqtt_mock_entry_with_yaml_config,
|
|
caplog,
|
|
button.DOMAIN,
|
|
DEFAULT_CONFIG,
|
|
)
|
|
|
|
|
|
async def test_discovery_update_attr(hass, mqtt_mock_entry_no_yaml_config, caplog):
|
|
"""Test update of discovered MQTTAttributes."""
|
|
await help_test_discovery_update_attr(
|
|
hass,
|
|
mqtt_mock_entry_no_yaml_config,
|
|
caplog,
|
|
button.DOMAIN,
|
|
DEFAULT_CONFIG,
|
|
)
|
|
|
|
|
|
async def test_unique_id(hass, mqtt_mock_entry_with_yaml_config):
|
|
"""Test unique id option only creates one button per unique_id."""
|
|
config = {
|
|
mqtt.DOMAIN: {
|
|
button.DOMAIN: [
|
|
{
|
|
"name": "Test 1",
|
|
"command_topic": "command-topic",
|
|
"unique_id": "TOTALLY_UNIQUE",
|
|
},
|
|
{
|
|
"name": "Test 2",
|
|
"command_topic": "command-topic",
|
|
"unique_id": "TOTALLY_UNIQUE",
|
|
},
|
|
]
|
|
}
|
|
}
|
|
await help_test_unique_id(
|
|
hass, mqtt_mock_entry_with_yaml_config, button.DOMAIN, config
|
|
)
|
|
|
|
|
|
async def test_discovery_removal_button(hass, mqtt_mock_entry_no_yaml_config, caplog):
|
|
"""Test removal of discovered button."""
|
|
data = '{ "name": "test", "command_topic": "test_topic" }'
|
|
await help_test_discovery_removal(
|
|
hass, mqtt_mock_entry_no_yaml_config, caplog, button.DOMAIN, data
|
|
)
|
|
|
|
|
|
async def test_discovery_update_button(hass, mqtt_mock_entry_no_yaml_config, caplog):
|
|
"""Test update of discovered button."""
|
|
config1 = copy.deepcopy(DEFAULT_CONFIG[mqtt.DOMAIN][button.DOMAIN])
|
|
config2 = copy.deepcopy(DEFAULT_CONFIG[mqtt.DOMAIN][button.DOMAIN])
|
|
config1["name"] = "Beer"
|
|
config2["name"] = "Milk"
|
|
|
|
await help_test_discovery_update(
|
|
hass,
|
|
mqtt_mock_entry_no_yaml_config,
|
|
caplog,
|
|
button.DOMAIN,
|
|
config1,
|
|
config2,
|
|
)
|
|
|
|
|
|
async def test_discovery_update_unchanged_button(
|
|
hass, mqtt_mock_entry_no_yaml_config, caplog
|
|
):
|
|
"""Test update of discovered button."""
|
|
data1 = (
|
|
'{ "name": "Beer",'
|
|
' "state_topic": "test_topic",'
|
|
' "command_topic": "test_topic" }'
|
|
)
|
|
with patch(
|
|
"homeassistant.components.mqtt.button.MqttButton.discovery_update"
|
|
) as discovery_update:
|
|
await help_test_discovery_update_unchanged(
|
|
hass,
|
|
mqtt_mock_entry_no_yaml_config,
|
|
caplog,
|
|
button.DOMAIN,
|
|
data1,
|
|
discovery_update,
|
|
)
|
|
|
|
|
|
@pytest.mark.no_fail_on_log_exception
|
|
async def test_discovery_broken(hass, mqtt_mock_entry_no_yaml_config, caplog):
|
|
"""Test handling of bad discovery message."""
|
|
data1 = '{ "name": "Beer" }'
|
|
data2 = '{ "name": "Milk", "command_topic": "test_topic" }'
|
|
await help_test_discovery_broken(
|
|
hass, mqtt_mock_entry_no_yaml_config, caplog, button.DOMAIN, data1, data2
|
|
)
|
|
|
|
|
|
async def test_entity_device_info_with_connection(hass, mqtt_mock_entry_no_yaml_config):
|
|
"""Test MQTT button device registry integration."""
|
|
await help_test_entity_device_info_with_connection(
|
|
hass, mqtt_mock_entry_no_yaml_config, button.DOMAIN, DEFAULT_CONFIG
|
|
)
|
|
|
|
|
|
async def test_entity_device_info_with_identifier(hass, mqtt_mock_entry_no_yaml_config):
|
|
"""Test MQTT button device registry integration."""
|
|
await help_test_entity_device_info_with_identifier(
|
|
hass, mqtt_mock_entry_no_yaml_config, button.DOMAIN, DEFAULT_CONFIG
|
|
)
|
|
|
|
|
|
async def test_entity_device_info_update(hass, mqtt_mock_entry_no_yaml_config):
|
|
"""Test device registry update."""
|
|
await help_test_entity_device_info_update(
|
|
hass, mqtt_mock_entry_no_yaml_config, button.DOMAIN, DEFAULT_CONFIG
|
|
)
|
|
|
|
|
|
async def test_entity_device_info_remove(hass, mqtt_mock_entry_no_yaml_config):
|
|
"""Test device registry remove."""
|
|
await help_test_entity_device_info_remove(
|
|
hass, mqtt_mock_entry_no_yaml_config, button.DOMAIN, DEFAULT_CONFIG
|
|
)
|
|
|
|
|
|
async def test_entity_id_update_discovery_update(hass, mqtt_mock_entry_no_yaml_config):
|
|
"""Test MQTT discovery update when entity_id is updated."""
|
|
await help_test_entity_id_update_discovery_update(
|
|
hass, mqtt_mock_entry_no_yaml_config, button.DOMAIN, DEFAULT_CONFIG
|
|
)
|
|
|
|
|
|
async def test_entity_debug_info_message(hass, mqtt_mock_entry_no_yaml_config):
|
|
"""Test MQTT debug info."""
|
|
await help_test_entity_debug_info_message(
|
|
hass,
|
|
mqtt_mock_entry_no_yaml_config,
|
|
button.DOMAIN,
|
|
DEFAULT_CONFIG,
|
|
button.SERVICE_PRESS,
|
|
command_payload="PRESS",
|
|
state_topic=None,
|
|
)
|
|
|
|
|
|
async def test_invalid_device_class(hass):
|
|
"""Test device_class option with invalid value."""
|
|
assert not await async_setup_component(
|
|
hass,
|
|
mqtt.DOMAIN,
|
|
{
|
|
mqtt.DOMAIN: {
|
|
button.DOMAIN: {
|
|
"name": "test",
|
|
"state_topic": "test-topic",
|
|
"device_class": "foobarnotreal",
|
|
}
|
|
}
|
|
},
|
|
)
|
|
|
|
|
|
async def test_valid_device_class(hass, mqtt_mock_entry_with_yaml_config):
|
|
"""Test device_class option with valid values."""
|
|
assert await async_setup_component(
|
|
hass,
|
|
mqtt.DOMAIN,
|
|
{
|
|
mqtt.DOMAIN: {
|
|
button.DOMAIN: [
|
|
{
|
|
"name": "Test 1",
|
|
"command_topic": "test-topic",
|
|
"device_class": "update",
|
|
},
|
|
{
|
|
"name": "Test 2",
|
|
"command_topic": "test-topic",
|
|
"device_class": "restart",
|
|
},
|
|
{
|
|
"name": "Test 3",
|
|
"command_topic": "test-topic",
|
|
},
|
|
]
|
|
}
|
|
},
|
|
)
|
|
await hass.async_block_till_done()
|
|
await mqtt_mock_entry_with_yaml_config()
|
|
|
|
state = hass.states.get("button.test_1")
|
|
assert state.attributes["device_class"] == button.ButtonDeviceClass.UPDATE
|
|
state = hass.states.get("button.test_2")
|
|
assert state.attributes["device_class"] == button.ButtonDeviceClass.RESTART
|
|
state = hass.states.get("button.test_3")
|
|
assert "device_class" not in state.attributes
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"service,topic,parameters,payload,template",
|
|
[
|
|
(button.SERVICE_PRESS, "command_topic", None, "PRESS", "command_template"),
|
|
],
|
|
)
|
|
async def test_publishing_with_custom_encoding(
|
|
hass,
|
|
mqtt_mock_entry_with_yaml_config,
|
|
caplog,
|
|
service,
|
|
topic,
|
|
parameters,
|
|
payload,
|
|
template,
|
|
):
|
|
"""Test publishing MQTT payload with different encoding."""
|
|
domain = button.DOMAIN
|
|
config = DEFAULT_CONFIG
|
|
|
|
await help_test_publishing_with_custom_encoding(
|
|
hass,
|
|
mqtt_mock_entry_with_yaml_config,
|
|
caplog,
|
|
domain,
|
|
config,
|
|
service,
|
|
topic,
|
|
parameters,
|
|
payload,
|
|
template,
|
|
)
|
|
|
|
|
|
async def test_reloadable(hass, mqtt_mock_entry_with_yaml_config, caplog, tmp_path):
|
|
"""Test reloading the MQTT platform."""
|
|
domain = button.DOMAIN
|
|
config = DEFAULT_CONFIG
|
|
await help_test_reloadable(
|
|
hass, mqtt_mock_entry_with_yaml_config, caplog, tmp_path, domain, config
|
|
)
|
|
|
|
|
|
async def test_setup_manual_entity_from_yaml(hass):
|
|
"""Test setup manual configured MQTT entity."""
|
|
platform = button.DOMAIN
|
|
await help_test_setup_manual_entity_from_yaml(hass, DEFAULT_CONFIG)
|
|
assert hass.states.get(f"{platform}.test")
|
|
|
|
|
|
async def test_unload_entry(hass, mqtt_mock_entry_with_yaml_config, tmp_path):
|
|
"""Test unloading the config entry."""
|
|
domain = button.DOMAIN
|
|
config = DEFAULT_CONFIG
|
|
await help_test_unload_config_entry_with_platform(
|
|
hass, mqtt_mock_entry_with_yaml_config, tmp_path, domain, config
|
|
)
|