Set XDEBUG_MODE for processes with coverage

[sanmai]

This PR:

• Follow up to Upgrade xdebug-handler to v2 and handle that coverage option is set #1510
• Set XDEBUG_MODE for processes with coverage so a user doesn't even have to know this knob exists
• Covered by tests
• Fixes For recent Xdebug coverage collection needs XDEBUG_MODE=coverage or xdebug.mode=coverage  #1473

Testing steps:

• Note how build failed on aa1e089 when we disabled Xdebug

Implementation notes:

• PHPUnit 9.4.2 doesn't really work well with Xdebug 3 (even with XDEBUG_MODE=coverage it emits a warning "xdebug.mode=coverage has to be set in php.ini" and fails to generate coverage). Upgrading to 9.5.10 fixes the problem.

[sidz]

we also support phpdbg

[sanmai]

I can add a check for it, but they are mutually exclusive. You can't use Xdebug with PHPDBG, IIRC, so whenever we export or not this variable does not matter.

On the contrary, you can have both Xdebug and PCOV. And that's why we're making sure of not breaking stuff.

[sidz]

I'm voting to add add phpdbg check to this condition.

[sanmai]

Fair enough. Added.

[sanmai]

I think I messed up something here. Let me take a day to check everything again.

[acasademont]

Would love to have this handled automatically, it's not a PITA to add the XDEBUG_MODE=coverage in front of the infection call, but it's a bit annoying having to add that variable for all infection when's something only needed for the intial test runs.

[acasademont]

And another thing we realized is that everything runs much slower if we set the XDEBUG_MODE=covefage on the infection call.

Previously we used a the --initial-tests-php-options="dxdebug.mode=coverage" but that causes some phpunit tests that need to run in a separate process to not have coverage enabled and fail.

So this patch would probably be the best solution.

[sanmai]

It doesn't make sense to check for an exact value of xdebug.mode here because it is not affected by XDEBUG_MODE.

[maks-rafalko]

not sure I understand this block.

1. Why is it needed to pass XDEBUG_MODE=coverage when pcov is loaded, for example?
2. In the end the user is still in control: they can provide XDEBUG_MODE=coverage on their own. - is it true? If user passes XDEBUG_MODE=debug and Xdebug is loaded (with, let's say, off mode), then this new code will override it by XDEBUG_MODE=coverage, no?

[sanmai]

1. This was a mistake, now corrected.
2. I meant that if a user wants to use Xdebug to collect coverage, they can provide XDEBUG_MODE=coverage even if they have PCOV loaded. We can't guarantee other tools will pick this up, but at least we're not standing in the way.
3. XDEBUG_MODE=debug is no use for us, we have to override it with XDEBUG_MODE=coverage

[sanmai]

OK, all should be much more clear in shallExtendEnvironmentWithXdebugMode below.

[maks-rafalko]

I think it should be && but not || between all the conditions.

Otherwise, if the current case is phpdbg, the this first condition will result to true and XDEBUG_MODE=coverage will be added

[maks-rafalko]

as in #1518 (comment), seems like here || also probably needs to be replaced with &&

[sanmai]

Yeah, we need to properly DI test this, without this extension_loaded nonsense.

[sanmai]

Three weeks later DI stuff isn't here, but it looks like I was able to figure it out: here we assume that
XDEBUG_MODE=coverage is set unless we're running with PCOV, or under PHPDBG, or with Xdebug <3. Checking for XdebugHandler here is a foul business: we never invoke it for tests.

[sanmai]

🤞

[maks-rafalko]

👏 looks more clear now

[alfredbez]

I'm getting an error since this change was merged and released:

Infection - PHP Mutation Testing Framework version 0.25.4.0


Fatal error: Uncaught Error: Call to undefined method Composer\XdebugHandler\XdebugHandler::isXdebugActive() in phar:///usr/local/bin/infection/src/TestFramework/Coverage/CoverageChecker.php:99
Stack trace:
#0 phar:///usr/local/bin/infection/src/TestFramework/Coverage/CoverageChecker.php(47): _HumbugBox75a5b98e45f1\Infection\TestFramework\Coverage\CoverageChecker->hasCoverageGeneratorEnabled()
#1 phar:///usr/local/bin/infection/src/Command/RunCommand.php(140): _HumbugBox75a5b98e45f1\Infection\TestFramework\Coverage\CoverageChecker->checkCoverageRequirements()
#2 phar:///usr/local/bin/infection/src/Command/RunCommand.php(72): _HumbugBox75a5b98e45f1\Infection\Command\RunCommand->startUp(Object(_HumbugBox75a5b98e45f1\Infection\Container), Object(_HumbugBox75a5b98e45f1\Infection\Console\ConsoleOutput), Object(_HumbugBox75a5b98e45f1\Infection\Logger\ConsoleLogger), Object(_HumbugBox75a5b98e45f1\Infection\Console\IO))
#3 phar:///usr/local/bin/infection/src/Command/BaseCommand.php(28): _HumbugBox75a5b98e45f1\Infection\Command\Ru in phar:///usr/local/bin/infection/src/TestFramework/Coverage/CoverageChecker.php on line 99

My Dockerfile looks like this:

FROM php:7.4-alpine

RUN apk --no-cache add pcre-dev ${PHPIZE_DEPS} \
  && pecl install xdebug \
  && docker-php-ext-enable xdebug \
  && apk del pcre-dev ${PHPIZE_DEPS}

RUN wget https://github.com/infection/infection/releases/download/0.25.4/infection.phar \
    && wget https://github.com/infection/infection/releases/download/0.25.4/infection.phar.asc \
    && chmod +x infection.phar \
    && mv infection.phar /usr/local/bin/infection

The same behaviour occurs in all future releases after 0.25.4.

---

I've extracted the phar and checked how that looks inside:

/tmp/usr/local/bin/infection $ php -r '$v = require_once("vendor/composer/installed.php"); echo $v["versions"]["composer/xdebug-handler"]["version"] . PHP_EOL;'
2.0.0.0
/tmp/usr/local/bin/infection $ grep isXdebugActive vendor/composer/xdebug-handler/src/XdebugHandler.php
    public static function isXdebugActive()
/tmp/usr/local/bin/infection $

---

Am I doing something wrong?