Fix sebastianbergmann#3701 by respecting forceCoversAnnotation before…

… test
andrewnicols · May 22, 2019 · 00ea7b1 · 00ea7b1
1 parent 24e7530
commit 00ea7b1
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 7 deletions.
diff --git a/src/Framework/TestCase.php b/src/Framework/TestCase.php
@@ -84,6 +84,11 @@ abstract class TestCase extends Assert implements SelfDescribing, Test
      */
     protected $preserveGlobalState = true;
 
+    /**
+     * @var bool
+     */
+    protected $forceCoversAnnotation = true;
+
     /**
      * @var bool
      */
@@ -1046,6 +1051,16 @@ public function isInIsolation(): bool
         return $this->inIsolation;
     }
 
+    public function setForceCoversAnnotation(bool $forceCoversAnnotation): void
+    {
+        $this->forceCoversAnnotation = $forceCoversAnnotation;
+    }
+
+    public function getForceCoversAnnotation(): bool
+    {
+        return $this->forceCoversAnnotation;
+    }
+
     public function getResult()
     {
         return $this->testResult;

diff --git a/src/Framework/TestSuite.php b/src/Framework/TestSuite.php
@@ -40,6 +40,11 @@ class TestSuite implements \IteratorAggregate, SelfDescribing, Test
      */
     protected $runTestInSeparateProcess = false;
 
+    /**
+     * @var bool
+     */
+    protected $forceCoversAnnotation = false;
+
     /**
      * The name of the test suite.
      *
@@ -542,6 +547,7 @@ public function run(TestResult $result = null): TestResult
                 $test->setBackupGlobals($this->backupGlobals);
                 $test->setBackupStaticAttributes($this->backupStaticAttributes);
                 $test->setRunTestInSeparateProcess($this->runTestInSeparateProcess);
+                $test->setForceCoversAnnotation($this->forceCoversAnnotation);
             }
 
             $test->run($result);
@@ -577,6 +583,11 @@ public function setRunTestInSeparateProcess(bool $runTestInSeparateProcess): voi
         $this->runTestInSeparateProcess = $runTestInSeparateProcess;
     }
 
+    public function setForceCoversAnnotation(bool $forceCoversAnnotation): void
+    {
+        $this->forceCoversAnnotation = $forceCoversAnnotation;
+    }
+
     public function setName(string $name): void
     {
         $this->name = $name;

diff --git a/src/Util/Test.php b/src/Util/Test.php
@@ -162,14 +162,18 @@ public static function requiresCodeCoverageDataCollection(TestCase $test): bool
             return true;
         }
 
+        // If there is no @covers annotation and forceCoversAnnotation is set,
+        // then code coverage data does not need to be collected.
+        if ($test->getForceCoversAnnotation()) {
+            return false;
+        }
+
         // If there is no @covers annotation but a @coversNothing annotation
         // then code coverage data does not need to be collected
         if (isset($annotations['class']['coversNothing'])) {
             return false;
         }
 
-        // If there is no @coversNothing annotation then
-        // code coverage data may be collected
         return true;
     }
 

diff --git a/tests/unit/Util/TestTest.php b/tests/unit/Util/TestTest.php
@@ -1328,11 +1328,12 @@ public function testCoversAnnotationIncludesTraitsUsedByClass(): void
     /**
      * @dataProvider canSkipCoverageProvider
      */
-    public function testCanSkipCoverage($testCase, $expectedCanSkip): void
+    public function testCanSkipCoverage($testCase, $expectedCanSkip, $forceCoversAnnotation): void
     {
         require_once TEST_FILES_PATH . $testCase . '.php';
 
         $test             = new $testCase('testSomething');
+        $test->setForceCoversAnnotation($forceCoversAnnotation);
         $coverageRequired = Test::requiresCodeCoverageDataCollection($test);
         $canSkipCoverage  = !$coverageRequired;
 
@@ -1342,10 +1343,15 @@ public function testCanSkipCoverage($testCase, $expectedCanSkip): void
     public function canSkipCoverageProvider(): array
     {
         return [
-            ['CoverageClassWithoutAnnotationsTest', false],
-            ['CoverageClassTest', false],
-            ['CoverageNothingTest', false],
-            ['CoverageCoversOverridesCoversNothingTest', false],
+            ['CoverageClassTest', false, false],
+            ['CoverageClassWithoutAnnotationsTest', false, false],
+            ['CoverageNothingTest', false, false],
+            ['CoverageCoversOverridesCoversNothingTest', false, false],
+
+            ['CoverageClassTest', false, true],
+            ['CoverageClassWithoutAnnotationsTest', true, true],
+            ['CoverageNothingTest', false, true],
+            ['CoverageCoversOverridesCoversNothingTest', false, true],
         ];
     }