mirror of
https://github.com/home-assistant/core.git
synced 2026-08-06 05:14:06 +01:00
Marc Mueller
134 lines
3.7 KiB
Python
134 lines
3.7 KiB
Python
"""Test the Prowl notifications."""
|
|
|
|
from typing import Any
|
|
from unittest.mock import Mock
|
|
|
|
import prowlpy
|
|
import pytest
|
|
|
|
from homeassistant.components.notify import DOMAIN as NOTIFY_DOMAIN
|
|
from homeassistant.components.prowl.const import DOMAIN
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
|
|
from .conftest import TEST_API_KEY
|
|
|
|
SERVICE_DATA = {"message": "Test Notification", "title": "Test Title"}
|
|
|
|
EXPECTED_SEND_PARAMETERS = {
|
|
"application": "Home-Assistant",
|
|
"event": "Test Title",
|
|
"description": "Test Notification",
|
|
"priority": 0,
|
|
"url": None,
|
|
}
|
|
|
|
|
|
@pytest.mark.usefixtures("configure_prowl_through_yaml")
|
|
async def test_send_notification_service(
|
|
hass: HomeAssistant,
|
|
mock_prowlpy: Mock,
|
|
) -> None:
|
|
"""Set up Prowl, call notify service, and check API call."""
|
|
assert hass.services.has_service(NOTIFY_DOMAIN, DOMAIN)
|
|
await hass.services.async_call(
|
|
NOTIFY_DOMAIN,
|
|
DOMAIN,
|
|
SERVICE_DATA,
|
|
blocking=True,
|
|
)
|
|
|
|
mock_prowlpy.send.assert_called_once_with(**EXPECTED_SEND_PARAMETERS)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("prowlpy_side_effect", "raised_exception", "exception_message"),
|
|
[
|
|
(
|
|
prowlpy.APIError("Internal server error"),
|
|
HomeAssistantError,
|
|
"Unexpected error when calling Prowl API",
|
|
),
|
|
(
|
|
TimeoutError,
|
|
HomeAssistantError,
|
|
"Timeout accessing Prowl API",
|
|
),
|
|
(
|
|
prowlpy.APIError(f"Invalid API key: {TEST_API_KEY}"),
|
|
HomeAssistantError,
|
|
"Invalid API key for Prowl service",
|
|
),
|
|
(
|
|
prowlpy.APIError(
|
|
"Not accepted: Your IP address has exceeded the API limit"
|
|
),
|
|
HomeAssistantError,
|
|
"Prowl service reported: exceeded rate limit",
|
|
),
|
|
(
|
|
SyntaxError(),
|
|
SyntaxError,
|
|
None,
|
|
),
|
|
],
|
|
)
|
|
@pytest.mark.usefixtures("configure_prowl_through_yaml")
|
|
async def test_fail_send_notification(
|
|
hass: HomeAssistant,
|
|
mock_prowlpy: Mock,
|
|
prowlpy_side_effect: Exception,
|
|
raised_exception: type[Exception],
|
|
exception_message: str | None,
|
|
) -> None:
|
|
"""Sending a message via Prowl with a failure."""
|
|
mock_prowlpy.send.side_effect = prowlpy_side_effect
|
|
|
|
assert hass.services.has_service(NOTIFY_DOMAIN, DOMAIN)
|
|
with pytest.raises(raised_exception, match=exception_message):
|
|
await hass.services.async_call(
|
|
NOTIFY_DOMAIN,
|
|
DOMAIN,
|
|
SERVICE_DATA,
|
|
blocking=True,
|
|
)
|
|
|
|
mock_prowlpy.send.assert_called_once_with(**EXPECTED_SEND_PARAMETERS)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("service_data", "expected_send_parameters"),
|
|
[
|
|
(
|
|
{"message": "Test Notification", "title": "Test Title"},
|
|
{
|
|
"application": "Home-Assistant",
|
|
"event": "Test Title",
|
|
"description": "Test Notification",
|
|
"priority": 0,
|
|
"url": None,
|
|
},
|
|
)
|
|
],
|
|
)
|
|
@pytest.mark.usefixtures("configure_prowl_through_yaml")
|
|
async def test_other_exception_send_notification(
|
|
hass: HomeAssistant,
|
|
mock_prowlpy: Mock,
|
|
service_data: dict[str, Any],
|
|
expected_send_parameters: dict[str, Any],
|
|
) -> None:
|
|
"""Sending a message via Prowl with a general unhandled exception."""
|
|
mock_prowlpy.send.side_effect = SyntaxError
|
|
|
|
assert hass.services.has_service(NOTIFY_DOMAIN, DOMAIN)
|
|
with pytest.raises(SyntaxError):
|
|
await hass.services.async_call(
|
|
NOTIFY_DOMAIN,
|
|
DOMAIN,
|
|
SERVICE_DATA,
|
|
blocking=True,
|
|
)
|
|
|
|
mock_prowlpy.send.assert_called_once_with(**EXPECTED_SEND_PARAMETERS)
|