feature #9739 [FrameworkBundle] Extract KernelTestCase from WebTestCase (johnkary)
This PR was merged into the 2.5-dev branch.
Discussion
----------
[FrameworkBundle] Extract KernelTestCase from WebTestCase
| Q | A
| ------------- | ---
| Bug fix? | No
| New feature? | Yes
| BC breaks? | No
| Deprecations? | No
| Tests pass? | Yes
| Fixed tickets | None
| License | MIT
| Doc PR | symfony/symfony-docs#3311
Previous discussion is in #7704. Opened new PR to target master branch.
This idea came to me while reading the Cookbook article [How to create a Console Command - Testing Commands](http://symfony.com/doc/master/cookbook/console/console_command.html#testing-commands) and I wanted to hear feedback from others before submitting a patch.
Basically the Cookbook article states that when testing a Command that extending `WebTestCase` is a good way to get access to the Kernel and thus the Container. This struck me as weird because I was wanting to test a Command, which doesn't really have anything to do with "the web."
Currently `WebTestCase` doesn't do anything internally that looks like web-specific work, and the class docblock itself states "WebTestCase is the base class for functional tests.".
After a suggestion in #7704 by @beberlei, I decided to take his advice and now have the following implementation:
Extracted a new class `KernelTestCase` from `WebTestCase` and instead allow WebTestCase to extend KernelTestCase. Pulled all methods up into KernelTestCase except `createClient()` because `createClient()` is focused solely on creating a Client for issuing web-based requests.
Benjamin's solution provides us a clear extension point from `KernelTestCase` for Command-based tests and also provides 100% backwards-compatibility without the need to deprecate WebTestCase.
Commits
-------
c4f14fb
Extract new base test class KernelTestClass
This commit is contained in:
commit
0aeb3945bc
174
src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php
Normal file
174
src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php
Normal file
@ -0,0 +1,174 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the Symfony package.
|
||||
*
|
||||
* (c) Fabien Potencier <fabien@symfony.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Symfony\Bundle\FrameworkBundle\Test;
|
||||
|
||||
use Symfony\Component\Finder\Finder;
|
||||
use Symfony\Component\HttpKernel\KernelInterface;
|
||||
|
||||
/**
|
||||
* KernelTestCase is the base class for tests needing a Kernel.
|
||||
*
|
||||
* @author Fabien Potencier <fabien@symfony.com>
|
||||
*/
|
||||
abstract class KernelTestCase extends \PHPUnit_Framework_TestCase
|
||||
{
|
||||
protected static $class;
|
||||
|
||||
/**
|
||||
* @var KernelInterface
|
||||
*/
|
||||
protected static $kernel;
|
||||
|
||||
/**
|
||||
* Finds the directory where the phpunit.xml(.dist) is stored.
|
||||
*
|
||||
* If you run tests with the PHPUnit CLI tool, everything will work as
|
||||
* expected. If not, override this method in your test classes.
|
||||
*
|
||||
* @return string The directory where phpunit.xml(.dist) is stored
|
||||
*
|
||||
* @throws \RuntimeException
|
||||
*/
|
||||
protected static function getPhpUnitXmlDir()
|
||||
{
|
||||
if (!isset($_SERVER['argv']) || false === strpos($_SERVER['argv'][0], 'phpunit')) {
|
||||
throw new \RuntimeException('You must override the WebTestCase::createKernel() method.');
|
||||
}
|
||||
|
||||
$dir = static::getPhpUnitCliConfigArgument();
|
||||
if ($dir === null &&
|
||||
(is_file(getcwd().DIRECTORY_SEPARATOR.'phpunit.xml') ||
|
||||
is_file(getcwd().DIRECTORY_SEPARATOR.'phpunit.xml.dist'))) {
|
||||
$dir = getcwd();
|
||||
}
|
||||
|
||||
// Can't continue
|
||||
if ($dir === null) {
|
||||
throw new \RuntimeException('Unable to guess the Kernel directory.');
|
||||
}
|
||||
|
||||
if (!is_dir($dir)) {
|
||||
$dir = dirname($dir);
|
||||
}
|
||||
|
||||
return $dir;
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds the value of the CLI configuration option.
|
||||
*
|
||||
* PHPUnit will use the last configuration argument on the command line, so
|
||||
* this only returns the last configuration argument.
|
||||
*
|
||||
* @return string The value of the PHPUnit cli configuration option
|
||||
*/
|
||||
private static function getPhpUnitCliConfigArgument()
|
||||
{
|
||||
$dir = null;
|
||||
$reversedArgs = array_reverse($_SERVER['argv']);
|
||||
foreach ($reversedArgs as $argIndex => $testArg) {
|
||||
if (preg_match('/^-[^ \-]*c$/', $testArg) || $testArg === '--configuration') {
|
||||
$dir = realpath($reversedArgs[$argIndex - 1]);
|
||||
break;
|
||||
} elseif (strpos($testArg, '--configuration=') === 0) {
|
||||
$argPath = substr($testArg, strlen('--configuration='));
|
||||
$dir = realpath($argPath);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return $dir;
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempts to guess the Kernel location.
|
||||
*
|
||||
* When the Kernel is located, the file is required.
|
||||
*
|
||||
* @return string The Kernel class name
|
||||
*
|
||||
* @throws \RuntimeException
|
||||
*/
|
||||
protected static function getKernelClass()
|
||||
{
|
||||
$dir = isset($_SERVER['KERNEL_DIR']) ? $_SERVER['KERNEL_DIR'] : static::getPhpUnitXmlDir();
|
||||
|
||||
$finder = new Finder();
|
||||
$finder->name('*Kernel.php')->depth(0)->in($dir);
|
||||
$results = iterator_to_array($finder);
|
||||
if (!count($results)) {
|
||||
throw new \RuntimeException('Either set KERNEL_DIR in your phpunit.xml according to http://symfony.com/doc/current/book/testing.html#your-first-functional-test or override the WebTestCase::createKernel() method.');
|
||||
}
|
||||
|
||||
$file = current($results);
|
||||
$class = $file->getBasename('.php');
|
||||
|
||||
require_once $file;
|
||||
|
||||
return $class;
|
||||
}
|
||||
|
||||
/**
|
||||
* Boots the Kernel for this test.
|
||||
*
|
||||
* @param array $options
|
||||
*/
|
||||
protected static function bootKernel(array $options = array())
|
||||
{
|
||||
static::ensureKernelShutdown();
|
||||
|
||||
static::$kernel = static::createKernel($options);
|
||||
static::$kernel->boot();
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Kernel.
|
||||
*
|
||||
* Available options:
|
||||
*
|
||||
* * environment
|
||||
* * debug
|
||||
*
|
||||
* @param array $options An array of options
|
||||
*
|
||||
* @return KernelInterface A KernelInterface instance
|
||||
*/
|
||||
protected static function createKernel(array $options = array())
|
||||
{
|
||||
if (null === static::$class) {
|
||||
static::$class = static::getKernelClass();
|
||||
}
|
||||
|
||||
return new static::$class(
|
||||
isset($options['environment']) ? $options['environment'] : 'test',
|
||||
isset($options['debug']) ? $options['debug'] : true
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Shutdown the Kernel.
|
||||
*/
|
||||
protected static function ensureKernelShutdown()
|
||||
{
|
||||
if (null !== static::$kernel) {
|
||||
static::$kernel->shutdown();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Clean up Kernel usage in this test.
|
||||
*/
|
||||
protected function tearDown()
|
||||
{
|
||||
static::ensureKernelShutdown();
|
||||
}
|
||||
}
|
@ -12,23 +12,14 @@
|
||||
namespace Symfony\Bundle\FrameworkBundle\Test;
|
||||
|
||||
use Symfony\Bundle\FrameworkBundle\Client;
|
||||
use Symfony\Component\Finder\Finder;
|
||||
use Symfony\Component\HttpKernel\KernelInterface;
|
||||
|
||||
/**
|
||||
* WebTestCase is the base class for functional tests.
|
||||
*
|
||||
* @author Fabien Potencier <fabien@symfony.com>
|
||||
*/
|
||||
abstract class WebTestCase extends \PHPUnit_Framework_TestCase
|
||||
abstract class WebTestCase extends KernelTestCase
|
||||
{
|
||||
protected static $class;
|
||||
|
||||
/**
|
||||
* @var KernelInterface
|
||||
*/
|
||||
protected static $kernel;
|
||||
|
||||
/**
|
||||
* Creates a Client.
|
||||
*
|
||||
@ -39,147 +30,11 @@ abstract class WebTestCase extends \PHPUnit_Framework_TestCase
|
||||
*/
|
||||
protected static function createClient(array $options = array(), array $server = array())
|
||||
{
|
||||
if (null !== static::$kernel) {
|
||||
static::$kernel->shutdown();
|
||||
}
|
||||
|
||||
static::$kernel = static::createKernel($options);
|
||||
static::$kernel->boot();
|
||||
static::bootKernel($options);
|
||||
|
||||
$client = static::$kernel->getContainer()->get('test.client');
|
||||
$client->setServerParameters($server);
|
||||
|
||||
return $client;
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds the directory where the phpunit.xml(.dist) is stored.
|
||||
*
|
||||
* If you run tests with the PHPUnit CLI tool, everything will work as expected.
|
||||
* If not, override this method in your test classes.
|
||||
*
|
||||
* @return string The directory where phpunit.xml(.dist) is stored
|
||||
*
|
||||
* @throws \RuntimeException
|
||||
*/
|
||||
protected static function getPhpUnitXmlDir()
|
||||
{
|
||||
if (!isset($_SERVER['argv']) || false === strpos($_SERVER['argv'][0], 'phpunit')) {
|
||||
throw new \RuntimeException('You must override the WebTestCase::createKernel() method.');
|
||||
}
|
||||
|
||||
$dir = static::getPhpUnitCliConfigArgument();
|
||||
if ($dir === null &&
|
||||
(is_file(getcwd().DIRECTORY_SEPARATOR.'phpunit.xml') ||
|
||||
is_file(getcwd().DIRECTORY_SEPARATOR.'phpunit.xml.dist'))) {
|
||||
$dir = getcwd();
|
||||
}
|
||||
|
||||
// Can't continue
|
||||
if ($dir === null) {
|
||||
throw new \RuntimeException('Unable to guess the Kernel directory.');
|
||||
}
|
||||
|
||||
if (!is_dir($dir)) {
|
||||
$dir = dirname($dir);
|
||||
}
|
||||
|
||||
return $dir;
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds the value of the CLI configuration option.
|
||||
*
|
||||
* PHPUnit will use the last configuration argument on the command line, so this only returns
|
||||
* the last configuration argument.
|
||||
*
|
||||
* @return string The value of the PHPUnit CLI configuration option
|
||||
*/
|
||||
private static function getPhpUnitCliConfigArgument()
|
||||
{
|
||||
$dir = null;
|
||||
$reversedArgs = array_reverse($_SERVER['argv']);
|
||||
foreach ($reversedArgs as $argIndex => $testArg) {
|
||||
if (preg_match('/^-[^ \-]*c$/', $testArg) || $testArg === '--configuration') {
|
||||
$dir = realpath($reversedArgs[$argIndex - 1]);
|
||||
break;
|
||||
} elseif (strpos($testArg, '--configuration=') === 0) {
|
||||
$argPath = substr($testArg, strlen('--configuration='));
|
||||
$dir = realpath($argPath);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return $dir;
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempts to guess the kernel location.
|
||||
*
|
||||
* When the Kernel is located, the file is required.
|
||||
*
|
||||
* @return string The Kernel class name
|
||||
*
|
||||
* @throws \RuntimeException
|
||||
*/
|
||||
protected static function getKernelClass()
|
||||
{
|
||||
$dir = $phpUnitDir = static::getPhpUnitXmlDir();
|
||||
|
||||
if (isset($_SERVER['KERNEL_DIR'])) {
|
||||
$dir = $_SERVER['KERNEL_DIR'];
|
||||
|
||||
if (!is_dir($dir) && is_dir("$phpUnitDir/$dir")) {
|
||||
$dir = "$phpUnitDir/$dir";
|
||||
}
|
||||
}
|
||||
|
||||
$finder = new Finder();
|
||||
$finder->name('*Kernel.php')->depth(0)->in($dir);
|
||||
$results = iterator_to_array($finder);
|
||||
if (!count($results)) {
|
||||
throw new \RuntimeException('Either set KERNEL_DIR in your phpunit.xml according to http://symfony.com/doc/current/book/testing.html#your-first-functional-test or override the WebTestCase::createKernel() method.');
|
||||
}
|
||||
|
||||
$file = current($results);
|
||||
$class = $file->getBasename('.php');
|
||||
|
||||
require_once $file;
|
||||
|
||||
return $class;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Kernel.
|
||||
*
|
||||
* Available options:
|
||||
*
|
||||
* * environment
|
||||
* * debug
|
||||
*
|
||||
* @param array $options An array of options
|
||||
*
|
||||
* @return KernelInterface A KernelInterface instance
|
||||
*/
|
||||
protected static function createKernel(array $options = array())
|
||||
{
|
||||
if (null === static::$class) {
|
||||
static::$class = static::getKernelClass();
|
||||
}
|
||||
|
||||
return new static::$class(
|
||||
isset($options['environment']) ? $options['environment'] : 'test',
|
||||
isset($options['debug']) ? $options['debug'] : true
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Shuts the kernel down if it was used in the test.
|
||||
*/
|
||||
protected function tearDown()
|
||||
{
|
||||
if (null !== static::$kernel) {
|
||||
static::$kernel->shutdown();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user