test: use specific snapshot matchers to avoid platform discrepancies

Author: DASPRiD

.github/workflows/ci.yml

@@ -36,6 +36,11 @@ jobs:
           extensions: iconv, imagick, gd
           coverage: xdebug
 
+      - name: Setup Node
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+
       - name: Get composer cache directory
         id: composer-cache
         run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
@@ -47,9 +52,12 @@ jobs:
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
           restore-keys: ${{ runner.os }}-composer-
 
-      - name: Install dependencies
+      - name: Install PHP dependencies
         run: composer install --no-progress --prefer-dist --optimize-autoloader
 
+      - name: Install Node dependencies
+        run: npm install
+
       - name: Test with phpunit
         run: vendor/bin/phpunit --coverage-clover clover.xml
 
@@ -58,7 +66,7 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: ./clover.xml
-          
+
   release:
     needs: [lint, test]
     runs-on: ubuntu-latest

.github/workflows/pull-request.yml

@@ -24,7 +24,7 @@ jobs:
     strategy:
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: ['8.1', '8.2', '8.3']
+        php-versions: ['8.1', '8.2', '8.3', '8.4']
     runs-on: ${{ matrix.operating-system }}
     steps:
       - uses: actions/checkout@v4
@@ -36,6 +36,11 @@ jobs:
           extensions: iconv, imagick
           coverage: xdebug
 
+      - name: Setup Node
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+
       - name: Get composer cache directory
         id: composer-cache
         run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
@@ -47,9 +52,12 @@ jobs:
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
           restore-keys: ${{ runner.os }}-composer-
 
-      - name: Install dependencies
+      - name: Install PHP dependencies
         run: composer install --no-progress --prefer-dist --optimize-autoloader
 
+      - name: Install Node dependencies
+        run: npm install
+
       - name: Test with phpunit
         run: vendor/bin/phpunit --coverage-clover clover.xml
 

.gitignore

@@ -1,4 +1,5 @@
 /composer.lock
 /vendor
+/node_modules
 /.phpunit.result.cache
 /.phpunit.cache

Dockerfile

@@ -1,4 +1,4 @@
-Copyright (c) 2017, Ben Scholzen 'DASPRiD'
+Copyright (c) 2017-present, Ben Scholzen 'DASPRiD'
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

LICENSE

@@ -55,3 +55,8 @@ $renderer = new GDLibRenderer(400);
 $writer = new Writer($renderer);
 $writer->writeFile('Hello World!', 'qrcode.png');
 ```
+
+## Development
+
+To run unit tests, you need to have [Node.js](https://nodejs.org/en) and the pixelmatch library installed. Running
+`npm install` will install this for you.

README.md

@@ -32,6 +32,7 @@
     "require-dev": {
         "phpunit/phpunit": "^10.5.11 || ^11.0.4",
         "spatie/phpunit-snapshot-assertions": "^5.1.5",
+        "spatie/pixelmatch-php": "^1.2.0",
         "squizlabs/php_codesniffer": "^3.9",
         "phly/keep-a-changelog": "^2.12"
     },

composer.json

@@ -0,0 +1,7 @@
+{
+  "name": "baconqrcode",
+  "private": true,
+  "dependencies": {
+    "pixelmatch": "^7.1.0"
+  }
+}

package-lock.json

@@ -5,22 +5,14 @@
 namespace BaconQrCodeTest\Integration;
 
 use BaconQrCode\Exception\InvalidArgumentException;
-use BaconQrCode\Exception\RuntimeException;
 use BaconQrCode\Renderer\Color\Alpha;
 use BaconQrCode\Renderer\Color\Rgb;
-use BaconQrCode\Renderer\Eye\EyeInterface;
-use BaconQrCode\Renderer\Eye\SimpleCircleEye;
-use BaconQrCode\Renderer\Eye\SquareEye;
 use BaconQrCode\Renderer\GDLibRenderer;
-use BaconQrCode\Renderer\ImageRenderer;
 use BaconQrCode\Renderer\Image\GDImageBackEnd;
-use BaconQrCode\Renderer\Module\DotsModule;
-use BaconQrCode\Renderer\Module\RoundnessModule;
 use BaconQrCode\Renderer\RendererStyle\EyeFill;
 use BaconQrCode\Renderer\RendererStyle\Fill;
 use BaconQrCode\Renderer\RendererStyle\Gradient;
 use BaconQrCode\Renderer\RendererStyle\GradientType;
-use BaconQrCode\Renderer\RendererStyle\RendererStyle;
 use BaconQrCode\Writer;
 use PHPUnit\Framework\Attributes\Group;
 use PHPUnit\Framework\Attributes\RequiresPhpExtension;
@@ -40,7 +32,7 @@ public function testGenericQrCode(): void
         $tempName = tempnam(sys_get_temp_dir(), 'test') . '.png';
         $writer->writeFile('Hello World!', $tempName);
 
-        $this->assertMatchesFileSnapshot($tempName);
+        $this->assertMatchesImageSnapshot($tempName);
         unlink($tempName);
     }
 
@@ -64,7 +56,7 @@ public function testDifferentColorsQrCode(): void
         $tempName = tempnam(sys_get_temp_dir(), 'test') . '.png';
         $writer->writeFile('Hello World!', $tempName);
 
-        $this->assertMatchesFileSnapshot($tempName);
+        $this->assertMatchesImageSnapshot($tempName);
         unlink($tempName);
     }