Added a fix for symfony 5.3 container. (#593)

* Added a fix for symfony 5.3 container.

* Travis should be happy with php8.0+symfony5.3

Author: biozshock

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Removed
  * Drop support of `run:paratest`, if you still need it, define the [`paratest:run` command](https://github.com/liip/LiipFunctionalTestBundle/blob/c732089d9ad32372db4cbee1a5a3c3b53bd40ff6/src/Command/RunParatestCommand.php) in your project
+ * Deprecated usage of `environment` property. Use the `static::$env` property instead.
 
 ## 3.0
 This new major version introduces a number of breaking changes; see the [upgrade guide](UPGRADE-3.0.md) for more details.

src/Test/WebTestCase.php

@@ -25,6 +25,7 @@
 use Symfony\Component\DependencyInjection\ResettableContainerInterface;
 use Symfony\Component\DomCrawler\Crawler;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
@@ -40,10 +41,11 @@ class_alias(KernelBrowser::class, Client::class);
  * @author Benjamin Eberlei <[email protected]>
  *
  * @method ContainerInterface getContainer()
+ * @property string $environment;
  */
 abstract class WebTestCase extends BaseWebTestCase
 {
-    protected $environment = 'test';
+    protected static $env = 'test';
 
     protected $containers;
 
@@ -70,7 +72,7 @@ abstract class WebTestCase extends BaseWebTestCase
      */
     protected function getServiceMockBuilder(string $id): MockBuilder
     {
-        $service = $this->getDependencyInjectionContainer()->get($id);
+        $service = $this->getContainer()->get($id);
         $class = get_class($service);
 
         return $this->getMockBuilder($class)->disableOriginalConstructor();
@@ -83,13 +85,13 @@ protected function runCommand(string $name, array $params = [], bool $reuseKerne
     {
         if (!$reuseKernel) {
             if (null !== static::$kernel) {
-                static::$kernel->shutdown();
+                static::ensureKernelShutdown();
             }
 
-            $kernel = static::$kernel = static::createKernel(['environment' => $this->environment]);
+            $kernel = static::bootKernel(['environment' => self::$env]);
             $kernel->boot();
         } else {
-            $kernel = $this->getDependencyInjectionContainer()->get('kernel');
+            $kernel = $this->getContainer()->get('kernel');
         }
 
         $application = new Application($kernel);
@@ -129,7 +131,7 @@ protected function getVerbosityLevel(): int
         // If `null`, is not yet set
         if (null === $this->verbosityLevel) {
             // Set the global verbosity level that is set as NORMAL by the TreeBuilder in Configuration
-            $level = strtoupper($this->getDependencyInjectionContainer()->getParameter('liip_functional_test.command_verbosity'));
+            $level = strtoupper($this->getContainer()->getParameter('liip_functional_test.command_verbosity'));
             $verbosity = '\Symfony\Component\Console\Output\StreamOutput::VERBOSITY_'.$level;
 
             $this->verbosityLevel = constant($verbosity);
@@ -184,7 +186,7 @@ protected function getDecorated(): bool
     {
         if (null === $this->decorated) {
             // Set the global decoration flag that is set to `true` by the TreeBuilder in Configuration
-            $this->decorated = $this->getDependencyInjectionContainer()->getParameter('liip_functional_test.command_decoration');
+            $this->decorated = $this->getContainer()->getParameter('liip_functional_test.command_decoration');
         }
 
         // Check the local decorated flag
@@ -204,12 +206,12 @@ public function isDecorated(bool $decorated): void
      * Get an instance of the dependency injection container.
      * (this creates a kernel *without* parameters).
      */
-    protected function getDependencyInjectionContainer(): ContainerInterface
+    private function getDependencyInjectionContainer(): ContainerInterface
     {
-        $cacheKey = $this->environment;
+        $cacheKey = self::$env;
         if (empty($this->containers[$cacheKey])) {
             $kernel = static::createKernel([
-                'environment' => $this->environment,
+                'environment' => self::$env,
             ]);
             $kernel->boot();
 
@@ -224,22 +226,60 @@ protected function getDependencyInjectionContainer(): ContainerInterface
         return $this->containers[$cacheKey];
     }
 
+    protected static function createKernel(array $options = []): KernelInterface
+    {
+        if (!isset($options['environment'])) {
+            $options['environment'] = self::$env;
+        }
+
+        return parent::createKernel($options);
+    }
+
     /**
      * Keep support of Symfony < 5.3.
      */
     public function __call(string $name, $arguments)
     {
         if ('getContainer' === $name) {
-            if (method_exists($this, $name)) {
-                return self::getContainer();
-            }
-
             return $this->getDependencyInjectionContainer();
         }
 
         throw new \Exception("Method {$name} is not supported.");
     }
 
+    public function __set($name, $value)
+    {
+        if ($name !== 'environment') {
+            throw new \Exception(sprintf('There is no property with name "%s"', $name));
+        }
+
+        @trigger_error('Setting "environment" property is deprecated, please use self::$env.', \E_USER_DEPRECATED);
+
+        self::$env = $value;
+    }
+
+    public function __isset($name)
+    {
+        if ($name !== 'environment') {
+            throw new \Exception(sprintf('There is no property with name "%s"', $name));
+        }
+
+        @trigger_error('Checking "environment" property is deprecated, please use self::$env.', \E_USER_DEPRECATED);
+
+        return true;
+    }
+
+    public function __get($name)
+    {
+        if ($name !== 'environment') {
+            throw new \Exception(sprintf('There is no property with name "%s"', $name));
+        }
+
+        @trigger_error('Getting "environment" property is deprecated, please use self::$env.', \E_USER_DEPRECATED);
+
+        return self::$env;
+    }
+
     /**
      * Creates an instance of a lightweight Http client.
      *
@@ -261,9 +301,9 @@ protected function makeClient(array $params = []): Client
      */
     protected function makeAuthenticatedClient(array $params = []): Client
     {
-        $username = $this->getDependencyInjectionContainer()
+        $username = $this->getContainer()
             ->getParameter('liip_functional_test.authentication.username');
-        $password = $this->getDependencyInjectionContainer()
+        $password = $this->getContainer()
             ->getParameter('liip_functional_test.authentication.password');
 
         return $this->createClientWithParams($params, $username, $password);
@@ -313,7 +353,7 @@ protected function createUserToken(UserInterface $user, string $firewallName): T
      */
     protected function getUrl(string $route, array $params = [], int $absolute = UrlGeneratorInterface::ABSOLUTE_PATH): string
     {
-        return $this->getDependencyInjectionContainer()->get('router')->generate($route, $params, $absolute);
+        return $this->getContainer()->get('router')->generate($route, $params, $absolute);
     }
 
     /**
@@ -452,7 +492,11 @@ protected function createClientWithParams(array $params, ?string $username = nul
             ]);
         }
 
-        $client = static::createClient(['environment' => $this->environment], $params);
+        if (static::$booted) {
+            static::ensureKernelShutdown();
+        }
+
+        $client = static::createClient(['environment' => self::$env], $params);
 
         if ($this->firewallLogins) {
             // has to be set otherwise "hasPreviousSession" in Request returns false.

tests/App/Resources/views/layout.html.twig

@@ -9,7 +9,7 @@
 
     <body>
         <p id="user">
-            {%- if (app.user is null) -%}
+            {%- if not is_granted('IS_AUTHENTICATED_REMEMBERED') -%}
                 Not logged in.
             {%- else -%}
                 Logged in as {{ app.user.username }}.

tests/App/config.yml

@@ -7,6 +7,7 @@ framework:
     router:          { resource: "%kernel.project_dir%/routing.yml" }
     form:            true
     csrf_protection: true
+    property_access: ~
     session:
         # handler_id set to null will use default session handler from php.ini
         handler_id:  ~
@@ -66,7 +67,7 @@ security:
     firewalls:
         secured_area:
             pattern:  ^/
-            anonymous: true
+            anonymous: lazy
             http_basic:
                 realm: "Admin Area"
             provider: chain_provider
@@ -86,5 +87,7 @@ services:
     Liip\Acme\Tests\App\Controller\DefaultController:
         tags: ['controller.service_arguments']
 
+    Symfony\Component\DependencyInjection\ContainerInterface: '@service_container'
+
 twig:
     default_path: '%kernel.project_dir%/Resources/views/'

tests/Command/CommandTest.php

@@ -70,8 +70,17 @@ public function testRunCommandWithInputs(): void
         $this->assertStringContainsString('Value of answer: AcmeDemoBundle', $this->commandTester->getDisplay());
     }
 
-    public function testRunCommandWithoutOptionsAndNotReuseKernel(): void
+    /**
+     * @dataProvider useEnvProvider
+     */
+    public function testRunCommandWithoutOptionsAndNotReuseKernel(bool $useEnv): void
     {
+        if ($useEnv) {
+            self::$env = 'test';
+        } else {
+            $this->environment = 'test';
+        }
+
         // Run command without options
         $this->commandTester = $this->runCommand('liipfunctionaltestbundle:test');
 
@@ -85,8 +94,15 @@ public function testRunCommandWithoutOptionsAndNotReuseKernel(): void
         $this->assertIsBool($this->getDecorated());
         $this->assertTrue($this->getDecorated());
 
-        // Run command and not reuse kernel
-        $this->environment = 'prod';
+        // Run command and reuse kernel
+        if ($useEnv) {
+            self::$env = 'prod';
+        } else {
+            $this->environment = 'prod';
+        }
+
+        self::ensureKernelShutdown();
+        $this->getContainer();
         $this->commandTester = $this->runCommand('liipfunctionaltestbundle:test', [], true);
 
         $this->assertInstanceOf(CommandTester::class, $this->commandTester);
@@ -95,6 +111,14 @@ public function testRunCommandWithoutOptionsAndNotReuseKernel(): void
         $this->assertStringContainsString('Verbosity level: NORMAL', $this->commandTester->getDisplay());
     }
 
+    public function useEnvProvider(): array
+    {
+        return [
+            [true],
+            [false],
+        ];
+    }
+
     public function testRunCommandWithoutDecoration(): void
     {
         // Set `decorated` to false

tests/Test/WebTestCaseConfigTest.php

@@ -150,11 +150,11 @@ public function testIndexAuthenticationLoginAs(): void
      */
     public function testIndexAuthenticationLoginClient(): void
     {
-        $this->client = static::makeClient();
-
         $this->schemaUpdate();
         $user = $this->loadTestFixtures();
 
+        $this->client = static::makeClient();
+
         $this->loginClient($this->client, $user, 'secured_area');
 
         $path = '/';

tests/Traits/LiipAcmeFixturesTrait.php

@@ -22,7 +22,7 @@ trait LiipAcmeFixturesTrait
     public function schemaUpdate(): void
     {
         // Create database
-        $kernel = $this->getDependencyInjectionContainer()->get('kernel');
+        $kernel = $this->getContainer()->get('kernel');
 
         $application = new Application($kernel);
 
@@ -46,7 +46,7 @@ public function loadTestFixtures(): User
         $user1->setEnabled(true);
         $user1->setConfirmationToken(null);
 
-        $manager = $this->getDependencyInjectionContainer()->get('doctrine')->getManager();
+        $manager = $this->getContainer()->get('doctrine')->getManager();
         $manager->persist($user1);
 
         $user2 = clone $user1;