Implement --force-coverage-cache CLI option

sebastianbergmann · sebastianbergmann · commit 4f7a13debfef · 2020-09-25T14:39:45.000+02:00
diff --git a/ChangeLog-9.4.md b/ChangeLog-9.4.md
@@ -8,6 +8,7 @@ All notable changes of the PHPUnit 9.4 release series are documented in this fil
 
 * [#4464](https://github.com/sebastianbergmann/phpunit/issues/4464): Filter based on covered (`@covers`) / used (`@uses`) units of code
 * [#4467](https://github.com/sebastianbergmann/phpunit/issues/4467): Convenient custom comparison of objects
+* Added `--force-coverage-cache` CLI option for configuring the code coverage static analysis cache to not check whether cache files exist and are up-to-date (do not use this if you do not need it or cannot guarantee that the cache files exist and are up-to-date)
 
 ### Changed
 
diff --git a/composer.json b/composer.json
@@ -20,6 +20,7 @@
         "issues": "https://github.com/sebastianbergmann/phpunit/issues"
     },
     "prefer-stable": true,
+    "minimum-stability": "dev",
     "require": {
         "php": ">=7.3",
         "ext-dom": "*",
@@ -33,7 +34,7 @@
         "phar-io/manifest": "^2.0.1",
         "phar-io/version": "^3.0.2",
         "phpspec/prophecy": "^1.11.1",
-        "phpunit/php-code-coverage": "^9.1.11",
+        "phpunit/php-code-coverage": "^9.2",
         "phpunit/php-file-iterator": "^3.0.4",
         "phpunit/php-invoker": "^3.1",
         "phpunit/php-text-template": "^2.0.2",
diff --git a/src/Framework/TestCase.php b/src/Framework/TestCase.php
@@ -811,6 +811,7 @@ public function run(TestResult $result = null): TestResult
             $codeCoverage               = $result->getCodeCoverage();
             $codeCoverageFilter         = null;
             $cachesStaticAnalysis       = 'false';
+            $forcesStaticAnalysisCache  = 'false';
             $codeCoverageCacheDirectory = null;
             $driverMethod               = 'forLineCoverage';
 
@@ -824,6 +825,10 @@ public function run(TestResult $result = null): TestResult
                 if ($codeCoverage->cachesStaticAnalysis()) {
                     $cachesStaticAnalysis       = 'true';
                     $codeCoverageCacheDirectory = $codeCoverage->cacheDirectory();
+
+                    if (!$codeCoverage->validatesStaticAnalysisCache()) {
+                        $forcesStaticAnalysisCache = 'true';
+                    }
                 }
             }
 
@@ -851,6 +856,7 @@ public function run(TestResult $result = null): TestResult
                 'className'                                  => $class->getName(),
                 'collectCodeCoverageInformation'             => $coverage,
                 'cachesStaticAnalysis'                       => $cachesStaticAnalysis,
+                'forcesStaticAnalysisCache'                  => $forcesStaticAnalysisCache,
                 'codeCoverageCacheDirectory'                 => $codeCoverageCacheDirectory,
                 'driverMethod'                               => $driverMethod,
                 'data'                                       => $data,
diff --git a/src/Runner/PhptTestCase.php b/src/Runner/PhptTestCase.php
@@ -174,19 +174,24 @@ public function run(TestResult $result = null): TestResult
 
         if ($result->getCollectCodeCoverageInformation()) {
             $codeCoverageCacheDirectory = null;
+            $forcesStaticAnalysisCache  = false;
             $pathCoverage               = false;
 
             $codeCoverage = $result->getCodeCoverage();
 
             if ($codeCoverage) {
                 if ($codeCoverage->cachesStaticAnalysis()) {
                     $codeCoverageCacheDirectory = $codeCoverage->cacheDirectory();
+
+                    if (!$codeCoverage->validatesStaticAnalysisCache()) {
+                        $forcesStaticAnalysisCache = true;
+                    }
                 }
 
                 $pathCoverage = $codeCoverage->collectsBranchAndPathCoverage();
             }
 
-            $this->renderForCoverage($code, $pathCoverage, $codeCoverageCacheDirectory);
+            $this->renderForCoverage($code, $pathCoverage, $codeCoverageCacheDirectory, $forcesStaticAnalysisCache);
         }
 
         $timer = new Timer;
@@ -595,7 +600,7 @@ private function getCoverageFiles(): array
         ];
     }
 
-    private function renderForCoverage(string &$job, bool $pathCoverage, ?string $codeCoverageCacheDirectory): void
+    private function renderForCoverage(string &$job, bool $pathCoverage, ?string $codeCoverageCacheDirectory, bool $forcesStaticAnalysisCache): void
     {
         $files = $this->getCoverageFiles();
 
@@ -639,6 +644,7 @@ private function renderForCoverage(string &$job, bool $pathCoverage, ?string $co
                 'coverageFile'               => $files['coverage'],
                 'driverMethod'               => $pathCoverage ? 'forLineAndPathCoverage' : 'forLineCoverage',
                 'codeCoverageCacheDirectory' => $codeCoverageCacheDirectory,
+                'forcesStaticAnalysisCache'  => $forcesStaticAnalysisCache ? 'true' : 'false',
             ]
         );
 
diff --git a/src/TextUI/CliArguments/Builder.php b/src/TextUI/CliArguments/Builder.php
@@ -41,6 +41,7 @@ final class Builder
         'configuration=',
         'coverage-cache=',
         'warm-coverage-cache',
+        'force-coverage-cache',
         'coverage-filter=',
         'coverage-clover=',
         'coverage-crap4j=',
@@ -152,6 +153,7 @@ public function fromParameters(array $parameters, array $additionalLongOptions):
         $configuration                              = null;
         $coverageCacheDirectory                     = null;
         $warmCoverageCache                          = null;
+        $forceCoverageCache                         = null;
         $coverageFilter                             = null;
         $coverageClover                             = null;
         $coverageCrap4J                             = null;
@@ -284,6 +286,11 @@ public function fromParameters(array $parameters, array $additionalLongOptions):
 
                     break;
 
+                case '--force-coverage-cache':
+                    $forceCoverageCache = true;
+
+                    break;
+
                 case '--coverage-clover':
                     $coverageClover = $option[1];
 
@@ -806,6 +813,7 @@ public function fromParameters(array $parameters, array $additionalLongOptions):
             $pathCoverage,
             $coverageCacheDirectory,
             $warmCoverageCache,
+            $forceCoverageCache,
             $debug,
             $defaultTimeLimit,
             $disableCodeCoverageIgnore,
diff --git a/src/TextUI/CliArguments/Configuration.php b/src/TextUI/CliArguments/Configuration.php
@@ -142,6 +142,11 @@ final class Configuration
      */
     private $warmCoverageCache;
 
+    /**
+     * @var ?bool
+     */
+    private $forceCoverageCache;
+
     /**
      * @var ?bool
      */
@@ -470,7 +475,7 @@ final class Configuration
     /**
      * @param null|int|string $columns
      */
-    public function __construct(?string $argument, ?string $atLeastVersion, ?bool $backupGlobals, ?bool $backupStaticAttributes, ?bool $beStrictAboutChangesToGlobalState, ?bool $beStrictAboutResourceUsageDuringSmallTests, ?string $bootstrap, ?bool $cacheResult, ?string $cacheResultFile, ?bool $checkVersion, ?string $colors, $columns, ?string $configuration, ?string $coverageClover, ?string $coverageCrap4J, ?string $coverageHtml, ?string $coveragePhp, ?string $coverageText, ?bool $coverageTextShowUncoveredFiles, ?bool $coverageTextShowOnlySummary, ?string $coverageXml, ?bool $pathCoverage, ?string $coverageCacheDirectory, ?bool $warmCoverageCache, ?bool $debug, ?int $defaultTimeLimit, ?bool $disableCodeCoverageIgnore, ?bool $disallowTestOutput, ?bool $disallowTodoAnnotatedTests, ?bool $enforceTimeLimit, ?array $excludeGroups, ?int $executionOrder, ?int $executionOrderDefects, ?array $extensions, ?array $unavailableExtensions, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?string $filter, ?bool $generateConfiguration, ?bool $migrateConfiguration, ?array $groups, ?array $testsCovering, ?array $testsUsing, ?bool $help, ?string $includePath, ?array $iniSettings, ?string $junitLogfile, ?bool $listGroups, ?bool $listSuites, ?bool $listTests, ?string $listTestsXml, ?string $loader, ?bool $noCoverage, ?bool $noExtensions, ?bool $noInteraction, ?bool $noLogging, ?string $printer, ?bool $processIsolation, ?int $randomOrderSeed, ?int $repeat, ?bool $reportUselessTests, ?bool $resolveDependencies, ?bool $reverseList, ?bool $stderr, ?bool $strictCoverage, ?bool $stopOnDefect, ?bool $stopOnError, ?bool $stopOnFailure, ?bool $stopOnIncomplete, ?bool $stopOnRisky, ?bool $stopOnSkipped, ?bool $stopOnWarning, ?string $teamcityLogfile, ?array $testdoxExcludeGroups, ?array $testdoxGroups, ?string $testdoxHtmlFile, ?string $testdoxTextFile, ?string $testdoxXmlFile, ?array $testSuffixes, ?string $testSuite, array $unrecognizedOptions, ?string $unrecognizedOrderBy, ?bool $useDefaultConfiguration, ?bool $verbose, ?bool $version, ?array $coverageFilter, ?string $xdebugFilterFile)
+    public function __construct(?string $argument, ?string $atLeastVersion, ?bool $backupGlobals, ?bool $backupStaticAttributes, ?bool $beStrictAboutChangesToGlobalState, ?bool $beStrictAboutResourceUsageDuringSmallTests, ?string $bootstrap, ?bool $cacheResult, ?string $cacheResultFile, ?bool $checkVersion, ?string $colors, $columns, ?string $configuration, ?string $coverageClover, ?string $coverageCrap4J, ?string $coverageHtml, ?string $coveragePhp, ?string $coverageText, ?bool $coverageTextShowUncoveredFiles, ?bool $coverageTextShowOnlySummary, ?string $coverageXml, ?bool $pathCoverage, ?string $coverageCacheDirectory, ?bool $warmCoverageCache, ?bool $forceCoverageCache, ?bool $debug, ?int $defaultTimeLimit, ?bool $disableCodeCoverageIgnore, ?bool $disallowTestOutput, ?bool $disallowTodoAnnotatedTests, ?bool $enforceTimeLimit, ?array $excludeGroups, ?int $executionOrder, ?int $executionOrderDefects, ?array $extensions, ?array $unavailableExtensions, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?string $filter, ?bool $generateConfiguration, ?bool $migrateConfiguration, ?array $groups, ?array $testsCovering, ?array $testsUsing, ?bool $help, ?string $includePath, ?array $iniSettings, ?string $junitLogfile, ?bool $listGroups, ?bool $listSuites, ?bool $listTests, ?string $listTestsXml, ?string $loader, ?bool $noCoverage, ?bool $noExtensions, ?bool $noInteraction, ?bool $noLogging, ?string $printer, ?bool $processIsolation, ?int $randomOrderSeed, ?int $repeat, ?bool $reportUselessTests, ?bool $resolveDependencies, ?bool $reverseList, ?bool $stderr, ?bool $strictCoverage, ?bool $stopOnDefect, ?bool $stopOnError, ?bool $stopOnFailure, ?bool $stopOnIncomplete, ?bool $stopOnRisky, ?bool $stopOnSkipped, ?bool $stopOnWarning, ?string $teamcityLogfile, ?array $testdoxExcludeGroups, ?array $testdoxGroups, ?string $testdoxHtmlFile, ?string $testdoxTextFile, ?string $testdoxXmlFile, ?array $testSuffixes, ?string $testSuite, array $unrecognizedOptions, ?string $unrecognizedOrderBy, ?bool $useDefaultConfiguration, ?bool $verbose, ?bool $version, ?array $coverageFilter, ?string $xdebugFilterFile)
     {
         $this->argument                                   = $argument;
         $this->atLeastVersion                             = $atLeastVersion;
@@ -497,6 +502,7 @@ public function __construct(?string $argument, ?string $atLeastVersion, ?bool $b
         $this->pathCoverage                               = $pathCoverage;
         $this->coverageCacheDirectory                     = $coverageCacheDirectory;
         $this->warmCoverageCache                          = $warmCoverageCache;
+        $this->forceCoverageCache                         = $forceCoverageCache;
         $this->debug                                      = $debug;
         $this->defaultTimeLimit                           = $defaultTimeLimit;
         $this->disableCodeCoverageIgnore                  = $disableCodeCoverageIgnore;
@@ -989,6 +995,23 @@ public function warmCoverageCache(): bool
         return $this->warmCoverageCache;
     }
 
+    public function hasForceCoverageCache(): bool
+    {
+        return $this->forceCoverageCache !== null;
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function forceCoverageCache(): bool
+    {
+        if ($this->forceCoverageCache === null) {
+            throw new Exception;
+        }
+
+        return $this->forceCoverageCache;
+    }
+
     public function hasDebug(): bool
     {
         return $this->debug !== null;
diff --git a/src/TextUI/CliArguments/Mapper.php b/src/TextUI/CliArguments/Mapper.php
@@ -64,6 +64,10 @@ public function mapToLegacyArray(Configuration $arguments): array
             $result['warmCoverageCache'] = $arguments->warmCoverageCache();
         }
 
+        if ($arguments->hasForceCoverageCache()) {
+            $result['forceCoverageCache'] = $arguments->forceCoverageCache();
+        }
+
         if ($arguments->hasCoverageClover()) {
             $result['coverageClover'] = $arguments->coverageClover();
         }
diff --git a/src/TextUI/Help.php b/src/TextUI/Help.php
@@ -43,6 +43,7 @@ final class Help
             ['arg' => '--coverage-xml <dir>', 'desc' => 'Generate code coverage report in PHPUnit XML format'],
             ['arg' => '--coverage-cache <dir>', 'desc' => 'Cache static analysis results'],
             ['arg' => '--warm-coverage-cache', 'desc' => 'Warm static analysis cache'],
+            ['arg' => '--force-coverage-cache', 'desc' => 'Do not validate static analysis cache'],
             ['arg' => '--coverage-filter <dir>', 'desc' => 'Include <dir> in code coverage analysis'],
             ['arg' => '--path-coverage', 'desc' => 'Perform path coverage analysis'],
             ['arg' => '--disable-coverage-ignore', 'desc' => 'Disable annotations for ignoring code coverage'],
diff --git a/src/TextUI/TestRunner.php b/src/TextUI/TestRunner.php
@@ -468,6 +468,10 @@ public function run(TestSuite $suite, array $arguments = [], array $warnings = [
                     $codeCoverage->cacheStaticAnalysis($arguments['coverageCacheDirectory']);
                 }
 
+                if (isset($arguments['forceCoverageCache']) && $arguments['forceCoverageCache'] === true && $codeCoverage->cachesStaticAnalysis()) {
+                    $codeCoverage->doNotValidateStaticAnalysisCache();
+                }
+
                 $codeCoverage->excludeSubclassesOfThisClassFromUnintentionallyCoveredCodeCheck(Comparator::class);
 
                 if ($arguments['strictCoverage']) {
diff --git a/src/Util/PHP/Template/PhptTestCase.tpl b/src/Util/PHP/Template/PhptTestCase.tpl
@@ -35,6 +35,10 @@ if (class_exists('SebastianBergmann\CodeCoverage\CodeCoverage')) {
 
     if ({codeCoverageCacheDirectory}) {
         $coverage->cacheStaticAnalysis({codeCoverageCacheDirectory});
+
+        if ({forcesStaticAnalysisCache}) {
+            $coverage->doNotValidateStaticAnalysisCache();
+        }
     }
 
     $coverage->start(__FILE__);
diff --git a/src/Util/PHP/Template/TestCaseClass.tpl b/src/Util/PHP/Template/TestCaseClass.tpl
@@ -45,6 +45,10 @@ function __phpunit_run_isolated_test()
 
         if ({cachesStaticAnalysis}) {
             $codeCoverage->cacheStaticAnalysis(unserialize('{codeCoverageCacheDirectory}'));
+
+            if ({forcesStaticAnalysisCache}) {
+                $codeCoverage->doNotValidateStaticAnalysisCache();
+            }
         }
 
         $result->setCodeCoverage($codeCoverage);
diff --git a/src/Util/PHP/Template/TestCaseMethod.tpl b/src/Util/PHP/Template/TestCaseMethod.tpl
@@ -46,6 +46,10 @@ function __phpunit_run_isolated_test()
 
         if ({cachesStaticAnalysis}) {
             $codeCoverage->cacheStaticAnalysis(unserialize('{codeCoverageCacheDirectory}'));
+
+            if ({forcesStaticAnalysisCache}) {
+                $codeCoverage->doNotValidateStaticAnalysisCache();
+            }
         }
 
         $result->setCodeCoverage($codeCoverage);
diff --git a/tests/end-to-end/cli/_files/output-cli-help-color.txt b/tests/end-to-end/cli/_files/output-cli-help-color.txt
@@ -16,6 +16,7 @@
                               XML format
   [32m--coverage-cache [36m<dir>[0m     [0m Cache static analysis results
   [32m--warm-coverage-cache      [0m Warm static analysis cache
+  [32m--force-coverage-cache     [0m Do not validate static analysis cache
   [32m--coverage-filter [36m<dir>[0m    [0m Include <dir> in code coverage analysis
   [32m--path-coverage            [0m Perform path coverage analysis
   [32m--disable-coverage-ignore  [0m Disable annotations for ignoring code
diff --git a/tests/end-to-end/cli/_files/output-cli-usage.txt b/tests/end-to-end/cli/_files/output-cli-usage.txt
@@ -14,6 +14,7 @@ Code Coverage Options:
   --coverage-xml <dir>        Generate code coverage report in PHPUnit XML format
   --coverage-cache <dir>      Cache static analysis results
   --warm-coverage-cache       Warm static analysis cache
+  --force-coverage-cache      Do not validate static analysis cache
   --coverage-filter <dir>     Include <dir> in code coverage analysis
   --path-coverage             Perform path coverage analysis
   --disable-coverage-ignore   Disable annotations for ignoring code coverage

Original file line number	Diff line number	Diff line change
`@@ -174,19 +174,24 @@ public function run(TestResult $result = null): TestResult`
`174`	`174`
`175`	`175`	`if ($result->getCollectCodeCoverageInformation()) {`
`176`	`176`	`$codeCoverageCacheDirectory = null;`
	`177`	`+ $forcesStaticAnalysisCache = false;`
`177`	`178`	`$pathCoverage = false;`
`178`	`179`
`179`	`180`	`$codeCoverage = $result->getCodeCoverage();`
`180`	`181`
`181`	`182`	`if ($codeCoverage) {`
`182`	`183`	`if ($codeCoverage->cachesStaticAnalysis()) {`
`183`	`184`	`$codeCoverageCacheDirectory = $codeCoverage->cacheDirectory();`
	`185`	`+`
	`186`	`+ if (!$codeCoverage->validatesStaticAnalysisCache()) {`
	`187`	`+ $forcesStaticAnalysisCache = true;`
	`188`	`+ }`
`184`	`189`	`}`
`185`	`190`
`186`	`191`	`$pathCoverage = $codeCoverage->collectsBranchAndPathCoverage();`
`187`	`192`	`}`
`188`	`193`
`189`		`- $this->renderForCoverage($code, $pathCoverage, $codeCoverageCacheDirectory);`
	`194`	`+ $this->renderForCoverage($code, $pathCoverage, $codeCoverageCacheDirectory, $forcesStaticAnalysisCache);`
`190`	`195`	`}`
`191`	`196`
`192`	`197`	`$timer = new Timer;`
`@@ -595,7 +600,7 @@ private function getCoverageFiles(): array`
`595`	`600`	`];`
`596`	`601`	`}`
`597`	`602`
`598`		`- private function renderForCoverage(string &$job, bool $pathCoverage, ?string $codeCoverageCacheDirectory): void`
	`603`	`+ private function renderForCoverage(string &$job, bool $pathCoverage, ?string $codeCoverageCacheDirectory, bool $forcesStaticAnalysisCache): void`
`599`	`604`	`{`
`600`	`605`	`$files = $this->getCoverageFiles();`
`601`	`606`
`@@ -639,6 +644,7 @@ private function renderForCoverage(string &$job, bool $pathCoverage, ?string $co`
`639`	`644`	`'coverageFile' => $files['coverage'],`
`640`	`645`	`'driverMethod' => $pathCoverage ? 'forLineAndPathCoverage' : 'forLineCoverage',`
`641`	`646`	`'codeCoverageCacheDirectory' => $codeCoverageCacheDirectory,`
	`647`	`+ 'forcesStaticAnalysisCache' => $forcesStaticAnalysisCache ? 'true' : 'false',`
`642`	`648`	`]`
`643`	`649`	`);`
`644`	`650`
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,10 @@ public function mapToLegacyArray(Configuration $arguments): array`
`64`	`64`	`$result['warmCoverageCache'] = $arguments->warmCoverageCache();`
`65`	`65`	`}`
`66`	`66`
	`67`	`+ if ($arguments->hasForceCoverageCache()) {`
	`68`	`+ $result['forceCoverageCache'] = $arguments->forceCoverageCache();`
	`69`	`+ }`
	`70`	`+`
`67`	`71`	`if ($arguments->hasCoverageClover()) {`
`68`	`72`	`$result['coverageClover'] = $arguments->coverageClover();`
`69`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -468,6 +468,10 @@ public function run(TestSuite $suite, array $arguments = [], array $warnings = [`
`468`	`468`	`$codeCoverage->cacheStaticAnalysis($arguments['coverageCacheDirectory']);`
`469`	`469`	`}`
`470`	`470`
	`471`	`+ if (isset($arguments['forceCoverageCache']) && $arguments['forceCoverageCache'] === true && $codeCoverage->cachesStaticAnalysis()) {`
	`472`	`+ $codeCoverage->doNotValidateStaticAnalysisCache();`
	`473`	`+ }`
	`474`	`+`
`471`	`475`	`$codeCoverage->excludeSubclassesOfThisClassFromUnintentionallyCoveredCodeCheck(Comparator::class);`
`472`	`476`
`473`	`477`	`if ($arguments['strictCoverage']) {`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,10 @@ if (class_exists('SebastianBergmann\CodeCoverage\CodeCoverage')) {`
`35`	`35`
`36`	`36`	`if ({codeCoverageCacheDirectory}) {`
`37`	`37`	`$coverage->cacheStaticAnalysis({codeCoverageCacheDirectory});`
	`38`	`+`
	`39`	`+ if ({forcesStaticAnalysisCache}) {`
	`40`	`+ $coverage->doNotValidateStaticAnalysisCache();`
	`41`	`+ }`
`38`	`42`	`}`
`39`	`43`
`40`	`44`	`$coverage->start(__FILE__);`