fix(symfony): add a alwaysBootKernel property for BC layer (api-platform#7007)

* fix(symfony): implement $alwaysBootKernel property for bc-layer

* fix(symfony): ensures that getContainer is not overriden

* fix(symfony): update test for kernel boot strategy

* fix(symfony): cs for trigger_deprecation

* fix(symfony): possibility to hide deprecation and set alwaysBootKernel to false by default

* fix(symfony): emulate 5.0 kernel behaviour for functional tests

* fix(symfony): emulate 5.0 kernel behaviour for functional tests

Author: Crovitche-1623

src/Symfony/Bundle/Test/ApiTestCase.php

@@ -28,6 +28,16 @@ abstract class ApiTestCase extends KernelTestCase
 {
     use ApiTestAssertionsTrait;
 
+    /**
+     * If you're using RecreateDatabaseTrait, RefreshDatabaseTrait, ReloadDatabaseTrait from theofidry/AliceBundle, you
+     * probably need to set this property to false in your test class to avoid recreating the database on each client creation.
+     *
+     * - `null` triggers a deprecation message and always boots the kernel
+     * - `false` does not boot the kernel if it's already booted
+     * - `true` always boots the kernel without any deprecation message
+     */
+    protected static ?bool $alwaysBootKernel = null;
+
     /**
      * Creates a Client.
      *
@@ -36,15 +46,23 @@ abstract class ApiTestCase extends KernelTestCase
      */
     protected static function createClient(array $kernelOptions = [], array $defaultOptions = []): Client
     {
-        if (!static::$booted) {
+        if (null === static::$alwaysBootKernel) {
+            trigger_deprecation(
+                'api-platform/symfony',
+                '4.1.0',
+                'In API Platform 5.0, the kernel will not always be booted when a new client is created (see https://github.com/api-platform/core/issues/6971).',
+            );
+        }
+
+        if (static::$alwaysBootKernel || null === static::$alwaysBootKernel) {
             static::bootKernel($kernelOptions);
         }
 
         try {
             /**
              * @var Client
              */
-            $client = static::$kernel->getContainer()->get('test.api_platform.client');
+            $client = self::getContainer()->get('test.api_platform.client');
         } catch (ServiceNotFoundException) {
             if (!class_exists(AbstractBrowser::class) || !trait_exists(HttpClientTrait::class)) {
                 throw new \LogicException('You cannot create the client used in functional tests if the BrowserKit and HttpClient components are not available. Try running "composer require --dev symfony/browser-kit symfony/http-client".');

tests/Functional/ArrayDtoTest.php

@@ -21,6 +21,8 @@ final class ArrayDtoTest extends ApiTestCase
 {
     use SetupClassResourcesTrait;
 
+    protected static ?bool $alwaysBootKernel = false;
+
     /**
      * @return class-string[]
      */

tests/Functional/BackedEnumPropertyTest.php

@@ -28,6 +28,8 @@ final class BackedEnumPropertyTest extends ApiTestCase
     use RecreateSchemaTrait;
     use SetupClassResourcesTrait;
 
+    protected static ?bool $alwaysBootKernel = false;
+
     /**
      * @return class-string[]
      */

tests/Functional/BackedEnumResourceTest.php

@@ -28,6 +28,8 @@ final class BackedEnumResourceTest extends ApiTestCase
 {
     use SetupClassResourcesTrait;
 
+    protected static ?bool $alwaysBootKernel = false;
+
     /**
      * @return class-string[]
      */

tests/Functional/ErrorTest.php

@@ -22,6 +22,8 @@ final class ErrorTest extends ApiTestCase
 {
     use SetupClassResourcesTrait;
 
+    protected static ?bool $alwaysBootKernel = false;
+
     /**
      * @return class-string[]
      */

tests/Functional/FormatTest.php

@@ -21,6 +21,8 @@ final class FormatTest extends ApiTestCase
 {
     use SetupClassResourcesTrait;
 
+    protected static ?bool $alwaysBootKernel = false;
+
     /**
      * @return class-string[]
      */

tests/Functional/HALCircularReference.php

@@ -19,6 +19,8 @@
 
 class HALCircularReference extends ApiTestCase
 {
+    protected static ?bool $alwaysBootKernel = false;
+
     public function testIssue4358(): void
     {
         $r1 = self::createClient()->request('GET', '/resource_a', ['headers' => ['Accept' => 'application/hal+json']]);

tests/Functional/HydraTest.php

@@ -22,6 +22,8 @@ class HydraTest extends ApiTestCase
 {
     use SetupClassResourcesTrait;
 
+    protected static ?bool $alwaysBootKernel = false;
+
     /**
      * @return class-string[]
      */

tests/Functional/Issues/Issue6926Test.php

@@ -22,6 +22,8 @@ class Issue6926Test extends ApiTestCase
 {
     use SetupClassResourcesTrait;
 
+    protected static ?bool $alwaysBootKernel = false;
+
     /**
      * @return class-string[]
      */

tests/Functional/ItemUriTemplateTest.php

@@ -21,6 +21,8 @@ class ItemUriTemplateTest extends ApiTestCase
 {
     use SetupClassResourcesTrait;
 
+    protected static ?bool $alwaysBootKernel = false;
+
     /**
      * @return class-string[]
      */