[TesterBundle] Add AutowireClient attribute (#271)

--------- Co-authored-by: Martin Poirier Théorêt <[email protected]>
mpoiriert · May 21, 2024 · 2d330bf · 2d330bf
1 parent 753929f
commit 2d330bf
Show file tree

Hide file tree

Showing 13 changed files with 260 additions and 126 deletions.
diff --git a/packages/tester-bundle/PHPStan/Rules/Properties/AutowireReadWritePropertiesExtension.php b/packages/tester-bundle/PHPStan/Rules/Properties/AutowireReadWritePropertiesExtension.php
@@ -2,31 +2,35 @@
 
 namespace Draw\Bundle\TesterBundle\PHPStan\Rules\Properties;
 
-use Draw\Bundle\TesterBundle\PHPUnit\Extension\SetUpAutowire\AutowireService;
 use PHPStan\Reflection\PropertyReflection;
 use PHPStan\Rules\Properties\ReadWritePropertiesExtension;
 
 class AutowireReadWritePropertiesExtension implements ReadWritePropertiesExtension
 {
+    public function __construct(
+        private string $attribute
+    ) {
+    }
+
     public function isAlwaysRead(PropertyReflection $property, string $propertyName): bool
     {
         return false;
     }
 
     public function isAlwaysWritten(PropertyReflection $property, string $propertyName): bool
     {
-        return $this->hasProperAttribute($property, $propertyName, AutowireService::class);
+        return $this->hasProperAttribute($property, $propertyName);
     }
 
     public function isInitialized(PropertyReflection $property, string $propertyName): bool
     {
-        return $this->hasProperAttribute($property, $propertyName, AutowireService::class);
+        return $this->hasProperAttribute($property, $propertyName);
     }
 
-    private function hasProperAttribute(PropertyReflection $property, string $propertyName, string $attribute): bool
+    private function hasProperAttribute(PropertyReflection $property, string $propertyName): bool
     {
         $properReflection = $property->getDeclaringClass()->getNativeProperty($propertyName)->getNativeReflection();
 
-        return 0 !== \count($properReflection->getAttributes($attribute, \ReflectionAttribute::IS_INSTANCEOF));
+        return 0 !== \count($properReflection->getAttributes($this->attribute, \ReflectionAttribute::IS_INSTANCEOF));
     }
 }
diff --git a/packages/tester-bundle/PHPUnit/Extension/SetUpAutowire/AutowireClient.php b/packages/tester-bundle/PHPUnit/Extension/SetUpAutowire/AutowireClient.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Draw\Bundle\TesterBundle\PHPUnit\Extension\SetUpAutowire;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class AutowireClient
+{
+    public function __construct(
+        private array $options = [],
+        private array $server = [],
+    ) {
+    }
+
+    public function getOptions(): array
+    {
+        return $this->options;
+    }
+
+    public function getServer(): array
+    {
+        return $this->server;
+    }
+}
diff --git a/packages/tester-bundle/PHPUnit/Extension/SetUpAutowire/SetUpAutowireExtension.php b/packages/tester-bundle/PHPUnit/Extension/SetUpAutowire/SetUpAutowireExtension.php
@@ -2,6 +2,7 @@
 
 namespace Draw\Bundle\TesterBundle\PHPUnit\Extension\SetUpAutowire;
 
+use Draw\Bundle\TesterBundle\WebTestCase as DrawWebTestCase;
 use Draw\Component\Core\Reflection\ReflectionAccessor;
 use Draw\Component\Core\Reflection\ReflectionExtractor;
 use PHPUnit\Event\Code\TestMethod;
@@ -14,6 +15,7 @@
 use PHPUnit\Runner\Extension\ParameterCollection;
 use PHPUnit\TextUI\Configuration\Configuration;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase as SymfonyWebTestCase;
 
 class SetUpAutowireExtension implements Extension
 {
@@ -58,6 +60,8 @@ public function notify(TestPrepared $event): void
                         return;
                     }
 
+                    $this->initializeClients($testCase);
+
                     $container = null;
 
                     foreach ($this->getPropertyAttributes($testCase) as [$property, $serviceId]) {
@@ -96,6 +100,64 @@ public function notify(TestPrepared $event): void
                     }
                 }
 
+                private function initializeClients(TestCase $testCase): void
+                {
+                    $clientAttributes = iterator_to_array($this->getClientAttributes($testCase));
+
+                    if (empty($clientAttributes)) {
+                        return;
+                    }
+
+                    if (!$testCase instanceof SymfonyWebTestCase && !$testCase instanceof DrawWebTestCase) {
+                        throw new \RuntimeException(
+                            sprintf(
+                                'AutowireClient attribute can only be used in %s or %s.',
+                                SymfonyWebTestCase::class,
+                                DrawWebTestCase::class
+                            )
+                        );
+                    }
+
+                    // This is to ensure the kernel is not booted before calling createClient
+                    // Can happen if we use the container in a setUpBeforeClass method or a beforeClass hook
+                    ReflectionAccessor::callMethod(
+                        $testCase,
+                        'ensureKernelShutdown'
+                    );
+
+                    foreach ($clientAttributes as [$property, $attribute]) {
+                        \assert($property instanceof \ReflectionProperty);
+                        \assert($attribute instanceof \ReflectionAttribute);
+
+                        $autoWireClient = $attribute->newInstance();
+                        \assert($autoWireClient instanceof AutowireClient);
+
+                        $property->setValue(
+                            $testCase,
+                            ReflectionAccessor::callMethod(
+                                $testCase,
+                                'createClient',
+                                $autoWireClient->getOptions(),
+                                $autoWireClient->getServer()
+                            )
+                        );
+                    }
+                }
+
+                private function getClientAttributes(TestCase $testCase): iterable
+                {
+                    foreach ((new \ReflectionObject($testCase))->getProperties() as $property) {
+                        $attribute = $property->getAttributes(
+                            AutowireClient::class,
+                            \ReflectionAttribute::IS_INSTANCEOF
+                        )[0] ?? null;
+
+                        if (null !== $attribute) {
+                            yield [$property, $attribute];
+                        }
+                    }
+                }
+
                 /**
                  * @return iterable<array{\ReflectionProperty, string|AutowireMock}>
                  */

diff --git a/packages/tester-bundle/WebTestCase.php b/packages/tester-bundle/WebTestCase.php
@@ -3,11 +3,15 @@
 namespace Draw\Bundle\TesterBundle;
 
 use Symfony\Bundle\FrameworkBundle\KernelBrowser;
+use Symfony\Bundle\FrameworkBundle\Test\DomCrawlerAssertionsTrait;
+use Symfony\Bundle\FrameworkBundle\Test\HttpClientAssertionsTrait;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 
 abstract class WebTestCase extends KernelTestCase
 {
+    use DomCrawlerAssertionsTrait;
+    use HttpClientAssertionsTrait;
     use JsonResponseAssertionsTrait;
 
     protected function tearDown(): void

diff --git a/packages/tester-bundle/extension.neon b/packages/tester-bundle/extension.neon
@@ -1,5 +1,14 @@
 services:
-    draw.tester_bundle.autowire_read_write_properties_extension:
+    draw.tester_bundle.autowire_client_read_write_properties_extension:
         class: Draw\Bundle\TesterBundle\PHPStan\Rules\Properties\AutowireReadWritePropertiesExtension
+        arguments:
+            - 'Draw\Bundle\TesterBundle\PHPUnit\Extension\SetUpAutowire\AutowireClient'
+        tags:
+            - phpstan.properties.readWriteExtension
+
+    draw.tester_bundle.autowire_service_read_write_properties_extension:
+        class: Draw\Bundle\TesterBundle\PHPStan\Rules\Properties\AutowireReadWritePropertiesExtension
+        arguments:
+            - 'Draw\Bundle\TesterBundle\PHPUnit\Extension\SetUpAutowire\AutowireService'
         tags:
             - phpstan.properties.readWriteExtension
diff --git a/tests/Controller/Api/TestDocumentControllerTest.php b/tests/Controller/Api/TestDocumentControllerTest.php
@@ -4,15 +4,21 @@
 
 use App\Message\NewTestDocumentMessage;
 use Draw\Bundle\TesterBundle\Messenger\MessengerTesterTrait;
+use Draw\Bundle\TesterBundle\PHPUnit\Extension\SetUpAutowire\AutowireClient;
+use Draw\Bundle\TesterBundle\PHPUnit\Extension\SetUpAutowire\AutowiredInterface;
 use Draw\Bundle\TesterBundle\WebTestCase;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
 
-class TestDocumentControllerTest extends WebTestCase
+class TestDocumentControllerTest extends WebTestCase implements AutowiredInterface
 {
     use MessengerTesterTrait;
 
+    #[AutowireClient]
+    private KernelBrowser $client;
+
     public function testCreate(): void
     {
-        static::createClient()
+        $this->client
             ->jsonRequest(
                 'POST',
                 '/api/test-documents',

diff --git a/tests/Controller/OpenApiControllerTest.php b/tests/Controller/OpenApiControllerTest.php
@@ -2,10 +2,16 @@
 
 namespace App\Tests\Controller;
 
+use Draw\Bundle\TesterBundle\PHPUnit\Extension\SetUpAutowire\AutowireClient;
+use Draw\Bundle\TesterBundle\PHPUnit\Extension\SetUpAutowire\AutowiredInterface;
 use Draw\Bundle\TesterBundle\WebTestCase;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
 
-class OpenApiControllerTest extends WebTestCase
+class OpenApiControllerTest extends WebTestCase implements AutowiredInterface
 {
+    #[AutowireClient]
+    private KernelBrowser $client;
+
     private bool $writeFile = false;
 
     public function testApiDocScopeAll(): void
@@ -22,9 +28,7 @@ public function assertApiDocIsTheSame(string $scope): void
     {
         $file = __DIR__.sprintf('/fixtures/api-doc-scope-%s.json', $scope);
 
-        $client = static::createClient();
-
-        $client->request('get', '/api-doc.json?scope='.$scope);
+        $this->client->request('get', '/api-doc.json?scope='.$scope);
 
         static::assertResponseIsSuccessful();
         static::assertResponseIsJson();

diff --git a/tests/Controller/PingActionTest.php b/tests/Controller/PingActionTest.php
@@ -2,16 +2,20 @@
 
 namespace App\Tests\Controller;
 
+use Draw\Bundle\TesterBundle\PHPUnit\Extension\SetUpAutowire\AutowireClient;
+use Draw\Bundle\TesterBundle\PHPUnit\Extension\SetUpAutowire\AutowiredInterface;
 use Draw\Bundle\TesterBundle\WebTestCase;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
 use Symfony\Component\HttpFoundation\Response;
 
-class PingActionTest extends WebTestCase
+class PingActionTest extends WebTestCase implements AutowiredInterface
 {
+    #[AutowireClient]
+    private KernelBrowser $client;
+
     public function testPing(): void
     {
-        $client = static::createClient();
-
-        $client->request('GET', '/ping');
+        $this->client->request('GET', '/ping');
 
         static::assertResponseStatusCodeSame(207);
 
@@ -36,9 +40,7 @@ public static function provideTestPingWithContext(): iterable
      */
     public function testPingWithContext(string $context, int $statusCode): void
     {
-        $client = static::createClient();
-
-        $client->request('GET', '/ping/'.$context);
+        $this->client->request('GET', '/ping/'.$context);
 
         static::assertResponseStatusCodeSame($statusCode);