Disable performance optimization for tests requiring on Xdebug

src/Framework/TestCase.php

@@ -367,6 +367,7 @@ final public function run(): void
  $this,
  $this->runClassInSeparateProcess && !$this->runTestInSeparateProcess,
  $this->preserveGlobalState,
+ $this->requiresXdebug(),
  );
  }
 
@@ -2589,6 +2590,11 @@ private function requirementsNotSatisfied(): bool
  return (new Requirements)->requirementsNotSatisfiedFor(static::class, $this->methodName) !== [];
  }
 
+ private function requiresXdebug(): bool
+ {
+ return (new Requirements)->requiresXdebug(static::class, $this->methodName);
+ }
+
  /**
  * @see https://github.com/sebastianbergmann/phpunit/issues/6095
  */

src/Framework/TestRunner/IsolatedTestRunner.php

@@ -16,5 +16,5 @@
  */
 interface IsolatedTestRunner
 {
- public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalState): void;
+ public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalState, bool $requiresXdebug): void;
 }

src/Framework/TestRunner/IsolatedTestRunnerRegistry.php

@@ -18,13 +18,13 @@ final class IsolatedTestRunnerRegistry
 {
  private static ?IsolatedTestRunner $runner = null;
 
- public static function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalState): void
+ public static function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalState, bool $requiresXdebug): void
  {
  if (self::$runner === null) {
  self::$runner = new SeparateProcessTestRunner;
  }
 
- self::$runner->run($test, $runEntireClass, $preserveGlobalState);
+ self::$runner->run($test, $runEntireClass, $preserveGlobalState, $requiresXdebug);
  }
 
  public static function set(IsolatedTestRunner $runner): void

src/Framework/TestRunner/SeparateProcessTestRunner.php

@@ -44,7 +44,7 @@ final class SeparateProcessTestRunner implements IsolatedTestRunner
  * @throws NoPreviousThrowableException
  * @throws ProcessIsolationException
  */
- public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalState): void
+ public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalState, bool $requiresXdebug): void
  {
  $class = new ReflectionClass($test);
 
@@ -139,7 +139,7 @@ public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalSt
 
  assert($code !== '');
 
- JobRunnerRegistry::runTestJob(new Job($code), $processResultFile, $test);
+ JobRunnerRegistry::runTestJob(new Job($code, requiresXdebug: $requiresXdebug), $processResultFile, $test);
 
  @unlink($serializedConfiguration);
  }

src/Metadata/Api/Requirements.php

@@ -170,4 +170,17 @@ public function requirementsNotSatisfiedFor(string $className, string $methodNam
 
  return $notSatisfied;
  }
+
+ public function requiresXdebug(string $className, string $methodName): bool
+ {
+ foreach (Registry::parser()->forClassAndMethod($className, $methodName) as $metadata) {
+ if ($metadata->isRequiresPhpExtension()) {
+ if ($metadata->extension() === 'xdebug') {
+ return true;
+ }
+ }
+ }
+
+ return false;
+ }
 }

src/Util/PHP/DefaultJobRunner.php

@@ -66,6 +66,7 @@ public function run(Job $job): Result
  $job->arguments(),
  null,
  $job->redirectErrors(),
+ $job->requiresXdebug(),
  );
  }
 
@@ -192,8 +193,12 @@ private function buildCommand(Job $job, ?string $file): array
  ),
  );
 
- if (!CodeCoverage::instance()->isActive() &&
- xdebug_is_debugger_active() === false) {
+ if (
+ !CodeCoverage::instance()->isActive() &&
+ xdebug_is_debugger_active() === false &&
+ !$job->requiresXdebug()
+ ) {
+ // disable xdebug to speedup test execution
  $phpSettings['xdebug.mode'] = 'xdebug.mode=off';
  }
  }

src/Util/PHP/Job.php

@@ -43,6 +43,7 @@
  */
  private ?string $input;
  private bool $redirectErrors;
+ private bool $requiresXdebug;
 
  /**
  * @param non-empty-string $code
@@ -51,14 +52,15 @@
  * @param list<non-empty-string> $arguments
  * @param ?non-empty-string $input
  */
- public function __construct(string $code, array $phpSettings = [], array $environmentVariables = [], array $arguments = [], ?string $input = null, bool $redirectErrors = false)
+ public function __construct(string $code, array $phpSettings = [], array $environmentVariables = [], array $arguments = [], ?string $input = null, bool $redirectErrors = false, bool $requiresXdebug = false)
  {
  $this->code = $code;
  $this->phpSettings = $phpSettings;
  $this->environmentVariables = $environmentVariables;
  $this->arguments = $arguments;
  $this->input = $input;
  $this->redirectErrors = $redirectErrors;
+ $this->requiresXdebug = $requiresXdebug;
  }
 
  /**
@@ -135,4 +137,9 @@ public function redirectErrors(): bool
  {
  return $this->redirectErrors;
  }
+
+ public function requiresXdebug(): bool
+ {
+ return $this->requiresXdebug;
+ }
 }

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

@@ -0,0 +1,24 @@
+--TEST--
+https://github.com/sebastianbergmann/phpunit/issues/6105
+--SKIPIF--
+<?php if(!extension_loaded('xdebug')) {
+ print 'skip: xdebug is not loaded';
+}
+--FILE--
+<?php declare(strict_types=1);
+$_SERVER['argv'][] = '--do-not-cache-result';
+$_SERVER['argv'][] = __DIR__ . '/6105/IssueTest6105.php';
+
+require_once __DIR__ . '/../../bootstrap.php';
+(new PHPUnit\TextUI\Application)->run($_SERVER['argv']);
+--EXPECTF--
+PHPUnit %s by Sebastian Bergmann and contributors.
+
+Runtime: %s
+Configuration: %s
+
+.. 2 / 2 (100%)
+
+Time: %s, Memory: %s
+
+OK (2 tests, 3 assertions)

tests/end-to-end/regression/6105/IssueTest6105.php

@@ -0,0 +1,40 @@
+<?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 IssueTest6105;
+
+use function header;
+use function ob_get_clean;
+use function ob_start;
+use PHPUnit\Framework\Attributes\CoversNothing;
+use PHPUnit\Framework\Attributes\RequiresPhpExtension;
+use PHPUnit\Framework\Attributes\RunInSeparateProcess;
+use PHPUnit\Framework\TestCase;
+
+#[CoversNothing]
+class IssueTest6105 extends TestCase
+{
+ public function test_1(): void
+ {
+ $this->assertTrue(true);
+ }
+
+ #[RunInSeparateProcess]
+ #[RequiresPhpExtension('xdebug')]
+ public function test_case_2_check(): void
+ {
+ ob_start();
+ header('X-Test: Testing');
+ print 'asd';
+ $content = ob_get_clean();
+
+ $this->assertSame('asd', $content);
+ $this->assertSame(['X-Test: Testing'], xdebug_get_headers());
+ }
+}