mirror of
https://github.com/home-assistant/core.git
synced 2025-07-27 15:17:35 +00:00
This makes mqtt_template tests async (#17784)
This commit is contained in:
kennedyshead
Paulus Schoutsen
parent
8bebfba21a
commit
67d92c4f5d
@ -26,48 +26,34 @@ If your light doesn't support white value feature, omit `white_value_template`.
|
||||
|
||||
If your light doesn't support RGB feature, omit `(red|green|blue)_template`.
|
||||
"""
|
||||
import unittest
|
||||
from unittest.mock import patch
|
||||
|
||||
from homeassistant.setup import setup_component
|
||||
from homeassistant.setup import async_setup_component
|
||||
from homeassistant.const import (
|
||||
STATE_ON, STATE_OFF, STATE_UNAVAILABLE, ATTR_ASSUMED_STATE)
|
||||
import homeassistant.components.light as light
|
||||
import homeassistant.core as ha
|
||||
|
||||
from tests.common import (
|
||||
get_test_home_assistant, mock_mqtt_component, fire_mqtt_message,
|
||||
assert_setup_component, mock_coro)
|
||||
from tests.components.light import common
|
||||
async_fire_mqtt_message, assert_setup_component, mock_coro)
|
||||
|
||||
|
||||
class TestLightMQTTTemplate(unittest.TestCase):
|
||||
"""Test the MQTT Template light."""
|
||||
|
||||
def setUp(self): # pylint: disable=invalid-name
|
||||
"""Set up things to be run when tests are started."""
|
||||
self.hass = get_test_home_assistant()
|
||||
self.mock_publish = mock_mqtt_component(self.hass)
|
||||
|
||||
def tearDown(self): # pylint: disable=invalid-name
|
||||
"""Stop everything that was started."""
|
||||
self.hass.stop()
|
||||
|
||||
def test_setup_fails(self):
|
||||
async def test_setup_fails(hass, mqtt_mock):
|
||||
"""Test that setup fails with missing required configuration items."""
|
||||
with assert_setup_component(0, light.DOMAIN):
|
||||
assert setup_component(self.hass, light.DOMAIN, {
|
||||
assert await async_setup_component(hass, light.DOMAIN, {
|
||||
light.DOMAIN: {
|
||||
'platform': 'mqtt_template',
|
||||
'name': 'test',
|
||||
}
|
||||
})
|
||||
assert self.hass.states.get('light.test') is None
|
||||
assert hass.states.get('light.test') is None
|
||||
|
||||
def test_state_change_via_topic(self):
|
||||
|
||||
async def test_state_change_via_topic(hass, mqtt_mock):
|
||||
"""Test state change via topic."""
|
||||
with assert_setup_component(1, light.DOMAIN):
|
||||
assert setup_component(self.hass, light.DOMAIN, {
|
||||
assert await async_setup_component(hass, light.DOMAIN, {
|
||||
light.DOMAIN: {
|
||||
'platform': 'mqtt_template',
|
||||
'name': 'test',
|
||||
@ -85,7 +71,7 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
}
|
||||
})
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_OFF == state.state
|
||||
assert state.attributes.get('rgb_color') is None
|
||||
assert state.attributes.get('brightness') is None
|
||||
@ -93,20 +79,22 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
assert state.attributes.get('white_value') is None
|
||||
assert not state.attributes.get(ATTR_ASSUMED_STATE)
|
||||
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb', 'on')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb', 'on')
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_ON == state.state
|
||||
assert state.attributes.get('rgb_color') is None
|
||||
assert state.attributes.get('brightness') is None
|
||||
assert state.attributes.get('color_temp') is None
|
||||
assert state.attributes.get('white_value') is None
|
||||
|
||||
def test_state_brightness_color_effect_temp_white_change_via_topic(self):
|
||||
|
||||
async def test_state_brightness_color_effect_temp_white_change_via_topic(
|
||||
hass, mqtt_mock):
|
||||
"""Test state, bri, color, effect, color temp, white val change."""
|
||||
with assert_setup_component(1, light.DOMAIN):
|
||||
assert setup_component(self.hass, light.DOMAIN, {
|
||||
assert await async_setup_component(hass, light.DOMAIN, {
|
||||
light.DOMAIN: {
|
||||
'platform': 'mqtt_template',
|
||||
'name': 'test',
|
||||
@ -136,7 +124,7 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
}
|
||||
})
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_OFF == state.state
|
||||
assert state.attributes.get('rgb_color') is None
|
||||
assert state.attributes.get('brightness') is None
|
||||
@ -146,11 +134,11 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
assert not state.attributes.get(ATTR_ASSUMED_STATE)
|
||||
|
||||
# turn on the light, full white
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb',
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb',
|
||||
'on,255,145,123,255-128-64,')
|
||||
self.hass.block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_ON == state.state
|
||||
assert (255, 128, 63) == state.attributes.get('rgb_color')
|
||||
assert 255 == state.attributes.get('brightness')
|
||||
@ -159,53 +147,57 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
assert state.attributes.get('effect') is None
|
||||
|
||||
# turn the light off
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb', 'off')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb', 'off')
|
||||
await hass.async_block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_OFF == state.state
|
||||
|
||||
# lower the brightness
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,100')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb', 'on,100')
|
||||
await hass.async_block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
light_state = self.hass.states.get('light.test')
|
||||
self.hass.block_till_done()
|
||||
light_state = hass.states.get('light.test')
|
||||
assert 100 == light_state.attributes['brightness']
|
||||
|
||||
# change the color temp
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,,195')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb', 'on,,195')
|
||||
await hass.async_block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
light_state = self.hass.states.get('light.test')
|
||||
self.hass.block_till_done()
|
||||
light_state = hass.states.get('light.test')
|
||||
assert 195 == light_state.attributes['color_temp']
|
||||
|
||||
# change the color
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,,,,41-42-43')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb', 'on,,,,41-42-43')
|
||||
await hass.async_block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
light_state = self.hass.states.get('light.test')
|
||||
light_state = hass.states.get('light.test')
|
||||
assert (243, 249, 255) == \
|
||||
light_state.attributes.get('rgb_color')
|
||||
|
||||
# change the white value
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,,,134')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb', 'on,,,134')
|
||||
await hass.async_block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
light_state = self.hass.states.get('light.test')
|
||||
self.hass.block_till_done()
|
||||
light_state = hass.states.get('light.test')
|
||||
assert 134 == light_state.attributes['white_value']
|
||||
|
||||
# change the effect
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb',
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb',
|
||||
'on,,,,41-42-43,rainbow')
|
||||
self.hass.block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
light_state = self.hass.states.get('light.test')
|
||||
light_state = hass.states.get('light.test')
|
||||
assert 'rainbow' == light_state.attributes.get('effect')
|
||||
|
||||
def test_optimistic(self):
|
||||
|
||||
async def test_optimistic(hass, mqtt_mock):
|
||||
"""Test optimistic mode."""
|
||||
fake_state = ha.State('light.test', 'on', {'brightness': 95,
|
||||
'hs_color': [100, 100],
|
||||
@ -217,7 +209,7 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
'.async_get_last_state',
|
||||
return_value=mock_coro(fake_state)):
|
||||
with assert_setup_component(1, light.DOMAIN):
|
||||
assert setup_component(self.hass, light.DOMAIN, {
|
||||
assert await async_setup_component(hass, light.DOMAIN, {
|
||||
light.DOMAIN: {
|
||||
'platform': 'mqtt_template',
|
||||
'name': 'test',
|
||||
@ -236,7 +228,7 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
}
|
||||
})
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_ON == state.state
|
||||
assert 95 == state.attributes.get('brightness')
|
||||
assert (100, 100) == state.attributes.get('hs_color')
|
||||
@ -245,55 +237,11 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
assert 50 == state.attributes.get('white_value')
|
||||
assert state.attributes.get(ATTR_ASSUMED_STATE)
|
||||
|
||||
# turn on the light
|
||||
common.turn_on(self.hass, 'light.test')
|
||||
self.hass.block_till_done()
|
||||
|
||||
self.mock_publish.async_publish.assert_called_once_with(
|
||||
'test_light_rgb/set', 'on,,,,--', 2, False)
|
||||
self.mock_publish.async_publish.reset_mock()
|
||||
state = self.hass.states.get('light.test')
|
||||
assert STATE_ON == state.state
|
||||
|
||||
# turn the light off
|
||||
common.turn_off(self.hass, 'light.test')
|
||||
self.hass.block_till_done()
|
||||
|
||||
self.mock_publish.async_publish.assert_called_once_with(
|
||||
'test_light_rgb/set', 'off', 2, False)
|
||||
self.mock_publish.async_publish.reset_mock()
|
||||
state = self.hass.states.get('light.test')
|
||||
assert STATE_OFF == state.state
|
||||
|
||||
# turn on the light with brightness, color
|
||||
common.turn_on(self.hass, 'light.test', brightness=50,
|
||||
rgb_color=[75, 75, 75])
|
||||
self.hass.block_till_done()
|
||||
|
||||
self.mock_publish.async_publish.assert_called_once_with(
|
||||
'test_light_rgb/set', 'on,50,,,50-50-50', 2, False)
|
||||
self.mock_publish.async_publish.reset_mock()
|
||||
|
||||
# turn on the light with color temp and white val
|
||||
common.turn_on(self.hass, 'light.test',
|
||||
color_temp=200, white_value=139)
|
||||
self.hass.block_till_done()
|
||||
|
||||
self.mock_publish.async_publish.assert_called_once_with(
|
||||
'test_light_rgb/set', 'on,,200,139,--', 2, False)
|
||||
|
||||
# check the state
|
||||
state = self.hass.states.get('light.test')
|
||||
assert STATE_ON == state.state
|
||||
assert (255, 255, 255) == state.attributes['rgb_color']
|
||||
assert 50 == state.attributes['brightness']
|
||||
assert 200 == state.attributes['color_temp']
|
||||
assert 139 == state.attributes['white_value']
|
||||
|
||||
def test_flash(self):
|
||||
async def test_flash(hass, mqtt_mock):
|
||||
"""Test flash."""
|
||||
with assert_setup_component(1, light.DOMAIN):
|
||||
assert setup_component(self.hass, light.DOMAIN, {
|
||||
assert await async_setup_component(hass, light.DOMAIN, {
|
||||
light.DOMAIN: {
|
||||
'platform': 'mqtt_template',
|
||||
'name': 'test',
|
||||
@ -304,28 +252,14 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
}
|
||||
})
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_OFF == state.state
|
||||
|
||||
# short flash
|
||||
common.turn_on(self.hass, 'light.test', flash='short')
|
||||
self.hass.block_till_done()
|
||||
|
||||
self.mock_publish.async_publish.assert_called_once_with(
|
||||
'test_light_rgb/set', 'on,short', 0, False)
|
||||
self.mock_publish.async_publish.reset_mock()
|
||||
|
||||
# long flash
|
||||
common.turn_on(self.hass, 'light.test', flash='long')
|
||||
self.hass.block_till_done()
|
||||
|
||||
self.mock_publish.async_publish.assert_called_once_with(
|
||||
'test_light_rgb/set', 'on,long', 0, False)
|
||||
|
||||
def test_transition(self):
|
||||
async def test_transition(hass, mqtt_mock):
|
||||
"""Test for transition time being sent when included."""
|
||||
with assert_setup_component(1, light.DOMAIN):
|
||||
assert setup_component(self.hass, light.DOMAIN, {
|
||||
assert await async_setup_component(hass, light.DOMAIN, {
|
||||
light.DOMAIN: {
|
||||
'platform': 'mqtt_template',
|
||||
'name': 'test',
|
||||
@ -335,28 +269,14 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
}
|
||||
})
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_OFF == state.state
|
||||
|
||||
# transition on
|
||||
common.turn_on(self.hass, 'light.test', transition=10)
|
||||
self.hass.block_till_done()
|
||||
|
||||
self.mock_publish.async_publish.assert_called_once_with(
|
||||
'test_light_rgb/set', 'on,10', 0, False)
|
||||
self.mock_publish.async_publish.reset_mock()
|
||||
|
||||
# transition off
|
||||
common.turn_off(self.hass, 'light.test', transition=4)
|
||||
self.hass.block_till_done()
|
||||
|
||||
self.mock_publish.async_publish.assert_called_once_with(
|
||||
'test_light_rgb/set', 'off,4', 0, False)
|
||||
|
||||
def test_invalid_values(self):
|
||||
async def test_invalid_values(hass, mqtt_mock):
|
||||
"""Test that invalid values are ignored."""
|
||||
with assert_setup_component(1, light.DOMAIN):
|
||||
assert setup_component(self.hass, light.DOMAIN, {
|
||||
assert await async_setup_component(hass, light.DOMAIN, {
|
||||
light.DOMAIN: {
|
||||
'platform': 'mqtt_template',
|
||||
'name': 'test',
|
||||
@ -385,7 +305,7 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
}
|
||||
})
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_OFF == state.state
|
||||
assert state.attributes.get('rgb_color') is None
|
||||
assert state.attributes.get('brightness') is None
|
||||
@ -395,11 +315,11 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
assert not state.attributes.get(ATTR_ASSUMED_STATE)
|
||||
|
||||
# turn on the light, full white
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb',
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb',
|
||||
'on,255,215,222,255-255-255,rainbow')
|
||||
self.hass.block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_ON == state.state
|
||||
assert 255 == state.attributes.get('brightness')
|
||||
assert 215 == state.attributes.get('color_temp')
|
||||
@ -408,56 +328,57 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
assert 'rainbow' == state.attributes.get('effect')
|
||||
|
||||
# bad state value
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb', 'offf')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb', 'offf')
|
||||
await hass.async_block_till_done()
|
||||
|
||||
# state should not have changed
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_ON == state.state
|
||||
|
||||
# bad brightness values
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,off,255-255-255')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb', 'on,off,255-255-255')
|
||||
await hass.async_block_till_done()
|
||||
|
||||
# brightness should not have changed
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert 255 == state.attributes.get('brightness')
|
||||
|
||||
# bad color temp values
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,,off,255-255-255')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb', 'on,,off,255-255-255')
|
||||
await hass.async_block_till_done()
|
||||
|
||||
# color temp should not have changed
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert 215 == state.attributes.get('color_temp')
|
||||
|
||||
# bad color values
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,255,a-b-c')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb', 'on,255,a-b-c')
|
||||
await hass.async_block_till_done()
|
||||
|
||||
# color should not have changed
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert (255, 255, 255) == state.attributes.get('rgb_color')
|
||||
|
||||
# bad white value values
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,,,off,255-255-255')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb', 'on,,,off,255-255-255')
|
||||
await hass.async_block_till_done()
|
||||
|
||||
# white value should not have changed
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert 222 == state.attributes.get('white_value')
|
||||
|
||||
# bad effect value
|
||||
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,255,a-b-c,white')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'test_light_rgb', 'on,255,a-b-c,white')
|
||||
await hass.async_block_till_done()
|
||||
|
||||
# effect should not have changed
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert 'rainbow' == state.attributes.get('effect')
|
||||
|
||||
def test_default_availability_payload(self):
|
||||
|
||||
async def test_default_availability_payload(hass, mqtt_mock):
|
||||
"""Test availability by default payload with defined topic."""
|
||||
assert setup_component(self.hass, light.DOMAIN, {
|
||||
assert await async_setup_component(hass, light.DOMAIN, {
|
||||
light.DOMAIN: {
|
||||
'platform': 'mqtt_template',
|
||||
'name': 'test',
|
||||
@ -468,24 +389,26 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
}
|
||||
})
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_UNAVAILABLE == state.state
|
||||
|
||||
fire_mqtt_message(self.hass, 'availability-topic', 'online')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'availability-topic', 'online')
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_UNAVAILABLE != state.state
|
||||
|
||||
fire_mqtt_message(self.hass, 'availability-topic', 'offline')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'availability-topic', 'offline')
|
||||
await hass.async_block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_UNAVAILABLE == state.state
|
||||
|
||||
def test_custom_availability_payload(self):
|
||||
|
||||
async def test_custom_availability_payload(hass, mqtt_mock):
|
||||
"""Test availability by custom payload with defined topic."""
|
||||
assert setup_component(self.hass, light.DOMAIN, {
|
||||
assert await async_setup_component(hass, light.DOMAIN, {
|
||||
light.DOMAIN: {
|
||||
'platform': 'mqtt_template',
|
||||
'name': 'test',
|
||||
@ -498,17 +421,18 @@ class TestLightMQTTTemplate(unittest.TestCase):
|
||||
}
|
||||
})
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_UNAVAILABLE == state.state
|
||||
|
||||
fire_mqtt_message(self.hass, 'availability-topic', 'good')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'availability-topic', 'good')
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_UNAVAILABLE != state.state
|
||||
|
||||
fire_mqtt_message(self.hass, 'availability-topic', 'nogood')
|
||||
self.hass.block_till_done()
|
||||
async_fire_mqtt_message(hass, 'availability-topic', 'nogood')
|
||||
await hass.async_block_till_done()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = self.hass.states.get('light.test')
|
||||
state = hass.states.get('light.test')
|
||||
assert STATE_UNAVAILABLE == state.state
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user