Tentative support for php-code-coverage 10

Author: dvdoug

.github/workflows/ci.yml

@@ -83,8 +83,8 @@ jobs:
         path: |
           ${{ steps.composercache.outputs.dir }}
           "build/php-code-coverage-cache"
-        key: "php-${{ matrix.php-version }}-deps-${{ matrix.dependencies }}-${{ hashFiles('composer.json') }}"
-        restore-keys: "php-${{ matrix.php-version }}-deps-${{ matrix.dependencies }}"
+        key: "php-${{ matrix.php-version }}-deps-${{ matrix.dependencies }}-php-code-coverage-${{ matrix.php-code-coverage-version }}-symfony-${{ matrix.symfony }}-${{ hashFiles('composer.json') }}"
+        restore-keys: "php-${{ matrix.php-version }}-deps-${{ matrix.dependencies }}-php-code-coverage-${{ matrix.php-code-coverage-version }}-symfony-${{ matrix.symfony }}"
 
     - name: Force Symfony version
       if: matrix.symfony-version != ''
@@ -107,17 +107,22 @@ jobs:
 
     - name: Install dependencies (low)
       if: matrix.dependencies == 'lowest'
-      run: composer update --prefer-lowest --no-interaction --prefer-dist
+      run: |
+        composer update --prefer-lowest --no-interaction --prefer-dist;
+        composer show;
 
     - name: Install dependencies (high)
       if: matrix.dependencies == 'highest'
-      run: composer update --no-interaction --prefer-dist
+      run: |
+        composer update --no-interaction --prefer-dist;
+        composer show;
 
     - name: Install dependencies (force latest)
       if: matrix.dependencies == 'force_latest'
       run: |
         composer config minimum-stability dev;
         composer update --no-interaction --prefer-dist --ignore-platform-reqs;
+        composer show;
 
     - name: Check code style
       if: matrix.php-version == '7.4' && matrix.symfony-version == '^5.0' && matrix.dependencies == 'highest'

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [Unreleased] - 2021-xx-xx
+### Added
+- Compatibility with `phpunit/php-code-coverage` v10.
+### Changed
+- Deprecated `processUncoveredFiles` setting, it has been removed as of php-code-coverage v10.
+
 ## [5.2.1] - 2021-01-10
 ### Fixed
 - When Xdebug was enabled, but its coverage feature was disabled an exception was thrown. This scenario is now treated
@@ -70,7 +76,7 @@
 
 [Unreleased]: https://github.com/dvdoug/behat-code-coverage/compare/v5.2.1...master
 
-[5.2.1]: https://github.com/dvdoug/behat-code-coverage/compare/v5.2.1...v5.2.1
+[5.2.1]: https://github.com/dvdoug/behat-code-coverage/compare/v5.2.0...v5.2.1
 [5.2.0]: https://github.com/dvdoug/behat-code-coverage/compare/v5.1.1...v5.2.0
 [5.1.1]: https://github.com/dvdoug/behat-code-coverage/compare/v5.1.0...v5.1.1
 [5.1.0]: https://github.com/dvdoug/behat-code-coverage/compare/v5.0.0...v5.1.0

behat.yml.dist

@@ -13,7 +13,6 @@ default:
           directories:
             'src': ~
         includeUncoveredFiles: true
-        processUncoveredFiles: false
       reports:
         cobertura:
           target: build/coverage-behat/cobertura.xml

composer.json

@@ -15,15 +15,15 @@
         "php": "^7.3 || ^8.0",
         "composer-runtime-api": "^2.0",
         "behat/behat": "^3.5",
-        "phpunit/php-code-coverage": "^9.2",
+        "phpunit/php-code-coverage": "^9.2||^10.0",
         "symfony/console": "^4.4||^5.0",
         "symfony/config": "^4.4||^5.0",
         "symfony/dependency-injection": "^4.4||^5.0",
         "symfony/event-dispatcher": "^4.4||^5.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.18.0",
-        "phpunit/phpunit": "^9.5.0",
+        "phpunit/phpunit": "^9.5.0||^10.0",
         "symfony/filesystem": "^4.4||^5.0"
     },
     "suggest": {

docs/configuration.rst

@@ -77,9 +77,10 @@ By default uncovered files are **included** but not **processed**.
   *processing*, the files will be loaded via an ``include()`` call and passed through the driver in exactly the same way as
   covered files are. However, not all files can be safely loaded in this way, for instance ``include()``\ing a script
   may have runtime side-effects. Because Behat Code Coverage cannot know the structure of your codebase and which files
-  are safe to ``include()`` and which are not, by default uncovered file processing is disabled for safety reasons. When
-  processing of uncovered files is disabled, a less-efficient and limited emulation of executable code detection is
-  performed out.
+  are safe to ``include()`` and which are not, by default uncovered file processing is disabled for safety reasons.
+
+  .. note::
+    The ``processUncoveredFiles`` setting has been removed in php-code-coverage v10, configuring it here is deprecated
 
 Reports
 -------

phpunit.xml.dist

@@ -15,7 +15,7 @@
     </testsuites>
 
   <!-- pathCoverage must be set false here for CI or PCOV/PHPDBG fail. It is enabled via CLI for Xdebug -->
-  <coverage pathCoverage="false" processUncoveredFiles="true" cacheDirectory="build/phpunit-cache/coverage">
+  <coverage pathCoverage="false" cacheDirectory="build/phpunit-cache/coverage">
 
     <include>
       <directory>src</directory>

src/Extension.php

@@ -11,6 +11,7 @@
 use Behat\Testwork\ServiceContainer\Extension as ExtensionInterface;
 use Behat\Testwork\ServiceContainer\ExtensionManager;
 use DVDoug\Behat\CodeCoverage\Subscriber\EventSubscriber;
+use ReflectionClass;
 use SebastianBergmann\CodeCoverage\CodeCoverage;
 use SebastianBergmann\CodeCoverage\Driver\Driver;
 use SebastianBergmann\CodeCoverage\Driver\Selector;
@@ -75,6 +76,7 @@ public function configure(ArrayNodeDefinition $builder): void
                         ->end()
                         ->scalarNode('processUncoveredFiles')
                             ->defaultFalse()
+                            ->setDeprecated('dvdoug/behat-code-coverage', '5.3', 'the processUncoveredFiles setting is deprecated, it has been removed from php-code-coverage v10')
                         ->end()
                         ->arrayNode('include')
                             ->addDefaultsIfNotSet()
@@ -250,10 +252,14 @@ public function initCodeCoverage(Filter $filter, array $filterConfig, ?bool $bra
             $codeCoverage->excludeUncoveredFiles();
         }
 
-        if ($filterConfig['processUncoveredFiles']) {
-            $codeCoverage->processUncoveredFiles();
-        } else {
-            $codeCoverage->doNotProcessUncoveredFiles();
+        $codeCoverageReflection = new ReflectionClass($codeCoverage);
+
+        if ($codeCoverageReflection->hasMethod('processUncoveredFiles')) {
+            if ($filterConfig['processUncoveredFiles']) {
+                $codeCoverage->processUncoveredFiles();
+            } else {
+                $codeCoverage->doNotProcessUncoveredFiles();
+            }
         }
 
         return $codeCoverage;