[Config][DependencyInjection] Uniformize trailing slash handling

symfony · nicolas-grekas · May 7, 2021 · Apr 22, 2021 · May 7, 2021 · dc50aa3b55b5504f55a8faf8ccd115561cb14315
commit dc50aa3b55b5504f55a8faf8ccd115561cb14315
diff --git a/src/Symfony/Component/Config/Loader/FileLoader.php b/src/Symfony/Component/Config/Loader/FileLoader.php
@@ -82,8 +82,8 @@ public function import($resource, $type = null, $ignoreErrors = false, $sourceRe
            $excluded = [];
            foreach ((array) $exclude as $pattern) {
                foreach ($this->glob($pattern, true, $_, false, true) as $path => $info) {
-                    // normalize Windows slashes
-                    $excluded[str_replace('\\', '/', $path)] = true;
+                    // normalize Windows slashes and remove trailing slashes
+                    $excluded[rtrim(str_replace('\\', '/', $path), '/')] = true;
                }
            }


diff --git a/src/Symfony/Component/Config/Tests/Fixtures/ExcludeTrailingSlash/bar.txt b/src/Symfony/Component/Config/Tests/Fixtures/ExcludeTrailingSlash/bar.txt
diff --git a/src/Symfony/Component/Config/Tests/Fixtures/ExcludeTrailingSlash/exclude/baz.txt b/src/Symfony/Component/Config/Tests/Fixtures/ExcludeTrailingSlash/exclude/baz.txt
diff --git a/src/Symfony/Component/Config/Tests/Fixtures/ExcludeTrailingSlash/foo.txt b/src/Symfony/Component/Config/Tests/Fixtures/ExcludeTrailingSlash/foo.txt
diff --git a/src/Symfony/Component/Config/Tests/Loader/FileLoaderTest.php b/src/Symfony/Component/Config/Tests/Loader/FileLoaderTest.php
@@ -127,6 +127,28 @@ public function testImportWithExclude()
        $this->assertCount(2, $loadedFiles);
        $this->assertNotContains('ExcludeFile.txt', $loadedFiles);
    }
+
+    /**
+     * @dataProvider excludeTrailingSlashConsistencyProvider
+     */
+    public function testExcludeTrailingSlashConsistency(string $exclude)
+    {
+        $loader = new TestFileLoader(new FileLocator(__DIR__.'/../Fixtures'));
+        $loadedFiles = $loader->import('ExcludeTrailingSlash/*', null, false, null, $exclude);
+        $this->assertCount(2, $loadedFiles);
+        $this->assertNotContains('baz.txt', $loadedFiles);
+    }
+
+    public function excludeTrailingSlashConsistencyProvider(): iterable
+    {
+        yield [__DIR__.'/../Fixtures/Exclude/ExcludeToo/'];
+        yield [__DIR__.'/../Fixtures/Exclude/ExcludeToo'];
+        yield [__DIR__.'/../Fixtures/Exclude/ExcludeToo/*'];
+        yield [__DIR__.'/../Fixtures/*/ExcludeToo'];
+        yield [__DIR__.'/../Fixtures/*/ExcludeToo/'];
+        yield [__DIR__.'/../Fixtures/Exclude/ExcludeToo/*'];
+        yield [__DIR__.'/../Fixtures/Exclude/ExcludeToo/AnotheExcludedFile.txt'];
+    }
 }

 class TestFileLoader extends FileLoader

diff --git a/src/Symfony/Component/Config/Tests/Resource/GlobResourceTest.php b/src/Symfony/Component/Config/Tests/Resource/GlobResourceTest.php
@@ -177,6 +177,7 @@ public function testBraceFallback()

        $expected = [
            $dir.'/Exclude/ExcludeToo/AnotheExcludedFile.txt',
+            $dir.'/ExcludeTrailingSlash/exclude/baz.txt',
            $dir.'/foo.xml',
        ];


diff --git a/src/Symfony/Component/DependencyInjection/Loader/FileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/FileLoader.php
@@ -166,8 +166,8 @@ private function findClasses(string $namespace, string $pattern, array $excludeP
                    $excludePrefix = $resource->getPrefix();
                }

-                // normalize Windows slashes
-                $excludePaths[str_replace('\\', '/', $path)] = true;
+                // normalize Windows slashes and remove trailing slashes
+                $excludePaths[rtrim(str_replace('\\', '/', $path), '/')] = true;
            }
        }


diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/FileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/FileLoaderTest.php
@@ -239,6 +239,35 @@ public function testRegisterClassesWithIncompatibleExclude()
            'yaml/*'
        );
    }
+
+    /**
+     * @dataProvider excludeTrailingSlashConsistencyProvider
+     */
+    public function testExcludeTrailingSlashConsistency(string $exclude)
+    {
+        $container = new ContainerBuilder();
+        $loader = new TestFileLoader($container, new FileLocator(self::$fixturesPath.'/Fixtures'));
+        $loader->registerClasses(
+            new Definition(),
+            'Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\\',
+            'Prototype/*',
+            $exclude
+        );
+
+        $this->assertTrue($container->has(Foo::class));
+        $this->assertFalse($container->has(DeeperBaz::class));
+    }
+
+    public function excludeTrailingSlashConsistencyProvider(): iterable
+    {
+        yield ['Prototype/OtherDir/AnotherSub/'];
+        yield ['Prototype/OtherDir/AnotherSub'];
+        yield ['Prototype/OtherDir/AnotherSub/*'];
+        yield ['Prototype/*/AnotherSub'];
+        yield ['Prototype/*/AnotherSub/'];
+        yield ['Prototype/*/AnotherSub/*'];
+        yield ['Prototype/OtherDir/AnotherSub/DeeperBaz.php'];
+    }
 }

 class TestFileLoader extends FileLoader