Improve code coverage collection

Author: acelaya

CHANGELOG.md

@@ -4,6 +4,23 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).
 
+## [4.0.0] - 2024-02-20
+### Added
+* Add support for PHPUnit 11
+
+### Changed
+* Simplify generating code coverage for CLI and API tests
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* *Nothing*
+
+
 ## [3.11.1] - 2024-02-18
 ### Added
 * *Nothing*

composer.json

@@ -14,17 +14,17 @@
     "require": {
         "php": "^8.2",
         "doctrine/data-fixtures": "^1.6",
-        "doctrine/orm": "^3.0 | ^2.18",
+        "doctrine/orm": "^3.0 || ^2.18",
         "fig/http-message-util": "^1.1",
         "guzzlehttp/guzzle": "^7.8",
-        "phpunit/php-code-coverage": "^10.1",
-        "phpunit/phpunit": "^10.5",
-        "psr/container": "^2.0 | ^1.0",
+        "phpunit/php-code-coverage": "^11.0 || ^10.1",
+        "phpunit/phpunit": "^11.0 || ^10.5",
+        "psr/container": "^2.0 || ^1.0",
         "psr/http-server-middleware": "^1.0",
         "shlinkio/shlink-json": "^1.0",
-        "symfony/console": "^7.0 | ^6.4",
-        "symfony/event-dispatcher": "^7.0 | ^6.4",
-        "symfony/process": "^7.0 | ^6.4"
+        "symfony/console": "^7.0 || ^6.4",
+        "symfony/event-dispatcher": "^7.0 || ^6.4",
+        "symfony/process": "^7.0 || ^6.4"
     },
     "require-dev": {
         "phpstan/phpstan": "^1.10",

src/CliTest/CliCoverageDelegator.php

@@ -4,7 +4,6 @@
 
 namespace Shlinkio\Shlink\TestUtils\CliTest;
 
-use Closure;
 use Psr\Container\ContainerInterface;
 use SebastianBergmann\CodeCoverage\CodeCoverage;
 use Symfony\Component\Console\Application;
@@ -16,7 +15,7 @@ class CliCoverageDelegator
 {
     public const COVERAGE_ID_ENV = 'COVERAGE_ID';
 
-    public function __construct(private readonly Closure $exportCoverage, private readonly ?CodeCoverage $coverage)
+    public function __construct(private readonly ?CodeCoverage $coverage)
     {
     }
 
@@ -26,7 +25,6 @@ public function __invoke(ContainerInterface $c, string $serviceName, callable $c
         $app = $callback();
         $wrappedEventDispatcher = new EventDispatcher();
         $coverage = $this->coverage;
-        $exportCoverage = $this->exportCoverage;
 
         // When the command starts, start collecting coverage
         $wrappedEventDispatcher->addListener(
@@ -42,11 +40,10 @@ static function () use (&$coverage): void {
         // When the command ends, stop collecting coverage and export it
         $wrappedEventDispatcher->addListener(
             'console.terminate',
-            static function () use (&$coverage, $exportCoverage): void {
+            static function () use (&$coverage): void {
                 $id = getenv(self::COVERAGE_ID_ENV);
                 if ($id && $coverage !== null) {
                     $coverage->stop();
-                    $exportCoverage('cli');
                 }
             },
         );

src/Helper/CoverageHelper.php

@@ -5,18 +5,16 @@
 namespace Shlinkio\Shlink\TestUtils\Helper;
 
 use PHPUnit\Framework\Attributes\Test;
-use PHPUnit\Runner\Version;
 use ReflectionMethod;
 use SebastianBergmann\CodeCoverage\CodeCoverage;
 use SebastianBergmann\CodeCoverage\Driver\Selector;
 use SebastianBergmann\CodeCoverage\Filter;
-use SebastianBergmann\CodeCoverage\Report\Html\Facade as Html;
 use SebastianBergmann\CodeCoverage\Report\PHP;
-use SebastianBergmann\CodeCoverage\Report\Xml\Facade as Xml;
 use SebastianBergmann\FileIterator\Facade as FileIteratorFacade;
 
 use function debug_backtrace;
-use function file_exists;
+use function microtime;
+use function register_shutdown_function;
 
 class CoverageHelper
 {
@@ -52,38 +50,30 @@ private static function resolveTestDataSet(string|int $dataName): string
         return ! empty($dataName) ? '#' . $dataName : '';
     }
 
-    public static function createCoverageForDirectories(array $dirs): CodeCoverage
-    {
+    /**
+     * @param string|null $shutdownExportBasePath - If provided, it will export coverage to this location on shutdown
+     */
+    public static function createCoverageForDirectories(
+        array $dirs,
+        ?string $shutdownExportBasePath = null,
+    ): CodeCoverage {
         $filter = new Filter();
         foreach ($dirs as $dir) {
             foreach ((new FileIteratorFacade())->getFilesAsArray($dir) as $file) {
                 $filter->includeFile($file);
             }
         }
 
-        return new CodeCoverage((new Selector())->forLineCoverage($filter), $filter);
-    }
+        $coverage = new CodeCoverage((new Selector())->forLineCoverage($filter), $filter);
 
-    public static function exportCoverage(
-        ?CodeCoverage $coverage,
-        string $basePath,
-        bool $pretty = false,
-        bool $mergeWithExisting = false,
-    ): void {
-        if ($coverage === null) {
-            return;
+        if ($shutdownExportBasePath !== null) {
+            register_shutdown_function(function () use ($shutdownExportBasePath, $coverage): void {
+                $id = (string) microtime(as_float: true);
+                $covPath = $shutdownExportBasePath . '/' . $id . '.cov';
+                (new PHP())->process($coverage, $covPath);
+            });
         }
 
-        $covPath = $basePath . '.cov';
-        if ($mergeWithExisting && file_exists($covPath)) {
-            $coverage->merge(require $covPath);
-        }
-
-        if ($pretty) {
-            (new Html())->process($coverage, $basePath . '/coverage-html');
-        } else {
-            (new PHP())->process($coverage, $covPath);
-            (new Xml(Version::getVersionString()))->process($coverage, $basePath . '/coverage-xml');
-        }
+        return $coverage;
     }
 }