Merge pull request #209 from symfony-cmf/adjust-symfony-test-case

Adjust to Symfony FrameworkBundle changes

Author: dbu

CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+4.0.0
+-----
+
+* [BC-BREAK] Made bootstrap utility methods in BaseTestCase static to not conflict with recent versions of Symfony FrameworkBundle.
+
 3.3.0
 -----
 

composer.json

@@ -41,7 +41,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "3.x-dev"
+            "dev-master": "4.x-dev"
         }
     }
 }

resources/web/router.php

@@ -20,6 +20,6 @@
 
 // otherwise lets run the application
 $_SERVER['DOCUMENT_ROOT'] = __DIR__;
-$_SERVER['SCRIPT_FILENAME'] = __DIR__.DIRECTORY_SEPARATOR.'app_test.php';
+$_SERVER['SCRIPT_FILENAME'] = __DIR__.\DIRECTORY_SEPARATOR.'app_test.php';
 
 require 'app_test.php';

src/Functional/BaseTestCase.php

@@ -15,6 +15,8 @@
 use Symfony\Bundle\FrameworkBundle\Client;
 use Symfony\Bundle\FrameworkBundle\KernelBrowser;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+use Symfony\Cmf\Component\Testing\Functional\DbManager\ORM;
+use Symfony\Cmf\Component\Testing\Functional\DbManager\PHPCR;
 use Symfony\Cmf\Component\Testing\Functional\DbManager\PhpcrDecorator;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Response;
@@ -48,45 +50,62 @@ abstract class BaseTestCase extends WebTestCase
      *  * environment - The environment to use (defaults to 'phpcr')
      *  * debug - If debug should be enabled/disabled (defaults to true)
      */
-    protected function getKernelConfiguration(): array
+    protected static function getKernelConfiguration(): array
     {
         return [];
     }
 
     /**
-     * @return Client|KernelBrowser
+     * {@inheritdoc}
+     *
+     * Overwritten to set the default environment to 'phpcr'.
      */
-    public function getFrameworkBundleClient()
+    protected static function createKernel(array $options = []): KernelInterface
     {
-        if (null === $this->client) {
-            // property does not exist in all symfony versions
-            if (property_exists(self::class, 'booted') && self::$booted) {
-                self::ensureKernelShutdown();
-            }
-            $this->client = self::createClient($this->getKernelConfiguration());
+        // default environment is 'phpcr'
+        if (!isset($options['environment'])) {
+            $options['environment'] = 'phpcr';
         }
 
-        return $this->client;
+        return parent::createKernel($options);
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * Overwritten to set the kernel configuration from getKernelConfiguration.
+     */
+    protected static function bootKernel(array $options = [])
+    {
+        return parent::bootKernel(static::getKernelConfiguration());
     }
 
-    public function getContainer(): ContainerInterface
+    /**
+     * BC with Symfony < 5.3 - when minimum version raises to ^5.3, we can remove this method.
+     */
+    protected static function getContainer(): ContainerInterface
     {
-        return $this->getKernel()->getContainer();
+        if (method_exists(KernelTestCase::class, 'getContainer')) {
+            return parent::getContainer();
+        }
+
+        return self::getKernel()->getContainer();
     }
 
-    public function getKernel(): KernelInterface
+    protected static function getKernel(): KernelInterface
     {
         if (null === static::$kernel) {
-            parent::bootKernel(static::getKernelConfiguration());
+            static::bootKernel();
         }
 
-        if (static::$kernel instanceof  KernelInterface) {
+        if (static::$kernel instanceof KernelInterface) {
             $kernelEnvironment = static::$kernel->getEnvironment();
-            $expectedEnvironment = isset($this->getKernelConfiguration()['environment'])
-                ? $this->getKernelConfiguration()['environment']
+            $expectedEnvironment = isset(static::getKernelConfiguration()['environment'])
+                ? static::getKernelConfiguration()['environment']
                 : 'phpcr';
             if ($kernelEnvironment !== $expectedEnvironment) {
-                parent::bootKernel(static::getKernelConfiguration());
+                var_dump($kernelEnvironment, $expectedEnvironment);
+                static::bootKernel();
             }
         }
 
@@ -98,23 +117,35 @@ public function getKernel(): KernelInterface
     }
 
     /**
-     * Gets the DbManager.
+     * @return Client|KernelBrowser
+     */
+    protected function getFrameworkBundleClient()
+    {
+        if (null === $this->client) {
+            // property does not exist in all symfony versions
+            if (property_exists(self::class, 'booted') && self::$booted) {
+                self::ensureKernelShutdown();
+            }
+            $this->client = self::createClient($this->getKernelConfiguration());
+        }
+
+        return $this->client;
+    }
+
+    /**
+     * Shortcut for getDbManager.
      *
      * @see self::getDbManager
      */
-    public function db($type)
+    protected function db($type)
     {
         return $this->getDbManager($type);
     }
 
     /**
-     * Gets the DbManager.
-     *
-     * @param string $type The Db type
-     *
-     * @return object
+     * @return ORM|PHPCR
      */
-    public function getDbManager($type)
+    protected function getDbManager(string $type)
     {
         if (isset($this->dbManagers[$type])) {
             return $this->dbManagers[$type];
@@ -143,36 +174,7 @@ public function getDbManager($type)
         return $dbManager;
     }
 
-    public static function getKernelClass(): string
-    {
-        if (isset($_SERVER['KERNEL_CLASS']) || isset($_ENV['KERNEL_CLASS'])) {
-            $class = isset($_SERVER['KERNEL_CLASS']) ? $_SERVER['KERNEL_CLASS'] : $_ENV['KERNEL_CLASS'];
-            if (!class_exists($class)) {
-                throw new \RuntimeException(sprintf('Class "%s" doesn\'t exist or cannot be autoloaded. Check that the KERNEL_CLASS value in phpunit.xml matches the fully-qualified class name of your Kernel or override the %s::createKernel() method.', $class, static::class));
-            }
-
-            return $class;
-        }
-
-        return parent::getKernelClass();
-    }
-
-    /**
-     * {@inheritdoc}
-     *
-     * This is overriden to set the default environment to 'phpcr'
-     */
-    protected static function createKernel(array $options = []): KernelInterface
-    {
-        // default environment is 'phpcr'
-        if (!isset($options['environment'])) {
-            $options['environment'] = 'phpcr';
-        }
-
-        return parent::createKernel($options);
-    }
-
-    protected function assertResponseSuccess(Response $response)
+    protected static function assertResponseSuccess(Response $response)
     {
         libxml_use_internal_errors(true);
 
@@ -186,6 +188,6 @@ protected function assertResponseSuccess(Response $response)
             $exception = $result->item(0)->nodeValue;
         }
 
-        $this->assertEquals(200, $response->getStatusCode(), $exception ? 'Exception: "'.$exception.'"' : '');
+        self::assertEquals(200, $response->getStatusCode(), $exception ? 'Exception: "'.$exception.'"' : '');
     }
 }

tests/Fixtures/TestTestCase.php

@@ -24,7 +24,7 @@ public function setKernel(KernelInterface $kernel)
     protected static function createKernel(array $options = []): KernelInterface
     {
         if (null === static::$kernel) {
-            return parent::createKernel($options);
+            static::$kernel = parent::createKernel($options);
         }
 
         return static::$kernel;

tests/Functional/BaseTestCaseTest.php

@@ -16,6 +16,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\FrameworkBundle\Client;
 use Symfony\Bundle\FrameworkBundle\KernelBrowser;
+use Symfony\Cmf\Component\Testing\Functional\BaseTestCase;
 use Symfony\Cmf\Component\Testing\Functional\DbManager\PHPCR;
 use Symfony\Cmf\Component\Testing\Tests\Fixtures\TestTestCase;
 use Symfony\Component\DependencyInjection\ContainerInterface;
@@ -57,7 +58,12 @@ protected function setUp(): void
         $this->kernel = $this->createMock(KernelInterface::class);
         $this->kernel->expects($this->any())
             ->method('getContainer')
-            ->willReturn($this->container);
+            ->willReturn($this->container)
+        ;
+        $this->kernel->expects($this->any())
+            ->method('getEnvironment')
+            ->willReturn('phpcr')
+        ;
 
         $this->testCase = new TestTestCase();
         $this->testCase->setKernel($this->kernel);
@@ -75,12 +81,33 @@ protected function setUp(): void
 
     public function testGetContainer()
     {
-        $this->assertEquals($this->container, $this->testCase->getContainer());
+        $class = new \ReflectionClass(BaseTestCase::class);
+        $method = $class->getMethod('getContainer');
+        $method->setAccessible(true);
+
+        $this->assertEquals($this->container, $method->invoke(null));
     }
 
     public function testGetKernel()
     {
-        $this->assertInstanceOf(KernelInterface::class, $this->testCase->getKernel());
+        $class = new \ReflectionClass(BaseTestCase::class);
+        $method = $class->getMethod('getKernel');
+        $method->setAccessible(true);
+
+        $this->assertInstanceOf(KernelInterface::class, $method->invoke(null));
+    }
+
+    public function testItCanProvideAFrameworkBundleClient()
+    {
+        $class = new \ReflectionClass(BaseTestCase::class);
+        $method = $class->getMethod('getFrameworkBundleClient');
+        $method->setAccessible(true);
+
+        if (class_exists(KernelBrowser::class)) {
+            $this->assertInstanceOf(KernelBrowser::class, $method->invoke($this->testCase));
+        } else {
+            $this->assertInstanceOf(Client::class, $method->invoke($this->testCase));
+        }
     }
 
     public function provideTestDb()
@@ -93,27 +120,26 @@ public function provideTestDb()
         ];
     }
 
-    public function testItCanProvideAFrameworkBundleClient()
-    {
-        if (class_exists(KernelBrowser::class)) {
-            $this->assertInstanceOf(KernelBrowser::class, $this->testCase->getFrameworkBundleClient());
-        } else {
-            $this->assertInstanceOf(Client::class, $this->testCase->getFrameworkBundleClient());
-        }
-    }
-
     /**
      * @dataProvider provideTestDb
      * @depends testGetContainer
      */
     public function testDb($dbName, $expected)
     {
+        $class = new \ReflectionClass(BaseTestCase::class);
+        $method = $class->getMethod('getDbManager');
+        $method->setAccessible(true);
+
         if (null === $expected) {
             $this->expectException('InvalidArgumentException');
             $this->expectExceptionMessage($dbName.'" does not exist');
         }
 
-        $res = $this->testCase->getDbManager($dbName);
+        $res = $method->invoke($this->testCase, $dbName);
+        if (null === $expected) {
+            // do not do assertions if the expected exception has not been thrown.
+            return;
+        }
 
         $className = sprintf(
             'Symfony\Cmf\Component\Testing\Functional\DbManager\%s',

tests/bootstrap.php

@@ -12,7 +12,7 @@
 $vendorDir = realpath(__DIR__.'/../vendor');
 
 if (!$loader = include $vendorDir.'/autoload.php') {
-    $nl = PHP_SAPI === 'cli' ? PHP_EOL : '<br />';
+    $nl = \PHP_SAPI === 'cli' ? \PHP_EOL : '<br />';
     echo "$nl$nl";
     exit('You must set up the project dependencies.'.$nl.
         'Run the following commands in '.dirname(__DIR__).':'.$nl.$nl.