Revert "Implement --force-coverage-cache CLI option"

sebastianbergmann · sebastianbergmann · commit 4f62d10d1b7f · 2020-09-27T06:47:09.000+02:00
This reverts commit 4f7a13d.
diff --git a/ChangeLog-9.4.md b/ChangeLog-9.4.md
@@ -9,7 +9,6 @@ All notable changes of the PHPUnit 9.4 release series are documented in this fil
 * [#4462](https://github.com/sebastianbergmann/phpunit/pull/4462): Support for Cobertura XML report format
 * [#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/src/Framework/TestCase.php b/src/Framework/TestCase.php
@@ -811,7 +811,6 @@ public function run(TestResult $result = null): TestResult
             $codeCoverage               = $result->getCodeCoverage();
             $codeCoverageFilter         = null;
             $cachesStaticAnalysis       = 'false';
-            $forcesStaticAnalysisCache  = 'false';
             $codeCoverageCacheDirectory = null;
             $driverMethod               = 'forLineCoverage';
 
@@ -825,10 +824,6 @@ public function run(TestResult $result = null): TestResult
                 if ($codeCoverage->cachesStaticAnalysis()) {
                     $cachesStaticAnalysis       = 'true';
                     $codeCoverageCacheDirectory = $codeCoverage->cacheDirectory();
-
-                    if (!$codeCoverage->validatesStaticAnalysisCache()) {
-                        $forcesStaticAnalysisCache = 'true';
-                    }
                 }
             }
 
@@ -856,7 +851,6 @@ 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
@@ -173,24 +173,19 @@ 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, $forcesStaticAnalysisCache);
+            $this->renderForCoverage($code, $pathCoverage, $codeCoverageCacheDirectory);
         }
 
         $timer = new Timer;
@@ -599,7 +594,7 @@ private function getCoverageFiles(): array
         ];
     }
 
-    private function renderForCoverage(string &$job, bool $pathCoverage, ?string $codeCoverageCacheDirectory, bool $forcesStaticAnalysisCache): void
+    private function renderForCoverage(string &$job, bool $pathCoverage, ?string $codeCoverageCacheDirectory): void
     {
         $files = $this->getCoverageFiles();
 
@@ -643,7 +638,6 @@ 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,7 +41,6 @@ final class Builder
         'configuration=',
         'coverage-cache=',
         'warm-coverage-cache',
-        'force-coverage-cache',
         'coverage-filter=',
         'coverage-clover=',
         'coverage-cobertura=',
@@ -154,7 +153,6 @@ public function fromParameters(array $parameters, array $additionalLongOptions):
         $configuration                              = null;
         $coverageCacheDirectory                     = null;
         $warmCoverageCache                          = null;
-        $forceCoverageCache                         = null;
         $coverageFilter                             = null;
         $coverageClover                             = null;
         $coverageCobertura                          = null;
@@ -288,11 +286,6 @@ public function fromParameters(array $parameters, array $additionalLongOptions):
 
                     break;
 
-                case '--force-coverage-cache':
-                    $forceCoverageCache = true;
-
-                    break;
-
                 case '--coverage-clover':
                     $coverageClover = $option[1];
 
@@ -821,7 +814,6 @@ 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
@@ -147,11 +147,6 @@ final class Configuration
      */
     private $warmCoverageCache;
 
-    /**
-     * @var ?bool
-     */
-    private $forceCoverageCache;
-
     /**
      * @var ?bool
      */
@@ -480,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 $coverageCobertura, ?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)
+    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 $coverageCobertura, ?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)
     {
         $this->argument                                   = $argument;
         $this->atLeastVersion                             = $atLeastVersion;
@@ -508,7 +503,6 @@ 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;
@@ -1018,23 +1012,6 @@ 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,10 +64,6 @@ 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
@@ -44,7 +44,6 @@ 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
@@ -473,10 +473,6 @@ 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,10 +35,6 @@ 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,10 +45,6 @@ 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,10 +46,6 @@ 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
@@ -18,7 +18,6 @@
                               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
@@ -15,7 +15,6 @@ 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
`@@ -173,24 +173,19 @@ public function run(TestResult $result = null): TestResult`
`173`	`173`
`174`	`174`	`if ($result->getCollectCodeCoverageInformation()) {`
`175`	`175`	`$codeCoverageCacheDirectory = null;`
`176`		`- $forcesStaticAnalysisCache = false;`
`177`	`176`	`$pathCoverage = false;`
`178`	`177`
`179`	`178`	`$codeCoverage = $result->getCodeCoverage();`
`180`	`179`
`181`	`180`	`if ($codeCoverage) {`
`182`	`181`	`if ($codeCoverage->cachesStaticAnalysis()) {`
`183`	`182`	`$codeCoverageCacheDirectory = $codeCoverage->cacheDirectory();`
`184`		`-`
`185`		`- if (!$codeCoverage->validatesStaticAnalysisCache()) {`
`186`		`- $forcesStaticAnalysisCache = true;`
`187`		`- }`
`188`	`183`	`}`
`189`	`184`
`190`	`185`	`$pathCoverage = $codeCoverage->collectsBranchAndPathCoverage();`
`191`	`186`	`}`
`192`	`187`
`193`		`- $this->renderForCoverage($code, $pathCoverage, $codeCoverageCacheDirectory, $forcesStaticAnalysisCache);`
	`188`	`+ $this->renderForCoverage($code, $pathCoverage, $codeCoverageCacheDirectory);`
`194`	`189`	`}`
`195`	`190`
`196`	`191`	`$timer = new Timer;`
`@@ -599,7 +594,7 @@ private function getCoverageFiles(): array`
`599`	`594`	`];`
`600`	`595`	`}`
`601`	`596`
`602`		`- private function renderForCoverage(string &$job, bool $pathCoverage, ?string $codeCoverageCacheDirectory, bool $forcesStaticAnalysisCache): void`
	`597`	`+ private function renderForCoverage(string &$job, bool $pathCoverage, ?string $codeCoverageCacheDirectory): void`
`603`	`598`	`{`
`604`	`599`	`$files = $this->getCoverageFiles();`
`605`	`600`
`@@ -643,7 +638,6 @@ private function renderForCoverage(string &$job, bool $pathCoverage, ?string $co`
`643`	`638`	`'coverageFile' => $files['coverage'],`
`644`	`639`	`'driverMethod' => $pathCoverage ? 'forLineAndPathCoverage' : 'forLineCoverage',`
`645`	`640`	`'codeCoverageCacheDirectory' => $codeCoverageCacheDirectory,`
`646`		`- 'forcesStaticAnalysisCache' => $forcesStaticAnalysisCache ? 'true' : 'false',`
`647`	`641`	`]`
`648`	`642`	`);`
`649`	`643`
Original file line number	Diff line number	Diff line change
`@@ -64,10 +64,6 @@ 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`		`-`
`71`	`67`	`if ($arguments->hasCoverageClover()) {`
`72`	`68`	`$result['coverageClover'] = $arguments->coverageClover();`
`73`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -473,10 +473,6 @@ public function run(TestSuite $suite, array $arguments = [], array $warnings = [`
`473`	`473`	`$codeCoverage->cacheStaticAnalysis($arguments['coverageCacheDirectory']);`
`474`	`474`	`}`
`475`	`475`
`476`		`- if (isset($arguments['forceCoverageCache']) && $arguments['forceCoverageCache'] === true && $codeCoverage->cachesStaticAnalysis()) {`
`477`		`- $codeCoverage->doNotValidateStaticAnalysisCache();`
`478`		`- }`
`479`		`-`
`480`	`476`	`$codeCoverage->excludeSubclassesOfThisClassFromUnintentionallyCoveredCodeCheck(Comparator::class);`
`481`	`477`
`482`	`478`	`if ($arguments['strictCoverage']) {`
Original file line number	Diff line number	Diff line change
`@@ -35,10 +35,6 @@ 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`		`- }`
`42`	`38`	`}`
`43`	`39`
`44`	`40`	`$coverage->start(__FILE__);`
Original file line number	Diff line number	Diff line change
`@@ -45,10 +45,6 @@ function __phpunit_run_isolated_test()`
`45`	`45`
`46`	`46`	`if ({cachesStaticAnalysis}) {`
`47`	`47`	`$codeCoverage->cacheStaticAnalysis(unserialize('{codeCoverageCacheDirectory}'));`
`48`		`-`
`49`		`- if ({forcesStaticAnalysisCache}) {`
`50`		`- $codeCoverage->doNotValidateStaticAnalysisCache();`
`51`		`- }`
`52`	`48`	`}`
`53`	`49`
`54`	`50`	`$result->setCodeCoverage($codeCoverage);`