Utility meter (#19718)
* initial commit * test service calls * lint * float -> Decimal * extra tests * lint * lint * lint * lint * fix self reset * clean * add services * improve service example description * add optional paused initialization * fix * travis fix * fix YEARLY * add tests for previous bug * address comments and suggestions from @ottowinter * lint * remove debug * add discoverability capabilities * no need for _hass * Update homeassistant/components/sensor/utility_meter.py Co-Authored-By: dgomes <diogogomes@gmail.com> * Update homeassistant/components/sensor/utility_meter.py Co-Authored-By: dgomes <diogogomes@gmail.com> * correct comment * improve error handling * address @MartinHjelmare comments * address @MartinHjelmare comments * one patch is enought * follow @ballob suggestion in https://github.com/home-assistant/architecture/issues/131 * fix tests * review fixes * major refactor * lint * lint * address comments by @MartinHjelmare * rename variable
This commit is contained in:
1 parent
ed6e349515
commit
1d5ffe9ad5
7 files changed
+713
No files matched your search
@@ -0,0 +1 @@
|
||||
"""Tests for Utility Meter component."""
|
||||
@@ -0,0 +1,102 @@
|
||||
"""The tests for the utility_meter component."""
|
||||
import logging
|
||||
|
||||
from datetime import timedelta
|
||||
from unittest.mock import patch
|
||||
|
||||
from homeassistant.const import (
|
||||
EVENT_HOMEASSISTANT_START, ATTR_ENTITY_ID)
|
||||
from homeassistant.components.utility_meter.const import (
|
||||
SERVICE_RESET, SERVICE_SELECT_TARIFF, SERVICE_SELECT_NEXT_TARIFF,
|
||||
ATTR_TARIFF)
|
||||
from homeassistant.setup import async_setup_component
|
||||
import homeassistant.util.dt as dt_util
|
||||
from homeassistant.components.utility_meter.const import DOMAIN
|
||||
from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
async def test_services(hass):
|
||||
"""Test energy sensor reset service."""
|
||||
config = {
|
||||
'utility_meter': {
|
||||
'energy_bill': {
|
||||
'source': 'sensor.energy',
|
||||
'cycle': 'hourly',
|
||||
'tariffs': ['peak', 'offpeak'],
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
assert await async_setup_component(hass, DOMAIN, config)
|
||||
assert await async_setup_component(hass, SENSOR_DOMAIN, config)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
hass.bus.async_fire(EVENT_HOMEASSISTANT_START)
|
||||
entity_id = config[DOMAIN]['energy_bill']['source']
|
||||
hass.states.async_set(entity_id, 1, {"unit_of_measurement": "kWh"})
|
||||
await hass.async_block_till_done()
|
||||
|
||||
now = dt_util.utcnow() + timedelta(seconds=10)
|
||||
with patch('homeassistant.util.dt.utcnow',
|
||||
return_value=now):
|
||||
hass.states.async_set(entity_id, 3, {"unit_of_measurement": "kWh"},
|
||||
force_update=True)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = hass.states.get('sensor.energy_bill_peak')
|
||||
assert state.state == '2'
|
||||
|
||||
state = hass.states.get('sensor.energy_bill_offpeak')
|
||||
assert state.state == '0'
|
||||
|
||||
# Next tariff
|
||||
data = {ATTR_ENTITY_ID: 'utility_meter.energy_bill'}
|
||||
await hass.services.async_call(DOMAIN,
|
||||
SERVICE_SELECT_NEXT_TARIFF, data)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
now += timedelta(seconds=10)
|
||||
with patch('homeassistant.util.dt.utcnow',
|
||||
return_value=now):
|
||||
hass.states.async_set(entity_id, 4, {"unit_of_measurement": "kWh"},
|
||||
force_update=True)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = hass.states.get('sensor.energy_bill_peak')
|
||||
assert state.state == '2'
|
||||
|
||||
state = hass.states.get('sensor.energy_bill_offpeak')
|
||||
assert state.state == '1'
|
||||
|
||||
# Change tariff
|
||||
data = {ATTR_ENTITY_ID: 'utility_meter.energy_bill',
|
||||
ATTR_TARIFF: 'peak'}
|
||||
await hass.services.async_call(DOMAIN,
|
||||
SERVICE_SELECT_TARIFF, data)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
now += timedelta(seconds=10)
|
||||
with patch('homeassistant.util.dt.utcnow',
|
||||
return_value=now):
|
||||
hass.states.async_set(entity_id, 5, {"unit_of_measurement": "kWh"},
|
||||
force_update=True)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = hass.states.get('sensor.energy_bill_peak')
|
||||
assert state.state == '3'
|
||||
|
||||
state = hass.states.get('sensor.energy_bill_offpeak')
|
||||
assert state.state == '1'
|
||||
|
||||
# Reset meters
|
||||
data = {ATTR_ENTITY_ID: 'utility_meter.energy_bill'}
|
||||
await hass.services.async_call(DOMAIN, SERVICE_RESET, data)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = hass.states.get('sensor.energy_bill_peak')
|
||||
assert state.state == '0'
|
||||
|
||||
state = hass.states.get('sensor.energy_bill_offpeak')
|
||||
assert state.state == '0'
|
||||
@@ -0,0 +1,136 @@
|
||||
"""The tests for the utility_meter sensor platform."""
|
||||
import logging
|
||||
|
||||
from datetime import timedelta
|
||||
from unittest.mock import patch
|
||||
from contextlib import contextmanager
|
||||
|
||||
from tests.common import async_fire_time_changed
|
||||
from homeassistant.const import EVENT_HOMEASSISTANT_START
|
||||
from homeassistant.setup import async_setup_component
|
||||
import homeassistant.util.dt as dt_util
|
||||
from homeassistant.components.utility_meter.const import DOMAIN
|
||||
from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@contextmanager
|
||||
def alter_time(retval):
|
||||
"""Manage multiple time mocks."""
|
||||
patch1 = patch("homeassistant.util.dt.utcnow", return_value=retval)
|
||||
patch2 = patch("homeassistant.util.dt.now", return_value=retval)
|
||||
|
||||
with patch1, patch2:
|
||||
yield
|
||||
|
||||
|
||||
async def test_state(hass):
|
||||
"""Test utility sensor state."""
|
||||
config = {
|
||||
'utility_meter': {
|
||||
'energy_bill': {
|
||||
'source': 'sensor.energy',
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
assert await async_setup_component(hass, DOMAIN, config)
|
||||
assert await async_setup_component(hass, SENSOR_DOMAIN, config)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
hass.bus.async_fire(EVENT_HOMEASSISTANT_START)
|
||||
entity_id = config[DOMAIN]['energy_bill']['source']
|
||||
hass.states.async_set(entity_id, 2, {"unit_of_measurement": "kWh"})
|
||||
await hass.async_block_till_done()
|
||||
|
||||
now = dt_util.utcnow() + timedelta(seconds=10)
|
||||
with patch('homeassistant.util.dt.utcnow',
|
||||
return_value=now):
|
||||
hass.states.async_set(entity_id, 3, {"unit_of_measurement": "kWh"},
|
||||
force_update=True)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = hass.states.get('sensor.energy_bill')
|
||||
assert state is not None
|
||||
|
||||
assert state.state == '1'
|
||||
|
||||
|
||||
async def _test_self_reset(hass, cycle, start_time, expect_reset=True):
|
||||
"""Test energy sensor self reset."""
|
||||
config = {
|
||||
'utility_meter': {
|
||||
'energy_bill': {
|
||||
'source': 'sensor.energy',
|
||||
'cycle': cycle
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
assert await async_setup_component(hass, DOMAIN, config)
|
||||
assert await async_setup_component(hass, SENSOR_DOMAIN, config)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
hass.bus.async_fire(EVENT_HOMEASSISTANT_START)
|
||||
entity_id = config[DOMAIN]['energy_bill']['source']
|
||||
|
||||
now = dt_util.parse_datetime(start_time)
|
||||
with alter_time(now):
|
||||
async_fire_time_changed(hass, now)
|
||||
hass.states.async_set(entity_id, 1, {"unit_of_measurement": "kWh"})
|
||||
await hass.async_block_till_done()
|
||||
|
||||
now += timedelta(seconds=30)
|
||||
with alter_time(now):
|
||||
async_fire_time_changed(hass, now)
|
||||
hass.states.async_set(entity_id, 3, {"unit_of_measurement": "kWh"},
|
||||
force_update=True)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
now += timedelta(seconds=30)
|
||||
with alter_time(now):
|
||||
async_fire_time_changed(hass, now)
|
||||
await hass.async_block_till_done()
|
||||
hass.states.async_set(entity_id, 6, {"unit_of_measurement": "kWh"},
|
||||
force_update=True)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
state = hass.states.get('sensor.energy_bill')
|
||||
if expect_reset:
|
||||
assert state.attributes.get('last_period') == '2'
|
||||
assert state.state == '3'
|
||||
else:
|
||||
assert state.attributes.get('last_period') == 0
|
||||
assert state.state == '5'
|
||||
|
||||
|
||||
async def test_self_reset_hourly(hass):
|
||||
"""Test hourly reset of meter."""
|
||||
await _test_self_reset(hass, 'hourly', "2017-12-31T23:59:00.000000+00:00")
|
||||
|
||||
|
||||
async def test_self_reset_daily(hass):
|
||||
"""Test daily reset of meter."""
|
||||
await _test_self_reset(hass, 'daily', "2017-12-31T23:59:00.000000+00:00")
|
||||
|
||||
|
||||
async def test_self_reset_weekly(hass):
|
||||
"""Test weekly reset of meter."""
|
||||
await _test_self_reset(hass, 'weekly', "2017-12-31T23:59:00.000000+00:00")
|
||||
|
||||
|
||||
async def test_self_reset_monthly(hass):
|
||||
"""Test monthly reset of meter."""
|
||||
await _test_self_reset(hass, 'monthly', "2017-12-31T23:59:00.000000+00:00")
|
||||
|
||||
|
||||
async def test_self_reset_yearly(hass):
|
||||
"""Test yearly reset of meter."""
|
||||
await _test_self_reset(hass, 'yearly', "2017-12-31T23:59:00.000000+00:00")
|
||||
|
||||
|
||||
async def test_self_no_reset_yearly(hass):
|
||||
"""Test yearly reset of meter does not occur after 1st January."""
|
||||
await _test_self_reset(hass, 'yearly', "2018-01-01T23:59:00.000000+00:00",
|
||||
expect_reset=False)
|
||||
Reference in new issue
Block a user