diff options
| author | Dennis Fink | 2026-10-25 20:47:14 +0100 |
|---|---|---|
| committer | Dennis Fink | 2026-10-25 20:47:14 +0100 |
| commit | a231913ab273f427697f2d27d615b495f6e160bb (patch) | |
| tree | b9d84e3aab3555ec88c648f790f9c31d8a4266a6 /tests/tasks/test_notifications.py | |
| parent | ae25061b14f8ea713ec7695848421edf84e4f0fc (diff) | |
| download | webmentions-ssg-a231913ab273f427697f2d27d615b495f6e160bb.tar.gz webmentions-ssg-a231913ab273f427697f2d27d615b495f6e160bb.zip | |
feat(receiver): add email notifications for new webmentions
Send an email after a newly received Webmention is successfully
verified, with SMTP delivery configurable through Flask-Mail.
Avoid notifications for resubmissions and manual reverification, and
keep the persisted verification result unchanged if notification
enqueueing fails.
Diffstat (limited to 'tests/tasks/test_notifications.py')
| -rw-r--r-- | tests/tasks/test_notifications.py | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/tests/tasks/test_notifications.py b/tests/tasks/test_notifications.py new file mode 100644 index 0000000..6069d79 --- /dev/null +++ b/tests/tasks/test_notifications.py @@ -0,0 +1,154 @@ +# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me> +# +# SPDX-License-Identifier: BSD-3-Clause + +import uuid +from unittest.mock import patch + +import pytest +from flask import Flask + +from webmentions_ssg import DATABASE as db +from webmentions_ssg.models import ReceivedWebmention + + +def test_sends_email_for_verified_webmention(app: Flask) -> None: + from webmentions_ssg.tasks.notifications import send_webmention_notification + + app.config["WEBMENTIONS_SSG_NOTIFICATION_EMAIL"] = "owner@example.com" + identifier = uuid.uuid7() + + with app.app_context(): + db.session.add( + ReceivedWebmention( + uuid=identifier, + source="https://source.example.com/post", + target="https://dennisfink.me/post", + status="verified", + ) + ) + db.session.commit() + + with patch("webmentions_ssg.tasks.notifications.mail.send") as send: + send_webmention_notification.call_local(identifier) + + send.assert_called_once() + message = send.call_args.args[0] + assert message.recipients == ["owner@example.com"] + assert "https://source.example.com/post" in message.body + assert "https://dennisfink.me/post" in message.body + + +@pytest.mark.parametrize("status", ["received", "verifying", "failed", "deleted"]) +def test_skips_unverified_webmentions(app: Flask, status: str) -> None: + from webmentions_ssg.tasks.notifications import send_webmention_notification + + app.config["WEBMENTIONS_SSG_NOTIFICATION_EMAIL"] = "owner@example.com" + identifier = uuid.uuid7() + + with app.app_context(): + db.session.add( + ReceivedWebmention( + uuid=identifier, + source="https://source.example.com/post", + target="https://dennisfink.me/post", + status=status, + ) + ) + db.session.commit() + + with patch("webmentions_ssg.tasks.notifications.mail.send") as send: + send_webmention_notification.call_local(identifier) + + send.assert_not_called() + + +def test_skips_when_notifications_disabled(app: Flask) -> None: + from webmentions_ssg.tasks.notifications import send_webmention_notification + + app.config["WEBMENTIONS_SSG_NOTIFICATION_EMAIL"] = None + identifier = uuid.uuid7() + + with app.app_context(): + db.session.add( + ReceivedWebmention( + uuid=identifier, + source="https://source.example.com/post", + target="https://dennisfink.me/post", + status="verified", + ) + ) + db.session.commit() + + with patch("webmentions_ssg.tasks.notifications.mail.send") as send: + send_webmention_notification.call_local(identifier) + + send.assert_not_called() + + +def test_skips_unknown_webmention(app: Flask) -> None: + from webmentions_ssg.tasks.notifications import send_webmention_notification + + app.config["WEBMENTIONS_SSG_NOTIFICATION_EMAIL"] = "owner@example.com" + + with app.app_context(): + with patch("webmentions_ssg.tasks.notifications.mail.send") as send: + send_webmention_notification.call_local(uuid.uuid7()) + + send.assert_not_called() + + +@pytest.mark.parametrize( + ("send_notification", "recipient", "should_enqueue"), + [ + pytest.param(None, "owner@example.com", True, id="default-enabled"), + pytest.param(True, "owner@example.com", True, id="explicitly-enabled"), + pytest.param(False, "owner@example.com", False, id="explicitly-disabled"), + pytest.param(True, None, True, id="no-recipient-configured"), + ], +) +def test_queues_notification_after_verification( + app: Flask, + send_notification: bool | None, + recipient: str | None, + should_enqueue: bool, +) -> None: + from webmentions_ssg.tasks import receiver + + app.config["WEBMENTIONS_SSG_NOTIFICATION_EMAIL"] = recipient + identifier = uuid.uuid7() + + with app.app_context(): + db.session.add( + ReceivedWebmention( + uuid=identifier, + source="https://source.example.com/post", + target="https://dennisfink.me/post", + status="received", + ) + ) + db.session.commit() + + with ( + patch( + "webmentions_ssg.tasks.receiver.source_mentions_target", return_value=True + ), + patch("webmentions_ssg.tasks.receiver.send_webmention_notification") as enqueue, + ): + if send_notification is None: + # Exercise the task's default argument. + receiver.verify_webmention.call_local(identifier) + else: + receiver.verify_webmention.call_local( + identifier, send_notification=send_notification + ) + + with app.app_context(): + webmention = db.session.get(ReceivedWebmention, identifier) + assert webmention is not None + assert webmention.status == "verified" + + if should_enqueue: + enqueue.assert_called_once_with(identifier) + else: + enqueue.assert_not_called() |
