aboutsummaryrefslogtreecommitdiff
path: root/tests/cli/test_users.py
blob: 4764c854ce2f5add5c819ecba86f2dc1f7967752 (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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
#
# SPDX-License-Identifier: BSD-3-Clause

from unittest.mock import patch

import pytest
import sqlalchemy as sa
from flask import Flask
from sqlalchemy.exc import IntegrityError

from webmentions_ssg import DATABASE
from webmentions_ssg.models import User


def _add_user(app: Flask, username: str, password: str = "original") -> None:
    """Persist a user using the same model as the CLI."""
    with app.app_context():
        DATABASE.session.add(User(username=username, password=password))
        DATABASE.session.commit()


def _get_user(app: Flask, username: str) -> User | None:
    with app.app_context():
        return DATABASE.session.scalar(sa.select(User).where(User.username == username))


def test_users_cli_help_lists_management_commands(app: Flask) -> None:
    result = app.test_cli_runner().invoke(args=["users", "--help"])

    assert result.exit_code == 0, result.output
    for command in ("create", "list", "set-password", "delete"):
        assert command in result.output


def test_users_cli_create_with_prompts_hashes_password(app: Flask) -> None:
    result = app.test_cli_runner().invoke(
        args=["users", "create"],
        input="alice\nmy new secret passphrase\nmy new secret passphrase\n",
    )

    assert result.exit_code == 0, result.output
    assert "Created user 'alice'." in result.output
    assert "my new secret passphrase" not in result.output
    user = _get_user(app, "alice")
    assert user is not None
    assert user.check_password("my new secret passphrase")
    assert user.password_hash != "my new secret passphrase"


def test_users_cli_create_with_username_option(app: Flask) -> None:
    result = app.test_cli_runner().invoke(
        args=["users", "create", "--username", "alice"],
        input="my new secret passphrase\nmy new secret passphrase\n",
    )

    assert result.exit_code == 0, result.output
    assert _get_user(app, "alice") is not None


def test_users_cli_create_rejects_duplicate(app: Flask) -> None:
    _add_user(app, "alice")

    result = app.test_cli_runner().invoke(
        args=[
            "users",
            "create",
            "--username",
            "alice",
            "--password",
            "a stronger duplicate password",
        ]
    )

    assert result.exit_code != 0
    assert "User 'alice' already exists." in result.output
    user = _get_user(app, "alice")
    assert user is not None
    assert user.check_password("original")


@pytest.mark.parametrize("username", ["", "   "])
def test_users_cli_create_rejects_invalid_username(app: Flask, username: str) -> None:
    result = app.test_cli_runner().invoke(
        args=[
            "users",
            "create",
            "--username",
            username,
            "--password",
            "a strong password for testing",
        ]
    )

    assert result.exit_code != 0
    assert "Username must not" in result.output


def test_users_cli_create_rejects_empty_password(app: Flask) -> None:
    result = app.test_cli_runner().invoke(
        args=["users", "create", "--username", "alice", "--password", ""]
    )

    assert result.exit_code != 0
    assert "Password must not be empty." in result.output
    assert _get_user(app, "alice") is None


def test_users_cli_list_empty(app: Flask) -> None:
    result = app.test_cli_runner().invoke(args=["users", "list"])

    assert result.exit_code == 0, result.output
    assert "No users found." in result.output


def test_users_cli_list_is_sorted_and_excludes_passwords(app: Flask) -> None:
    _add_user(app, "zoe")
    _add_user(app, "alice")

    result = app.test_cli_runner().invoke(args=["users", "list"])

    assert result.exit_code == 0, result.output
    lines = result.output.splitlines()
    assert lines[0] == "ID\tUSERNAME"
    assert lines[1].endswith("\talice")
    assert lines[2].endswith("\tzoe")
    assert "original" not in result.output


def test_users_cli_set_password_updates_hash(app: Flask) -> None:
    _add_user(app, "alice")
    old_hash = _get_user(app, "alice").password_hash  # type: ignore[union-attr]

    result = app.test_cli_runner().invoke(
        args=["users", "set-password", "alice"],
        input="a long replacement passphrase\na long replacement passphrase\n",
    )

    assert result.exit_code == 0, result.output
    assert "Updated password for user 'alice'." in result.output
    assert "a long replacement passphrase" not in result.output
    user = _get_user(app, "alice")
    assert user is not None
    assert user.password_hash != old_hash
    assert not user.check_password("original")
    assert user.check_password("a long replacement passphrase")


def test_users_cli_set_password_missing_user(app: Flask) -> None:
    result = app.test_cli_runner().invoke(
        args=[
            "users",
            "set-password",
            "missing",
            "--password",
            "a long replacement passphrase",
        ]
    )

    assert result.exit_code != 0
    assert "User 'missing' does not exist." in result.output


def test_users_cli_set_password_rejects_empty_password(app: Flask) -> None:
    _add_user(app, "alice")

    result = app.test_cli_runner().invoke(
        args=["users", "set-password", "alice", "--password", ""]
    )

    assert result.exit_code != 0
    assert "Password must not be empty." in result.output
    user = _get_user(app, "alice")
    assert user is not None
    assert user.check_password("original")


def test_users_cli_delete_with_confirmation(app: Flask) -> None:
    _add_user(app, "alice")

    result = app.test_cli_runner().invoke(
        args=["users", "delete", "alice"], input="y\n"
    )

    assert result.exit_code == 0, result.output
    assert "Delete user 'alice'?" in result.output
    assert "Deleted user 'alice'." in result.output
    assert _get_user(app, "alice") is None


def test_users_cli_delete_confirmation_rejected(app: Flask) -> None:
    _add_user(app, "alice")

    result = app.test_cli_runner().invoke(
        args=["users", "delete", "alice"], input="n\n"
    )

    assert result.exit_code != 0
    assert "Aborted" in result.output
    assert _get_user(app, "alice") is not None


def test_users_cli_delete_yes_only_deletes_target(app: Flask) -> None:
    _add_user(app, "alice")
    _add_user(app, "bob")

    result = app.test_cli_runner().invoke(args=["users", "delete", "alice", "--yes"])

    assert result.exit_code == 0, result.output
    assert "Deleted user 'alice'." in result.output
    assert _get_user(app, "alice") is None
    assert _get_user(app, "bob") is not None


def test_users_cli_delete_missing_user(app: Flask) -> None:
    result = app.test_cli_runner().invoke(args=["users", "delete", "missing", "-y"])

    assert result.exit_code != 0
    assert "User 'missing' does not exist." in result.output


def test_users_cli_delete_missing_blank_username(app: Flask) -> None:
    result = app.test_cli_runner().invoke(args=["users", "delete", " ", "--yes"])

    assert result.exit_code != 0
    assert "User ' ' does not exist." in result.output


def test_users_cli_can_manage_legacy_whitespace_username(app: Flask) -> None:
    _add_user(app, " alice ")

    reset = app.test_cli_runner().invoke(
        args=[
            "users",
            "set-password",
            " alice ",
            "--password",
            "a long replacement passphrase",
        ]
    )

    assert reset.exit_code == 0, reset.output
    user = _get_user(app, " alice ")
    assert user is not None
    assert user.check_password("a long replacement passphrase")

    deleted = app.test_cli_runner().invoke(args=["users", "delete", " alice ", "--yes"])
    assert deleted.exit_code == 0, deleted.output
    assert _get_user(app, " alice ") is None


def test_users_cli_create_rolls_back_on_duplicate_race(app: Flask) -> None:
    database_error = IntegrityError("INSERT", {}, Exception("duplicate"))

    with app.app_context():
        with (
            patch.object(DATABASE.session, "commit", side_effect=database_error),
            patch.object(DATABASE.session, "rollback") as rollback,
        ):
            result = app.test_cli_runner().invoke(
                args=[
                    "users",
                    "create",
                    "--username",
                    "alice",
                    "--password",
                    "a long secret for testing",
                ]
            )
        rollback.assert_called_once()

    assert result.exit_code != 0
    assert "User 'alice' already exists." in result.output


@pytest.mark.parametrize(
    ("password", "error"),
    [
        ("short", "at least 8 characters"),
        ("good passphrase with\tab", "control characters"),
    ],
)
@pytest.mark.parametrize("operation", ["create", "set-password"])
def test_users_cli_enforces_password_policy(
    app: Flask, password: str, error: str, operation: str
) -> None:
    _add_user(app, "existing")
    if operation == "create":
        command = ["users", "create", "--username", "new"]
    else:
        command = ["users", "set-password", "existing"]

    result = app.test_cli_runner().invoke(args=[*command, "--password", password])
    assert result.exit_code != 0
    assert error in result.output
    assert _get_user(app, "new") is None
    existing = _get_user(app, "existing")
    assert existing is not None and existing.check_password("original")


def test_users_cli_accepts_long_unicode_passphrase(app: Flask) -> None:
    passphrase = "🦊 several words of my passphrase 🪁"
    result = app.test_cli_runner().invoke(
        args=["users", "create", "--username", "alice", "--password", passphrase]
    )
    assert result.exit_code == 0, result.output
    user = _get_user(app, "alice")
    assert user is not None and user.check_password(passphrase)


@pytest.mark.parametrize("passphrase", ["12345678", " " * 8, "🦊" + "a" * 1025])
def test_users_cli_accepts_minimum_whitespace_and_unbounded_passwords(
    app: Flask, passphrase: str
) -> None:
    result = app.test_cli_runner().invoke(
        args=["users", "create", "--username", "alice", "--password", passphrase]
    )
    assert result.exit_code == 0, result.output
    user = _get_user(app, "alice")
    assert user is not None and user.check_password(passphrase)