aboutsummaryrefslogtreecommitdiff
path: root/tests
diff options
context:
space:
mode:
authorDennis Fink2026-11-16 16:21:51 +0100
committerDennis Fink2026-11-16 16:21:51 +0100
commit09353e2fd7a66987076f33f65ac4f0fc8831e887 (patch)
tree3b2aea952518022a4cd57268b86cf73507ab3440 /tests
parent335c27571fa1856a6b775ff51d69d1590273a965 (diff)
downloadwebmentions-ssg-09353e2fd7a66987076f33f65ac4f0fc8831e887.tar.gz
webmentions-ssg-09353e2fd7a66987076f33f65ac4f0fc8831e887.zip
fix(core): restrict migrate CLI to development
Hide Flask-Migrate's unrestricted command group unless `WEBMENTIONS_SSG_DEV` is enabled, while keeping the guarded database management commands available. Base migration CLI exposure on the development environment flag rather than the selected configuration class.
Diffstat (limited to '')
-rw-r--r--tests/test_cli.py44
1 files changed, 42 insertions, 2 deletions
diff --git a/tests/test_cli.py b/tests/test_cli.py
index 9485494..c98b2fc 100644
--- a/tests/test_cli.py
+++ b/tests/test_cli.py
@@ -18,7 +18,7 @@ from sqlalchemy import inspect
from sqlalchemy.exc import IntegrityError
from webmentions_ssg import create_app, db, migrate
-from webmentions_ssg.config import TestingConfig
+from webmentions_ssg.config import DevelopmentConfig, TestingConfig
from webmentions_ssg.models import ReceivedWebmention, ReceivedWebmentionStatus, User
@@ -30,6 +30,7 @@ def test_cli_groups_are_registered(app: Flask) -> None:
@pytest.fixture
def database_app(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Iterator[Flask]:
monkeypatch.chdir(tmp_path)
+ monkeypatch.delenv("WEBMENTIONS_SSG_DEV", raising=False)
class DatabaseTestingConfig(TestingConfig):
LOG_FILE = str(tmp_path / "database-cli.log")
@@ -65,7 +66,7 @@ def _database_revision(app: Flask) -> str:
).scalar_one()
-def test_database_commands_are_registered_without_hiding_flask_migrate(
+def test_database_commands_are_available_without_migrate_in_testing(
database_app: Flask,
) -> None:
runner = database_app.test_cli_runner()
@@ -75,10 +76,49 @@ def test_database_commands_are_registered_without_hiding_flask_migrate(
assert "create-db" in result.output
assert "upgrade" in result.output
+ assert "migrate" not in database_app.cli.commands
+ result = runner.invoke(args=["migrate", "--help"])
+ assert result.exit_code != 0
+ assert "No such command 'migrate'" in result.output
+
+
+def test_migrate_commands_are_available_only_with_dev_env(
+ tmp_path: Path, monkeypatch: pytest.MonkeyPatch
+) -> None:
+ # Even an explicitly supplied testing config should expose migrations in DEV.
+ monkeypatch.setenv("WEBMENTIONS_SSG_DEV", "1")
+
+ class CLITestingConfig(TestingConfig):
+ LOG_FILE = str(tmp_path / "development-cli.log")
+
+ app = create_app(CLITestingConfig)
+ assert "migrate" in app.cli.commands
+ runner = app.test_cli_runner()
+
result = runner.invoke(args=["migrate", "--help"])
assert result.exit_code == 0, result.output
assert "downgrade" in result.output
assert "revision" in result.output
+ assert "upgrade" in result.output
+
+ result = runner.invoke(args=["db", "--help"])
+ assert result.exit_code == 0, result.output
+ assert "create-db" in result.output
+ assert "upgrade" in result.output
+
+ # Configuration inheritance must not enable migrations when DEV is unset.
+ monkeypatch.delenv("WEBMENTIONS_SSG_DEV")
+
+ class DevelopmentTestingConfig(DevelopmentConfig):
+ TESTING = True
+ LOG_FILE = str(tmp_path / "development-disabled-cli.log")
+ HUEY_URL = "memory://"
+
+ non_dev_app = create_app(DevelopmentTestingConfig)
+ assert "migrate" not in non_dev_app.cli.commands
+ result = non_dev_app.test_cli_runner().invoke(args=["migrate", "--help"])
+ assert result.exit_code != 0
+ assert "No such command 'migrate'" in result.output
def test_create_db_builds_schema_and_records_latest_migration(