wip

Author: marickvantuil

.github/workflows/run-tests.yml

@@ -62,23 +62,22 @@ jobs:
     needs: access_check
     strategy:
       matrix:
+        db: [ 'mysql', 'sqlite' ]
         payload:
-          - { laravel: '11.*', php: '8.3', 'testbench': '9.*' }
-          - { laravel: '11.*', php: '8.2', 'testbench': '9.*' }
-          - { laravel: '10.*', php: '8.3', 'testbench': '8.*' }
-          - { laravel: '10.*', php: '8.2', 'testbench': '8.*' }
-          - { laravel: '10.*', php: '8.1', 'testbench': '8.*' }
+          - { laravel: '11.*', php: '8.3', 'testbench': '9.*', collision: '8.*' }
+          - { laravel: '11.*', php: '8.2', 'testbench': '9.*', collision: '8.*' }
+          - { laravel: '10.*', php: '8.3', 'testbench': '8.*', collision: '7.*' }
+          - { laravel: '10.*', php: '8.2', 'testbench': '8.*', collision: '7.*' }
+          - { laravel: '10.*', php: '8.1', 'testbench': '8.*', collision: '7.*' }
 
-    name: PHP ${{ matrix.payload.php }} - Laravel ${{ matrix.payload.laravel }}
+    name: PHP ${{ matrix.payload.php }} - Laravel ${{ matrix.payload.laravel }} - DB ${{ matrix.db }}
 
     services:
       mysql:
         image: mysql:8
         env:
-          MYSQL_USER: root
-          MYSQL_ROOT_PASSWORD: root
-          MYSQL_PASSWORD:
-          MYSQL_ALLOW_EMPTY_PASSWORD: true
+          MYSQL_USER: test
+          MYSQL_PASSWORD: test
           MYSQL_DATABASE: test
         ports:
           - 3307:3306
@@ -97,9 +96,23 @@ jobs:
           extensions: mbstring, dom, fileinfo, mysql
           coverage: none
 
+      - name: Set up MySQL and PostgreSQL
+        run: |
+          MYSQL_PORT=3307 POSTGRES_PORT=5432 docker compose up ${{ matrix.db }} -d
+
       - name: Install dependencies
         run: |
-          composer require "laravel/framework:${{ matrix.payload.laravel }}" "orchestra/testbench:${{ matrix.payload.testbench }}" --no-interaction --no-update
+          composer require "laravel/framework:${{ matrix.payload.laravel }}" "orchestra/testbench:${{ matrix.payload.testbench }}" "nunomaduro/collision:${{ matrix.payload.collision }}" --no-interaction --no-update
           composer update --prefer-stable --prefer-dist --no-interaction
+          if [ "${{ matrix.db }}" = "mysql" ]; then
+            while ! mysqladmin ping --host=127.0.0.1 --user=test --port=3307 --password=test --silent; do
+              echo "Waiting for MySQL..."
+              sleep 1
+            done
+          else
+            echo "Not waiting for MySQL."
+          fi
       - name: Execute tests
+        env:
+          DB_DRIVER: ${{ matrix.db }}
         run: composer test

composer.json

@@ -15,7 +15,10 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Tests\\": "tests/"
+            "Tests\\": "tests/",
+            "Workbench\\App\\": "workbench/app/",
+            "Workbench\\Database\\Factories\\": "workbench/database/factories/",
+            "Workbench\\Database\\Seeders\\": "workbench/database/seeders/"
         }
     },
     "extra": {
@@ -32,19 +35,36 @@
     "require-dev": {
         "mockery/mockery": "^1.2",
         "orchestra/testbench": "^8.0|^9.0",
+        "nunomaduro/collision": "^7.0|^8.0",
         "laravel/pint": "^1.14"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
     "scripts": {
         "l11": [
-            "composer update laravel/framework:11.* orchestra/testbench:9.* --with-all-dependencies"
+            "composer update laravel/framework:11.* orchestra/testbench:9.* nunomaduro/collision:8.* --with-all-dependencies"
         ],
         "l10": [
-            "composer update laravel/framework:10.* orchestra/testbench:8.* --with-all-dependencies"
+            "composer update laravel/framework:10.* orchestra/testbench:8.* nunomaduro/collision:7.* --with-all-dependencies"
         ],
         "test": [
-            "CI_DB_DRIVER=sqlite CI_DB_DATABASE=:memory: phpunit"
+            "testbench package:test"
+        ],
+        "post-autoload-dump": [
+            "@clear",
+            "@prepare"
+        ],
+        "clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
+        "prepare": "@php vendor/bin/testbench package:discover --ansi",
+        "build": "@php vendor/bin/testbench workbench:build --ansi",
+        "serve": [
+            "Composer\\Config::disableProcessTimeout",
+            "@build",
+            "@php vendor/bin/testbench serve"
+        ],
+        "lint": [
+            "@php vendor/bin/pint",
+            "@php vendor/bin/phpstan analyse"
         ]
     }
-}
+}

docker-compose.yml

@@ -0,0 +1,18 @@
+services:
+  mysql:
+    image: mysql:8
+    ports:
+      - '${MYSQL_PORT:-3307}:3306'
+    environment:
+      MYSQL_USER: 'test'
+      MYSQL_PASSWORD: 'test'
+      MYSQL_DATABASE: 'test'
+      MYSQL_RANDOM_ROOT_PASSWORD: true
+  pgsql:
+    image: postgres:14
+    ports:
+      - '${POSTGRES_PORT:-5432}:5432'
+    environment:
+      POSTGRES_USER: 'test'
+      POSTGRES_PASSWORD: 'test'
+      POSTGRES_DB: 'test'

testbench.yaml

@@ -0,0 +1,23 @@
+providers:
+  - Workbench\App\Providers\WorkbenchServiceProvider
+  - Stackkit\LaravelDatabaseEmails\LaravelDatabaseEmailsServiceProvider
+
+migrations:
+  - workbench/database/migrations
+
+seeders:
+  - Workbench\Database\Seeders\DatabaseSeeder
+
+workbench:
+  start: '/'
+  install: true
+  health: false
+  discovers:
+    web: true
+    api: false
+    commands: false
+    components: false
+    views: false
+  build: []
+  assets: []
+  sync: []

tests/QueuedEmailsTest.php

@@ -9,14 +9,11 @@
 
 class QueuedEmailsTest extends TestCase
 {
-    public function setUp(): void
-    {
-        parent::setUp();
-    }
-
     #[Test]
     public function queueing_an_email_will_leave_sending_on_false()
     {
+        Queue::fake();
+
         $email = $this->queueEmail();
 
         $this->assertEquals(0, $email->sending);
@@ -25,6 +22,8 @@ public function queueing_an_email_will_leave_sending_on_false()
     #[Test]
     public function queueing_an_email_will_set_the_queued_at_column()
     {
+        Queue::fake();
+
         $email = $this->queueEmail();
 
         $this->assertNotNull($email->queued_at);

tests/TestCase.php

@@ -2,12 +2,18 @@
 
 namespace Tests;
 
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Illuminate\Foundation\Testing\LazilyRefreshDatabase;
+use Illuminate\Foundation\Testing\RefreshDatabase;
 use Stackkit\LaravelDatabaseEmails\Email;
+use Stackkit\LaravelDatabaseEmails\LaravelDatabaseEmailsServiceProvider;
 
 class TestCase extends \Orchestra\Testbench\TestCase
 {
     protected $invalid;
 
+    use LazilyRefreshDatabase;
+
     public function setUp(): void
     {
         parent::setUp();
@@ -31,20 +37,10 @@ function () {
         Email::truncate();
     }
 
-    /**
-     * Get package providers.  At a minimum this is the package being tested, but also
-     * would include packages upon which our package depends, e.g. Cartalyst/Sentry
-     * In a normal app environment these would be added to the 'providers' array in
-     * the config/app.php file.
-     *
-     * @param  \Illuminate\Foundation\Application $app
-     *
-     * @return array
-     */
     protected function getPackageProviders($app)
     {
         return [
-            \Stackkit\LaravelDatabaseEmails\LaravelDatabaseEmailsServiceProvider::class,
+            LaravelDatabaseEmailsServiceProvider::class,
         ];
     }
 
@@ -61,15 +57,25 @@ protected function getEnvironmentSetUp($app)
         $app['config']->set('laravel-database-emails.testing.email', '[email protected]');
 
         $app['config']->set('database.default', 'testbench');
+        $driver = env('DB_DRIVER', 'sqlite');
         $app['config']->set('database.connections.testbench', [
-            'driver'   => getenv('CI_DB_DRIVER'),
-            'host'     => getenv('CI_DB_HOST'),
-            'port'     => getenv('CI_DB_PORT'),
-            'database' => getenv('CI_DB_DATABASE'),
-            'username' => getenv('CI_DB_USERNAME'),
-            'password' => getenv('CI_DB_PASSWORD'),
-            'prefix'   => '',
-            'strict' => true,
+            'driver' => $driver,
+            ...match($driver) {
+                'sqlite' => [
+                    'database' => ':memory:',
+                ],
+                'mysql' => [
+                    'host' => '127.0.0.1',
+                    'port' => 3307,
+                ],
+                'pgsql' => [
+                    'host' => '127.0.0.1',
+                    'port' => 5432,
+                ],
+            },
+            'database' => 'test',
+            'username' => 'test',
+            'password' => 'test',
         ]);
 
         $app['config']->set('mail.driver', 'log');

workbench/app/Models/.gitkeep

@@ -0,0 +1,24 @@
+<?php
+
+namespace Workbench\App\Providers;
+
+use Illuminate\Support\ServiceProvider;
+
+class WorkbenchServiceProvider extends ServiceProvider
+{
+    /**
+     * Register services.
+     */
+    public function register(): void
+    {
+        //
+    }
+
+    /**
+     * Bootstrap services.
+     */
+    public function boot(): void
+    {
+        //
+    }
+}

workbench/app/Providers/WorkbenchServiceProvider.php

@@ -0,0 +1,19 @@
+<?php
+
+use Illuminate\Foundation\Application;
+use Illuminate\Foundation\Configuration\Exceptions;
+use Illuminate\Foundation\Configuration\Middleware;
+
+use function Orchestra\Testbench\default_skeleton_path;
+
+return Application::configure(basePath: $APP_BASE_PATH ?? default_skeleton_path())
+    ->withRouting(
+        web: __DIR__.'/../routes/web.php',
+        commands: __DIR__.'/../routes/console.php',
+    )
+    ->withMiddleware(function (Middleware $middleware) {
+        //
+    })
+    ->withExceptions(function (Exceptions $exceptions) {
+        //
+    })->create();

workbench/bootstrap/.gitkeep

@@ -0,0 +1,5 @@
+<?php
+
+return [
+    //
+];

workbench/bootstrap/app.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Workbench\Database\Seeders;
+
+use Illuminate\Database\Console\Seeds\WithoutModelEvents;
+use Illuminate\Database\Seeder;
+
+class DatabaseSeeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     */
+    public function run(): void
+    {
+        //
+    }
+}

workbench/bootstrap/providers.php

@@ -0,0 +1,8 @@
+<?php
+
+use Illuminate\Foundation\Inspiring;
+use Illuminate\Support\Facades\Artisan;
+
+Artisan::command('inspire', function () {
+    $this->comment(Inspiring::quote());
+})->purpose('Display an inspiring quote')->hourly();

workbench/database/factories/.gitkeep

@@ -0,0 +1,7 @@
+<?php
+
+use Illuminate\Support\Facades\Route;
+
+Route::get('/', function () {
+    return view('welcome');
+});