veyra/friends-of-behat-symfony-extension
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

SymfonyExtension v2.0: proof of concept

Browse Source
This commit is contained in:
Kamil Kokot
2018-12-19 16:45:37 +01:00
parent 3ef0d0dcf3
commit 50fc509fb3
12 changed files with 453 additions and 289 deletions
Download Patch File Download Diff File Expand all files Collapse all files

229
src/ServiceContainer/SymfonyExtension.php
View File

@@ -4,22 +4,20 @@ declare(strict_types=1);
namespace FriendsOfBehat\SymfonyExtension\ServiceContainer;
use Behat\Behat\Context\ServiceContainer\ContextExtension;
use Behat\MinkExtension\ServiceContainer\MinkExtension;
use Behat\Testwork\Environment\ServiceContainer\EnvironmentExtension;
use Behat\Testwork\EventDispatcher\ServiceContainer\EventDispatcherExtension;
use Behat\Testwork\ServiceContainer\Extension;
use Behat\Testwork\ServiceContainer\ExtensionManager;
use FriendsOfBehat\CrossContainerExtension\CrossContainerProcessor;
use FriendsOfBehat\CrossContainerExtension\KernelBasedContainerAccessor;
use FriendsOfBehat\CrossContainerExtension\ServiceContainer\CrossContainerExtension;
use FriendsOfBehat\SymfonyExtension\Context\Environment\Handler\ContextServiceEnvironmentHandler;
use FriendsOfBehat\SymfonyExtension\Driver\Factory\SymfonyDriverFactory;
use FriendsOfBehat\SymfonyExtension\Listener\KernelRebooter;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\DependencyInjection\Container;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\Dotenv\Dotenv;
use Symfony\Component\HttpKernel\KernelInterface;
final class SymfonyExtension implements Extension
{
@@ -27,41 +25,13 @@ final class SymfonyExtension implements Extension
* Kernel used inside Behat contexts or to create services injected to them.
* Container is built before every scenario.
*/
const KERNEL_ID = 'sylius_symfony_extension.kernel';
public const KERNEL_ID = 'sylius_symfony_extension.kernel';
/**
* The current container used in scenario contexts.
* To be used as a factory for current injected application services.
*/
const KERNEL_CONTAINER_ID = 'sylius_symfony_extension.kernel.container';
/**
* Kernel used by Symfony2 driver to isolate web container from contexts' container.
* Kernel used by Symfony driver to isolate web container from contexts' container.
* Container is built before every request.
*/
const DRIVER_KERNEL_ID = 'sylius_symfony_extension.driver_kernel';
/**
* Kernel that should be used by extensions only.
* Container is built only once at the first use.
*/
const SHARED_KERNEL_ID = 'sylius_symfony_extension.shared_kernel';
/**
* The only container built by shared kernel.
* To be used as a factory for shared injected application services.
*/
const SHARED_KERNEL_CONTAINER_ID = 'sylius_symfony_extension.shared_kernel.container';
/**
* Default symfony environment used to run your suites.
*/
private const DEFAULT_ENV = 'test';
/**
* Enable or disable the debug mode
*/
private const DEFAULT_DEBUG_MODE = true;
private const DRIVER_KERNEL_ID = 'sylius_symfony_extension.driver_kernel';
/**
* Default Symfony configuration
@@ -69,53 +39,22 @@ final class SymfonyExtension implements Extension
private const SYMFONY_DEFAULTS = [
'env_file' => null,
'kernel' => [
'bootstrap' => 'app/autoload.php',
'path' => 'app/AppKernel.php',
'class' => 'AppKernel',
'env' => self::DEFAULT_ENV,
'debug' => self::DEFAULT_DEBUG_MODE,
'env' => 'test',
'debug' => true,
],
];
/**
* Default Symfony 4 configuration
*/
private const SYMFONY_4_DEFAULTS = [
'env_file' => '.env',
'kernel' => [
'bootstrap' => null,
'path' => 'src/Kernel.php',
'class' => 'App\Kernel',
'env' => self::DEFAULT_ENV,
'debug' => self::DEFAULT_DEBUG_MODE,
],
];
/**
* @var CrossContainerProcessor|null
*/
private $crossContainerProcessor;
/**
* {@inheritdoc}
*/
public function getConfigKey(): string
{
return 'fob_symfony';
}
/**
* {@inheritdoc}
*/
public function initialize(ExtensionManager $extensionManager): void
{
$this->registerSymfonyDriverFactory($extensionManager);
$this->initializeCrossContainerProcessor($extensionManager);
}
/**
* {@inheritdoc}
*/
public function configure(ArrayNodeDefinition $builder): void
{
$builder
@@ -124,8 +63,6 @@ final class SymfonyExtension implements Extension
->arrayNode('kernel')
->addDefaultsIfNotSet()
->children()
->scalarNode('bootstrap')->defaultFalse()->end()
->scalarNode('path')->end()
->scalarNode('class')->end()
->scalarNode('env')->end()
->booleanNode('debug')->end()
@@ -135,28 +72,18 @@ final class SymfonyExtension implements Extension
;
}
/**
* {@inheritdoc}
*/
public function load(ContainerBuilder $container, array $config): void
{
$config = $this->autoconfigure($container, $config);
$this->loadKernel($container, $config['kernel']);
$this->loadKernelContainer($container);
$this->loadDriverKernel($container);
$this->loadSharedKernel($container);
$this->loadSharedKernelContainer($container);
$this->loadEnvironmentHandler($container);
$this->loadKernelRebooter($container);
$this->declareSymfonyContainers($container);
}
/**
* {@inheritdoc}
*/
public function process(ContainerBuilder $container): void
{
}
@@ -165,13 +92,6 @@ final class SymfonyExtension implements Extension
{
$defaults = self::SYMFONY_DEFAULTS;
$symfonyFourKernelPath = sprintf('%s/%s', $container->getParameter('paths.base'), self::SYMFONY_4_DEFAULTS['kernel']['path']);
if ($userConfig['kernel']['bootstrap'] === null || file_exists($symfonyFourKernelPath)) {
$defaults = self::SYMFONY_4_DEFAULTS;
}
$userConfig['kernel']['bootstrap'] = $userConfig['kernel']['bootstrap'] === false ? null : $userConfig['kernel']['bootstrap'];
$config = array_replace_recursive($defaults, $userConfig);
if (null !== $config['env_file']) {
@@ -200,30 +120,12 @@ final class SymfonyExtension implements Extension
{
$definition = new Definition($config['class'], [
$config['env'],
$config['debug'],
(bool) $config['debug'],
]);
$definition->addMethodCall('boot');
$definition->setPublic(true);
$file = $this->getKernelFile($container->getParameter('paths.base'), $config['path']);
if (null !== $file) {
$definition->setFile($file);
}
$container->setDefinition(self::KERNEL_ID, $definition);
$this->requireKernelBootstrapFile($container->getParameter('paths.base'), $config['bootstrap']);
}
private function loadKernelContainer(ContainerBuilder $container): void
{
$containerDefinition = new Definition(Container::class);
$containerDefinition->setFactory([
new Reference(self::KERNEL_ID),
'getContainer',
]);
$container->setDefinition(self::KERNEL_CONTAINER_ID, $containerDefinition);
}
private function loadDriverKernel(ContainerBuilder $container): void
@@ -231,71 +133,26 @@ final class SymfonyExtension implements Extension
$container->setDefinition(self::DRIVER_KERNEL_ID, $container->findDefinition(self::KERNEL_ID));
}
private function loadSharedKernel(ContainerBuilder $container): void
{
$container->setDefinition(self::SHARED_KERNEL_ID, $container->findDefinition(self::KERNEL_ID));
}
private function loadSharedKernelContainer(ContainerBuilder $container): void
{
$containerDefinition = new Definition(Container::class);
$containerDefinition->setFactory([
new Reference(self::SHARED_KERNEL_ID),
'getContainer',
]);
$container->setDefinition(self::SHARED_KERNEL_CONTAINER_ID, $containerDefinition);
}
/**
* @throws \Exception
*/
private function loadKernelRebooter(ContainerBuilder $container): void
{
$definition = new Definition(KernelRebooter::class, [new Reference(self::KERNEL_ID)]);
$definition = new Definition(KernelRebooter::class, [new Reference(self::KERNEL_ID), $container]);
$definition->addTag(EventDispatcherExtension::SUBSCRIBER_TAG);
$container->setDefinition(self::KERNEL_ID . '.rebooter', $definition);
}
/**
* @throws \Exception
*/
private function declareSymfonyContainers(ContainerBuilder $container): void
private function loadEnvironmentHandler(ContainerBuilder $container): void
{
if (null === $this->crossContainerProcessor) {
return;
$definition = new Definition(ContextServiceEnvironmentHandler::class, [
new Reference(self::KERNEL_ID),
]);
$definition->addTag(EnvironmentExtension::HANDLER_TAG, ['priority' => 128]);
foreach ($container->findTaggedServiceIds(ContextExtension::INITIALIZER_TAG) as $serviceId => $tags) {
$definition->addMethodCall('registerContextInitializer', [$container->getDefinition($serviceId)]);
}
$containerAccessors = [
'symfony' => self::KERNEL_ID,
'symfony_driver' => self::DRIVER_KERNEL_ID,
'symfony_shared' => self::SHARED_KERNEL_ID,
];
foreach ($containerAccessors as $containerName => $kernelIdentifier) {
$kernel = $container->get($kernelIdentifier);
if (!$kernel instanceof KernelInterface) {
throw new \RuntimeException(sprintf(
'Expected service "%s" to be an instance of "%s", got "%s" instead.',
$kernelIdentifier,
KernelInterface::class,
\is_object($kernel) ? \get_class($kernel) : \gettype($kernel)
));
}
$this->crossContainerProcessor->addContainerAccessor($containerName, new KernelBasedContainerAccessor($kernel));
}
}
private function initializeCrossContainerProcessor(ExtensionManager $extensionManager): void
{
/** @var CrossContainerExtension $extension */
$extension = $extensionManager->getExtension('fob_cross_container');
if (null !== $extension) {
$this->crossContainerProcessor = $extension->getCrossContainerProcessor();
}
$container->setDefinition('fob_symfony.environment_handler.context_service', $definition);
}
private function registerSymfonyDriverFactory(ExtensionManager $extensionManager): void
@@ -306,50 +163,6 @@ final class SymfonyExtension implements Extension
return;
}
$minkExtension->registerDriverFactory(new SymfonyDriverFactory(
'symfony',
new Reference(self::DRIVER_KERNEL_ID)
));
}
private function getKernelFile(string $basePath, string $kernelPath): ?string
{
$possibleFiles = [
sprintf('%s/%s', $basePath, $kernelPath),
$kernelPath,
];
foreach ($possibleFiles as $possibleFile) {
if (file_exists($possibleFile)) {
return $possibleFile;
}
}
return null;
}
/**
* @throws \DomainException
*/
private function requireKernelBootstrapFile(string $basePath, ?string $bootstrapPath): void
{
if (null === $bootstrapPath) {
return;
}
$possiblePaths = [
sprintf('%s/%s', $basePath, $bootstrapPath),
$bootstrapPath,
];
foreach ($possiblePaths as $possiblePath) {
if (file_exists($possiblePath)) {
require_once $possiblePath;
return;
}
}
throw new \DomainException('Could not load bootstrap file.');
$minkExtension->registerDriverFactory(new SymfonyDriverFactory('symfony', new Reference(self::DRIVER_KERNEL_ID)));
}
}