[DI] Ignore missing tree root nodes on validate

ro0NL · fabpot · commit b3cdfc64b561 · 2018-06-05T07:03:28.000+02:00
diff --git a/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php b/src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Config\Definition\Builder;
 
+use Symfony\Component\Config\Definition\Exception\TreeWithoutRootNodeException;
 use Symfony\Component\Config\Definition\NodeInterface;
 
 /**
@@ -74,7 +75,7 @@ public function setPathSeparator(string $separator)
     private function assertTreeHasRootNode()
     {
         if (null === $this->root) {
-            throw new \RuntimeException('The configuration tree has no root node.');
+            throw new TreeWithoutRootNodeException('The configuration tree has no root node.');
         }
     }
 }
diff --git a/src/Symfony/Component/Config/Definition/Exception/TreeWithoutRootNodeException.php b/src/Symfony/Component/Config/Definition/Exception/TreeWithoutRootNodeException.php
@@ -0,0 +1,19 @@
+<?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\Config\Definition\Exception;
+
+/**
+ * @author Roland Franssen <franssen.roland@gmail.com>
+ */
+class TreeWithoutRootNodeException extends \RuntimeException
+{
+}
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ValidateEnvPlaceholdersPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ValidateEnvPlaceholdersPass.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\DependencyInjection\Compiler;
 
 use Symfony\Component\Config\Definition\BaseNode;
+use Symfony\Component\Config\Definition\Exception\TreeWithoutRootNodeException;
 use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Exception\LogicException;
@@ -77,7 +78,10 @@ public function process(ContainerBuilder $container)
                     continue;
                 }
 
-                $processor->processConfiguration($configuration, $config);
+                try {
+                    $processor->processConfiguration($configuration, $config);
+                } catch (TreeWithoutRootNodeException $e) {
+                }
             }
         } finally {
             BaseNode::resetPlaceholders();
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/ValidateEnvPlaceholdersPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/ValidateEnvPlaceholdersPassTest.php
@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
+use Symfony\Component\Config\Definition\Exception\TreeWithoutRootNodeException;
 use Symfony\Component\DependencyInjection\Compiler\MergeExtensionConfigurationPass;
 use Symfony\Component\DependencyInjection\Compiler\RegisterEnvVarProcessorsPass;
 use Symfony\Component\DependencyInjection\Compiler\ValidateEnvPlaceholdersPass;
@@ -222,6 +223,17 @@ public function testEnvWithVariableNode(): void
         $this->assertSame($expected, $container->resolveEnvPlaceholders($ext->getConfig()));
     }
 
+    public function testConfigurationWithoutRootNode(): void
+    {
+        $container = new ContainerBuilder();
+        $container->registerExtension($ext = new EnvExtension(new EnvConfigurationWithoutRootNode()));
+        $container->loadFromExtension('env_extension');
+
+        $this->doProcess($container);
+
+        $this->addToAssertionCount(1);
+    }
+
     private function doProcess(ContainerBuilder $container): void
     {
         (new MergeExtensionConfigurationPass())->process($container);
@@ -267,23 +279,41 @@ public function getConfigTreeBuilder()
     }
 }
 
+class EnvConfigurationWithoutRootNode implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder()
+    {
+        return new TreeBuilder();
+    }
+}
+
 class EnvExtension extends Extension
 {
+    private $configuration;
     private $config;
 
+    public function __construct(ConfigurationInterface $configuration = null)
+    {
+        $this->configuration = $configuration ?? new EnvConfiguration();
+    }
+
     public function getAlias()
     {
         return 'env_extension';
     }
 
     public function getConfiguration(array $config, ContainerBuilder $container)
     {
-        return new EnvConfiguration();
+        return $this->configuration;
     }
 
     public function load(array $configs, ContainerBuilder $container)
     {
-        $this->config = $this->processConfiguration($this->getConfiguration($configs, $container), $configs);
+        try {
+            $this->config = $this->processConfiguration($this->getConfiguration($configs, $container), $configs);
+        } catch (TreeWithoutRootNodeException $e) {
+            $this->config = null;
+        }
     }
 
     public function getConfig()
diff --git a/src/Symfony/Component/DependencyInjection/composer.json b/src/Symfony/Component/DependencyInjection/composer.json
@@ -32,7 +32,7 @@
         "symfony/proxy-manager-bridge": "Generate service proxies to lazy load them"
     },
     "conflict": {
-        "symfony/config": "<4.1",
+        "symfony/config": "<4.1.1",
         "symfony/finder": "<3.4",
         "symfony/proxy-manager-bridge": "<3.4",
         "symfony/yaml": "<3.4"

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Config\Definition\Builder;`
`13`	`13`
	`14`	`+use Symfony\Component\Config\Definition\Exception\TreeWithoutRootNodeException;`
`14`	`15`	`use Symfony\Component\Config\Definition\NodeInterface;`
`15`	`16`
`16`	`17`	`/**`
`@@ -74,7 +75,7 @@ public function setPathSeparator(string $separator)`
`74`	`75`	`private function assertTreeHasRootNode()`
`75`	`76`	`{`
`76`	`77`	`if (null === $this->root) {`
`77`		`- throw new \RuntimeException('The configuration tree has no root node.');`
	`78`	`+ throw new TreeWithoutRootNodeException('The configuration tree has no root node.');`
`78`	`79`	`}`
`79`	`80`	`}`
`80`	`81`	`}`