Merge pull request #8821 from paulbalandan/php-unit-attributes

style: Enable `php_unit_attributes`

Author: kenjis

.php-cs-fixer.dist.php

@@ -43,7 +43,8 @@
 
 $overrides = [
     // for updating to coding-standard
-    'modernize_strpos' => true,
+    'modernize_strpos'    => true,
+    'php_unit_attributes' => true,
 ];
 
 $options = [

.php-cs-fixer.no-header.php

@@ -31,7 +31,8 @@
 
 $overrides = [
     // for updating to coding-standard
-    'modernize_strpos' => true,
+    'modernize_strpos'    => true,
+    'php_unit_attributes' => true,
 ];
 
 $options = [

.php-cs-fixer.tests.php

@@ -36,7 +36,8 @@
 $overrides = [
     'void_return' => true,
     // for updating to coding-standard
-    'modernize_strpos' => true,
+    'modernize_strpos'    => true,
+    'php_unit_attributes' => true,
 ];
 
 $options = [

.php-cs-fixer.user-guide.php

@@ -40,7 +40,8 @@
         'leading_backslash_in_global_namespace' => true,
     ],
     // for updating to coding-standard
-    'modernize_strpos' => true,
+    'modernize_strpos'    => true,
+    'php_unit_attributes' => true,
 ];
 
 $options = [

tests/system/API/ResponseTraitTest.php

@@ -13,6 +13,7 @@
 
 namespace CodeIgniter\API;
 
+use PHPUnit\Framework\Attributes\Group;
 use CodeIgniter\Config\Factories;
 use CodeIgniter\Format\FormatterInterface;
 use CodeIgniter\Format\JSONFormatter;
@@ -28,9 +29,8 @@
 
 /**
  * @internal
- *
- * @group Others
  */
+#[Group('Others')]
 final class ResponseTraitTest extends CIUnitTestCase
 {
     private ?MockIncomingRequest $request  = null;

tests/system/AutoReview/ComposerJsonTest.php

@@ -13,17 +13,17 @@
 
 namespace CodeIgniter\AutoReview;
 
+use PHPUnit\Framework\Attributes\CoversNothing;
+use PHPUnit\Framework\Attributes\Group;
 use InvalidArgumentException;
 use JsonException;
 use PHPUnit\Framework\TestCase;
 
 /**
  * @internal
- *
- * @coversNothing
- *
- * @group AutoReview
  */
+#[CoversNothing]
+#[Group('AutoReview')]
 final class ComposerJsonTest extends TestCase
 {
     private array $devComposer;

tests/system/AutoReview/FrameworkCodeTest.php

@@ -13,26 +13,28 @@
 
 namespace CodeIgniter\AutoReview;
 
+use PHPUnit\Framework\Attributes\DataProvider;
 use FilesystemIterator;
+use PHPUnit\Framework\Attributes\Group;
 use PHPUnit\Framework\TestCase;
 use RecursiveDirectoryIterator;
 use RecursiveIteratorIterator;
+use ReflectionAttribute;
 use ReflectionClass;
 use SplFileInfo;
 
 /**
  * @internal
- *
- * @group AutoReview
  */
+#[Group('AutoReview')]
 final class FrameworkCodeTest extends TestCase
 {
     /**
      * Cache of discovered test class names.
      */
     private static array $testClasses = [];
 
-    private static array $recognizedGroupAnnotations = [
+    private static array $recognizedGroupAttributeNames = [
         'AutoReview',
         'CacheLive',
         'DatabaseLive',
@@ -41,11 +43,10 @@ final class FrameworkCodeTest extends TestCase
     ];
 
     /**
-     * @dataProvider provideEachTestClassHasCorrectGroupAnnotation
-     *
      * @param class-string $class
      */
-    public function testEachTestClassHasCorrectGroupAnnotation(string $class): void
+    #[DataProvider('provideEachTestClassHasCorrectGroupAttributeName')]
+    public function testEachTestClassHasCorrectGroupAttributeName(string $class): void
     {
         $reflection = new ReflectionClass($class);
 
@@ -55,27 +56,31 @@ public function testEachTestClassHasCorrectGroupAnnotation(string $class): void
             return;
         }
 
-        $docComment = (string) $reflection->getDocComment();
-        $this->assertNotEmpty($docComment, sprintf('[%s] Test class is missing a class-level PHPDoc.', $class));
+        $attributes = $reflection->getAttributes(Group::class);
+        $this->assertNotEmpty($attributes, sprintf('[%s] Test class is missing a #[Group] attribute.', $class));
 
-        preg_match_all('/@group (\S+)/', $docComment, $matches);
-        array_shift($matches);
-        $this->assertNotEmpty($matches[0], sprintf('[%s] Test class is missing a @group annotation.', $class));
+        $unrecognizedGroups = array_diff(
+            array_map(static function (ReflectionAttribute $attribute): string {
+                $groupAttribute = $attribute->newInstance();
+                assert($groupAttribute instanceof Group);
 
-        $unrecognizedGroups = array_diff($matches[0], self::$recognizedGroupAnnotations);
+                return $groupAttribute->name();
+            }, $attributes),
+            self::$recognizedGroupAttributeNames
+        );
         $this->assertEmpty($unrecognizedGroups, sprintf(
-            "[%s] Unexpected @group annotation%s:\n%s\nExpected annotations to be in \"%s\".",
+            "[%s] Unexpected #[Group] attribute%s:\n%s\nExpected group names to be in \"%s\".",
             $class,
             count($unrecognizedGroups) > 1 ? 's' : '',
             implode("\n", array_map(
-                static fn (string $group): string => sprintf('  * @group %s', $group),
+                static fn (string $group): string => sprintf('  * #[Group(\'%s\')]', $group),
                 $unrecognizedGroups
             )),
-            implode(', ', self::$recognizedGroupAnnotations)
+            implode(', ', self::$recognizedGroupAttributeNames)
         ));
     }
 
-    public static function provideEachTestClassHasCorrectGroupAnnotation(): iterable
+    public static function provideEachTestClassHasCorrectGroupAttributeName(): iterable
     {
         foreach (self::getTestClasses() as $class) {
             yield $class => [$class];

tests/system/Autoloader/AutoloaderTest.php

@@ -13,6 +13,9 @@
 
 namespace CodeIgniter\Autoloader;
 
+use PHPUnit\Framework\Attributes\Group;
+use PHPUnit\Framework\Attributes\RunInSeparateProcess;
+use PHPUnit\Framework\Attributes\PreserveGlobalState;
 use App\Controllers\Home;
 use Closure;
 use CodeIgniter\Exceptions\ConfigException;
@@ -27,9 +30,8 @@
 
 /**
  * @internal
- *
- * @group Others
  */
+#[Group('Others')]
 final class AutoloaderTest extends CIUnitTestCase
 {
     use ReflectionHelper;
@@ -390,10 +392,8 @@ public function testAutoloaderLoadsNonClassFiles(): void
         $loader->unregister();
     }
 
-    /**
-     * @runInSeparateProcess
-     * @preserveGlobalState disabled
-     */
+    #[RunInSeparateProcess]
+    #[PreserveGlobalState(false)]
     public function testLoadHelpers(): void
     {
         // Workaround for errors on PHPUnit 10 and PHP 8.3.

tests/system/Autoloader/FileLocatorCachedTest.php

@@ -13,15 +13,15 @@
 
 namespace CodeIgniter\Autoloader;
 
+use PHPUnit\Framework\Attributes\Group;
 use CodeIgniter\Cache\FactoriesCache\FileVarExportHandler;
 use Config\Autoload;
 use Config\Modules;
 
 /**
  * @internal
- *
- * @group Others
  */
+#[Group('Others')]
 final class FileLocatorCachedTest extends FileLocatorTest
 {
     private FileVarExportHandler $handler;

tests/system/Autoloader/FileLocatorTest.php

@@ -13,6 +13,7 @@
 
 namespace CodeIgniter\Autoloader;
 
+use PHPUnit\Framework\Attributes\Group;
 use CodeIgniter\HTTP\Header;
 use CodeIgniter\Test\CIUnitTestCase;
 use Config\Autoload;
@@ -21,9 +22,9 @@
 /**
  * @internal
  *
- * @group Others
  * @no-final
  */
+#[Group('Others')]
 class FileLocatorTest extends CIUnitTestCase
 {
     protected FileLocatorInterface $locator;