125 lines
4.1 KiB
Python
Executable File
125 lines
4.1 KiB
Python
Executable File
#!/usr/bin/env python
|
|
"""System Migration handler"""
|
|
from importlib.util import module_from_spec, spec_from_file_location
|
|
from inspect import getmembers, isclass
|
|
from os import environ, system
|
|
from pathlib import Path
|
|
from typing import Any
|
|
|
|
from psycopg import Connection, Cursor, connect
|
|
from structlog.stdlib import get_logger
|
|
|
|
from authentik.lib.config import CONFIG
|
|
|
|
LOGGER = get_logger()
|
|
ADV_LOCK_UID = 1000
|
|
LOCKED = False
|
|
|
|
|
|
class CommandError(Exception):
|
|
"""Error raised when a system_crit command fails"""
|
|
|
|
|
|
class BaseMigration:
|
|
"""Base System Migration"""
|
|
|
|
cur: Cursor
|
|
con: Connection
|
|
|
|
def __init__(self, cur: Any, con: Any):
|
|
self.cur = cur
|
|
self.con = con
|
|
|
|
def system_crit(self, command: str):
|
|
"""Run system command"""
|
|
LOGGER.debug("Running system_crit command", command=command)
|
|
retval = system(command) # nosec
|
|
if retval != 0:
|
|
raise CommandError("Migration error")
|
|
|
|
def fake_migration(self, *app_migration: tuple[str, str]):
|
|
"""Fake apply a list of migrations, arguments are
|
|
expected to be tuples of (app_label, migration_name)"""
|
|
for app, _migration in app_migration:
|
|
self.system_crit(f"./manage.py migrate {app} {_migration} --fake")
|
|
|
|
def needs_migration(self) -> bool:
|
|
"""Return true if Migration needs to be run"""
|
|
return False
|
|
|
|
def run(self):
|
|
"""Run the actual migration"""
|
|
|
|
|
|
def wait_for_lock(cursor: Cursor):
|
|
"""lock an advisory lock to prevent multiple instances from migrating at once"""
|
|
global LOCKED # noqa: PLW0603
|
|
LOGGER.info("waiting to acquire database lock")
|
|
cursor.execute("SELECT pg_advisory_lock(%s)", (ADV_LOCK_UID,))
|
|
LOCKED = True
|
|
|
|
|
|
def release_lock(cursor: Cursor):
|
|
"""Release database lock"""
|
|
global LOCKED # noqa: PLW0603
|
|
if not LOCKED:
|
|
return
|
|
LOGGER.info("releasing database lock")
|
|
cursor.execute("SELECT pg_advisory_unlock(%s)", (ADV_LOCK_UID,))
|
|
LOCKED = False
|
|
|
|
|
|
def run_migrations():
|
|
conn = connect(
|
|
dbname=CONFIG.get("postgresql.name"),
|
|
user=CONFIG.get("postgresql.user"),
|
|
password=CONFIG.get("postgresql.password"),
|
|
host=CONFIG.get("postgresql.host"),
|
|
port=CONFIG.get_int("postgresql.port"),
|
|
sslmode=CONFIG.get("postgresql.sslmode"),
|
|
sslrootcert=CONFIG.get("postgresql.sslrootcert"),
|
|
sslcert=CONFIG.get("postgresql.sslcert"),
|
|
sslkey=CONFIG.get("postgresql.sslkey"),
|
|
)
|
|
curr = conn.cursor()
|
|
try:
|
|
wait_for_lock(curr)
|
|
for migration_path in Path(__file__).parent.absolute().glob("system_migrations/*.py"):
|
|
spec = spec_from_file_location("lifecycle.system_migrations", migration_path)
|
|
if not spec:
|
|
continue
|
|
mod = module_from_spec(spec)
|
|
spec.loader.exec_module(mod)
|
|
|
|
for name, sub in getmembers(mod, isclass):
|
|
if name != "Migration":
|
|
continue
|
|
migration = sub(curr, conn)
|
|
if migration.needs_migration():
|
|
LOGGER.info("Migration needs to be applied", migration=migration_path.name)
|
|
migration.run()
|
|
LOGGER.info("Migration finished applying", migration=migration_path.name)
|
|
LOGGER.info("applying django migrations")
|
|
environ.setdefault("DJANGO_SETTINGS_MODULE", "authentik.root.settings")
|
|
try:
|
|
from django.core.management import execute_from_command_line
|
|
except ImportError as exc:
|
|
raise ImportError(
|
|
"Couldn't import Django. Are you sure it's installed and "
|
|
"available on your PYTHONPATH environment variable? Did you "
|
|
"forget to activate a virtual environment?"
|
|
) from exc
|
|
execute_from_command_line(["", "migrate_schemas"])
|
|
execute_from_command_line(["", "migrate_schemas", "--schema", "template", "--tenant"])
|
|
execute_from_command_line(
|
|
["", "check"] + ([] if CONFIG.get_bool("debug") else ["--deploy"])
|
|
)
|
|
finally:
|
|
release_lock(curr)
|
|
curr.close()
|
|
conn.close()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
run_migrations()
|