feat: download the qgis_setup.sh to run plugin tests

.github/workflows/build_docker_images.yml

@@ -93,6 +93,19 @@ jobs:
           DOCKER_VERSION=$(echo "${DOCKER}" | jq ".${{ matrix.version }}")
           QGIS_VERSION=$(echo "${QGIS}" | jq ".${{ matrix.version }}")
 
+          QGIS_REF="NA"
+          TEST_URL="refs/heads"
+          if ! [[ "$QGIS_VERSION" == "master" || ]]; then
+            QGIS_REF=master
+          elif [[ "$QGIS_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            QGIS_REF="final-${QGIS_VERSION//./_}"
+            TEST_URL="refs/tags"
+          fi
+          if ! wget -q --spider https://api.github.com/repos/qgis/QGIS/git/${TEST_URL}/${QGIS_REF}; then
+            echo "Invalid git ref '${QGIS_REF}' for version '${QGIS_VERSION}'"
+            exit 1
+          fi
+
           echo "Existing ${{ matrix.version }} docker: ${DOCKER_VERSION}"
           echo "Available ${{ matrix.version }} QGIS: ${QGIS_VERSION}"
 
@@ -111,6 +124,7 @@ jobs:
 
           echo "will_update=${WILL_UPDATE}" >> $GITHUB_OUTPUT
           echo "qgis_version=${QGIS_VERSION//\"/}">> $GITHUB_OUTPUT
+          echo "qgis_ref=${QGIS_REF}" >> $GITHUB_OUTPUT
 
       - name: Set up QEMU
         if: ${{ steps.determine.outputs.will_update == 1 }}
@@ -136,4 +150,4 @@ jobs:
         env:
           DOCKER_USERNAME: ${{ secrets.docker_username }}
           DOCKER_PASSWORD: ${{ secrets.docker_password }}
-        run: ./scripts/build-push-docker.sh ${{ matrix.qgis_type }} ${{ matrix.version }} ${{steps.determine.outputs.qgis_version}} ${{ matrix.platform.os }} ${{ matrix.platform.release }} ${DEFAULT_UBUNTU_RELEASE}
+        run: ./scripts/build-push-docker.sh ${{ matrix.qgis_type }} ${{ matrix.version }} ${{steps.determine.outputs.qgis_version}} ${{ matrix.platform.os }} ${{ matrix.platform.release }} ${DEFAULT_UBUNTU_RELEASE} ${{ steps.determine.outputs.qgis_ref }}

README.md

@@ -6,7 +6,7 @@ This repository automates the build of QGIS desktop and QGIS server Docker image
 
 [![Docker Hub](https://img.shields.io/docker/pulls/qgis/qgis)](https://hub.docker.com/r/qgis/qgis)
 
-- [Documentation](./desktop/README.md)
+- [Documentation](./desktop/README.md), including instructions to test QGIS plugins
 
 ## Server
 

desktop/Dockerfile

@@ -4,10 +4,8 @@ ARG release=noble
 FROM ${os}:${release}
 LABEL maintainer="OPENGIS.ch <info@opengis.ch>"
 
-ARG os
 ARG release
 ARG repo
-ARG qgis_version=master
 
 RUN apt update && apt install -y gnupg wget software-properties-common && \
     wget -qO - https://qgis.org/downloads/qgis-2022.gpg.key | gpg --no-default-keyring --keyring gnupg-ring:/etc/apt/trusted.gpg.d/qgis-archive.gpg --import && \
@@ -20,6 +18,12 @@ RUN apt update && apt install -y gnupg wget software-properties-common && \
       python3-pytest python3-mock xvfb qttools5-dev-tools pyqt5-dev-tools && \
     apt-get clean
 
-# Test version
+# Test version and download plugin test scripts
 COPY scripts/check_version.sh /opt/check_version.sh
+COPY scripts/qgis_test_setup.sh /opt/qgis_test_setup.sh
+
+ARG qgis_version=master
+ARG qgis_ref
+
 RUN /opt/check_version.sh ${qgis_version}
+RUN /opt/qgis_test_setup.sh ${qgis_ref}

desktop/README.md

@@ -3,3 +3,25 @@
 [![Docker Hub](https://img.shields.io/docker/pulls/qgis/qgis)](https://hub.docker.com/r/qgis/qgis)
 
 A simple QGIS desktop Docker image, pushed on [Docker Hub](https://hub.docker.com/r/qgis/qgis).
+
+## Python Plugin testing
+
+This image can be used to set up a testing environment for plugins, e.g.
+
+```
+PLUGIN_DIR=<plugin_name> # e.g. PLUGIN_NAME=valhalla
+
+# it's important to map the plugin's root to /tests_directory and that $PLUGIN_DIR is the sub-directory containing the plugin sources
+docker run -dt --name qgis -v ${PWD}:/tests_directory -e QT_QPA_PLATFORM="offscreen" qgis/qgis:latest
+
+# run the qgis_setup.sh script and then your tests, e.g.
+docker exec qgis bash -c "qgis_setup.sh ${PLUGIN_DIR}"
+
+# now you can run whatever you need
+docker exec qgis bash -c "apt-get update && apt-get install -y pre-commit python3-coverage"
+docker exec qgis bash -c "git config --global --add safe.directory /tests_directory"
+docker exec qgis bash -c "cd /tests_directory && pre-commit run --all-files"
+docker exec qgis bash -c "cd /tests_directory && python3 -m coverage run -m unittest discover"
+docker exec qgis bash -c "cd /tests_directory && python3 -m coverage report"
+docker exec qgis bash -c "cd /tests_directory && python3 -m coverage report"
+```

scripts/build-push-docker.sh

@@ -8,6 +8,7 @@ QGIS_VERSION=$3
 OS=$4
 OS_RELEASE=$5
 DEFAULT_OS_RELEASE=$6
+QGIS_REF=$7
 
 MAJOR_QGIS_VERSION=$(echo "${QGIS_VERSION}" | cut -d. -f1,2)
 
@@ -50,4 +51,5 @@ docker buildx build --push --platform linux/amd64 \
                --build-arg release=${OS_RELEASE} \
                --build-arg repo=${QGIS_PPA} \
                --build-arg qgis_version=${QGIS_VERSION} \
+               --build-arg qgis_ref=${QGIS_REF} \
                ${ALL_TAGS} -f ${QGIS_TYPE}/Dockerfile .

scripts/qgis_test_setup.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+# Makes the qgis_setup.sh script available for plugin testing
+
+# Usage: qgis_test_setup.sh <docker_tag> <plugin_name>, e.g. ./qgis_test_setup.sh 3.44.1
+
+set -euo pipefail
+
+# Check if version argument is provided
+if [[ -z "$1" ]]; then
+  echo "Usage: $0 <QGIS git ref, e.g. final-3_44_1 or master>"
+  exit 1
+fi
+
+# Convert docker version to branch name
+QGIS_REF="$1"
+
+SETUP_SCRIPT_URL="https://raw.githubusercontent.com/qgis/QGIS/${QGIS_REF}/.docker/qgis_resources/test_runner/qgis_setup.sh"
+SETUP_SCRIPT_PATH="/usr/bin/$(basename ${SETUP_SCRIPT_URL})"
+
+STARTUP_SCRIPT_URL="https://raw.githubusercontent.com/qgis/QGIS/${QGIS_REF}/.docker/qgis_resources/test_runner/qgis_startup.py"
+STARTUP_SCRIPT_PATH="/usr/bin/$(basename ${STARTUP_SCRIPT_URL})"
+
+echo "Downloading qgis_setup.sh and friends from ref ${QGIS_REF}..."
+
+wget -q -O "$SETUP_SCRIPT_PATH" "$SETUP_SCRIPT_URL"
+wget -q -O "$STARTUP_SCRIPT_PATH" "$STARTUP_SCRIPT_URL"
+
+chmod +x "$SETUP_SCRIPT_PATH"
+chmod +x "$STARTUP_SCRIPT_PATH"