Set XDEBUG_MODE for processes with coverage

.github/workflows/ci.yaml

@@ -37,7 +37,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           coverage: ${{ matrix.coverage-driver }}
-          ini-values: memory_limit=512M
+          ini-values: memory_limit=512M, xdebug.mode=off
           tools: composer:v2
 
       - name: Get composer cache directory

devTools/phpstan-src.neon

@@ -51,6 +51,9 @@ parameters:
         -
             path: '../src/FileSystem/DummyFileSystem.php'
             message: '#Infection\\FileSystem\\DummyFileSystem#'
+        -
+            path: '../src/Process/CoveredPhpProcess.php'
+            message: '#Function ini_get is unsafe to use#'
     level: max
     paths:
         - ../src

devTools/phpstan-tests.neon

@@ -26,6 +26,9 @@ parameters:
             message: "#^Variable method call on Infection\\\\Tests\\\\FileSystem\\\\Finder\\\\MockVendor\\.$#"
             count: 1
             path: ../tests/phpunit/FileSystem/Finder/TestFrameworkFinderTest.php
+        -
+            message: '#Function ini_get is unsafe to use#'
+            path: ../tests/phpunit/Process/CoveredPhpProcessTest.php
     level: 4
     paths:
         - ../tests/phpunit

devTools/xdebug-coverage.ini

@@ -1 +1 @@
-xdebug.mode=coverage
+xdebug.mode=off

src/Process/CoveredPhpProcess.php

@@ -0,0 +1,75 @@
+<?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 Composer\XdebugHandler\XdebugHandler;
+use function ini_get as ini_get_unsafe;
+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. We add this variable if we know that Xdebug was offloaded, or
+ * if we know Xdebug is loaded since we can't know it coverage option is enabled (setting
+ * XDEBUG_MODE won't change xdebug.mode).
+ */
+final class CoveredPhpProcess extends Process
+{
+    /**
+     * @param array<string|bool>|null $env
+     */
+    public function start(?callable $callback = null, ?array $env = null): void
+    {
+
+        if (
+            XdebugHandler::getSkippedVersion() !== '' ||
+            // Any other value but false means Xdebug 3 is loaded. Xdebug 2 didn't have
+            // it too, but it has coverage enabled at all times.
+            ini_get_unsafe('xdebug.mode') !== false
+        ) {
+            $env = array_merge($env ?? [], [
+                'XDEBUG_MODE' => 'coverage',
+            ]);
+        }
+
+        parent::start($callback, $env ?? []);
+    }
+}

src/Process/Factory/InitialTestsRunProcessFactory.php

@@ -37,6 +37,7 @@
 
 use Composer\InstalledVersions;
 use Infection\AbstractTestFramework\TestFrameworkAdapter;
+use Infection\Process\CoveredPhpProcess;
 use Infection\Process\OriginalPhpProcess;
 use function method_exists;
 use Symfony\Component\Process\Process;
@@ -66,7 +67,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(

tests/phpunit/Process/CoveredPhpProcessTest.php

@@ -0,0 +1,75 @@
+<?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 Composer\XdebugHandler\XdebugHandler;
+use Infection\Process\CoveredPhpProcess;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Process\Process;
+use function ini_get as ini_get_unsafe;
+
+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(null, ['TESTING' => 'test']);
+
+        if (XdebugHandler::getSkippedVersion() !== '' || ini_get_unsafe('xdebug.mode') !== false) {
+            $this->assertStringContainsString('XDEBUG_MODE=coverage', $process->getOutput());
+        } else {
+            $this->assertStringNotContainsString('XDEBUG_MODE=coverage', $process->getOutput());
+        }
+
+        $this->assertStringContainsString('TESTING=test', $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