Closes #4246

sebastianbergmann · May 28, 2020 · 61f7c75 · 61f7c75
1 parent a7a3cf2
commit 61f7c75
Show file tree

Hide file tree

Showing 9 changed files with 92 additions and 19 deletions.
diff --git a/ChangeLog-9.2.md b/ChangeLog-9.2.md
@@ -10,6 +10,7 @@ All notable changes of the PHPUnit 9.2 release series are documented in this fil
 
 ### Changed
 
+* [#4246](https://github.com/sebastianbergmann/phpunit/issues/4246): Tests that are supposed to have a `@covers` annotation are now marked as risky even if code coverage is not collected
 * The test runner no longer relies on `$_SERVER['REQUEST_TIME_FLOAT']` for printing the elapsed time
 
 [9.2.0]: https://github.com/sebastianbergmann/phpunit/compare/9.1...master
diff --git a/src/Framework/TestCase.php b/src/Framework/TestCase.php
@@ -632,7 +632,6 @@ public function hasFailed(): bool
      * @throws UtilException
      * @throws \SebastianBergmann\CodeCoverage\CoveredCodeNotExecutedException
      * @throws \SebastianBergmann\CodeCoverage\InvalidArgumentException
-     * @throws \SebastianBergmann\CodeCoverage\MissingCoversAnnotationException
      * @throws \SebastianBergmann\CodeCoverage\RuntimeException
      * @throws \SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException

diff --git a/src/Framework/TestResult.php b/src/Framework/TestResult.php
@@ -17,7 +17,6 @@
 use SebastianBergmann\CodeCoverage\CodeCoverage;
 use SebastianBergmann\CodeCoverage\CoveredCodeNotExecutedException as OriginalCoveredCodeNotExecutedException;
 use SebastianBergmann\CodeCoverage\Exception as OriginalCodeCoverageException;
-use SebastianBergmann\CodeCoverage\MissingCoversAnnotationException as OriginalMissingCoversAnnotationException;
 use SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException;
 use SebastianBergmann\Invoker\Invoker;
 use SebastianBergmann\Invoker\TimeoutException;
@@ -158,6 +157,11 @@ final class TestResult implements \Countable
      */
     private $enforceTimeLimit = false;
 
+    /**
+     * @var bool
+     */
+    private $forceCoversAnnotation = false;
+
     /**
      * @var int
      */
@@ -596,7 +600,6 @@ public function getCollectCodeCoverageInformation(): bool
      *
      * @throws CodeCoverageException
      * @throws OriginalCoveredCodeNotExecutedException
-     * @throws OriginalMissingCoversAnnotationException
      * @throws UnintentionallyCoveredCodeException
      * @throws \SebastianBergmann\CodeCoverage\InvalidArgumentException
      * @throws \SebastianBergmann\CodeCoverage\RuntimeException
@@ -773,6 +776,20 @@ public function run(Test $test): void
             $risky = true;
         }
 
+        if ($this->forceCoversAnnotation) {
+            $annotations = $test->getAnnotations();
+
+            if (!isset($annotations['class']['covers']) && !isset($annotations['method']['covers'])) {
+                $this->addFailure(
+                    $test,
+                    new MissingCoversAnnotationException(
+                        'This test does not have a @covers annotation but is expected to have one'
+                    ),
+                    $time
+                );
+            }
+        }
+
         if ($collectCodeCoverage) {
             $append           = !$risky && !$incomplete && !$skipped;
             $linesToBeCovered = [];
@@ -824,16 +841,6 @@ public function run(Test $test): void
                     ),
                     $time
                 );
-            } catch (OriginalMissingCoversAnnotationException $cce) {
-                if ($linesToBeCovered !== false) {
-                    $this->addFailure(
-                        $test,
-                        new MissingCoversAnnotationException(
-                            'This test does not have a @covers annotation but is expected to have one'
-                        ),
-                        $time
-                    );
-                }
             } catch (OriginalCodeCoverageException $cce) {
                 $error = true;
 
@@ -1114,6 +1121,16 @@ public function isStrictAboutTodoAnnotatedTests(): bool
         return $this->beStrictAboutTodoAnnotatedTests;
     }
 
+    public function forceCoversAnnotation(): void
+    {
+        $this->forceCoversAnnotation = true;
+    }
+
+    public function forcesCoversAnnotation(): bool
+    {
+        return $this->forceCoversAnnotation;
+    }
+
     /**
      * Enables or disables the stopping for risky tests.
      */

diff --git a/src/Framework/TestSuite.php b/src/Framework/TestSuite.php
@@ -550,7 +550,6 @@ public function setGroupDetails(array $groups): void
      * @throws \PHPUnit\Framework\CodeCoverageException
      * @throws \SebastianBergmann\CodeCoverage\CoveredCodeNotExecutedException
      * @throws \SebastianBergmann\CodeCoverage\InvalidArgumentException
-     * @throws \SebastianBergmann\CodeCoverage\MissingCoversAnnotationException
      * @throws \SebastianBergmann\CodeCoverage\RuntimeException
      * @throws \SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException

diff --git a/src/Runner/PhptTestCase.php b/src/Runner/PhptTestCase.php
@@ -103,7 +103,6 @@ public function count(): int
      * @throws Exception
      * @throws \SebastianBergmann\CodeCoverage\CoveredCodeNotExecutedException
      * @throws \SebastianBergmann\CodeCoverage\InvalidArgumentException
-     * @throws \SebastianBergmann\CodeCoverage\MissingCoversAnnotationException
      * @throws \SebastianBergmann\CodeCoverage\RuntimeException
      * @throws \SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException
      * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException

diff --git a/src/TextUI/TestRunner.php b/src/TextUI/TestRunner.php
@@ -541,10 +541,6 @@ public function run(TestSuite $suite, array $arguments = [], array $warnings = [
                 $arguments['strictCoverage']
             );
 
-            $codeCoverage->setForceCoversAnnotation(
-                $arguments['forceCoversAnnotation']
-            );
-
             if (isset($arguments['ignoreDeprecatedCodeUnitsFromCodeCoverage'])) {
                 $codeCoverage->setIgnoreDeprecatedCode(
                     $arguments['ignoreDeprecatedCodeUnitsFromCodeCoverage']
@@ -627,6 +623,10 @@ public function run(TestSuite $suite, array $arguments = [], array $warnings = [
         $result->setTimeoutForMediumTests($arguments['timeoutForMediumTests']);
         $result->setTimeoutForLargeTests($arguments['timeoutForLargeTests']);
 
+        if (isset($arguments['forceCoversAnnotation']) && $arguments['forceCoversAnnotation'] === true) {
+            $result->forceCoversAnnotation();
+        }
+
         $this->processSuiteFilters($suite, $arguments);
         $suite->setRunTestInSeparateProcess($arguments['processIsolation']);
 

diff --git a/tests/end-to-end/force-covers-annotation.phpt b/tests/end-to-end/force-covers-annotation.phpt
@@ -0,0 +1,24 @@
+--TEST--
+phpunit ../../_files/BankAccountTest.php
+--FILE--
+<?php declare(strict_types=1);
+$_SERVER['argv'][1] = '--configuration';
+$_SERVER['argv'][2] = __DIR__ . '/force-covers-annotation/phpunit.xml';
+$_SERVER['argv'][3] = __DIR__ . '/force-covers-annotation/tests/Test.php';
+
+require __DIR__ . '/../bootstrap.php';
+PHPUnit\TextUI\Command::main();
+--EXPECTF--
+PHPUnit %s by Sebastian Bergmann and contributors.
+
+R                                                                   1 / 1 (100%)
+
+Time: %s, Memory: %s
+
+There was 1 risky test:
+
+1) Test::testOne
+This test does not have a @covers annotation but is expected to have one
+
+OK, but incomplete, skipped, or risky tests!
+Tests: 1, Assertions: 1, Risky: 1.
diff --git a/tests/end-to-end/force-covers-annotation/phpunit.xml b/tests/end-to-end/force-covers-annotation/phpunit.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.2/phpunit.xsd"
+         forceCoversAnnotation="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory suffix="Test.php">tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+</phpunit>
diff --git a/tests/end-to-end/force-covers-annotation/tests/Test.php b/tests/end-to-end/force-covers-annotation/tests/Test.php
@@ -0,0 +1,18 @@
+<?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;
+
+final class Test extends TestCase
+{
+    public function testOne(): void
+    {
+        $this->assertTrue(true);
+    }
+}