Setup paratest for unit and integration tests parallelization

Author: ifox

.github/workflows/main.yml

@@ -148,7 +148,7 @@ jobs:
         run: ./vendor/bin/testbench-dusk package:discover
 
       - name: Execute all tests
-        run: vendor/bin/phpunit --stop-on-error
+        run: vendor/bin/paratest --testsuite Unit,Integration --stop-on-error && vendor/bin/phpunit --testsuite Browser --stop-on-error
         env:
           DB_PORT: ${{ job.services.mysql.ports['3306'] }}
 

composer.json

@@ -46,6 +46,7 @@
   },
   "require-dev": {
     "area17/phptorch": "dev-main",
+    "brianium/paratest": "^7.8",
     "chillerlan/php-qrcode": "~4.0",
     "friendsofphp/php-cs-fixer": "^3.0",
     "larastan/larastan": "^2.9 | ^3.0",
@@ -74,12 +75,14 @@
     }
   },
   "scripts": {
-    "test:phpunit": "vendor/bin/phpunit",
+    "test:phpunit": "vendor/bin/paratest --testsuite Unit,Integration --stop-on-error --no-coverage",
+    "test:browser": "vendor/bin/phpunit --testsuite Browser --stop-on-error --no-coverage",
     "test:analyse": "php -d memory_limit=-1 vendor/bin/phpstan analyse",
     "test:syntax": "vendor/bin/php-cs-fixer --dry-run fix src",
     "test": [
       "@test:syntax",
-      "@test:phpunit"
+      "@test:phpunit",
+      "@test:browser"
     ],
     "post-autoload-dump": [
       "@php ./vendor/bin/testbench package:discover --ansi"

phpunit-legacy.xml

@@ -22,6 +22,8 @@
         </testsuite>
         <testsuite name="Unit">
             <directory>tests/unit</directory>
+        </testsuite>
+        <testsuite name="Integration">
             <directory>tests/integration</directory>
         </testsuite>
     </testsuites>

phpunit.xml

@@ -1,5 +1,17 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="tests/bootstrap.php" colors="true" processIsolation="false" stopOnError="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.1/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+  displayDetailsOnPhpunitDeprecations="true" 
+  displayDetailsOnTestsThatTriggerWarnings="true" 
+  backupGlobals="false" 
+  bootstrap="tests/bootstrap.php" 
+  colors="true" 
+  processIsolation="false" 
+  stopOnError="true" 
+  stopOnFailure="true" 
+  xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.1/phpunit.xsd" 
+  cacheDirectory=".phpunit.cache" 
+  backupStaticProperties="false"
+>
   <coverage>
     <report>
       <clover outputFile="./.github/clover.xml"/>
@@ -12,6 +24,8 @@
     </testsuite>
     <testsuite name="Unit">
       <directory>tests/unit</directory>
+    </testsuite>
+    <testsuite name="Integration">
       <directory>tests/integration</directory>
     </testsuite>
   </testsuites>
@@ -27,6 +41,7 @@
     <env name="CACHE_STORE" value="array"/>
     <env name="SESSION_DRIVER" value="array"/>
     <env name="QUEUE_DRIVER" value="sync"/>
+    <env name="QUEUE_CONNECTION" value="sync"/>
     <env name="MAIL_DRIVER" value="array"/>
     <env name="DB_CONNECTION" value="mysql"/>
     <env name="DB_DATABASE" value="twill_testing_3x"/>

tests/integration/TestCase.php

@@ -69,6 +69,8 @@ public function createApplication(): Application
 
     public static function setUpBeforeClass(): void
     {
+        self::prepareParallelTestbenchApplication();
+        self::configureParallelDatabase();
         cleanupTestState(self::applicationBasePath());
         parent::setUpBeforeClass();
     }
@@ -101,12 +103,13 @@ public function setUp(): void
         }
 
         $loader = new ClassLoader();
-        $loader->addPsr4('App\\', 'vendor/orchestra/testbench-core/laravel/app');
+        $loader->addPsr4('App\\', $this->getBasePath() . '/app');
         $loader->register();
 
         // Enforce the url for testing to be 'http://twill.test' for certain assertions.
         // This is different from the one in phpunit.xml because that one is used for laravel dusk.
-        $_ENV['APP_URL'] = 'http://twill.test';
+        $_ENV['APP_URL'] = $_SERVER['APP_URL'] = 'http://twill.test';
+        putenv('APP_URL=http://twill.test');
         $_ENV['MEDIA_LIBRARY_LOCAL_PATH'] = "media-library";
         $_ENV["FILE_LIBRARY_LOCAL_PATH"] = "file-library";
         $_ENV["FILE_LIBRARY_ENDPOINT_TYPE"] = "local";
@@ -149,6 +152,7 @@ public function setUp(): void
      */
     public function configTwill($app): void
     {
+        $app['config']->set('app.url', 'http://twill.test');
         $app['config']->set('twill.admin_app_url', '');
         $app['config']->set('twill.admin_app_path', 'twill');
         $app['config']->set('twill.auth_login_redirect_path', '/twill');
@@ -556,7 +560,13 @@ public function loadConfig()
 
     protected static function getBasePathStatic(): string
     {
-        return __DIR__ . '/../../vendor/orchestra/testbench-core/laravel';
+        $basePath = __DIR__ . '/../../vendor/orchestra/testbench-core/laravel';
+
+        if ($token = self::parallelTestingToken()) {
+            return $basePath . '_' . $token;
+        }
+
+        return $basePath;
     }
 
     public static function applicationBasePath(): string
@@ -566,6 +576,65 @@ public static function applicationBasePath(): string
 
     protected function getBasePath(): string
     {
-        return __DIR__ . '/../../vendor/orchestra/testbench-core/laravel';
+        return self::getBasePathStatic();
+    }
+
+    protected static function parallelTestingToken(): ?string
+    {
+        return $_SERVER['TEST_TOKEN'] ?? $_ENV['TEST_TOKEN'] ?? null;
+    }
+
+    protected static function prepareParallelTestbenchApplication(): void
+    {
+        if (! self::parallelTestingToken()) {
+            return;
+        }
+
+        $source = __DIR__ . '/../../vendor/orchestra/testbench-core/laravel';
+        $target = self::getBasePathStatic();
+
+        if (! is_dir($target)) {
+            self::copyDirectory($source, $target);
+        }
+    }
+
+    protected static function configureParallelDatabase(): void
+    {
+        if (! self::parallelTestingToken() || ($_ENV['DB_CONNECTION'] ?? null) !== 'mysql') {
+            return;
+        }
+
+        $database = preg_replace('/_\d+$/', '', $_ENV['DB_DATABASE']) . '_' . self::parallelTestingToken();
+        $_ENV['DB_DATABASE'] = $_SERVER['DB_DATABASE'] = $database;
+        putenv("DB_DATABASE={$database}");
+
+        $host = $_ENV['DB_HOST'] ?? '127.0.0.1';
+        $port = $_ENV['DB_PORT'] ?? '3306';
+        $username = $_ENV['DB_USERNAME'] ?? 'root';
+        $password = $_ENV['DB_PASSWORD'] ?? '';
+
+        $pdo = new \PDO("mysql:host={$host};port={$port}", $username, $password);
+        $pdo->exec("DROP DATABASE IF EXISTS `{$database}`");
+        $pdo->exec("CREATE DATABASE `{$database}`");
+    }
+
+    protected static function copyDirectory(string $source, string $target): void
+    {
+        mkdir($target, 0777, true);
+
+        foreach (scandir($source) as $item) {
+            if ($item === '.' || $item === '..') {
+                continue;
+            }
+
+            $sourcePath = $source . DIRECTORY_SEPARATOR . $item;
+            $targetPath = $target . DIRECTORY_SEPARATOR . $item;
+
+            if (is_dir($sourcePath) && ! is_link($sourcePath)) {
+                self::copyDirectory($sourcePath, $targetPath);
+            } else {
+                copy($sourcePath, $targetPath);
+            }
+        }
     }
 }