fix(tests): migrate from phpdocs to attributes (#419)

phpdocs are deprecated in phpunit11
web-push-libs · Feb 4, 2025 · a2b1c0a · a2b1c0a
1 parent b9c07b4
commit a2b1c0a
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 26 deletions.
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -7,8 +7,9 @@
     '@PHP81Migration'                     => true, // Must be the same as the min PHP version.
     'blank_line_after_opening_tag'        => false, // Do not waste space between <?php and declare.
     'global_namespace_import'             => ['import_classes' => false, 'import_constants' => false, 'import_functions' => false],
-    'php_unit_test_class_requires_covers' => true,
+    'php_unit_attributes'                 => true,
     'php_unit_method_casing'              => true,
+    'php_unit_test_class_requires_covers' => true,
     // Do not enable by default. These rules require review!! (but they are useful)
     // '@PHP80Migration:risky'      => true,
     // '@PHPUnit100Migration:risky' => true,

diff --git a/tests/EncryptionTest.php b/tests/EncryptionTest.php
@@ -12,11 +12,10 @@
 use Jose\Component\Core\JWK;
 use Minishlink\WebPush\Encryption;
 use Minishlink\WebPush\Utils;
+use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 
-/**
- * @covers \Minishlink\WebPush\Encryption
- */
+#[CoversClass(Encryption::class)]
 final class EncryptionTest extends PHPUnit\Framework\TestCase
 {
     public function testBase64Encode(): void

diff --git a/tests/MessageSentReportTest.php b/tests/MessageSentReportTest.php
@@ -7,12 +7,11 @@
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
 use Minishlink\WebPush\MessageSentReport;
+use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
-/**
- * @covers \Minishlink\WebPush\MessageSentReport
- */
+#[CoversClass(MessageSentReport::class)]
 class MessageSentReportTest extends TestCase
 {
     #[dataProvider('generateReportsWithExpiration')]

diff --git a/tests/PushServiceTest.php b/tests/PushServiceTest.php
@@ -11,14 +11,15 @@
 use Minishlink\WebPush\MessageSentReport;
 use Minishlink\WebPush\Subscription;
 use Minishlink\WebPush\WebPush;
+use PHPUnit\Framework\Attributes\CoversNothing;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Group;
 
 /**
  * Test with test server.
- * @coversNothing
  */
 #[group('online')]
+#[CoversNothing]
 final class PushServiceTest extends PHPUnit\Framework\TestCase
 {
     private static int    $timeout    = 30;

diff --git a/tests/SubscriptionTest.php b/tests/SubscriptionTest.php
@@ -1,10 +1,9 @@
 <?php declare(strict_types=1);
 
 use Minishlink\WebPush\Subscription;
+use PHPUnit\Framework\Attributes\CoversClass;
 
-/**
- * @covers \Minishlink\WebPush\Subscription
- */
+#[CoversClass(Subscription::class)]
 class SubscriptionTest extends PHPUnit\Framework\TestCase
 {
     public function testCreateMinimal(): void

diff --git a/tests/UtilsTest.php b/tests/UtilsTest.php
@@ -2,11 +2,10 @@
 
 use Jose\Component\KeyManagement\JWKFactory;
 use Minishlink\WebPush\Utils;
+use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
 
-/**
- * @covers \Minishlink\WebPush\Utils
- */
+#[CoversClass(Utils::class)]
 final class UtilsTest extends TestCase
 {
     public function testSerializePublicKey(): void

diff --git a/tests/VAPIDTest.php b/tests/VAPIDTest.php
@@ -10,11 +10,10 @@
 
 use Minishlink\WebPush\Utils;
 use Minishlink\WebPush\VAPID;
+use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 
-/**
- * @covers \Minishlink\WebPush\VAPID
- */
+#[CoversClass(VAPID::class)]
 final class VAPIDTest extends PHPUnit\Framework\TestCase
 {
     public static function vapidProvider(): array
@@ -74,10 +73,6 @@ public function testGetVapidHeaders(string $audience, array $vapid, string $cont
         }
     }
 
-    /**
-     * @param string $auth
-     * @return array
-     */
     private function explodeAuthorization(string $auth): array
     {
         $auth = explode('.', $auth);

diff --git a/tests/WebPushTest.php b/tests/WebPushTest.php
@@ -11,11 +11,10 @@
 use Minishlink\WebPush\Subscription;
 use Minishlink\WebPush\SubscriptionInterface;
 use Minishlink\WebPush\WebPush;
+use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 
-/**
- * @covers \Minishlink\WebPush\WebPush
- */
+#[CoversClass(WebPush::class)]
 final class WebPushTest extends PHPUnit\Framework\TestCase
 {
     private static array $endpoints;
@@ -135,8 +134,6 @@ public static function notificationProvider(): array
     }
 
     /**
-     * @param SubscriptionInterface $subscription
-     * @param string                $payload
      * @throws ErrorException
      */
     #[dataProvider('notificationProvider')]