Upgrade to Symfony 6.2, PHP 8.2, PHPUnit 10 (#42)

stfalcon-studio · May 16, 2023 · 34cbd62 · 34cbd62
1 parent b8e7743
commit 34cbd62
Show file tree

Hide file tree

Showing 62 changed files with 172 additions and 321 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -25,6 +25,14 @@ jobs:
       - name: 'Checkout Code'
         uses: actions/checkout@v2
 
+      - name: 'Setup PHP'
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          ini-values: memory_limit=-1
+          coverage: none
+          tools: composer:v2
+
       - name: 'Install Dependencies'
         run: composer install --prefer-dist --no-progress --no-interaction
 
@@ -41,7 +49,7 @@ jobs:
       - name: 'Setup PHP'
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.1
+          php-version: 8.2
           ini-values: memory_limit=-1
           coverage: none
           tools: composer:v2
@@ -66,7 +74,7 @@ jobs:
       - name: 'Setup PHP'
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.1
+          php-version: 8.2
           ini-values: memory_limit=-1
           coverage: none
           tools: composer:v2
@@ -86,10 +94,8 @@ jobs:
       fail-fast: false
       matrix:
         php-version:
-          - '8.1'
           - '8.2'
         symfony-version:
-          - '6.1'
           - '6.2'
     steps:
       - name: 'Checkout Code'
@@ -102,8 +108,6 @@ jobs:
           ini-values: memory_limit=-1
           coverage: none
           tools: composer:v2
-        env:
-          SYMFONY_VERSION: ${{ matrix.symfony-version }}
 
       - name: 'Install PHP dependencies with Composer'
         run: composer install --prefer-dist --no-progress --optimize-autoloader
@@ -125,7 +129,7 @@ jobs:
       - name: 'Setup PHP'
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.1
+          php-version: 8.2
           ini-values: memory_limit=-1
           coverage: pcov
           tools: composer:v2

diff --git a/.styleci.yml b/.styleci.yml
@@ -2,7 +2,7 @@ risky: true
 preset: symfony
 tab-width: 4
 use-tabs: false
-version: 8.1
+version: 8.2
 enabled:
   - combine_consecutive_unsets
   - ordered_class_elements

diff --git a/Tests/Asset/DatetimeVersionStrategyTest.php b/Tests/Asset/DatetimeVersionStrategyTest.php
@@ -19,9 +19,7 @@
 
 final class DatetimeVersionStrategyTest extends TestCase
 {
-    /** @var DateTimeHelper|MockObject */
     private DateTimeHelper|MockObject $dateTimeHelper;
-
     private DatetimeVersionStrategy $datetimeVersionStrategy;
 
     protected function setUp(): void

diff --git a/Tests/Command/AbstractBaseCommandTest.php b/Tests/Command/AbstractBaseCommandTest.php
@@ -12,6 +12,7 @@
 
 namespace StfalconStudio\ApiBundle\Tests\Command;
 
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use StfalconStudio\ApiBundle\Exception\Console\InvalidParameterException;
@@ -21,15 +22,9 @@
 
 final class AbstractBaseCommandTest extends TestCase
 {
-    /** @var OutputFormatterInterface|MockObject */
     private OutputFormatterInterface|MockObject $formatter;
-
-    /** @var InputInterface|MockObject */
     private InputInterface|MockObject $input;
-
-    /** @var OutputInterface|MockObject */
     private OutputInterface|MockObject $output;
-
     private DummyCommand $command;
 
     protected function setUp(): void
@@ -76,11 +71,7 @@ public function testInitializeWrongTypeOfDate(): void
         $this->command->runInitialize($this->input, $this->output);
     }
 
-    /**
-     * @dataProvider dataProviderForInitializeInvalidDateFormat
-     *
-     * @param string $optionValue
-     */
+    #[DataProvider('dataProviderForInitializeInvalidDateFormat')]
     public function testInitializeInvalidDateFormat(string $optionValue): void
     {
         $this->input

diff --git a/...Controller/AbstractDtoBasedActionTest.php → ...roller/AbstractDtoBasedActionTestCase.php b/...Controller/AbstractDtoBasedActionTest.php → ...roller/AbstractDtoBasedActionTestCase.php
@@ -23,30 +23,15 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 
-abstract class AbstractDtoBasedActionTest extends TestCase
+abstract class AbstractDtoBasedActionTestCase extends TestCase
 {
-    /** @var AuthorizationCheckerInterface|MockObject */
     protected AuthorizationCheckerInterface|MockObject $authorizationChecker;
-
-    /** @var EntityValidator|MockObject */
     protected EntityValidator|MockObject $entityValidator;
-
-    /** @var JsonSchemaValidator|MockObject */
     protected JsonSchemaValidator|MockObject $jsonSchemaValidator;
-
-    /** @var Serializer|MockObject */
     protected Serializer|MockObject $serializer;
-
-    /** @var DtoExtractor|MockObject */
     protected DtoExtractor|MockObject $dtoExtractor;
-
-    /** @var EventDispatcherInterface|MockObject */
     protected EventDispatcherInterface|MockObject $eventDispatcher;
-
-    /** @var Request|MockObject */
     protected Request|MockObject $request;
-
-    /** @var AbstractDtoBasedAction */
     protected $action;
 
     protected function setUp(): void

diff --git a/Tests/Controller/DtoBasedActionTest.php → Tests/Controller/DtoBasedActionTestCase.php b/Tests/Controller/DtoBasedActionTest.php → Tests/Controller/DtoBasedActionTestCase.php
@@ -15,9 +15,8 @@
 use StfalconStudio\ApiBundle\DTO\DtoInterface;
 use Symfony\Component\HttpFoundation\Request;
 
-final class DtoBasedActionTest extends AbstractDtoBasedActionTest
+final class DtoBasedActionTestCase extends AbstractDtoBasedActionTestCase
 {
-    /** @var DummyAction */
     protected $action;
 
     protected function setUp(): void

diff --git a/Tests/Controller/DummyAction.php b/Tests/Controller/DummyAction.php
@@ -22,40 +22,21 @@ class DummyAction extends AbstractDtoBasedAction
 {
     use EntityManagerTrait;
 
-    /**
-     * @param Request $request
-     */
     public function doValidateJsonSchema(Request $request): void
     {
         $this->validateJsonSchema($request);
     }
 
-    /**
-     * @param DtoInterface                 $dto
-     * @param Constraint|Constraint[]|null $constraints
-     * @param array|null                   $groups
-     */
     public function doValidateDto(DtoInterface $dto, Constraint|array|null $constraints = null, array $groups = null): void
     {
         $this->validateDto($dto, $constraints, $groups);
     }
 
-    /**
-     * @param mixed                        $entity
-     * @param Constraint|Constraint[]|null $constraints
-     * @param array|null                   $groups
-     */
     public function doValidateEntity(mixed $entity, Constraint|array|null $constraints = null, array $groups = null): void
     {
         $this->validateEntity($entity, $constraints, $groups);
     }
 
-    /**
-     * @param Request     $request
-     * @param object|null $objectToPopulate
-     *
-     * @return DtoInterface
-     */
     public function doGetDtoFromRequest(Request $request, object $objectToPopulate = null): DtoInterface
     {
         return $this->getDtoFromRequest($request, $objectToPopulate);

diff --git a/Tests/EventListener/Console/ConsoleErrorListenerTest.php b/Tests/EventListener/Console/ConsoleErrorListenerTest.php
@@ -22,12 +22,8 @@
 
 final class ConsoleErrorListenerTest extends TestCase
 {
-    /** @var InputInterface|MockObject */
     private InputInterface|MockObject $input;
-
-    /** @var OutputInterface|MockObject */
     private OutputInterface|MockObject $output;
-
     private ConsoleErrorListener $subscriber;
 
     protected function setUp(): void

diff --git a/Tests/EventListener/JWT/JwtRefreshSubscriberTest.php b/Tests/EventListener/JWT/JwtRefreshSubscriberTest.php
@@ -23,18 +23,10 @@
 
 final class JwtRefreshSubscriberTest extends TestCase
 {
-    /** @var RefreshEvent|MockObject */
     private RefreshEvent|MockObject $refreshEvent;
-
-    /** @var TokenInterface|MockObject */
     private TokenInterface|MockObject $token;
-
-    /** @var RefreshToken|MockObject */
     private RefreshToken|MockObject $refreshToken;
-
-    /** @var CredentialsInterface|MockObject */
     private CredentialsInterface|MockObject $user;
-
     private JwtRefreshSubscriber $subscriber;
 
     protected function setUp(): void

diff --git a/Tests/EventListener/JWT/JwtSubscriberTest.php b/Tests/EventListener/JWT/JwtSubscriberTest.php
@@ -25,9 +25,7 @@
 
 final class JwtSubscriberTest extends TestCase
 {
-    /** @var TranslatorInterface|MockObject */
     private TranslatorInterface|MockObject $translator;
-
     private JwtSubscriber $subscriber;
 
     protected function setUp(): void
@@ -64,21 +62,17 @@ public function testGetSubscribedEvents(): void
         self::assertSame($expected, $actual);
     }
 
-    /**
-     * @param MockObject|AuthenticationFailureEvent|string $event
-     * @param string                                       $message
-     *
-     * @dataProvider dataProviderForTestOnAuthenticationFailureResponse
-     */
-    public function testOnAuthenticationFailureResponse(MockObject|AuthenticationFailureEvent|string $event, string $message): void
+    public function testOnAuthenticationFailureResponse(): void
     {
         $this->translator
             ->expects(self::once())
             ->method('trans')
-            ->with($message)
+            ->with('unauthorised_user_message')
             ->willReturn('translated message')
         ;
 
+        $event = $this->createMock(AuthenticationFailureEvent::class);
+
         $event
             ->expects(self::once())
             ->method('setResponse')
@@ -91,11 +85,72 @@ public function testOnAuthenticationFailureResponse(MockObject|AuthenticationFai
         $this->subscriber->onAuthenticationFailureResponse($event);
     }
 
-    public function dataProviderForTestOnAuthenticationFailureResponse(): iterable
+    public function testOnJWTInvalidEvent(): void
+    {
+        $this->translator
+            ->expects(self::once())
+            ->method('trans')
+            ->with('invalid_jwt_token_message')
+            ->willReturn('translated message')
+        ;
+
+        $event = $this->createMock(JWTInvalidEvent::class);
+
+        $event
+            ->expects(self::once())
+            ->method('setResponse')
+            ->with($this->callback(static function (JsonResponse $response) {
+                return '{"error":"unauthorised_user","errorDescription":"translated message"}' === $response->getContent()
+                    && JsonResponse::HTTP_UNAUTHORIZED === $response->getStatusCode();
+            }))
+        ;
+
+        $this->subscriber->onAuthenticationFailureResponse($event);
+    }
+
+    public function testOnJWTNotFoundEvent(): void
+    {
+        $this->translator
+            ->expects(self::once())
+            ->method('trans')
+            ->with('not_found_jwt_token_message')
+            ->willReturn('translated message')
+        ;
+
+        $event = $this->createMock(JWTNotFoundEvent::class);
+
+        $event
+            ->expects(self::once())
+            ->method('setResponse')
+            ->with($this->callback(static function (JsonResponse $response) {
+                return '{"error":"unauthorised_user","errorDescription":"translated message"}' === $response->getContent()
+                    && JsonResponse::HTTP_UNAUTHORIZED === $response->getStatusCode();
+            }))
+        ;
+
+        $this->subscriber->onAuthenticationFailureResponse($event);
+    }
+
+    public function testOnJWTExpiredEvent(): void
     {
-        yield [$this->createMock(AuthenticationFailureEvent::class), 'unauthorised_user_message'];
-        yield [$this->createMock(JWTInvalidEvent::class), 'invalid_jwt_token_message'];
-        yield [$this->createMock(JWTNotFoundEvent::class), 'not_found_jwt_token_message'];
-        yield [$this->createMock(JWTExpiredEvent::class), 'expired_jwt_token_message'];
+        $this->translator
+            ->expects(self::once())
+            ->method('trans')
+            ->with('expired_jwt_token_message')
+            ->willReturn('translated message')
+        ;
+
+        $event = $this->createMock(JWTExpiredEvent::class);
+
+        $event
+            ->expects(self::once())
+            ->method('setResponse')
+            ->with($this->callback(static function (JsonResponse $response) {
+                return '{"error":"unauthorised_user","errorDescription":"translated message"}' === $response->getContent()
+                    && JsonResponse::HTTP_UNAUTHORIZED === $response->getStatusCode();
+            }))
+        ;
+
+        $this->subscriber->onAuthenticationFailureResponse($event);
     }
 }
diff --git a/Tests/EventListener/JWT/TokenBlackListSubscriberTest.php b/Tests/EventListener/JWT/TokenBlackListSubscriberTest.php
@@ -21,9 +21,7 @@
 
 final class TokenBlackListSubscriberTest extends TestCase
 {
-    /** @var JwtBlackListService|MockObject */
     private JwtBlackListService|MockObject $tokenBlackListService;
-
     private TokenBlackListSubscriber $subscriber;
 
     protected function setUp(): void

diff --git a/Tests/EventListener/Kernel/ApiExceptionFormatterListenerTest.php b/Tests/EventListener/Kernel/ApiExceptionFormatterListenerTest.php
@@ -39,30 +39,14 @@ final class ApiExceptionFormatterListenerTest extends TestCase
 {
     private const API_HOST = 'https://test.com';
 
-    /** @var SerializerInterface|MockObject */
     private SerializerInterface|MockObject $serializer;
-
-    /** @var ClientInterface|MockObject */
     private ClientInterface|MockObject $sentryClient;
-
-    /** @var TranslatorInterface|MockObject */
     private TranslatorInterface|MockObject $translator;
-
-    /** @var Request|MockObject */
     private Request|MockObject $request;
-
-    /** @var JsonResponse|MockObject */
     private JsonResponse|MockObject $response;
-
-    /** @var HttpKernelInterface|MockObject */
     private HttpKernelInterface|MockObject $kernel;
-
-    /** @var ExceptionResponseProcessorInterface|MockObject */
     private ExceptionResponseProcessorInterface|MockObject $exceptionResponseProcessor;
-
-    /** @var ExceptionResponseFactory|MockObject */
     private ExceptionResponseFactory|MockObject $exceptionResponseFactory;
-
     private ApiExceptionFormatterListener $exceptionFormatterListener;
 
     protected function setUp(): void