Merge pull request #919 from WendellAdriel/feature/coverage-errors-on…

…ly-flag-2 [2.x] Print only files below the min coverage
pestphp · Dec 17, 2023 · 1e2ca40 · 1e2ca40
2 parents 4522cb5 + 8ea7b2b
commit 1e2ca40
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 3 deletions.
diff --git a/src/Plugins/Coverage.php b/src/Plugins/Coverage.php
@@ -27,6 +27,20 @@ final class Coverage implements AddsOutput, HandlesArguments
      */
     private const MIN_OPTION = 'min';
 
+    /**
+     * @var string
+     */
+    private const ERRORS_ONLY_OPTION = 'errors-only';
+
+    /**
+     * @var string[]
+     */
+    private const ALLOWED_OPTIONS = [
+        self::COVERAGE_OPTION,
+        self::MIN_OPTION,
+        self::ERRORS_ONLY_OPTION,
+    ];
+
     /**
      * Whether it should show the coverage or not.
      */
@@ -37,6 +51,11 @@ final class Coverage implements AddsOutput, HandlesArguments
      */
     public float $coverageMin = 0.0;
 
+    /**
+     * Whether it should show only errors or not.
+     */
+    public bool $errorsOnly = false;
+
     /**
      * Creates a new Plugin instance.
      */
@@ -51,7 +70,7 @@ public function __construct(private readonly OutputInterface $output)
     public function handleArguments(array $originals): array
     {
         $arguments = [...[''], ...array_values(array_filter($originals, function (string $original): bool {
-            foreach ([self::COVERAGE_OPTION, self::MIN_OPTION] as $option) {
+            foreach (self::ALLOWED_OPTIONS as $option) {
                 if ($original === sprintf('--%s', $option)) {
                     return true;
                 }
@@ -73,6 +92,7 @@ public function handleArguments(array $originals): array
         $inputs = [];
         $inputs[] = new InputOption(self::COVERAGE_OPTION, null, InputOption::VALUE_NONE);
         $inputs[] = new InputOption(self::MIN_OPTION, null, InputOption::VALUE_REQUIRED);
+        $inputs[] = new InputOption(self::ERRORS_ONLY_OPTION, null, InputOption::VALUE_NONE);
 
         $input = new ArgvInput($arguments, new InputDefinition($inputs));
         if ((bool) $input->getOption(self::COVERAGE_OPTION)) {
@@ -106,6 +126,10 @@ public function handleArguments(array $originals): array
             $this->coverageMin = (float) $minOption;
         }
 
+        if ((bool) $input->getOption(self::ERRORS_ONLY_OPTION)) {
+            $this->errorsOnly = true;
+        }
+
         return $originals;
     }
 
@@ -122,7 +146,7 @@ public function addOutput(int $exitCode): int
                 exit(1);
             }
 
-            $coverage = \Pest\Support\Coverage::report($this->output);
+            $coverage = \Pest\Support\Coverage::report($this->output, $this->coverageMin, $this->errorsOnly);
 
             $exitCode = (int) ($coverage < $this->coverageMin);
 

diff --git a/src/Support/Coverage.php b/src/Support/Coverage.php
@@ -74,7 +74,7 @@ public static function usingXdebug(): bool
      * Reports the code coverage report to the
      * console and returns the result in float.
      */
-    public static function report(OutputInterface $output): float
+    public static function report(OutputInterface $output, float $coverageMin, bool $showErrorsOnly): float
     {
         if (! file_exists($reportPath = self::getPath())) {
             if (self::usingXdebug()) {
@@ -126,6 +126,10 @@ public static function report(OutputInterface $output): float
 
             $truncateAt = max(1, terminal()->width() - 12);
 
+            if ($showErrorsOnly && (float) $percentage >= $coverageMin) {
+                continue;
+            }
+
             renderUsing($output);
             render(<<<HTML
                 <div class="flex mx-2">

diff --git a/tests/Features/Coverage.php b/tests/Features/Coverage.php
@@ -34,6 +34,18 @@
     expect($plugin->coverageMin)->toEqual(2.4);
 });
 
+it('adds coverage if --errors-only exist', function () {
+    $plugin = new CoveragePlugin(new ConsoleOutput());
+    expect($plugin->errorsOnly)->toBeFalse()
+        ->and($plugin->coverage)->toBeFalse();
+
+    $plugin->handleArguments([]);
+    expect($plugin->errorsOnly)->toBeFalse();
+
+    $plugin->handleArguments(['--errors-only']);
+    expect($plugin->errorsOnly)->toBeTrue();
+});
+
 it('generates coverage based on file input', function () {
     expect(Coverage::getMissingCoverage(new class()
     {