Merge pull request #19 from unicef/fix/Align-db-models

Align db models

Author: ntrncic

docs/src/commands.md

@@ -30,3 +30,14 @@ This command runs migrations, creates extra permissions, and removes stale conte
 -   `--no-static`: Do not run collectstatic.
 -   `--admin-email`: Admin email.
 -   `--admin-password`: Admin password.
+
+## db_align
+
+This command aligns unmanaged HOPE models with the current HOPE database schema by regenerating `modules/hope/models/_inspect.py`.
+
+### Arguments
+
+-   `table`: Optional list of tables to introspect. If omitted, all configured HOPE tables are introspected.
+-   `--database`: Database alias to introspect. Defaults to `hope_ro`.
+-   `--schema`: Schema to introspect. Defaults to `public`.
+-   `--output-file`: Destination filename under `modules/hope/models/`. Defaults to `_inspect.py`.

src/hope_portal/api/urls.py

@@ -1,12 +1,8 @@
-from django.urls import include, path
-
 from .router import Router
 
 app_name = "api"
 
 router = Router()
 
 
-urlpatterns = [
-    path("", include(router.urls)),
-]
+urlpatterns = router.urls

src/hope_portal/management/commands/db_align.py

@@ -0,0 +1,65 @@
+from argparse import ArgumentParser
+from typing import Any
+
+from django.core.management import BaseCommand, call_command
+
+
+class Command(BaseCommand):
+    help = "Align HOPE unmanaged models with the current HOPE database schema."
+    requires_system_checks = []
+    requires_migrations_checks = False
+
+    def add_arguments(self, parser: ArgumentParser) -> None:
+        parser.add_argument(
+            "table",
+            action="store",
+            nargs="*",
+            type=str,
+            help="Optional list of tables to introspect. Introspects all configured HOPE tables when omitted.",
+        )
+        parser.add_argument(
+            "--database",
+            action="store",
+            dest="database",
+            default="hope_ro",
+            help='Database alias to introspect. Defaults to "hope_ro".',
+        )
+        parser.add_argument(
+            "--schema",
+            action="store",
+            dest="schema",
+            default="public",
+            help='Database schema to introspect. Defaults to "public".',
+        )
+        parser.add_argument(
+            "--output-file",
+            action="store",
+            dest="output_file",
+            default="_inspect.py",
+            type=str,
+            help='Destination filename under "modules/hope/models/". Defaults to "_inspect.py".',
+        )
+
+    def handle(self, *args: Any, **options: Any) -> None:
+        table: list[str] = options["table"]
+        database = options["database"]
+        schema = options["schema"]
+        output_file = options["output_file"]
+
+        self.stdout.write(
+            f"Aligning HOPE schema from database='{database}', schema='{schema}' into '{output_file}'",
+            self.style.WARNING,
+        )
+
+        call_command(
+            "inspect_hope",
+            *table,
+            database=database,
+            schema=schema,
+            output_file=output_file,
+        )
+
+        self.stdout.write(
+            "Schema alignment complete. Restart application workers to load updated models.",
+            self.style.SUCCESS,
+        )