diff --git a/homeassistant/components/geo_location/nsw_rural_fire_service_feed.py b/homeassistant/components/geo_location/nsw_rural_fire_service_feed.py new file mode 100644 index 00000000000..52f261ba858 --- /dev/null +++ b/homeassistant/components/geo_location/nsw_rural_fire_service_feed.py @@ -0,0 +1,284 @@ +""" +NSW Rural Fire Service Feed platform. + +Retrieves current events (bush fires, grass fires, etc.) in GeoJSON format, +and displays information on events filtered by distance and category to the +HA instance's location. + +For more details about this platform, please refer to the documentation at +https://home-assistant.io/components/geo_location/nsw_rural_fire_service_feed/ +""" +import logging +from datetime import timedelta +from typing import Optional + +import voluptuous as vol + +import homeassistant.helpers.config_validation as cv +from homeassistant.components.geo_location import GeoLocationEvent, \ + PLATFORM_SCHEMA +from homeassistant.const import CONF_RADIUS, CONF_SCAN_INTERVAL, \ + EVENT_HOMEASSISTANT_START, ATTR_ATTRIBUTION +from homeassistant.core import callback +from homeassistant.helpers.dispatcher import dispatcher_send, \ + async_dispatcher_connect +from homeassistant.helpers.event import track_time_interval + +REQUIREMENTS = ['geojson_client==0.1'] + +_LOGGER = logging.getLogger(__name__) + +ATTR_CATEGORY = 'category' +ATTR_COUNCIL_AREA = 'council_area' +ATTR_EXTERNAL_ID = 'external_id' +ATTR_FIRE = 'fire' +ATTR_LOCATION = 'location' +ATTR_PUBLICATION_DATE = 'publication_date' +ATTR_RESPONSIBLE_AGENCY = 'responsible_agency' +ATTR_SIZE = 'size' +ATTR_STATUS = 'status' +ATTR_TYPE = 'type' + +CONF_CATEGORIES = 'categories' + +DEFAULT_RADIUS_IN_KM = 20.0 +DEFAULT_UNIT_OF_MEASUREMENT = "km" + +SCAN_INTERVAL = timedelta(minutes=5) + +SIGNAL_DELETE_ENTITY = 'nsw_rural_fire_service_feed_delete_{}' +SIGNAL_UPDATE_ENTITY = 'nsw_rural_fire_service_feed_update_{}' + +SOURCE = 'nsw_rural_fire_service_feed' + +VALID_CATEGORIES = ['Emergency Warning', 'Watch and Act', 'Advice', + 'Not Applicable'] + +PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ + vol.Optional(CONF_RADIUS, default=DEFAULT_RADIUS_IN_KM): + vol.Coerce(float), + vol.Optional(CONF_CATEGORIES, default=[]): + vol.All(cv.ensure_list, [vol.In(VALID_CATEGORIES)]) +}) + + +def setup_platform(hass, config, add_entities, discovery_info=None): + """Set up the GeoJSON Events platform.""" + scan_interval = config.get(CONF_SCAN_INTERVAL, SCAN_INTERVAL) + radius_in_km = config[CONF_RADIUS] + categories = config.get(CONF_CATEGORIES) + # Initialize the entity manager. + feed = NswRuralFireServiceFeedManager(hass, add_entities, scan_interval, + radius_in_km, categories) + + def start_feed_manager(event): + """Start feed manager.""" + feed.startup() + + hass.bus.listen_once(EVENT_HOMEASSISTANT_START, start_feed_manager) + + +class NswRuralFireServiceFeedManager: + """Feed Manager for NSW Rural Fire Service GeoJSON feed.""" + + def __init__(self, hass, add_entities, scan_interval, radius_in_km, + categories): + """Initialize the GeoJSON Feed Manager.""" + from geojson_client.nsw_rural_fire_service_feed \ + import NswRuralFireServiceFeed + self._hass = hass + self._feed = NswRuralFireServiceFeed((hass.config.latitude, + hass.config.longitude), + filter_radius=radius_in_km, + filter_categories=categories) + self._add_entities = add_entities + self._scan_interval = scan_interval + self.feed_entries = {} + self._managed_external_ids = set() + + def startup(self): + """Start up this manager.""" + self._update() + self._init_regular_updates() + + def _init_regular_updates(self): + """Schedule regular updates at the specified interval.""" + track_time_interval(self._hass, lambda now: self._update(), + self._scan_interval) + + def _update(self): + """Update the feed and then update connected entities.""" + import geojson_client + status, feed_entries = self._feed.update() + if status == geojson_client.UPDATE_OK: + _LOGGER.debug("Data retrieved %s", feed_entries) + # Keep a copy of all feed entries for future lookups by entities. + self.feed_entries = {entry.external_id: entry + for entry in feed_entries} + # For entity management the external ids from the feed are used. + feed_external_ids = set(self.feed_entries) + remove_external_ids = self._managed_external_ids.difference( + feed_external_ids) + self._remove_entities(remove_external_ids) + update_external_ids = self._managed_external_ids.intersection( + feed_external_ids) + self._update_entities(update_external_ids) + create_external_ids = feed_external_ids.difference( + self._managed_external_ids) + self._generate_new_entities(create_external_ids) + elif status == geojson_client.UPDATE_OK_NO_DATA: + _LOGGER.debug("Update successful, but no data received from %s", + self._feed) + else: + _LOGGER.warning("Update not successful, no data received from %s", + self._feed) + # Remove all entities. + self._remove_entities(self._managed_external_ids.copy()) + + def _generate_new_entities(self, external_ids): + """Generate new entities for events.""" + new_entities = [] + for external_id in external_ids: + new_entity = NswRuralFireServiceLocationEvent(self, external_id) + _LOGGER.debug("New entity added %s", external_id) + new_entities.append(new_entity) + self._managed_external_ids.add(external_id) + # Add new entities to HA. + self._add_entities(new_entities, True) + + def _update_entities(self, external_ids): + """Update entities.""" + for external_id in external_ids: + _LOGGER.debug("Existing entity found %s", external_id) + dispatcher_send(self._hass, + SIGNAL_UPDATE_ENTITY.format(external_id)) + + def _remove_entities(self, external_ids): + """Remove entities.""" + for external_id in external_ids: + _LOGGER.debug("Entity not current anymore %s", external_id) + self._managed_external_ids.remove(external_id) + dispatcher_send(self._hass, + SIGNAL_DELETE_ENTITY.format(external_id)) + + +class NswRuralFireServiceLocationEvent(GeoLocationEvent): + """This represents an external event with GeoJSON data.""" + + def __init__(self, feed_manager, external_id): + """Initialize entity with data from feed entry.""" + self._feed_manager = feed_manager + self._external_id = external_id + self._name = None + self._distance = None + self._latitude = None + self._longitude = None + self._attribution = None + self._category = None + self._publication_date = None + self._location = None + self._council_area = None + self._status = None + self._type = None + self._fire = None + self._size = None + self._responsible_agency = None + + async def async_added_to_hass(self): + """Call when entity is added to hass.""" + async_dispatcher_connect( + self.hass, SIGNAL_DELETE_ENTITY.format(self._external_id), + self._delete_callback) + async_dispatcher_connect( + self.hass, SIGNAL_UPDATE_ENTITY.format(self._external_id), + self._update_callback) + + @callback + def _delete_callback(self): + """Remove this entity.""" + self.hass.async_create_task(self.async_remove()) + + @callback + def _update_callback(self): + """Call update method.""" + self.async_schedule_update_ha_state(True) + + @property + def should_poll(self): + """No polling needed for GeoJSON location events.""" + return False + + async def async_update(self): + """Update this entity from the data held in the feed manager.""" + _LOGGER.debug("Updating %s", self._external_id) + feed_entry = self._feed_manager.feed_entries.get(self._external_id) + if feed_entry: + self._update_from_feed(feed_entry) + + def _update_from_feed(self, feed_entry): + """Update the internal state from the provided feed entry.""" + self._name = feed_entry.title + self._distance = feed_entry.distance_to_home + self._latitude = feed_entry.coordinates[0] + self._longitude = feed_entry.coordinates[1] + self._attribution = feed_entry.attribution + self._category = feed_entry.category + self._publication_date = feed_entry.publication_date + self._location = feed_entry.location + self._council_area = feed_entry.council_area + self._status = feed_entry.status + self._type = feed_entry.type + self._fire = feed_entry.fire + self._size = feed_entry.size + self._responsible_agency = feed_entry.responsible_agency + + @property + def source(self) -> str: + """Return source value of this external event.""" + return SOURCE + + @property + def name(self) -> Optional[str]: + """Return the name of the entity.""" + return self._name + + @property + def distance(self) -> Optional[float]: + """Return distance value of this external event.""" + return self._distance + + @property + def latitude(self) -> Optional[float]: + """Return latitude value of this external event.""" + return self._latitude + + @property + def longitude(self) -> Optional[float]: + """Return longitude value of this external event.""" + return self._longitude + + @property + def unit_of_measurement(self): + """Return the unit of measurement.""" + return DEFAULT_UNIT_OF_MEASUREMENT + + @property + def device_state_attributes(self): + """Return the device state attributes.""" + attributes = {} + for key, value in ( + (ATTR_EXTERNAL_ID, self._external_id), + (ATTR_CATEGORY, self._category), + (ATTR_LOCATION, self._location), + (ATTR_ATTRIBUTION, self._attribution), + (ATTR_PUBLICATION_DATE, self._publication_date), + (ATTR_COUNCIL_AREA, self._council_area), + (ATTR_STATUS, self._status), + (ATTR_TYPE, self._type), + (ATTR_FIRE, self._fire), + (ATTR_SIZE, self._size), + (ATTR_RESPONSIBLE_AGENCY, self._responsible_agency), + ): + if value or isinstance(value, bool): + attributes[key] = value + return attributes diff --git a/requirements_all.txt b/requirements_all.txt index f7dc780a0a8..63f1a451049 100644 --- a/requirements_all.txt +++ b/requirements_all.txt @@ -399,6 +399,7 @@ gearbest_parser==1.0.7 geizhals==0.0.7 # homeassistant.components.geo_location.geo_json_events +# homeassistant.components.geo_location.nsw_rural_fire_service_feed geojson_client==0.1 # homeassistant.components.sensor.geo_rss_events diff --git a/requirements_test_all.txt b/requirements_test_all.txt index e449a9ae98a..9ad85eb8de6 100644 --- a/requirements_test_all.txt +++ b/requirements_test_all.txt @@ -72,6 +72,7 @@ foobot_async==0.3.1 gTTS-token==1.1.2 # homeassistant.components.geo_location.geo_json_events +# homeassistant.components.geo_location.nsw_rural_fire_service_feed geojson_client==0.1 # homeassistant.components.sensor.geo_rss_events diff --git a/tests/components/geo_location/test_nsw_rural_fire_service_feed.py b/tests/components/geo_location/test_nsw_rural_fire_service_feed.py new file mode 100644 index 00000000000..92c4bae1931 --- /dev/null +++ b/tests/components/geo_location/test_nsw_rural_fire_service_feed.py @@ -0,0 +1,175 @@ +"""The tests for the geojson platform.""" +import datetime +import unittest +from unittest import mock +from unittest.mock import patch, MagicMock + +from homeassistant.components import geo_location +from homeassistant.components.geo_location import ATTR_SOURCE +from homeassistant.components.geo_location.nsw_rural_fire_service_feed import \ + ATTR_EXTERNAL_ID, SCAN_INTERVAL, ATTR_CATEGORY, ATTR_FIRE, ATTR_LOCATION, \ + ATTR_COUNCIL_AREA, ATTR_STATUS, ATTR_TYPE, ATTR_SIZE, \ + ATTR_RESPONSIBLE_AGENCY, ATTR_PUBLICATION_DATE +from homeassistant.const import CONF_URL, EVENT_HOMEASSISTANT_START, \ + CONF_RADIUS, ATTR_LATITUDE, ATTR_LONGITUDE, ATTR_FRIENDLY_NAME, \ + ATTR_UNIT_OF_MEASUREMENT, ATTR_ATTRIBUTION +from homeassistant.setup import setup_component +from tests.common import get_test_home_assistant, assert_setup_component, \ + fire_time_changed +import homeassistant.util.dt as dt_util + +URL = 'http://geo.json.local/geo_json_events.json' +CONFIG = { + geo_location.DOMAIN: [ + { + 'platform': 'nsw_rural_fire_service_feed', + CONF_URL: URL, + CONF_RADIUS: 200 + } + ] +} + + +class TestGeoJsonPlatform(unittest.TestCase): + """Test the geojson platform.""" + + def setUp(self): + """Initialize values for this testcase class.""" + self.hass = get_test_home_assistant() + + def tearDown(self): + """Stop everything that was started.""" + self.hass.stop() + + @staticmethod + def _generate_mock_feed_entry(external_id, title, distance_to_home, + coordinates, category=None, location=None, + attribution=None, publication_date=None, + council_area=None, status=None, + entry_type=None, fire=True, size=None, + responsible_agency=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.location = location + feed_entry.attribution = attribution + feed_entry.publication_date = publication_date + feed_entry.council_area = council_area + feed_entry.status = status + feed_entry.type = entry_type + feed_entry.fire = fire + feed_entry.size = size + feed_entry.responsible_agency = responsible_agency + return feed_entry + + @mock.patch('geojson_client.nsw_rural_fire_service_feed.' + 'NswRuralFireServiceFeed') + def test_setup(self, mock_feed): + """Test the general setup of the platform.""" + # Set up some mock feed entries for this test. + mock_entry_1 = self._generate_mock_feed_entry( + '1234', 'Title 1', 15.5, (-31.0, 150.0), category='Category 1', + location='Location 1', attribution='Attribution 1', + publication_date=datetime.datetime(2018, 9, 22, 8, 0, + tzinfo=datetime.timezone.utc), + council_area='Council Area 1', status='Status 1', + entry_type='Type 1', size='Size 1', responsible_agency='Agency 1') + mock_entry_2 = self._generate_mock_feed_entry('2345', 'Title 2', 20.5, + (-31.1, 150.1), + fire=False) + mock_entry_3 = self._generate_mock_feed_entry('3456', 'Title 3', 25.5, + (-31.2, 150.2)) + mock_entry_4 = self._generate_mock_feed_entry('4567', 'Title 4', 12.5, + (-31.3, 150.3)) + mock_feed.return_value.update.return_value = 'OK', [mock_entry_1, + mock_entry_2, + mock_entry_3] + + utcnow = dt_util.utcnow() + # Patching 'utcnow' to gain more control over the timed update. + with patch('homeassistant.util.dt.utcnow', return_value=utcnow): + with assert_setup_component(1, geo_location.DOMAIN): + self.assertTrue(setup_component(self.hass, geo_location.DOMAIN, + CONFIG)) + # Artificially trigger update. + self.hass.bus.fire(EVENT_HOMEASSISTANT_START) + # Collect events. + self.hass.block_till_done() + + all_states = self.hass.states.all() + assert len(all_states) == 3 + + state = self.hass.states.get("geo_location.title_1") + self.assertIsNotNone(state) + assert state.name == "Title 1" + assert state.attributes == { + ATTR_EXTERNAL_ID: "1234", ATTR_LATITUDE: -31.0, + ATTR_LONGITUDE: 150.0, ATTR_FRIENDLY_NAME: "Title 1", + ATTR_CATEGORY: "Category 1", ATTR_LOCATION: "Location 1", + ATTR_ATTRIBUTION: "Attribution 1", + ATTR_PUBLICATION_DATE: + datetime.datetime(2018, 9, 22, 8, 0, + tzinfo=datetime.timezone.utc), + ATTR_FIRE: True, + ATTR_COUNCIL_AREA: 'Council Area 1', + ATTR_STATUS: 'Status 1', ATTR_TYPE: 'Type 1', + ATTR_SIZE: 'Size 1', ATTR_RESPONSIBLE_AGENCY: 'Agency 1', + ATTR_UNIT_OF_MEASUREMENT: "km", + ATTR_SOURCE: 'nsw_rural_fire_service_feed'} + self.assertAlmostEqual(float(state.state), 15.5) + + state = self.hass.states.get("geo_location.title_2") + self.assertIsNotNone(state) + assert state.name == "Title 2" + assert state.attributes == { + ATTR_EXTERNAL_ID: "2345", ATTR_LATITUDE: -31.1, + ATTR_LONGITUDE: 150.1, ATTR_FRIENDLY_NAME: "Title 2", + ATTR_FIRE: False, + ATTR_UNIT_OF_MEASUREMENT: "km", + ATTR_SOURCE: 'nsw_rural_fire_service_feed'} + self.assertAlmostEqual(float(state.state), 20.5) + + state = self.hass.states.get("geo_location.title_3") + self.assertIsNotNone(state) + assert state.name == "Title 3" + assert state.attributes == { + ATTR_EXTERNAL_ID: "3456", ATTR_LATITUDE: -31.2, + ATTR_LONGITUDE: 150.2, ATTR_FRIENDLY_NAME: "Title 3", + ATTR_FIRE: True, + ATTR_UNIT_OF_MEASUREMENT: "km", + ATTR_SOURCE: 'nsw_rural_fire_service_feed'} + self.assertAlmostEqual(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] + fire_time_changed(self.hass, utcnow + SCAN_INTERVAL) + self.hass.block_till_done() + + all_states = self.hass.states.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 + # mock_restdata.return_value.data = None + fire_time_changed(self.hass, utcnow + + 2 * SCAN_INTERVAL) + self.hass.block_till_done() + + all_states = self.hass.states.all() + assert len(all_states) == 3 + + # Simulate an update - empty data, removes all entities + mock_feed.return_value.update.return_value = 'ERROR', None + fire_time_changed(self.hass, utcnow + + 2 * SCAN_INTERVAL) + self.hass.block_till_done() + + all_states = self.hass.states.all() + assert len(all_states) == 0