feat(test): add Client::loginUser() (#4588)

Author: dunglas

CHANGELOG.md

@@ -45,6 +45,7 @@
 * A new configuration is available to keep old services (IriConverter, IdentifiersExtractor and OpenApiFactory) `metadata_backward_compatibility_layer` (defaults to false) (#4351)
 * Add support for `security_post_validation` attribute
 * Mark the GraphQL subsystem as stable (#4500)
+* feat(test): add `Client::loginUser()`
 
 ## 2.6.7
 

src/Symfony/Bundle/Test/Client.php

@@ -20,6 +20,7 @@
 use Symfony\Component\HttpClient\HttpClientTrait;
 use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\HttpKernel\Profiler\Profile;
+use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 use Symfony\Contracts\HttpClient\ResponseStreamInterface;
@@ -243,4 +244,15 @@ private static function extractHeaders(array $options): array
 
         return $headers;
     }
+
+    public function loginUser(UserInterface $user, string $firewallContext = 'main'): self
+    {
+        if (!method_exists($this->kernelBrowser, 'loginUser')) {
+            throw new \LogicException(sprintf('"%s" requires symfony/framework-bundle 5.1+ to be installed.', __METHOD__));
+        }
+
+        $this->kernelBrowser->loginUser($user, $firewallContext);
+
+        return $this;
+    }
 }

tests/Symfony/Bundle/Test/ClientTest.php

@@ -18,7 +18,9 @@
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Tools\SchemaTool;
 use PHPUnit\Runner\Version;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
 use Symfony\Component\HttpKernel\Profiler\Profile;
+use Symfony\Component\Security\Core\User\InMemoryUser;
 
 /**
  * @group legacy
@@ -162,4 +164,17 @@ public function testStream(): void
         $client = self::createClient();
         $client->stream([]);
     }
+
+    public function testLoginUser(): void
+    {
+        if (!method_exists(KernelBrowser::class, 'loginUser')) {
+            $this->markTestSkipped('symfony/framework-bundle 5.1 is required to test this function');
+        }
+
+        $client = self::createClient();
+        $client->loginUser(new InMemoryUser('dunglas', 'kevin', ['ROLE_USER']));
+
+        $client->request('GET', '/secured_dummies');
+        $this->assertResponseIsSuccessful();
+    }
 }