Allow to set cleanUpCloverXml

Author: robiningelbrecht

README.md

@@ -30,7 +30,8 @@ Navigate to your `phpunit.xml.dist` file and add following config to set default
 ```xml
 <extensions>
     <bootstrap class="RobinIngelbrecht\PHPUnitCoverageTools\PhpUnitExtension">
-        <parameter name="exitOnLowCoverage" value="true|false"/>
+        <parameter name="exitOnLowCoverage" value="0|1"/>
+        <parameter name="cleanUpCloverXml" value="0|1"/>
     </bootstrap>
 </extensions>
 ```
@@ -69,6 +70,7 @@ return [
     MinCoverageRules::TOTAL => 20,
     'RobinIngelbrecht\PHPUnitCoverageTools\*' => 80,
     'RobinIngelbrecht\PHPUnitCoverageTools\Subscriber\Application\ApplicationFinishedSubscriber' => 100,
+    'RobinIngelbrecht\PHPUnitCoverageTools\*CommandHandler' => 100,
 ];
 ```
 
@@ -77,6 +79,11 @@ This example will enforce:
 - A minimum total coverage of *20%*
 - A minimum coverage of *80%* for all classes in namespace `RobinIngelbrecht\PHPUnitCoverageTools`
 - *100%* code coverage for the class `ApplicationFinishedSubscriber`
+- *100%* code coverage for the classes ending with `CommandHandler`
+
+### --clean-up-clover-xml
+
+Adding this argument will clean up the generated clover file after the application has finished running.
 
 ### Example when coverage is too low
 

src/Subscriber/Application/ApplicationFinishedSubscriber.php

@@ -21,6 +21,7 @@ public function __construct(
         private readonly string $relativePathToCloverXml,
         private readonly MinCoverageRules $minCoverageRules,
         private readonly bool $exitOnLowCoverage,
+        private readonly bool $cleanUpCloverXml,
         private readonly Exitter $exitter,
         private readonly ConsoleOutput $consoleOutput,
     ) {
@@ -61,6 +62,10 @@ public function notify(Finished $event): void
         }
         $reader->close();
 
+        if ($this->cleanUpCloverXml) {
+            unlink($absolutePathToCloverXml);
+        }
+
         if (!$metrics && !$metricTotal) {
             throw new \RuntimeException('Could not determine coverage metrics');
         }
@@ -116,10 +121,15 @@ public static function fromConfigurationAndParameters(
             return null;
         }
 
+        if (!$cleanUpCloverXml = in_array('--clean-up-clover-xml', $_SERVER['argv'], true)) {
+            $cleanUpCloverXml = $parameters->has('cleanUpCloverXml') && (int) $parameters->get('cleanUpCloverXml');
+        }
+
         return new self(
             $configuration->coverageClover(),
             $rules,
-            $parameters->has('exitOnLowCoverage') && $parameters->get('exitOnLowCoverage'),
+            $parameters->has('exitOnLowCoverage') && (int) $parameters->get('exitOnLowCoverage'),
+            $cleanUpCloverXml,
             new Exitter(),
             new ConsoleOutput(new \Symfony\Component\Console\Output\ConsoleOutput()),
         );

tests/Subscriber/Application/ApplicationFinishedSubscriberTest.php

@@ -37,6 +37,7 @@ public function testNotifyWithAtLeastOneFailedRule(): void
             'tests/clover.xml',
             MinCoverageRules::fromConfigFile('tests/Subscriber/Application/min-coverage-rules-with-failed-rule.php'),
             true,
+            false,
             $exitter,
             new ConsoleOutput($spyOutput),
         );
@@ -67,6 +68,7 @@ public function testNotifyWithAWarning(): void
              'tests/clover.xml',
              MinCoverageRules::fromConfigFile('tests/Subscriber/Application/min-coverage-rules-with-warning.php'),
              false,
+             false,
              new Exitter(),
              new ConsoleOutput($spyOutput),
          );
@@ -97,6 +99,7 @@ public function testNotifyWhenCoverageIsOk(): void
              'tests/clover.xml',
              MinCoverageRules::fromConfigFile('tests/Subscriber/Application/min-coverage-rules-success.php'),
              false,
+             false,
              new Exitter(),
              new ConsoleOutput($spyOutput),
          );
@@ -127,6 +130,7 @@ public function testNotifyWhitOnlyTotal(): void
             'tests/clover.xml',
             MinCoverageRules::fromConfigFile('tests/Subscriber/Application/min-coverage-rules-total-only.php'),
             false,
+            false,
             new Exitter(),
             new ConsoleOutput($spyOutput),
         );
@@ -161,6 +165,7 @@ public function testNotifyWhitInvalidRules(): void
             'tests/clover.xml',
             MinCoverageRules::fromConfigFile('tests/Subscriber/Application/min-coverage-rules-invalid.php'),
             false,
+            false,
             new Exitter(),
             new ConsoleOutput($spyOutput),
         );
@@ -173,6 +178,7 @@ public function testNotifyWithNonExistingCloverFile(): void
             'tests/clover-wrong.xml',
             MinCoverageRules::fromConfigFile('tests/Subscriber/Application/min-coverage-rules-success.php'),
             false,
+            false,
             new Exitter(),
             new ConsoleOutput($spyOutput),
         );
@@ -203,6 +209,7 @@ public function testNotifyWithInvalidCloverFile(): void
              'tests/clover-invalid.xml',
              MinCoverageRules::fromConfigFile('tests/Subscriber/Application/min-coverage-rules-success.php'),
              false,
+             false,
              new Exitter(),
              new ConsoleOutput($spyOutput),
          );
@@ -227,13 +234,53 @@ public function testNotifyWithInvalidCloverFile(): void
          ));
      }
 
+    public function testNotifyWithCleanUpCloverFile(): void
+    {
+        copy(dirname(__DIR__, 2).'/clover.xml', dirname(__DIR__, 2).'/clover-to-delete.xml');
+        $exitter = $this->createMock(Exitter::class);
+
+        $exitter
+            ->expects($this->once())
+            ->method('exit')
+            ->with(1);
+
+        $spyOutput = new SpyOutput();
+        $subscriber = new ApplicationFinishedSubscriber(
+            'tests/clover-to-delete.xml',
+            MinCoverageRules::fromConfigFile('tests/Subscriber/Application/min-coverage-rules-with-failed-rule.php'),
+            true,
+            true,
+            $exitter,
+            new ConsoleOutput($spyOutput),
+        );
+
+        $subscriber->notify(new Finished(
+            new Info(
+                new Snapshot(
+                    HRTime::fromSecondsAndNanoseconds(1, 0),
+                    MemoryUsage::fromBytes(100),
+                    MemoryUsage::fromBytes(100),
+                    new GarbageCollectorStatus(0, 0, 0, 0, null, null, null, null)
+                ),
+                Duration::fromSecondsAndNanoseconds(1, 0),
+                MemoryUsage::fromBytes(100),
+                Duration::fromSecondsAndNanoseconds(1, 0),
+                MemoryUsage::fromBytes(100),
+            ),
+            0
+        ));
+
+        $this->assertFileDoesNotExist(dirname(__DIR__, 2).'/clover-to-delete.xml');
+    }
+
      public function testFromConfigurationAndParameters(): void
      {
          $this->assertEquals(
              new ApplicationFinishedSubscriber(
                  'tests/clover.xml',
                  MinCoverageRules::fromInt(90),
                  false,
+                 false,
                  new Exitter(),
                  new ConsoleOutput(new \Symfony\Component\Console\Output\ConsoleOutput()),
              ),
@@ -254,6 +301,7 @@ public function testFromConfigurationAndParametersFromFile(): void
                 'tests/clover.xml',
                 MinCoverageRules::fromConfigFile('tests/Subscriber/Application/min-coverage-rules-success.php'),
                 false,
+                false,
                 new Exitter(),
                 new ConsoleOutput(new \Symfony\Component\Console\Output\ConsoleOutput()),
             ),