|
| 1 | +#!/usr/bin/env python |
| 2 | +# Licensed to the Apache Software Foundation (ASF) under one |
| 3 | +# or more contributor license agreements. See the NOTICE file |
| 4 | +# distributed with this work for additional information |
| 5 | +# regarding copyright ownership. The ASF licenses this file |
| 6 | +# to you under the Apache License, Version 2.0 (the |
| 7 | +# "License"); you may not use this file except in compliance |
| 8 | +# with the License. You may obtain a copy of the License at |
| 9 | +# |
| 10 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | +# |
| 12 | +# Unless required by applicable law or agreed to in writing, |
| 13 | +# software distributed under the License is distributed on an |
| 14 | +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | +# KIND, either express or implied. See the License for the |
| 16 | +# specific language governing permissions and limitations |
| 17 | +# under the License. |
| 18 | +""" |
| 19 | +Pre-commit hook to check if SQLAlchemy model changes require a database migration. |
| 20 | +This script uses alembic.command.check to detect if model changes require migrations. |
| 21 | +""" |
| 22 | + |
| 23 | +from __future__ import annotations |
| 24 | + |
| 25 | +import subprocess |
| 26 | +import sys |
| 27 | + |
| 28 | +try: |
| 29 | + from rich import print |
| 30 | + from rich.console import Console |
| 31 | + from rich.panel import Panel |
| 32 | +except ImportError: |
| 33 | + print("ERROR: The rich package is required for this pre-commit hook.") |
| 34 | + print("Install it using: pip install rich") |
| 35 | + sys.exit(1) |
| 36 | + |
| 37 | +console = Console(width=120) |
| 38 | + |
| 39 | + |
| 40 | +def check_for_migration_needs(): |
| 41 | + """Check if model changes require a migration using alembic.command.check.""" |
| 42 | + |
| 43 | + try: |
| 44 | + result = subprocess.run( |
| 45 | + ["breeze", "shell", "cd airflow-core/src/airflow && alembic check", "--answer", "n"], |
| 46 | + check=False, |
| 47 | + capture_output=True, |
| 48 | + text=True, |
| 49 | + ) |
| 50 | + |
| 51 | + if result.returncode != 0: |
| 52 | + console.print( |
| 53 | + Panel.fit( |
| 54 | + "[bold red]Model changes detected that require a migration![/bold red]\n\n" |
| 55 | + "The alembic check command has detected model changes that would generate new migration operations.\n\n" |
| 56 | + "Please create a migration file by running:\n" |
| 57 | + '[bold yellow]cd airflow-core && alembic revision --autogenerate -m "your migration message"[/bold yellow]\n\n' |
| 58 | + "Then review the generated migration file to ensure it captures your changes correctly.", |
| 59 | + title="Migration Required", |
| 60 | + border_style="red", |
| 61 | + ) |
| 62 | + ) |
| 63 | + |
| 64 | + return 1 |
| 65 | + else: |
| 66 | + console.print("[green]No new upgrade operations detected. No migration needed.[/green]") |
| 67 | + return 0 |
| 68 | + |
| 69 | + except subprocess.CalledProcessError as e: |
| 70 | + console.print(f"[bold red]Error running alembic check:[/bold red] {e}") |
| 71 | + console.print(f"[bold red]Output:[/bold red] {e.stdout.decode() if e.stdout else ''}") |
| 72 | + console.print(f"[bold red]Error:[/bold red] {e.stderr.decode() if e.stderr else ''}") |
| 73 | + return 1 |
| 74 | + |
| 75 | + |
| 76 | +if __name__ == "__main__": |
| 77 | + sys.exit(check_for_migration_needs()) |
0 commit comments