From 627857af92fc19f885faac775883aa2ce9f6bbcf Mon Sep 17 00:00:00 2001
From: undergroundwires <git@undergroundwires.dev>
Date: Fri, 11 Oct 2024 22:56:08 +0200
Subject: [PATCH] Fix CI/CD fail by installing ImageMagick on runner

This commit addresses an issue where CI/CD jobs fail due to the removal of
`imagemagick` from GitHub's preinstalled software list for Ubuntu
runners. As a result, commands relying on `imagemagick` were not found.

To resolve this, the commit installs `imagemagick` across all platforms
(Linux, macOS, and Windows). This safeguards against future changes to
the preinstalled software list on GitHub runners.

This commit also centralizes installing of ImageMagick as its own action
for reusability.
---
 .../actions/install-imagemagick/action.yml    | 12 ++++
 .../install-imagemagick.sh                    | 56 +++++++++++++++++++
 .../checks.desktop-runtime-errors.yaml        |  6 +-
 .github/workflows/checks.scripts.yaml         |  7 +--
 4 files changed, 74 insertions(+), 7 deletions(-)
 create mode 100644 .github/actions/install-imagemagick/action.yml
 create mode 100755 .github/actions/install-imagemagick/install-imagemagick.sh

diff --git a/.github/actions/install-imagemagick/action.yml b/.github/actions/install-imagemagick/action.yml
new file mode 100644
index 00000000..808f7964
--- /dev/null
+++ b/.github/actions/install-imagemagick/action.yml
@@ -0,0 +1,12 @@
+inputs:
+  project-root:
+    required: false
+    default: '.'
+runs:
+  using: composite
+  steps:
+    -
+      name: Install ImageMagick
+      shell: bash
+      run: ./.github/actions/install-imagemagick/install-imagemagick.sh
+      working-directory: ${{ inputs.project-root }}
diff --git a/.github/actions/install-imagemagick/install-imagemagick.sh b/.github/actions/install-imagemagick/install-imagemagick.sh
new file mode 100755
index 00000000..b55b88d1
--- /dev/null
+++ b/.github/actions/install-imagemagick/install-imagemagick.sh
@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+main() {
+  local command
+  if ! command=$(get_install_command); then
+    fatal_error 'Could not find available command to install'
+  fi
+  if ! $command; then
+    echo "Failed to install ImageMagick. Command: ${command}"
+    exit 1
+  fi
+  echo 'ImageMagick installation completed successfully'
+}
+
+get_install_command() {
+  case "$OSTYPE" in
+    darwin*)
+      ensure_command_exists 'brew'
+      echo 'brew install imagemagick'
+      ;;
+    linux-gnu*)
+      if is_ubuntu; then
+        ensure_command_exists 'apt'
+        echo 'sudo apt install -y imagemagick'
+      else
+        fatal_error 'Unsupported Linux distribution'
+      fi
+      ;;
+    msys*|cygwin*)
+      ensure_command_exists 'choco'
+      echo 'choco install -y imagemagick'
+      ;;
+    *)
+      fatal_error "Unsupported operating system: $OSTYPE"
+      ;;
+  esac
+}
+
+ensure_command_exists() {
+  local -r command="$1"
+  if ! command -v "$command" >/dev/null 2>&1; then
+    fatal_error 'Command missing: brew'
+  fi
+}
+
+fatal_error() {
+  local -r error_message="$1"
+  >&2 echo "❌ $error_message"
+  exit 1
+}
+
+is_ubuntu() {
+  [ -f /etc/lsb-release ] && grep -q 'Ubuntu' /etc/lsb-release
+}
+
+main
diff --git a/.github/workflows/checks.desktop-runtime-errors.yaml b/.github/workflows/checks.desktop-runtime-errors.yaml
index 6a01a277..1c5a924e 100644
--- a/.github/workflows/checks.desktop-runtime-errors.yaml
+++ b/.github/workflows/checks.desktop-runtime-errors.yaml
@@ -26,6 +26,9 @@ jobs:
       -
         name: Install dependencies
         uses: ./.github/actions/npm-install-dependencies
+      -
+        name: Install ImageMagick # For screenshots
+        uses: ./.github/actions/install-imagemagick
       -
         name: Configure Ubuntu
         if: contains(matrix.os, 'ubuntu') # macOS runner is missing Docker
@@ -56,9 +59,6 @@ jobs:
           sudo Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
           echo "DISPLAY=:99" >> $GITHUB_ENV
 
-          # Install ImageMagick for screenshots
-          sudo apt install -y imagemagick
-
           # Install xdotool and xprop (from x11-utils) for window title capturing
           sudo apt install -y xdotool x11-utils
       -
diff --git a/.github/workflows/checks.scripts.yaml b/.github/workflows/checks.scripts.yaml
index 45cd425c..816b4d96 100644
--- a/.github/workflows/checks.scripts.yaml
+++ b/.github/workflows/checks.scripts.yaml
@@ -9,16 +9,15 @@ jobs:
     runs-on: ${{ matrix.os }}-latest
     strategy:
       matrix:
-        os: [ macos, ubuntu, windows ]
+        os: [macos, ubuntu, windows]
       fail-fast: false # Still interested to see results from other combinations
     steps:
       -
         name: Checkout
         uses: actions/checkout@v4
       -
-        name: Install ImageMagick on macOS
-        if: matrix.os == 'macos'
-        run: brew install imagemagick
+        name: Install ImageMagick
+        uses: ./.github/actions/install-imagemagick
       -
         name: Setup node
         uses: ./.github/actions/setup-node