aboutsummaryrefslogtreecommitdiff
path: root/tests/forms/test_init.py
blob: 42e6a2ca89896eefc597330c2b7c37d94cf36e9d (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
# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
#
# SPDX-License-Identifier: BSD-3-Clause

import pytest
from flask import Flask
from werkzeug.datastructures import MultiDict

from webmentions_ssg.forms import AdminActionForm, EndpointForm, LoginForm

VALID_SOURCE = "https://source.example/post"
VALID_TARGET = "https://dennisfink.me/blog/example/"


@pytest.mark.parametrize(
    ("form_data", "invalid_field", "expected_error"),
    [
        pytest.param(
            {"target": VALID_TARGET},
            "source",
            "This field is required.",
            id="source-required",
        ),
        pytest.param(
            {"source": "not a URL", "target": VALID_TARGET},
            "source",
            "Invalid URL.",
            id="source-url",
        ),
        pytest.param(
            {"source": "ftp://source.example/post", "target": VALID_TARGET},
            "source",
            "source must begin with http or https",
            id="source-scheme",
        ),
        pytest.param(
            {"source": VALID_SOURCE},
            "target",
            "This field is required.",
            id="target-required",
        ),
        pytest.param(
            {"source": VALID_SOURCE, "target": "not a URL"},
            "target",
            "Invalid URL.",
            id="target-url",
        ),
        pytest.param(
            {"source": VALID_SOURCE, "target": "ftp://dennisfink.me/blog/example/"},
            "target",
            "target must begin with http or https",
            id="target-scheme",
        ),
    ],
)
def test_endpoint_form_rejects_invalid_field_syntax(
    app: Flask, form_data: dict[str, str], invalid_field: str, expected_error: str
) -> None:
    with app.test_request_context("/endpoint", method="POST"):
        form = EndpointForm(formdata=MultiDict(form_data), meta={"csrf": False})

        assert not form.validate()
        assert expected_error in form.errors[invalid_field]


def test_endpoint_form_accepts_valid_data(app: Flask) -> None:
    with app.test_request_context("/endpoint", method="POST"):
        form = EndpointForm(
            formdata=MultiDict({"source": VALID_SOURCE, "target": VALID_TARGET}),
            meta={"csrf": False},
        )

        assert form.validate()
        assert form.errors == {}


@pytest.mark.parametrize(
    ("form_data", "invalid_field"),
    [
        pytest.param({"password": "secret"}, "username", id="username-required"),
        pytest.param({"username": "admin"}, "password", id="password-required"),
    ],
)
def test_login_form_requires_credentials(
    app: Flask, form_data: dict[str, str], invalid_field: str
) -> None:
    with app.test_request_context("/login", method="POST"):
        form = LoginForm(formdata=MultiDict(form_data), meta={"csrf": False})

        assert not form.validate()
        assert "This field is required." in form.errors[invalid_field]


def test_login_form_accepts_credentials(app: Flask) -> None:
    with app.test_request_context("/login", method="POST"):
        form = LoginForm(
            formdata=MultiDict({"username": "admin", "password": "secret"}),
            meta={"csrf": False},
        )
        assert form.validate()


def test_admin_action_form_accepts_submission(app: Flask) -> None:
    with app.test_request_context(method="POST"):
        form = AdminActionForm(meta={"csrf": False})
        assert form.validate()


def test_endpoint_does_not_do_dns_in_web_request(
    app: Flask, monkeypatch: pytest.MonkeyPatch
) -> None:
    def unexpected_dns_lookup(*args: object, **kwargs: object) -> None:
        raise AssertionError("No DNS lookup belongs in form validation")

    monkeypatch.setattr(
        "webmentions_ssg.url_security.dns.resolver.resolve_name", unexpected_dns_lookup
    )
    with app.test_request_context("/endpoint", method="POST"):
        for source in (VALID_SOURCE, "ftp://source.example/post", "not a URL"):
            form = EndpointForm(
                formdata=MultiDict({"source": source, "target": VALID_TARGET}),
                meta={"csrf": False},
            )
            assert form.validate() is (source == VALID_SOURCE)


@pytest.mark.parametrize(
    "source", ["http://127.0.0.1/", "http://[::1]/", "http://169.254.169.254/"]
)
def test_endpoint_rejects_private_ip_literals(app: Flask, source: str) -> None:
    with app.test_request_context("/endpoint", method="POST"):
        form = EndpointForm(
            formdata=MultiDict({"source": source, "target": VALID_TARGET}),
            meta={"csrf": False},
        )
        assert not form.validate()
        assert "URL must use a public address." in form.errors["source"]


def test_endpoint_handles_malformed_ipv6_without_crashing(app: Flask) -> None:
    with app.test_request_context("/endpoint", method="POST"):
        form = EndpointForm(
            formdata=MultiDict({"source": VALID_SOURCE, "target": "http://[::1"}),
            meta={"csrf": False},
        )
        assert not form.validate()
        assert "Invalid URL." in form.errors["target"]


def test_endpoint_form_applies_configurable_url_byte_limit_to_both_fields(
    app: Flask,
) -> None:
    with app.test_request_context("/endpoint", method="POST"):
        app.config["MAX_WEBMENTION_URL_BYTES"] = len(VALID_SOURCE.encode("utf-8"))
        form = EndpointForm(
            formdata=MultiDict({"source": VALID_SOURCE + "x", "target": VALID_TARGET}),
            meta={"csrf": False},
        )
        assert not form.validate()
        assert "source" in form.errors
        assert any("bytes" in message for message in form.errors["source"])

        app.config["MAX_WEBMENTION_URL_BYTES"] = len(VALID_TARGET.encode("utf-8"))
        form = EndpointForm(
            formdata=MultiDict({"source": VALID_SOURCE, "target": VALID_TARGET + "x"}),
            meta={"csrf": False},
        )
        assert not form.validate()
        assert "target" in form.errors
        assert any("bytes" in message for message in form.errors["target"])


@pytest.mark.parametrize("field_name", ["source", "target"])
@pytest.mark.parametrize(
    "invalid_url",
    [
        pytest.param("http://ex☃mple.test/", id="invalid-idn"),
        pytest.param("https://example.com/a\nb", id="newline"),
        pytest.param("https://example.com/a\rb", id="carriage-return"),
        pytest.param("https://example.com/\x00b", id="nul"),
        pytest.param("https://example.com/a b", id="ascii-space"),
        pytest.param("https://example.com/a\u00a0b", id="unicode-whitespace"),
        pytest.param("https://example.com/\x7fb", id="del"),
    ],
)
def test_endpoint_rejects_invalid_httpx_urls_and_whitespace(
    app: Flask, field_name: str, invalid_url: str
) -> None:
    data = {"source": VALID_SOURCE, "target": VALID_TARGET}
    data[field_name] = invalid_url
    with app.test_request_context("/endpoint", method="POST"):
        form = EndpointForm(formdata=MultiDict(data), meta={"csrf": False})
        assert not form.validate()
        assert "Invalid URL." in form.errors[field_name]


def test_endpoint_accepts_encoded_path_space(app: Flask) -> None:
    with app.test_request_context("/endpoint", method="POST"):
        form = EndpointForm(
            formdata=MultiDict(
                {"source": "https://source.example/a%20b", "target": VALID_TARGET}
            ),
            meta={"csrf": False},
        )
        assert form.validate()