Set XDEBUG_MODE for processes with coverage

.github/workflows/ci.yaml

@@ -24,6 +24,7 @@ jobs:
           - { operating-system: 'windows-latest', php-version: '7.4', dependencies: '', coverage-driver: 'xdebug' }
           - { operating-system: 'ubuntu-latest', php-version: '7.4', dependencies: '--prefer-lowest', coverage-driver: 'pcov' }
           - { operating-system: 'ubuntu-latest', php-version: '8.0', dependencies: '--ignore-platform-req=php', coverage-driver: 'pcov' }
+          - { operating-system: 'ubuntu-latest', php-version: '7.4', dependencies: '', coverage-driver: 'xdebug2' }
 
     continue-on-error: ${{ matrix.php-version == '8.0' }}
     name: CI on ${{ matrix.operating-system }} with PHP ${{ matrix.php-version }}, using ${{ matrix.coverage-driver }} ${{ matrix.dependencies }}

devTools/Dockerfile-php74-xdebug

@@ -28,7 +28,7 @@ RUN apk add --no-cache \
         zip
 
 COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
-COPY devTools/memory-limit.ini devTools/xdebug-coverage.ini ${PHP_INI_DIR}/conf.d/
+COPY devTools/memory-limit.ini ${PHP_INI_DIR}/conf.d/
 
 RUN adduser -h /opt/infection -s /bin/bash -D infection
 

devTools/Dockerfile-php80-xdebug

@@ -27,7 +27,7 @@ RUN apk add --no-cache \
         zip
 
 COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
-COPY devTools/memory-limit.ini devTools/xdebug-coverage.ini ${PHP_INI_DIR}/conf.d/
+COPY devTools/memory-limit.ini ${PHP_INI_DIR}/conf.d/
 
 RUN adduser -h /opt/infection -s /bin/bash -D infection
 

devTools/phpstan-src-baseline.neon

@@ -255,6 +255,11 @@ parameters:
 			count: 1
 			path: ../src/PhpParser/Visitor/ReflectionVisitor.php
 
+		-
+			message: "#^Parameter \\#2 \\$env \\(array\\<bool\\|string\\>\\|null\\) of method Infection\\\\Process\\\\CoveredPhpProcess\\:\\:start\\(\\) should be contravariant with parameter \\$env \\(array\\) of method Symfony\\\\Component\\\\Process\\\\Process\\:\\:start\\(\\)$#"
+			count: 1
+			path: ../src/Process/CoveredPhpProcess.php
+
 		-
 			message: "#^Parameter \\#2 \\$env \\(array\\<bool\\|string\\>\\|null\\) of method Infection\\\\Process\\\\OriginalPhpProcess\\:\\:start\\(\\) should be contravariant with parameter \\$env \\(array\\) of method Symfony\\\\Component\\\\Process\\\\Process\\:\\:start\\(\\)$#"
 			count: 1

devTools/phpstan-tests.neon

@@ -16,7 +16,7 @@ parameters:
         - '#^Cannot call method (willReturn|shouldBeCalledTimes)\(\) on iterable<Infection\\Mutation\\Mutation>\.$#'
         - '#Offset .*\\.* does not exist on array<class-string<.*>.*#'
         - '#Dynamic call to static method PHPUnit\\Framework\\.*::.*#'
-        - '#Call to method PHPUnit\\Framework\\Assert::.* with array.* and array.* will always evaluate to false#'
+        - '#Call to method PHPUnit\\Framework\\Assert::.* with .* and .* will always evaluate to (false|true)#'
         - '#^PHPDoc tag @var for variable \$sourceFilesCollectorProphecy contains unresolvable type#'
         -
             path: '../tests/phpunit/TestFramework/PhpUnit/Config/Builder/InitialConfigBuilderTest.php'

src/Process/CoveredPhpProcess.php

@@ -0,0 +1,68 @@
+<?php
+/**
+ * This code is licensed under the BSD 3-Clause License.
+ *
+ * Copyright (c) 2017, Maks Rafalko
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+declare(strict_types=1);
+
+namespace Infection\Process;
+
+use function array_merge;
+use function extension_loaded;
+use Symfony\Component\Process\Process;
+
+/**
+ * @internal
+ *
+ * Process which setups necessary environment variables to make coverage reporting happen
+ * without any extra user interaction.
+ *
+ * As of now we only cover Xdebug, adding XDEBUG_MODE environment variable to ensure it
+ * is properly activated. Since we can't know if Xdebug was offloaded, we add this env
+ * variable at most times, except when there's PCOV loaded: chances are Xdebug is not
+ * required when PCOV already used for coverage.
+ */
+final class CoveredPhpProcess extends Process
+{
+    /**
+     * @param array<string|bool>|null $env
+     */
+    public function start(?callable $callback = null, ?array $env = null): void
+    {
+        if (!extension_loaded('pcov')) {
+            $env = array_merge($env ?? [], [
+                'XDEBUG_MODE' => 'coverage',
+            ]);
+        }
+
+        parent::start($callback, $env ?? []);
+    }
+}

src/Process/Factory/InitialTestsRunProcessFactory.php

@@ -36,6 +36,7 @@
 namespace Infection\Process\Factory;
 
 use Infection\AbstractTestFramework\TestFrameworkAdapter;
+use Infection\Process\CoveredPhpProcess;
 use Infection\Process\OriginalPhpProcess;
 use function method_exists;
 use Symfony\Component\Process\Process;
@@ -64,7 +65,7 @@ public function createProcess(
         bool $skipCoverage
     ): Process {
         // If we're expecting to receive a code coverage, test process must run in a vanilla environment
-        $processClass = $skipCoverage ? Process::class : OriginalPhpProcess::class;
+        $processClass = $skipCoverage ? CoveredPhpProcess::class : OriginalPhpProcess::class;
 
         /** @var Process $process */
         $process = new $processClass(

src/TestFramework/Coverage/CoverageChecker.php

@@ -103,7 +103,7 @@ public function checkCoverageRequirements(): void
 Coverage needs to be generated but no code coverage generator (pcov, phpdbg or xdebug) has been detected. Please either:
 - Enable pcov and run Infection again
 - Use phpdbg, e.g. `phpdbg -qrr infection`
-- Enable Xdebug (in case of using Xdebug 3 check that `xdebug.mode` or environment variable XDEBUG_MODE set to `coverage`) and run Infection again
+- Enable Xdebug and run Infection again
 - Use the "--coverage" option with path to the existing coverage report
 - Enable the code generator tool for the initial test run only, e.g. with `--initial-tests-php-options -d zend_extension=xdebug.so`
 TXT

tests/phpunit/Process/CoveredPhpProcessTest.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ * This code is licensed under the BSD 3-Clause License.
+ *
+ * Copyright (c) 2017, Maks Rafalko
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+declare(strict_types=1);
+
+namespace Infection\Tests\Process;
+
+use function extension_loaded;
+use Infection\Process\CoveredPhpProcess;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Process\Process;
+
+final class CoveredPhpProcessTest extends TestCase
+{
+    public function test_it_extends_symfony_process(): void
+    {
+        $process = new CoveredPhpProcess([]);
+
+        $this->assertInstanceOf(Process::class, $process);
+    }
+
+    public function test_it_takes_command_line(): void
+    {
+        $process = new CoveredPhpProcess(['foo']);
+        $this->assertStringContainsString('foo', $process->getCommandLine());
+    }
+
+    /**
+     * @group integration
+     */
+    public function test_it_injects_xdebug_env_vars(): void
+    {
+        $process = new CoveredPhpProcess(['env']);
+        $process->run();
+
+        if (!extension_loaded('pcov')) {
+            $this->assertStringContainsString('XDEBUG_MODE=coverage', $process->getOutput());
+        } else {
+            $this->assertStringNotContainsString('XDEBUG_MODE=coverage', $process->getOutput());
+        }
+    }
+}

tests/phpunit/Process/Factory/InitialTestsRunProcessFactoryTest.php

@@ -36,6 +36,7 @@
 namespace Infection\Tests\Process\Factory;
 
 use Infection\AbstractTestFramework\TestFrameworkAdapter;
+use Infection\Process\CoveredPhpProcess;
 use Infection\Process\Factory\InitialTestsRunProcessFactory;
 use Infection\Process\OriginalPhpProcess;
 use const PHP_OS_FAMILY;
@@ -86,6 +87,7 @@ public function test_it_creates_a_process_with_coverage_skipped(): void
 
         $this->assertNull($process->getTimeout());
         $this->assertNotInstanceOf(OriginalPhpProcess::class, $process);
+        $this->assertInstanceOf(CoveredPhpProcess::class, $process);
     }
 
     public function test_it_creates_a_process_with_coverage(): void

tests/phpunit/TestFramework/Coverage/CoverageCheckerTest.php

@@ -142,7 +142,7 @@ public function test_it_needs_code_coverage_generator_enabled_if_coverage_is_not
 Coverage needs to be generated but no code coverage generator (pcov, phpdbg or xdebug) has been detected. Please either:
 - Enable pcov and run Infection again
 - Use phpdbg, e.g. `phpdbg -qrr infection`
-- Enable Xdebug (in case of using Xdebug 3 check that `xdebug.mode` or environment variable XDEBUG_MODE set to `coverage`) and run Infection again
+- Enable Xdebug and run Infection again
 - Use the "--coverage" option with path to the existing coverage report
 - Enable the code generator tool for the initial test run only, e.g. with `--initial-tests-php-options -d zend_extension=xdebug.so`
 TXT

tests/phpunit/TestFramework/Coverage/JUnit/TestLocationBucketSorterTest.php

@@ -189,7 +189,7 @@ public function test_it_sorts_faster_than_quicksort(ArrayIterator $uniqueTestLoc
             $totalQuickSort += microtime(true) - $start;
         }
 
-        $this->assertGreaterThanOrEqual(0.01, abs($totalQuickSort - $totalBucketSort));
+        $this->assertGreaterThanOrEqual(0.001, abs($totalQuickSort - $totalBucketSort));
     }
 
     public static function locationsArrayProvider(): iterable