feat: pg-diff md report generation

Author: RuslanSibgatulin

.github/workflows/ci-cd.yml

@@ -0,0 +1,33 @@
+name: CI/CD
+
+on: [push]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME_CACHE: ghcr.io/${{ github.repository }}:_buildcache
+
+jobs:
+  build-image:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build Docker image
+        uses: docker/build-push-action@v4
+        with:
+          tags: ghcr.io/${{ github.repository }}:latest
+          push: true
+          # platforms: linux/arm64,linux/amd64
+          cache-from: type=registry,ref=${{ env.IMAGE_NAME_CACHE }}
+          cache-to: type=registry,ref=${{ env.IMAGE_NAME_CACHE }},mode=max

Dockerfile

@@ -0,0 +1,20 @@
+FROM python:3.12.9-slim
+
+WORKDIR /app
+
+# Download liquibase package and extract to WORKDIR
+RUN apt-get update  \
+  && apt-get install -y --no-install-recommends \
+  curl=7.* \
+  unzip=6.* \
+  openjdk-17-jre-headless \
+  && curl -o liquibase.zip -SL https://github.com/liquibase/liquibase/releases/download/v4.31.0/liquibase-4.31.0.zip \
+  && unzip liquibase.zip -d liquibase \
+  && rm liquibase.zip
+    
+COPY pg_diff.sh .
+COPY pg_diff.py .
+
+RUN ["chmod", "+x", "pg_diff.sh"]
+
+CMD "./pg_diff.sh"

pg_diff.py

@@ -0,0 +1,86 @@
+import enum
+import re
+import sys
+
+
+class DBChanges(enum.StrEnum):
+    ColumnAdded = "column added"
+    ColumnDeleted = "column deleted"
+    ColumnChanged = "column changed"
+    TableAdded = "table added"
+    TableDeleted = "table deleted"
+    TableChanged = "table changed"
+
+
+TOC = {
+    "Missing Column(s)": DBChanges.ColumnAdded,
+    "Unexpected Column(s)": DBChanges.ColumnDeleted,
+    "Changed Column(s)": DBChanges.ColumnChanged,
+    "Missing Table(s)": DBChanges.TableAdded,
+    "Unexpected Table(s)": DBChanges.TableDeleted,
+    "Changed Table(s)": DBChanges.TableChanged,
+}
+
+HEADING_PATTERN = r"(\w+.\w+\(s\)):"
+COLUMN_PATTERN = r"^\s{5}public.(\w+).(\w+)"
+TABLE_PATTERN = r"^\s{5}(\w+)"
+
+
+current_type = None
+columns_changes = {}
+tables_changes = {}
+
+for line in sys.stdin.readlines():
+    heading = re.match(HEADING_PATTERN, line)
+    if heading:
+        current_type = TOC.get(heading.group(1))
+    elif current_type in {
+        DBChanges.ColumnAdded,
+        DBChanges.ColumnDeleted,
+        DBChanges.ColumnChanged,
+    }:
+        column_name = re.match(COLUMN_PATTERN, line)
+        columns_changes.setdefault(current_type, {}).setdefault(
+            column_name.group(1),
+            [],
+        ).append(column_name.group(2))
+    else:
+        table_name = re.match(TABLE_PATTERN, line)
+        if table_name:
+            tables_changes.setdefault(
+                current_type,
+                [],
+            ).append(table_name.group(1))
+
+sys.stdout.write("*" * 100 + "\n")
+sys.stdout.write(" " * 42 + "DB changes report\n")
+sys.stdout.write("*" * 100 + "\n\n")
+
+ignore_tables = set()
+for change_type, tables in tables_changes.items():
+    ignore_tables.update(tables)
+    sys.stdout.writelines(
+        [
+            "- {0} `{1}`\n".format(
+                change_type.value,
+                table,
+            )
+            for table in tables
+        ],
+    )
+
+for change_type, tables in columns_changes.items():
+    for table, columns in tables.items():
+        if table in ignore_tables:
+            continue
+
+        sys.stdout.writelines(
+            [
+                "- {0} `{1}` table `{2}`\n".format(
+                    change_type.value,
+                    column,
+                    table,
+                )
+                for column in columns
+            ],
+        )

pg_diff.sh

@@ -0,0 +1,10 @@
+POSTGRES_SCHEMA=public
+
+./liquibase/liquibase --show-banner=false \
+--url=$POSTGRES_TARGET_DB \
+--diffTypes=tables,columns \
+--defaultSchemaName=$POSTGRES_SCHEMA \
+diff \
+--referenceUrl=$POSTGRES_CURRENT_DB \
+--schemas=$POSTGRES_SCHEMA \
+| python pg_diff.py

readme.md

@@ -0,0 +1,15 @@
+# Postgres DB diff report
+
+## ENV variables
+
+- `POSTGRES_TARGET_DB` - most updated DB state (ex: development DB)
+- `POSTGRES_CURRENT_DB` - outdated DB state (ex: PROD DB before release)
+
+## Get report
+
+```bash
+docker run --rm -it \
+-e "POSTGRES_TARGET_DB=jdbc:postgresql://postgres:5432/db-name?user=pg_user&password=secret" \
+-e "POSTGRES_CURRENT_DB=jdbc:postgresql://postgres:5432/db-name?user=pg_user&password=secret" \
+--network=pg-network pg-diff:latest
+```