#510 6th PoC - fix DB Alembic upgrade mgnt with Flask-Migrate latest

Author: justb4

.github/workflows/main.yml

@@ -37,6 +37,12 @@ jobs:
     - name: Load Fixtures Test Data ⚙️
       run: pixi run -e dev load-data tests/data/fixtures.json
 
+    - name: Test DB downgrade to previous schema (via Alembic) ⚙️
+      run: pixi run -e dev db-downgrade
+
+    - name: Test DB upgrade back to current schema (via Alembic) ⚙️
+      run: pixi run -e dev db-upgrade
+
     - name: Run Probes ⚙️
       run: pixi run -e dev run-healthchecks
 

GeoHealthCheck/manage.py

@@ -37,17 +37,36 @@
 # optional arguments:
 #   -h, --help  show this help message and exit
 
-from flask_script import Manager
-from flask_migrate import Migrate, MigrateCommand
+from flask_migrate import (Migrate, upgrade, downgrade, current,
+                           migrate, history, revision)
 from init import App
+import sys
 
 DB = App.get_db()
 APP = App.get_app()
 
-migrate = Migrate(APP, DB)
-
-manager = Manager(APP)
-manager.add_command('db', MigrateCommand)
+Migrate(APP, DB)
 
 if __name__ == '__main__':
-    manager.run()
+    action = ''
+    if len(sys.argv) > 1:
+        action = sys.argv[1]
+
+    with APP.app_context():
+        if action == 'current':
+            current()
+        elif action == 'upgrade':
+            # Upgrade to latest version
+            upgrade()
+        elif action == 'downgrade':
+            # Downgrade one version back
+            downgrade()
+        elif action == 'migrate':
+            # Generate revision
+            migrate()
+        elif action == 'history':
+            # Show revisions
+            history()
+        elif action == 'revision':
+            # Create new revision
+            revision()

GeoHealthCheck/migrations/README.md

@@ -1,12 +1,13 @@
 # Database upgrade support
 
 This dir contains various files for developing database upgrades.
-Upgrades are supported using Alembic via Flask-Migrate
-and Flask-Script.
-Users should be able to upgrade existing installs via: 
+Upgrades are supported using Alembic via Flask-Migrate.
+Users should be able to upgrade existing installations via `pixi`: 
 
 	# In top dir of installation
-	invoke upgrade
+	pixi run db-upgrade
+	# or the equivalent
+	python manage.py upgrade
 
 The `versions` dir contains the various upgrades. These were
 initially created using the Alembic `autogenerate` facility
@@ -20,12 +21,12 @@ for various DB management tasks related to migrations and upgrading.
 Whenever a change in the database schema or table content
 conventions has changed a new migration should be created via the command.
 
-	python3 manage.py db migrate
+	python manage.py migrate
 
 Where `migrate` is an alias for `revision --autogenerate`. 
 Alternatively if the autogeneration does not work, create an empty migration: 
 
-	python3 manage.py db revision
+	python manage.py revision
 
 In both cases this will create a new revision and a `<revision_number>_.py` file 
 under `versions/` to upgrade
@@ -37,9 +38,9 @@ to check various DB metadata.
 
 Subsequently the upgrade can be performed using:
 
-	python3 manage.py db upgrade
-	# or the equivalent (for users) 
-	invoke upgrade
+	pixi run db-upgrade
+	# or the equivalent
+	python manage.py upgrade
 
 ## Revisions
 

docker/scripts/run-web.sh

@@ -16,7 +16,7 @@ export PYTHONPATH=/GeoHealthCheck/GeoHealthCheck:$PYTHONPATH
 pushd /GeoHealthCheck || exit 1
 
 # pixi shell -e prod
-pixi run -e prod upgrade-db
+pixi run -e prod db-upgrade
 
 # SCRIPT_NAME should not have value '/'
 [ "${SCRIPT_NAME}" = '/' ] && export SCRIPT_NAME="" && echo "make SCRIPT_NAME empty from /"

pixi.lock

@@ -22,8 +22,7 @@ dependencies = [
     "Flask==1.1.1",
     "Flask-Babel==0.12.2",
     "Flask-Login==0.4.1",
-    "Flask-Migrate==2.5.2",
-    "Flask-Script==2.0.6",
+    "Flask-Migrate==4.1.0",
     "SQLAlchemy==1.3.8",
     "Flask-SQLAlchemy==2.4.0",
     "itsdangerous==1.1.0",
@@ -82,7 +81,8 @@ run = "python GeoHealthCheck/app.py"
 docs = "invoke refresh-docs"
 clean = "invoke clean"
 runner-daemon = "invoke runner-daemon"
-upgrade-db = "invoke upgrade"
+db-upgrade = "invoke db-upgrade"
+db-downgrade = "invoke db-downgrade"
 run-healthchecks = "invoke run-healthchecks"
 run-tests = "invoke run-tests"
 

pyproject.toml

@@ -206,12 +206,22 @@ def create_hash(c, password):
 
 
 @task
-def upgrade(c):
+def db_upgrade(c):
     """upgrade database if changed; be sure to backup first!"""
 
     print('Upgrading database...')
     os.chdir(BASEDIR / 'GeoHealthCheck')
-    c.run('python manage.py db upgrade')
+    c.run('python manage.py upgrade')
+    os.chdir(BASEDIR)
+
+
+@task
+def db_downgrade(c):
+    """downgrade database to previous version; be sure to backup first!"""
+
+    print('Downgrading database...')
+    os.chdir(BASEDIR / 'GeoHealthCheck')
+    c.run('python manage.py downgrade')
     os.chdir(BASEDIR)