Fix coverage of phpunit data providers (#352)

atk4 · Jul 6, 2022 · 9686c15 · 9686c15
1 parent 34e4383
commit 9686c15
Show file tree

Hide file tree

Showing 21 changed files with 70 additions and 67 deletions.
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -9,12 +9,9 @@
     </listeners>
     <coverage>
         <include>
-            <directory suffix=".php">src</directory>
+            <directory>src</directory>
+            <directory>tests</directory>
         </include>
-        <exclude>
-            <file>src/Phpunit/ResultPrinter.php</file>
-            <file>src/Phpunit/TestCase.php</file>
-        </exclude>
         <report>
             <php outputFile="coverage/phpunit.cov" />
         </report>

diff --git a/src/DebugTrait.php b/src/DebugTrait.php
@@ -16,8 +16,6 @@ trait DebugTrait
 
     /**
      * Outputs message to STDERR.
-     *
-     * @codeCoverageIgnore - replaced with "echo" which can be intercepted by test-suite
      */
     protected function _echoStderr(string $message): void
     {

diff --git a/src/Exception.php b/src/Exception.php
@@ -143,8 +143,6 @@ public function addMoreInfo(string $param, $value): self
     /**
      * Add a suggested/possible solution to the exception.
      *
-     * @TODO can be added more features? usually we are out of App
-     *
      * @return $this
      */
     public function addSolution(string $solution): self

diff --git a/src/Phpunit/TestCase.php b/src/Phpunit/TestCase.php
@@ -14,8 +14,40 @@ abstract class TestCase extends BaseTestCase
 {
     use WarnDynamicPropertyTrait;
 
+    protected function setUp(): void
+    {
+        // rerun data providers to fix coverage when coverage for test files is enabled
+        // https://github.com/sebastianbergmann/php-code-coverage/issues/920
+        $staticClass = get_class(new class() {
+            /** @var array<string, true> */
+            public static $processedMethods = [];
+        });
+        $classRefl = new \ReflectionClass(static::class);
+        foreach ($classRefl->getMethods() as $methodRefl) {
+            $methodDoc = $methodRefl->getDocComment();
+            if ($methodDoc !== false && preg_match('~@dataProvider[ \t]+([\w\x7f-\xff]+::)?([\w\x7f-\xff]+)~', $methodDoc, $matches)) {
+                $providerClassRefl = $matches[1] === '' ? $classRefl : new \ReflectionClass($matches[1]);
+                $providerMethodRefl = $providerClassRefl->getMethod($matches[2]);
+                $key = $providerClassRefl->getName() . '::' . $providerMethodRefl->getName();
+                if (!isset($staticClass::$processedMethods[$key])) {
+                    $staticClass::$processedMethods[static::class] = true;
+                    $providerInstance = $providerClassRefl->newInstanceWithoutConstructor();
+                    $provider = $providerMethodRefl->invoke($providerInstance);
+                    if (!is_array($provider)) {
+                        // yield all provider data
+                        iterator_to_array($provider);
+                    }
+                }
+            }
+        }
+
+        parent::setUp();
+    }
+
     protected function tearDown(): void
     {
+        parent::tearDown();
+
         // remove once https://github.com/sebastianbergmann/phpunit/issues/4705 is fixed
         foreach (array_keys(array_diff_key(get_object_vars($this), get_class_vars(BaseTestCase::class))) as $k) {
             $this->{$k} = \PHP_MAJOR_VERSION < 8

diff --git a/src/ReadableCaptionTrait.php b/src/ReadableCaptionTrait.php
@@ -14,13 +14,11 @@ trait ReadableCaptionTrait
      */
     public function readableCaption(string $s): string
     {
-        // $s = 'this\\ _isNASA_MyBigBull shit_123\Foo';
-
         // first remove not allowed characters and uppercase words
-        $s = ucwords(preg_replace('/[^a-z0-9]+/i', ' ', $s));
+        $s = ucwords(preg_replace('~[^a-z\d]+~i', ' ', $s));
 
         // and then run regex to split camelcased words too
-        $s = array_map('trim', preg_split('/^[^A-Z\d]+\K|[A-Z\d][^A-Z\d]+\K/', $s, -1, \PREG_SPLIT_NO_EMPTY));
+        $s = array_map('trim', preg_split('~(?:^|[A-Z\d])[^A-Z\d]+\K~', $s, -1, \PREG_SPLIT_NO_EMPTY));
         $s = implode(' ', $s);
 
         return $s;

diff --git a/src/Translator/Translator.php b/src/Translator/Translator.php
@@ -75,21 +75,11 @@ public function setDefaultDomain(string $defaultDomain): self
         return $this;
     }
 
-    /**
-     * No clone.
-     *
-     * @codeCoverageIgnore
-     */
     protected function __clone()
     {
         throw new Exception('Translator cannot be cloned');
     }
 
-    /**
-     * No serialize.
-     *
-     * @codeCoverageIgnore
-     */
     public function __wakeup(): void
     {
         throw new Exception('Translator cannot be serialized');
@@ -119,8 +109,6 @@ public function setAdapter(ITranslatorAdapter $translator): self
 
     /**
      * Get the adapter.
-     *
-     * @TODO should remain private?
      */
     private function getAdapter(): ITranslatorAdapter
     {

diff --git a/tests/AppScopeTraitTest.php b/tests/AppScopeTraitTest.php
@@ -10,9 +10,6 @@
 use Atk4\Core\Phpunit\TestCase;
 use Atk4\Core\TrackableTrait;
 
-/**
- * @coversDefaultClass \Atk4\Core\AppScopeTrait
- */
 class AppScopeTraitTest extends TestCase
 {
     public function testConstruct(): void

diff --git a/tests/CollectionTraitTest.php b/tests/CollectionTraitTest.php
@@ -7,9 +7,6 @@
 use Atk4\Core;
 use Atk4\Core\Phpunit\TestCase;
 
-/**
- * @coversDefaultClass \Atk4\Core\ContainerTrait
- */
 class CollectionTraitTest extends TestCase
 {
     public function testBasic(): void

diff --git a/tests/ConfigTraitTest.php b/tests/ConfigTraitTest.php
@@ -7,9 +7,6 @@
 use Atk4\Core\ConfigTrait;
 use Atk4\Core\Phpunit\TestCase;
 
-/**
- * @coversDefaultClass \Atk4\Core\ConfigTrait
- */
 class ConfigTraitTest extends TestCase
 {
     /** @var string */

diff --git a/tests/ContainerTraitTest.php b/tests/ContainerTraitTest.php
@@ -7,9 +7,6 @@
 use Atk4\Core;
 use Atk4\Core\Phpunit\TestCase;
 
-/**
- * @coversDefaultClass \Atk4\Core\ContainerTrait
- */
 class ContainerTraitTest extends TestCase
 {
     public function testBasic(): void

diff --git a/tests/DebugTraitTest.php b/tests/DebugTraitTest.php
@@ -8,9 +8,6 @@
 use Atk4\Core\DebugTrait;
 use Atk4\Core\Phpunit\TestCase;
 
-/**
- * @coversDefaultClass \Atk4\Core\DebugTrait
- */
 class DebugTraitTest extends TestCase
 {
     /**

diff --git a/tests/DiContainerTraitTest.php b/tests/DiContainerTraitTest.php
@@ -8,9 +8,6 @@
 use Atk4\Core\Exception;
 use Atk4\Core\Phpunit\TestCase;
 
-/**
- * @coversDefaultClass \Atk4\Core\DiContainerTrait
- */
 class DiContainerTraitTest extends TestCase
 {
     public function testFromSeed(): void

diff --git a/tests/DynamicMethodTraitTest.php b/tests/DynamicMethodTraitTest.php
@@ -10,9 +10,6 @@
 use Atk4\Core\HookTrait;
 use Atk4\Core\Phpunit\TestCase;
 
-/**
- * @coversDefaultClass \Atk4\Core\DynamicMethodTrait
- */
 class DynamicMethodTraitTest extends TestCase
 {
     public function testConstruct(): void

diff --git a/tests/ExceptionTest.php b/tests/ExceptionTest.php
@@ -9,9 +9,6 @@
 use Atk4\Core\Phpunit\TestCase;
 use Atk4\Core\TrackableTrait;
 
-/**
- * @coversDefaultClass \Atk4\Core\Exception
- */
 class ExceptionTest extends TestCase
 {
     public function testBasic(): void

diff --git a/tests/FactoryTest.php b/tests/FactoryTest.php
@@ -10,9 +10,6 @@
 use Atk4\Core\HookBreaker;
 use Atk4\Core\Phpunit\TestCase;
 
-/**
- * @coversDefaultClass \Atk4\Core\Factory
- */
 class FactoryTest extends TestCase
 {
     public function testMerge1(): void

diff --git a/tests/HookTraitTest.php b/tests/HookTraitTest.php
@@ -9,9 +9,6 @@
 use Atk4\Core\HookTrait;
 use Atk4\Core\Phpunit\TestCase;
 
-/**
- * @coversDefaultClass \Atk4\Core\HookTrait
- */
 class HookTraitTest extends TestCase
 {
     public function testArguments(): void

diff --git a/tests/InitializerTraitTest.php b/tests/InitializerTraitTest.php
@@ -8,9 +8,6 @@
 use Atk4\Core\Exception;
 use Atk4\Core\Phpunit\TestCase;
 
-/**
- * @coversDefaultClass \Atk4\Core\InitializerTrait
- */
 class InitializerTraitTest extends TestCase
 {
     public function testInit(): void

diff --git a/tests/Phpunit/TestCaseTest.php b/tests/Phpunit/TestCaseTest.php
@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atk4\Core\Tests\Phpunit;
+
+use Atk4\Core\Phpunit\TestCase;
+
+class TestCaseTest extends TestCase
+{
+    /** @var int */
+    private static $providerCallCounter = 0;
+
+    private function coverCoverageFromProvider(): void
+    {
+        ++self::$providerCallCounter;
+    }
+
+    /**
+     * @dataProvider provideProviderCoverage
+     */
+    public function testProviderCoverage(string $v): void
+    {
+        $this->assertGreaterThan(1, self::$providerCallCounter);
+        $this->assertTrue(in_array($v, ['x', 'y'], true));
+    }
+
+    public function provideProviderCoverage(): \Traversable
+    {
+        yield ['x'];
+        $this->coverCoverageFromProvider();
+        yield ['y'];
+    }
+}
diff --git a/tests/ReadableCaptionTraitTest.php b/tests/ReadableCaptionTraitTest.php
@@ -7,9 +7,6 @@
 use Atk4\Core\Phpunit\TestCase;
 use Atk4\Core\ReadableCaptionTrait;
 
-/**
- * @coversDefaultClass \Atk4\Core\ReadableCaptionTrait
- */
 class ReadableCaptionTraitTest extends TestCase
 {
     /**

diff --git a/tests/StaticAddToTest.php b/tests/StaticAddToTest.php
@@ -57,9 +57,6 @@ public function __construct(string $name)
     }
 }
 
-/**
- * @coversDefaultClass \Atk4\Core\StaticAddToTrait
- */
 class StaticAddToTest extends TestCase
 {
     public function testBasic(): void

diff --git a/tests/TraitUtilTest.php b/tests/TraitUtilTest.php
@@ -9,9 +9,6 @@
 use Atk4\Core\Phpunit\TestCase;
 use Atk4\Core\TraitUtil;
 
-/**
- * @coversDefaultClass \Atk4\Core\TraitUtil
- */
 class TraitUtilTest extends TestCase
 {
     public function testHasTrait(): void