feature #1770 Make the root package name and path dynamically discovered in MakerTestCase (GromNaN)

This PR was squashed before being merged into the 1.x branch.

Discussion
----------

Make the root package name and path dynamically discovered in `MakerTestCase`

An issue when using the `MakerTestCase` to test maker classes provided by other packages, is that it depends on the `tests` directory of the `symfony/maker-bundle` package.

In this PR, we use `Composer\InstalledVersions::getRootPackage()` to retrieve the path and name of the root package under test. This way, that's the tested package that is linked into the temporary test projects.

This assumes a certain structure of the maker package (`src`, `tests` and `tests/fixtures` dirs, `tests/tmp` ignored, `tools/twigcs` subproject).

Commits
-------

5d8d6fb Make the root package name and path dynamically discovered in `MakerTestCase`

Author: GromNaN

composer.json

@@ -14,6 +14,7 @@
     "minimum-stability": "dev",
     "require": {
         "php": ">=8.1",
+        "composer-runtime-api": "^2.1",
         "doctrine/inflector": "^2.0",
         "nikic/php-parser": "^5.0",
         "symfony/config": "^6.4|^7.0|^8.0",

src/Test/MakerTestEnvironment.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\MakerBundle\Test;
 
+use Composer\InstalledVersions;
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Process\InputStream;
 
@@ -28,9 +29,11 @@ final class MakerTestEnvironment
     public const GENERATED_FILES_REGEX = '#(?:created|updated):\s(?:.*\\\\)*(.*\.[a-z]{3,4}).*(?:\\\\n)?#ui';
 
     private Filesystem $fs;
-    private bool|string $rootPath;
+    private string $packageName;
+    private string $rootPath;
     private string $cachePath;
     private string $flexPath;
+    private string $fixturesPath;
     private string $path;
     private MakerTestProcess $runnedMakerProcess;
     private bool $isWindows;
@@ -41,7 +44,9 @@ private function __construct(
         $this->isWindows = '\\' === \DIRECTORY_SEPARATOR;
 
         $this->fs = new Filesystem();
-        $this->rootPath = realpath(__DIR__.'/../../');
+        $composerPackage = InstalledVersions::getRootPackage();
+        $this->packageName = $composerPackage['name'];
+        $this->rootPath = realpath($composerPackage['install_path']);
         $cachePath = $this->rootPath.'/tests/tmp/cache';
 
         if (!$this->fs->exists($cachePath)) {
@@ -51,6 +56,7 @@ private function __construct(
         $this->cachePath = realpath($cachePath);
         $targetVersion = $this->getTargetSkeletonVersion();
         $this->flexPath = $this->cachePath.'/flex_project'.$targetVersion;
+        $this->fixturesPath = $this->rootPath.'/tests/fixtures/';
 
         $directoryName = $targetVersion ?: 'current';
         if (str_ends_with($directoryName, '.*')) {
@@ -65,6 +71,11 @@ public static function create(MakerTestDetails $testDetails): self
         return new self($testDetails);
     }
 
+    public function getFixturesPath(string $path = ''): string
+    {
+        return $this->fixturesPath.$path;
+    }
+
     public function getPath(): string
     {
         return $this->path;
@@ -134,7 +145,7 @@ public function prepareDirectory(): void
     {
         // Copy MakerBundle to a "repo" directory for tests
         if (!file_exists($makerRepoPath = \sprintf('%s/maker-repo', $this->cachePath))) {
-            MakerTestProcess::create(\sprintf('git clone %s %s', $this->rootPath, $makerRepoPath), $this->cachePath)->run();
+            MakerTestProcess::create(['git', 'clone', $this->rootPath, $makerRepoPath], $this->cachePath)->run();
         }
 
         if (!$this->fs->exists($this->flexPath)) {
@@ -150,15 +161,7 @@ public function prepareDirectory(): void
         if (!$this->fs->exists($this->path)) {
             try {
                 // let's do some magic here git is faster than copy
-                MakerTestProcess::create(
-                    $this->isWindows ? 'git clone %FLEX_PATH% %APP_PATH%' : 'git clone "$FLEX_PATH" "$APP_PATH"',
-                    \dirname($this->flexPath),
-                    [
-                        'FLEX_PATH' => $this->flexPath,
-                        'APP_PATH' => $this->path,
-                    ]
-                )
-                    ->run();
+                MakerTestProcess::create(['git', 'clone', $this->flexPath, $this->path], \dirname($this->flexPath))->run();
 
                 // In Window's we have to require MakerBundle in each project - git clone doesn't symlink well
                 if ($this->isWindows) {
@@ -196,7 +199,10 @@ public function prepareDirectory(): void
         }
     }
 
-    public function runCommand(string $command): MakerTestProcess
+    /**
+     * @param string|list<string> $command
+     */
+    public function runCommand(string|array $command): MakerTestProcess
     {
         return MakerTestProcess::create($command, $this->path)->run();
     }
@@ -236,7 +242,7 @@ public function fileExists(string $file): bool
 
     public function runTwigCSLint(string $file): MakerTestProcess
     {
-        if (!file_exists(__DIR__.'/../../tools/twigcs/vendor/bin/twigcs')) {
+        if (!file_exists($this->rootPath.'/tools/twigcs/vendor/bin/twigcs')) {
             throw new \Exception('twigcs not found: run: "composer upgrade -W --working-dir=tools/twigcs".');
         }
 
@@ -249,20 +255,20 @@ private function buildFlexSkeleton(): void
         $targetVersion = $this->getTargetSkeletonVersion();
         $versionString = $targetVersion ? \sprintf(':%s', $targetVersion) : '';
 
-        $flexProjectDir = \sprintf('flex_project%s', $targetVersion);
+        $flexProjectDir = \sprintf('%s/flex_project%s', $this->cachePath, $targetVersion);
 
         MakerTestProcess::create(
             \sprintf('composer create-project symfony/skeleton%s %s --prefer-dist --no-progress --keep-vcs', $versionString, $flexProjectDir),
             $this->cachePath
         )->run();
 
-        $rootPath = str_replace('\\', '\\\\', realpath(__DIR__.'/../..'));
+        $rootPath = str_replace('\\', '\\\\', $this->rootPath);
 
-        $this->addMakerBundleRepoToComposer(\sprintf('%s/%s/composer.json', $this->cachePath, $flexProjectDir));
+        $this->addMakerBundleRepoToComposer($flexProjectDir);
 
         // In Linux, git plays well with symlinks - we can add maker to the flex skeleton.
         if (!$this->isWindows) {
-            $this->composerRequireMakerBundle(\sprintf('%s/%s', $this->cachePath, $flexProjectDir));
+            $this->composerRequireMakerBundle($flexProjectDir);
         }
 
         // fetch a few packages needed for testing
@@ -411,9 +417,7 @@ public function getTargetSkeletonVersion(): ?string
 
     private function composerRequireMakerBundle(string $projectDirectory): void
     {
-        MakerTestProcess::create('composer require --dev symfony/maker-bundle', $projectDirectory)
-            ->run()
-        ;
+        MakerTestProcess::create(['composer', 'require', '--dev', $this->packageName], $projectDirectory)->run();
 
         $makerRepoSrcPath = \sprintf('%s/maker-repo/src', $this->cachePath);
 
@@ -425,26 +429,20 @@ private function composerRequireMakerBundle(string $projectDirectory): void
     }
 
     /**
-     * Adds Symfony/MakerBundle as a "path" repository to composer.json.
+     * Adds symfony/maker-bundle as a "path" repository to composer.json.
      */
-    private function addMakerBundleRepoToComposer(string $composerJsonPath): void
+    private function addMakerBundleRepoToComposer(string $projectDirectory): void
     {
-        $composerJson = json_decode(
-            file_get_contents($composerJsonPath), true, 512, \JSON_THROW_ON_ERROR);
-
-        // Require-dev is empty and composer complains about this being an array when we encode it again.
-        unset($composerJson['require-dev']);
-
-        $composerJson['repositories']['symfony/maker-bundle'] = [
+        $repo = [
             'type' => 'path',
             'url' => \sprintf('%s%smaker-repo', $this->cachePath, \DIRECTORY_SEPARATOR),
             'options' => [
                 'versions' => [
-                    'symfony/maker-bundle' => '9999.99', // Arbitrary version to avoid stability conflicts
+                    $this->packageName => '9999.99', // Arbitrary version to avoid stability conflicts
                 ],
             ],
         ];
 
-        file_put_contents($composerJsonPath, json_encode($composerJson, \JSON_THROW_ON_ERROR | \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES));
+        MakerTestProcess::create(['composer', 'repo', 'add', $this->packageName, json_encode($repo)], $projectDirectory)->run();
     }
 }

src/Test/MakerTestProcess.php

@@ -22,7 +22,10 @@ final class MakerTestProcess
 {
     private Process $process;
 
-    private function __construct($commandLine, $cwd, array $envVars, $timeout)
+    /**
+     * @param string|list<string> $commandLine
+     */
+    private function __construct(string|array $commandLine, string $cwd, array $envVars, ?float $timeout)
     {
         $this->process = \is_string($commandLine)
             ? Process::fromShellCommandline($commandLine, $cwd, null, null, $timeout)
@@ -31,7 +34,10 @@ private function __construct($commandLine, $cwd, array $envVars, $timeout)
         $this->process->setEnv($envVars);
     }
 
-    public static function create($commandLine, $cwd, array $envVars = [], $timeout = null): self
+    /**
+     * @param string|list<string> $commandLine
+     */
+    public static function create(string|array $commandLine, string $cwd, array $envVars = [], ?float $timeout = null): self
     {
         return new self($commandLine, $cwd, $envVars, $timeout);
     }

src/Test/MakerTestRunner.php

@@ -52,7 +52,7 @@ public function runMaker(array $inputs, string $argumentsString = '', bool $allo
      */
     public function copy(string $source, string $destination)
     {
-        $path = __DIR__.'/../../tests/fixtures/'.$source;
+        $path = $this->environment->getFixturesPath($source);
 
         if (!file_exists($path)) {
             throw new \Exception(\sprintf('Cannot find file "%s"', $path));
@@ -76,7 +76,7 @@ public function copy(string $source, string $destination)
     public function renderTemplateFile(string $source, string $destination, array $variables): void
     {
         $twig = new Environment(
-            new FilesystemLoader(__DIR__.'/../../tests/fixtures')
+            new FilesystemLoader($this->environment->getFixturesPath())
         );
 
         $rendered = $twig->render($source, $variables);