Add MVP person component (#20290)

* Add person component

* Required first name.
* Optional last name and user id.
* Optionally track device trackers. Last device tracker state change will
  set state.
* Set device tracker state entity_id as source attribute.
* Set coordinates of device tracker state as state attributes.
* Restore state.

* Parse restored state too

* Clean up

* Add missing property decorator

* Validate source entities as device trackers

* Only use name instead of first and last name

* Add user_id validation

* Add unique_id

* Remove not needed properties

* Uniform docstrings

* Fail component setup if no valid entities

* Add tests

* Add id and use that for unique_id

* Clean up

tests/components/person/test_init.py

@@ -0,0 +1,186 @@
+"""The tests for the person component."""
+from homeassistant.components.person import ATTR_SOURCE, ATTR_USER_ID, DOMAIN
+from homeassistant.const import (
+    ATTR_ID, ATTR_LATITUDE, ATTR_LONGITUDE, STATE_UNKNOWN)
+from homeassistant.core import CoreState, State
+from homeassistant.setup import async_setup_component
+
+from tests.common import mock_component, mock_restore_cache
+
+DEVICE_TRACKER = 'device_tracker.test_tracker'
+DEVICE_TRACKER_2 = 'device_tracker.test_tracker_2'
+
+
+async def test_minimal_setup(hass):
+    """Test minimal config with only name."""
+    config = {DOMAIN: {'id': '1234', 'name': 'test person'}}
+    assert await async_setup_component(hass, DOMAIN, config)
+
+    state = hass.states.get('person.test_person')
+    assert state.state == STATE_UNKNOWN
+    assert state.attributes.get(ATTR_LATITUDE) is None
+    assert state.attributes.get(ATTR_LONGITUDE) is None
+    assert state.attributes.get(ATTR_SOURCE) is None
+    assert state.attributes.get(ATTR_USER_ID) is None
+
+
+async def test_setup_no_id(hass):
+    """Test config with no id."""
+    config = {DOMAIN: {'name': 'test user'}}
+    assert not await async_setup_component(hass, DOMAIN, config)
+
+
+async def test_setup_no_name(hass):
+    """Test config with no name."""
+    config = {DOMAIN: {'id': '1234'}}
+    assert not await async_setup_component(hass, DOMAIN, config)
+
+
+async def test_setup_user_id(hass, hass_owner_user):
+    """Test config with user id."""
+    user_id = hass_owner_user.id
+    config = {
+        DOMAIN: {'id': '1234', 'name': 'test person', 'user_id': user_id}}
+    assert await async_setup_component(hass, DOMAIN, config)
+
+    state = hass.states.get('person.test_person')
+    assert state.state == STATE_UNKNOWN
+    assert state.attributes.get(ATTR_ID) == '1234'
+    assert state.attributes.get(ATTR_LATITUDE) is None
+    assert state.attributes.get(ATTR_LONGITUDE) is None
+    assert state.attributes.get(ATTR_SOURCE) is None
+    assert state.attributes.get(ATTR_USER_ID) == user_id
+
+
+async def test_setup_invalid_user_id(hass):
+    """Test config with invalid user id."""
+    config = {
+        DOMAIN: {
+            'id': '1234', 'name': 'test bad user', 'user_id': 'bad_user_id'}}
+    assert not await async_setup_component(hass, DOMAIN, config)
+
+
+async def test_valid_invalid_user_ids(hass, hass_owner_user):
+    """Test a person with valid user id and a person with invalid user id ."""
+    user_id = hass_owner_user.id
+    config = {DOMAIN: [
+        {'id': '1234', 'name': 'test valid user', 'user_id': user_id},
+        {'id': '5678', 'name': 'test bad user', 'user_id': 'bad_user_id'}]}
+    assert await async_setup_component(hass, DOMAIN, config)
+
+    state = hass.states.get('person.test_valid_user')
+    assert state.state == STATE_UNKNOWN
+    assert state.attributes.get(ATTR_ID) == '1234'
+    assert state.attributes.get(ATTR_LATITUDE) is None
+    assert state.attributes.get(ATTR_LONGITUDE) is None
+    assert state.attributes.get(ATTR_SOURCE) is None
+    assert state.attributes.get(ATTR_USER_ID) == user_id
+    state = hass.states.get('person.test_bad_user')
+    assert state is None
+
+
+async def test_setup_tracker(hass, hass_owner_user):
+    """Test set up person with one device tracker."""
+    user_id = hass_owner_user.id
+    config = {DOMAIN: {
+        'id': '1234', 'name': 'tracked person', 'user_id': user_id,
+        'device_trackers': DEVICE_TRACKER}}
+    assert await async_setup_component(hass, DOMAIN, config)
+
+    state = hass.states.get('person.tracked_person')
+    assert state.state == STATE_UNKNOWN
+    assert state.attributes.get(ATTR_ID) == '1234'
+    assert state.attributes.get(ATTR_LATITUDE) is None
+    assert state.attributes.get(ATTR_LONGITUDE) is None
+    assert state.attributes.get(ATTR_SOURCE) is None
+    assert state.attributes.get(ATTR_USER_ID) == user_id
+
+    hass.states.async_set(DEVICE_TRACKER, 'home')
+    await hass.async_block_till_done()
+
+    state = hass.states.get('person.tracked_person')
+    assert state.state == 'home'
+    assert state.attributes.get(ATTR_ID) == '1234'
+    assert state.attributes.get(ATTR_LATITUDE) is None
+    assert state.attributes.get(ATTR_LONGITUDE) is None
+    assert state.attributes.get(ATTR_SOURCE) == DEVICE_TRACKER
+    assert state.attributes.get(ATTR_USER_ID) == user_id
+
+    hass.states.async_set(
+        DEVICE_TRACKER, 'not_home',
+        {ATTR_LATITUDE: 10.123456, ATTR_LONGITUDE: 11.123456})
+    await hass.async_block_till_done()
+
+    state = hass.states.get('person.tracked_person')
+    assert state.state == 'not_home'
+    assert state.attributes.get(ATTR_ID) == '1234'
+    assert state.attributes.get(ATTR_LATITUDE) == 10.12346
+    assert state.attributes.get(ATTR_LONGITUDE) == 11.12346
+    assert state.attributes.get(ATTR_SOURCE) == DEVICE_TRACKER
+    assert state.attributes.get(ATTR_USER_ID) == user_id
+
+
+async def test_setup_two_trackers(hass, hass_owner_user):
+    """Test set up person with two device trackers."""
+    user_id = hass_owner_user.id
+    config = {DOMAIN: {
+        'id': '1234', 'name': 'tracked person', 'user_id': user_id,
+        'device_trackers': [DEVICE_TRACKER, DEVICE_TRACKER_2]}}
+    assert await async_setup_component(hass, DOMAIN, config)
+
+    state = hass.states.get('person.tracked_person')
+    assert state.state == STATE_UNKNOWN
+    assert state.attributes.get(ATTR_ID) == '1234'
+    assert state.attributes.get(ATTR_LATITUDE) is None
+    assert state.attributes.get(ATTR_LONGITUDE) is None
+    assert state.attributes.get(ATTR_SOURCE) is None
+    assert state.attributes.get(ATTR_USER_ID) == user_id
+
+    hass.states.async_set(DEVICE_TRACKER, 'home')
+    await hass.async_block_till_done()
+
+    state = hass.states.get('person.tracked_person')
+    assert state.state == 'home'
+    assert state.attributes.get(ATTR_ID) == '1234'
+    assert state.attributes.get(ATTR_LATITUDE) is None
+    assert state.attributes.get(ATTR_LONGITUDE) is None
+    assert state.attributes.get(ATTR_SOURCE) == DEVICE_TRACKER
+    assert state.attributes.get(ATTR_USER_ID) == user_id
+
+    hass.states.async_set(
+        DEVICE_TRACKER_2, 'not_home',
+        {ATTR_LATITUDE: 12.123456, ATTR_LONGITUDE: 13.123456})
+    await hass.async_block_till_done()
+
+    state = hass.states.get('person.tracked_person')
+    assert state.state == 'not_home'
+    assert state.attributes.get(ATTR_ID) == '1234'
+    assert state.attributes.get(ATTR_LATITUDE) == 12.12346
+    assert state.attributes.get(ATTR_LONGITUDE) == 13.12346
+    assert state.attributes.get(ATTR_SOURCE) == DEVICE_TRACKER_2
+    assert state.attributes.get(ATTR_USER_ID) == user_id
+
+
+async def test_restore_home_state(hass, hass_owner_user):
+    """Test that the state is restored for a person on startup."""
+    user_id = hass_owner_user.id
+    attrs = {
+        ATTR_ID: '1234', ATTR_LATITUDE: 10.12346, ATTR_LONGITUDE: 11.12346,
+        ATTR_SOURCE: DEVICE_TRACKER, ATTR_USER_ID: user_id}
+    state = State('person.tracked_person', 'home', attrs)
+    mock_restore_cache(hass, (state, ))
+    hass.state = CoreState.starting
+    mock_component(hass, 'recorder')
+    config = {DOMAIN: {
+        'id': '1234', 'name': 'tracked person', 'user_id': user_id,
+        'device_trackers': DEVICE_TRACKER}}
+    assert await async_setup_component(hass, DOMAIN, config)
+
+    state = hass.states.get('person.tracked_person')
+    assert state.state == 'home'
+    assert state.attributes.get(ATTR_ID) == '1234'
+    assert state.attributes.get(ATTR_LATITUDE) == 10.12346
+    assert state.attributes.get(ATTR_LONGITUDE) == 11.12346
+    # When restoring state the entity_id of the person will be used as source.
+    assert state.attributes.get(ATTR_SOURCE) == 'person.tracked_person'
+    assert state.attributes.get(ATTR_USER_ID) == user_id