2018-03-03 10:07:55 +00:00
|
|
|
<?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\Component\DependencyInjection\Tests\Compiler;
|
|
|
|
|
|
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
|
|
|
|
use Symfony\Component\Config\Definition\ConfigurationInterface;
|
|
|
|
use Symfony\Component\DependencyInjection\Compiler\MergeExtensionConfigurationPass;
|
|
|
|
use Symfony\Component\DependencyInjection\Compiler\RegisterEnvVarProcessorsPass;
|
|
|
|
use Symfony\Component\DependencyInjection\Compiler\ValidateEnvPlaceholdersPass;
|
|
|
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
|
|
|
use Symfony\Component\DependencyInjection\Extension\Extension;
|
|
|
|
|
|
|
|
class ValidateEnvPlaceholdersPassTest extends TestCase
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @expectedException \Symfony\Component\DependencyInjection\Exception\LogicException
|
|
|
|
* @expectedExceptionMessage Invalid type for env parameter "env(FOO)". Expected "string", but got "bool".
|
|
|
|
*/
|
|
|
|
public function testDefaultEnvIsValidatedByType()
|
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->setParameter('env(FOO)', true);
|
|
|
|
$container->registerExtension(new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', array(
|
|
|
|
'scalar_node' => '%env(FOO)%',
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testEnvsAreValidatedInConfig()
|
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->setParameter('env(NULLED)', null);
|
|
|
|
$container->registerExtension($ext = new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', $expected = array(
|
|
|
|
'scalar_node' => '%env(NULLED)%',
|
|
|
|
'int_node' => '%env(int:FOO)%',
|
|
|
|
'float_node' => '%env(float:BAR)%',
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
|
|
|
|
$this->assertSame($expected, $container->resolveEnvPlaceholders($ext->getConfig()));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidTypeException
|
|
|
|
* @expectedExceptionMessage Invalid type for path "env_extension.bool_node". Expected "bool", but got one of "bool", "int", "float", "string", "array".
|
|
|
|
*/
|
|
|
|
public function testEnvsAreValidatedInConfigWithInvalidPlaceholder()
|
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->registerExtension($ext = new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', $expected = array(
|
|
|
|
'bool_node' => '%env(const:BAZ)%',
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
|
|
|
|
$this->assertSame($expected, $container->resolveEnvPlaceholders($ext->getConfig()));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidTypeException
|
|
|
|
* @expectedExceptionMessage Invalid type for path "env_extension.int_node". Expected "int", but got "array".
|
|
|
|
*/
|
|
|
|
public function testInvalidEnvInConfig()
|
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->registerExtension(new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', array(
|
|
|
|
'int_node' => '%env(json:FOO)%',
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidTypeException
|
|
|
|
* @expectedExceptionMessage Invalid type for path "env_extension.int_node". Expected int, but got NULL.
|
|
|
|
*/
|
|
|
|
public function testNulledEnvInConfig()
|
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->setParameter('env(NULLED)', null);
|
|
|
|
$container->registerExtension(new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', array(
|
|
|
|
'int_node' => '%env(NULLED)%',
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testValidateEnvOnMerge()
|
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->registerExtension($ext = new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', array(
|
|
|
|
'int_node' => '%env(int:const:FOO)%',
|
|
|
|
'bool_node' => true,
|
|
|
|
));
|
|
|
|
$container->prependExtensionConfig('env_extension', array(
|
|
|
|
'int_node' => '%env(int:BAR)%',
|
|
|
|
'bool_node' => '%env(bool:int:BAZ)%',
|
|
|
|
'scalar_node' => '%env(BAZ)%',
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
|
|
|
|
$expected = array(
|
|
|
|
'int_node' => '%env(int:const:FOO)%',
|
|
|
|
'bool_node' => true,
|
|
|
|
'scalar_node' => '%env(BAZ)%',
|
|
|
|
);
|
|
|
|
|
|
|
|
$this->assertSame($expected, $container->resolveEnvPlaceholders($ext->getConfig()));
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testConcatenatedEnvInConfig()
|
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->registerExtension($ext = new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', array(
|
|
|
|
'scalar_node' => $expected = 'foo %env(BAR)% baz',
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
|
|
|
|
$this->assertSame(array('scalar_node' => $expected), $container->resolveEnvPlaceholders($ext->getConfig()));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
|
|
|
|
* @expectedExceptionMessage A dynamic value is not compatible with a "Symfony\Component\Config\Definition\EnumNode" node type at path "env_extension.enum_node".
|
|
|
|
*/
|
|
|
|
public function testEnvIsIncompatibleWithEnumNode()
|
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->registerExtension(new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', array(
|
|
|
|
'enum_node' => '%env(FOO)%',
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
|
|
|
|
* @expectedExceptionMessage A dynamic value is not compatible with a "Symfony\Component\Config\Definition\ArrayNode" node type at path "env_extension.simple_array_node".
|
|
|
|
*/
|
|
|
|
public function testEnvIsIncompatibleWithArrayNode()
|
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->registerExtension(new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', array(
|
|
|
|
'simple_array_node' => '%env(json:FOO)%',
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testNormalizedEnvIsCompatibleWithArrayNode()
|
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->registerExtension($ext = new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', array(
|
|
|
|
'array_node' => $expected = '%env(CHILD)%',
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
|
|
|
|
$this->assertSame(array('array_node' => array('child_node' => $expected)), $container->resolveEnvPlaceholders($ext->getConfig()));
|
|
|
|
}
|
|
|
|
|
|
|
|
public function testEnvIsNotUnset()
|
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->registerExtension($ext = new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', $expected = array(
|
|
|
|
'array_node' => array('int_unset_at_zero' => '%env(int:CHILD)%'),
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
|
|
|
|
$this->assertSame($expected, $container->resolveEnvPlaceholders($ext->getConfig()));
|
|
|
|
}
|
|
|
|
|
2018-04-06 06:34:50 +01:00
|
|
|
public function testEmptyEnvWhichCannotBeEmptyForScalarNode(): void
|
2018-04-04 17:31:13 +01:00
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->registerExtension($ext = new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', $expected = array(
|
|
|
|
'scalar_node_not_empty' => '%env(SOME)%',
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
|
|
|
|
$this->assertSame($expected, $container->resolveEnvPlaceholders($ext->getConfig()));
|
|
|
|
}
|
|
|
|
|
2018-04-16 09:25:21 +01:00
|
|
|
public function testEnvWithVariableNode(): void
|
|
|
|
{
|
|
|
|
$container = new ContainerBuilder();
|
|
|
|
$container->registerExtension($ext = new EnvExtension());
|
|
|
|
$container->prependExtensionConfig('env_extension', $expected = array(
|
|
|
|
'variable_node' => '%env(SOME)%',
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->doProcess($container);
|
|
|
|
|
|
|
|
$this->assertSame($expected, $container->resolveEnvPlaceholders($ext->getConfig()));
|
|
|
|
}
|
|
|
|
|
2018-03-03 10:07:55 +00:00
|
|
|
private function doProcess(ContainerBuilder $container): void
|
|
|
|
{
|
|
|
|
(new MergeExtensionConfigurationPass())->process($container);
|
|
|
|
(new RegisterEnvVarProcessorsPass())->process($container);
|
|
|
|
(new ValidateEnvPlaceholdersPass())->process($container);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
class EnvConfiguration implements ConfigurationInterface
|
|
|
|
{
|
|
|
|
public function getConfigTreeBuilder()
|
|
|
|
{
|
|
|
|
$treeBuilder = new TreeBuilder();
|
|
|
|
$rootNode = $treeBuilder->root('env_extension');
|
|
|
|
$rootNode
|
|
|
|
->children()
|
|
|
|
->scalarNode('scalar_node')->end()
|
2018-04-04 17:31:13 +01:00
|
|
|
->scalarNode('scalar_node_not_empty')->cannotBeEmpty()->end()
|
2018-03-03 10:07:55 +00:00
|
|
|
->integerNode('int_node')->end()
|
|
|
|
->floatNode('float_node')->end()
|
|
|
|
->booleanNode('bool_node')->end()
|
|
|
|
->arrayNode('array_node')
|
|
|
|
->beforeNormalization()
|
|
|
|
->ifTrue(function ($value) { return !is_array($value); })
|
|
|
|
->then(function ($value) { return array('child_node' => $value); })
|
|
|
|
->end()
|
|
|
|
->children()
|
|
|
|
->scalarNode('child_node')->end()
|
|
|
|
->integerNode('int_unset_at_zero')
|
|
|
|
->validate()
|
|
|
|
->ifTrue(function ($value) { return 0 === $value; })
|
|
|
|
->thenUnset()
|
|
|
|
->end()
|
|
|
|
->end()
|
|
|
|
->end()
|
|
|
|
->end()
|
|
|
|
->arrayNode('simple_array_node')->end()
|
|
|
|
->enumNode('enum_node')->values(array('a', 'b'))->end()
|
2018-04-16 09:25:21 +01:00
|
|
|
->variableNode('variable_node')->end()
|
2018-03-03 10:07:55 +00:00
|
|
|
->end();
|
|
|
|
|
|
|
|
return $treeBuilder;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
class EnvExtension extends Extension
|
|
|
|
{
|
|
|
|
private $config;
|
|
|
|
|
|
|
|
public function getAlias()
|
|
|
|
{
|
|
|
|
return 'env_extension';
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getConfiguration(array $config, ContainerBuilder $container)
|
|
|
|
{
|
|
|
|
return new EnvConfiguration();
|
|
|
|
}
|
|
|
|
|
|
|
|
public function load(array $configs, ContainerBuilder $container)
|
|
|
|
{
|
|
|
|
$this->config = $this->processConfiguration($this->getConfiguration($configs, $container), $configs);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getConfig()
|
|
|
|
{
|
|
|
|
return $this->config;
|
|
|
|
}
|
|
|
|
}
|