feature #1116 [Live] add TestLiveComponent::actingAs() (kbond)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

[Live] add `TestLiveComponent::actingAs()`

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| Tickets       | (slack discussion)
| License       | MIT

```php
$this->createLiveComponent('my_component')
    ->actingAs($user) // UserInterface
    ->...
;
```

Additionally, the test client can be passed to `InteractsWithLiveComponents::createLiveComponent()`:

```php
// customize the test client
$client = self::getContainer()->get('test.client');

// do some stuff with the client (ie login user via form)

$testComponent = $this->createLiveComponent(
    name: 'MyComponent',
    data: ['foo' => 'bar'],
    client: $client,
);
```

Commits
-------

3762fc4 [Live] add `TestLiveComponent::actingAs()`

Author: weaverryan

src/LiveComponent/doc/index.rst

@@ -3123,6 +3123,20 @@ uses Symfony's test client to render and make requests to your components::
             $response = $testComponent->call('redirect')->response(); // Symfony\Component\HttpFoundation\Response
 
             $this->assertSame(302, $response->getStatusCode());
+
+            // authenticate a user ($user is instance of UserInterface)
+            $testComponent->actingAs($user);
+
+            // customize the test client
+            $client = self::getContainer()->get('test.client');
+
+            // do some stuff with the client (ie login user via form)
+
+            $testComponent = $this->createLiveComponent(
+                name: 'MyComponent',
+                data: ['foo' => 'bar'],
+                client: $client,
+            );
         }
     }
 

src/LiveComponent/src/Test/InteractsWithLiveComponents.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\UX\LiveComponent\Test;
 
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Symfony\UX\TwigComponent\ComponentFactory;
 
@@ -19,7 +20,7 @@
  */
 trait InteractsWithLiveComponents
 {
-    protected function createLiveComponent(string $name, array $data = []): TestLiveComponent
+    protected function createLiveComponent(string $name, array $data = [], KernelBrowser $client = null): TestLiveComponent
     {
         if (!$this instanceof KernelTestCase) {
             throw new \LogicException(sprintf('The "%s" trait can only be used on "%s" classes.', __TRAIT__, KernelTestCase::class));
@@ -37,7 +38,7 @@ protected function createLiveComponent(string $name, array $data = []): TestLive
             $metadata,
             $data,
             $factory,
-            self::getContainer()->get('test.client'),
+            $client ?? self::getContainer()->get('test.client'),
             self::getContainer()->get('ux.live_component.component_hydrator'),
             self::getContainer()->get('ux.live_component.metadata_factory'),
             self::getContainer()->get('router'),

src/LiveComponent/src/Test/TestLiveComponent.php

@@ -14,6 +14,7 @@
 use Symfony\Bundle\FrameworkBundle\KernelBrowser;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\UX\LiveComponent\LiveComponentHydrator;
 use Symfony\UX\LiveComponent\Metadata\LiveComponentMetadataFactory;
 use Symfony\UX\TwigComponent\ComponentFactory;
@@ -76,6 +77,16 @@ public function component(): object
         return (new MountedComponent($this->metadata->getName(), $component, $componentAttributes))->getComponent();
     }
 
+    /**
+     * @param UserInterface $user
+     */
+    public function actingAs(object $user, string $firewallContext = 'main'): self
+    {
+        $this->client->loginUser($user, $firewallContext);
+
+        return $this;
+    }
+
     /**
      * @param array<string,mixed> $arguments
      */