Exclude __sleep() and __wakeup() from test double code generation on PHP >= 8.5

Author: sebastianbergmann

ChangeLog-8.5.md

@@ -2,6 +2,12 @@
 
 All notable changes of the PHPUnit 8.5 release series are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles.
 
+## [8.5.46] - 2025-MM-DD
+
+### Changed
+
+* [#6366](https://github.com/sebastianbergmann/phpunit/issues/6366): Exclude `__sleep()` and `__wakeup()` from test double code generation on PHP >= 8.5
+
 ## [8.5.45] - 2025-09-11
 
 ### Changed
@@ -346,6 +352,7 @@ All notable changes of the PHPUnit 8.5 release series are documented in this fil
 * [#3967](https://github.com/sebastianbergmann/phpunit/issues/3967): Cannot double interface that extends interface that extends `\Throwable`
 * [#3968](https://github.com/sebastianbergmann/phpunit/pull/3968): Test class run in a separate PHP process are passing when `exit` called inside
 
+[8.5.46]: https://github.com/sebastianbergmann/phpunit/compare/8.5.45...8.5
 [8.5.45]: https://github.com/sebastianbergmann/phpunit/compare/8.5.44...8.5.45
 [8.5.44]: https://github.com/sebastianbergmann/phpunit/compare/8.5.43...8.5.44
 [8.5.43]: https://github.com/sebastianbergmann/phpunit/compare/8.5.42...8.5.43

src/Framework/MockObject/Generator.php

@@ -12,6 +12,7 @@
 use const DIRECTORY_SEPARATOR;
 use const PHP_EOL;
 use const PHP_MAJOR_VERSION;
+use const PHP_VERSION;
 use const PREG_OFFSET_CAPTURE;
 use const WSDL_CACHE_NONE;
 use function array_diff_assoc;
@@ -43,6 +44,7 @@
 use function strtolower;
 use function substr;
 use function trait_exists;
+use function version_compare;
 use Doctrine\Instantiator\Exception\ExceptionInterface as InstantiatorException;
 use Doctrine\Instantiator\Instantiator;
 use Exception;
@@ -113,20 +115,9 @@ public function __clone()
 EOT;
 
     /**
-     * @var array
+     * @var array<non-empty-string, true>
      */
-    private const BLACKLISTED_METHOD_NAMES = [
-        '__CLASS__'       => true,
-        '__DIR__'         => true,
-        '__FILE__'        => true,
-        '__FUNCTION__'    => true,
-        '__LINE__'        => true,
-        '__METHOD__'      => true,
-        '__NAMESPACE__'   => true,
-        '__TRAIT__'       => true,
-        '__clone'         => true,
-        '__halt_compiler' => true,
-    ];
+    private static $excludedMethodNames = [];
 
     /**
      * @var array
@@ -1112,12 +1103,32 @@ private function generateMockClassDeclaration(array $mockClassName, bool $isInte
 
     private function canMockMethod(ReflectionMethod $method): bool
     {
-        return !($this->isConstructor($method) || $method->isFinal() || $method->isPrivate() || $this->isMethodNameBlacklisted($method->getName()));
+        return !($this->isConstructor($method) || $method->isFinal() || $method->isPrivate() || $this->isMethodNameExcluded($method->getName()));
     }
 
-    private function isMethodNameBlacklisted(string $name): bool
+    private function isMethodNameExcluded(string $name): bool
     {
-        return isset(self::BLACKLISTED_METHOD_NAMES[$name]);
+        if (self::$excludedMethodNames === []) {
+            self::$excludedMethodNames = [
+                '__CLASS__'       => true,
+                '__DIR__'         => true,
+                '__FILE__'        => true,
+                '__FUNCTION__'    => true,
+                '__LINE__'        => true,
+                '__METHOD__'      => true,
+                '__NAMESPACE__'   => true,
+                '__TRAIT__'       => true,
+                '__clone'         => true,
+                '__halt_compiler' => true,
+            ];
+
+            if (version_compare(PHP_VERSION, '8.5', '>=')) {
+                self::$excludedMethodNames['__sleep']  = true;
+                self::$excludedMethodNames['__wakeup'] = true;
+            }
+        }
+
+        return isset(self::$excludedMethodNames[$name]);
     }
 
     private function getTemplate(string $template): Text_Template

tests/end-to-end/regression/6366.phpt

@@ -0,0 +1,19 @@
+--TEST--
+https://github.com/sebastianbergmann/phpunit/issues/6366
+--FILE--
+<?php declare(strict_types=1);
+$_SERVER['argv'][] = '--do-not-cache-result';
+$_SERVER['argv'][] = '--no-configuration';
+$_SERVER['argv'][] = __DIR__ . '/6366/Issue6366Test.php';
+
+require_once __DIR__ . '/../../bootstrap.php';
+
+PHPUnit\TextUI\Command::main();
+--EXPECTF--
+PHPUnit %s by Sebastian Bergmann and contributors.
+
+.                                                                   1 / 1 (100%)
+
+Time: %s, Memory: %s
+
+OK (1 test, 0 assertions)

tests/end-to-end/regression/6366/Issue6366Test.php

@@ -0,0 +1,24 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\TestFixture\Issue6366;
+
+use Exception;
+use PHPUnit\Framework\TestCase;
+
+final class Issue6366Test extends TestCase
+{
+    /**
+     * @doesNotPerformAssertions
+     */
+    public function testOne(): void
+    {
+        $this->createStub(Exception::class);
+    }
+}