[11.x] Adds PHPUnit 11 support (#49622)

Author: nunomaduro

.github/workflows/tests.yml

@@ -40,9 +40,10 @@ jobs:
       fail-fast: true
       matrix:
         php: [8.2, 8.3]
+        phpunit: ['10.5', '11.0']
         stability: [prefer-lowest, prefer-stable]
 
-    name: PHP ${{ matrix.php }} - ${{ matrix.stability }}
+    name: PHP ${{ matrix.php }} - PHPUnit ${{ matrix.phpunit }} - ${{ matrix.stability }}
 
     steps:
       - name: Checkout code
@@ -69,6 +70,13 @@ jobs:
           max_attempts: 5
           command: composer require guzzlehttp/psr7:^2.4 --no-interaction --no-update
 
+      - name: Set PHPUnit
+        uses: nick-fields/retry@v2
+        with:
+          timeout_minutes: 5
+          max_attempts: 5
+          command: composer require phpunit/phpunit:^${{ matrix.phpunit }} --dev --no-interaction --no-update
+
       - name: Install dependencies
         uses: nick-fields/retry@v2
         with:
@@ -101,9 +109,10 @@ jobs:
       fail-fast: true
       matrix:
         php: [8.2, 8.3]
+        phpunit: ['10.5', '11.0']
         stability: [prefer-lowest, prefer-stable]
 
-    name: PHP ${{ matrix.php }} - ${{ matrix.stability }} - Windows
+    name: PHP ${{ matrix.php }} - PHPUnit ${{ matrix.phpunit }} - ${{ matrix.stability }} - Windows
 
     steps:
       - name: Set git to use LF
@@ -131,6 +140,13 @@ jobs:
           max_attempts: 5
           command: composer require guzzlehttp/psr7:~2.4 --no-interaction --no-update
 
+      - name: Set PHPUnit
+        uses: nick-fields/retry@v2
+        with:
+          timeout_minutes: 5
+          max_attempts: 5
+          command: composer require phpunit/phpunit:~${{ matrix.phpunit }} --dev --no-interaction --no-update
+
       - name: Install dependencies
         uses: nick-fields/retry@v2
         with:

composer.json

@@ -108,7 +108,7 @@
         "orchestra/testbench-core": "^9.0",
         "pda/pheanstalk": "^5.0",
         "phpstan/phpstan": "^1.4.7",
-        "phpunit/phpunit": "^10.5",
+        "phpunit/phpunit": "^10.5|^11.0",
         "predis/predis": "^2.0.2",
         "symfony/cache": "^7.0",
         "symfony/http-client": "^7.0",
@@ -163,7 +163,7 @@
         "ext-redis": "Required to use the Redis cache and queue drivers (^4.0|^5.0).",
         "ably/ably-php": "Required to use the Ably broadcast driver (^1.0).",
         "aws/aws-sdk-php": "Required to use the SQS queue driver, DynamoDb failed job storage, and SES mail driver (^3.235.5).",
-        "brianium/paratest": "Required to run tests in parallel (^6.0).",
+        "brianium/paratest": "Required to run tests in parallel (^7.0|^8.0).",
         "fakerphp/faker": "Required to use the eloquent factory builder (^1.9.1).",
         "filp/whoops": "Required for friendly error pages in development (^2.14.3).",
         "guzzlehttp/guzzle": "Required to use the HTTP Client and the ping methods on schedules (^7.8).",
@@ -176,7 +176,7 @@
         "mockery/mockery": "Required to use mocking (^1.6).",
         "nyholm/psr7": "Required to use PSR-7 bridging features (^1.2).",
         "pda/pheanstalk": "Required to use the beanstalk queue driver (^5.0).",
-        "phpunit/phpunit": "Required to use assertions and run tests (^10.5).",
+        "phpunit/phpunit": "Required to use assertions and run tests (^10.5|^11.0).",
         "predis/predis": "Required to use the predis connector (^2.0.2).",
         "psr/http-message": "Required to allow Storage::put to accept a StreamInterface (^1.0).",
         "pusher/pusher-php-server": "Required to use the Pusher broadcast driver (^6.0|^7.0).",

phpstan.src.neon.dist

@@ -13,5 +13,6 @@ parameters:
     - "#should always throw an exception or terminate script execution#"
     - "#Instantiated class [a-zA-Z0-9\\\\_]+ not found.#"
     - "#Unsafe usage of new static#"
+    - "#has an uninitialized readonly property#"
   excludePaths:
     - "src/Illuminate/Testing/ParallelRunner.php"

src/Illuminate/Foundation/Bootstrap/HandleExceptions.php

@@ -9,6 +9,7 @@
 use Illuminate\Log\LogManager;
 use Illuminate\Support\Env;
 use Monolog\Handler\NullHandler;
+use PHPUnit\Runner\ErrorHandler;
 use Symfony\Component\Console\Output\ConsoleOutput;
 use Symfony\Component\ErrorHandler\Error\FatalError;
 use Throwable;
@@ -37,7 +38,7 @@ class HandleExceptions
      */
     public function bootstrap(Application $app)
     {
-        self::$reservedMemory = str_repeat('x', 32768);
+        static::$reservedMemory = str_repeat('x', 32768);
 
         static::$app = $app;
 
@@ -177,7 +178,7 @@ protected function ensureNullLogDriverIsConfigured()
      */
     public function handleException(Throwable $e)
     {
-        self::$reservedMemory = null;
+        static::$reservedMemory = null;
 
         try {
             $this->getExceptionHandler()->report($e);
@@ -225,7 +226,7 @@ protected function renderHttpResponse(Throwable $e)
      */
     public function handleShutdown()
     {
-        self::$reservedMemory = null;
+        static::$reservedMemory = null;
 
         if (! is_null($error = error_get_last()) && $this->isFatal($error['type'])) {
             $this->handleException($this->fatalErrorFromPhpError($error, 0));
@@ -292,9 +293,70 @@ protected function getExceptionHandler()
      * Clear the local application instance from memory.
      *
      * @return void
+     *
+     * @deprecated This method will be removed in a future Laravel version.
      */
     public static function forgetApp()
     {
         static::$app = null;
     }
+
+    /**
+     * Flush the bootstrapper's global state.
+     *
+     * @return void
+     */
+    public static function flushState()
+    {
+        if (is_null(static::$app)) {
+            return;
+        }
+
+        static::flushHandlersState();
+
+        static::$app = null;
+
+        static::$reservedMemory = null;
+    }
+
+    /**
+     * Flush the bootstrapper's global handlers state.
+     *
+     * @return void
+     */
+    public static function flushHandlersState()
+    {
+        while (true) {
+            $previousHandler = set_exception_handler(static fn () => null);
+
+            restore_exception_handler();
+
+            if ($previousHandler === null) {
+                break;
+            }
+
+            restore_exception_handler();
+        }
+
+        while (true) {
+            $previousHandler = set_error_handler(static fn () => null);
+
+            restore_error_handler();
+
+            if ($previousHandler === null) {
+                break;
+            }
+
+            restore_error_handler();
+        }
+
+        if (class_exists(ErrorHandler::class)) {
+            $instance = ErrorHandler::instance();
+
+            if ((fn () => $this->enabled ?? false)->call($instance)) {
+                $instance->disable();
+                $instance->enable();
+            }
+        }
+    }
 }

src/Illuminate/Foundation/Testing/TestCase.php

@@ -246,7 +246,7 @@ protected function tearDown(): void
         Component::forgetComponentsResolver();
         Component::forgetFactory();
         ConvertEmptyStringsToNull::flushState();
-        HandleExceptions::forgetApp();
+        HandleExceptions::flushState();
         Queue::createPayloadUsing(null);
         Sleep::fake(false);
         TrimStrings::flushState();

src/Illuminate/Testing/Constraints/ArraySubset.php

@@ -2,142 +2,17 @@
 
 namespace Illuminate\Testing\Constraints;
 
-use ArrayObject;
 use PHPUnit\Framework\Constraint\Constraint;
-use SebastianBergmann\Comparator\ComparisonFailure;
-use Traversable;
+use PHPUnit\Runner\Version;
 
-/**
- * @internal This class is not meant to be used or overwritten outside the framework itself.
- */
-final class ArraySubset extends Constraint
-{
-    /**
-     * @var iterable
-     */
-    private $subset;
-
-    /**
-     * @var bool
-     */
-    private $strict;
-
-    /**
-     * Create a new array subset constraint instance.
-     *
-     * @param  iterable  $subset
-     * @param  bool  $strict
-     * @return void
-     */
-    public function __construct(iterable $subset, bool $strict = false)
+if (str_starts_with(Version::series(), '10')) {
+    class ArraySubset extends Constraint
     {
-        $this->strict = $strict;
-        $this->subset = $subset;
+        use Concerns\ArraySubset;
     }
-
-    /**
-     * Evaluates the constraint for parameter $other.
-     *
-     * If $returnResult is set to false (the default), an exception is thrown
-     * in case of a failure. null is returned otherwise.
-     *
-     * If $returnResult is true, the result of the evaluation is returned as
-     * a boolean value instead: true in case of success, false in case of a
-     * failure.
-     *
-     * @param  mixed  $other
-     * @param  string  $description
-     * @param  bool  $returnResult
-     * @return bool|null
-     *
-     * @throws \PHPUnit\Framework\ExpectationFailedException
-     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
-     */
-    public function evaluate($other, string $description = '', bool $returnResult = false): ?bool
+} else {
+    readonly class ArraySubset extends Constraint
     {
-        // type cast $other & $this->subset as an array to allow
-        // support in standard array functions.
-        $other = $this->toArray($other);
-        $this->subset = $this->toArray($this->subset);
-
-        $patched = array_replace_recursive($other, $this->subset);
-
-        if ($this->strict) {
-            $result = $other === $patched;
-        } else {
-            $result = $other == $patched;
-        }
-
-        if ($returnResult) {
-            return $result;
-        }
-
-        if (! $result) {
-            $f = new ComparisonFailure(
-                $patched,
-                $other,
-                var_export($patched, true),
-                var_export($other, true)
-            );
-
-            $this->fail($other, $description, $f);
-        }
-
-        return null;
-    }
-
-    /**
-     * Returns a string representation of the constraint.
-     *
-     * @return string
-     *
-     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
-     */
-    public function toString(): string
-    {
-        return 'has the subset '.$this->exporter()->export($this->subset);
-    }
-
-    /**
-     * Returns the description of the failure.
-     *
-     * The beginning of failure messages is "Failed asserting that" in most
-     * cases. This method should return the second part of that sentence.
-     *
-     * @param  mixed  $other
-     * @return string
-     *
-     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
-     */
-    protected function failureDescription($other): string
-    {
-        return 'an array '.$this->toString();
-    }
-
-    /**
-     * Returns the description of the failure.
-     *
-     * The beginning of failure messages is "Failed asserting that" in most
-     * cases. This method should return the second part of that sentence.
-     *
-     * @param  iterable  $other
-     * @return array
-     */
-    private function toArray(iterable $other): array
-    {
-        if (is_array($other)) {
-            return $other;
-        }
-
-        if ($other instanceof ArrayObject) {
-            return $other->getArrayCopy();
-        }
-
-        if ($other instanceof Traversable) {
-            return iterator_to_array($other);
-        }
-
-        // Keep BC even if we know that array would not be the expected one
-        return (array) $other;
+        use Concerns\ArraySubset;
     }
 }