Queensland bushfire alert feed platform (#24473)
* initial version of qfes bushfire geolocation platform * removed all occurrences of legally protected names; using new georss library * regenerated codeowners * fixed pylint * added one more valid category * moved library import to top and ran isort
This commit is contained in:
1 parent
9413b5a415
commit
03bb3d9ddc
9 files changed
+439
No files matched your search
@@ -0,0 +1 @@
|
||||
"""Tests for the qld_bushfire component."""
|
||||
@@ -0,0 +1,189 @@
|
||||
"""The tests for the Queensland Bushfire Alert Feed platform."""
|
||||
import datetime
|
||||
from unittest.mock import patch, MagicMock, call
|
||||
|
||||
from homeassistant.components import geo_location
|
||||
from homeassistant.components.geo_location import ATTR_SOURCE
|
||||
from homeassistant.components.qld_bushfire.geo_location import (
|
||||
ATTR_EXTERNAL_ID, SCAN_INTERVAL, ATTR_CATEGORY,
|
||||
ATTR_STATUS, ATTR_PUBLICATION_DATE, ATTR_UPDATED_DATE)
|
||||
from homeassistant.const import EVENT_HOMEASSISTANT_START, \
|
||||
CONF_RADIUS, ATTR_LATITUDE, ATTR_LONGITUDE, ATTR_FRIENDLY_NAME, \
|
||||
ATTR_UNIT_OF_MEASUREMENT, ATTR_ATTRIBUTION, CONF_LATITUDE, CONF_LONGITUDE
|
||||
from homeassistant.setup import async_setup_component
|
||||
from tests.common import assert_setup_component, async_fire_time_changed
|
||||
import homeassistant.util.dt as dt_util
|
||||
|
||||
CONFIG = {
|
||||
geo_location.DOMAIN: [
|
||||
{
|
||||
'platform': 'qld_bushfire',
|
||||
CONF_RADIUS: 200
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
CONFIG_WITH_CUSTOM_LOCATION = {
|
||||
geo_location.DOMAIN: [
|
||||
{
|
||||
'platform': 'qld_bushfire',
|
||||
CONF_RADIUS: 200,
|
||||
CONF_LATITUDE: 40.4,
|
||||
CONF_LONGITUDE: -3.7
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
def _generate_mock_feed_entry(external_id, title, distance_to_home,
|
||||
coordinates, category=None, attribution=None,
|
||||
published=None, updated=None, status=None):
|
||||
"""Construct a mock feed entry for testing purposes."""
|
||||
feed_entry = MagicMock()
|
||||
feed_entry.external_id = external_id
|
||||
feed_entry.title = title
|
||||
feed_entry.distance_to_home = distance_to_home
|
||||
feed_entry.coordinates = coordinates
|
||||
feed_entry.category = category
|
||||
feed_entry.attribution = attribution
|
||||
feed_entry.published = published
|
||||
feed_entry.updated = updated
|
||||
feed_entry.status = status
|
||||
return feed_entry
|
||||
|
||||
|
||||
async def test_setup(hass):
|
||||
"""Test the general setup of the platform."""
|
||||
# Set up some mock feed entries for this test.
|
||||
mock_entry_1 = _generate_mock_feed_entry(
|
||||
'1234', 'Title 1', 15.5, (38.0, -3.0),
|
||||
category='Category 1',
|
||||
attribution='Attribution 1',
|
||||
published=datetime.datetime(2018, 9, 22, 8, 0,
|
||||
tzinfo=datetime.timezone.utc),
|
||||
updated=datetime.datetime(2018, 9, 22, 8, 10,
|
||||
tzinfo=datetime.timezone.utc),
|
||||
status='Status 1')
|
||||
mock_entry_2 = _generate_mock_feed_entry(
|
||||
'2345', 'Title 2', 20.5, (38.1, -3.1))
|
||||
mock_entry_3 = _generate_mock_feed_entry(
|
||||
'3456', 'Title 3', 25.5, (38.2, -3.2))
|
||||
mock_entry_4 = _generate_mock_feed_entry(
|
||||
'4567', 'Title 4', 12.5, (38.3, -3.3))
|
||||
|
||||
# Patching 'utcnow' to gain more control over the timed update.
|
||||
utcnow = dt_util.utcnow()
|
||||
with patch('homeassistant.util.dt.utcnow', return_value=utcnow), \
|
||||
patch('georss_qld_bushfire_alert_client.'
|
||||
'QldBushfireAlertFeed') as mock_feed:
|
||||
mock_feed.return_value.update.return_value = 'OK', [mock_entry_1,
|
||||
mock_entry_2,
|
||||
mock_entry_3]
|
||||
with assert_setup_component(1, geo_location.DOMAIN):
|
||||
assert await async_setup_component(
|
||||
hass, geo_location.DOMAIN, CONFIG)
|
||||
# Artificially trigger update.
|
||||
hass.bus.async_fire(EVENT_HOMEASSISTANT_START)
|
||||
# Collect events.
|
||||
await hass.async_block_till_done()
|
||||
|
||||
all_states = hass.states.async_all()
|
||||
assert len(all_states) == 3
|
||||
|
||||
state = hass.states.get("geo_location.title_1")
|
||||
assert state is not None
|
||||
assert state.name == "Title 1"
|
||||
assert state.attributes == {
|
||||
ATTR_EXTERNAL_ID: "1234",
|
||||
ATTR_LATITUDE: 38.0,
|
||||
ATTR_LONGITUDE: -3.0,
|
||||
ATTR_FRIENDLY_NAME: "Title 1",
|
||||
ATTR_CATEGORY: "Category 1",
|
||||
ATTR_ATTRIBUTION: "Attribution 1",
|
||||
ATTR_PUBLICATION_DATE:
|
||||
datetime.datetime(
|
||||
2018, 9, 22, 8, 0, tzinfo=datetime.timezone.utc),
|
||||
ATTR_UPDATED_DATE:
|
||||
datetime.datetime(
|
||||
2018, 9, 22, 8, 10, tzinfo=datetime.timezone.utc),
|
||||
ATTR_STATUS: 'Status 1',
|
||||
ATTR_UNIT_OF_MEASUREMENT: "km",
|
||||
ATTR_SOURCE: 'qld_bushfire'}
|
||||
assert float(state.state) == 15.5
|
||||
|
||||
state = hass.states.get("geo_location.title_2")
|
||||
assert state is not None
|
||||
assert state.name == "Title 2"
|
||||
assert state.attributes == {
|
||||
ATTR_EXTERNAL_ID: "2345",
|
||||
ATTR_LATITUDE: 38.1,
|
||||
ATTR_LONGITUDE: -3.1,
|
||||
ATTR_FRIENDLY_NAME: "Title 2",
|
||||
ATTR_UNIT_OF_MEASUREMENT: "km",
|
||||
ATTR_SOURCE: 'qld_bushfire'}
|
||||
assert float(state.state) == 20.5
|
||||
|
||||
state = hass.states.get("geo_location.title_3")
|
||||
assert state is not None
|
||||
assert state.name == "Title 3"
|
||||
assert state.attributes == {
|
||||
ATTR_EXTERNAL_ID: "3456",
|
||||
ATTR_LATITUDE: 38.2,
|
||||
ATTR_LONGITUDE: -3.2,
|
||||
ATTR_FRIENDLY_NAME: "Title 3",
|
||||
ATTR_UNIT_OF_MEASUREMENT: "km",
|
||||
ATTR_SOURCE: 'qld_bushfire'}
|
||||
assert float(state.state) == 25.5
|
||||
|
||||
# Simulate an update - one existing, one new entry,
|
||||
# one outdated entry
|
||||
mock_feed.return_value.update.return_value = 'OK', [
|
||||
mock_entry_1, mock_entry_4, mock_entry_3]
|
||||
async_fire_time_changed(hass, utcnow + SCAN_INTERVAL)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
all_states = hass.states.async_all()
|
||||
assert len(all_states) == 3
|
||||
|
||||
# Simulate an update - empty data, but successful update,
|
||||
# so no changes to entities.
|
||||
mock_feed.return_value.update.return_value = 'OK_NO_DATA', None
|
||||
async_fire_time_changed(hass, utcnow + 2 * SCAN_INTERVAL)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
all_states = hass.states.async_all()
|
||||
assert len(all_states) == 3
|
||||
|
||||
# Simulate an update - empty data, removes all entities
|
||||
mock_feed.return_value.update.return_value = 'ERROR', None
|
||||
async_fire_time_changed(hass, utcnow + 3 * SCAN_INTERVAL)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
all_states = hass.states.async_all()
|
||||
assert len(all_states) == 0
|
||||
|
||||
|
||||
async def test_setup_with_custom_location(hass):
|
||||
"""Test the setup with a custom location."""
|
||||
# Set up some mock feed entries for this test.
|
||||
mock_entry_1 = _generate_mock_feed_entry(
|
||||
'1234', 'Title 1', 20.5, (38.1, -3.1), category="Category 1")
|
||||
|
||||
with patch('georss_qld_bushfire_alert_client.'
|
||||
'QldBushfireAlertFeed') as mock_feed:
|
||||
mock_feed.return_value.update.return_value = 'OK', [mock_entry_1]
|
||||
|
||||
with assert_setup_component(1, geo_location.DOMAIN):
|
||||
assert await async_setup_component(
|
||||
hass, geo_location.DOMAIN, CONFIG_WITH_CUSTOM_LOCATION)
|
||||
|
||||
# Artificially trigger update.
|
||||
hass.bus.async_fire(EVENT_HOMEASSISTANT_START)
|
||||
# Collect events.
|
||||
await hass.async_block_till_done()
|
||||
|
||||
all_states = hass.states.async_all()
|
||||
assert len(all_states) == 1
|
||||
|
||||
assert mock_feed.call_args == call(
|
||||
(40.4, -3.7), filter_categories=[], filter_radius=200.0)
|
||||
Reference in new issue
Block a user