Added events STARTED, RESTARTED AND PAUSED (#19516)

Rewrote the tests a bit
the 'wait for the timer to finish' part of the test is now it's own test.
The rest is a sequence of fire/assert. Which i rewrote to a loop to
reduce the amount of duplicate code
This commit is contained in:
Robbert Müller 2018-12-29 16:40:17 +01:00 committed by Fabian Affolter
parent dc9da79a1c
commit 9928b977fd
2 changed files with 116 additions and 51 deletions

View file

@ -33,6 +33,9 @@ STATUS_PAUSED = 'paused'
EVENT_TIMER_FINISHED = 'timer.finished' EVENT_TIMER_FINISHED = 'timer.finished'
EVENT_TIMER_CANCELLED = 'timer.cancelled' EVENT_TIMER_CANCELLED = 'timer.cancelled'
EVENT_TIMER_STARTED = 'timer.started'
EVENT_TIMER_RESTARTED = 'timer.restarted'
EVENT_TIMER_PAUSED = 'timer.paused'
SERVICE_START = 'start' SERVICE_START = 'start'
SERVICE_PAUSE = 'pause' SERVICE_PAUSE = 'pause'
@ -158,6 +161,10 @@ class Timer(RestoreEntity):
if duration: if duration:
newduration = duration newduration = duration
event = EVENT_TIMER_STARTED
if self._state == STATUS_PAUSED:
event = EVENT_TIMER_RESTARTED
self._state = STATUS_ACTIVE self._state = STATUS_ACTIVE
# pylint: disable=redefined-outer-name # pylint: disable=redefined-outer-name
start = dt_util.utcnow() start = dt_util.utcnow()
@ -170,6 +177,10 @@ class Timer(RestoreEntity):
else: else:
self._remaining = self._duration self._remaining = self._duration
self._end = start + self._duration self._end = start + self._duration
self._hass.bus.async_fire(event,
{"entity_id": self.entity_id})
self._listener = async_track_point_in_utc_time(self._hass, self._listener = async_track_point_in_utc_time(self._hass,
self.async_finished, self.async_finished,
self._end) self._end)
@ -185,6 +196,8 @@ class Timer(RestoreEntity):
self._remaining = self._end - dt_util.utcnow() self._remaining = self._end - dt_util.utcnow()
self._state = STATUS_PAUSED self._state = STATUS_PAUSED
self._end = None self._end = None
self._hass.bus.async_fire(EVENT_TIMER_PAUSED,
{"entity_id": self.entity_id})
await self.async_update_ha_state() await self.async_update_ha_state()
async def async_cancel(self): async def async_cancel(self):

View file

@ -9,7 +9,8 @@ from homeassistant.setup import async_setup_component
from homeassistant.components.timer import ( from homeassistant.components.timer import (
DOMAIN, CONF_DURATION, CONF_NAME, STATUS_ACTIVE, STATUS_IDLE, DOMAIN, CONF_DURATION, CONF_NAME, STATUS_ACTIVE, STATUS_IDLE,
STATUS_PAUSED, CONF_ICON, ATTR_DURATION, EVENT_TIMER_FINISHED, STATUS_PAUSED, CONF_ICON, ATTR_DURATION, EVENT_TIMER_FINISHED,
EVENT_TIMER_CANCELLED, SERVICE_START, SERVICE_PAUSE, SERVICE_CANCEL, EVENT_TIMER_CANCELLED, EVENT_TIMER_STARTED, EVENT_TIMER_RESTARTED,
EVENT_TIMER_PAUSED, SERVICE_START, SERVICE_PAUSE, SERVICE_CANCEL,
SERVICE_FINISH) SERVICE_FINISH)
from homeassistant.const import (ATTR_ICON, ATTR_FRIENDLY_NAME, CONF_ENTITY_ID) from homeassistant.const import (ATTR_ICON, ATTR_FRIENDLY_NAME, CONF_ENTITY_ID)
from homeassistant.util.dt import utcnow from homeassistant.util.dt import utcnow
@ -94,6 +95,105 @@ def test_methods_and_events(hass):
"""Fake event listener for trigger.""" """Fake event listener for trigger."""
results.append(event) results.append(event)
hass.bus.async_listen(EVENT_TIMER_STARTED, fake_event_listener)
hass.bus.async_listen(EVENT_TIMER_RESTARTED, fake_event_listener)
hass.bus.async_listen(EVENT_TIMER_PAUSED, fake_event_listener)
hass.bus.async_listen(EVENT_TIMER_FINISHED, fake_event_listener)
hass.bus.async_listen(EVENT_TIMER_CANCELLED, fake_event_listener)
steps = [
{
'call': SERVICE_START,
'state': STATUS_ACTIVE,
'event': EVENT_TIMER_STARTED,
},
{
'call': SERVICE_PAUSE,
'state': STATUS_PAUSED,
'event': EVENT_TIMER_PAUSED,
},
{
'call': SERVICE_START,
'state': STATUS_ACTIVE,
'event': EVENT_TIMER_RESTARTED,
},
{
'call': SERVICE_CANCEL,
'state': STATUS_IDLE,
'event': EVENT_TIMER_CANCELLED,
},
{
'call': SERVICE_START,
'state': STATUS_ACTIVE,
'event': EVENT_TIMER_STARTED,
},
{
'call': SERVICE_FINISH,
'state': STATUS_IDLE,
'event': EVENT_TIMER_FINISHED,
},
{
'call': SERVICE_START,
'state': STATUS_ACTIVE,
'event': EVENT_TIMER_STARTED,
},
{
'call': SERVICE_PAUSE,
'state': STATUS_PAUSED,
'event': EVENT_TIMER_PAUSED,
},
{
'call': SERVICE_CANCEL,
'state': STATUS_IDLE,
'event': EVENT_TIMER_CANCELLED,
}
]
expectedEvents = 0
for step in steps:
if step['call'] is not None:
yield from hass.services.async_call(
DOMAIN,
step['call'],
{CONF_ENTITY_ID: 'timer.test1'}
)
yield from hass.async_block_till_done()
state = hass.states.get('timer.test1')
assert state
if step['state'] is not None:
assert state.state == step['state']
if step['event'] is not None:
expectedEvents += 1
assert results[-1].event_type == step['event']
assert len(results) == expectedEvents
@asyncio.coroutine
def test_wait_till_timer_expires(hass):
"""Test for a timer to end."""
hass.state = CoreState.starting
yield from async_setup_component(hass, DOMAIN, {
DOMAIN: {
'test1': {
CONF_DURATION: 10,
}
}})
state = hass.states.get('timer.test1')
assert state
assert state.state == STATUS_IDLE
results = []
def fake_event_listener(event):
"""Fake event listener for trigger."""
results.append(event)
hass.bus.async_listen(EVENT_TIMER_STARTED, fake_event_listener)
hass.bus.async_listen(EVENT_TIMER_PAUSED, fake_event_listener)
hass.bus.async_listen(EVENT_TIMER_FINISHED, fake_event_listener) hass.bus.async_listen(EVENT_TIMER_FINISHED, fake_event_listener)
hass.bus.async_listen(EVENT_TIMER_CANCELLED, fake_event_listener) hass.bus.async_listen(EVENT_TIMER_CANCELLED, fake_event_listener)
@ -106,35 +206,8 @@ def test_methods_and_events(hass):
assert state assert state
assert state.state == STATUS_ACTIVE assert state.state == STATUS_ACTIVE
yield from hass.services.async_call(DOMAIN, assert results[-1].event_type == EVENT_TIMER_STARTED
SERVICE_PAUSE,
{CONF_ENTITY_ID: 'timer.test1'})
yield from hass.async_block_till_done()
state = hass.states.get('timer.test1')
assert state
assert state.state == STATUS_PAUSED
yield from hass.services.async_call(DOMAIN,
SERVICE_CANCEL,
{CONF_ENTITY_ID: 'timer.test1'})
yield from hass.async_block_till_done()
state = hass.states.get('timer.test1')
assert state
assert state.state == STATUS_IDLE
assert len(results) == 1 assert len(results) == 1
assert results[-1].event_type == EVENT_TIMER_CANCELLED
yield from hass.services.async_call(DOMAIN,
SERVICE_START,
{CONF_ENTITY_ID: 'timer.test1'})
yield from hass.async_block_till_done()
state = hass.states.get('timer.test1')
assert state
assert state.state == STATUS_ACTIVE
async_fire_time_changed(hass, utcnow() + timedelta(seconds=10)) async_fire_time_changed(hass, utcnow() + timedelta(seconds=10))
yield from hass.async_block_till_done() yield from hass.async_block_till_done()
@ -143,29 +216,8 @@ def test_methods_and_events(hass):
assert state assert state
assert state.state == STATUS_IDLE assert state.state == STATUS_IDLE
assert results[-1].event_type == EVENT_TIMER_FINISHED
assert len(results) == 2 assert len(results) == 2
assert results[-1].event_type == EVENT_TIMER_FINISHED
yield from hass.services.async_call(DOMAIN,
SERVICE_START,
{CONF_ENTITY_ID: 'timer.test1'})
yield from hass.async_block_till_done()
state = hass.states.get('timer.test1')
assert state
assert state.state == STATUS_ACTIVE
yield from hass.services.async_call(DOMAIN,
SERVICE_FINISH,
{CONF_ENTITY_ID: 'timer.test1'})
yield from hass.async_block_till_done()
state = hass.states.get('timer.test1')
assert state
assert state.state == STATUS_IDLE
assert len(results) == 3
assert results[-1].event_type == EVENT_TIMER_FINISHED
@asyncio.coroutine @asyncio.coroutine