Require xdebug_info('mode') to work when Xdebug is used

Author: sebastianbergmann

ChangeLog-12.0.md

@@ -13,5 +13,6 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
 * Methods `CodeCoverage::includeUncoveredFiles()` and `CodeCoverage::excludeUncoveredFiles()`
 * Optional argument `$linesToBeUsed` of `CodeCoverage::stop()` and `CodeCoverage::append()` methods
 * This component is no longer supported on PHP 8.2
+* This component no longer supports Xdebug versions before Xdebug 3.1
 
 [12.0.0]: https://github.com/sebastianbergmann/php-code-coverage/compare/11.0...main

src/Driver/Selector.php

@@ -21,6 +21,7 @@ final class Selector
      * @throws PcovNotAvailableException
      * @throws XdebugNotAvailableException
      * @throws XdebugNotEnabledException
+     * @throws XdebugVersionNotSupportedException
      */
     public function forLineCoverage(Filter $filter): Driver
     {
@@ -45,6 +46,7 @@ public function forLineCoverage(Filter $filter): Driver
      * @throws NoCodeCoverageDriverWithPathCoverageSupportAvailableException
      * @throws XdebugNotAvailableException
      * @throws XdebugNotEnabledException
+     * @throws XdebugVersionNotSupportedException
      */
     public function forLineAndPathCoverage(Filter $filter): Driver
     {

src/Driver/XdebugDriver.php

@@ -14,11 +14,8 @@
 use const XDEBUG_CC_UNUSED;
 use const XDEBUG_FILTER_CODE_COVERAGE;
 use const XDEBUG_PATH_INCLUDE;
-use function explode;
 use function extension_loaded;
-use function getenv;
 use function in_array;
-use function ini_get;
 use function phpversion;
 use function version_compare;
 use function xdebug_get_code_coverage;
@@ -65,11 +62,11 @@ final class XdebugDriver extends Driver
     /**
      * @throws XdebugNotAvailableException
      * @throws XdebugNotEnabledException
+     * @throws XdebugVersionNotSupportedException
      */
     public function __construct(Filter $filter)
     {
         $this->ensureXdebugIsAvailable();
-        $this->ensureXdebugCodeCoverageFeatureIsEnabled();
 
         if (!$filter->isEmpty()) {
             xdebug_set_filter(
@@ -127,35 +124,20 @@ public function nameAndVersion(): string
 
     /**
      * @throws XdebugNotAvailableException
+     * @throws XdebugNotEnabledException
+     * @throws XdebugVersionNotSupportedException
      */
     private function ensureXdebugIsAvailable(): void
     {
         if (!extension_loaded('xdebug')) {
             throw new XdebugNotAvailableException;
         }
-    }
-
-    /**
-     * @throws XdebugNotEnabledException
-     */
-    private function ensureXdebugCodeCoverageFeatureIsEnabled(): void
-    {
-        if (version_compare(phpversion('xdebug'), '3.1', '>=')) {
-            if (!in_array('coverage', xdebug_info('mode'), true)) {
-                throw new XdebugNotEnabledException;
-            }
-
-            return;
-        }
-
-        $mode = getenv('XDEBUG_MODE');
 
-        if ($mode === false || $mode === '') {
-            $mode = ini_get('xdebug.mode');
+        if (!version_compare(phpversion('xdebug'), '3.1', '>=')) {
+            throw new XdebugVersionNotSupportedException(phpversion('xdebug'));
         }
 
-        if ($mode === false ||
-            !in_array('coverage', explode(',', $mode), true)) {
+        if (!in_array('coverage', xdebug_info('mode'), true)) {
             throw new XdebugNotEnabledException;
         }
     }

src/Exception/XdebugVersionNotSupportedException.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of phpunit/php-code-coverage.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\CodeCoverage\Driver;
+
+use function sprintf;
+use RuntimeException;
+use SebastianBergmann\CodeCoverage\Exception;
+
+final class XdebugVersionNotSupportedException extends RuntimeException implements Exception
+{
+    /**
+     * @param non-empty-string $version
+     */
+    public function __construct(string $version)
+    {
+        parent::__construct(
+            sprintf(
+                'Version %s of the Xdebug extension is not supported',
+                $version,
+            ),
+        );
+    }
+}