[Security] Make login redirection logic available to programmatic login

Author: hellomedia

CHANGELOG.md

@@ -8,6 +8,7 @@ CHANGELOG
  * Add `_stateless` attribute to the request when firewall is stateless
  * Add `StatelessAuthenticatorFactoryInterface` for authenticators targeting `stateless` firewalls only and that don't require a user provider
  * Modify "icon.svg" to improve accessibility for blind/low vision users
+ * Make `Security::login()` return the authenticator response
 
 6.2
 ---

Security.php

@@ -56,8 +56,10 @@ public function getFirewallConfig(Request $request): ?FirewallConfig
      * @param UserInterface $user              The user to authenticate
      * @param string|null   $authenticatorName The authenticator name (e.g. "form_login") or service id (e.g. SomeApiKeyAuthenticator::class) - required only if multiple authenticators are configured
      * @param string|null   $firewallName      The firewall name - required only if multiple firewalls are configured
+     *
+     * @return Response|null The authenticator success response if any
      */
-    public function login(UserInterface $user, string $authenticatorName = null, string $firewallName = null): void
+    public function login(UserInterface $user, string $authenticatorName = null, string $firewallName = null): ?Response
     {
         $request = $this->container->get('request_stack')->getCurrentRequest();
         $firewallName ??= $this->getFirewallConfig($request)?->getName();
@@ -69,7 +71,8 @@ public function login(UserInterface $user, string $authenticatorName = null, str
         $authenticator = $this->getAuthenticator($authenticatorName, $firewallName);
 
         $this->container->get('security.user_checker')->checkPreAuth($user);
-        $this->container->get('security.user_authenticator')->authenticateUser($user, $authenticator, $request);
+
+        return $this->container->get('security.user_authenticator')->authenticateUser($user, $authenticator, $request);
     }
 
     /**

Tests/SecurityTest.php

@@ -169,6 +169,57 @@ public function testLogin()
         $security->login($user);
     }
 
+    public function testLoginReturnsAuthenticatorResponse()
+    {
+        $request = new Request();
+        $authenticator = $this->createMock(AuthenticatorInterface::class);
+        $requestStack = $this->createMock(RequestStack::class);
+        $firewallMap = $this->createMock(FirewallMap::class);
+        $firewall = new FirewallConfig('main', 'main');
+        $user = $this->createMock(UserInterface::class);
+        $userChecker = $this->createMock(UserCheckerInterface::class);
+        $userAuthenticator = $this->createMock(UserAuthenticatorInterface::class);
+
+        $container = $this->createMock(ContainerInterface::class);
+        $container
+            ->expects($this->atLeastOnce())
+            ->method('get')
+            ->willReturnMap([
+                ['request_stack', $requestStack],
+                ['security.firewall.map', $firewallMap],
+                ['security.user_authenticator', $userAuthenticator],
+                ['security.user_checker', $userChecker],
+            ])
+        ;
+
+        $requestStack->expects($this->once())->method('getCurrentRequest')->willReturn($request);
+        $firewallMap->expects($this->once())->method('getFirewallConfig')->willReturn($firewall);
+        $userChecker->expects($this->once())->method('checkPreAuth')->with($user);
+        $userAuthenticator->expects($this->once())->method('authenticateUser')
+            ->with($user, $authenticator, $request)
+            ->willReturn(new Response('authenticator response'));
+
+        $firewallAuthenticatorLocator = $this->createMock(ServiceProviderInterface::class);
+        $firewallAuthenticatorLocator
+            ->expects($this->once())
+            ->method('getProvidedServices')
+            ->willReturn(['security.authenticator.custom.dev' => $authenticator])
+        ;
+        $firewallAuthenticatorLocator
+            ->expects($this->once())
+            ->method('get')
+            ->with('security.authenticator.custom.dev')
+            ->willReturn($authenticator)
+        ;
+
+        $security = new Security($container, ['main' => $firewallAuthenticatorLocator]);
+
+        $response = $security->login($user);
+
+        $this->assertInstanceOf(Response::class, $response);
+        $this->assertEquals('authenticator response', $response->getContent());
+    }
+
     public function testLoginWithoutAuthenticatorThrows()
     {
         $request = new Request();