aboutsummaryrefslogtreecommitdiff
path: root/tests
diff options
context:
space:
mode:
Diffstat (limited to 'tests')
-rw-r--r--tests/tasks/test_notifications.py172
-rw-r--r--tests/tasks/test_receiver.py45
-rw-r--r--tests/test_views.py10
3 files changed, 81 insertions, 146 deletions
diff --git a/tests/tasks/test_notifications.py b/tests/tasks/test_notifications.py
index fa6ef79..f523d82 100644
--- a/tests/tasks/test_notifications.py
+++ b/tests/tasks/test_notifications.py
@@ -2,7 +2,9 @@
#
# SPDX-License-Identifier: BSD-3-Clause
+
import uuid
+from types import ModuleType
from unittest.mock import patch
import pytest
@@ -12,143 +14,117 @@ 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
+@pytest.fixture
+def notifications(app: Flask) -> ModuleType:
+ from webmentions_ssg.tasks import notifications
+
+ return notifications
- app.config["NOTIFICATION_EMAIL"] = "owner@example.com"
- identifier = uuid.uuid7()
+def create_mention(app: Flask, status: str = "verified") -> uuid.UUID:
+ identifier = uuid.uuid7()
with app.app_context():
db.session.add(
ReceivedWebmention(
uuid=identifier,
- source="https://source.example.com/post",
+ source=f"https://source.example/{identifier}",
target="https://dennisfink.me/post",
- status="verified",
+ status=status,
)
)
db.session.commit()
+ return identifier
- 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
+def test_digest_sends_one_email_for_multiple_verified_mentions(
+ notifications: ModuleType, app: Flask
+) -> None:
+ app.config["NOTIFICATION_EMAIL"] = "owner@example.com"
+ first = create_mention(app)
+ second = create_mention(app)
+ unverified = create_mention(app, "failed")
-@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
+ with app.app_context():
+ with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
+ notifications.send_webmention_digest()
+ notifications.send_webmention_digest()
- app.config["NOTIFICATION_EMAIL"] = "owner@example.com"
- identifier = uuid.uuid7()
+ send.assert_called_once()
+ message = send.call_args.args[0]
- 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()
+ assert message.recipients == ["owner@example.com"]
+ assert "2 new Webmentions" in message.body
+ assert "source.example" not in message.body
- with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
- send_webmention_notification.call_local(identifier)
+ first_mention = db.session.get(ReceivedWebmention, first)
+ second_mention = db.session.get(ReceivedWebmention, second)
+ unverified_mention = db.session.get(ReceivedWebmention, unverified)
- send.assert_not_called()
+ assert first_mention is not None
+ assert second_mention is not None
+ assert unverified_mention is not None
+ assert first_mention.notification_sent_at is not None
+ assert second_mention.notification_sent_at is not None
+ assert unverified_mention.notification_sent_at is None
-def test_skips_when_notifications_disabled(app: Flask) -> None:
- from webmentions_ssg.tasks.notifications import send_webmention_notification
+def test_digest_skips_when_notifications_disabled(
+ notifications: ModuleType, app: Flask
+) -> None:
app.config["NOTIFICATION_EMAIL"] = None
- identifier = uuid.uuid7()
+ identifier = create_mention(app)
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)
+ notifications.send_webmention_digest()
send.assert_not_called()
+ mention = db.session.get(ReceivedWebmention, identifier)
+ assert mention is not None
+ assert mention.notification_sent_at is None
-def test_skips_unknown_webmention(app: Flask) -> None:
- from webmentions_ssg.tasks.notifications import send_webmention_notification
+def test_digest_does_not_mark_mentions_when_email_fails(
+ notifications: ModuleType, app: Flask
+) -> None:
app.config["NOTIFICATION_EMAIL"] = "owner@example.com"
+ identifier = create_mention(app)
with app.app_context():
- with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
- send_webmention_notification.call_local(uuid.uuid7())
+ with (
+ patch(
+ "webmentions_ssg.tasks.notifications.mail.send",
+ side_effect=RuntimeError("SMTP unavailable"),
+ ),
+ pytest.raises(RuntimeError, match="SMTP unavailable"),
+ ):
+ notifications.send_webmention_digest()
- send.assert_not_called()
+ mention = db.session.get(ReceivedWebmention, identifier)
+ assert mention is not None
+ assert mention.notification_sent_at is None
-@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
+ with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
+ notifications.send_webmention_digest()
- app.config["NOTIFICATION_EMAIL"] = recipient
- identifier = uuid.uuid7()
+ send.assert_called_once()
+ mention = db.session.get(ReceivedWebmention, identifier)
- 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()
+ assert mention is not None
+ assert mention.notification_sent_at is not None
- 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
- )
+
+def test_digest_skips_when_no_new_mentions(
+ notifications: ModuleType, app: Flask
+) -> None:
+ app.config["NOTIFICATION_EMAIL"] = "owner@example.com"
with app.app_context():
- webmention = db.session.get(ReceivedWebmention, identifier)
- assert webmention is not None
- assert webmention.status == "verified"
+ with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
+ notifications.send_webmention_digest()
- if should_enqueue:
- enqueue.assert_called_once_with(identifier)
- else:
- enqueue.assert_not_called()
+ send.assert_not_called()
diff --git a/tests/tasks/test_receiver.py b/tests/tasks/test_receiver.py
index f4ab09f..1943b65 100644
--- a/tests/tasks/test_receiver.py
+++ b/tests/tasks/test_receiver.py
@@ -468,18 +468,10 @@ def test_verify_webmention_persists_final_state(
)
case _:
raise AssertionError(f"Unexpected outcome: {outcome}")
-
- app.config["NOTIFICATION_EMAIL"] = "owner@example.com"
-
- with patch.object(receiver, "send_webmention_notification") as enqueue:
- receiver.verify_webmention.call_local(identifier)
+ receiver.verify_webmention.call_local(identifier)
assert get_webmention_state(app, identifier) == (expected_status, expected_reason)
- # The receiver always enqueues when requested; the notification task
- # checks the persisted status before deciding whether to send an email.
- enqueue.assert_called_once_with(identifier)
-
@patch("webmentions_ssg.tasks.receiver.source_mentions_target")
@pytest.mark.parametrize("failure", ["temporary-http", "network"])
@@ -500,16 +492,10 @@ def test_verify_webmention_persists_retryable_failure_and_reraises(
source_mentions_target.side_effect = exception
- app.config["NOTIFICATION_EMAIL"] = "owner@example.com"
-
- with (
- patch.object(receiver, "send_webmention_notification") as enqueue,
- pytest.raises(type(exception), match=str(exception)),
- ):
+ with pytest.raises(type(exception), match=str(exception)):
receiver.verify_webmention.call_local(identifier)
assert get_webmention_state(app, identifier) == ("failed", str(exception))
- enqueue.assert_not_called()
def test_verify_webmention_ignores_unknown_identifier(
@@ -621,30 +607,3 @@ def test_source_mentions_target_falls_back_for_unknown_encoding(
assert receiver.source_mentions_target(SOURCE_URL, TARGET_URL)
fetch_source.assert_called_once_with(SOURCE_URL)
-
-
-@patch("webmentions_ssg.tasks.receiver.source_mentions_target", return_value=True)
-def test_verify_webmention_keeps_verified_state_when_notification_enqueue_fails(
- source_mentions_target: Mock,
- app: Flask,
- receiver: ModuleType,
- caplog: pytest.LogCaptureFixture,
-) -> None:
- identifier = create_webmention(app)
-
- with (
- patch.object(
- receiver,
- "send_webmention_notification",
- side_effect=RuntimeError("Huey unavailable"),
- ) as enqueue,
- caplog.at_level(logging.ERROR),
- ):
- # Enqueueing fails, but verification must return without raising.
- receiver.verify_webmention.call_local(identifier)
-
- source_mentions_target.assert_called_once_with(SOURCE_URL, TARGET_URL)
- enqueue.assert_called_once_with(identifier)
- assert get_webmention_state(app, identifier) == ("verified", None)
- assert f"Could not enqueue webmention notification for {identifier}" in caplog.text
- assert "RuntimeError: Huey unavailable" in caplog.text
diff --git a/tests/test_views.py b/tests/test_views.py
index 54098db..ed944c9 100644
--- a/tests/test_views.py
+++ b/tests/test_views.py
@@ -156,7 +156,7 @@ def test_endpoint_creates_webmention(
identifier = webmention.uuid
assert response.headers["Location"].endswith(str(identifier))
- verify_webmention.assert_called_once_with(identifier, send_notification=True)
+ verify_webmention.assert_called_once_with(identifier)
def test_endpoint_is_idempotent(
@@ -190,7 +190,7 @@ def test_endpoint_is_idempotent(
identifier = webmention.uuid
- verify_webmention.assert_called_once_with(identifier, send_notification=True)
+ verify_webmention.assert_called_once_with(identifier)
def test_resending_resets_failure_state(
@@ -229,7 +229,7 @@ def test_resending_resets_failure_state(
assert webmention.status == "received"
assert webmention.failure_reason is None
- verify_webmention.assert_called_once_with(identifier, send_notification=False)
+ verify_webmention.assert_called_once_with(identifier)
@pytest.mark.parametrize("path", ["/sent", f"/sent/{uuid.uuid7()}"])
@@ -604,7 +604,7 @@ def test_reverify_received_webmention(
assert webmention.status == "received"
assert webmention.failure_reason is None
- verify_webmention.assert_called_once_with(identifier, send_notification=False)
+ verify_webmention.assert_called_once_with(identifier)
def test_rescan_sent_sources_requires_login(client: FlaskClient) -> None:
@@ -931,4 +931,4 @@ def test_endpoint_reverifies_after_cooldown(
assert stored.status == "received"
assert stored.failure_reason is None
- verify.assert_called_once_with(identifier, send_notification=False)
+ verify.assert_called_once_with(identifier)