Remove the processUncoveredFiles attribute on the <coverage> XML conf…

…iguration element (because the corresponding functionality in php-code-coverage has been removed)
sebastianbergmann · May 4, 2021 · 602370c · 602370c
1 parent 4b70280
commit 602370c
Show file tree

Hide file tree

Showing 15 changed files with 42 additions and 34 deletions.
diff --git a/ChangeLog-10.0.md b/ChangeLog-10.0.md
@@ -52,6 +52,7 @@ All notable changes of the PHPUnit 10.0 release series are documented in this fi
 * [#4601](https://github.com/sebastianbergmann/phpunit/issues/4601): Deprecate assertions that operate on class/object properties
 * Removed the `PHPUnit\Runner\TestSuiteLoader` interface
 * Removed the `<listeners>` XML configuration element and its children
-* Removed the `groups` attribute on the `test` element in the TestDox XML report
+* Removed the `groups` attribute on the `<test>` element in the TestDox XML report
+* Removed the `processUncoveredFiles` attribute on the `<coverage>` XML configuration element
 
 [10.0.0]: https://github.com/sebastianbergmann/phpunit/compare/9.5...master
diff --git a/phpunit.xml b/phpunit.xml
@@ -18,8 +18,7 @@
         </testsuite>
     </testsuites>
 
-    <coverage processUncoveredFiles="true"
-              ignoreDeprecatedCodeUnits="true">
+    <coverage ignoreDeprecatedCodeUnits="true">
         <include>
             <directory suffix=".php">src</directory>
         </include>

diff --git a/phpunit.xsd b/phpunit.xsd
@@ -32,7 +32,6 @@
         <xs:attribute name="cacheDirectory" type="xs:anyURI"/>
         <xs:attribute name="pathCoverage" type="xs:boolean" default="false"/>
         <xs:attribute name="includeUncoveredFiles" type="xs:boolean" default="true"/>
-        <xs:attribute name="processUncoveredFiles" type="xs:boolean" default="false"/>
         <xs:attribute name="ignoreDeprecatedCodeUnits" type="xs:boolean" default="false"/>
         <xs:attribute name="disableCodeCoverageIgnore" type="xs:boolean" default="false"/>
     </xs:complexType>

diff --git a/src/TextUI/TestRunner.php b/src/TextUI/TestRunner.php
@@ -466,12 +466,6 @@ public function run(TestSuite $suite, array $arguments = [], array $warnings = [
                         } else {
                             CodeCoverage::instance()->excludeUncoveredFiles();
                         }
-
-                        if ($codeCoverageConfiguration->processUncoveredFiles()) {
-                            CodeCoverage::instance()->processUncoveredFiles();
-                        } else {
-                            CodeCoverage::instance()->doNotProcessUncoveredFiles();
-                        }
                     }
                 }
 

diff --git a/src/TextUI/XmlConfiguration/CodeCoverage/CodeCoverage.php b/src/TextUI/XmlConfiguration/CodeCoverage/CodeCoverage.php
@@ -42,8 +42,6 @@ final class CodeCoverage
 
     private bool $includeUncoveredFiles;
 
-    private bool $processUncoveredFiles;
-
     private bool $ignoreDeprecatedCodeUnits;
 
     private bool $disableCodeCoverageIgnore;
@@ -62,7 +60,7 @@ final class CodeCoverage
 
     private ?Xml $xml = null;
 
-    public function __construct(?Directory $cacheDirectory, DirectoryCollection $directories, FileCollection $files, DirectoryCollection $excludeDirectories, FileCollection $excludeFiles, bool $pathCoverage, bool $includeUncoveredFiles, bool $processUncoveredFiles, bool $ignoreDeprecatedCodeUnits, bool $disableCodeCoverageIgnore, ?Clover $clover, ?Cobertura $cobertura, ?Crap4j $crap4j, ?Html $html, ?Php $php, ?Text $text, ?Xml $xml)
+    public function __construct(?Directory $cacheDirectory, DirectoryCollection $directories, FileCollection $files, DirectoryCollection $excludeDirectories, FileCollection $excludeFiles, bool $pathCoverage, bool $includeUncoveredFiles, bool $ignoreDeprecatedCodeUnits, bool $disableCodeCoverageIgnore, ?Clover $clover, ?Cobertura $cobertura, ?Crap4j $crap4j, ?Html $html, ?Php $php, ?Text $text, ?Xml $xml)
     {
         $this->cacheDirectory            = $cacheDirectory;
         $this->directories               = $directories;
@@ -71,7 +69,6 @@ public function __construct(?Directory $cacheDirectory, DirectoryCollection $dir
         $this->excludeFiles              = $excludeFiles;
         $this->pathCoverage              = $pathCoverage;
         $this->includeUncoveredFiles     = $includeUncoveredFiles;
-        $this->processUncoveredFiles     = $processUncoveredFiles;
         $this->ignoreDeprecatedCodeUnits = $ignoreDeprecatedCodeUnits;
         $this->disableCodeCoverageIgnore = $disableCodeCoverageIgnore;
         $this->clover                    = $clover;
@@ -154,11 +151,6 @@ public function disableCodeCoverageIgnore(): bool
         return $this->disableCodeCoverageIgnore;
     }
 
-    public function processUncoveredFiles(): bool
-    {
-        return $this->processUncoveredFiles;
-    }
-
     /**
      * @psalm-assert-if-true !null $this->clover
      */

diff --git a/src/TextUI/XmlConfiguration/Generator.php b/src/TextUI/XmlConfiguration/Generator.php
@@ -39,7 +39,7 @@ final class Generator
         </testsuite>
     </testsuites>
 
-    <coverage processUncoveredFiles="true">
+    <coverage>
         <include>
             <directory suffix=".php">{src_directory}</directory>
         </include>

diff --git a/src/TextUI/XmlConfiguration/Loader.php b/src/TextUI/XmlConfiguration/Loader.php
@@ -306,7 +306,6 @@ private function codeCoverage(string $filename, DOMXPath $xpath, DOMDocument $do
         $cacheDirectory            = null;
         $pathCoverage              = false;
         $includeUncoveredFiles     = true;
-        $processUncoveredFiles     = false;
         $ignoreDeprecatedCodeUnits = false;
         $disableCodeCoverageIgnore = false;
 
@@ -333,12 +332,6 @@ private function codeCoverage(string $filename, DOMXPath $xpath, DOMDocument $do
                 true
             );
 
-            $processUncoveredFiles = $this->getBooleanAttribute(
-                $element,
-                'processUncoveredFiles',
-                false
-            );
-
             $ignoreDeprecatedCodeUnits = $this->getBooleanAttribute(
                 $element,
                 'ignoreDeprecatedCodeUnits',
@@ -463,7 +456,6 @@ private function codeCoverage(string $filename, DOMXPath $xpath, DOMDocument $do
             $this->readFilterFiles($filename, $xpath, 'coverage/exclude/file'),
             $pathCoverage,
             $includeUncoveredFiles,
-            $processUncoveredFiles,
             $ignoreDeprecatedCodeUnits,
             $disableCodeCoverageIgnore,
             $clover,

diff --git a/src/TextUI/XmlConfiguration/Migration/MigrationBuilder.php b/src/TextUI/XmlConfiguration/Migration/MigrationBuilder.php
@@ -45,6 +45,7 @@ final class MigrationBuilder
             RemoveTestSuiteLoaderAttributes::class,
             RemoveCacheResultFileAttribute::class,
             RemoveCoverageElementCacheDirectoryAttribute::class,
+            RemoveCoverageElementProcessUncoveredFilesAttribute::class,
             IntroduceCacheDirectoryAttribute::class,
             RenameBackupStaticAttributesAttribute::class,
         ],

diff --git a/...onfiguration/Migration/Migrations/RemoveCoverageElementProcessUncoveredFilesAttribute.php b/...onfiguration/Migration/Migrations/RemoveCoverageElementProcessUncoveredFilesAttribute.php
@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (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 PHPUnit\TextUI\XmlConfiguration;
+
+use DOMDocument;
+use DOMElement;
+
+/**
+ * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ */
+final class RemoveCoverageElementProcessUncoveredFilesAttribute implements Migration
+{
+    public function migrate(DOMDocument $document): void
+    {
+        $node = $document->getElementsByTagName('coverage')->item(0);
+
+        if (!$node instanceof DOMElement || $node->parentNode === null) {
+            return;
+        }
+
+        if ($node->hasAttribute('processUncoveredFiles')) {
+            $node->removeAttribute('processUncoveredFiles');
+        }
+    }
+}
diff --git a/tests/_files/XmlConfigurationMigration/output-9.2.xml b/tests/_files/XmlConfigurationMigration/output-9.2.xml
@@ -4,7 +4,6 @@
          cacheDirectory=".phpunit.cache">
 
     <coverage includeUncoveredFiles="true"
-              processUncoveredFiles="true"
               ignoreDeprecatedCodeUnits="true"
               disableCodeCoverageIgnore="true">
         <include>

diff --git a/tests/_files/XmlConfigurationMigration/output-9.5.xml b/tests/_files/XmlConfigurationMigration/output-9.5.xml
@@ -3,7 +3,7 @@
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
          cacheDirectory=".phpunit.cache">
 
-    <coverage processUncoveredFiles="true">
+    <coverage>
         <include>
             <directory suffix=".php">src</directory>
         </include>

diff --git a/tests/end-to-end/force-covers-annotation/phpunit.xml b/tests/end-to-end/force-covers-annotation/phpunit.xml
@@ -8,7 +8,7 @@
         </testsuite>
     </testsuites>
 
-    <coverage processUncoveredFiles="true">
+    <coverage>
         <include>
             <directory suffix=".php">src</directory>
         </include>

diff --git a/tests/end-to-end/risky-tests/global-state/phpunit.xml b/tests/end-to-end/risky-tests/global-state/phpunit.xml
@@ -17,7 +17,7 @@
         </testsuite>
     </testsuites>
 
-    <coverage processUncoveredFiles="true">
+    <coverage>
         <include>
             <directory suffix=".php">src</directory>
         </include>

diff --git a/tests/unit/TextUI/XmlConfigurationGeneratorTest.php b/tests/unit/TextUI/XmlConfigurationGeneratorTest.php
@@ -41,7 +41,7 @@ public function testGeneratesConfigurationCorrectly(): void
         </testsuite>
     </testsuites>
 
-    <coverage processUncoveredFiles="true">
+    <coverage>
         <include>
             <directory suffix=".php">src</directory>
         </include>

diff --git a/tests/unit/TextUI/XmlConfigurationTest.php b/tests/unit/TextUI/XmlConfigurationTest.php
@@ -158,7 +158,6 @@ public function testCodeCoverageConfigurationIsReadCorrectly(): void
 
         $this->assertTrue($codeCoverage->pathCoverage());
         $this->assertTrue($codeCoverage->includeUncoveredFiles());
-        $this->assertTrue($codeCoverage->processUncoveredFiles());
         $this->assertTrue($codeCoverage->ignoreDeprecatedCodeUnits());
         $this->assertTrue($codeCoverage->disableCodeCoverageIgnore());