From 5afb245d13b91047d68d7b7343245c41b6460953 Mon Sep 17 00:00:00 2001 From: Dennis Fink Date: Tue, 27 Oct 2026 16:33:56 +0100 Subject: feat(core): expand user management CLI Add commands to list users, reset passwords, and delete accounts. Move mail and user commands into dedicated CLI modules. --- tests/cli/test_mail.py | 77 ++++++++++++++++ tests/cli/test_users.py | 237 ++++++++++++++++++++++++++++++++++++++++++++++++ tests/test_cli.py | 77 ---------------- 3 files changed, 314 insertions(+), 77 deletions(-) create mode 100644 tests/cli/test_mail.py create mode 100644 tests/cli/test_users.py delete mode 100644 tests/test_cli.py (limited to 'tests') diff --git a/tests/cli/test_mail.py b/tests/cli/test_mail.py new file mode 100644 index 0000000..0a2afce --- /dev/null +++ b/tests/cli/test_mail.py @@ -0,0 +1,77 @@ +# SPDX-FileCopyrightText: 2026 Dennis Fink +# +# SPDX-License-Identifier: BSD-3-Clause + +from unittest.mock import patch + +from flask import Flask + + +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" + ) + + with patch("webmentions_ssg.MAIL.send") as send: + result = app.test_cli_runner().invoke(args=["mail", "test"]) + + assert result.exit_code == 0, result.output + send.assert_called_once() + message = send.call_args.args[0] + assert message.sender == "sender@example.com" + assert message.recipients == ["owner@example.com"] + assert "test email" in message.subject.lower() + assert "outgoing mail configuration" in message.body + assert "Test email sent to owner@example.com." in result.output + + +def test_mail_cli_overrides_configured_recipient(app: Flask) -> None: + app.config.update( + NOTIFICATION_EMAIL="owner@example.com", MAIL_DEFAULT_SENDER="sender@example.com" + ) + + with patch("webmentions_ssg.MAIL.send") as send: + result = app.test_cli_runner().invoke( + args=["mail", "test", "--to", "other@example.com"] + ) + + assert result.exit_code == 0, result.output + send.assert_called_once() + assert send.call_args.args[0].recipients == ["other@example.com"] + + +def test_mail_cli_requires_recipient(app: Flask) -> None: + app.config.update(NOTIFICATION_EMAIL=None, MAIL_DEFAULT_SENDER="sender@example.com") + + with patch("webmentions_ssg.MAIL.send") as send: + result = app.test_cli_runner().invoke(args=["mail", "test"]) + + assert result.exit_code != 0 + assert "Set NOTIFICATION_EMAIL or pass --to" in result.output + send.assert_not_called() + + +def test_mail_cli_requires_default_sender(app: Flask) -> None: + app.config.update(NOTIFICATION_EMAIL="owner@example.com", MAIL_DEFAULT_SENDER=None) + + with patch("webmentions_ssg.MAIL.send") as send: + result = app.test_cli_runner().invoke(args=["mail", "test"]) + + assert result.exit_code != 0 + assert "MAIL_DEFAULT_SENDER is not configured" in result.output + send.assert_not_called() + + +def test_mail_cli_reports_smtp_failure(app: Flask) -> None: + app.config.update( + NOTIFICATION_EMAIL="owner@example.com", MAIL_DEFAULT_SENDER="sender@example.com" + ) + + with patch( + "webmentions_ssg.MAIL.send", side_effect=ConnectionError("SMTP unavailable") + ) as send: + result = app.test_cli_runner().invoke(args=["mail", "test"]) + + assert result.exit_code != 0 + assert "Could not send test email: SMTP unavailable" in result.output + send.assert_called_once() diff --git a/tests/cli/test_users.py b/tests/cli/test_users.py new file mode 100644 index 0000000..24bab0a --- /dev/null +++ b/tests/cli/test_users.py @@ -0,0 +1,237 @@ +# SPDX-FileCopyrightText: 2026 Dennis Fink +# +# SPDX-License-Identifier: BSD-3-Clause + +from unittest.mock import patch + +import pytest +import sqlalchemy as sa +from flask import Flask + +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\nnew-secret\nnew-secret\n" + ) + + assert result.exit_code == 0, result.output + assert "Created user 'alice'." in result.output + assert "new-secret" not in result.output + user = _get_user(app, "alice") + assert user is not None + assert user.check_password("new-secret") + assert user.password_hash != "new-secret" + + +def test_users_cli_create_with_username_option(app: Flask) -> None: + result = app.test_cli_runner().invoke( + args=["users", "create", "--username", "alice"], + input="new-secret\nnew-secret\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", "other"] + ) + + 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", "valid"] + ) + + 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="replacement\nreplacement\n" + ) + + assert result.exit_code == 0, result.output + assert "Updated password for user 'alice'." in result.output + assert "replacement" 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("replacement") + + +def test_users_cli_set_password_missing_user(app: Flask) -> None: + result = app.test_cli_runner().invoke( + args=["users", "set-password", "missing", "--password", "replacement"] + ) + + 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", "replacement"] + ) + + assert reset.exit_code == 0, reset.output + user = _get_user(app, " alice ") + assert user is not None + assert user.check_password("replacement") + + 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 = sa.exc.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", "secret"] + ) + rollback.assert_called_once() + + assert result.exit_code != 0 + assert "User 'alice' already exists." in result.output diff --git a/tests/test_cli.py b/tests/test_cli.py deleted file mode 100644 index 0a2afce..0000000 --- a/tests/test_cli.py +++ /dev/null @@ -1,77 +0,0 @@ -# SPDX-FileCopyrightText: 2026 Dennis Fink -# -# SPDX-License-Identifier: BSD-3-Clause - -from unittest.mock import patch - -from flask import Flask - - -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" - ) - - with patch("webmentions_ssg.MAIL.send") as send: - result = app.test_cli_runner().invoke(args=["mail", "test"]) - - assert result.exit_code == 0, result.output - send.assert_called_once() - message = send.call_args.args[0] - assert message.sender == "sender@example.com" - assert message.recipients == ["owner@example.com"] - assert "test email" in message.subject.lower() - assert "outgoing mail configuration" in message.body - assert "Test email sent to owner@example.com." in result.output - - -def test_mail_cli_overrides_configured_recipient(app: Flask) -> None: - app.config.update( - NOTIFICATION_EMAIL="owner@example.com", MAIL_DEFAULT_SENDER="sender@example.com" - ) - - with patch("webmentions_ssg.MAIL.send") as send: - result = app.test_cli_runner().invoke( - args=["mail", "test", "--to", "other@example.com"] - ) - - assert result.exit_code == 0, result.output - send.assert_called_once() - assert send.call_args.args[0].recipients == ["other@example.com"] - - -def test_mail_cli_requires_recipient(app: Flask) -> None: - app.config.update(NOTIFICATION_EMAIL=None, MAIL_DEFAULT_SENDER="sender@example.com") - - with patch("webmentions_ssg.MAIL.send") as send: - result = app.test_cli_runner().invoke(args=["mail", "test"]) - - assert result.exit_code != 0 - assert "Set NOTIFICATION_EMAIL or pass --to" in result.output - send.assert_not_called() - - -def test_mail_cli_requires_default_sender(app: Flask) -> None: - app.config.update(NOTIFICATION_EMAIL="owner@example.com", MAIL_DEFAULT_SENDER=None) - - with patch("webmentions_ssg.MAIL.send") as send: - result = app.test_cli_runner().invoke(args=["mail", "test"]) - - assert result.exit_code != 0 - assert "MAIL_DEFAULT_SENDER is not configured" in result.output - send.assert_not_called() - - -def test_mail_cli_reports_smtp_failure(app: Flask) -> None: - app.config.update( - NOTIFICATION_EMAIL="owner@example.com", MAIL_DEFAULT_SENDER="sender@example.com" - ) - - with patch( - "webmentions_ssg.MAIL.send", side_effect=ConnectionError("SMTP unavailable") - ) as send: - result = app.test_cli_runner().invoke(args=["mail", "test"]) - - assert result.exit_code != 0 - assert "Could not send test email: SMTP unavailable" in result.output - send.assert_called_once() -- cgit v1.3.1