make+scripts+GitHub: prevent missing migration files

This commit adds a check script to our CI that makes sure there are no
"holes" in the numbering of our migration version files.
The script would also detect duplicate numbers in the migration
prefixes.
This is to prevent mistakes from cherry-picking commits onto branches
that contain migration files.

Author: guggero

.github/workflows/main.yaml

@@ -81,15 +81,15 @@ jobs:
       - name: Run test vector creation check
         run: make test-vector-check
 
-  migration-version-check:
+  migration-check:
     name: migration version check
     runs-on: ubuntu-latest
     steps:
       - name: git checkout
         uses: actions/checkout@v3
 
-      - name: Run migration version check
-        run: make migration-version-check
+      - name: Run migration check
+        run: make migration-check
 
   ########################
   # Compilation check.

Makefile

@@ -331,7 +331,10 @@ test-vector-check: gen-deterministic-test-vectors
 	@$(call print, "Checking deterministic test vectors.")
 	if test -n "$$(git status | grep -e ".json")"; then echo "Test vectors not updated"; git status; git diff; exit 1; fi
 
-migration-version-check:
+migration-check:
+	@$(call print, "Checking migration numbering.")
+	./scripts/check-migration-numbering.sh
+
 	@$(call print, "Checking migration version.")
 	./scripts/check-migration-latest-version.sh
 

scripts/check-migration-numbering.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+# The directory containing migration files.
+migrations_path="tapdb/sqlc/migrations"
+
+# Check if the directory exists
+if [ ! -d "$migrations_path" ]; then
+  echo "Directory $migrations_path does not exist."
+  exit 1
+fi
+
+# Get all unique prefixes (e.g., 000001, always 6 digits) from .up.sql files.
+prefixes=($(ls "$migrations_path"/*.up.sql 2>/dev/null | \
+    sed -E 's/.*\/([0-9]{6})_.*\.up\.sql/\1/' | sort))
+
+# Check if no prefixes were found.
+if [ ${#prefixes[@]} -eq 0 ]; then
+  echo "No .up.sql migration files found in $migrations_path."
+  exit 1
+fi
+
+# Iterate over prefixes to ensure that there are no gaps and that each prefix
+# has a corresponding .down.sql file. Because the prefixes are sorted, and the
+# index starts at 0, we expect each prefix to be the index plus one.
+for i in "${!prefixes[@]}"; do
+  expected_prefix=$(printf "%06d" $((i+1)))
+
+  if [ "${prefixes[$i]}" != "$expected_prefix" ]; then
+    echo "Error: Missing migration with prefix $expected_prefix."
+    exit 1
+  fi
+
+  # Find the corresponding .down.sql file.
+  base_filename=$(ls "$migrations_path/${prefixes[$i]}"_*.up.sql | \
+      sed -E 's/\.up\.sql//')
+
+  if [ ! -f "$base_filename.down.sql" ]; then
+    echo "Error: Missing .down.sql file for migration $expected_prefix."
+    exit 1
+  fi
+done
+
+echo "All migration files are present and properly numbered."