mirror of
https://github.com/home-assistant/core.git
synced 2025-12-24 21:06:19 +00:00
Deduplicate MQTT mixin tests (#32563)
* Deduplicate MQTT mixin tests * Remove test of not yet merged function
This commit is contained in:
@@ -2,12 +2,10 @@
|
||||
import copy
|
||||
import json
|
||||
import unittest
|
||||
from unittest.mock import ANY
|
||||
|
||||
import pytest
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.components import mqtt
|
||||
from homeassistant.components.climate import DEFAULT_MAX_TEMP, DEFAULT_MIN_TEMP
|
||||
from homeassistant.components.climate.const import (
|
||||
DOMAIN as CLIMATE_DOMAIN,
|
||||
@@ -25,16 +23,23 @@ from homeassistant.components.climate.const import (
|
||||
SUPPORT_TARGET_TEMPERATURE,
|
||||
SUPPORT_TARGET_TEMPERATURE_RANGE,
|
||||
)
|
||||
from homeassistant.components.mqtt.discovery import async_start
|
||||
from homeassistant.const import STATE_OFF, STATE_UNAVAILABLE
|
||||
|
||||
from tests.common import (
|
||||
MockConfigEntry,
|
||||
async_fire_mqtt_message,
|
||||
async_mock_mqtt_component,
|
||||
async_setup_component,
|
||||
mock_registry,
|
||||
from .common import (
|
||||
help_test_discovery_broken,
|
||||
help_test_discovery_removal,
|
||||
help_test_discovery_update,
|
||||
help_test_discovery_update_attr,
|
||||
help_test_entity_device_info_update,
|
||||
help_test_entity_device_info_with_identifier,
|
||||
help_test_entity_id_update,
|
||||
help_test_setting_attribute_via_mqtt_json_message,
|
||||
help_test_unique_id,
|
||||
help_test_update_with_json_attrs_bad_JSON,
|
||||
help_test_update_with_json_attrs_not_dict,
|
||||
)
|
||||
|
||||
from tests.common import async_fire_mqtt_message, async_setup_component
|
||||
from tests.components.climate import common
|
||||
|
||||
ENTITY_CLIMATE = "climate.test"
|
||||
@@ -768,76 +773,54 @@ async def test_temp_step_custom(hass, mqtt_mock):
|
||||
|
||||
async def test_setting_attribute_via_mqtt_json_message(hass, mqtt_mock):
|
||||
"""Test the setting of attribute via MQTT with JSON payload."""
|
||||
assert await async_setup_component(
|
||||
hass,
|
||||
CLIMATE_DOMAIN,
|
||||
{
|
||||
CLIMATE_DOMAIN: {
|
||||
"platform": "mqtt",
|
||||
"name": "test",
|
||||
"power_state_topic": "test-topic",
|
||||
"power_command_topic": "test_topic",
|
||||
"json_attributes_topic": "attr-topic",
|
||||
}
|
||||
},
|
||||
config = {
|
||||
CLIMATE_DOMAIN: {
|
||||
"platform": "mqtt",
|
||||
"name": "test",
|
||||
"power_state_topic": "test-topic",
|
||||
"power_command_topic": "test_topic",
|
||||
"json_attributes_topic": "attr-topic",
|
||||
}
|
||||
}
|
||||
await help_test_setting_attribute_via_mqtt_json_message(
|
||||
hass, mqtt_mock, CLIMATE_DOMAIN, config
|
||||
)
|
||||
|
||||
async_fire_mqtt_message(hass, "attr-topic", '{ "val": "100" }')
|
||||
state = hass.states.get("climate.test")
|
||||
|
||||
assert state.attributes.get("val") == "100"
|
||||
|
||||
|
||||
async def test_update_with_json_attrs_not_dict(hass, mqtt_mock, caplog):
|
||||
"""Test attributes get extracted from a JSON result."""
|
||||
assert await async_setup_component(
|
||||
hass,
|
||||
CLIMATE_DOMAIN,
|
||||
{
|
||||
CLIMATE_DOMAIN: {
|
||||
"platform": "mqtt",
|
||||
"name": "test",
|
||||
"power_state_topic": "test-topic",
|
||||
"power_command_topic": "test_topic",
|
||||
"json_attributes_topic": "attr-topic",
|
||||
}
|
||||
},
|
||||
config = {
|
||||
CLIMATE_DOMAIN: {
|
||||
"platform": "mqtt",
|
||||
"name": "test",
|
||||
"power_state_topic": "test-topic",
|
||||
"power_command_topic": "test_topic",
|
||||
"json_attributes_topic": "attr-topic",
|
||||
}
|
||||
}
|
||||
await help_test_update_with_json_attrs_not_dict(
|
||||
hass, mqtt_mock, caplog, CLIMATE_DOMAIN, config
|
||||
)
|
||||
|
||||
async_fire_mqtt_message(hass, "attr-topic", '[ "list", "of", "things"]')
|
||||
state = hass.states.get("climate.test")
|
||||
|
||||
assert state.attributes.get("val") is None
|
||||
assert "JSON result was not a dictionary" in caplog.text
|
||||
|
||||
|
||||
async def test_update_with_json_attrs_bad_JSON(hass, mqtt_mock, caplog):
|
||||
"""Test attributes get extracted from a JSON result."""
|
||||
assert await async_setup_component(
|
||||
hass,
|
||||
CLIMATE_DOMAIN,
|
||||
{
|
||||
CLIMATE_DOMAIN: {
|
||||
"platform": "mqtt",
|
||||
"name": "test",
|
||||
"power_state_topic": "test-topic",
|
||||
"power_command_topic": "test_topic",
|
||||
"json_attributes_topic": "attr-topic",
|
||||
}
|
||||
},
|
||||
config = {
|
||||
CLIMATE_DOMAIN: {
|
||||
"platform": "mqtt",
|
||||
"name": "test",
|
||||
"power_state_topic": "test-topic",
|
||||
"power_command_topic": "test_topic",
|
||||
"json_attributes_topic": "attr-topic",
|
||||
}
|
||||
}
|
||||
await help_test_update_with_json_attrs_bad_JSON(
|
||||
hass, mqtt_mock, caplog, CLIMATE_DOMAIN, config
|
||||
)
|
||||
|
||||
async_fire_mqtt_message(hass, "attr-topic", "This is not JSON")
|
||||
|
||||
state = hass.states.get("climate.test")
|
||||
assert state.attributes.get("val") is None
|
||||
assert "Erroneous JSON: This is not JSON" in caplog.text
|
||||
|
||||
|
||||
async def test_discovery_update_attr(hass, mqtt_mock, caplog):
|
||||
"""Test update of discovered MQTTAttributes."""
|
||||
entry = MockConfigEntry(domain=mqtt.DOMAIN)
|
||||
await async_start(hass, "homeassistant", {}, entry)
|
||||
data1 = (
|
||||
'{ "name": "Beer",'
|
||||
' "power_state_topic": "test-topic",'
|
||||
@@ -850,127 +833,60 @@ async def test_discovery_update_attr(hass, mqtt_mock, caplog):
|
||||
' "power_command_topic": "test_topic",'
|
||||
' "json_attributes_topic": "attr-topic2" }'
|
||||
)
|
||||
async_fire_mqtt_message(hass, "homeassistant/climate/bla/config", data1)
|
||||
await hass.async_block_till_done()
|
||||
async_fire_mqtt_message(hass, "attr-topic1", '{ "val": "100" }')
|
||||
state = hass.states.get("climate.beer")
|
||||
assert state.attributes.get("val") == "100"
|
||||
|
||||
# Change json_attributes_topic
|
||||
async_fire_mqtt_message(hass, "homeassistant/climate/bla/config", data2)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
# Verify we are no longer subscribing to the old topic
|
||||
async_fire_mqtt_message(hass, "attr-topic1", '{ "val": "50" }')
|
||||
state = hass.states.get("climate.beer")
|
||||
assert state.attributes.get("val") == "100"
|
||||
|
||||
# Verify we are subscribing to the new topic
|
||||
async_fire_mqtt_message(hass, "attr-topic2", '{ "val": "75" }')
|
||||
state = hass.states.get("climate.beer")
|
||||
assert state.attributes.get("val") == "75"
|
||||
await help_test_discovery_update_attr(
|
||||
hass, mqtt_mock, caplog, CLIMATE_DOMAIN, data1, data2
|
||||
)
|
||||
|
||||
|
||||
async def test_unique_id(hass):
|
||||
"""Test unique id option only creates one climate per unique_id."""
|
||||
await async_mock_mqtt_component(hass)
|
||||
assert await async_setup_component(
|
||||
hass,
|
||||
CLIMATE_DOMAIN,
|
||||
{
|
||||
CLIMATE_DOMAIN: [
|
||||
{
|
||||
"platform": "mqtt",
|
||||
"name": "Test 1",
|
||||
"power_state_topic": "test-topic",
|
||||
"power_command_topic": "test_topic",
|
||||
"unique_id": "TOTALLY_UNIQUE",
|
||||
},
|
||||
{
|
||||
"platform": "mqtt",
|
||||
"name": "Test 2",
|
||||
"power_state_topic": "test-topic",
|
||||
"power_command_topic": "test_topic",
|
||||
"unique_id": "TOTALLY_UNIQUE",
|
||||
},
|
||||
]
|
||||
},
|
||||
)
|
||||
async_fire_mqtt_message(hass, "test-topic", "payload")
|
||||
assert len(hass.states.async_entity_ids(CLIMATE_DOMAIN)) == 1
|
||||
config = {
|
||||
CLIMATE_DOMAIN: [
|
||||
{
|
||||
"platform": "mqtt",
|
||||
"name": "Test 1",
|
||||
"power_state_topic": "test-topic",
|
||||
"power_command_topic": "test_topic",
|
||||
"unique_id": "TOTALLY_UNIQUE",
|
||||
},
|
||||
{
|
||||
"platform": "mqtt",
|
||||
"name": "Test 2",
|
||||
"power_state_topic": "test-topic",
|
||||
"power_command_topic": "test_topic",
|
||||
"unique_id": "TOTALLY_UNIQUE",
|
||||
},
|
||||
]
|
||||
}
|
||||
await help_test_unique_id(hass, CLIMATE_DOMAIN, config)
|
||||
|
||||
|
||||
async def test_discovery_removal_climate(hass, mqtt_mock, caplog):
|
||||
"""Test removal of discovered climate."""
|
||||
entry = MockConfigEntry(domain=mqtt.DOMAIN)
|
||||
await async_start(hass, "homeassistant", {}, entry)
|
||||
data = '{ "name": "Beer" }'
|
||||
async_fire_mqtt_message(hass, "homeassistant/climate/bla/config", data)
|
||||
await hass.async_block_till_done()
|
||||
state = hass.states.get("climate.beer")
|
||||
assert state is not None
|
||||
assert state.name == "Beer"
|
||||
async_fire_mqtt_message(hass, "homeassistant/climate/bla/config", "")
|
||||
await hass.async_block_till_done()
|
||||
state = hass.states.get("climate.beer")
|
||||
assert state is None
|
||||
await help_test_discovery_removal(hass, mqtt_mock, caplog, CLIMATE_DOMAIN, data)
|
||||
|
||||
|
||||
async def test_discovery_update_climate(hass, mqtt_mock, caplog):
|
||||
"""Test update of discovered climate."""
|
||||
entry = MockConfigEntry(domain=mqtt.DOMAIN)
|
||||
await async_start(hass, "homeassistant", {}, entry)
|
||||
data1 = '{ "name": "Beer" }'
|
||||
data2 = '{ "name": "Milk" }'
|
||||
async_fire_mqtt_message(hass, "homeassistant/climate/bla/config", data1)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = hass.states.get("climate.beer")
|
||||
assert state is not None
|
||||
assert state.name == "Beer"
|
||||
|
||||
async_fire_mqtt_message(hass, "homeassistant/climate/bla/config", data2)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = hass.states.get("climate.beer")
|
||||
assert state is not None
|
||||
assert state.name == "Milk"
|
||||
|
||||
state = hass.states.get("climate.milk")
|
||||
assert state is None
|
||||
await help_test_discovery_update(
|
||||
hass, mqtt_mock, caplog, CLIMATE_DOMAIN, data1, data2
|
||||
)
|
||||
|
||||
|
||||
async def test_discovery_broken(hass, mqtt_mock, caplog):
|
||||
"""Test handling of bad discovery message."""
|
||||
entry = MockConfigEntry(domain=mqtt.DOMAIN)
|
||||
await async_start(hass, "homeassistant", {}, entry)
|
||||
|
||||
data1 = '{ "name": "Beer",' ' "power_command_topic": "test_topic#" }'
|
||||
data2 = '{ "name": "Milk", ' ' "power_command_topic": "test_topic" }'
|
||||
|
||||
async_fire_mqtt_message(hass, "homeassistant/climate/bla/config", data1)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = hass.states.get("climate.beer")
|
||||
assert state is None
|
||||
|
||||
async_fire_mqtt_message(hass, "homeassistant/climate/bla/config", data2)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = hass.states.get("climate.milk")
|
||||
assert state is not None
|
||||
assert state.name == "Milk"
|
||||
state = hass.states.get("climate.beer")
|
||||
assert state is None
|
||||
await help_test_discovery_broken(
|
||||
hass, mqtt_mock, caplog, CLIMATE_DOMAIN, data1, data2
|
||||
)
|
||||
|
||||
|
||||
async def test_entity_device_info_with_identifier(hass, mqtt_mock):
|
||||
"""Test MQTT climate device registry integration."""
|
||||
entry = MockConfigEntry(domain=mqtt.DOMAIN)
|
||||
entry.add_to_hass(hass)
|
||||
await async_start(hass, "homeassistant", {}, entry)
|
||||
registry = await hass.helpers.device_registry.async_get_registry()
|
||||
|
||||
data = json.dumps(
|
||||
{
|
||||
"platform": "mqtt",
|
||||
@@ -986,26 +902,13 @@ async def test_entity_device_info_with_identifier(hass, mqtt_mock):
|
||||
"unique_id": "veryunique",
|
||||
}
|
||||
)
|
||||
async_fire_mqtt_message(hass, "homeassistant/climate/bla/config", data)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
device = registry.async_get_device({("mqtt", "helloworld")}, set())
|
||||
assert device is not None
|
||||
assert device.identifiers == {("mqtt", "helloworld")}
|
||||
assert device.connections == {("mac", "02:5b:26:a8:dc:12")}
|
||||
assert device.manufacturer == "Whatever"
|
||||
assert device.name == "Beer"
|
||||
assert device.model == "Glass"
|
||||
assert device.sw_version == "0.1-beta"
|
||||
await help_test_entity_device_info_with_identifier(
|
||||
hass, mqtt_mock, CLIMATE_DOMAIN, data
|
||||
)
|
||||
|
||||
|
||||
async def test_entity_device_info_update(hass, mqtt_mock):
|
||||
"""Test device registry update."""
|
||||
entry = MockConfigEntry(domain=mqtt.DOMAIN)
|
||||
entry.add_to_hass(hass)
|
||||
await async_start(hass, "homeassistant", {}, entry)
|
||||
registry = await hass.helpers.device_registry.async_get_registry()
|
||||
|
||||
config = {
|
||||
"platform": "mqtt",
|
||||
"name": "Test 1",
|
||||
@@ -1021,63 +924,23 @@ async def test_entity_device_info_update(hass, mqtt_mock):
|
||||
},
|
||||
"unique_id": "veryunique",
|
||||
}
|
||||
|
||||
data = json.dumps(config)
|
||||
async_fire_mqtt_message(hass, "homeassistant/climate/bla/config", data)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
device = registry.async_get_device({("mqtt", "helloworld")}, set())
|
||||
assert device is not None
|
||||
assert device.name == "Beer"
|
||||
|
||||
config["device"]["name"] = "Milk"
|
||||
data = json.dumps(config)
|
||||
async_fire_mqtt_message(hass, "homeassistant/climate/bla/config", data)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
device = registry.async_get_device({("mqtt", "helloworld")}, set())
|
||||
assert device is not None
|
||||
assert device.name == "Milk"
|
||||
await help_test_entity_device_info_update(hass, mqtt_mock, CLIMATE_DOMAIN, config)
|
||||
|
||||
|
||||
async def test_entity_id_update(hass, mqtt_mock):
|
||||
"""Test MQTT subscriptions are managed when entity_id is updated."""
|
||||
registry = mock_registry(hass, {})
|
||||
mock_mqtt = await async_mock_mqtt_component(hass)
|
||||
assert await async_setup_component(
|
||||
hass,
|
||||
CLIMATE_DOMAIN,
|
||||
{
|
||||
CLIMATE_DOMAIN: [
|
||||
{
|
||||
"platform": "mqtt",
|
||||
"name": "beer",
|
||||
"mode_state_topic": "test-topic",
|
||||
"availability_topic": "avty-topic",
|
||||
"unique_id": "TOTALLY_UNIQUE",
|
||||
}
|
||||
]
|
||||
},
|
||||
)
|
||||
|
||||
state = hass.states.get("climate.beer")
|
||||
assert state is not None
|
||||
assert mock_mqtt.async_subscribe.call_count == 2
|
||||
mock_mqtt.async_subscribe.assert_any_call("test-topic", ANY, 0, "utf-8")
|
||||
mock_mqtt.async_subscribe.assert_any_call("avty-topic", ANY, 0, "utf-8")
|
||||
mock_mqtt.async_subscribe.reset_mock()
|
||||
|
||||
registry.async_update_entity("climate.beer", new_entity_id="climate.milk")
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = hass.states.get("climate.beer")
|
||||
assert state is None
|
||||
|
||||
state = hass.states.get("climate.milk")
|
||||
assert state is not None
|
||||
assert mock_mqtt.async_subscribe.call_count == 2
|
||||
mock_mqtt.async_subscribe.assert_any_call("test-topic", ANY, 0, "utf-8")
|
||||
mock_mqtt.async_subscribe.assert_any_call("avty-topic", ANY, 0, "utf-8")
|
||||
config = {
|
||||
CLIMATE_DOMAIN: [
|
||||
{
|
||||
"platform": "mqtt",
|
||||
"name": "beer",
|
||||
"mode_state_topic": "test-topic",
|
||||
"availability_topic": "avty-topic",
|
||||
"unique_id": "TOTALLY_UNIQUE",
|
||||
}
|
||||
]
|
||||
}
|
||||
await help_test_entity_id_update(hass, mqtt_mock, CLIMATE_DOMAIN, config)
|
||||
|
||||
|
||||
async def test_precision_default(hass, mqtt_mock):
|
||||
|
||||
Reference in New Issue
Block a user