add tests

Author: kbond

src/Icons/src/Registry/CacheIconRegistry.php

@@ -78,7 +78,7 @@ public function isOptional(): bool
         return true;
     }
 
-    public function warmUp(string $cacheDir, string $buildDir = null): array
+    public function warmUp(string $cacheDir, ?string $buildDir = null): array
     {
         foreach ($this as $name) {
             $this->get($name, refresh: true);

src/Icons/src/Registry/LocalSvgIconRegistry.php

@@ -34,15 +34,37 @@ public function get(string $name): array
 
         $svg = file_get_contents($filename) ?: throw new \RuntimeException(sprintf('The icon file "%s" could not be read.', $filename));
         $doc = new \DOMDocument();
-        $doc->loadXML($svg);
-        $svgTag = $doc->firstElementChild;
+        $doc->preserveWhiteSpace = false;
+
+        try {
+            $doc->loadXML($svg);
+        } catch (\Throwable $e) {
+            throw new \RuntimeException(sprintf('The icon file "%s" does not contain a valid SVG.', $filename), previous: $e);
+        }
+
+        $svgElements = $doc->getElementsByTagName('svg');
+
+        if (0 === $svgElements->length) {
+            throw new \RuntimeException(sprintf('The icon file "%s" does not contain a valid SVG.', $filename));
+        }
+
+        if (1 !== $svgElements->length) {
+            throw new \RuntimeException(sprintf('The icon file "%s" contains more than one SVG.', $filename));
+        }
+
+        $svgElement = $svgElements->item(0) ?? throw new \RuntimeException(sprintf('The icon file "%s" does not contain a valid SVG.', $filename));
+
         $html = '';
 
-        foreach ($svgTag->childNodes as $child) {
+        foreach ($svgElement->childNodes as $child) {
             $html .= $doc->saveHTML($child);
         }
 
-        $allAttributes = array_map(fn (\DOMAttr $a) => $a->value, [...$svgTag->attributes]);
+        if (!$html) {
+            throw new \RuntimeException(sprintf('The icon file "%s" contains an empty SVG.', $filename));
+        }
+
+        $allAttributes = array_map(fn (\DOMAttr $a) => $a->value, [...$svgElement->attributes]);
         $attributes = [];
 
         if (isset($allAttributes['viewBox'])) {

src/Icons/tests/Fixtures/svg/invalid1.svg

@@ -0,0 +1,64 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\Icons\Tests\Unit\Registry;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\UX\Icons\Registry\LocalSvgIconRegistry;
+
+/**
+ * @author Kevin Bond <[email protected]>
+ */
+final class LocalSvgIconRegistryTest extends TestCase
+{
+    /**
+     * @dataProvider validSvgProvider
+     */
+    public function testValidSvgs(string $name, array $expectedAttributes, string $expectedContent): void
+    {
+        [$content, $attributes] = $this->registry()->get($name);
+
+        $this->assertSame($expectedContent, $content);
+        $this->assertSame($expectedAttributes, $attributes);
+    }
+
+    public static function validSvgProvider(): iterable
+    {
+        yield ['valid1', ['viewBox' => '0 0 24 24'], '<path fill-rule="evenodd" d="M7.5 6a4.5 4.5 0 1 1 9 0 4.5 4.5 0 0 1-9 0ZM3.751 20.105a8.25 8.25 0 0 1 16.498 0 .75.75 0 0 1-.437.695A18.683 18.683 0 0 1 12 22.5c-2.786 0-5.433-.608-7.812-1.7a.75.75 0 0 1-.437-.695Z" clip-rule="evenodd"></path>'];
+        yield ['valid2', ['viewBox' => '0 0 24 24'], '<path fill-rule="evenodd" d="M7.5 6a4.5 4.5 0 1 1 9 0 4.5 4.5 0 0 1-9 0ZM3.751 20.105a8.25 8.25 0 0 1 16.498 0 .75.75 0 0 1-.437.695A18.683 18.683 0 0 1 12 22.5c-2.786 0-5.433-.608-7.812-1.7a.75.75 0 0 1-.437-.695Z" clip-rule="evenodd"></path>'];
+        yield ['valid3', ['viewBox' => '0 0 24 24'], '<path fill-rule="evenodd" d="M7.5 6a4.5 4.5 0 1 1 9 0 4.5 4.5 0 0 1-9 0ZM3.751 20.105a8.25 8.25 0 0 1 16.498 0 .75.75 0 0 1-.437.695A18.683 18.683 0 0 1 12 22.5c-2.786 0-5.433-.608-7.812-1.7a.75.75 0 0 1-.437-.695Z" clip-rule="evenodd"></path>'];
+        yield ['valid4', ['viewBox' => '0 0 24 24'], '<path fill-rule="evenodd" d="M7.5 6a4.5 4.5 0 1 1 9 0 4.5 4.5 0 0 1-9 0ZM3.751 20.105a8.25 8.25 0 0 1 16.498 0 .75.75 0 0 1-.437.695A18.683 18.683 0 0 1 12 22.5c-2.786 0-5.433-.608-7.812-1.7a.75.75 0 0 1-.437-.695Z" clip-rule="evenodd"></path><path fill-rule="evenodd" d="M7.5 6a4.5 4.5 0 1 1 9 0 4.5 4.5 0 0 1-9 0ZM3.751 20.105a8.25 8.25 0 0 1 16.498 0 .75.75 0 0 1-.437.695A18.683 18.683 0 0 1 12 22.5c-2.786 0-5.433-.608-7.812-1.7a.75.75 0 0 1-.437-.695Z" clip-rule="evenodd"></path>'];
+        yield ['valid5', ['viewBox' => '0 0 24 24'], '<path fill-rule="evenodd" d="M7.5 6a4.5 4.5 0 1 1 9 0 4.5 4.5 0 0 1-9 0ZM3.751 20.105a8.25 8.25 0 0 1 16.498 0 .75.75 0 0 1-.437.695A18.683 18.683 0 0 1 12 22.5c-2.786 0-5.433-.608-7.812-1.7a.75.75 0 0 1-.437-.695Z" clip-rule="evenodd"></path><g><path fill-rule="evenodd" d="M7.5 6a4.5 4.5 0 1 1 9 0 4.5 4.5 0 0 1-9 0ZM3.751 20.105a8.25 8.25 0 0 1 16.498 0 .75.75 0 0 1-.437.695A18.683 18.683 0 0 1 12 22.5c-2.786 0-5.433-.608-7.812-1.7a.75.75 0 0 1-.437-.695Z" clip-rule="evenodd"></path></g>'];
+    }
+
+    /**
+     * @dataProvider invalidSvgProvider
+     */
+    public function testInvalidSvgs(string $name): void
+    {
+        $this->expectException(\RuntimeException::class);
+
+        $this->registry()->get($name);
+    }
+
+    public static function invalidSvgProvider(): iterable
+    {
+        yield ['invalid1'];
+        yield ['invalid2'];
+        yield ['invalid3'];
+        yield ['invalid4'];
+    }
+
+    private function registry(): LocalSvgIconRegistry
+    {
+        return new LocalSvgIconRegistry(__DIR__.'/../../Fixtures/svg');
+    }
+}