Add support for whitelisting classes for the unintentionally covered code unit check

Author: sebastianbergmann

ChangeLog-3.3.md

@@ -6,7 +6,7 @@ All notable changes of the PHP_CodeCoverage 3.3 release series are documented in
 
 ### Added
 
-* Added optional check for missing `@covers` annotation when the usage of `@covers` annotations is forced
+* Added support for whitelisting classes for the unintentionally covered code unit check
 
 [3.3.0]: https://github.com/sebastianbergmann/php-code-coverage/compare/3.2...3.3.0
 

src/CodeCoverage.php

@@ -102,6 +102,11 @@ class PHP_CodeCoverage
      */
     private $tests = [];
 
+    /**
+     * @var string[]
+     */
+    private $unintentionallyCoveredSubclassesWhitelist = [];
+
     /**
      * Constructor.
      *
@@ -547,6 +552,15 @@ public function setIgnoreDeprecatedCode($flag)
         $this->ignoreDeprecatedCode = $flag;
     }
 
+    /**
+     * @param array $whitelist
+     * @since Method available since Release 3.3.0
+     */
+    public function setUnintentionallyCoveredSubclassesWhitelist(array $whitelist)
+    {
+        $this->unintentionallyCoveredSubclassesWhitelist = $whitelist;
+    }
+
     /**
      * Applies the @covers annotation filtering.
      *
@@ -905,10 +919,9 @@ private function performUnintentionallyCoveredCodeCheck(array &$data, array $lin
             }
         }
 
-        if (!empty($unintentionallyCoveredUnits)) {
-            $unintentionallyCoveredUnits = array_unique($unintentionallyCoveredUnits);
-            sort($unintentionallyCoveredUnits);
+        $unintentionallyCoveredUnits = $this->processUnintentionallyCoveredUnits($unintentionallyCoveredUnits);
 
+        if (!empty($unintentionallyCoveredUnits)) {
             throw new PHP_CodeCoverage_UnintentionallyCoveredCodeException(
                 $unintentionallyCoveredUnits
             );
@@ -1017,4 +1030,34 @@ private function selectDriver()
             return new PHP_CodeCoverage_Driver_Xdebug;
         }
     }
+
+    /**
+     * @param array $unintentionallyCoveredUnits
+     *
+     * @return array
+     */
+    private function processUnintentionallyCoveredUnits(array $unintentionallyCoveredUnits)
+    {
+        $unintentionallyCoveredUnits = array_unique($unintentionallyCoveredUnits);
+        sort($unintentionallyCoveredUnits);
+
+        foreach (array_keys($unintentionallyCoveredUnits) as $k => $v) {
+            $unit = explode('::', $unintentionallyCoveredUnits[$k]);
+
+            if (count($unit) != 2) {
+                continue;
+            }
+
+            $class = new ReflectionClass($unit[0]);
+
+            foreach ($this->unintentionallyCoveredSubclassesWhitelist as $whitelisted) {
+                if ($class->isSubclassOf($whitelisted)) {
+                    unset($unintentionallyCoveredUnits[$k]);
+                    break;
+                }
+            }
+        }
+
+        return array_values($unintentionallyCoveredUnits);
+    }
 }