aboutsummaryrefslogtreecommitdiff
path: root/tests/views/helpers.py
blob: 354102bbc27dbda8c4be1affc1e3bfa5e012592d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
#
# SPDX-License-Identifier: BSD-3-Clause

import uuid
from datetime import UTC, datetime
from http import HTTPStatus
from types import ModuleType
from unittest.mock import Mock

import pytest
from flask import Flask
from flask.testing import FlaskClient

from webmentions_ssg import db
from webmentions_ssg.models import (
    ReceivedWebmention,
    SentWebmention,
    SentWebmentionStatus,
    SourceDocument,
    User,
)

SOURCE_URL = "https://source.example/post"
TARGET_URL = "https://dennisfink.me/blog/example/"


def mock_endpoint_form(
    views_module: ModuleType,
    monkeypatch: pytest.MonkeyPatch,
    *,
    valid: bool,
    source: str = SOURCE_URL,
    target: str = TARGET_URL,
    errors: dict[str, list[str]] | None = None,
) -> Mock:
    form = Mock()
    form.validate_on_submit.return_value = valid
    form.source.data = source
    form.target.data = target
    form.errors = errors or {}

    monkeypatch.setattr(
        views_module.forms, "WebmentionSubmissionForm", Mock(return_value=form)
    )
    return form


def log_in(app: Flask, client: FlaskClient) -> None:
    with app.app_context():
        user = User(username="admin", password="test")

        db.session.add(user)
        db.session.commit()

        user_id = user.get_id()

    with client.session_transaction() as session:
        session["_user_id"] = str(user_id)
        session["_fresh"] = True


def create_sent_source(app: Flask) -> uuid.UUID:
    now = datetime.now(UTC)

    with app.app_context():
        source = SourceDocument(
            path="blog/example/index.html",
            url="https://dennisfink.me/blog/example/",
            content_hash="0" * 32,
            revision=2,
            last_seen_at=now,
            revised_at=now,
        )

        source.sent_webmentions.extend(
            [
                SentWebmention(
                    target="https://example.com/b",
                    linked=True,
                    desired_revision=2,
                    processed_revision=2,
                    sent_revision=2,
                    status=SentWebmentionStatus.SENT,
                    webmention_endpoint="https://example.com/webmention",
                    endpoint_response_status=HTTPStatus.ACCEPTED,
                ),
                SentWebmention(
                    target="https://example.com/a",
                    linked=True,
                    desired_revision=2,
                    processed_revision=2,
                    sent_revision=1,
                    status=SentWebmentionStatus.FAILED,
                    failure_reason="Webmention endpoint returned HTTP 400",
                    webmention_endpoint="https://example.com/webmention",
                    endpoint_response_status=HTTPStatus.BAD_REQUEST,
                ),
            ]
        )

        db.session.add(source)
        db.session.commit()

        return source.uuid


def mock_login_form(
    views_module: ModuleType,
    monkeypatch: pytest.MonkeyPatch,
    *,
    valid: bool,
    username: str = "admin",
    password: str | None = "test",
) -> Mock:
    form = Mock()
    form.validate_on_submit.return_value = valid
    form.username.data = username
    form.password.data = password

    monkeypatch.setattr(views_module.forms, "LoginForm", Mock(return_value=form))
    return form


def mock_admin_action_form(
    views_module: ModuleType, monkeypatch: pytest.MonkeyPatch, *, valid: bool
) -> Mock:
    form = Mock()
    form.validate_on_submit.return_value = valid

    monkeypatch.setattr(
        views_module.forms, "ConfirmActionForm", Mock(return_value=form)
    )
    return form


def create_received_webmention(
    app: Flask,
    *,
    source: str = SOURCE_URL,
    target: str = TARGET_URL,
    status: str = "verified",
    failure_reason: str | None = None,
    updated_at: datetime | None = None,
) -> uuid.UUID:
    with app.app_context():
        webmention = ReceivedWebmention(
            uuid=uuid.uuid7(),
            source=source,
            target=target,
            status=status,
            failure_reason=failure_reason,
        )
        if updated_at is not None:
            webmention.updated_at = updated_at

        db.session.add(webmention)
        db.session.commit()

        return webmention.uuid


def create_resendable_sent_webmention(app: Flask) -> tuple[uuid.UUID, uuid.UUID]:
    now = datetime.now(UTC)

    with app.app_context():
        source = SourceDocument(
            path="blog/resend/index.html",
            url="https://dennisfink.me/blog/resend/",
            content_hash="1" * 32,
            revision=3,
            last_seen_at=now,
            revised_at=now,
        )
        webmention = SentWebmention(
            target="https://example.com/resend",
            linked=True,
            desired_revision=3,
            processed_revision=3,
            sent_revision=2,
            status=SentWebmentionStatus.FAILED,
            failure_reason="Previous failure",
            webmention_endpoint="https://example.com/webmention",
            endpoint_response_status=HTTPStatus.INTERNAL_SERVER_ERROR,
            status_url="https://example.com/webmention/status/123",
        )
        source.sent_webmentions.append(webmention)

        db.session.add(source)
        db.session.commit()

        return source.uuid, webmention.uuid


def create_outgoing(
    app: Flask, *, status_url: str | None = None
) -> tuple[uuid.UUID, uuid.UUID]:
    now = datetime.now(UTC)
    with app.app_context():
        source = SourceDocument(
            path="blog/post/index.html",
            url="https://source.example/blog/post",
            content_hash="0" * 32,
            revision=1,
            last_seen_at=now,
            revised_at=now,
        )
        mention = SentWebmention(
            target="https://example.com/article",
            linked=True,
            desired_revision=1,
            status_url=status_url,
            endpoint_response_status=(
                HTTPStatus.CREATED if status_url is not None else None
            ),
        )
        source.sent_webmentions.append(mention)
        db.session.add(source)
        db.session.commit()
        return source.uuid, mention.uuid