[FrameworkBundle][Test]: add token attributes in KernelBrowser::loginUser()

PEHAUT-PIETRI Valmont · chalasr · commit 1d38977d4bf9 · 2023-09-16T00:46:14.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -24,6 +24,7 @@ CHANGELOG
  * Deprecate not setting the `framework.validation.email_validation_mode` config option; it will default to `html5` in 7.0
  * Deprecate `framework.validation.enable_annotations`, use `framework.validation.enable_attributes` instead
  * Deprecate `framework.serializer.enable_annotations`, use `framework.serializer.enable_attributes` instead
+ * Add `array $tokenAttributes = []` optional parameter to `KernelBrowser::loginUser()`
 
 6.3
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/KernelBrowser.php b/src/Symfony/Bundle/FrameworkBundle/KernelBrowser.php
@@ -107,12 +107,15 @@ public function enableReboot()
     }
 
     /**
-     * @param UserInterface $user
+     * @param UserInterface        $user
+     * @param array<string, mixed> $tokenAttributes
      *
      * @return $this
      */
-    public function loginUser(object $user, string $firewallContext = 'main'): static
+    public function loginUser(object $user, string $firewallContext = 'main'/* , array $tokenAttributes = [] */): static
     {
+        $tokenAttributes = 2 < \func_num_args() ? func_get_arg(2) : [];
+
         if (!interface_exists(UserInterface::class)) {
             throw new \LogicException(sprintf('"%s" requires symfony/security-core to be installed. Try running "composer require symfony/security-core".', __METHOD__));
         }
@@ -122,6 +125,7 @@ public function loginUser(object $user, string $firewallContext = 'main'): stati
         }
 
         $token = new TestBrowserToken($user->getRoles(), $user, $firewallContext);
+        $token->setAttributes($tokenAttributes);
         // required for compatibility with Symfony 5.4
         if (method_exists($token, 'isAuthenticated')) {
             $token->setAuthenticated(true, false);

Original file line number	Diff line number	Diff line change
`@@ -107,12 +107,15 @@ public function enableReboot()`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`/**`
`110`		`- * @param UserInterface $user`
	`110`	`+ * @param UserInterface $user`
	`111`	`+ * @param array<string, mixed> $tokenAttributes`
`111`	`112`	`*`
`112`	`113`	`* @return $this`
`113`	`114`	`*/`
`114`		`- public function loginUser(object $user, string $firewallContext = 'main'): static`
	`115`	`+ public function loginUser(object $user, string $firewallContext = 'main'/* , array $tokenAttributes = [] */): static`
`115`	`116`	`{`
	`117`	`+ $tokenAttributes = 2 < \func_num_args() ? func_get_arg(2) : [];`
	`118`	`+`
`116`	`119`	`if (!interface_exists(UserInterface::class)) {`
`117`	`120`	`throw new \LogicException(sprintf('"%s" requires symfony/security-core to be installed. Try running "composer require symfony/security-core".', __METHOD__));`
`118`	`121`	`}`
`@@ -122,6 +125,7 @@ public function loginUser(object $user, string $firewallContext = 'main'): stati`
`122`	`125`	`}`
`123`	`126`
`124`	`127`	`$token = new TestBrowserToken($user->getRoles(), $user, $firewallContext);`
	`128`	`+ $token->setAttributes($tokenAttributes);`
`125`	`129`	`// required for compatibility with Symfony 5.4`
`126`	`130`	`if (method_exists($token, 'isAuthenticated')) {`
`127`	`131`	`$token->setAuthenticated(true, false);`