Clean up exception handling

Author: sebastianbergmann

src/CodeCoverage.php

@@ -14,8 +14,12 @@
 use PHPUnit\Util\Test;
 use SebastianBergmann\CodeCoverage\Driver\Driver;
 use SebastianBergmann\CodeCoverage\Driver\PcovDriver;
+use SebastianBergmann\CodeCoverage\Driver\PcovNotAvailableException;
 use SebastianBergmann\CodeCoverage\Driver\PhpdbgDriver;
+use SebastianBergmann\CodeCoverage\Driver\PhpdbgNotAvailableException;
 use SebastianBergmann\CodeCoverage\Driver\XdebugDriver;
+use SebastianBergmann\CodeCoverage\Driver\XdebugNotAvailableException;
+use SebastianBergmann\CodeCoverage\Driver\XdebugNotEnabledException;
 use SebastianBergmann\CodeCoverage\Node\Builder;
 use SebastianBergmann\CodeCoverage\Node\Directory;
 use SebastianBergmann\CodeUnitReverseLookup\Wizard;
@@ -129,9 +133,6 @@ final class CodeCoverage
      */
     private $report;
 
-    /**
-     * @throws RuntimeException
-     */
     public function __construct(Driver $driver = null, Filter $filter = null)
     {
         if ($filter === null) {
@@ -221,8 +222,6 @@ public function setTests(array $tests): void
      * Start collection of code coverage information.
      *
      * @param PhptTestCase|string|TestCase $id
-     *
-     * @throws RuntimeException
      */
     public function start($id, bool $clear = false): void
     {
@@ -246,8 +245,6 @@ public function start($id, bool $clear = false): void
      *
      * @throws MissingCoversAnnotationException
      * @throws CoveredCodeNotExecutedException
-     * @throws RuntimeException
-     * @throws \ReflectionException
      */
     public function stop(bool $append = true, $linesToBeCovered = [], array $linesToBeUsed = [], bool $ignoreForceCoversAnnotation = false): RawCodeCoverageData
     {
@@ -271,11 +268,11 @@ public function stop(bool $append = true, $linesToBeCovered = [], array $linesTo
      * @param PhptTestCase|string|TestCase $id
      * @param array|false                  $linesToBeCovered
      *
-     * @throws \SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException
-     * @throws \SebastianBergmann\CodeCoverage\MissingCoversAnnotationException
-     * @throws \SebastianBergmann\CodeCoverage\CoveredCodeNotExecutedException
-     * @throws \ReflectionException
-     * @throws RuntimeException
+     * @throws UnintentionallyCoveredCodeException
+     * @throws MissingCoversAnnotationException
+     * @throws CoveredCodeNotExecutedException
+     * @throws TestIdMissingException
+     * @throws ReflectionException
      */
     public function append(RawCodeCoverageData $rawData, $id = null, bool $append = true, $linesToBeCovered = [], array $linesToBeUsed = [], bool $ignoreForceCoversAnnotation = false): void
     {
@@ -284,7 +281,7 @@ public function append(RawCodeCoverageData $rawData, $id = null, bool $append =
         }
 
         if ($id === null) {
-            throw new RuntimeException;
+            throw new TestIdMissingException;
         }
 
         $this->applyWhitelistFilter($rawData);
@@ -434,10 +431,10 @@ public function detectsDeadCode(): bool
      *
      * @param array|false $linesToBeCovered
      *
-     * @throws \SebastianBergmann\CodeCoverage\CoveredCodeNotExecutedException
-     * @throws \ReflectionException
+     * @throws CoveredCodeNotExecutedException
      * @throws MissingCoversAnnotationException
      * @throws UnintentionallyCoveredCodeException
+     * @throws ReflectionException
      */
     private function applyCoversAnnotationFilter(RawCodeCoverageData $rawData, $linesToBeCovered, array $linesToBeUsed, bool $ignoreForceCoversAnnotation): void
     {
@@ -507,9 +504,7 @@ private function applyIgnoredLinesFilter(RawCodeCoverageData $data): void
     /**
      * @throws CoveredCodeNotExecutedException
      * @throws MissingCoversAnnotationException
-     * @throws RuntimeException
      * @throws UnintentionallyCoveredCodeException
-     * @throws \ReflectionException
      */
     private function addUncoveredFilesFromWhitelist(): void
     {
@@ -631,8 +626,8 @@ private function getLinesToBeIgnoredInner(string $fileName): array
     }
 
     /**
-     * @throws \ReflectionException
      * @throws UnintentionallyCoveredCodeException
+     * @throws ReflectionException
      */
     private function performUnintentionallyCoveredCodeCheck(RawCodeCoverageData $data, array $linesToBeCovered, array $linesToBeUsed): void
     {
@@ -727,7 +722,11 @@ private function getAllowedLines(array $linesToBeCovered, array $linesToBeUsed):
     }
 
     /**
-     * @throws RuntimeException
+     * @throws NoCodeCoverageDriverAvailableException
+     * @throws PcovNotAvailableException
+     * @throws PhpdbgNotAvailableException
+     * @throws XdebugNotAvailableException
+     * @throws XdebugNotEnabledException
      */
     private function selectDriver(Filter $filter): Driver
     {
@@ -745,9 +744,12 @@ private function selectDriver(Filter $filter): Driver
             return new XdebugDriver($filter);
         }
 
-        throw new RuntimeException('No code coverage driver available');
+        throw new NoCodeCoverageDriverAvailableException;
     }
 
+    /**
+     * @throws ReflectionException
+     */
     private function processUnintentionallyCoveredUnits(array $unintentionallyCoveredUnits): array
     {
         $unintentionallyCoveredUnits = \array_unique($unintentionallyCoveredUnits);
@@ -760,14 +762,22 @@ private function processUnintentionallyCoveredUnits(array $unintentionallyCovere
                 continue;
             }
 
-            $class = new \ReflectionClass($unit[0]);
+            try {
+                $class = new \ReflectionClass($unit[0]);
 
-            foreach ($this->unintentionallyCoveredSubclassesWhitelist as $whitelisted) {
-                if ($class->isSubclassOf($whitelisted)) {
-                    unset($unintentionallyCoveredUnits[$k]);
+                foreach ($this->unintentionallyCoveredSubclassesWhitelist as $whitelisted) {
+                    if ($class->isSubclassOf($whitelisted)) {
+                        unset($unintentionallyCoveredUnits[$k]);
 
-                    break;
+                        break;
+                    }
                 }
+            } catch (\ReflectionException $e) {
+                throw new ReflectionException(
+                    $e->getMessage(),
+                    (int) $e->getCode(),
+                    $e
+                );
             }
         }
 
@@ -777,9 +787,7 @@ private function processUnintentionallyCoveredUnits(array $unintentionallyCovere
     /**
      * @throws CoveredCodeNotExecutedException
      * @throws MissingCoversAnnotationException
-     * @throws RuntimeException
      * @throws UnintentionallyCoveredCodeException
-     * @throws \ReflectionException
      */
     private function initializeData(): void
     {

src/Driver/PcovDriver.php

@@ -22,8 +22,15 @@ final class PcovDriver extends Driver
      */
     private $filter;
 
+    /**
+     * @throws PcovNotAvailableException
+     */
     public function __construct(Filter $filter)
     {
+        if (!\extension_loaded('pcov')) {
+            throw new PcovNotAvailableException;
+        }
+
         $this->filter = $filter;
     }
 

src/Driver/PhpdbgDriver.php

@@ -10,28 +10,19 @@
 namespace SebastianBergmann\CodeCoverage\Driver;
 
 use SebastianBergmann\CodeCoverage\RawCodeCoverageData;
-use SebastianBergmann\CodeCoverage\RuntimeException;
 
 /**
  * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
  */
 final class PhpdbgDriver extends Driver
 {
     /**
-     * @throws RuntimeException
+     * @throws PhpdbgNotAvailableException
      */
     public function __construct()
     {
         if (\PHP_SAPI !== 'phpdbg') {
-            throw new RuntimeException(
-                'This driver requires the PHPDBG SAPI'
-            );
-        }
-
-        if (!\function_exists('phpdbg_start_oplog')) {
-            throw new RuntimeException(
-                'This build of PHPDBG does not support code coverage'
-            );
+            throw new PhpdbgNotAvailableException;
         }
     }
 

src/Driver/XdebugDriver.php

@@ -11,7 +11,6 @@
 
 use SebastianBergmann\CodeCoverage\Filter;
 use SebastianBergmann\CodeCoverage\RawCodeCoverageData;
-use SebastianBergmann\CodeCoverage\RuntimeException;
 
 /**
  * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
@@ -24,16 +23,17 @@ final class XdebugDriver extends Driver
     private $pathCoverageIsMixedCoverage;
 
     /**
-     * @throws RuntimeException
+     * @throws XdebugNotAvailableException
+     * @throws XdebugNotEnabledException
      */
     public function __construct(Filter $filter)
     {
         if (!\extension_loaded('xdebug')) {
-            throw new RuntimeException('This driver requires Xdebug');
+            throw new XdebugNotAvailableException;
         }
 
         if (!\ini_get('xdebug.coverage_enable')) {
-            throw new RuntimeException('xdebug.coverage_enable=On has to be set in php.ini');
+            throw new XdebugNotEnabledException;
         }
 
         if ($filter->hasWhitelist()) {

src/Exception/BranchAndPathCoverageNotSupportedException.php

@@ -9,6 +9,6 @@
  */
 namespace SebastianBergmann\CodeCoverage;
 
-final class BranchAndPathCoverageNotSupportedException extends RuntimeException
+final class BranchAndPathCoverageNotSupportedException extends \RuntimeException implements Exception
 {
 }

src/Exception/CoveredCodeNotExecutedException.php

@@ -9,6 +9,6 @@
  */
 namespace SebastianBergmann\CodeCoverage;
 
-final class CoveredCodeNotExecutedException extends RuntimeException
+final class CoveredCodeNotExecutedException extends \RuntimeException implements Exception
 {
 }

src/Exception/DeadCodeDetectionNotSupportedException.php

@@ -9,6 +9,6 @@
  */
 namespace SebastianBergmann\CodeCoverage;
 
-final class DeadCodeDetectionNotSupportedException extends RuntimeException
+final class DeadCodeDetectionNotSupportedException extends \RuntimeException implements Exception
 {
 }

src/Exception/DirectoryCouldNotBeCreatedException.php

@@ -9,6 +9,6 @@
  */
 namespace SebastianBergmann\CodeCoverage;
 
-final class DirectoryCouldNotBeCreatedException extends RuntimeException
+final class DirectoryCouldNotBeCreatedException extends \RuntimeException implements Exception
 {
 }

src/Exception/MissingCoversAnnotationException.php

@@ -9,6 +9,6 @@
  */
 namespace SebastianBergmann\CodeCoverage;
 
-final class MissingCoversAnnotationException extends RuntimeException
+final class MissingCoversAnnotationException extends \RuntimeException implements Exception
 {
 }

src/Exception/NoCodeCoverageDriverAvailableException.php

@@ -0,0 +1,18 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of phpunit/php-code-coverage.
+ *
+ * (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 SebastianBergmann\CodeCoverage;
+
+final class NoCodeCoverageDriverAvailableException extends \RuntimeException implements Exception
+{
+    public function __construct()
+    {
+        parent::__construct('No code coverage driver available');
+    }
+}