Apply dogfood project environment variables

Author: fabpot

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- Apply configured environment variables to dogfood processes
 - Navigate and complete form fields mapped to data class properties
 - Complete and navigate PHP constants and enums in Twig
 

tests/Tool/Dogfood/ComposerSetupTest.php

@@ -35,6 +35,17 @@ public function testInstallsThePinnedDependencySet(): void
         self::assertCount(1, $processes->calls);
         self::assertSame(['composer', 'install', '--no-interaction', '--no-progress'], $processes->calls[0]['command']);
         self::assertSame($this->directory, $processes->calls[0]['directory']);
+        self::assertSame([], $processes->calls[0]['environment']);
+    }
+
+    public function testPassesConfiguredEnvironmentVariablesToComposer(): void
+    {
+        file_put_contents(Path::join($this->directory, 'composer.lock'), '{}');
+        $processes = new FakeProcessRunner(static fn (): ProcessResult => new ProcessResult(0, '', '', false));
+
+        (new ComposerSetup($processes))->setUp($this->configuration(environmentVariables: ['DATABASE_URL' => 'mysql://root@127.0.0.1:9/app']), $this->directory);
+
+        self::assertSame(['DATABASE_URL' => 'mysql://root@127.0.0.1:9/app'], $processes->calls[0]['environment']);
     }
 
     public function testSkipsScriptsWhenDisabled(): void
@@ -109,10 +120,11 @@ public function testReportsInstallationFailures(): void
     }
 
     /**
-     * @param list<string> $allowPlugins
+     * @param list<string>          $allowPlugins
+     * @param array<string, string> $environmentVariables
      */
-    private function configuration(?string $lockFile = null, array $allowPlugins = []): ProjectConfiguration
+    private function configuration(?string $lockFile = null, array $allowPlugins = [], array $environmentVariables = []): ProjectConfiguration
     {
-        return new ProjectConfiguration('acme', 'https://github.com/acme/app.git', str_repeat('a', 40), null, 'dev', 'composer', false, 120, lockFile: $lockFile, allowPlugins: $allowPlugins);
+        return new ProjectConfiguration('acme', 'https://github.com/acme/app.git', str_repeat('a', 40), null, 'dev', 'composer', false, 120, lockFile: $lockFile, allowPlugins: $allowPlugins, environmentVariables: $environmentVariables);
     }
 }

tests/Tool/Dogfood/ConfigurationLoaderTest.php

@@ -45,6 +45,7 @@ public function testLoadsMinimalConfigurationWithDefaults(): void
         self::assertSame(self::REVISION, $configuration->revision);
         self::assertNull($configuration->directory);
         self::assertSame('dev', $configuration->environment);
+        self::assertSame([], $configuration->environmentVariables);
         self::assertSame('composer', $configuration->setup);
         self::assertTrue($configuration->ci);
         self::assertSame(120, $configuration->indexTimeout);
@@ -61,6 +62,10 @@ public function testLoadsFullConfiguration(): void
             'revision' => self::REVISION,
             'directory' => 'twig.symfony.com',
             'environment' => 'test',
+            'environmentVariables' => [
+                'DATABASE_URL' => 'mysql://root@127.0.0.1:9/app',
+                'APP_SECRET' => 'dogfood-not-a-secret',
+            ],
             'setup' => 'composer',
             'ci' => false,
             'indexTimeout' => 300,
@@ -75,6 +80,10 @@ public function testLoadsFullConfiguration(): void
         self::assertSame('twig.symfony.com', $configuration->name);
         self::assertSame('twig.symfony.com', $configuration->directory);
         self::assertSame('test', $configuration->environment);
+        self::assertSame([
+            'APP_SECRET' => 'dogfood-not-a-secret',
+            'DATABASE_URL' => 'mysql://root@127.0.0.1:9/app',
+        ], $configuration->environmentVariables);
         self::assertFalse($configuration->ci);
         self::assertSame(300, $configuration->indexTimeout);
         self::assertSame(20, $configuration->requestTimeout);
@@ -176,6 +185,10 @@ public static function invalidConfigurationProvider(): iterable
         yield 'absolute directory' => [['directory' => '/srv'], 'relative path inside the repository'];
         yield 'parent directory' => [['directory' => '../other'], 'relative path inside the repository'];
         yield 'invalid environment' => [['environment' => 'dev; rm'], 'simple environment name'];
+        yield 'environment variable list' => [['environmentVariables' => ['DATABASE_URL']], 'map of environment variable names to string values'];
+        yield 'invalid environment variable name' => [['environmentVariables' => ['database-url' => 'value']], 'map of environment variable names to string values'];
+        yield 'non-string environment variable' => [['environmentVariables' => ['DATABASE_URL' => 42]], 'map of environment variable names to string values'];
+        yield 'null byte environment variable' => [['environmentVariables' => ['DATABASE_URL' => "value\0suffix"]], 'map of environment variable names to string values'];
         yield 'unknown setup' => [['setup' => 'shell'], 'The "setup" in'];
         yield 'missing ci' => [['ci' => null], 'boolean "ci"'];
         yield 'string ci' => [['ci' => 'yes'], 'boolean "ci"'];

tests/Tool/Dogfood/FakeProcessRunner.php

@@ -7,21 +7,21 @@
 
 final class FakeProcessRunner implements ProcessRunnerInterface
 {
-    /** @var list<array{command: list<string>, directory: ?string, timeout: float}> */
+    /** @var list<array{command: list<string>, directory: ?string, timeout: float, environment: array<string, string>}> */
     public array $calls = [];
 
     /**
-     * @param \Closure(list<string>, ?string): ProcessResult $handler
+     * @param \Closure(list<string>, ?string, array<string, string>): ProcessResult $handler
      */
     public function __construct(
         private \Closure $handler,
     ) {
     }
 
-    public function run(array $command, ?string $directory = null, float $timeout = 600.0): ProcessResult
+    public function run(array $command, ?string $directory = null, float $timeout = 600.0, array $environment = []): ProcessResult
     {
-        $this->calls[] = ['command' => $command, 'directory' => $directory, 'timeout' => $timeout];
+        $this->calls[] = ['command' => $command, 'directory' => $directory, 'timeout' => $timeout, 'environment' => $environment];
 
-        return ($this->handler)($command, $directory);
+        return ($this->handler)($command, $directory, $environment);
     }
 }

tests/Tool/Dogfood/NativeProcessRunnerTest.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Symfony\Lsp\Tests\Tool\Dogfood;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Lsp\Tools\Dogfood\NativeProcessRunner;
+
+final class NativeProcessRunnerTest extends TestCase
+{
+    public function testOverridesTheInheritedEnvironment(): void
+    {
+        $result = (new NativeProcessRunner())->run(
+            [\PHP_BINARY, '-r', 'fwrite(STDOUT, (string) getenv("SYMFONY_LSP_DOGFOOD_TEST"));'],
+            environment: ['SYMFONY_LSP_DOGFOOD_TEST' => 'configured'],
+        );
+
+        self::assertTrue($result->successful());
+        self::assertSame('configured', $result->standardOutput);
+    }
+}

tests/Tool/Dogfood/ServerHarnessTest.php

@@ -46,11 +46,13 @@ public function testDerivesTheProcessBudgetFromDiscoveredProbes(array $files, fl
             20,
             requestTimeout: 3,
             probeRoots: ['src', 'templates'],
+            environmentVariables: ['DATABASE_URL' => 'mysql://root@127.0.0.1:9/app'],
         );
 
         (new ServerHarness($processes, '/tools/dogfood-server', '/bin/symfony-lsp'))->run($configuration, $this->directory);
 
         self::assertSame($expectedTimeout, $processes->calls[0]['timeout']);
+        self::assertSame(['DATABASE_URL' => 'mysql://root@127.0.0.1:9/app'], $processes->calls[0]['environment']);
     }
 
     /** @return iterable<string, array{array<string, string>, float}> */

tools/dogfood/ComposerSetup.php

@@ -23,7 +23,7 @@ public function setUp(ProjectConfiguration $configuration, string $applicationRo
         }
         $manifest = [] === $configuration->allowPlugins ? false : @file_get_contents($applicationRoot.'/composer.json');
         foreach ($configuration->allowPlugins as $plugin) {
-            $allow = $this->processes->run(['composer', 'config', '--no-plugins', '--no-interaction', 'allow-plugins.'.$plugin, 'true'], $applicationRoot, $this->timeout);
+            $allow = $this->processes->run(['composer', 'config', '--no-plugins', '--no-interaction', 'allow-plugins.'.$plugin, 'true'], $applicationRoot, $this->timeout, $configuration->environmentVariables);
             if (!$allow->successful()) {
                 throw new SetupException(\sprintf('Unable to allow the Composer plugin "%s".', $plugin));
             }
@@ -35,7 +35,7 @@ public function setUp(ProjectConfiguration $configuration, string $applicationRo
         if (!$this->scripts) {
             $command[] = '--no-scripts';
         }
-        $result = $this->processes->run($command, $applicationRoot, $this->timeout);
+        $result = $this->processes->run($command, $applicationRoot, $this->timeout, $configuration->environmentVariables);
         if (false !== $manifest) {
             file_put_contents($applicationRoot.'/composer.json', $manifest);
         }

tools/dogfood/ConfigurationLoader.php

@@ -5,7 +5,7 @@
 final class ConfigurationLoader
 {
     private const VERSION = 1;
-    private const KEYS = ['version', 'repository', 'revision', 'directory', 'environment', 'setup', 'ci', 'indexTimeout', 'requestTimeout', 'probeRoots', 'probesPerCategory', 'allowPlugins', 'ignorePlatformRequirements', 'setupChanges'];
+    private const KEYS = ['version', 'repository', 'revision', 'directory', 'environment', 'environmentVariables', 'setup', 'ci', 'indexTimeout', 'requestTimeout', 'probeRoots', 'probesPerCategory', 'allowPlugins', 'ignorePlatformRequirements', 'setupChanges'];
     private const DEFAULT_INDEX_TIMEOUT = 120;
     private const MAX_INDEX_TIMEOUT = 900;
     private const DEFAULT_REQUEST_TIMEOUT = 10;
@@ -85,6 +85,7 @@ private function loadFile(string $file, array $setupIds): ProjectConfiguration
             $this->allowPlugins($data, $file),
             $this->ignorePlatformRequirements($data, $file),
             $this->setupChanges($data, $file),
+            $this->environmentVariables($data, $file),
         );
     }
 
@@ -149,6 +150,27 @@ private function environment(array $data, string $file): string
         return $environment;
     }
 
+    /**
+     * @param array<array-key, mixed> $data
+     *
+     * @return array<string, string>
+     */
+    private function environmentVariables(array $data, string $file): array
+    {
+        $variables = $data['environmentVariables'] ?? [];
+        if (!\is_array($variables) || ([] !== $variables && array_is_list($variables))) {
+            throw new ConfigurationException(\sprintf('The "environmentVariables" in "%s" must be a map of environment variable names to string values.', $file));
+        }
+        foreach ($variables as $name => $value) {
+            if (!\is_string($name) || 1 !== preg_match('/^[A-Z_][A-Z0-9_]*$/', $name) || !\is_string($value) || str_contains($value, "\0")) {
+                throw new ConfigurationException(\sprintf('The "environmentVariables" in "%s" must be a map of environment variable names to string values.', $file));
+            }
+        }
+        ksort($variables);
+
+        return $variables;
+    }
+
     /**
      * @param array<array-key, mixed> $data
      * @param list<string>            $setupIds

tools/dogfood/NativeProcessRunner.php

@@ -11,13 +11,13 @@
 
 final class NativeProcessRunner implements ProcessRunnerInterface
 {
-    public function run(array $command, ?string $directory = null, float $timeout = 600.0): ProcessResult
+    public function run(array $command, ?string $directory = null, float $timeout = 600.0, array $environment = []): ProcessResult
     {
-        $environment = [];
+        $inheritedEnvironment = [];
         foreach (getenv() as $key => $value) {
-            $environment[(string) $key] = $value;
+            $inheritedEnvironment[(string) $key] = $value;
         }
-        $process = Process::start($command, $directory, $environment);
+        $process = Process::start($command, $directory, array_replace($inheritedEnvironment, $environment));
         $process->getStdin()->close();
         /** @var \Amp\Future<string> $stdout */
         $stdout = async(static fn (): string => buffer($process->getStdout()));

tools/dogfood/ProcessRunnerInterface.php

@@ -5,7 +5,8 @@
 interface ProcessRunnerInterface
 {
     /**
-     * @param list<string> $command
+     * @param list<string>          $command
+     * @param array<string, string> $environment
      */
-    public function run(array $command, ?string $directory = null, float $timeout = 600.0): ProcessResult;
+    public function run(array $command, ?string $directory = null, float $timeout = 600.0, array $environment = []): ProcessResult;
 }