274 lines
7.7 KiB
Python
274 lines
7.7 KiB
Python
"""The tests for the MQTT scene platform."""
|
|
import copy
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
from homeassistant.components import mqtt, scene
|
|
from homeassistant.const import ATTR_ENTITY_ID, SERVICE_TURN_ON, STATE_UNKNOWN, Platform
|
|
from homeassistant.core import HomeAssistant, State
|
|
|
|
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_unchanged,
|
|
help_test_reloadable,
|
|
help_test_unique_id,
|
|
help_test_unload_config_entry_with_platform,
|
|
)
|
|
|
|
from tests.common import mock_restore_cache
|
|
from tests.typing import MqttMockHAClientGenerator, MqttMockPahoClient
|
|
|
|
DEFAULT_CONFIG = {
|
|
mqtt.DOMAIN: {
|
|
scene.DOMAIN: {
|
|
"name": "test",
|
|
"command_topic": "test-topic",
|
|
"payload_on": "test-payload-on",
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def scene_platform_only():
|
|
"""Only setup the scene platform to speed up tests."""
|
|
with patch("homeassistant.components.mqtt.PLATFORMS", [Platform.SCENE]):
|
|
yield
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"hass_config",
|
|
[
|
|
{
|
|
mqtt.DOMAIN: {
|
|
scene.DOMAIN: {
|
|
"name": "test",
|
|
"command_topic": "command-topic",
|
|
"payload_on": "beer on",
|
|
},
|
|
}
|
|
}
|
|
],
|
|
)
|
|
async def test_sending_mqtt_commands(
|
|
hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
|
|
) -> None:
|
|
"""Test the sending MQTT commands."""
|
|
fake_state = State("scene.test", STATE_UNKNOWN)
|
|
mock_restore_cache(hass, (fake_state,))
|
|
|
|
mqtt_mock = await mqtt_mock_entry()
|
|
|
|
state = hass.states.get("scene.test")
|
|
assert state.state == STATE_UNKNOWN
|
|
|
|
data = {ATTR_ENTITY_ID: "scene.test"}
|
|
await hass.services.async_call(scene.DOMAIN, SERVICE_TURN_ON, data, blocking=True)
|
|
|
|
mqtt_mock.async_publish.assert_called_once_with(
|
|
"command-topic", "beer on", 0, False
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize("hass_config", [DEFAULT_CONFIG])
|
|
async def test_availability_when_connection_lost(
|
|
hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
|
|
) -> None:
|
|
"""Test availability after MQTT disconnection."""
|
|
await help_test_availability_when_connection_lost(
|
|
hass, mqtt_mock_entry, scene.DOMAIN
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize("hass_config", [DEFAULT_CONFIG])
|
|
async def test_availability_without_topic(
|
|
hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
|
|
) -> None:
|
|
"""Test availability without defined availability topic."""
|
|
await help_test_availability_without_topic(
|
|
hass, mqtt_mock_entry, scene.DOMAIN, DEFAULT_CONFIG
|
|
)
|
|
|
|
|
|
async def test_default_availability_payload(
|
|
hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
|
|
) -> None:
|
|
"""Test availability by default payload with defined topic."""
|
|
config = {
|
|
mqtt.DOMAIN: {
|
|
scene.DOMAIN: {
|
|
"name": "test",
|
|
"command_topic": "command-topic",
|
|
"payload_on": 1,
|
|
}
|
|
}
|
|
}
|
|
await help_test_default_availability_payload(
|
|
hass,
|
|
mqtt_mock_entry,
|
|
scene.DOMAIN,
|
|
config,
|
|
True,
|
|
"state-topic",
|
|
"1",
|
|
)
|
|
|
|
|
|
async def test_custom_availability_payload(
|
|
hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
|
|
) -> None:
|
|
"""Test availability by custom payload with defined topic."""
|
|
config = {
|
|
mqtt.DOMAIN: {
|
|
scene.DOMAIN: {
|
|
"name": "test",
|
|
"command_topic": "command-topic",
|
|
"payload_on": 1,
|
|
}
|
|
}
|
|
}
|
|
|
|
await help_test_custom_availability_payload(
|
|
hass,
|
|
mqtt_mock_entry,
|
|
scene.DOMAIN,
|
|
config,
|
|
True,
|
|
"state-topic",
|
|
"1",
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"hass_config",
|
|
[
|
|
{
|
|
mqtt.DOMAIN: {
|
|
scene.DOMAIN: [
|
|
{
|
|
"name": "Test 1",
|
|
"command_topic": "command-topic",
|
|
"unique_id": "TOTALLY_UNIQUE",
|
|
},
|
|
{
|
|
"name": "Test 2",
|
|
"command_topic": "command-topic",
|
|
"unique_id": "TOTALLY_UNIQUE",
|
|
},
|
|
]
|
|
}
|
|
}
|
|
],
|
|
)
|
|
async def test_unique_id(
|
|
hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
|
|
) -> None:
|
|
"""Test unique id option only creates one scene per unique_id."""
|
|
await help_test_unique_id(hass, mqtt_mock_entry, scene.DOMAIN)
|
|
|
|
|
|
async def test_discovery_removal_scene(
|
|
hass: HomeAssistant,
|
|
mqtt_mock_entry: MqttMockHAClientGenerator,
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
"""Test removal of discovered scene."""
|
|
data = '{ "name": "test",' ' "command_topic": "test_topic" }'
|
|
await help_test_discovery_removal(hass, mqtt_mock_entry, caplog, scene.DOMAIN, data)
|
|
|
|
|
|
async def test_discovery_update_payload(
|
|
hass: HomeAssistant,
|
|
mqtt_mock_entry: MqttMockHAClientGenerator,
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
"""Test update of discovered scene."""
|
|
config1 = copy.deepcopy(DEFAULT_CONFIG[mqtt.DOMAIN][scene.DOMAIN])
|
|
config2 = copy.deepcopy(DEFAULT_CONFIG[mqtt.DOMAIN][scene.DOMAIN])
|
|
config1["name"] = "Beer"
|
|
config2["name"] = "Milk"
|
|
config1["payload_on"] = "ON"
|
|
config2["payload_on"] = "ACTIVATE"
|
|
|
|
await help_test_discovery_update(
|
|
hass,
|
|
mqtt_mock_entry,
|
|
caplog,
|
|
scene.DOMAIN,
|
|
config1,
|
|
config2,
|
|
)
|
|
|
|
|
|
async def test_discovery_update_unchanged_scene(
|
|
hass: HomeAssistant,
|
|
mqtt_mock_entry: MqttMockHAClientGenerator,
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
"""Test update of discovered scene."""
|
|
data1 = '{ "name": "Beer",' ' "command_topic": "test_topic" }'
|
|
with patch(
|
|
"homeassistant.components.mqtt.scene.MqttScene.discovery_update"
|
|
) as discovery_update:
|
|
await help_test_discovery_update_unchanged(
|
|
hass,
|
|
mqtt_mock_entry,
|
|
caplog,
|
|
scene.DOMAIN,
|
|
data1,
|
|
discovery_update,
|
|
)
|
|
|
|
|
|
@pytest.mark.no_fail_on_log_exception
|
|
async def test_discovery_broken(
|
|
hass: HomeAssistant,
|
|
mqtt_mock_entry: MqttMockHAClientGenerator,
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
"""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, caplog, scene.DOMAIN, data1, data2
|
|
)
|
|
|
|
|
|
async def test_reloadable(
|
|
hass: HomeAssistant,
|
|
mqtt_client_mock: MqttMockPahoClient,
|
|
) -> None:
|
|
"""Test reloading the MQTT platform."""
|
|
domain = scene.DOMAIN
|
|
config = DEFAULT_CONFIG
|
|
await help_test_reloadable(hass, mqtt_client_mock, domain, config)
|
|
|
|
|
|
@pytest.mark.parametrize("hass_config", [DEFAULT_CONFIG])
|
|
async def test_setup_manual_entity_from_yaml(
|
|
hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
|
|
) -> None:
|
|
"""Test setup manual configured MQTT entity."""
|
|
await mqtt_mock_entry()
|
|
platform = scene.DOMAIN
|
|
assert hass.states.get(f"{platform}.test")
|
|
|
|
|
|
async def test_unload_entry(
|
|
hass: HomeAssistant,
|
|
mqtt_mock_entry: MqttMockHAClientGenerator,
|
|
) -> None:
|
|
"""Test unloading the config entry."""
|
|
domain = scene.DOMAIN
|
|
config = DEFAULT_CONFIG
|
|
await help_test_unload_config_entry_with_platform(
|
|
hass, mqtt_mock_entry, domain, config
|
|
)
|