✨(cli) add migration check command

The Warren CLI Alembic wrapper lacked a command to verify if the database has
any unapplied migrations.
This update introduces a migration check command, which will exit with a status
of 1 if there are unapplied migrations in the target database.

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to
 ### Added
 
 - Send LTI course id to the frontend
+- Add a warren migration check CLI command
 
 ### Changed
 

src/api/core/warren/cli.py

@@ -9,6 +9,7 @@
 from uuid import UUID
 
 import click
+from alembic.util import CommandError
 from pydantic import BaseModel
 
 from warren import __version__ as warren_version
@@ -42,6 +43,15 @@ def migration():
     """Database migration commands (alembic wrapper)."""
 
 
+@migration.command()
+def check():
+    """Check database migration."""
+    try:
+        alembic_migrations.check()
+    except CommandError:
+        raise click.ClickException("Target database is not up to date.") from None
+
+
 @migration.command()
 @click.option("--verbose", "-v", is_flag=True, default=False)
 def current(verbose: bool):

src/api/core/warren/migrations/__init__.py

@@ -9,6 +9,11 @@
 ALEMBIC_CFG.set_main_option("sqlalchemy.url", settings.DATABASE_URL)
 
 
+def check():
+    """Check if database has unapplied migrations."""
+    command.check(ALEMBIC_CFG)
+
+
 def current(verbose: bool = False):
     """Get information about the current migration state."""
     command.current(ALEMBIC_CFG, verbose=verbose)

src/api/core/warren/tests/test_cli.py

@@ -1,10 +1,11 @@
 """Test Warren commands functions."""
 
 # ruff: noqa: S106
-from unittest.mock import AsyncMock, MagicMock
+from unittest.mock import AsyncMock, MagicMock, Mock
 
 import pytest
 from alembic import command as alembic_command
+from alembic.util import CommandError
 from click import BadParameter
 from click.testing import CliRunner
 from pydantic import BaseModel
@@ -23,6 +24,22 @@
 from warren.xi.schema import Experience
 
 
+def test_migration_check_command(monkeypatch):
+    """Test warren check command."""
+    monkeypatch.setattr(alembic_command, "check", MagicMock())
+
+    runner = CliRunner()
+    runner.invoke(cli, ["migration", "check"])
+    alembic_command.check.assert_called_with(migrations.ALEMBIC_CFG)
+
+    monkeypatch.setattr(alembic_command, "check", Mock(side_effect=CommandError))
+
+    runner = CliRunner()
+    result = runner.invoke(cli, ["migration", "check"])
+    alembic_command.check.assert_called_with(migrations.ALEMBIC_CFG)
+    assert result.exit_code == 1
+
+
 def test_migration_current_command(monkeypatch):
     """Test warren current command."""
     monkeypatch.setattr(alembic_command, "current", MagicMock())