Add test suite

.github/workflows/run-tests.yml

@@ -0,0 +1,47 @@
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  run-tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        php: [8.2, 8.3]
+        stability: [prefer-lowest, prefer-stable]
+
+    name: PHP ${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: curl, mbstring, imagick
+          coverage: none
+
+      - name: Install dependencies
+        run: composer update --${{ matrix.stability }} --prefer-dist --no-interaction
+
+      - name: Setup problem matchers
+        run: |
+          echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+          echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+      - name: Execute tests
+        run: |
+          npm install
+          vendor/bin/phpunit

.gitignore

@@ -1,3 +1,6 @@
 .DS_Store
 /vendor
 /composer.lock
+/node_modules
+/phpunit.xml
+/.phpunit.cache

README.md

@@ -105,13 +105,9 @@ More layouts are coming.
 
 ## Testing
 
-There's a basic test script in `tests/test.php`. You can execute this directly from the command line:
-
-```shell
-php tests/test.php
-```
-
-But a more robust test suite is needed and is coming.
+The OG uses [snapshot testing](https://github.com/spatie/phpunit-snapshot-assertions). To run the integration tests, 
+install [NodeJS](https://nodejs.org/en) (version 20 or above) and install the dependencies with `npm install`. Lastly, 
+execute the tests with `./vendor/bin/phpunit`. 
 
 ## Contributing
 

composer.json

@@ -13,10 +13,20 @@
             "SimonHamp\\TheOg\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    },
     "authors": [
         {
             "name": "Simon Hamp",
             "email": "simon.hamp@me.com"
         }
-    ]
+    ],
+    "require-dev": {
+        "spatie/phpunit-snapshot-assertions": "^5.1",
+        "phpunit/phpunit": "^10.5",
+        "spatie/pixelmatch-php": "^1.0"
+    }
 }

package.json

@@ -0,0 +1,5 @@
+{
+  "devDependencies": {
+    "pixelmatch": "^5.3.0"
+  }
+}

phpunit.xml.dist

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+    <testsuites>
+        <testsuite name="Integration">
+            <directory>tests/Integration</directory>
+        </testsuite>
+        <testsuite name="Unit">
+            <directory>tests/Unit</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

tests/Integration/ImageTest.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace Tests\Integration;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use SimonHamp\TheOg\Background;
+use SimonHamp\TheOg\Image;
+use SimonHamp\TheOg\Themes\Themes;
+use Spatie\Snapshots\MatchesSnapshots;
+
+class ImageTest extends IntegrationTestCase
+{
+    use MatchesSnapshots;
+
+    #[DataProvider('snapshotImages')]
+    public function test_basic_image(Image $image, string $name): void
+    {
+        $path = self::TESTCASE_DIRECTORY.'/'.$name.'.png';
+
+        $image->save($path);
+
+        $this->assertMatchesImageSnapshot($path);
+    }
+
+    public static function snapshotImages(): iterable
+    {
+        yield 'basic' => [
+            (new Image())
+                ->url('https://example.com/blog/some-blog-post-url')
+                ->title('Some blog post title that is quite big and quite long')
+                ->description('Some slightly smaller but potentially much longer subtext. It could be really long so we might need to trim it completely after many words'),
+            'basic',
+        ];
+
+        yield 'different theme' => [
+            (new Image())
+                ->theme(Themes::Dark)
+                ->url('https://example.com/blog/some-blog-post-url')
+                ->title('Some blog post title that is quite big and quite long')
+                ->description('Some slightly smaller but potentially much longer subtext. It could be really long so we might need to trim it completely after many words'),
+            'different-theme',
+        ];
+
+        yield 'override some elements' => [
+            (new Image())
+                ->accentColor('#cc0000')
+                ->url('https://example.com/blog/some-blog-post-url')
+                ->title('Some blog post title that is quite big and quite long')
+                ->description(<<<'TEXT'
+        Some slightly smaller but potentially much longer subtext. It could be really long so we might need to trim it completely after many words.
+
+        Some slightly smaller but potentially much longer subtext. It could be really long so we might need to trim it completely after many words.
+        TEXT
+                )
+                ->background(Background::JustWaves, 0.2),
+            'override-some-elements',
+        ];
+
+        yield 'basic with background url' => [
+            (new Image())
+                ->url('https://example.com/blog/some-blog-post-url')
+                ->title('Some blog post title that is quite big and quite long')
+                ->description('Some slightly smaller but potentially much longer subtext. It could be really long so we might need to trim it completely after many words')
+                ->backgroundUrl('https://www.goodfreephotos.com/albums/animals/mammals/african-bush-elephant-loxodonta-africana.jpg', 0.2),
+            'basic-with-background-url',
+        ];
+
+        yield 'different theme with background url' => [
+            (new Image())
+                ->theme(Themes::Dark)
+                ->url('https://example.com/blog/some-blog-post-url')
+                ->title('Some blog post title that is quite big and quite long')
+                ->description('Some slightly smaller but potentially much longer subtext. It could be really long so we might need to trim it completely after many words')
+                ->backgroundUrl('https://www.goodfreephotos.com/albums/animals/mammals/african-bush-elephant-loxodonta-africana.jpg', 0.2),
+            'different-theme-with-background-url',
+        ];
+    }
+}

tests/Integration/IntegrationTestCase.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Tests\Integration;
+
+use FilesystemIterator;
+use PHPUnit\Framework\TestCase;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+
+class IntegrationTestCase extends TestCase
+{
+    protected const TESTCASE_DIRECTORY = __DIR__.'/../resources/testcases';
+
+    protected function tearDown(): void
+    {
+        TestCase::tearDown();
+
+        $files = new RecursiveIteratorIterator(
+            new RecursiveDirectoryIterator(self::TESTCASE_DIRECTORY, FilesystemIterator::SKIP_DOTS),
+            RecursiveIteratorIterator::CHILD_FIRST,
+        );
+
+        foreach ($files as $file) {
+            unlink($file->getRealPath());
+        }
+    }
+}

tests/Unit/Layout/LayoutsTest.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Tests\Unit\Layout;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use SimonHamp\TheOg\BorderPosition;
+use SimonHamp\TheOg\Layout\Layouts\GitHubBasic;
+use SimonHamp\TheOg\Layout\Layouts\Standard;
+use Tests\Unit\UnitTestcase;
+
+class LayoutsTest extends UnitTestCase
+{
+    #[DataProvider('provideLayouts')]
+    public function test_layouts(
+        string $layoutClass,
+        BorderPosition $borderPosition,
+        int $borderWidth,
+        int $boxWidth,
+        int $boxHeight,
+        int $mountX,
+        int $mountY
+    ): void {
+        $layout = new $layoutClass();
+
+        self::assertEquals($borderPosition, $layout->getBorderPosition());
+        self::assertEquals($borderWidth, $layout->getBorderWidth());
+        self::assertEquals($boxWidth, $layout->mountArea()->box->width());
+        self::assertEquals($boxHeight, $layout->mountArea()->box->height());
+        self::assertEquals($mountX, $layout->mountArea()->position->x());
+        self::assertEquals($mountY, $layout->mountArea()->position->y());
+    }
+
+    public static function provideLayouts(): iterable
+    {
+        yield 'standard' => [Standard::class, BorderPosition::All, 25, 1070, 500, 65, 65];
+        yield 'github basic' => [GitHubBasic::class, BorderPosition::Bottom, 25, 1190, 550, 45, 45];
+    }
+}

tests/Unit/UnitTestcase.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Tests\Unit;
+
+use PHPUnit\Framework\TestCase;
+
+class UnitTestcase extends TestCase
+{
+    //
+}