Attempt to use Docker for ImageMagick in CI

Author: Pierstoval

.github/workflows/php.yml

@@ -18,18 +18,6 @@ jobs:
         steps:
             - uses: actions/checkout@v2
 
-            - name: Install ImageMagick
-              run: |
-                  sudo apt-get update
-                  sudo apt-get upgrade -y libjpeg-dev libpng-dev libgif-dev make wget
-                  wget https://www.imagemagick.org/download/ImageMagick.tar.gz
-                  tar xvzf ImageMagick.tar.gz
-                  cd ImageMagick-*
-                  ./configure
-                  make
-                  sudo make install
-                  sudo ldconfig /usr/local/lib
-
             - uses: shivammathur/setup-php@v2
               with:
                   php-version: "${{ matrix.php-version }}"
@@ -46,8 +34,10 @@ jobs:
                   key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
                   restore-keys: ${{ runner.os }}-composer-
 
-            - run: composer install
+            - name: Setup
+              run: |
+                  make install
 
-            - run: |
-                # export IMAGEMAGICK_PATH="docker run --rm --volume `pwd`:`pwd` --workdir=`pwd` --entrypoint="`pwd`/docker_entrypoint.sh" --user=$UID:$GID dpokidov/imagemagick:latest magick"
-                vendor/bin/phpunit
+            - name: Test
+              run: |
+                  make test

Makefile

@@ -0,0 +1,49 @@
+SHELL := /bin/bash
+
+IMAGEMAGICK_DOCKER_IMAGE = orbitale-imphp
+
+# Helper vars
+_TITLE := "\033[32m[%s]\033[0m %s\n"
+_ERROR := "\033[31m[%s]\033[0m %s\n"
+
+.DEFAULT_GOAL := help
+help: ## Show this help.
+	@printf "\n Available commands:\n\n"
+	@grep -E '(^[a-zA-Z_-]+:.*?##.*$$)|(^##)' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-25s\033[0m %s\n", $$1, $$2}' | sed -e 's/\[32m## */[33m/'
+.PHONY: help
+
+install: vendor imagemagick-docker ## Install composer dependencies and Docker image for testing
+.PHONY: install
+
+start: ## Start Docker image for testing
+	@docker start $(IMAGEMAGICK_DOCKER_IMAGE)
+.PHONY: start
+
+stop: ## Stop testing Docker image
+	@docker stop $(IMAGEMAGICK_DOCKER_IMAGE)
+.PHONY: stop
+
+test: start ## Start Docker image for testing
+	export IMAGEMAGICK_PATH="docker exec $(IMAGEMAGICK_DOCKER_IMAGE) `pwd`/docker_entrypoint.sh magick" && \
+	vendor/bin/phpunit
+	$(MAKE) stop
+.PHONY: test
+
+vendor:
+	@printf $(_TITLE) "Install" "Installing Composer dependencies"
+	@composer update
+.PHONY: vendor
+
+imagemagick-docker:
+	@printf $(_TITLE) "Install" "Removing existing Docker image"
+	@docker rm --force --volumes $(IMAGEMAGICK_DOCKER_IMAGE)
+	@printf $(_TITLE) "Install" "Creating ImageMagick Docker image for development"
+	@docker create \
+		--name=$(IMAGEMAGICK_DOCKER_IMAGE) \
+		--volume `pwd`:`pwd` \
+		--workdir=`pwd` \
+		--entrypoint="`pwd`/docker_entrypoint.sh" \
+		dpokidov/imagemagick:latest \
+		sleep 99999 \
+		>/dev/null
+.PHONY: imagemagick-docker

Tests/CommandTest.php

@@ -23,25 +23,18 @@ class CommandTest extends AbstractTestCase
      */
     public function testWrongConvertDirs($path, $expectedMessage, $expectedException): void
     {
-        $exception = '';
-        $exceptionClass = '';
-
         $path = \str_replace('\\', '/', $path);
         $expectedMessage = \str_replace('\\', '/', $expectedMessage);
-        try {
-            new Command($path);
-        } catch (\Exception $e) {
-            $exception = $e->getMessage();
-            $exceptionClass = \get_class($e);
-        }
-        static::assertStringContainsString($expectedMessage, $exception);
-        static::assertEquals($expectedException, $exceptionClass);
+        $this->expectExceptionMessage($expectedMessage);
+        $this->expectException($expectedException);
+
+        new Command($path);
     }
 
     public function provideWrongConvertDirs(): ?\Generator
     {
-        yield ['/this/is/a/dummy/dir', 'The specified path (/this/is/a/dummy/dir) is not a file.', MagickBinaryNotFoundException::class];
-        yield ['./', 'The specified path (.) is not a file.', MagickBinaryNotFoundException::class];
+        yield ['/this/is/a/dummy/dir', "ImageMagick does not seem to work well, the test command resulted in an error.\nExecution returned message: \"Command not found\"\nTo solve this issue, please run this command and check your error messages to see if ImageMagick was correctly installed:\n/this/is/a/dummy/dir -version", MagickBinaryNotFoundException::class];
+        yield ['./', "The specified path (\"ImageMagick does not seem to work well, the test command resulted in an error.\nExecution returned message: \"Misuse of shell builtins\"\nTo solve this issue, please run this command and check your error messages to see if ImageMagick was correctly installed:\n. -version\") is not a file.\nYou must set the \"magickBinaryPath\" parameter as the main \"magick\" binary installed by ImageMagick.", MagickBinaryNotFoundException::class];
     }
 
     /**

docker_entrypoint.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+"$@"

src/Command.php

@@ -85,11 +85,11 @@ public function __construct(?string $magickBinaryPath = '')
         try {
             $code = $process->run();
         } catch (\Throwable $e) {
-            throw new \RuntimeException('Could not check ImageMagick version', 1, $e);
+            throw new MagickBinaryNotFoundException('Could not check ImageMagick version', 1, $e);
         }
 
         if (0 !== $code || !$process->isSuccessful()) {
-            throw new \InvalidArgumentException(\sprintf("ImageMagick does not seem to work well, the test command resulted in an error.\n"."Execution returned message: \"{$process->getExitCodeText()}\"\n"."To solve this issue, please run this command and check your error messages to see if ImageMagick was correctly installed:\n%s", $magickBinaryPath.' -version'));
+            throw new MagickBinaryNotFoundException(\sprintf("ImageMagick does not seem to work well, the test command resulted in an error.\n"."Execution returned message: \"{$process->getExitCodeText()}\"\n"."To solve this issue, please run this command and check your error messages to see if ImageMagick was correctly installed:\n%s", $magickBinaryPath.' -version'));
         }
 
         $this->ref = new References();
@@ -272,6 +272,13 @@ public function run(): CommandResponse
             }
         });
 
+        if ($code !== 0) {
+            echo "\n>>> Command-line: « {$process->getCommandLine()} » \n";
+            echo "\n>>> Output:\n>{$output}\n";
+            echo "\n>>> Error:\n>{$error}\n";
+        }
+
+
         return new CommandResponse($process, $code, $output, $error);
     }