XDebug environment variable takes precedence over ini option

[HorvathPeterHub]

Issue: XDebug code coverage not working with "php -dxdebug.mode=coverage" option

Description:

I'm trying to run PHPUnit tests with code coverage in PhpStorm. I use the following command:

php -dxdebug.mode=coverage /app/vendor/phpunit/phpunit/phpunit --coverage-clover /opt/phpstorm-coverage/Packages@ArrayTest.xml --configuration /app/lib/MyProject/phpunit.xml --filter Horvathpeter\\MyProject\\Test\\MyTest --test-suffix MyTest.php /app/vendor/horvathpeter/myproject/test --teamcity

However, even though the -dxdebug.mode=coverage option is passed, I still get a warning that XDEBUG_MODE=coverage or xdebug.mode=coverage has to be set. And the code coverage dialog does not appear.

Upon checking the PHPUnit code, I found that it checks for the XDEBUG_MODE environment variable first, before checking the xdebug.mode ini option. And even though the ini option is passed, it still checks for the environment variable, which is set in my case to something else.

Here's the relevant code from PHPUnit:

$mode = getenv('XDEBUG_MODE');

if ($mode === false || $mode === '') {
    $mode = ini_get('xdebug.mode');
}

if ($mode === false ||
    !in_array('coverage', explode(',', $mode), true)) {
    throw new Xdebug3NotEnabledException;
}

I checked the environment variables using var_dump(getenv('XDEBUG_MODE')); and found that it is set to debug,develop.

It seems that the getenv() function takes precedence over the -dxdebug.mode option. Can this behavior be changed so that the passed ini option takes precedence over the environment variable?

Expected result:

The -dxdebug.mode=coverage option should enable code coverage without the need for setting the XDEBUG_MODE environment variable.

Actual result:

The -dxdebug.mode=coverage option is not recognized as enabling code coverage, and the XDEBUG_MODE environment variable needs to be set.

Environment:

PHP version: 8.2.1
XDebug version: 3.2.0
PHPUnit version: 9.6.5

[sebastianbergmann]

Here's the relevant code from PHPUnit:

That code is not in PHPUnit but in php-code-coverage.

[HorvathPeterHub]

Yes, you're right. But is the ticket good here? Or should I submit it somewhere else?
Update: now I see, you've transferred it.

[sebastianbergmann]

I already moved it.

[outdooracorn]

I'm also experiencing this problem while using PhpStorm's code coverage feature. Is this something that is likely to be addressed? Thanks

PHP version: 8.3.14
XDebug version: 3.4.0
PHPUnit version: 9.6.21

[sebastianbergmann]

I do not plan to make any changes to PHPUnit 9.6 (and its dependencies) anymore aside from keeping them compatible with new versions of PHP.