[DependencyInjection] The YamlFileLoader raises an InvalidArgumentException is a service definition contains unsupported keywords.

Hugo Hamon · Hugo Hamon · commit 505089b4e4c8 · 2015-12-24T16:22:08.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
@@ -32,6 +32,15 @@
  */
 class YamlFileLoader extends FileLoader
 {
+    private static $keywords = array(
+        'alias', 'parent', 'class', 'shared',
+        'synthetic', 'lazy', 'public', 'abstract',
+        'deprecated', 'factory', 'file', 'arguments',
+        'properties', 'configurator', 'calls', 'tags',
+        'decorates', 'decoration_inner_name', 'decoration_priority',
+        'autowire', 'autowiring_types',
+    );
+
     private $yamlParser;
 
     /**
@@ -147,6 +156,8 @@ private function parseDefinition($id, $service, $file)
             throw new InvalidArgumentException(sprintf('A service definition must be an array or a string starting with "@" but %s found for service "%s" in %s. Check your YAML syntax.', gettype($service), $id, $file));
         }
 
+        static::checkDefinition($id, $service);
+
         if (isset($service['alias'])) {
             $public = !array_key_exists('public', $service) || (bool) $service['public'];
             $this->container->setAlias($id, new Alias($service['alias'], $public));
@@ -432,4 +443,26 @@ private function loadFromExtensions($content)
             $this->container->loadFromExtension($namespace, $values);
         }
     }
+
+    /**
+     * Checks the keywords used to define a service.
+     *
+     * @param string $id         The service name
+     * @param array  $definition The service definition to check
+     *
+     * @throws InvalidArgumentException When an invalid keyword is used
+     */
+    private static function checkDefinition($id, array $definition)
+    {
+        foreach ($definition as $key => $value) {
+            if (!in_array($key, static::$keywords)) {
+                throw new InvalidArgumentException(sprintf(
+                    'The "%s" key in "%s" service definition is not valid. It must be one of "%s".',
+                    (string) $key,
+                    $id,
+                    implode('", "', static::$keywords)
+                ));
+            }
+        }
+    }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/invalid_definition.yml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/invalid_definition.yml
@@ -0,0 +1,9 @@
+services:
+    foo:
+        class: stdClass
+        arguments: [ 'foo', 'bar' ]
+
+    # This definition is invalid and must raise an InvalidArgumentException
+    bar:
+        class: stdClass
+        private: true        # the "private" keyword is invalid
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/YamlFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/YamlFileLoaderTest.php
@@ -293,4 +293,15 @@ public function testAutowire()
 
         $this->assertTrue($container->getDefinition('bar_service')->isAutowired());
     }
+
+    /**
+     * @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
+     * @expectedExceptionMessageRegExp #^The "private" key in "bar" service definition is not valid\.#
+     */
+    public function testInvalidDefinitionIsRejected()
+    {
+        $container = new ContainerBuilder();
+        $loader = new YamlFileLoader($container, new FileLocator(self::$fixturesPath.'/yaml'));
+        $loader->load('invalid_definition.yml');
+    }
 }
