Merge pull request #3048 from stof/fix_deprecation

stof · web-flow · commit 0b96e8284895 · 2022-10-24T16:26:22.000+02:00
Fix deprecations reported on Symfony 5.4
diff --git a/DependencyInjection/Compiler/InjectRememberMeServicesPass.php b/DependencyInjection/Compiler/InjectRememberMeServicesPass.php
@@ -34,7 +34,9 @@ public function process(ContainerBuilder $container)
         $firewallName = $container->getParameter('fos_user.firewall_name');
         $loginManager = $container->getDefinition('fos_user.security.login_manager');
 
-        if ($container->hasDefinition('security.authentication.rememberme.services.persistent.'.$firewallName)) {
+        if ($container->has('security.authenticator.remember_me_handler.'.$firewallName)) {
+            $loginManager->replaceArgument(4, new Reference('security.authenticator.remember_me_handler.'.$firewallName));
+        } elseif ($container->hasDefinition('security.authentication.rememberme.services.persistent.'.$firewallName)) {
             $loginManager->replaceArgument(4, new Reference('security.authentication.rememberme.services.persistent.'.$firewallName));
         } elseif ($container->hasDefinition('security.authentication.rememberme.services.simplehash.'.$firewallName)) {
             $loginManager->replaceArgument(4, new Reference('security.authentication.rememberme.services.simplehash.'.$firewallName));
diff --git a/Security/LoginManager.php b/Security/LoginManager.php
@@ -16,7 +16,9 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
+use Symfony\Component\Security\Core\Authorization\Voter\CacheableVoterInterface;
 use Symfony\Component\Security\Core\User\UserCheckerInterface;
+use Symfony\Component\Security\Http\RememberMe\RememberMeHandlerInterface;
 use Symfony\Component\Security\Http\RememberMe\RememberMeServicesInterface;
 use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;
 
@@ -48,23 +50,27 @@ class LoginManager implements LoginManagerInterface
     private $requestStack;
 
     /**
-     * @var RememberMeServicesInterface
+     * @var RememberMeHandlerInterface|RememberMeServicesInterface|null
      */
-    private $rememberMeService;
+    private $rememberMeHandler;
 
     /**
-     * LoginManager constructor.
+     * @param RememberMeHandlerInterface|RememberMeServicesInterface|null $rememberMeHandler
      */
     public function __construct(TokenStorageInterface $tokenStorage, UserCheckerInterface $userChecker,
                                 SessionAuthenticationStrategyInterface $sessionStrategy,
                                 RequestStack $requestStack,
-                                RememberMeServicesInterface $rememberMeService = null
+                                $rememberMeHandler = null
     ) {
+        if (null !== $rememberMeHandler && !$rememberMeHandler instanceof RememberMeHandlerInterface && !$rememberMeHandler instanceof RememberMeServicesInterface) {
+            throw new \TypeError(sprintf('Argument 2 passed to "%s()" must be an instance of "%s|%s|null", "%s" given.', __METHOD__, RememberMeHandlerInterface::class, RememberMeServicesInterface::class, \is_object($rememberMeHandler) ? \get_class($rememberMeHandler) : \gettype($rememberMeHandler)));
+        }
+
         $this->tokenStorage = $tokenStorage;
         $this->userChecker = $userChecker;
         $this->sessionStrategy = $sessionStrategy;
         $this->requestStack = $requestStack;
-        $this->rememberMeService = $rememberMeService;
+        $this->rememberMeHandler = $rememberMeHandler;
     }
 
     /**
@@ -80,8 +86,10 @@ final public function logInUser($firewallName, UserInterface $user, Response $re
         if (null !== $request) {
             $this->sessionStrategy->onAuthentication($request, $token);
 
-            if (null !== $response && null !== $this->rememberMeService) {
-                $this->rememberMeService->loginSuccess($request, $response, $token);
+            if (null !== $response && $this->rememberMeHandler instanceof RememberMeServicesInterface) {
+                $this->rememberMeHandler->loginSuccess($request, $response, $token);
+            } elseif ($this->rememberMeHandler instanceof RememberMeHandlerInterface) {
+                $this->rememberMeHandler->createRememberMeCookie($user);
             }
         }
 
@@ -95,6 +103,11 @@ final public function logInUser($firewallName, UserInterface $user, Response $re
      */
     protected function createToken($firewall, UserInterface $user)
     {
-        return new UsernamePasswordToken($user, null, $firewall, $user->getRoles());
+        // Bc layer for Symfony <5.4
+        if (!interface_exists(CacheableVoterInterface::class)) {
+            return new UsernamePasswordToken($user, null, $firewall, $user->getRoles());
+        }
+
+        return new UsernamePasswordToken($user, $firewall, $user->getRoles());
     }
 }
diff --git a/Tests/Security/EmailProviderTest.php b/Tests/Security/EmailProviderTest.php
@@ -15,6 +15,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
 use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
+use Symfony\Component\Security\Core\Exception\UserNotFoundException;
 
 class EmailProviderTest extends TestCase
 {
@@ -47,7 +48,11 @@ public function testLoadUserByUsername()
 
     public function testLoadUserByInvalidUsername()
     {
-        $this->expectException(UsernameNotFoundException::class);
+        if (class_exists(UserNotFoundException::class)) {
+            $this->expectException(UserNotFoundException::class);
+        } else {
+            $this->expectException(UsernameNotFoundException::class);
+        }
 
         $this->userManager->expects($this->once())
             ->method('findUserByEmail')
@@ -82,7 +87,11 @@ public function testRefreshUserBy()
 
     public function testRefreshDeleted()
     {
-        $this->expectException(UsernameNotFoundException::class);
+        if (class_exists(UserNotFoundException::class)) {
+            $this->expectException(UserNotFoundException::class);
+        } else {
+            $this->expectException(UsernameNotFoundException::class);
+        }
 
         $user = $this->getMockForAbstractClass('FOS\UserBundle\Model\User');
         $this->userManager->expects($this->once())
diff --git a/Tests/Security/EmailUserProviderTest.php b/Tests/Security/EmailUserProviderTest.php
@@ -15,6 +15,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
 use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
+use Symfony\Component\Security\Core\Exception\UserNotFoundException;
 
 class EmailUserProviderTest extends TestCase
 {
@@ -47,7 +48,11 @@ public function testLoadUserByUsername()
 
     public function testLoadUserByInvalidUsername()
     {
-        $this->expectException(UsernameNotFoundException::class);
+        if (class_exists(UserNotFoundException::class)) {
+            $this->expectException(UserNotFoundException::class);
+        } else {
+            $this->expectException(UsernameNotFoundException::class);
+        }
 
         $this->userManager->expects($this->once())
             ->method('findUserByUsernameOrEmail')
diff --git a/Tests/Security/LoginManagerTest.php b/Tests/Security/LoginManagerTest.php
@@ -11,9 +11,17 @@
 
 namespace FOS\UserBundle\Tests\Security;
 
+use FOS\UserBundle\Model\UserInterface;
 use FOS\UserBundle\Security\LoginManager;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+use Symfony\Component\Security\Http\RememberMe\RememberMeHandlerInterface;
+use Symfony\Component\Security\Http\RememberMe\RememberMeServicesInterface;
+use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;
 
 class LoginManagerTest extends TestCase
 {
@@ -23,66 +31,79 @@ public function testLogInUserWithRequestStack()
         $loginManager->logInUser('main', $this->mockUser());
     }
 
-    public function testLogInUserWithRememberMeAndRequestStack()
+    public function testLogInUserWithRememberMeHandler()
     {
-        $response = $this->getMockBuilder('Symfony\Component\HttpFoundation\Response')->getMock();
+        if (!interface_exists(RememberMeHandlerInterface::class)) {
+            $this->markTestSkipped('This test requires Symfony 5.3+.');
+        }
 
-        $loginManager = $this->createLoginManager('main', $response);
-        $loginManager->logInUser('main', $this->mockUser(), $response);
+        $response = new Response();
+        $user = $this->mockUser();
+
+        $rememberMeHandler = $this->createMock(RememberMeHandlerInterface::class);
+        $rememberMeHandler->expects($this->once())
+            ->method('createRememberMeCookie')
+            ->with($user);
+
+        $loginManager = $this->createLoginManager('main', $rememberMeHandler);
+        $loginManager->logInUser('main', $user, $response);
     }
 
     /**
-     * @param string $firewallName
-     *
-     * @return LoginManager
+     * @group legacy
      */
-    private function createLoginManager($firewallName, Response $response = null)
+    public function testLogInUserWithRememberMeService()
     {
-        $tokenStorage = $this->getMockBuilder('Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface')->getMock();
+        if (!interface_exists(RememberMeServicesInterface::class)) {
+            $this->markTestSkipped('This test does not support Symfony 6+.');
+        }
+
+        $response = new Response();
+
+        $rememberMeService = $this->createMock(RememberMeServicesInterface::class);
+        $rememberMeService
+            ->expects($this->once())
+            ->method('loginSuccess')
+            ->with($this->isInstanceOf(Request::class), $response, $this->isInstanceOf(TokenInterface::class));
+
+        $loginManager = $this->createLoginManager('main', $rememberMeService);
+        $loginManager->logInUser('main', $this->mockUser(), $response);
+    }
 
+    /**
+     * @param RememberMeHandlerInterface|RememberMeServicesInterface|null $rememberMeHandler
+     */
+    private function createLoginManager(string $firewallName, $rememberMeHandler = null): LoginManager
+    {
+        $tokenStorage = $this->getMockBuilder(TokenStorageInterface::class)->getMock();
         $tokenStorage
             ->expects($this->once())
             ->method('setToken')
-            ->with($this->isInstanceOf('Symfony\Component\Security\Core\Authentication\Token\TokenInterface'));
+            ->with($this->isInstanceOf(TokenInterface::class));
 
         $userChecker = $this->getMockBuilder('Symfony\Component\Security\Core\User\UserCheckerInterface')->getMock();
         $userChecker
             ->expects($this->once())
             ->method('checkPreAuth')
-            ->with($this->isInstanceOf('FOS\UserBundle\Model\UserInterface'));
+            ->with($this->isInstanceOf(UserInterface::class));
 
-        $request = $this->getMockBuilder('Symfony\Component\HttpFoundation\Request')->getMock();
+        $request = new Request();
 
-        $sessionStrategy = $this->getMockBuilder('Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface')->getMock();
+        $sessionStrategy = $this->getMockBuilder(SessionAuthenticationStrategyInterface::class)->getMock();
         $sessionStrategy
             ->expects($this->once())
             ->method('onAuthentication')
-            ->with($request, $this->isInstanceOf('Symfony\Component\Security\Core\Authentication\Token\TokenInterface'));
+            ->with($request, $this->isInstanceOf(TokenInterface::class));
 
-        $requestStack = $this->getMockBuilder('Symfony\Component\HttpFoundation\RequestStack')->getMock();
-        $requestStack
-            ->expects($this->once())
-            ->method('getCurrentRequest')
-            ->will($this->returnValue($request));
-
-        $rememberMe = null;
-        if (null !== $response) {
-            $rememberMe = $this->getMockBuilder('Symfony\Component\Security\Http\RememberMe\RememberMeServicesInterface')->getMock();
-            $rememberMe
-                ->expects($this->once())
-                ->method('loginSuccess')
-                ->with($request, $response, $this->isInstanceOf('Symfony\Component\Security\Core\Authentication\Token\TokenInterface'));
-        }
+        $requestStack = new RequestStack();
+        $requestStack->push($request);
 
-        return new LoginManager($tokenStorage, $userChecker, $sessionStrategy, $requestStack, $rememberMe);
+        return new LoginManager($tokenStorage, $userChecker, $sessionStrategy, $requestStack, $rememberMeHandler);
     }
 
-    /**
-     * @return mixed
-     */
-    private function mockUser()
+    private function mockUser(): UserInterface
     {
-        $user = $this->getMockBuilder('FOS\UserBundle\Model\UserInterface')->getMock();
+        $user = $this->getMockBuilder(UserInterface::class)->getMock();
         $user
             ->expects($this->once())
             ->method('getRoles')
diff --git a/Tests/Security/UserProviderTest.php b/Tests/Security/UserProviderTest.php
@@ -15,6 +15,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
 use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
+use Symfony\Component\Security\Core\Exception\UserNotFoundException;
 
 class UserProviderTest extends TestCase
 {
@@ -47,7 +48,11 @@ public function testLoadUserByUsername()
 
     public function testLoadUserByInvalidUsername()
     {
-        $this->expectException(UsernameNotFoundException::class);
+        if (class_exists(UserNotFoundException::class)) {
+            $this->expectException(UserNotFoundException::class);
+        } else {
+            $this->expectException(UsernameNotFoundException::class);
+        }
 
         $this->userManager->expects($this->once())
             ->method('findUserByUsername')
@@ -82,7 +87,11 @@ public function testRefreshUserBy()
 
     public function testRefreshDeleted()
     {
-        $this->expectException(UsernameNotFoundException::class);
+        if (class_exists(UserNotFoundException::class)) {
+            $this->expectException(UserNotFoundException::class);
+        } else {
+            $this->expectException(UsernameNotFoundException::class);
+        }
 
         $user = $this->getMockForAbstractClass('FOS\UserBundle\Model\User');
         $this->userManager->expects($this->once())
diff --git a/Tests/Util/PasswordUpdaterTest.php b/Tests/Util/PasswordUpdaterTest.php
@@ -13,19 +13,28 @@
 
 use FOS\UserBundle\Tests\TestUser;
 use FOS\UserBundle\Util\PasswordUpdater;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Security\Core\Encoder\EncoderFactoryInterface;
 
+/**
+ * @group legacy
+ */
 class PasswordUpdaterTest extends TestCase
 {
     /**
-     * @var PasswordUpdater
+     * @var PasswordUpdater&MockObject
      */
     private $updater;
     private $encoderFactory;
 
     protected function setUp(): void
     {
-        $this->encoderFactory = $this->getMockBuilder('Symfony\Component\Security\Core\Encoder\EncoderFactoryInterface')->getMock();
+        if (!interface_exists(EncoderFactoryInterface::class)) {
+            $this->markTestSkipped('The PasswordUpdater class does not support Symfony 6+.');
+        }
+
+        $this->encoderFactory = $this->getMockBuilder(EncoderFactoryInterface::class)->getMock();
 
         $this->updater = new PasswordUpdater($this->encoderFactory);
     }
diff --git a/Tests/ignored-deprecations.txt b/Tests/ignored-deprecations.txt
@@ -0,0 +1,4 @@
+# SwiftMailer does not put phpdoc on overwritten methods and is not maintained anymore to add them.
+/Method "Swift_[^"]++" might add "[^"]++" as a native return type declaration in the future\. Do the same in implementation "Swift_[^"]++" now to avoid errors or add an explicit @return annotation to suppress this message\./
+# Weird error reported for symfony/validator
+/The "Symfony\\Component\\Validator\\Constraint::\$errorNames" property is considered final\. You should not override it in "Symfony\\Component\\Validator\\Constraints\\NotBlank"\./
diff --git a/composer.json b/composer.json
@@ -51,7 +51,7 @@
         "friendsofphp/php-cs-fixer": "^3.0.2, !=3.5.0",
         "swiftmailer/swiftmailer": "^4.3 || ^5.0 || ^6.0",
         "symfony/console": "^4.4 || ^5.0",
-        "symfony/phpunit-bridge": "^5.3",
+        "symfony/phpunit-bridge": "^6.1",
         "symfony/yaml": "^4.4 || ^5.0"
     },
     "config": {
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -18,7 +18,8 @@
             </exclude>
         </whitelist>
     </filter>
+
     <php>
-        <env name="SYMFONY_DEPRECATIONS_HELPER" value="disabled" />
+        <env name="SYMFONY_DEPRECATIONS_HELPER" value="ignoreFile=Tests/ignored-deprecations.txt&amp;max[total]=0" />
     </php>
 </phpunit>
