migrate to PHPUnit 11 (see #216)

overtrue · Oct 31, 2024 · 0c8b519 · 0c8b519
1 parent e39a262
commit 0c8b519
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 71 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -41,6 +41,6 @@ jobs:
         with:
           composer-options: "--prefer-dist --no-scripts"
 
-      -   # https://github.com/sebastianbergmann/phpunit/tree/10.5
-        name: Unit tests with PHPUnit 10
+      -   # https://github.com/sebastianbergmann/phpunit/tree/11.4
+        name: Unit tests with PHPUnit 11
         run: vendor/bin/phpunit --no-progress --testdox --do-not-cache-result
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd"
          bootstrap="autoload.php"
          executionOrder="depends,defects"
          beStrictAboutOutputDuringTests="true"

diff --git a/tests/Cache/CacheTest.php b/tests/Cache/CacheTest.php
@@ -17,6 +17,7 @@
 use Generator;
 use Overtrue\PHPLint\Cache;
 use Overtrue\PHPLint\Tests\TestCase;
+use PHPUnit\Framework\Attributes\CoversMethod;
 use Symfony\Component\Cache\CacheItem;
 
 use function dirname;
@@ -28,6 +29,12 @@
  * @author Laurent Laville
  * @since Release 9.0.0
  */
+#[CoversMethod(Cache::class, 'hasItem')]
+#[CoversMethod(Cache::class, 'getItem')]
+#[CoversMethod(Cache::class, 'saveItem')]
+#[CoversMethod(Cache::class, 'clear')]
+#[CoversMethod(Cache::class, 'isHit')]
+#[CoversMethod(Cache::class, 'getCalls')]
 final class CacheTest extends TestCase
 {
     private static Cache $cache;
@@ -65,17 +72,11 @@ static function ($key, $value, $isHit) {
         self::$cache = $cache;
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Cache::hasItem
-     */
     public function testHasItem(): void
     {
         $this->assertTrue(self::$cache->hasItem(__FILE__));
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Cache::getItem
-     */
     public function testGetItem(): void
     {
         // expected
@@ -87,9 +88,6 @@ public function testGetItem(): void
         $this->assertSame($item->get(), $cacheItem->get());
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Cache::saveItem
-     */
     public function testSaveItem(): void
     {
         $filename = dirname(__DIR__) . '/EndToEnd/LintCommandTest.php';
@@ -103,59 +101,38 @@ public function testSaveItem(): void
         $this->assertEquals($fingerprint, self::$cache->getItem($filename)->get());
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Cache::clear
-     */
     public function testClearPool(): void
     {
         $cleared = self::$cache->clear();
         $this->assertTrue($cleared);
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Cache::isHit
-     */
     public function testCacheHit(): void
     {
         $this->assertTrue(self::$cache->isHit(__FILE__));
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Cache::isHit
-     */
     public function testCacheMiss(): void
     {
         $this->assertFalse(self::$cache->isHit(dirname(__DIR__) . '/EndToEnd/LintCommandTest.php'));
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Cache::isHit
-     */
     public function testCacheMissWithFileUnknown(): void
     {
         $this->assertFalse(self::$cache->isHit(dirname(__DIR__) . '/Finder/FinderTest.php'));
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Cache::isHit
-     */
     public function testCacheMissWithWrongFileFingerprint(): void
     {
         $this->assertFalse(self::$cache->isHit(dirname(__DIR__) . '/Configuration/ConfigResolverTest.php'));
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Cache::getCalls
-     */
     public function testGetCalls(): void
     {
         // cache init calls count
         $this->assertCount(3, self::$cache->getCalls());
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Cache::saveItem
-     */
     public function testFilenameHasReservedCharacters(): void
     {
         $filename = dirname(__DIR__) . '/EndToEnd/[email protected]';

diff --git a/tests/Configuration/ConsoleConfigTest.php b/tests/Configuration/ConsoleConfigTest.php
@@ -16,22 +16,20 @@
 use Overtrue\PHPLint\Command\LintCommand;
 use Overtrue\PHPLint\Configuration\ConsoleOptionsResolver;
 use Overtrue\PHPLint\Configuration\OptionDefinition;
-use Overtrue\PHPLint\Configuration\OptionsFactory;
 use Overtrue\PHPLint\Configuration\Resolver;
 use Overtrue\PHPLint\Event\EventDispatcher;
 use Overtrue\PHPLint\Tests\TestCase;
+use PHPUnit\Framework\Attributes\CoversMethod;
+use PHPUnit\Framework\Attributes\DataProvider;
 use Symfony\Component\Console\Input\ArrayInput;
 
-use Symfony\Component\OptionsResolver\OptionsResolver;
-
 use function dirname;
 use function realpath;
 
+#[CoversMethod(ConsoleOptionsResolver::class, 'getOption')]
+#[CoversMethod(ConsoleOptionsResolver::class, 'getOptions')]
 final class ConsoleConfigTest extends TestCase
 {
-    /**
-     * @covers \Overtrue\PHPLint\Configuration\ConsoleOptionsResolver::getOption
-     */
     public function testConfigFileNotReadable(): void
     {
         $dispatcher = new EventDispatcher([]);
@@ -44,10 +42,7 @@ public function testConfigFileNotReadable(): void
         $this->assertFalse(realpath($resolver->getOption(OptionDefinition::CONFIGURATION)));
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Configuration\ConsoleOptionsResolver::getOptions
-     * @dataProvider commandInputProvider
-     */
+    #[DataProvider('commandInputProvider')]
     public function testCommandConfig(array $arguments, callable $fetchExpected): void
     {
         $dispatcher = new EventDispatcher([]);

diff --git a/tests/Configuration/YamlConfigTest.php b/tests/Configuration/YamlConfigTest.php
@@ -16,18 +16,18 @@
 use Overtrue\PHPLint\Command\LintCommand;
 use Overtrue\PHPLint\Configuration\FileOptionsResolver;
 use Overtrue\PHPLint\Configuration\OptionDefinition;
-use Overtrue\PHPLint\Configuration\OptionsFactory;
 use Overtrue\PHPLint\Configuration\Resolver;
 use Overtrue\PHPLint\Event\EventDispatcher;
 use Overtrue\PHPLint\Tests\TestCase;
+use PHPUnit\Framework\Attributes\CoversMethod;
+use PHPUnit\Framework\Attributes\DataProvider;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
 
+#[CoversMethod(FileOptionsResolver::class, 'getOption')]
+#[CoversMethod(FileOptionsResolver::class, 'getOptions')]
 final class YamlConfigTest extends TestCase
 {
-    /**
-     * @covers \Overtrue\PHPLint\Configuration\FileOptionsResolver
-     */
     public function testInvalidYamlFile(): void
     {
         $this->expectException(InvalidOptionsException::class);
@@ -41,10 +41,7 @@ public function testInvalidYamlFile(): void
         new FileOptionsResolver($input);
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Configuration\FileOptionsResolver::getOptions
-     * @dataProvider commandInputProvider
-     */
+    #[DataProvider('commandInputProvider')]
     public function testYamlConfig(array $arguments, callable $fetchExpected): void
     {
         $dispatcher = new EventDispatcher([]);

diff --git a/tests/EndToEnd/LintCommandTest.php b/tests/EndToEnd/LintCommandTest.php
@@ -16,8 +16,8 @@
 use Overtrue\PHPLint\Command\LintCommand;
 use Overtrue\PHPLint\Console\Application;
 use Overtrue\PHPLint\Event\EventDispatcher;
-use Overtrue\PHPLint\Extension\OutputFormat;
 use Overtrue\PHPLint\Tests\TestCase;
+use PHPUnit\Framework\Attributes\CoversMethod;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Tester\CommandTester;
 
@@ -27,6 +27,7 @@
  * @author Laurent Laville
  * @since Release 9.0.0
  */
+#[CoversMethod(LintCommand::class, '')]
 final class LintCommandTest extends TestCase
 {
     private ?CommandTester $commandTester;
@@ -54,9 +55,6 @@ protected function tearDown(): void
         $this->commandTester = null;
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Command\LintCommand
-     */
     public function testLintDirectoryWithoutConfigurationAndCache(): void
     {
         $arguments = [
@@ -74,9 +72,6 @@ public function testLintDirectoryWithoutConfigurationAndCache(): void
         );
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Command\LintCommand
-     */
     public function testLintSyntaxErrorFileWithoutConfigurationAndCache(): void
     {
         $arguments = [

diff --git a/tests/Finder/FinderTest.php b/tests/Finder/FinderTest.php
@@ -21,6 +21,7 @@
 use Overtrue\PHPLint\Event\EventDispatcher;
 use Overtrue\PHPLint\Finder;
 use Overtrue\PHPLint\Tests\TestCase;
+use PHPUnit\Framework\Attributes\CoversMethod;
 use Symfony\Component\Console\Input\ArrayInput;
 
 use function array_keys;
@@ -33,11 +34,9 @@
  * @author Laurent Laville
  * @since Release 9.0.0
  */
+#[CoversMethod(Finder::class, 'getFiles')]
 final class FinderTest extends TestCase
 {
-    /**
-     * @covers \Overtrue\PHPLint\Finder::getFiles
-     */
     public function testAllPhpFilesFoundShouldExists(): void
     {
         $dispatcher = new EventDispatcher([]);
@@ -62,9 +61,6 @@ public function testAllPhpFilesFoundShouldExists(): void
         }
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Finder::getFiles
-     */
     public function testAllPathShouldExistsAndReadable(): void
     {
         $this->expectException(LogicException::class);
@@ -86,9 +82,6 @@ public function testAllPathShouldExistsAndReadable(): void
         count($finder->getFiles());
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Finder::getFiles
-     */
     public function testSearchPhpFilesWithCondition(): void
     {
         $dispatcher = new EventDispatcher([]);

diff --git a/tests/Output/OutputTest.php b/tests/Output/OutputTest.php
@@ -22,6 +22,7 @@
 use Overtrue\PHPLint\Output\JunitOutput;
 use Overtrue\PHPLint\Output\LinterOutput;
 use Overtrue\PHPLint\Tests\TestCase;
+use PHPUnit\Framework\Attributes\CoversMethod;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Output\OutputInterface;
 
@@ -37,6 +38,7 @@
  * @author Laurent Laville
  * @since Release 9.5.3
  */
+#[CoversMethod(JunitOutput::class, 'format')]
 final class OutputTest extends TestCase
 {
     private LinterOutput $linterOutput;
@@ -73,9 +75,6 @@ protected function setUp(): void
         $this->linterOutput->setContext($configResolver, $startTime, 2, $defaults);
     }
 
-    /**
-     * @covers \Overtrue\PHPLint\Output\JunitOutput::format
-     */
     public function testJunitOutput(): void
     {
         $stream = fopen('php://memory', 'w+');

diff --git a/vendor-bin/phpunit/composer.json b/vendor-bin/phpunit/composer.json
@@ -1,5 +1,5 @@
 {
   "require-dev": {
-    "phpunit/phpunit": "^10.0"
+    "phpunit/phpunit": "^11.0"
   }
 }