aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--tests/test_cli.py44
-rw-r--r--tests/test_models.py47
-rw-r--r--webmentions_ssg/migrations/versions/7c38bb1a935e_received_webmention_status_enum.py48
-rw-r--r--webmentions_ssg/models.py11
4 files changed, 135 insertions, 15 deletions
diff --git a/tests/test_cli.py b/tests/test_cli.py
index ac673b4..0d9b357 100644
--- a/tests/test_cli.py
+++ b/tests/test_cli.py
@@ -5,6 +5,7 @@
import logging
from collections.abc import Iterator
from pathlib import Path
+from uuid import UUID
from unittest.mock import patch
import pytest
@@ -17,7 +18,7 @@ from sqlalchemy.exc import IntegrityError
from webmentions_ssg import create_app, db, migrate
from webmentions_ssg.config import TestingConfig
-from webmentions_ssg.models import User
+from webmentions_ssg.models import ReceivedStatus, ReceivedWebmention, User
def test_cli_groups_are_registered(app: Flask) -> None:
@@ -273,6 +274,47 @@ def test_upgrade_backfills_portable_digest_for_existing_received_rows(
)
+def test_upgrade_converts_received_status_without_losing_rows(
+ database_app: Flask,
+) -> None:
+ """An existing text status survives the non-native Enum migration."""
+ identifier = "0" * 31 + "1"
+ with database_app.app_context():
+ migrate_upgrade(revision="e62b1a7c4d90")
+ with db.engine.begin() as connection:
+ connection.execute(
+ sa.text(
+ "INSERT INTO received_webmentions "
+ "(uuid, source, target, url_digest, status, updated_at) "
+ "VALUES (:uuid, :source, :target, :url_digest, :status, :updated_at)"
+ ),
+ {
+ "uuid": identifier,
+ "source": "https://source.example/old",
+ "target": "https://dennisfink.me/target",
+ "url_digest": "0" * 64,
+ "status": "verifying",
+ "updated_at": "2026-01-01 00:00:00",
+ },
+ )
+
+ migrate_upgrade()
+ with db.engine.connect() as connection:
+ columns = {
+ column["name"]: column
+ for column in inspect(connection).get_columns("received_webmentions")
+ }
+ assert isinstance(columns["status"]["type"], sa.String)
+ assert columns["status"]["type"].length == 9
+ assert connection.execute(
+ sa.text("SELECT status FROM received_webmentions")
+ ).scalar_one() == "verifying"
+
+ mention = db.session.get(ReceivedWebmention, UUID(hex=identifier))
+ assert mention is not None
+ assert mention.status is ReceivedStatus.VERIFYING
+
+
def test_mail_cli_sends_to_configured_notification_email(app: Flask) -> None:
app.config.update(
NOTIFICATION_EMAIL="owner@example.com", MAIL_DEFAULT_SENDER="sender@example.com"
diff --git a/tests/test_models.py b/tests/test_models.py
index bb95be2..b9e7c80 100644
--- a/tests/test_models.py
+++ b/tests/test_models.py
@@ -13,6 +13,7 @@ from sqlalchemy.exc import IntegrityError
from webmentions_ssg import db
from webmentions_ssg.models import (
+ ReceivedStatus,
ReceivedWebmention,
SentWebmention,
Source,
@@ -44,14 +45,14 @@ def test_user_password_is_hashed_and_can_be_checked() -> None:
@pytest.mark.parametrize(
("status", "expected"),
[
- ("received", False),
- ("verifying", False),
- ("verified", True),
- ("failed", False),
- ("deleted", False),
+ (ReceivedStatus.RECEIVED, False),
+ (ReceivedStatus.VERIFYING, False),
+ (ReceivedStatus.VERIFIED, True),
+ (ReceivedStatus.FAILED, False),
+ (ReceivedStatus.DELETED, False),
],
)
-def test_received_webmention_verified(status: str, expected: bool) -> None:
+def test_received_webmention_verified(status: ReceivedStatus, expected: bool) -> None:
webmention = ReceivedWebmention(
uuid=uuid.uuid7(),
source="https://source.example/post",
@@ -212,14 +213,36 @@ def test_user_session_id_changes_when_password_hash_changes() -> None:
assert user.get_id() != original_id
-def test_received_status_remains_text_with_enum_constants() -> None:
- from sqlalchemy import Text
+def test_received_status_uses_non_native_enum() -> None:
+ status_type = ReceivedWebmention.__table__.c.status.type
- from webmentions_ssg.models import ReceivedStatus
+ assert isinstance(status_type, sa.Enum)
+ assert status_type.enum_class is ReceivedStatus
+ assert status_type.native_enum is False
+ assert status_type.enums == [status.value for status in ReceivedStatus]
+
+
+def test_received_status_round_trips_as_enum(app: Flask) -> None:
+ with app.app_context():
+ identifier = uuid.uuid7()
+ mention = ReceivedWebmention(
+ uuid=identifier,
+ source="https://source.example/post",
+ target="https://dennisfink.me/blog/example/",
+ status=ReceivedStatus.VERIFIED,
+ )
+ db.session.add(mention)
+ db.session.commit()
+
+ assert db.session.scalar(
+ sa.text("SELECT status FROM received_webmentions WHERE uuid = :uuid"),
+ {"uuid": identifier.hex},
+ ) == "verified"
- assert isinstance(ReceivedWebmention.__table__.c.status.type, Text)
- assert ReceivedStatus.VERIFIED == "verified"
- assert ReceivedStatus.DELETED == "deleted"
+ db.session.expunge_all()
+ loaded = db.session.get(ReceivedWebmention, identifier)
+ assert loaded is not None
+ assert loaded.status is ReceivedStatus.VERIFIED
def test_received_verification_reset_is_reusable_for_atomic_updates() -> None:
diff --git a/webmentions_ssg/migrations/versions/7c38bb1a935e_received_webmention_status_enum.py b/webmentions_ssg/migrations/versions/7c38bb1a935e_received_webmention_status_enum.py
new file mode 100644
index 0000000..dcae16d
--- /dev/null
+++ b/webmentions_ssg/migrations/versions/7c38bb1a935e_received_webmention_status_enum.py
@@ -0,0 +1,48 @@
+# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+"""Store incoming Webmention status as a non-native Enum.
+
+Revision ID: 7c38bb1a935e
+Revises: e62b1a7c4d90
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+revision = "7c38bb1a935e"
+down_revision = "e62b1a7c4d90"
+branch_labels = None
+depends_on = None
+
+
+status_enum = sa.Enum(
+ "received",
+ "verifying",
+ "verified",
+ "failed",
+ "deleted",
+ name="received_webmention_status",
+ native_enum=False,
+)
+
+
+def upgrade() -> None:
+ with op.batch_alter_table("received_webmentions") as batch_op:
+ batch_op.alter_column(
+ "status",
+ existing_type=sa.Text(),
+ type_=status_enum,
+ existing_nullable=False,
+ )
+
+
+def downgrade() -> None:
+ with op.batch_alter_table("received_webmentions") as batch_op:
+ batch_op.alter_column(
+ "status",
+ existing_type=status_enum,
+ type_=sa.Text(),
+ existing_nullable=False,
+ )
diff --git a/webmentions_ssg/models.py b/webmentions_ssg/models.py
index dbbb7ad..ea2de0b 100644
--- a/webmentions_ssg/models.py
+++ b/webmentions_ssg/models.py
@@ -119,8 +119,15 @@ class ReceivedWebmention(Base):
self.url_digest = received_url_digest(source, target)
return value
- status: Mapped[str] = mapped_column(
- Text(), nullable=False, default=ReceivedStatus.RECEIVED
+ status: Mapped[ReceivedStatus] = mapped_column(
+ Enum(
+ ReceivedStatus,
+ name="received_webmention_status",
+ values_callable=lambda enum_type: [member.value for member in enum_type],
+ native_enum=False,
+ ),
+ nullable=False,
+ default=ReceivedStatus.RECEIVED,
)
# Counts stale-row requeues, not Huey's bounded in-task retries. A fresh
# explicit submission resets this counter.