Refactor

Author: sebastianbergmann

src/Framework/TestRunner/SeparateProcessTestRunner.php

@@ -11,25 +11,20 @@
 
 use function assert;
 use function defined;
-use function file_get_contents;
 use function get_include_path;
 use function hrtime;
-use function is_file;
 use function serialize;
 use function sys_get_temp_dir;
 use function tempnam;
 use function unlink;
 use function unserialize;
 use function var_export;
-use PHPUnit\Event\Facade;
 use PHPUnit\Event\NoPreviousThrowableException;
 use PHPUnit\Runner\CodeCoverage;
-use PHPUnit\TestRunner\TestResult\PassedTests;
 use PHPUnit\TextUI\Configuration\Registry as ConfigurationRegistry;
 use PHPUnit\Util\GlobalState;
 use PHPUnit\Util\PHP\Job;
 use PHPUnit\Util\PHP\JobRunnerRegistry;
-use PHPUnit\Util\PHP\PhpProcessException;
 use ReflectionClass;
 use SebastianBergmann\Template\InvalidArgumentException;
 use SebastianBergmann\Template\Template;
@@ -144,46 +139,11 @@ public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalSt
 
         assert($code !== '');
 
-        $this->runTestJob($code, $test, $processResultFile);
+        JobRunnerRegistry::runTestJob(new Job($code), $processResultFile, $test);
 
         @unlink($serializedConfiguration);
     }
 
-    /**
-     * @param non-empty-string $code
-     *
-     * @throws Exception
-     * @throws NoPreviousThrowableException
-     * @throws PhpProcessException
-     */
-    private function runTestJob(string $code, Test $test, string $processResultFile): void
-    {
-        $result = JobRunnerRegistry::run(new Job($code));
-
-        $processResult = '';
-
-        if (is_file($processResultFile)) {
-            $processResult = file_get_contents($processResultFile);
-
-            assert($processResult !== false);
-
-            @unlink($processResultFile);
-        }
-
-        $processor = new ChildProcessResultProcessor(
-            Facade::instance(),
-            Facade::emitter(),
-            PassedTests::instance(),
-            CodeCoverage::instance(),
-        );
-
-        $processor->process(
-            $test,
-            $processResult,
-            $result->stderr(),
-        );
-    }
-
     /**
      * @throws ProcessIsolationException
      */

src/Util/PHP/DefaultJobRunner.php

@@ -16,6 +16,7 @@
 use function assert;
 use function fclose;
 use function file_put_contents;
+use function function_exists;
 use function fwrite;
 use function ini_get_all;
 use function is_array;
@@ -37,7 +38,7 @@
  *
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
  */
-final readonly class DefaultJobRunner implements JobRunner
+final readonly class DefaultJobRunner extends JobRunner
 {
     /**
      * @throws PhpProcessException
@@ -178,6 +179,8 @@ private function buildCommand(Job $job, ?string $file): array
                 ),
             );
         } elseif ($runtime->hasXdebug()) {
+            assert(function_exists('xdebug_is_debugger_active'));
+
             $xdebugSettings = ini_get_all('xdebug');
 
             assert($xdebugSettings !== false);
@@ -189,11 +192,8 @@ private function buildCommand(Job $job, ?string $file): array
                 ),
             );
 
-            // disable xdebug if not required to reduce xdebug performance overhead in subprocesses
-            if (
-                !CodeCoverage::instance()->isActive() &&
-                xdebug_is_debugger_active() === false
-            ) {
+            if (!CodeCoverage::instance()->isActive() &&
+                xdebug_is_debugger_active() === false) {
                 $phpSettings['xdebug.mode'] = 'xdebug.mode=off';
             }
         }

src/Util/PHP/JobRunner.php

@@ -9,12 +9,50 @@
  */
 namespace PHPUnit\Util\PHP;
 
+use function assert;
+use function file_get_contents;
+use function is_file;
+use function unlink;
+use PHPUnit\Framework\ChildProcessResultProcessor;
+use PHPUnit\Framework\Test;
+
 /**
  * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
  *
- * @internal This interface is not covered by the backward compatibility promise for PHPUnit
+ * @internal This class is not covered by the backward compatibility promise for PHPUnit
  */
-interface JobRunner
+abstract readonly class JobRunner
 {
-    public function run(Job $job): Result;
+    private ChildProcessResultProcessor $processor;
+
+    public function __construct(ChildProcessResultProcessor $processor)
+    {
+        $this->processor = $processor;
+    }
+
+    /**
+     * @param non-empty-string $processResultFile
+     */
+    final public function runTestJob(Job $job, string $processResultFile, Test $test): void
+    {
+        $result = $this->run($job);
+
+        $processResult = '';
+
+        if (is_file($processResultFile)) {
+            $processResult = file_get_contents($processResultFile);
+
+            assert($processResult !== false);
+
+            @unlink($processResultFile);
+        }
+
+        $this->processor->process(
+            $test,
+            $processResult,
+            $result->stderr(),
+        );
+    }
+
+    abstract public function run(Job $job): Result;
 }

src/Util/PHP/JobRunnerRegistry.php

@@ -9,6 +9,12 @@
  */
 namespace PHPUnit\Util\PHP;
 
+use PHPUnit\Event\Facade;
+use PHPUnit\Framework\ChildProcessResultProcessor;
+use PHPUnit\Framework\Test;
+use PHPUnit\Runner\CodeCoverage;
+use PHPUnit\TestRunner\TestResult\PassedTests;
+
 /**
  * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
  *
@@ -20,15 +26,35 @@ final class JobRunnerRegistry
 
     public static function run(Job $job): Result
     {
-        if (self::$runner === null) {
-            self::$runner = new DefaultJobRunner;
-        }
+        return self::runner()->run($job);
+    }
 
-        return self::$runner->run($job);
+    /**
+     * @param non-empty-string $processResultFile
+     */
+    public static function runTestJob(Job $job, string $processResultFile, Test $test): void
+    {
+        self::runner()->runTestJob($job, $processResultFile, $test);
     }
 
     public static function set(JobRunner $runner): void
     {
         self::$runner = $runner;
     }
+
+    private static function runner(): JobRunner
+    {
+        if (self::$runner === null) {
+            self::$runner = new DefaultJobRunner(
+                new ChildProcessResultProcessor(
+                    Facade::instance(),
+                    Facade::emitter(),
+                    PassedTests::instance(),
+                    CodeCoverage::instance(),
+                ),
+            );
+        }
+
+        return self::$runner;
+    }
 }

tests/unit/Util/PHP/DefaultJobRunnerTest.php

@@ -12,11 +12,16 @@
 use const PHP_VERSION;
 use function version_compare;
 use Generator;
+use PHPUnit\Event\Emitter;
+use PHPUnit\Event\Facade;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Small;
 use PHPUnit\Framework\Attributes\UsesClass;
+use PHPUnit\Framework\ChildProcessResultProcessor;
 use PHPUnit\Framework\TestCase;
+use PHPUnit\Runner\CodeCoverage;
+use PHPUnit\TestRunner\TestResult\PassedTests;
 
 #[CoversClass(DefaultJobRunner::class)]
 #[UsesClass(Job::class)]
@@ -114,7 +119,14 @@ public static function provider(): Generator
     #[DataProvider('provider')]
     public function testRunsJobInSeparateProcess(Result $expected, Job $job): void
     {
-        $jobRunner = new DefaultJobRunner;
+        $jobRunner = new DefaultJobRunner(
+            new ChildProcessResultProcessor(
+                new Facade,
+                $this->createStub(Emitter::class),
+                new PassedTests,
+                new CodeCoverage,
+            ),
+        );
 
         $result = $jobRunner->run($job);