[Routing] Fixed the importing of files using glob patterns that match multiple resources

skalpa · nicolas-grekas · commit 0778af16a007 · 2018-03-22T16:22:11.000+01:00
diff --git a/Loader/Configurator/RoutingConfigurator.php b/Loader/Configurator/RoutingConfigurator.php
@@ -39,9 +39,17 @@ public function __construct(RouteCollection $collection, PhpFileLoader $loader,
     final public function import($resource, $type = null, $ignoreErrors = false)
     {
         $this->loader->setCurrentDir(dirname($this->path));
-        $subCollection = $this->loader->import($resource, $type, $ignoreErrors, $this->file);
+        $imported = $this->loader->import($resource, $type, $ignoreErrors, $this->file);
+        if (!is_array($imported)) {
+            return new ImportConfigurator($this->collection, $imported);
+        }
 
-        return new ImportConfigurator($this->collection, $subCollection);
+        $mergedCollection = new RouteCollection();
+        foreach ($imported as $subCollection) {
+            $mergedCollection->addCollection($subCollection);
+        }
+
+        return new ImportConfigurator($this->collection, $mergedCollection);
     }
 
     /**
diff --git a/Loader/XmlFileLoader.php b/Loader/XmlFileLoader.php
@@ -146,26 +146,33 @@ protected function parseImport(RouteCollection $collection, \DOMElement $node, $
 
         $this->setCurrentDir(dirname($path));
 
-        $subCollection = $this->import($resource, ('' !== $type ? $type : null), false, $file);
-        /* @var $subCollection RouteCollection */
-        $subCollection->addPrefix($prefix);
-        if (null !== $host) {
-            $subCollection->setHost($host);
-        }
-        if (null !== $condition) {
-            $subCollection->setCondition($condition);
-        }
-        if (null !== $schemes) {
-            $subCollection->setSchemes($schemes);
-        }
-        if (null !== $methods) {
-            $subCollection->setMethods($methods);
+        $imported = $this->import($resource, ('' !== $type ? $type : null), false, $file);
+
+        if (!is_array($imported)) {
+            $imported = array($imported);
         }
-        $subCollection->addDefaults($defaults);
-        $subCollection->addRequirements($requirements);
-        $subCollection->addOptions($options);
 
-        $collection->addCollection($subCollection);
+        foreach ($imported as $subCollection) {
+            /* @var $subCollection RouteCollection */
+            $subCollection->addPrefix($prefix);
+            if (null !== $host) {
+                $subCollection->setHost($host);
+            }
+            if (null !== $condition) {
+                $subCollection->setCondition($condition);
+            }
+            if (null !== $schemes) {
+                $subCollection->setSchemes($schemes);
+            }
+            if (null !== $methods) {
+                $subCollection->setMethods($methods);
+            }
+            $subCollection->addDefaults($defaults);
+            $subCollection->addRequirements($requirements);
+            $subCollection->addOptions($options);
+
+            $collection->addCollection($subCollection);
+        }
     }
 
     /**
diff --git a/Loader/YamlFileLoader.php b/Loader/YamlFileLoader.php
@@ -158,26 +158,33 @@ protected function parseImport(RouteCollection $collection, array $config, $path
 
         $this->setCurrentDir(dirname($path));
 
-        $subCollection = $this->import($config['resource'], $type, false, $file);
-        /* @var $subCollection RouteCollection */
-        $subCollection->addPrefix($prefix);
-        if (null !== $host) {
-            $subCollection->setHost($host);
-        }
-        if (null !== $condition) {
-            $subCollection->setCondition($condition);
-        }
-        if (null !== $schemes) {
-            $subCollection->setSchemes($schemes);
-        }
-        if (null !== $methods) {
-            $subCollection->setMethods($methods);
+        $imported = $this->import($config['resource'], $type, false, $file);
+
+        if (!is_array($imported)) {
+            $imported = array($imported);
         }
-        $subCollection->addDefaults($defaults);
-        $subCollection->addRequirements($requirements);
-        $subCollection->addOptions($options);
 
-        $collection->addCollection($subCollection);
+        foreach ($imported as $subCollection) {
+            /* @var $subCollection RouteCollection */
+            $subCollection->addPrefix($prefix);
+            if (null !== $host) {
+                $subCollection->setHost($host);
+            }
+            if (null !== $condition) {
+                $subCollection->setCondition($condition);
+            }
+            if (null !== $schemes) {
+                $subCollection->setSchemes($schemes);
+            }
+            if (null !== $methods) {
+                $subCollection->setMethods($methods);
+            }
+            $subCollection->addDefaults($defaults);
+            $subCollection->addRequirements($requirements);
+            $subCollection->addOptions($options);
+
+            $collection->addCollection($subCollection);
+        }
     }
 
     /**
diff --git a/Tests/Fixtures/glob/bar.xml b/Tests/Fixtures/glob/bar.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<routes xmlns="http://symfony.com/schema/routing"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://symfony.com/schema/routing
+        http://symfony.com/schema/routing/routing-1.0.xsd">
+
+    <route id="bar_route" path="/bar" controller="AppBundle:Bar:view" />
+</routes>
diff --git a/Tests/Fixtures/glob/bar.yml b/Tests/Fixtures/glob/bar.yml
@@ -0,0 +1,4 @@
+bar_route:
+    path: /bar
+    defaults:
+        _controller: AppBundle:Bar:view
diff --git a/Tests/Fixtures/glob/baz.xml b/Tests/Fixtures/glob/baz.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<routes xmlns="http://symfony.com/schema/routing"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://symfony.com/schema/routing
+        http://symfony.com/schema/routing/routing-1.0.xsd">
+
+    <route id="baz_route" path="/baz" controller="AppBundle:Baz:view" />
+</routes>
diff --git a/Tests/Fixtures/glob/baz.yml b/Tests/Fixtures/glob/baz.yml
@@ -0,0 +1,4 @@
+baz_route:
+    path: /baz
+    defaults:
+        _controller: AppBundle:Baz:view
diff --git a/Tests/Fixtures/glob/import_multiple.xml b/Tests/Fixtures/glob/import_multiple.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<routes xmlns="http://symfony.com/schema/routing"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://symfony.com/schema/routing
+        http://symfony.com/schema/routing/routing-1.0.xsd">
+
+    <import resource="ba?.xml" />
+</routes>
diff --git a/Tests/Fixtures/glob/import_multiple.yml b/Tests/Fixtures/glob/import_multiple.yml
@@ -0,0 +1,2 @@
+_static:
+    resource: ba?.yml
diff --git a/Tests/Fixtures/glob/import_single.xml b/Tests/Fixtures/glob/import_single.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<routes xmlns="http://symfony.com/schema/routing"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://symfony.com/schema/routing
+        http://symfony.com/schema/routing/routing-1.0.xsd">
+
+    <import resource="b?r.xml" />
+</routes>
diff --git a/Tests/Fixtures/glob/import_single.yml b/Tests/Fixtures/glob/import_single.yml
@@ -0,0 +1,2 @@
+_static:
+    resource: b?r.yml
diff --git a/Tests/Fixtures/glob/php_dsl.php b/Tests/Fixtures/glob/php_dsl.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\Routing\Loader\Configurator;
+
+return function (RoutingConfigurator $routes) {
+    return $routes->import('php_dsl_ba?.php');
+};
diff --git a/Tests/Fixtures/glob/php_dsl_bar.php b/Tests/Fixtures/glob/php_dsl_bar.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Symfony\Component\Routing\Loader\Configurator;
+
+return function (RoutingConfigurator $routes) {
+    $collection = $routes->collection();
+
+    $collection->add('bar_route', '/bar')
+        ->defaults(array('_controller' => 'AppBundle:Bar:view'));
+
+    return $collection;
+};
diff --git a/Tests/Fixtures/glob/php_dsl_baz.php b/Tests/Fixtures/glob/php_dsl_baz.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Symfony\Component\Routing\Loader\Configurator;
+
+return function (RoutingConfigurator $routes) {
+    $collection = $routes->collection();
+
+    $collection->add('baz_route', '/baz')
+        ->defaults(array('_controller' => 'AppBundle:Baz:view'));
+
+    return $collection;
+};
diff --git a/Tests/Loader/PhpFileLoaderTest.php b/Tests/Loader/PhpFileLoaderTest.php
@@ -117,4 +117,17 @@ public function testRoutingConfigurator()
 
         $this->assertEquals($expectedCollection, $routeCollection);
     }
+
+    public function testRoutingConfiguratorCanImportGlobPatterns()
+    {
+        $locator = new FileLocator(array(__DIR__.'/../Fixtures/glob'));
+        $loader = new PhpFileLoader($locator);
+        $routeCollection = $loader->load('php_dsl.php');
+
+        $route = $routeCollection->get('bar_route');
+        $this->assertSame('AppBundle:Bar:view', $route->getDefault('_controller'));
+
+        $route = $routeCollection->get('baz_route');
+        $this->assertSame('AppBundle:Baz:view', $route->getDefault('_controller'));
+    }
 }
diff --git a/Tests/Loader/XmlFileLoaderTest.php b/Tests/Loader/XmlFileLoaderTest.php
@@ -361,4 +361,25 @@ public function testImportWithOverriddenController()
         $loader = new XmlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures/controller')));
         $loader->load('import_override_defaults.xml');
     }
+
+    public function testImportRouteWithGlobMatchingSingleFile()
+    {
+        $loader = new XmlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures/glob')));
+        $routeCollection = $loader->load('import_single.xml');
+
+        $route = $routeCollection->get('bar_route');
+        $this->assertSame('AppBundle:Bar:view', $route->getDefault('_controller'));
+    }
+
+    public function testImportRouteWithGlobMatchingMultipleFiles()
+    {
+        $loader = new XmlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures/glob')));
+        $routeCollection = $loader->load('import_multiple.xml');
+
+        $route = $routeCollection->get('bar_route');
+        $this->assertSame('AppBundle:Bar:view', $route->getDefault('_controller'));
+
+        $route = $routeCollection->get('baz_route');
+        $this->assertSame('AppBundle:Baz:view', $route->getDefault('_controller'));
+    }
 }
diff --git a/Tests/Loader/YamlFileLoaderTest.php b/Tests/Loader/YamlFileLoaderTest.php
@@ -182,4 +182,25 @@ public function testImportWithOverriddenController()
         $loader = new YamlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures/controller')));
         $loader->load('import_override_defaults.yml');
     }
+
+    public function testImportRouteWithGlobMatchingSingleFile()
+    {
+        $loader = new YamlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures/glob')));
+        $routeCollection = $loader->load('import_single.yml');
+
+        $route = $routeCollection->get('bar_route');
+        $this->assertSame('AppBundle:Bar:view', $route->getDefault('_controller'));
+    }
+
+    public function testImportRouteWithGlobMatchingMultipleFiles()
+    {
+        $loader = new YamlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures/glob')));
+        $routeCollection = $loader->load('import_multiple.yml');
+
+        $route = $routeCollection->get('bar_route');
+        $this->assertSame('AppBundle:Bar:view', $route->getDefault('_controller'));
+
+        $route = $routeCollection->get('baz_route');
+        $this->assertSame('AppBundle:Baz:view', $route->getDefault('_controller'));
+    }
 }
