Fix sebastianbergmann#3697 Respect @coversNothing at coverage driver …

…start
andrewnicols · May 21, 2019 · 86cb787 · 86cb787
1 parent 41a5260
commit 86cb787
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 14 deletions.
diff --git a/src/Util/Test.php b/src/Util/Test.php
@@ -162,12 +162,18 @@ public static function requiresCodeCoverageDataCollection(TestCase $test): bool
             return true;
         }
 
-        // If there is no @covers annotation but a @coversNothing annotation
-        // then code coverage data does not need to be collected
+        // If there is no @covers annotation but a @coversNothing annotation on
+        // the test class then code coverage data does not need to be collected
         if (isset($annotations['class']['coversNothing'])) {
             return false;
         }
 
+        // If there is no @covers annotation but a @coversNothing annotation on
+        // the test method then code coverage data does not need to be collected
+        if (isset($annotations['method']['coversNothing'])) {
+            return false;
+        }
+
         // If there is no @coversNothing annotation then
         // code coverage data may be collected
         return true;
@@ -1270,14 +1276,14 @@ private static function sanitizeVersionNumber(string $version)
 
     private static function shouldCoversAnnotationBeUsed(array $annotations): bool
     {
-        if (isset($annotations['method']['coversNothing'])) {
-            return false;
-        }
-
         if (isset($annotations['method']['covers'])) {
             return true;
         }
 
+        if (isset($annotations['method']['coversNothing'])) {
+            return false;
+        }
+
         if (isset($annotations['class']['coversNothing'])) {
             return false;
         }

diff --git a/tests/_files/CoverageNothingTest.php → ...verridesCoversNothingSameDocblockTest.php b/tests/_files/CoverageNothingTest.php → ...verridesCoversNothingSameDocblockTest.php
@@ -9,7 +9,7 @@
  */
 use PHPUnit\Framework\TestCase;
 
-class CoverageNothingTest extends TestCase
+class CoverageCoversOverridesCoversNothingSameDocblockTest extends TestCase
 {
     /**
      * @covers CoveredClass::publicMethod

diff --git a/tests/_files/CoverageNothingClassTest.php b/tests/_files/CoverageNothingClassTest.php
@@ -0,0 +1,22 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @coversNothing
+ */
+class CoverageNothingClassTest extends TestCase
+{
+    public function testSomething(): void
+    {
+        $o = new CoveredClass;
+        $o->publicMethod();
+    }
+}
diff --git a/tests/_files/CoverageNothingMethodTest.php b/tests/_files/CoverageNothingMethodTest.php
@@ -0,0 +1,22 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+use PHPUnit\Framework\TestCase;
+
+class CoverageNothingMethodTest extends TestCase
+{
+    /**
+     * @coversNothing
+     */
+    public function testSomething(): void
+    {
+        $o = new CoveredClass;
+        $o->publicMethod();
+    }
+}
diff --git a/tests/unit/Util/TestTest.php b/tests/unit/Util/TestTest.php
@@ -1065,11 +1065,15 @@ public function testGetLinesToBeCovered($test, $lines): void
             $expected = [
                 TEST_FILES_PATH . 'NamespaceCoveredClass.php' => $lines,
             ];
+        } elseif ($test === 'CoverageCoversOverridesCoversNothingSameDocblockTest') {
+            $expected = [TEST_FILES_PATH . 'CoveredClass.php' => $lines];
         } elseif ($test === 'CoverageCoversOverridesCoversNothingTest') {
             $expected = [TEST_FILES_PATH . 'CoveredClass.php' => $lines];
         } elseif ($test === 'CoverageNoneTest') {
             $expected = [];
-        } elseif ($test === 'CoverageNothingTest') {
+        } elseif ($test === 'CoverageNothingMethodTest') {
+            $expected = false;
+        } elseif ($test === 'CoverageNothingClassTest') {
             $expected = false;
         } elseif ($test === 'CoverageFunctionTest') {
             $expected = [
@@ -1292,13 +1296,21 @@ public function getLinesToBeCoveredProvider(): array
                 \range(31, 35),
             ],
             [
-                'CoverageNothingTest',
+                'CoverageNothingClassTest',
+                false,
+            ],
+            [
+                'CoverageNothingMethodTest',
                 false,
             ],
             [
                 'CoverageCoversOverridesCoversNothingTest',
                 \range(29, 33),
             ],
+            [
+                'CoverageCoversOverridesCoversNothingSameDocblockTest',
+                \range(29, 33),
+            ],
         ];
     }
 
@@ -1332,18 +1344,20 @@ public function testCanSkipCoverage($testCase, $expectedCanSkip): void
     {
         require_once TEST_FILES_PATH . $testCase . '.php';
 
-        $test            = new $testCase;
-        $canSkipCoverage = Test::requiresCodeCoverageDataCollection($test);
+        $test             = new $testCase('testSomething');
+        $coverageRequired = Test::requiresCodeCoverageDataCollection($test);
 
-        $this->assertEquals($expectedCanSkip, $canSkipCoverage);
+        $this->assertEquals($expectedCanSkip, !$coverageRequired);
     }
 
     public function canSkipCoverageProvider(): array
     {
         return [
-            ['CoverageClassTest', true],
-            ['CoverageNothingTest', true],
+            ['CoverageClassTest', false],
+            ['CoverageCoversOverridesCoversNothingSameDocblockTest', false],
             ['CoverageCoversOverridesCoversNothingTest', false],
+            ['CoverageNothingClassTest', true],
+            ['CoverageNothingMethodTest', true],
         ];
     }