#510 6th PoC - fixes and improvements DB actions manage.py and friends

Author: justb4

.github/workflows/main.yml

@@ -37,11 +37,11 @@ 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: Test DB downgrade to previous schema (via Alembic) ⚙️
+      run: pixi run -e dev db-action downgrade
+
+    - name: Test DB upgrade back to current schema (via Alembic) ⚙️
+      run: pixi run -e dev db-action upgrade
 
     - name: Run Probes ⚙️
       run: pixi run -e dev run-healthchecks

Dockerfile

@@ -91,15 +91,16 @@ RUN \
     && echo "For ${TZ} date=$(date)" && echo "Locale=$(locale)"  \
     && adduser --disabled-password --shell /bin/bash --home ${GHC_HOME} --gecos "User" ghc \
     && chmod +x /*.sh  \
-    && echo "pixi install --locked -e prod" && pixi install --locked -e prod \
-    && echo "pixi run -e prod setup" && pixi run -e prod setup \
-    && echo "cp /config_site.py " && cp /config_site.py ${GHC_HOME}/instance/config_site.py \
-    && echo "copy plugins.." && if [ -d /plugins ]; then cp -ar /plugins/* ${GHC_HOME}/GeoHealthCheck/plugins/; fi && rm -rf /plugins \
+    && pixi install --locked -e prod \
+    && pixi run -e prod setup \
+    && cp /config_site.py ${GHC_HOME}/instance/config_site.py \
+    && if [ -d /plugins ]; then cp -ar /plugins/* ${GHC_HOME}/GeoHealthCheck/plugins/; fi && rm -rf /plugins \
     && apt-get remove --purge -y ${DEB_BUILD_DEPS} \
     && apt-get clean \
     && apt autoremove -y  \
     && rm -rf /var/lib/apt/lists/*
 
+# For later: run as user 'ghc'
 # USER ghc
 
 # For SQLite

GeoHealthCheck/manage.py

@@ -7,22 +7,16 @@
 # Usage:
 #
 # $ python3 manage.py --help
-# usage: manage.py [-h] {shell,db,runserver} ...
-#
-# positional arguments:
-#   {shell,db,runserver}
-#     shell     Runs a Python shell inside Flask application context.
-#     db        Perform database migrations
-#     runserver Runs the Flask development server i.e. app.run()
+# usage: manage.py action
 #
 # optional arguments:
 #   -h, --help  show this help message and exit
 #
 # For DB management:
-# $ python3 manage.py db --help
+# $ python manage.py upgrade
 # usage: Perform database migrations
 #
-# positional arguments:
+# action arguments:
 #   {upgrade,migrate,current,stamp,init,downgrade,history,revision}
 #     upgrade         Upgrade to a later version
 #     migrate         Alias for 'revision --autogenerate'
@@ -37,20 +31,28 @@
 # optional arguments:
 #   -h, --help  show this help message and exit
 
+import sys
+import os
 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(APP, DB)
+workdir_path = os.path.dirname(__file__)
+migrations_path = os.path.join(workdir_path, 'migrations')
+Migrate(APP, DB, directory=migrations_path)
+ACTIONS = ['current', 'upgrade', 'downgrade', 'migrate', 'history', 'revision']
 
 if __name__ == '__main__':
-    action = ''
-    if len(sys.argv) > 1:
-        action = sys.argv[1]
+    if len(sys.argv) < 1 or sys.argv[1] not in ACTIONS:
+        print(f'Invalid action, valid values: {ACTIONS}')
+        sys.exit(1)
+
+    # Valid action name
+    action = sys.argv[1]
+
+    os.chdir(workdir_path)
 
     with APP.app_context():
         if action == 'current':

GeoHealthCheck/migrations/README.md

@@ -5,7 +5,7 @@ Upgrades are supported using Alembic via Flask-Migrate.
 Users should be able to upgrade existing installations via `pixi`: 
 
 	# In top dir of installation
-	pixi run db-upgrade
+	pixi run db-action upgrade
 	# or the equivalent
 	python manage.py upgrade
 
@@ -38,7 +38,7 @@ to check various DB metadata.
 
 Subsequently the upgrade can be performed using:
 
-	pixi run db-upgrade
+	pixi run db-action upgrade
 	# or the equivalent
 	python manage.py upgrade
 

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 db-upgrade
+pixi run -e prod db-action upgrade
 
 # SCRIPT_NAME should not have value '/'
 [ "${SCRIPT_NAME}" = '/' ] && export SCRIPT_NAME="" && echo "make SCRIPT_NAME empty from /"

docs/install.rst

@@ -105,7 +105,7 @@ An existing GHC database installation can be upgraded with:
 .. code-block:: bash
 
   # In the top directory (e.g. the topdir cloned from github)
-  invoke upgrade
+  invoke db-action upgrade
 
   # Notice any output, in particular errors
 
@@ -177,10 +177,10 @@ were added:
 * OGC 3DTiles Probe (by SpotInfo)
 * MapBox TileJSON Probe (by SpotInfo)
 * additional WMTS Probes (by SpotInfo)
-* use official OGC naming for OAFeat Probes (includes DB-upgrade)
+* use official OGC naming for OAFeat Probes (includes db-action upgrade)
 * many bugfixes and security updates
 
-Only a single DB-upgrade is required and only if your installation (DB) contains
+Only a single db-action upgrade is required and only if your installation (DB) contains
 OGC OAFeat Resources and Probes, formerly called "WFS3".
 
 See `closed issues/merged PRs for related Milestone 0.9.0 <https://github.com/geopython/GeoHealthCheck/milestone/10?closed=1>`_.

pyproject.toml

@@ -8,6 +8,7 @@ license = { text = "MIT" }
 authors = [
     { name = "Just van den Broecke", email = "just@justobjects.nl" },
     { name = "Tom Kralidis", email = "tomkralidis@gmail.com" },
+    { name = "Francesco Bartoli" },
 ]
 # Complete runtime dependency set, readable by pip and Dependabot.
 # Hybrid sourcing: the native/geo libs listed here AND in
@@ -81,8 +82,7 @@ run = "python GeoHealthCheck/app.py"
 docs = "invoke refresh-docs"
 clean = "invoke clean"
 runner-daemon = "invoke runner-daemon"
-db-upgrade = "invoke db-upgrade"
-db-downgrade = "invoke db-downgrade"
+db-action = "invoke db-action"
 run-healthchecks = "invoke run-healthchecks"
 run-tests = "invoke run-tests"
 

tasks.py

@@ -206,23 +206,15 @@ def create_hash(c, password):
 
 
 @task
-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 upgrade')
-    os.chdir(BASEDIR)
+def db_action(c, action):
+    """Execute database action, e.g. upgrade, downgrade"""
 
+    if action is None:
+        print('Usage: db-action (action), or try help')
+        return
 
-@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)
+    print(f'Database action={action}')
+    c.run(f'python GeoHealthCheck/manage.py {action}')
 
 
 @task