Merge pull request #2 from eduralph/feature/ci-cd-pipeline

Consolidate CI images and fix Windows + integration tests

Author: eduralph

.github/docker/gramps-ci/Dockerfile

@@ -0,0 +1,54 @@
+# .github/docker/gramps-ci/Dockerfile
+#
+# Unified Gramps 6.0 CI image. Includes everything jobs need:
+#   - Python + pip-installed Gramps, PyGObject, pycairo
+#   - GTK typelibs (so addon modules that `from gi.repository import Gtk`
+#     at module load time are importable — widgets still need xvfb to render)
+#   - intltool/gettext/git for make.py builds
+#   - ruff, pytest, dbf for lint/test tooling
+#   - xvfb + xauth for tests that actually render (wrap with `xvfb-run`)
+#
+# No display server runs by default — the image is headless unless a command
+# explicitly invokes `xvfb-run`. When running with docker locally, pass
+# `--init` (or use a container runtime that injects tini) because xvfb-run
+# hangs if it inherits PID 1.
+#
+ARG PYTHON_VERSION=3.12
+FROM python:${PYTHON_VERSION}-slim
+
+LABEL org.opencontainers.image.source="https://github.com/gramps-project/addons-source"
+LABEL org.opencontainers.image.description="Unified Gramps 6.0 CI image (Python, Gramps, GTK typelibs, xvfb)"
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+        libgirepository-2.0-dev \
+        gir1.2-glib-2.0 \
+        gir1.2-gtk-3.0 \
+        gir1.2-pango-1.0 \
+        gir1.2-gdkpixbuf-2.0 \
+        gir1.2-atk-1.0 \
+        gcc \
+        pkg-config \
+        python3-dev \
+        libcairo2-dev \
+        intltool \
+        gettext \
+        git \
+        xvfb \
+        xauth \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN pip install --no-cache-dir \
+        PyGObject \
+        pycairo \
+        "gramps>=6.0,<6.1" \
+        orjson \
+        pytest \
+        ruff \
+        dbf
+
+RUN apt-get purge -y gcc python3-dev pkg-config && apt-get autoremove -y
+
+RUN python -c "from gramps.gen.const import VERSION; print('Gramps', VERSION)" \
+ && python -c "import gi; gi.require_version('Gtk', '3.0'); from gi.repository import Gtk; print('GTK OK')"
+
+WORKDIR /workspace

.github/docker/gramps-gtk/Dockerfile

@@ -7,18 +7,17 @@ on:
     branches: [maintenance/gramps60]
 
 env:
-  HEADLESS_IMAGE: ghcr.io/${{ github.repository }}/gramps-headless:gramps60
-  GTK_IMAGE: ghcr.io/${{ github.repository }}/gramps-gtk:gramps60
+  CI_IMAGE: ghcr.io/${{ github.repository }}/gramps-ci:gramps60
 
 jobs:
   # -----------------------------------------------------------------
-  # Lint (headless container)
+  # Lint (ci container)
   # -----------------------------------------------------------------
   lint:
     name: Lint
     runs-on: ubuntu-latest
     container:
-      image: ghcr.io/${{ github.repository }}/gramps-headless:gramps60
+      image: ghcr.io/${{ github.repository }}/gramps-ci:gramps60
     steps:
       - uses: actions/checkout@v4
 
@@ -60,13 +59,13 @@ jobs:
           exit $failed
 
   # -----------------------------------------------------------------
-  # Compile check (headless container)
+  # Compile check (ci container)
   # -----------------------------------------------------------------
   compile-check:
     name: Compile Check
     runs-on: ubuntu-latest
     container:
-      image: ghcr.io/${{ github.repository }}/gramps-headless:gramps60
+      image: ghcr.io/${{ github.repository }}/gramps-ci:gramps60
     steps:
       - uses: actions/checkout@v4
 
@@ -81,13 +80,13 @@ jobs:
           exit $failed
 
   # -----------------------------------------------------------------
-  # Unit tests — Linux (headless container)
+  # Unit tests — Linux (ci container)
   # -----------------------------------------------------------------
   unit-test-linux:
     name: Unit Tests (Linux)
     runs-on: ubuntu-latest
     container:
-      image: ghcr.io/${{ github.repository }}/gramps-headless:gramps60
+      image: ghcr.io/${{ github.repository }}/gramps-ci:gramps60
     steps:
       - uses: actions/checkout@v4
 
@@ -101,71 +100,69 @@ jobs:
               test_dirs="$test_dirs $d"
             fi
           done
-          for f in */test_*.py; do
-            if [ -f "$f" ]; then
-              test_dirs="$test_dirs $(dirname "$f")"
-            fi
-          done
           if [ -n "$test_dirs" ]; then
             echo "Running unit tests in: $test_dirs"
             python3 -m pytest $test_dirs -v --tb=short \
               --ignore-glob='**/test_integration*.py' \
+              --ignore=Sqlite/tests/test_sqlite.py \
               -m 'not gui'
           else
             echo "No per-addon unit test files found"
           fi
 
   # -----------------------------------------------------------------
-  # Unit tests — Windows (bare runner, pip install)
+  # Unit tests — Windows (conda-forge: bundles PyGObject + GTK + Gramps)
   # -----------------------------------------------------------------
   unit-test-windows:
     name: Unit Tests (Windows)
     runs-on: windows-latest
+    defaults:
+      run:
+        shell: bash -el {0}
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python
-        uses: actions/setup-python@v5
+      - name: Set up Miniforge
+        uses: conda-incubator/setup-miniconda@v3
         with:
+          miniforge-version: latest
           python-version: "3.12"
+          activate-environment: addons-ci
+          channels: conda-forge
 
-      - name: Install dependencies
-        run: pip install gramps orjson pytest dbf
+      - name: Install Gramps + test deps
+        run: mamba install -y "gramps>=6.0,<6.1" pygobject gtk3 orjson pytest dbf
 
       - name: Run per-addon unit tests
         env:
           PYTHONPATH: .
-        shell: bash
         run: |
           test_dirs=""
           for d in */tests/; do
             if ls "$d"/test_*.py 1>/dev/null 2>&1; then
               test_dirs="$test_dirs $d"
             fi
           done
-          for f in */test_*.py; do
-            if [ -f "$f" ]; then
-              test_dirs="$test_dirs $(dirname "$f")"
-            fi
-          done
           if [ -n "$test_dirs" ]; then
             echo "Running unit tests in: $test_dirs"
             python -m pytest $test_dirs -v --tb=short \
               --ignore-glob='**/test_integration*.py' \
+              --ignore=Sqlite/tests/test_sqlite.py \
               -m 'not gui'
           else
             echo "No per-addon unit test files found"
           fi
 
   # -----------------------------------------------------------------
-  # Integration tests — Gramps (GTK container)
+  # Integration tests — Gramps (ci container, xvfb available)
   # -----------------------------------------------------------------
   integration-test:
     name: Integration Tests (Gramps)
     runs-on: ubuntu-latest
     needs: [unit-test-linux]
     container:
-      image: ghcr.io/${{ github.repository }}/gramps-gtk:gramps60
+      image: ghcr.io/${{ github.repository }}/gramps-ci:gramps60
+      options: --init
     steps:
       - uses: actions/checkout@v4
         with:
@@ -174,7 +171,7 @@ jobs:
       - name: Run plugin registration tests
         env:
           PYTHONPATH: .
-        run: xvfb-run python3 -m pytest tests/ -v --tb=short
+        run: python3 -m pytest tests/ -v --tb=short
 
       - name: Run per-addon integration tests
         env:
@@ -188,19 +185,19 @@ jobs:
           done
           if [ -n "$integration_tests" ]; then
             echo "Running per-addon integration tests: $integration_tests"
-            xvfb-run python3 -m pytest $integration_tests -v --tb=short
+            python3 -m pytest $integration_tests -v --tb=short
           else
             echo "No per-addon integration test files found"
           fi
 
   # -----------------------------------------------------------------
-  # Build (headless container — has intltool/gettext)
+  # Build (ci container)
   # -----------------------------------------------------------------
   build:
     name: Build
     runs-on: ubuntu-latest
     container:
-      image: ghcr.io/${{ github.repository }}/gramps-headless:gramps60
+      image: ghcr.io/${{ github.repository }}/gramps-ci:gramps60
     steps:
       - uses: actions/checkout@v4
 

.github/docker/gramps-headless/Dockerfile

@@ -16,8 +16,8 @@ permissions:
   packages: write
 
 jobs:
-  build-headless:
-    name: Build gramps-headless
+  build-ci:
+    name: Build gramps-ci
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -36,55 +36,17 @@ jobs:
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: ${{ env.REGISTRY }}/${{ env.REPO }}/gramps-headless
+          images: ${{ env.REGISTRY }}/${{ env.REPO }}/gramps-ci
           tags: |
             type=raw,value=gramps60
             type=sha,prefix=gramps60-
 
-      - name: Build and push gramps-headless
+      - name: Build and push gramps-ci
         uses: docker/build-push-action@v6
         with:
-          context: .github/docker/gramps-headless
+          context: .github/docker/gramps-ci
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           cache-from: type=gha
           cache-to: type=gha,mode=max
-
-  build-gtk:
-    name: Build gramps-gtk
-    runs-on: ubuntu-latest
-    needs: [build-headless]
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Log in to GHCR
-        uses: docker/login-action@v3
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Docker metadata
-        id: meta
-        uses: docker/metadata-action@v5
-        with:
-          images: ${{ env.REGISTRY }}/${{ env.REPO }}/gramps-gtk
-          tags: |
-            type=raw,value=gramps60
-            type=sha,prefix=gramps60-
-
-      - name: Build and push gramps-gtk
-        uses: docker/build-push-action@v6
-        with:
-          context: .github/docker/gramps-gtk
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-          build-args: |
-            BASE_IMAGE=${{ env.REGISTRY }}/${{ env.REPO }}/gramps-headless:gramps60

.github/workflows/ci.yml

@@ -2,6 +2,9 @@
 *.py[cod]
 __pycache__
 
+# Gramps runtime logs
+debug.log
+
 # Editing
 *~
 tags