jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-27 07:07:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

This makes mqtt_template tests async (#17784)

Browse Source
This commit is contained in:
kennedyshead 2018-10-25 10:00:07 +02:00 committed by Paulus Schoutsen
parent 8bebfba21a
commit 67d92c4f5d
1 changed files with 354 additions and 430 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

276
tests/components/light/test_mqtt_template.py
View File

@ -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`. If your light doesn't support RGB feature, omit `(red|green|blue)_template`.
""" """
import unittest
from unittest.mock import patch from unittest.mock import patch
from homeassistant.setup import setup_component from homeassistant.setup import async_setup_component
from homeassistant.const import ( from homeassistant.const import (
STATE_ON, STATE_OFF, STATE_UNAVAILABLE, ATTR_ASSUMED_STATE) STATE_ON, STATE_OFF, STATE_UNAVAILABLE, ATTR_ASSUMED_STATE)
import homeassistant.components.light as light import homeassistant.components.light as light
import homeassistant.core as ha import homeassistant.core as ha
from tests.common import ( from tests.common import (
get_test_home_assistant, mock_mqtt_component, fire_mqtt_message, async_fire_mqtt_message, assert_setup_component, mock_coro)
assert_setup_component, mock_coro)
from tests.components.light import common
class TestLightMQTTTemplate(unittest.TestCase): async def test_setup_fails(hass, mqtt_mock):
"""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):
"""Test that setup fails with missing required configuration items.""" """Test that setup fails with missing required configuration items."""
with assert_setup_component(0, light.DOMAIN): with assert_setup_component(0, light.DOMAIN):
assert setup_component(self.hass, light.DOMAIN, { assert await async_setup_component(hass, light.DOMAIN, {
light.DOMAIN: { light.DOMAIN: {
'platform': 'mqtt_template', 'platform': 'mqtt_template',
'name': 'test', '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.""" """Test state change via topic."""
with assert_setup_component(1, light.DOMAIN): with assert_setup_component(1, light.DOMAIN):
assert setup_component(self.hass, light.DOMAIN, { assert await async_setup_component(hass, light.DOMAIN, {
light.DOMAIN: { light.DOMAIN: {
'platform': 'mqtt_template', 'platform': 'mqtt_template',
'name': 'test', '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_OFF == state.state
assert state.attributes.get('rgb_color') is None assert state.attributes.get('rgb_color') is None
assert state.attributes.get('brightness') 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 state.attributes.get('white_value') is None
assert not state.attributes.get(ATTR_ASSUMED_STATE) assert not state.attributes.get(ATTR_ASSUMED_STATE)
fire_mqtt_message(self.hass, 'test_light_rgb', 'on') async_fire_mqtt_message(hass, 'test_light_rgb', 'on')
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 STATE_ON == state.state
assert state.attributes.get('rgb_color') is None assert state.attributes.get('rgb_color') is None
assert state.attributes.get('brightness') is None assert state.attributes.get('brightness') is None
assert state.attributes.get('color_temp') is None assert state.attributes.get('color_temp') is None
assert state.attributes.get('white_value') 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.""" """Test state, bri, color, effect, color temp, white val change."""
with assert_setup_component(1, light.DOMAIN): with assert_setup_component(1, light.DOMAIN):
assert setup_component(self.hass, light.DOMAIN, { assert await async_setup_component(hass, light.DOMAIN, {
light.DOMAIN: { light.DOMAIN: {
'platform': 'mqtt_template', 'platform': 'mqtt_template',
'name': 'test', '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_OFF == state.state
assert state.attributes.get('rgb_color') is None assert state.attributes.get('rgb_color') is None
assert state.attributes.get('brightness') 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) assert not state.attributes.get(ATTR_ASSUMED_STATE)
# turn on the light, full white # 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,') '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 STATE_ON == state.state
assert (255, 128, 63) == state.attributes.get('rgb_color') assert (255, 128, 63) == state.attributes.get('rgb_color')
assert 255 == state.attributes.get('brightness') assert 255 == state.attributes.get('brightness')
@ -159,53 +147,57 @@ class TestLightMQTTTemplate(unittest.TestCase):
assert state.attributes.get('effect') is None assert state.attributes.get('effect') is None
# turn the light off # turn the light off
fire_mqtt_message(self.hass, 'test_light_rgb', 'off') async_fire_mqtt_message(hass, 'test_light_rgb', 'off')
self.hass.block_till_done() 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 assert STATE_OFF == state.state
# lower the brightness # lower the brightness
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,100') async_fire_mqtt_message(hass, 'test_light_rgb', 'on,100')
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')
self.hass.block_till_done()
assert 100 == light_state.attributes['brightness'] assert 100 == light_state.attributes['brightness']
# change the color temp # change the color temp
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,,195') async_fire_mqtt_message(hass, 'test_light_rgb', 'on,,195')
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')
self.hass.block_till_done()
assert 195 == light_state.attributes['color_temp'] assert 195 == light_state.attributes['color_temp']
# change the color # change the color
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,,,,41-42-43') async_fire_mqtt_message(hass, 'test_light_rgb', 'on,,,,41-42-43')
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 (243, 249, 255) == \ assert (243, 249, 255) == \
light_state.attributes.get('rgb_color') light_state.attributes.get('rgb_color')
# change the white value # change the white value
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,,,134') async_fire_mqtt_message(hass, 'test_light_rgb', 'on,,,134')
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')
self.hass.block_till_done()
assert 134 == light_state.attributes['white_value'] assert 134 == light_state.attributes['white_value']
# change the effect # change the effect
fire_mqtt_message(self.hass, 'test_light_rgb', async_fire_mqtt_message(hass, 'test_light_rgb',
'on,,,,41-42-43,rainbow') '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') assert 'rainbow' == light_state.attributes.get('effect')
def test_optimistic(self):
async def test_optimistic(hass, mqtt_mock):
"""Test optimistic mode.""" """Test optimistic mode."""
fake_state = ha.State('light.test', 'on', {'brightness': 95, fake_state = ha.State('light.test', 'on', {'brightness': 95,
'hs_color': [100, 100], 'hs_color': [100, 100],
@ -217,7 +209,7 @@ class TestLightMQTTTemplate(unittest.TestCase):
'.async_get_last_state', '.async_get_last_state',
return_value=mock_coro(fake_state)): return_value=mock_coro(fake_state)):
with assert_setup_component(1, light.DOMAIN): with assert_setup_component(1, light.DOMAIN):
assert setup_component(self.hass, light.DOMAIN, { assert await async_setup_component(hass, light.DOMAIN, {
light.DOMAIN: { light.DOMAIN: {
'platform': 'mqtt_template', 'platform': 'mqtt_template',
'name': 'test', '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 STATE_ON == state.state
assert 95 == state.attributes.get('brightness') assert 95 == state.attributes.get('brightness')
assert (100, 100) == state.attributes.get('hs_color') assert (100, 100) == state.attributes.get('hs_color')
@ -245,55 +237,11 @@ class TestLightMQTTTemplate(unittest.TestCase):
assert 50 == state.attributes.get('white_value') assert 50 == state.attributes.get('white_value')
assert state.attributes.get(ATTR_ASSUMED_STATE) 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( async def test_flash(hass, mqtt_mock):
'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):
"""Test flash.""" """Test flash."""
with assert_setup_component(1, light.DOMAIN): with assert_setup_component(1, light.DOMAIN):
assert setup_component(self.hass, light.DOMAIN, { assert await async_setup_component(hass, light.DOMAIN, {
light.DOMAIN: { light.DOMAIN: {
'platform': 'mqtt_template', 'platform': 'mqtt_template',
'name': 'test', '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 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( async def test_transition(hass, mqtt_mock):
'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):
"""Test for transition time being sent when included.""" """Test for transition time being sent when included."""
with assert_setup_component(1, light.DOMAIN): with assert_setup_component(1, light.DOMAIN):
assert setup_component(self.hass, light.DOMAIN, { assert await async_setup_component(hass, light.DOMAIN, {
light.DOMAIN: { light.DOMAIN: {
'platform': 'mqtt_template', 'platform': 'mqtt_template',
'name': 'test', '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 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( async def test_invalid_values(hass, mqtt_mock):
'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):
"""Test that invalid values are ignored.""" """Test that invalid values are ignored."""
with assert_setup_component(1, light.DOMAIN): with assert_setup_component(1, light.DOMAIN):
assert setup_component(self.hass, light.DOMAIN, { assert await async_setup_component(hass, light.DOMAIN, {
light.DOMAIN: { light.DOMAIN: {
'platform': 'mqtt_template', 'platform': 'mqtt_template',
'name': 'test', '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_OFF == state.state
assert state.attributes.get('rgb_color') is None assert state.attributes.get('rgb_color') is None
assert state.attributes.get('brightness') 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) assert not state.attributes.get(ATTR_ASSUMED_STATE)
# turn on the light, full white # 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') '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 STATE_ON == state.state
assert 255 == state.attributes.get('brightness') assert 255 == state.attributes.get('brightness')
assert 215 == state.attributes.get('color_temp') assert 215 == state.attributes.get('color_temp')
@ -408,56 +328,57 @@ class TestLightMQTTTemplate(unittest.TestCase):
assert 'rainbow' == state.attributes.get('effect') assert 'rainbow' == state.attributes.get('effect')
# bad state value # bad state value
fire_mqtt_message(self.hass, 'test_light_rgb', 'offf') async_fire_mqtt_message(hass, 'test_light_rgb', 'offf')
self.hass.block_till_done() await hass.async_block_till_done()
# state should not have changed # state should not have changed
state = self.hass.states.get('light.test') state = hass.states.get('light.test')
assert STATE_ON == state.state assert STATE_ON == state.state
# bad brightness values # bad brightness values
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,off,255-255-255') async_fire_mqtt_message(hass, 'test_light_rgb', 'on,off,255-255-255')
self.hass.block_till_done() await hass.async_block_till_done()
# brightness should not have changed # brightness should not have changed
state = self.hass.states.get('light.test') state = hass.states.get('light.test')
assert 255 == state.attributes.get('brightness') assert 255 == state.attributes.get('brightness')
# bad color temp values # bad color temp values
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,,off,255-255-255') async_fire_mqtt_message(hass, 'test_light_rgb', 'on,,off,255-255-255')
self.hass.block_till_done() await hass.async_block_till_done()
# color temp should not have changed # 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') assert 215 == state.attributes.get('color_temp')
# bad color values # bad color values
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,255,a-b-c') async_fire_mqtt_message(hass, 'test_light_rgb', 'on,255,a-b-c')
self.hass.block_till_done() await hass.async_block_till_done()
# color should not have changed # 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') assert (255, 255, 255) == state.attributes.get('rgb_color')
# bad white value values # bad white value values
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,,,off,255-255-255') async_fire_mqtt_message(hass, 'test_light_rgb', 'on,,,off,255-255-255')
self.hass.block_till_done() await hass.async_block_till_done()
# white value should not have changed # 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') assert 222 == state.attributes.get('white_value')
# bad effect value # bad effect value
fire_mqtt_message(self.hass, 'test_light_rgb', 'on,255,a-b-c,white') async_fire_mqtt_message(hass, 'test_light_rgb', 'on,255,a-b-c,white')
self.hass.block_till_done() await hass.async_block_till_done()
# effect should not have changed # effect should not have changed
state = self.hass.states.get('light.test') state = hass.states.get('light.test')
assert 'rainbow' == state.attributes.get('effect') 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.""" """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: { light.DOMAIN: {
'platform': 'mqtt_template', 'platform': 'mqtt_template',
'name': 'test', '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 assert STATE_UNAVAILABLE == state.state
fire_mqtt_message(self.hass, 'availability-topic', 'online') async_fire_mqtt_message(hass, 'availability-topic', 'online')
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_UNAVAILABLE != state.state assert STATE_UNAVAILABLE != state.state
fire_mqtt_message(self.hass, 'availability-topic', 'offline') async_fire_mqtt_message(hass, 'availability-topic', 'offline')
self.hass.block_till_done() 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 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.""" """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: { light.DOMAIN: {
'platform': 'mqtt_template', 'platform': 'mqtt_template',
'name': 'test', '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 assert STATE_UNAVAILABLE == state.state
fire_mqtt_message(self.hass, 'availability-topic', 'good') async_fire_mqtt_message(hass, 'availability-topic', 'good')
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_UNAVAILABLE != state.state assert STATE_UNAVAILABLE != state.state
fire_mqtt_message(self.hass, 'availability-topic', 'nogood') async_fire_mqtt_message(hass, 'availability-topic', 'nogood')
self.hass.block_till_done() 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 assert STATE_UNAVAILABLE == state.state