Make createStub(), TestCase::createStubForIntersectionOfInterfaces(), and createConfiguredStub() static so that they can be used in static data provider methods

Author: sebastianbergmann

ChangeLog-10.3.md

@@ -13,5 +13,6 @@ All notable changes of the PHPUnit 10.3 release series are documented in this fi
 * When a test case class inherits test methods from a parent class then, by default (when no test reordering is requested), the test methods from the class that is highest in the inheritance tree (instead of the class that is lowest in the inheritance tree) are now run first
 * Invocation count expectation failure messages have been slightly improved
 * When a test case class inherits test methods from a parent class then the TestDox output for such a test case class now starts with test methods from the class that is highest in the inheritance tree (instead of the class that is lowest in the inheritance tree)
+* `TestCase::createStub()`, `TestCase::createStubForIntersectionOfInterfaces()`, and `TestCase::createConfiguredStub()` are now static (and can be used from static data provider methods)
 
 [10.3.0]: https://github.com/sebastianbergmann/phpunit/compare/10.2...main

src/Framework/TestCase.php

@@ -161,9 +161,8 @@ abstract class TestCase extends Assert implements Reorderable, SelfDescribing, T
     /**
      * @psalm-var array<string,string>
      */
-    private array $iniSettings                  = [];
-    private array $locale                       = [];
-    private ?MockGenerator $mockObjectGenerator = null;
+    private array $iniSettings = [];
+    private array $locale      = [];
 
     /**
      * @psalm-var list<MockObjectInternal>
@@ -1169,66 +1168,6 @@ protected function setLocale(mixed ...$arguments): void
         }
     }
 
-    /**
-     * Creates a test stub for the specified interface or class.
-     *
-     * @psalm-template RealInstanceType of object
-     *
-     * @psalm-param class-string<RealInstanceType> $originalClassName
-     *
-     * @psalm-return Stub&RealInstanceType
-     *
-     * @throws \PHPUnit\Framework\MockObject\Exception
-     * @throws InvalidArgumentException
-     * @throws NoPreviousThrowableException
-     */
-    protected function createStub(string $originalClassName): Stub
-    {
-        $stub = $this->createTestDouble($originalClassName, false);
-
-        Event\Facade::emitter()->testCreatedStub($originalClassName);
-
-        return $stub;
-    }
-
-    /**
-     * @psalm-param list<class-string> $interfaces
-     *
-     * @throws \PHPUnit\Framework\MockObject\Exception
-     */
-    protected function createStubForIntersectionOfInterfaces(array $interfaces): Stub
-    {
-        $stub = $this->mockObjectGenerator()->getMockForInterfaces($interfaces);
-
-        Event\Facade::emitter()->testCreatedStubForIntersectionOfInterfaces($interfaces);
-
-        return $stub;
-    }
-
-    /**
-     * Creates (and configures) a test stub for the specified interface or class.
-     *
-     * @psalm-template RealInstanceType of object
-     *
-     * @psalm-param class-string<RealInstanceType> $originalClassName
-     *
-     * @psalm-return Stub&RealInstanceType
-     *
-     * @throws \PHPUnit\Framework\MockObject\Exception
-     * @throws InvalidArgumentException
-     * @throws NoPreviousThrowableException
-     */
-    final protected function createConfiguredStub(string $originalClassName, array $configuration): Stub
-    {
-        $o = $this->createStub($originalClassName);
-
-        foreach ($configuration as $method => $return) {
-            $o->method($method)->willReturn($return);
-        }
-
-        return $o;
-    }
-
     /**
      * Creates a mock object for the specified interface or class.
      *
@@ -1244,7 +1183,15 @@ final protected function createConfiguredStub(string $originalClassName, array $
      */
     protected function createMock(string $originalClassName): MockObject
     {
-        $mock = $this->createTestDouble($originalClassName);
+        $mock = (new MockGenerator)->getMock(
+            $originalClassName,
+            callOriginalConstructor: false,
+            callOriginalClone: false,
+            cloneArguments: false,
+            allowMockingUnknownTypes: false,
+        );
+
+        $this->registerMockObject($mock);
 
         Event\Facade::emitter()->testCreatedMockObject($originalClassName);
 
@@ -1258,7 +1205,7 @@ protected function createMock(string $originalClassName): MockObject
      */
     protected function createMockForIntersectionOfInterfaces(array $interfaces): MockObject
     {
-        $mock = $this->mockObjectGenerator()->getMockForInterfaces($interfaces);
+        $mock = (new MockGenerator)->getMockForInterfaces($interfaces);
 
         Event\Facade::emitter()->testCreatedMockObjectForIntersectionOfInterfaces($interfaces);
 
@@ -1368,7 +1315,7 @@ protected function createTestProxy(string $originalClassName, array $constructor
      */
     protected function getMockForAbstractClass(string $originalClassName, array $arguments = [], string $mockClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true, array $mockedMethods = [], bool $cloneArguments = false): MockObject
     {
-        $mockObject = $this->mockObjectGenerator()->getMockForAbstractClass(
+        $mockObject = (new MockGenerator)->getMockForAbstractClass(
             $originalClassName,
             $arguments,
             $mockClassName,
@@ -1408,7 +1355,7 @@ protected function getMockFromWsdl(string $wsdlFile, string $originalClassName =
 
         if (!class_exists($originalClassName)) {
             eval(
-                $this->mockObjectGenerator()->generateClassFromWsdl(
+                (new MockGenerator)->generateClassFromWsdl(
                     $wsdlFile,
                     $originalClassName,
                     $methods,
@@ -1417,7 +1364,7 @@ protected function getMockFromWsdl(string $wsdlFile, string $originalClassName =
             );
         }
 
-        $mockObject = $this->mockObjectGenerator()->getMock(
+        $mockObject = (new MockGenerator)->getMock(
             $originalClassName,
             $methods,
             ['', $options],
@@ -1455,7 +1402,7 @@ protected function getMockFromWsdl(string $wsdlFile, string $originalClassName =
      */
     protected function getMockForTrait(string $traitName, array $arguments = [], string $mockClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true, array $mockedMethods = [], bool $cloneArguments = false): MockObject
     {
-        $mockObject = $this->mockObjectGenerator()->getMockForTrait(
+        $mockObject = (new MockGenerator)->getMockForTrait(
             $traitName,
             $arguments,
             $mockClassName,
@@ -1484,7 +1431,7 @@ protected function getMockForTrait(string $traitName, array $arguments = [], str
      */
     protected function getObjectForTrait(string $traitName, array $arguments = [], string $traitClassName = '', bool $callOriginalConstructor = true, bool $callOriginalClone = true, bool $callAutoload = true): object
     {
-        return $this->mockObjectGenerator()->getObjectForTrait(
+        return (new MockGenerator)->getObjectForTrait(
             $traitName,
             $traitClassName,
             $callAutoload,
@@ -1660,15 +1607,6 @@ private function markSkippedForMissingDependency(ExecutionOrderDependency $depen
         $this->status = TestStatus::skipped($message);
     }
 
-    private function mockObjectGenerator(): MockGenerator
-    {
-        if ($this->mockObjectGenerator === null) {
-            $this->mockObjectGenerator = new MockGenerator;
-        }
-
-        return $this->mockObjectGenerator;
-    }
-
     private function startOutputBuffering(): void
     {
         ob_start();
@@ -1990,34 +1928,6 @@ private function isCallableTestMethod(string $dependency): bool
         );
     }
 
-    /**
-     * @psalm-template RealInstanceType of object
-     *
-     * @psalm-param class-string<RealInstanceType> $originalClassName
-     *
-     * @psalm-return MockObject&RealInstanceType
-     *
-     * @throws \PHPUnit\Framework\MockObject\Exception
-     * @throws InvalidArgumentException
-     * @throws NoPreviousThrowableException
-     */
-    private function createTestDouble(string $originalClassName, bool $register = true): MockObject
-    {
-        $testDouble = $this->mockObjectGenerator()->getMock(
-            $originalClassName,
-            callOriginalConstructor: false,
-            callOriginalClone: false,
-            cloneArguments: false,
-            allowMockingUnknownTypes: false,
-        );
-
-        if ($register) {
-            $this->registerMockObject($testDouble);
-        }
-
-        return $testDouble;
-    }
-
     /**
      * @throws Exception
      * @throws ExpectationFailedException
@@ -2273,4 +2183,70 @@ private function isRegisteredFailure(Throwable $t): bool
 
         return false;
     }
+
+    /**
+     * Creates a test stub for the specified interface or class.
+     *
+     * @psalm-template RealInstanceType of object
+     *
+     * @psalm-param class-string<RealInstanceType> $originalClassName
+     *
+     * @psalm-return Stub&RealInstanceType
+     *
+     * @throws \PHPUnit\Framework\MockObject\Exception
+     * @throws InvalidArgumentException
+     * @throws NoPreviousThrowableException
+     */
+    protected static function createStub(string $originalClassName): Stub
+    {
+        $stub = (new MockGenerator)->getMock(
+            $originalClassName,
+            callOriginalConstructor: false,
+            callOriginalClone: false,
+            cloneArguments: false,
+            allowMockingUnknownTypes: false,
+        );
+
+        Event\Facade::emitter()->testCreatedStub($originalClassName);
+
+        return $stub;
+    }
+
+    /**
+     * @psalm-param list<class-string> $interfaces
+     *
+     * @throws \PHPUnit\Framework\MockObject\Exception
+     */
+    protected static function createStubForIntersectionOfInterfaces(array $interfaces): Stub
+    {
+        $stub = (new MockGenerator)->getMockForInterfaces($interfaces);
+
+        Event\Facade::emitter()->testCreatedStubForIntersectionOfInterfaces($interfaces);
+
+        return $stub;
+    }
+
+    /**
+     * Creates (and configures) a test stub for the specified interface or class.
+     *
+     * @psalm-template RealInstanceType of object
+     *
+     * @psalm-param class-string<RealInstanceType> $originalClassName
+     *
+     * @psalm-return Stub&RealInstanceType
+     *
+     * @throws \PHPUnit\Framework\MockObject\Exception
+     * @throws InvalidArgumentException
+     * @throws NoPreviousThrowableException
+     */
+    final protected static function createConfiguredStub(string $originalClassName, array $configuration): Stub
+    {
+        $o = self::createStub($originalClassName);
+
+        foreach ($configuration as $method => $return) {
+            $o->method($method)->willReturn($return);
+        }
+
+        return $o;
+    }
 }