2016-08-09 00:36:49 +00:00
|
|
|
"""The tests for the notify smtp platform."""
|
2024-02-18 12:20:45 +00:00
|
|
|
from copy import deepcopy
|
2023-12-04 01:06:01 +00:00
|
|
|
from pathlib import Path
|
2019-12-09 13:38:01 +00:00
|
|
|
import re
|
2021-01-01 21:31:56 +00:00
|
|
|
from unittest.mock import patch
|
2020-10-16 11:55:12 +00:00
|
|
|
|
|
|
|
|
import pytest
|
2016-08-09 00:36:49 +00:00
|
|
|
|
2020-09-03 00:43:07 +00:00
|
|
|
import homeassistant.components.notify as notify
|
2023-09-11 07:36:55 +00:00
|
|
|
from homeassistant.components.smtp.const import DOMAIN
|
2019-03-28 03:36:13 +00:00
|
|
|
from homeassistant.components.smtp.notify import MailNotificationService
|
2023-02-08 16:12:54 +00:00
|
|
|
from homeassistant.core import HomeAssistant
|
2023-12-04 10:48:29 +00:00
|
|
|
from homeassistant.exceptions import ServiceValidationError
|
2016-08-09 00:36:49 +00:00
|
|
|
|
2024-02-18 12:20:45 +00:00
|
|
|
from .const import MOCKED_CONFIG_ENTRY_DATA
|
|
|
|
|
|
|
|
|
|
from tests.common import MockConfigEntry
|
2021-11-02 03:47:05 +00:00
|
|
|
|
2016-08-09 00:36:49 +00:00
|
|
|
|
2019-03-28 03:36:13 +00:00
|
|
|
class MockSMTP(MailNotificationService):
|
2016-08-09 00:36:49 +00:00
|
|
|
"""Test SMTP object that doesn't need a working server."""
|
|
|
|
|
|
2021-06-28 10:54:03 +00:00
|
|
|
def _send_email(self, msg, recipients):
|
|
|
|
|
"""Just return msg string and recipients for testing."""
|
|
|
|
|
return msg.as_string(), recipients
|
2016-08-09 00:36:49 +00:00
|
|
|
|
|
|
|
|
|
2020-10-16 11:55:12 +00:00
|
|
|
@pytest.fixture
|
|
|
|
|
def message():
|
|
|
|
|
"""Return MockSMTP object with test data."""
|
|
|
|
|
mailer = MockSMTP(
|
|
|
|
|
"localhost",
|
|
|
|
|
25,
|
|
|
|
|
5,
|
|
|
|
|
"test@test.com",
|
|
|
|
|
1,
|
|
|
|
|
"testuser",
|
|
|
|
|
"testpass",
|
|
|
|
|
["recip1@example.com", "testrecip@test.com"],
|
|
|
|
|
"Home Assistant",
|
|
|
|
|
0,
|
2022-05-27 05:15:20 +00:00
|
|
|
True,
|
2020-10-16 11:55:12 +00:00
|
|
|
)
|
2023-01-27 12:57:06 +00:00
|
|
|
return mailer
|
2020-10-16 11:55:12 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
HTML = """
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
|
|
|
|
|
<head><meta charset="UTF-8"></head>
|
|
|
|
|
<body>
|
|
|
|
|
<div>
|
|
|
|
|
<h1>Intruder alert at apartment!!</h1>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
<img alt="tests/testing_config/notify/test.jpg" src="cid:tests/testing_config/notify/test.jpg"/>
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>"""
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
EMAIL_DATA = [
|
|
|
|
|
(
|
|
|
|
|
"Test msg",
|
|
|
|
|
{"images": ["tests/testing_config/notify/test.jpg"]},
|
2023-11-23 12:51:51 +00:00
|
|
|
"Content-Type: multipart/mixed",
|
2020-10-16 11:55:12 +00:00
|
|
|
),
|
|
|
|
|
(
|
|
|
|
|
"Test msg",
|
|
|
|
|
{"html": HTML, "images": ["tests/testing_config/notify/test.jpg"]},
|
|
|
|
|
"Content-Type: multipart/related",
|
|
|
|
|
),
|
|
|
|
|
(
|
|
|
|
|
"Test msg",
|
2023-12-04 10:48:29 +00:00
|
|
|
{"html": HTML, "images": ["tests/testing_config/notify/test_not_exists.jpg"]},
|
2020-10-16 11:55:12 +00:00
|
|
|
"Content-Type: multipart/related",
|
|
|
|
|
),
|
|
|
|
|
(
|
|
|
|
|
"Test msg",
|
|
|
|
|
{"html": HTML, "images": ["tests/testing_config/notify/test.pdf"]},
|
|
|
|
|
"Content-Type: multipart/related",
|
|
|
|
|
),
|
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
|
2024-02-18 12:20:45 +00:00
|
|
|
@patch(
|
|
|
|
|
"homeassistant.components.smtp.notify.MailNotificationService.connection_is_valid",
|
|
|
|
|
lambda x: True,
|
|
|
|
|
)
|
|
|
|
|
async def test_reload_smtp(hass: HomeAssistant) -> None:
|
|
|
|
|
"""Verify we can reload a smtp config entry."""
|
|
|
|
|
data = deepcopy(MOCKED_CONFIG_ENTRY_DATA)
|
|
|
|
|
entry = MockConfigEntry(domain=DOMAIN, data=data)
|
|
|
|
|
entry.add_to_hass(hass)
|
|
|
|
|
await hass.config_entries.async_setup(entry.entry_id)
|
|
|
|
|
# Wait for discovery to finish
|
|
|
|
|
await hass.async_block_till_done()
|
|
|
|
|
|
|
|
|
|
assert hass.services.has_service(notify.DOMAIN, DOMAIN)
|
|
|
|
|
await hass.config_entries.async_reload(entry.entry_id)
|
|
|
|
|
assert not hass.services.has_service(notify.DOMAIN, DOMAIN)
|
|
|
|
|
await hass.async_block_till_done()
|
|
|
|
|
# Wait for discovery to finish
|
|
|
|
|
assert hass.services.has_service(notify.DOMAIN, DOMAIN)
|
|
|
|
|
|
|
|
|
|
# Unloading the entry should remove the service
|
|
|
|
|
await hass.config_entries.async_unload(entry.entry_id)
|
|
|
|
|
assert not hass.services.has_service(notify.DOMAIN, DOMAIN)
|
|
|
|
|
await hass.config_entries.async_setup(entry.entry_id)
|
|
|
|
|
# Wait for discovery to finish
|
|
|
|
|
await hass.async_block_till_done()
|
|
|
|
|
assert hass.services.has_service(notify.DOMAIN, DOMAIN)
|
|
|
|
|
|
|
|
|
|
|
2020-10-16 11:55:12 +00:00
|
|
|
@pytest.mark.parametrize(
|
2023-02-15 13:09:50 +00:00
|
|
|
("message_data", "data", "content_type"),
|
2020-10-16 11:55:12 +00:00
|
|
|
EMAIL_DATA,
|
|
|
|
|
ids=[
|
|
|
|
|
"Tests when sending text message and images.",
|
|
|
|
|
"Tests when sending text message, HTML Template and images.",
|
|
|
|
|
"Tests when image does not exist at mentioned location.",
|
|
|
|
|
"Tests when image type cannot be detected or is of wrong type.",
|
|
|
|
|
],
|
|
|
|
|
)
|
2023-02-15 14:23:34 +00:00
|
|
|
def test_send_message(
|
2023-12-04 01:06:01 +00:00
|
|
|
hass: HomeAssistant, message_data, data, content_type, message
|
2023-02-15 14:23:34 +00:00
|
|
|
) -> None:
|
2020-10-16 11:55:12 +00:00
|
|
|
"""Verify if we can send messages of all types correctly."""
|
|
|
|
|
sample_email = "<mock@mock>"
|
2023-12-04 01:06:01 +00:00
|
|
|
message.hass = hass
|
|
|
|
|
hass.config.allowlist_external_dirs.add(Path("tests/testing_config").resolve())
|
2020-10-16 11:55:12 +00:00
|
|
|
with patch("email.utils.make_msgid", return_value=sample_email):
|
2021-06-28 10:54:03 +00:00
|
|
|
result, _ = message.send_message(message_data, data=data)
|
2020-10-16 11:55:12 +00:00
|
|
|
assert content_type in result
|
|
|
|
|
|
|
|
|
|
|
2023-12-04 01:06:01 +00:00
|
|
|
@pytest.mark.parametrize(
|
|
|
|
|
("message_data", "data", "content_type"),
|
|
|
|
|
[
|
|
|
|
|
(
|
|
|
|
|
"Test msg",
|
|
|
|
|
{"images": ["tests/testing_config/notify/test.jpg"]},
|
|
|
|
|
"Content-Type: multipart/mixed",
|
|
|
|
|
),
|
|
|
|
|
],
|
|
|
|
|
)
|
|
|
|
|
def test_sending_insecure_files_fails(
|
|
|
|
|
hass: HomeAssistant,
|
|
|
|
|
message_data,
|
|
|
|
|
data,
|
|
|
|
|
content_type,
|
|
|
|
|
message,
|
|
|
|
|
) -> None:
|
|
|
|
|
"""Verify if we cannot send messages with insecure attachments."""
|
|
|
|
|
sample_email = "<mock@mock>"
|
|
|
|
|
message.hass = hass
|
2023-12-04 10:48:29 +00:00
|
|
|
with patch("email.utils.make_msgid", return_value=sample_email), pytest.raises(
|
|
|
|
|
ServiceValidationError
|
|
|
|
|
) as exc:
|
2023-12-04 01:06:01 +00:00
|
|
|
result, _ = message.send_message(message_data, data=data)
|
|
|
|
|
assert content_type in result
|
2023-12-04 10:48:29 +00:00
|
|
|
assert exc.value.translation_key == "remote_path_not_allowed"
|
|
|
|
|
assert exc.value.translation_domain == DOMAIN
|
|
|
|
|
assert (
|
|
|
|
|
str(exc.value.translation_placeholders["file_path"])
|
|
|
|
|
== "tests/testing_config/notify"
|
|
|
|
|
)
|
|
|
|
|
assert exc.value.translation_placeholders["url"]
|
|
|
|
|
assert exc.value.translation_placeholders["file_name"] == "test.jpg"
|
2023-12-04 01:06:01 +00:00
|
|
|
|
|
|
|
|
|
2023-02-15 14:23:34 +00:00
|
|
|
def test_send_text_message(hass: HomeAssistant, message) -> None:
|
2020-10-16 11:55:12 +00:00
|
|
|
"""Verify if we can send simple text message."""
|
|
|
|
|
expected = (
|
|
|
|
|
'^Content-Type: text/plain; charset="us-ascii"\n'
|
|
|
|
|
"MIME-Version: 1.0\n"
|
|
|
|
|
"Content-Transfer-Encoding: 7bit\n"
|
|
|
|
|
"Subject: Home Assistant\n"
|
|
|
|
|
"To: recip1@example.com,testrecip@test.com\n"
|
|
|
|
|
"From: Home Assistant <test@test.com>\n"
|
|
|
|
|
"X-Mailer: Home Assistant\n"
|
|
|
|
|
"Date: [^\n]+\n"
|
|
|
|
|
"Message-Id: <[^@]+@[^>]+>\n"
|
|
|
|
|
"\n"
|
|
|
|
|
"Test msg$"
|
|
|
|
|
)
|
|
|
|
|
sample_email = "<mock@mock>"
|
|
|
|
|
message_data = "Test msg"
|
|
|
|
|
with patch("email.utils.make_msgid", return_value=sample_email):
|
2021-06-28 10:54:03 +00:00
|
|
|
result, _ = message.send_message(message_data)
|
2020-10-16 11:55:12 +00:00
|
|
|
assert re.search(expected, result)
|
2021-06-28 10:54:03 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
|
|
|
"target",
|
|
|
|
|
[
|
|
|
|
|
None,
|
|
|
|
|
"target@example.com",
|
|
|
|
|
],
|
|
|
|
|
ids=[
|
|
|
|
|
"Verify we can send email to default recipient.",
|
|
|
|
|
"Verify email recipient can be overwritten by target arg.",
|
|
|
|
|
],
|
|
|
|
|
)
|
2023-02-15 14:23:34 +00:00
|
|
|
def test_send_target_message(target, hass: HomeAssistant, message) -> None:
|
2021-06-28 10:54:03 +00:00
|
|
|
"""Verify if we can send email to correct recipient."""
|
|
|
|
|
sample_email = "<mock@mock>"
|
|
|
|
|
message_data = "Test msg"
|
|
|
|
|
with patch("email.utils.make_msgid", return_value=sample_email):
|
|
|
|
|
if not target:
|
|
|
|
|
expected_recipient = ["recip1@example.com", "testrecip@test.com"]
|
|
|
|
|
else:
|
|
|
|
|
expected_recipient = target
|
|
|
|
|
|
|
|
|
|
_, recipient = message.send_message(message_data, target=target)
|
|
|
|
|
assert recipient == expected_recipient
|
