bug #950 Resolve directories for copy from recipe in update case (shyim)

This PR was merged into the 2.x branch.

Discussion
----------

Resolve directories for copy from recipe in update case

The update case of `CopyFromRecipeConfigurator` does not respect the folders in the config.
https://symfony.com/doc/current/setup/flex.html#customizing-flex-paths

Commits
-------

ee3a0d5 Resolve directories for copy from recipe in update case

Author: nicolas-grekas

src/Configurator/CopyFromRecipeConfigurator.php

@@ -37,18 +37,35 @@ public function unconfigure(Recipe $recipe, $config, Lock $lock)
     public function update(RecipeUpdate $recipeUpdate, array $originalConfig, array $newConfig): void
     {
         foreach ($recipeUpdate->getOriginalRecipe()->getFiles() as $filename => $data) {
+            $filename = $this->resolveTargetFolder($filename, $originalConfig);
             $recipeUpdate->setOriginalFile($filename, $data['contents']);
         }
 
         $files = [];
         foreach ($recipeUpdate->getNewRecipe()->getFiles() as $filename => $data) {
+            $filename = $this->resolveTargetFolder($filename, $newConfig);
             $recipeUpdate->setNewFile($filename, $data['contents']);
 
             $files[] = $this->getLocalFilePath($recipeUpdate->getRootDir(), $filename);
         }
+
         $recipeUpdate->getLock()->add($recipeUpdate->getPackageName(), ['files' => $files]);
     }
 
+    /**
+     * @param array<string, string> $config
+     */
+    private function resolveTargetFolder(string $path, array $config): string
+    {
+        foreach ($config as $key => $target) {
+            if (0 === strpos($path, $key)) {
+                return $this->options->expandTargetDir($target).substr($path, \strlen($key));
+            }
+        }
+
+        return $path;
+    }
+
     private function getRemovableFilesFromRecipeAndLock(Recipe $recipe, Lock $lock): array
     {
         $lockedFiles = array_unique(

tests/Command/UpdateRecipesCommandTest.php

@@ -100,7 +100,7 @@ private function createCommandUpdateRecipes(): CommandTester
             $rfs = Factory::createRemoteFilesystem($this->io, $composer->getConfig());
             $rfs = new ParallelDownloader($this->io, $composer->getConfig(), $rfs->getOptions(), $rfs->isTlsDisabled());
         }
-        $options = new Options(['root-dir' => FLEX_TEST_DIR]);
+        $options = new Options(['root-dir' => FLEX_TEST_DIR, 'bin-dir' => 'bin/']);
         $command = new UpdateRecipesCommand(
             $flex,
             new Downloader($composer, $this->io, $rfs),

tests/Configurator/CopyFromRecipeConfiguratorTest.php

@@ -190,6 +190,84 @@ public function testUpdate()
         $this->assertSame($newRecipeFiles, $recipeUpdate->getNewFiles());
     }
 
+    public function testUpdateResolveDirectories()
+    {
+        $configurator = $this->createConfigurator();
+
+        $lock = $this->createMock(Lock::class);
+        $lock->expects($this->once())
+            ->method('add')
+            ->with(
+                'test-package',
+                [
+                    'files' => [
+                        'config/packages/framework.yaml',
+                        'test.yaml',
+                    ],
+                ]
+            );
+
+        $originalRecipeFiles = [
+            'symfony8config/packages/framework.yaml' => 'before',
+            'root/test.yaml' => 'before',
+        ];
+        $newRecipeFiles = [
+            'symfony8config/packages/framework.yaml' => 'after',
+            'root/test.yaml' => 'after',
+        ];
+
+        $originalRecipeFileData = [];
+        foreach ($originalRecipeFiles as $file => $contents) {
+            $originalRecipeFileData[$file] = ['contents' => $contents, 'executable' => false];
+        }
+
+        $newRecipeFileData = [];
+        foreach ($newRecipeFiles as $file => $contents) {
+            $newRecipeFileData[$file] = ['contents' => $contents, 'executable' => false];
+        }
+
+        $originalRecipe = $this->createMock(Recipe::class);
+        $originalRecipe->method('getName')
+            ->willReturn('test-package');
+        $originalRecipe->method('getFiles')
+            ->willReturn($originalRecipeFileData);
+
+        $newRecipe = $this->createMock(Recipe::class);
+        $newRecipe->method('getFiles')
+            ->willReturn($newRecipeFileData);
+
+        $recipeUpdate = new RecipeUpdate(
+            $originalRecipe,
+            $newRecipe,
+            $lock,
+            FLEX_TEST_DIR
+        );
+
+        $configurator->update(
+            $recipeUpdate,
+            [
+                'root/' => '',
+                'symfony8config/' => '%CONFIG_DIR%/',
+            ],
+            [
+                'root/' => '',
+                'symfony8config/' => '%CONFIG_DIR%/',
+            ]
+        );
+
+        // Due to root/ => '', we expect that root/ has been stripped
+        $this->assertArrayHasKey('test.yaml', $recipeUpdate->getOriginalFiles());
+        $this->assertArrayHasKey('test.yaml', $recipeUpdate->getNewFiles());
+
+        $this->assertSame('after', $recipeUpdate->getNewFiles()['test.yaml']);
+
+        // %CONFIG-DIR%, got resolved to config/packages back
+        $this->assertArrayHasKey('config/packages/framework.yaml', $recipeUpdate->getOriginalFiles());
+        $this->assertArrayHasKey('config/packages/framework.yaml', $recipeUpdate->getNewFiles());
+
+        $this->assertSame('after', $recipeUpdate->getNewFiles()['config/packages/framework.yaml']);
+    }
+
     protected function setUp(): void
     {
         parent::setUp();
@@ -223,7 +301,7 @@ protected function tearDown(): void
 
     private function createConfigurator(): CopyFromRecipeConfigurator
     {
-        return new CopyFromRecipeConfigurator($this->getMockBuilder(Composer::class)->getMock(), $this->io, new Options(['root-dir' => FLEX_TEST_DIR], $this->io));
+        return new CopyFromRecipeConfigurator($this->getMockBuilder(Composer::class)->getMock(), $this->io, new Options(['root-dir' => FLEX_TEST_DIR, 'config-dir' => 'config'], $this->io));
     }
 
     private function cleanUpTargetFiles()