Add motion detection support to motionEye (#49665)

2021-07-01 02:22:43 -07:00 · 2021-07-01 02:22:43 -07:00 · 2868fef7d4
commit 2868fef7d4
parent 7bd8e2aa55
11 changed files with 751 additions and 33 deletions
--- a/tests/components/motioneye/test_web_hooks.py
+++ b/tests/components/motioneye/test_web_hooks.py
@ -0,0 +1,348 @@
+"""Test the motionEye camera web hooks."""
+import copy
+import logging
+from typing import Any
+from unittest.mock import AsyncMock, call, patch
+
+from motioneye_client.const import (
+    KEY_CAMERAS,
+    KEY_HTTP_METHOD_POST_JSON,
+    KEY_WEB_HOOK_NOTIFICATIONS_ENABLED,
+    KEY_WEB_HOOK_NOTIFICATIONS_HTTP_METHOD,
+    KEY_WEB_HOOK_NOTIFICATIONS_URL,
+    KEY_WEB_HOOK_STORAGE_ENABLED,
+    KEY_WEB_HOOK_STORAGE_HTTP_METHOD,
+    KEY_WEB_HOOK_STORAGE_URL,
+)
+
+from homeassistant.components.motioneye.const import (
+    ATTR_EVENT_TYPE,
+    CONF_WEBHOOK_SET_OVERWRITE,
+    DOMAIN,
+    EVENT_FILE_STORED,
+    EVENT_MOTION_DETECTED,
+)
+from homeassistant.components.webhook import URL_WEBHOOK_PATH
+from homeassistant.const import (
+    ATTR_DEVICE_ID,
+    CONF_URL,
+    CONF_WEBHOOK_ID,
+    HTTP_BAD_REQUEST,
+    HTTP_OK,
+)
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import device_registry as dr
+from homeassistant.setup import async_setup_component
+
+from . import (
+    TEST_CAMERA,
+    TEST_CAMERA_DEVICE_IDENTIFIER,
+    TEST_CAMERA_ID,
+    TEST_CAMERA_NAME,
+    TEST_CAMERAS,
+    TEST_URL,
+    create_mock_motioneye_client,
+    create_mock_motioneye_config_entry,
+    setup_mock_motioneye_config_entry,
+)
+
+from tests.common import async_capture_events
+
+_LOGGER = logging.getLogger(__name__)
+
+
+WEB_HOOK_MOTION_DETECTED_QUERY_STRING = (
+    "camera_id=%t&changed_pixels=%D&despeckle_labels=%Q&event=%v&fps=%{fps}"
+    "&frame_number=%q&height=%h&host=%{host}&motion_center_x=%K&motion_center_y=%L"
+    "&motion_height=%J&motion_version=%{ver}&motion_width=%i&noise_level=%N"
+    "&threshold=%o&width=%w&src=hass-motioneye&event_type=motion_detected"
+)
+
+WEB_HOOK_FILE_STORED_QUERY_STRING = (
+    "camera_id=%t&event=%v&file_path=%f&file_type=%n&fps=%{fps}&frame_number=%q"
+    "&height=%h&host=%{host}&motion_version=%{ver}&noise_level=%N&threshold=%o&width=%w"
+    "&src=hass-motioneye&event_type=file_stored"
+)
+
+
+async def test_setup_camera_without_webhook(hass: HomeAssistant) -> None:
+    """Test a camera with no webhook."""
+    client = create_mock_motioneye_client()
+    config_entry = await setup_mock_motioneye_config_entry(hass, client=client)
+
+    device_registry = await dr.async_get_registry(hass)
+    device = device_registry.async_get_device(
+        identifiers={TEST_CAMERA_DEVICE_IDENTIFIER}
+    )
+    assert device
+
+    expected_camera = copy.deepcopy(TEST_CAMERA)
+    expected_camera[KEY_WEB_HOOK_NOTIFICATIONS_ENABLED] = True
+    expected_camera[KEY_WEB_HOOK_NOTIFICATIONS_HTTP_METHOD] = KEY_HTTP_METHOD_POST_JSON
+    expected_camera[KEY_WEB_HOOK_NOTIFICATIONS_URL] = (
+        "https://example.com"
+        + URL_WEBHOOK_PATH.format(webhook_id=config_entry.data[CONF_WEBHOOK_ID])
+        + f"?{WEB_HOOK_MOTION_DETECTED_QUERY_STRING}&device_id={device.id}"
+    )
+
+    expected_camera[KEY_WEB_HOOK_STORAGE_ENABLED] = True
+    expected_camera[KEY_WEB_HOOK_STORAGE_HTTP_METHOD] = KEY_HTTP_METHOD_POST_JSON
+    expected_camera[KEY_WEB_HOOK_STORAGE_URL] = (
+        "https://example.com"
+        + URL_WEBHOOK_PATH.format(webhook_id=config_entry.data[CONF_WEBHOOK_ID])
+        + f"?{WEB_HOOK_FILE_STORED_QUERY_STRING}&device_id={device.id}"
+    )
+    assert client.async_set_camera.call_args == call(TEST_CAMERA_ID, expected_camera)
+
+
+async def test_setup_camera_with_wrong_webhook(
+    hass: HomeAssistant,
+) -> None:
+    """Test camera with wrong web hook."""
+    wrong_url = "http://wrong-url"
+
+    client = create_mock_motioneye_client()
+    cameras = copy.deepcopy(TEST_CAMERAS)
+    cameras[KEY_CAMERAS][0][KEY_WEB_HOOK_NOTIFICATIONS_URL] = wrong_url
+    cameras[KEY_CAMERAS][0][KEY_WEB_HOOK_STORAGE_URL] = wrong_url
+    client.async_get_cameras = AsyncMock(return_value=cameras)
+
+    config_entry = create_mock_motioneye_config_entry(hass)
+    await setup_mock_motioneye_config_entry(
+        hass,
+        config_entry=config_entry,
+        client=client,
+    )
+    assert not client.async_set_camera.called
+
+    # Update the options, which will trigger a reload with the new behavior.
+    with patch(
+        "homeassistant.components.motioneye.MotionEyeClient",
+        return_value=client,
+    ):
+        hass.config_entries.async_update_entry(
+            config_entry, options={CONF_WEBHOOK_SET_OVERWRITE: True}
+        )
+        await hass.async_block_till_done()
+
+    device_registry = await dr.async_get_registry(hass)
+    device = device_registry.async_get_device(
+        identifiers={TEST_CAMERA_DEVICE_IDENTIFIER}
+    )
+    assert device
+
+    expected_camera = copy.deepcopy(TEST_CAMERA)
+    expected_camera[KEY_WEB_HOOK_NOTIFICATIONS_ENABLED] = True
+    expected_camera[KEY_WEB_HOOK_NOTIFICATIONS_HTTP_METHOD] = KEY_HTTP_METHOD_POST_JSON
+    expected_camera[KEY_WEB_HOOK_NOTIFICATIONS_URL] = (
+        "https://example.com"
+        + URL_WEBHOOK_PATH.format(webhook_id=config_entry.data[CONF_WEBHOOK_ID])
+        + f"?{WEB_HOOK_MOTION_DETECTED_QUERY_STRING}&device_id={device.id}"
+    )
+
+    expected_camera[KEY_WEB_HOOK_STORAGE_ENABLED] = True
+    expected_camera[KEY_WEB_HOOK_STORAGE_HTTP_METHOD] = KEY_HTTP_METHOD_POST_JSON
+    expected_camera[KEY_WEB_HOOK_STORAGE_URL] = (
+        "https://example.com"
+        + URL_WEBHOOK_PATH.format(webhook_id=config_entry.data[CONF_WEBHOOK_ID])
+        + f"?{WEB_HOOK_FILE_STORED_QUERY_STRING}&device_id={device.id}"
+    )
+
+    assert client.async_set_camera.call_args == call(TEST_CAMERA_ID, expected_camera)
+
+
+async def test_setup_camera_with_old_webhook(
+    hass: HomeAssistant,
+) -> None:
+    """Verify that webhooks are overwritten if they are from this integration.
+
+    Even if the overwrite option is disabled, verify the behavior is still to
+    overwrite incorrect versions of the URL that were set by this integration.
+
+    (To allow the web hook URL to be seamlessly updated in future versions)
+    """
+
+    old_url = "http://old-url?src=hass-motioneye"
+
+    client = create_mock_motioneye_client()
+    cameras = copy.deepcopy(TEST_CAMERAS)
+    cameras[KEY_CAMERAS][0][KEY_WEB_HOOK_NOTIFICATIONS_URL] = old_url
+    cameras[KEY_CAMERAS][0][KEY_WEB_HOOK_STORAGE_URL] = old_url
+    client.async_get_cameras = AsyncMock(return_value=cameras)
+
+    config_entry = create_mock_motioneye_config_entry(hass)
+    await setup_mock_motioneye_config_entry(
+        hass,
+        config_entry=config_entry,
+        client=client,
+    )
+    assert client.async_set_camera.called
+
+    device_registry = await dr.async_get_registry(hass)
+    device = device_registry.async_get_device(
+        identifiers={TEST_CAMERA_DEVICE_IDENTIFIER}
+    )
+    assert device
+
+    expected_camera = copy.deepcopy(TEST_CAMERA)
+    expected_camera[KEY_WEB_HOOK_NOTIFICATIONS_ENABLED] = True
+    expected_camera[KEY_WEB_HOOK_NOTIFICATIONS_HTTP_METHOD] = KEY_HTTP_METHOD_POST_JSON
+    expected_camera[KEY_WEB_HOOK_NOTIFICATIONS_URL] = (
+        "https://example.com"
+        + URL_WEBHOOK_PATH.format(webhook_id=config_entry.data[CONF_WEBHOOK_ID])
+        + f"?{WEB_HOOK_MOTION_DETECTED_QUERY_STRING}&device_id={device.id}"
+    )
+
+    expected_camera[KEY_WEB_HOOK_STORAGE_ENABLED] = True
+    expected_camera[KEY_WEB_HOOK_STORAGE_HTTP_METHOD] = KEY_HTTP_METHOD_POST_JSON
+    expected_camera[KEY_WEB_HOOK_STORAGE_URL] = (
+        "https://example.com"
+        + URL_WEBHOOK_PATH.format(webhook_id=config_entry.data[CONF_WEBHOOK_ID])
+        + f"?{WEB_HOOK_FILE_STORED_QUERY_STRING}&device_id={device.id}"
+    )
+
+    assert client.async_set_camera.call_args == call(TEST_CAMERA_ID, expected_camera)
+
+
+async def test_setup_camera_with_correct_webhook(
+    hass: HomeAssistant,
+) -> None:
+    """Verify that webhooks are not overwritten if they are already correct."""
+
+    client = create_mock_motioneye_client()
+    config_entry = create_mock_motioneye_config_entry(
+        hass, data={CONF_URL: TEST_URL, CONF_WEBHOOK_ID: "webhook_secret_id"}
+    )
+
+    device_registry = await dr.async_get_registry(hass)
+    device = device_registry.async_get_or_create(
+        config_entry_id=config_entry.entry_id,
+        identifiers={TEST_CAMERA_DEVICE_IDENTIFIER},
+    )
+
+    cameras = copy.deepcopy(TEST_CAMERAS)
+    cameras[KEY_CAMERAS][0][KEY_WEB_HOOK_NOTIFICATIONS_ENABLED] = True
+    cameras[KEY_CAMERAS][0][
+        KEY_WEB_HOOK_NOTIFICATIONS_HTTP_METHOD
+    ] = KEY_HTTP_METHOD_POST_JSON
+    cameras[KEY_CAMERAS][0][KEY_WEB_HOOK_NOTIFICATIONS_URL] = (
+        "https://example.com"
+        + URL_WEBHOOK_PATH.format(webhook_id=config_entry.data[CONF_WEBHOOK_ID])
+        + f"?{WEB_HOOK_MOTION_DETECTED_QUERY_STRING}&device_id={device.id}"
+    )
+    cameras[KEY_CAMERAS][0][KEY_WEB_HOOK_STORAGE_ENABLED] = True
+    cameras[KEY_CAMERAS][0][
+        KEY_WEB_HOOK_STORAGE_HTTP_METHOD
+    ] = KEY_HTTP_METHOD_POST_JSON
+    cameras[KEY_CAMERAS][0][KEY_WEB_HOOK_STORAGE_URL] = (
+        "https://example.com"
+        + URL_WEBHOOK_PATH.format(webhook_id=config_entry.data[CONF_WEBHOOK_ID])
+        + f"?{WEB_HOOK_FILE_STORED_QUERY_STRING}&device_id={device.id}"
+    )
+    client.async_get_cameras = AsyncMock(return_value=cameras)
+
+    await setup_mock_motioneye_config_entry(
+        hass,
+        config_entry=config_entry,
+        client=client,
+    )
+
+    # Webhooks are correctly configured, so no set call should have been made.
+    assert not client.async_set_camera.called
+
+
+async def test_good_query(hass: HomeAssistant, aiohttp_client: Any) -> None:
+    """Test good callbacks."""
+    await async_setup_component(hass, "http", {"http": {}})
+
+    device_registry = await dr.async_get_registry(hass)
+    client = create_mock_motioneye_client()
+    config_entry = await setup_mock_motioneye_config_entry(hass, client=client)
+
+    device = device_registry.async_get_or_create(
+        config_entry_id=config_entry.entry_id,
+        identifiers={TEST_CAMERA_DEVICE_IDENTIFIER},
+    )
+
+    data = {
+        "one": "1",
+        "two": "2",
+        ATTR_DEVICE_ID: device.id,
+    }
+    client = await aiohttp_client(hass.http.app)
+
+    for event in (EVENT_MOTION_DETECTED, EVENT_FILE_STORED):
+        events = async_capture_events(hass, f"{DOMAIN}.{event}")
+
+        resp = await client.post(
+            URL_WEBHOOK_PATH.format(webhook_id=config_entry.data[CONF_WEBHOOK_ID]),
+            json={
+                **data,
+                ATTR_EVENT_TYPE: event,
+            },
+        )
+        assert resp.status == HTTP_OK
+
+        assert len(events) == 1
+        assert events[0].data == {
+            "name": TEST_CAMERA_NAME,
+            "device_id": device.id,
+            ATTR_EVENT_TYPE: event,
+            CONF_WEBHOOK_ID: config_entry.data[CONF_WEBHOOK_ID],
+            **data,
+        }
+
+
+async def test_bad_query_missing_parameters(
+    hass: HomeAssistant, aiohttp_client: Any
+) -> None:
+    """Test a query with missing parameters."""
+    await async_setup_component(hass, "http", {"http": {}})
+    config_entry = await setup_mock_motioneye_config_entry(hass)
+
+    client = await aiohttp_client(hass.http.app)
+
+    resp = await client.post(
+        URL_WEBHOOK_PATH.format(webhook_id=config_entry.data[CONF_WEBHOOK_ID]), json={}
+    )
+    assert resp.status == HTTP_BAD_REQUEST
+
+
+async def test_bad_query_no_such_device(
+    hass: HomeAssistant, aiohttp_client: Any
+) -> None:
+    """Test a correct query with incorrect device."""
+    await async_setup_component(hass, "http", {"http": {}})
+    config_entry = await setup_mock_motioneye_config_entry(hass)
+
+    client = await aiohttp_client(hass.http.app)
+
+    resp = await client.post(
+        URL_WEBHOOK_PATH.format(webhook_id=config_entry.data[CONF_WEBHOOK_ID]),
+        json={
+            ATTR_EVENT_TYPE: EVENT_MOTION_DETECTED,
+            ATTR_DEVICE_ID: "not-a-real-device",
+        },
+    )
+    assert resp.status == HTTP_BAD_REQUEST
+
+
+async def test_bad_query_cannot_decode(
+    hass: HomeAssistant, aiohttp_client: Any
+) -> None:
+    """Test a correct query with incorrect device."""
+    await async_setup_component(hass, "http", {"http": {}})
+    config_entry = await setup_mock_motioneye_config_entry(hass)
+
+    client = await aiohttp_client(hass.http.app)
+
+    motion_events = async_capture_events(hass, f"{DOMAIN}.{EVENT_MOTION_DETECTED}")
+    storage_events = async_capture_events(hass, f"{DOMAIN}.{EVENT_FILE_STORED}")
+
+    resp = await client.post(
+        URL_WEBHOOK_PATH.format(webhook_id=config_entry.data[CONF_WEBHOOK_ID]),
+        data=b"this is not json",
+    )
+    assert resp.status == HTTP_BAD_REQUEST
+    assert not motion_events
+    assert not storage_events