WIP: Timer component (#9889)

* Added timer component * Reworked functionality a bit * Fixed requested change * Fixed state updates when finished * Removing expired listeners, added events, changed services * Added finish service * Using timedelta parameters in start-service * Cleanup * Lint * Updating state for remaining time * Removed duration from cancel method * Renamed service to fix disabled lint * Some tests (incomplete) * Relocated service descriptions * Addressed requested changes * Adjusted tests, added methods and events * Added test for finish service, lint * Code cleanp, using string states * tzzz... one char... * Proper usage of restore_state * Some more cleanup
2026-10-03 15:59:57 +00:00 · 2017-10-31 20:20:56 -07:00
parent 253c8aee1f
commit 890c11cc7c
3 changed files with 553 additions and 0 deletions
@@ -0,0 +1,199 @@
+"""The tests for the timer component."""
+# pylint: disable=protected-access
+import asyncio
+import unittest
+import logging
+from datetime import timedelta
+
+from homeassistant.core import CoreState
+from homeassistant.setup import setup_component, async_setup_component
+from homeassistant.components.timer import (
+    DOMAIN, CONF_DURATION, CONF_NAME, STATUS_ACTIVE, STATUS_IDLE,
+    STATUS_PAUSED, CONF_ICON, ATTR_DURATION, EVENT_TIMER_FINISHED,
+    EVENT_TIMER_CANCELLED, SERVICE_START, SERVICE_PAUSE, SERVICE_CANCEL,
+    SERVICE_FINISH)
+from homeassistant.const import (ATTR_ICON, ATTR_FRIENDLY_NAME, CONF_ENTITY_ID)
+from homeassistant.util.dt import utcnow
+
+from tests.common import (get_test_home_assistant, async_fire_time_changed)
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class TestTimer(unittest.TestCase):
+    """Test the timer component."""
+
+    # pylint: disable=invalid-name
+    def setUp(self):
+        """Set up things to be run when tests are started."""
+        self.hass = get_test_home_assistant()
+
+    # pylint: disable=invalid-name
+    def tearDown(self):
+        """Stop everything that was started."""
+        self.hass.stop()
+
+    def test_config(self):
+        """Test config."""
+        invalid_configs = [
+            None,
+            1,
+            {},
+            {'name with space': None},
+        ]
+
+        for cfg in invalid_configs:
+            self.assertFalse(
+                setup_component(self.hass, DOMAIN, {DOMAIN: cfg}))
+
+    def test_config_options(self):
+        """Test configuration options."""
+        count_start = len(self.hass.states.entity_ids())
+
+        _LOGGER.debug('ENTITIES @ start: %s', self.hass.states.entity_ids())
+
+        config = {
+            DOMAIN: {
+                'test_1': {},
+                'test_2': {
+                    CONF_NAME: 'Hello World',
+                    CONF_ICON: 'mdi:work',
+                    CONF_DURATION: 10,
+                }
+            }
+        }
+
+        assert setup_component(self.hass, 'timer', config)
+        self.hass.block_till_done()
+
+        self.assertEqual(count_start + 2, len(self.hass.states.entity_ids()))
+        self.hass.block_till_done()
+
+        state_1 = self.hass.states.get('timer.test_1')
+        state_2 = self.hass.states.get('timer.test_2')
+
+        self.assertIsNotNone(state_1)
+        self.assertIsNotNone(state_2)
+
+        self.assertEqual(STATUS_IDLE, state_1.state)
+        self.assertNotIn(ATTR_ICON, state_1.attributes)
+        self.assertNotIn(ATTR_FRIENDLY_NAME, state_1.attributes)
+
+        self.assertEqual(STATUS_IDLE, state_2.state)
+        self.assertEqual('Hello World',
+                         state_2.attributes.get(ATTR_FRIENDLY_NAME))
+        self.assertEqual('mdi:work', state_2.attributes.get(ATTR_ICON))
+        self.assertEqual('0:00:10', state_2.attributes.get(ATTR_DURATION))
+
+
+@asyncio.coroutine
+def test_methods_and_events(hass):
+    """Test methods and events."""
+    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_FINISHED, fake_event_listener)
+    hass.bus.async_listen(EVENT_TIMER_CANCELLED, fake_event_listener)
+
+    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_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 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))
+    yield from hass.async_block_till_done()
+
+    state = hass.states.get('timer.test1')
+    assert state
+    assert state.state == STATUS_IDLE
+
+    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
+def test_no_initial_state_and_no_restore_state(hass):
+    """Ensure that entity is create without initial and restore feature."""
+    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