Fix issue symfony#3251: Check attribute type of service tags

phreaknerd · phreaknerd · commit 3ae826a07dcd · 2012-04-13T17:07:37.000+02:00
The attributes of service tags have to be of a scalar type.
It was possible to add arrays here with yaml-configuration.
diff --git a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
@@ -216,6 +216,12 @@ private function parseDefinition($id, $service, $file)
                 $name = $tag['name'];
                 unset($tag['name']);
 
+                foreach ($tag as $attribute => $value) {
+                    if (!is_scalar($value)) {
+                        throw new InvalidArgumentException(sprintf('A "tags" attribute must be of a scalar-type for service "%s", tag "%s" in %s.', $id, $name, $file));
+                    }
+                }
+
                 $definition->addTag($name, $tag);
             }
         }
diff --git a/tests/Symfony/Tests/Component/DependencyInjection/Fixtures/yaml/badtag3.yml b/tests/Symfony/Tests/Component/DependencyInjection/Fixtures/yaml/badtag3.yml
@@ -0,0 +1,6 @@
+services:
+    foo_service:
+        class:    FooClass
+        tags:
+          # tag-attribute is not a scalar
+          - { name: foo, foo: { foo: foo, bar: bar } }
diff --git a/tests/Symfony/Tests/Component/DependencyInjection/Loader/YamlFileLoaderTest.php b/tests/Symfony/Tests/Component/DependencyInjection/Loader/YamlFileLoaderTest.php
@@ -185,4 +185,16 @@ public function testTagWithoutNameThrowsException()
             $this->assertStringStartsWith('A "tags" entry is missing a "name" key for service ', $e->getMessage(), '->load() throws an InvalidArgumentException if a tag is missing the name key');
         }
     }
+
+    public function testTagWithAttributeArrayThrowsException()
+    {
+        $loader = new YamlFileLoader(new ContainerBuilder(), new FileLocator(self::$fixturesPath.'/yaml'));
+        try {
+            $loader->load('badtag3.yml');
+            $this->fail('->load() should throw an exception when a tag-attribute is not a scalar');
+        } catch (\Exception $e) {
+            $this->assertInstanceOf('Symfony\Component\DependencyInjection\Exception\InvalidArgumentException', $e, '->load() throws an InvalidArgumentException if a tag-attribute is not a scalar');
+            $this->assertStringStartsWith('A "tags" attribute must be of a scalar-type for service ', $e->getMessage(), '->load() throws an InvalidArgumentException if a tag-attribute is not a scalar');
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -216,6 +216,12 @@ private function parseDefinition($id, $service, $file)`
`216`	`216`	`$name = $tag['name'];`
`217`	`217`	`unset($tag['name']);`
`218`	`218`
	`219`	`+ foreach ($tag as $attribute => $value) {`
	`220`	`+ if (!is_scalar($value)) {`
	`221`	`+ throw new InvalidArgumentException(sprintf('A "tags" attribute must be of a scalar-type for service "%s", tag "%s" in %s.', $id, $name, $file));`
	`222`	`+ }`
	`223`	`+ }`
	`224`	`+`
`219`	`225`	`$definition->addTag($name, $tag);`
`220`	`226`	`}`
`221`	`227`	`}`
Original file line number	Diff line number	Diff line change
`@@ -185,4 +185,16 @@ public function testTagWithoutNameThrowsException()`
`185`	`185`	`$this->assertStringStartsWith('A "tags" entry is missing a "name" key for service ', $e->getMessage(), '->load() throws an InvalidArgumentException if a tag is missing the name key');`
`186`	`186`	`}`
`187`	`187`	`}`
	`188`	`+`
	`189`	`+ public function testTagWithAttributeArrayThrowsException()`
	`190`	`+ {`
	`191`	`+ $loader = new YamlFileLoader(new ContainerBuilder(), new FileLocator(self::$fixturesPath.'/yaml'));`
	`192`	`+ try {`
	`193`	`+ $loader->load('badtag3.yml');`
	`194`	`+ $this->fail('->load() should throw an exception when a tag-attribute is not a scalar');`
	`195`	`+ } catch (\Exception $e) {`
	`196`	`+ $this->assertInstanceOf('Symfony\Component\DependencyInjection\Exception\InvalidArgumentException', $e, '->load() throws an InvalidArgumentException if a tag-attribute is not a scalar');`
	`197`	`+ $this->assertStringStartsWith('A "tags" attribute must be of a scalar-type for service ', $e->getMessage(), '->load() throws an InvalidArgumentException if a tag-attribute is not a scalar');`
	`198`	`+ }`
	`199`	`+ }`
`188`	`200`	`}`