Use alembic instead of sqlalchemy-migrate for migrations

Existing databases are assumed to have all existing migrations applied.
On upgrade, we'll detect the presence of the `migrate_version` table,
and set the alembic version to the initial/current schema, `0001`.

Also remove the setuptools pin since it was there for
sqlalchemy-migrate's benefit.

Author: jcristau

pyproject.toml

@@ -10,6 +10,7 @@ readme = "README.rst"
 requires-python = ">=3.13"
 dependencies = [
     "aiohttp",
+    "alembic",
     "arrow",
     "auth0-python>=5",
     "connexion<3",
@@ -31,10 +32,8 @@ dependencies = [
     "requests",
     "requests-hawk",
     "sentry-sdk[flask]",
-    # sqlalchemy-migrate tries to import pkg_resources which doesn't exist anymore after setuptools 82
-    "setuptools<82",
+    "setuptools",
     "spec-synthase",
-    "sqlalchemy-migrate",
     "sqlalchemy<2",
     "statsd",
     "swagger-spec-validator",

scripts/manage-db.py

@@ -157,7 +157,7 @@ def extract_active_data(trans, url, dump_location="dump.sql"):
 
         # Now extract the data we actually want....
         # We always want all the data from a few tables...
-        run(mysql_data_only_command(host, user, password, db, "dockerflow rules rules_history migrate_version").split(), stdout=dump_file, check=True)
+        run(mysql_data_only_command(host, user, password, db, "dockerflow rules rules_history alembic_version").split(), stdout=dump_file, check=True)
 
         release_names = get_active_release_names(trans)
         extract_releases(release_names, url, dump_file)
@@ -195,7 +195,7 @@ def _strip_multiple_spaces(string):
     usage += "  cleanup-dryrun: Show what would be removed if 'cleanup' is run."
     parser = OptionParser(usage=usage)
     parser.add_option("-d", "--db", dest="db", default=None, help="database to manage, in URI format")
-    parser.add_option("--version", dest="version", default=None, type="int", help="Create/upgrade to this specific schema version rather than the latest.")
+    parser.add_option("--version", dest="version", default=None, type="string", help="Create/upgrade to this specific schema version rather than the latest.")
     options, args = parser.parse_args()
 
     if not options.db:

src/auslib/alembic/env.py

@@ -0,0 +1,95 @@
+"""Alembic environment configuration.
+
+Supports both programmatic use (engine passed via config.attributes["connection"])
+and CLI use (for developers running `alembic revision --autogenerate`).
+"""
+
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    # disable_existing_loggers=False is required to preserve loggers set up before
+    # migrations run
+    fileConfig(config.config_file_name, disable_existing_loggers=False)
+
+# Get target_metadata from config attributes (set programmatically)
+# or create an AUSDatabase instance for CLI/autogenerate use
+target_metadata = config.attributes.get("target_metadata")
+if target_metadata is None:
+    # CLI mode - create a database instance to get metadata
+    from auslib.db import AUSDatabase
+
+    db = AUSDatabase()
+    # Get database URI from alembic.ini or environment
+    db_uri = config.get_main_option("sqlalchemy.url")
+    if db_uri:
+        db.setDburi(db_uri)
+        target_metadata = db.metadata
+    else:
+        raise ValueError(
+            "No target_metadata in config.attributes and no sqlalchemy.url in config. "
+            "Either pass metadata programmatically or set sqlalchemy.url in alembic.ini"
+        )
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    # Check if a connection was passed programmatically
+    connectable = config.attributes.get("connection")
+
+    if connectable is None:
+        # CLI mode - create engine from config
+        connectable = engine_from_config(
+            config.get_section(config.config_ini_section, {}),
+            prefix="sqlalchemy.",
+            poolclass=pool.NullPool,
+        )
+
+    with connectable.connect() as connection:
+        context.configure(connection=connection, target_metadata=target_metadata)
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

src/auslib/alembic/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}