Add warnings when using the --skip-initial-test-suite option

infection · Feb 17, 2020 · 91f92a0 · 91f92a0
1 parent 110e1a6
commit 91f92a0
Show file tree

Hide file tree

Showing 7 changed files with 64 additions and 9 deletions.
diff --git a/src/Command/InfectionCommand.php b/src/Command/InfectionCommand.php
@@ -246,6 +246,10 @@ private function startUp(): void
 
         $coverageChecker = $this->container->getCoverageRequirementChecker();
 
+        if ($coverageChecker->hasSkipInitialTestSuiteWithoutCoverageOption()) {
+            throw CoverageDoesNotExistException::mustAlreadyExist();
+        }
+
         if (!$coverageChecker->hasDebuggerOrCoverageOption()) {
             throw CoverageDoesNotExistException::unableToGenerate();
         }

diff --git a/src/Console/ConsoleOutput.php b/src/Console/ConsoleOutput.php
@@ -129,4 +129,13 @@ public function logNotInControlOfExitCodes(): void
             'It is your responsibility to disable xdebug/phpdbg unless needed.',
         ]);
     }
+
+    public function logSkippingInitialTestSuite(): void
+    {
+        $this->io->warning([
+            'Skipping the initial test suite run can be very dangerous.' . PHP_EOL .
+            'It is your responsibility to ensure the test suite is in a passing state to begin.' . PHP_EOL .
+            'If this is not done then mutations may report as caught when they are not.',
+        ]);
+    }
 }
diff --git a/src/Container.php b/src/Container.php
@@ -297,7 +297,8 @@ public static function create(): self
                 $config = $container->getConfiguration();
 
                 return new CoverageRequirementChecker(
-                    $config->getCoveragePath() !== '',
+                    $config->shouldSkipCoverage(),
+                    $config->shouldSkipInitialTestSuite(),
                     $config->getInitialTestsPhpOptions() ?? ''
                 );
             },

diff --git a/src/Engine.php b/src/Engine.php
@@ -113,6 +113,7 @@ public function execute(int $threads): bool
     private function runInitialTestSuite(): void
     {
         if ($this->config->shouldSkipInitialTestSuite()) {
+            $this->consoleOutput->logSkippingInitialTestSuite();
             $this->assertCodeCoverageExists($this->config->getTestFramework());
 
             return;

diff --git a/src/Process/Coverage/CoverageRequirementChecker.php b/src/Process/Coverage/CoverageRequirementChecker.php
@@ -46,11 +46,13 @@
 final class CoverageRequirementChecker
 {
     private $skipCoverage;
+    private $skipInitialTestSuite;
     private $initialTestPhpOptions;
 
-    public function __construct(bool $skipCoverage, string $initialTestPhpOptions)
+    public function __construct(bool $skipCoverage, bool $skipInitialTestSuite, string $initialTestPhpOptions)
     {
         $this->skipCoverage = $skipCoverage;
+        $this->skipInitialTestSuite = $skipInitialTestSuite;
         $this->initialTestPhpOptions = $initialTestPhpOptions;
     }
 
@@ -80,4 +82,9 @@ private function isPcovIncludedInInitialTestPhpOptions(): bool
             $this->initialTestPhpOptions
         );
     }
+
+    public function hasSkipInitialTestSuiteWithoutCoverageOption(): bool
+    {
+        return $this->skipInitialTestSuite && !$this->skipCoverage;
+    }
 }
diff --git a/src/TestFramework/Coverage/CoverageDoesNotExistException.php b/src/TestFramework/Coverage/CoverageDoesNotExistException.php
@@ -92,4 +92,9 @@ public static function unableToGenerate(): self
             self::INFECTION_USAGE_SUGGESTION
         );
     }
+
+    public static function mustAlreadyExist(): self
+    {
+        return new self('When skipping the initial test suite run, existing code coverage must be provided using --coverage');
+    }
 }
diff --git a/tests/phpunit/Process/Coverage/CoverageRequirementCheckerTest.php b/tests/phpunit/Process/Coverage/CoverageRequirementCheckerTest.php
@@ -55,7 +55,7 @@ public function test_it_has_debugger_or_coverage_option_on_phpdbg(): void
         $this->requireNoXdebug();
         $this->requireNoPcov();
 
-        $coverageChecker = new CoverageRequirementChecker(false, '');
+        $coverageChecker = new CoverageRequirementChecker(false, false, '');
 
         $this->assertTrue($coverageChecker->hasDebuggerOrCoverageOption());
     }
@@ -66,7 +66,7 @@ public function test_it_has_debugger_or_coverage_option_on_pcov(): void
         $this->requireNoXdebug();
         $this->requirePcov();
 
-        $coverageChecker = new CoverageRequirementChecker(false, '');
+        $coverageChecker = new CoverageRequirementChecker(false, false, '');
 
         $this->assertTrue($coverageChecker->hasDebuggerOrCoverageOption());
     }
@@ -77,7 +77,7 @@ public function test_it_has_debugger_or_coverage_option_with_xdebug(): void
         $this->requireNoPcov();
         $this->requireXdebug();
 
-        $coverageChecker = new CoverageRequirementChecker(false, '');
+        $coverageChecker = new CoverageRequirementChecker(false, false, '');
 
         $this->assertTrue($coverageChecker->hasDebuggerOrCoverageOption());
     }
@@ -88,7 +88,7 @@ public function test_it_has_debug_or_coverage_option_when_provided_with_coverage
         $this->requireNoXdebug();
         $this->requireNoPcov();
 
-        $coverageChecker = new CoverageRequirementChecker(true, '');
+        $coverageChecker = new CoverageRequirementChecker(true, false, '');
 
         $this->assertTrue($coverageChecker->hasDebuggerOrCoverageOption());
     }
@@ -99,7 +99,7 @@ public function test_it_has_debug_or_coverage_option_when_provided_with_correct_
         $this->requireNoXdebug();
         $this->requireNoPcov();
 
-        $coverageChecker = new CoverageRequirementChecker(false, '-d zend_extension=xdebug.so');
+        $coverageChecker = new CoverageRequirementChecker(false, false, '-d zend_extension=xdebug.so');
 
         $this->assertTrue($coverageChecker->hasDebuggerOrCoverageOption());
     }
@@ -110,7 +110,7 @@ public function test_it_has_debug_or_coverage_option_when_provided_with_correct_
         $this->requireNoXdebug();
         $this->requireNoPcov();
 
-        $coverageChecker = new CoverageRequirementChecker(false, '-d extension=pcov.so');
+        $coverageChecker = new CoverageRequirementChecker(false, false, '-d extension=pcov.so');
 
         $this->assertTrue($coverageChecker->hasDebuggerOrCoverageOption());
     }
@@ -121,11 +121,39 @@ public function test_it_has_no_debug_or_coverage_option_when_provided_with_incor
         $this->requireNoXdebug();
         $this->requireNoPcov();
 
-        $coverageChecker = new CoverageRequirementChecker(false, '--help');
+        $coverageChecker = new CoverageRequirementChecker(false, false, '--help');
 
         $this->assertFalse($coverageChecker->hasDebuggerOrCoverageOption());
     }
 
+    public function test_it_has_skip_initial_test_suite_without_coverage(): void
+    {
+        $coverageChecker = new CoverageRequirementChecker(false, true, '');
+
+        $this->assertTrue($coverageChecker->hasSkipInitialTestSuiteWithoutCoverageOption());
+    }
+
+    public function test_it_has_skip_initial_test_suite_with_coverage(): void
+    {
+        $coverageChecker = new CoverageRequirementChecker(true, true, '');
+
+        $this->assertFalse($coverageChecker->hasSkipInitialTestSuiteWithoutCoverageOption());
+    }
+
+    public function test_it_doesnt_have_skip_initial_test_suite_without_coverage(): void
+    {
+        $coverageChecker = new CoverageRequirementChecker(false, false, '');
+
+        $this->assertFalse($coverageChecker->hasSkipInitialTestSuiteWithoutCoverageOption());
+    }
+
+    public function test_it_doesnt_have_skip_initial_test_suite_with_coverage(): void
+    {
+        $coverageChecker = new CoverageRequirementChecker(true, false, '');
+
+        $this->assertFalse($coverageChecker->hasSkipInitialTestSuiteWithoutCoverageOption());
+    }
+
     private function requirePhpDbg(): void
     {
         if (PHP_SAPI !== 'phpdbg') {