Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disable Xdebug in subprocesses when it is not used #5989

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions src/Runner/PHPT/PhptTestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -906,8 +906,6 @@ private function settings(bool $collectCoverage): array
if (extension_loaded('xdebug')) {
if ($collectCoverage) {
$settings[] = 'xdebug.mode=coverage';
} else {
$settings[] = 'xdebug.mode=off';
}
}

Expand Down
9 changes: 9 additions & 0 deletions src/Util/PHP/DefaultJobRunner.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
use function tempnam;
use function trim;
use function unlink;
use PHPUnit\Runner\CodeCoverage;
use SebastianBergmann\Environment\Runtime;

/**
Expand Down Expand Up @@ -184,6 +185,14 @@ private function buildCommand(Job $job, ?string $file): array
array_keys($xdebugSettings),
),
);

// disable xdebug if not required to reduce xdebug performance overhead in subprocesses
if (
!CodeCoverage::instance()->isActive() &&
xdebug_is_debugger_active() === false
) {
$phpSettings['xdebug.mode'] = 'xdebug.mode=off';
}
}

$command = array_merge($command, $this->settingsToParameters($phpSettings));
Expand Down
23 changes: 23 additions & 0 deletions tests/end-to-end/event/_files/XdebugIsDisabled.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?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\Event;

use function extension_loaded;
use function ini_get;
use PHPUnit\Framework\TestCase;

final class XdebugIsDisabled extends TestCase
{
public function testOne(): void
{
$this->assertTrue(extension_loaded('xdebug'));
$this->assertSame('', (string) ini_get('xdebug.mode'));
Copy link
Contributor Author

@staabm staabm Oct 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when -d xdebug.mode=off is passed, xdebug.mode returns '':

➜  phpunit git:(xdebugsub) ✗ php -d 'xdebug.mode=off' test.php
string(0) ""
➜  phpunit git:(xdebugsub) ✗ php -d 'xdebug.mode=coverage' test.php
string(8) "coverage"
➜  phpunit git:(xdebugsub) ✗ cat test.php
<?php

var_dump((string) ini_get('xdebug.mode'));

}
}
38 changes: 38 additions & 0 deletions tests/end-to-end/event/process-isolation-disable-xdebug.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
--TEST--
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this test be moved in a different folder?

Subprocesses auto-disable xdebug when no debugger is attached.
--SKIPIF--
<?php declare(strict_types=1);
if (!extension_loaded('xdebug')) {
print 'skip: Extension xdebug must be loaded.';
} elseif (xdebug_is_debugger_active() === true) {
print 'skip: Debugger must not be attached.';
}

--FILE--
<?php declare(strict_types=1);
$_SERVER['argv'][] = '--do-not-cache-result';
$_SERVER['argv'][] = '--no-configuration';
$_SERVER['argv'][] = '--process-isolation';
$_SERVER['argv'][] = '--debug';
$_SERVER['argv'][] = __DIR__ . '/_files/XdebugIsDisabled.php';

require __DIR__ . '/../../bootstrap.php';

(new PHPUnit\TextUI\Application)->run($_SERVER['argv']);
--EXPECTF--
PHPUnit Started (PHPUnit %s using %s)
Test Runner Configured
Event Facade Sealed
Test Suite Loaded (1 test)
Test Runner Started
Test Suite Sorted
Test Runner Execution Started (1 test)
Test Suite Started (PHPUnit\TestFixture\Event\XdebugIsDisabled, 1 test)
Test Preparation Started (PHPUnit\TestFixture\Event\XdebugIsDisabled::testOne)
Test Prepared (PHPUnit\TestFixture\Event\XdebugIsDisabled::testOne)
Test Passed (PHPUnit\TestFixture\Event\XdebugIsDisabled::testOne)
Test Finished (PHPUnit\TestFixture\Event\XdebugIsDisabled::testOne)
Test Suite Finished (PHPUnit\TestFixture\Event\XdebugIsDisabled, 1 test)
Test Runner Execution Finished
Test Runner Finished
PHPUnit Finished (Shell Exit Code: 0)