feature #715 Improve Docker Compose file detection (dunglas)

nicolas-grekas · nicolas-grekas · commit 781efaab66c2 · 2020-12-15T14:25:36.000+01:00
This PR was squashed before being merged into the 1.9-dev branch. Discussion ---------- Improve Docker Compose file detection This PR implements the rules described in the Docker Compose manual: https://docs.docker.com/compose/reference/envvars/#compose_file (see also #705 (comment), cc @jycamier). Basically, the directory containing the Compose definition can be configured using the `COMPOSE_FILE` environment variable, and it isn't defined Flex will look for the Compose file (as `docker-compose itself`) in the project directory and then in each parent director. This will be especially helpful for API Platform, where the `docker-compose.yml` file is in the parent directory of the Symfony application (https://github.com/api-platform/api-platform/), but also for other monolithic Git repositories containing several applications and a `docker-compose.yaml` file at the root (which is very common and considered a best practice). There is a voluntary limitation regarding the `COMPOSE_FILE` environment variable: the name of the file **must** be the one defined in the recipe (with the `.yml` or `.yaml` extension). In other words, only the directory is configurable, not the file name (on purpose). Commits ------- d04b0b6 Improve Docker Compose file detection
diff --git a/src/Configurator/DockerComposeConfigurator.php b/src/Configurator/DockerComposeConfigurator.php
@@ -11,7 +11,11 @@
 
 namespace Symfony\Flex\Configurator;
 
+use Composer\Composer;
+use Composer\IO\IOInterface;
+use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Flex\Lock;
+use Symfony\Flex\Options;
 use Symfony\Flex\Recipe;
 
 /**
@@ -21,6 +25,15 @@
  */
 class DockerComposeConfigurator extends AbstractConfigurator
 {
+    private $filesystem;
+
+    public function __construct(Composer $composer, IOInterface $io, Options $options)
+    {
+        parent::__construct($composer, $io, $options);
+
+        $this->filesystem = new Filesystem();
+    }
+
     public function configure(Recipe $recipe, $config, Lock $lock, array $options = [])
     {
         $installDocker = $this->composer->getPackage()->getExtra()['symfony']['docker'] ?? false;
@@ -30,17 +43,14 @@ public function configure(Recipe $recipe, $config, Lock $lock, array $options =
 
         $rootDir = $this->options->get('root-dir');
         foreach ($this->normalizeConfig($config) as $file => $extra) {
-            $dockerComposeFile = sprintf('%s/%s', $rootDir, $file);
-
-            // Test with the ".yaml" extension if the file doesn't end up with ".yml".
             if (
-                (!file_exists($dockerComposeFile) && !file_exists($dockerComposeFile = substr($dockerComposeFile, 0, -2).'aml')) ||
+                (null === $dockerComposeFile = $this->findDockerComposeFile($rootDir, $file)) ||
                 $this->isFileMarked($recipe, $dockerComposeFile)
             ) {
                 continue;
             }
 
-            $this->write(sprintf('Adding Docker Compose entries to "%s"', $dockerComposeFile));
+            $this->write(sprintf('Adding Docker Compose definitions to "%s"', $dockerComposeFile));
 
             $offset = 8;
             $node = null;
@@ -83,14 +93,15 @@ public function configure(Recipe $recipe, $config, Lock $lock, array $options =
 
             file_put_contents($dockerComposeFile, implode('', $lines));
         }
+
+        $this->write('Docker Compose definitions have been modified. Please run "docker-compose up --build" again to apply the changes.');
     }
 
     public function unconfigure(Recipe $recipe, $config, Lock $lock)
     {
         $rootDir = $this->options->get('root-dir');
         foreach ($this->normalizeConfig($config) as $file => $extra) {
-            $dockerComposeFile = sprintf('%s/%s', $rootDir, $file);
-            if (!file_exists($dockerComposeFile) && !file_exists($dockerComposeFile = substr($dockerComposeFile, 0, -2).'aml')) {
+            if (null === $dockerComposeFile = $this->findDockerComposeFile($rootDir, $file)) {
                 continue;
             }
 
@@ -110,6 +121,8 @@ public function unconfigure(Recipe $recipe, $config, Lock $lock)
             $this->write(sprintf('Removing Docker Compose entries from "%s"', $dockerComposeFile));
             file_put_contents($dockerComposeFile, ltrim($contents, "\n"));
         }
+
+        $this->write('Docker Compose definitions have been modified. Please run "docker-compose up" again to apply the changes.');
     }
 
     /**
@@ -125,6 +138,49 @@ private function normalizeConfig(array $config): array
         return $config;
     }
 
+    /**
+     * Finds the Docker Compose file according to these rules: https://docs.docker.com/compose/reference/envvars/#compose_file.
+     */
+    private function findDockerComposeFile(string $rootDir, string $file): ?string
+    {
+        if (isset($_SERVER['COMPOSE_FILE'])) {
+            $separator = $_SERVER['COMPOSE_PATH_SEPARATOR'] ?? ('\\' === \DIRECTORY_SEPARATOR ? ';' : ':');
+
+            $files = explode($separator, $_SERVER['COMPOSE_FILE']);
+            foreach ($files as $f) {
+                if ($file !== basename($f)) {
+                    continue;
+                }
+
+                if (!$this->filesystem->isAbsolutePath($f)) {
+                    $f = realpath(sprintf('%s/%s', $rootDir, $f));
+                }
+
+                if ($this->filesystem->exists($f)) {
+                    return $f;
+                }
+            }
+        }
+
+        // COMPOSE_FILE not set, or doesn't contain the file we're looking for
+        $dir = $rootDir;
+        $previousDir = null;
+        do {
+            // Test with the ".yaml" extension if the file doesn't end up with ".yml".
+            if (
+                $this->filesystem->exists($dockerComposeFile = sprintf('%s/%s', $dir, $file)) ||
+                $this->filesystem->exists($dockerComposeFile = substr($dockerComposeFile, 0, -2).'aml')
+            ) {
+                return $dockerComposeFile;
+            }
+
+            $previousDir = $dir;
+            $dir = \dirname($dir);
+        } while ($dir !== $previousDir);
+
+        return null;
+    }
+
     private function parse($level, $indent, $services): string
     {
         $line = '';
diff --git a/tests/Configurator/DockerComposeConfiguratorTest.php b/tests/Configurator/DockerComposeConfiguratorTest.php
@@ -15,6 +15,7 @@
 use Composer\IO\IOInterface;
 use Composer\Package\Package;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Flex\Configurator\DockerComposeConfigurator;
 use Symfony\Flex\Lock;
 use Symfony\Flex\Options;
@@ -103,6 +104,9 @@ class DockerComposeConfiguratorTest extends TestCase
     /** @var Lock|\PHPUnit\Framework\MockObject\MockObject */
     private $lock;
 
+    /** @var Composer|\PHPUnit\Framework\MockObject\MockObject */
+    private $composer;
+
     /** @var DockerComposeConfigurator */
     private $configurator;
 
@@ -121,21 +125,27 @@ protected function setUp(): void
         $package = new Package('dummy/dummy', '1.0.0', '1.0.0');
         $package->setExtra(['symfony' => ['docker' => true]]);
 
-        $composer = $this->getMockBuilder(Composer::class)->getMock();
-        $composer->method('getPackage')->willReturn($package);
+        $this->composer = $this->getMockBuilder(Composer::class)->getMock();
+        $this->composer->method('getPackage')->willReturn($package);
 
         $this->configurator = new DockerComposeConfigurator(
-            $composer,
+            $this->composer,
             $this->getMockBuilder(IOInterface::class)->getMock(),
             new Options(['config-dir' => 'config', 'root-dir' => FLEX_TEST_DIR])
         );
     }
 
     protected function tearDown(): void
     {
-        @unlink(FLEX_TEST_DIR.'/docker-compose.yml');
-        @unlink(FLEX_TEST_DIR.'/docker-compose.override.yml');
-        @unlink(FLEX_TEST_DIR.'/docker-compose.yaml');
+        unset($_SERVER['COMPOSE_FILE']);
+
+        (new Filesystem())->remove([
+            FLEX_TEST_DIR.'/docker-compose.yml',
+            FLEX_TEST_DIR.'/docker-compose.override.yml',
+            FLEX_TEST_DIR.'/docker-compose.yaml',
+            FLEX_TEST_DIR.'/child/docker-compose.override.yaml',
+            FLEX_TEST_DIR.'/child',
+        ]);
     }
 
     public function testConfigure()
@@ -430,4 +440,92 @@ public function testConfigureMultipleFiles()
         $this->assertStringEqualsFile($dockerComposeFile, self::ORIGINAL_CONTENT);
         $this->assertStringEqualsFile($dockerComposeOverrideFile, self::ORIGINAL_CONTENT);
     }
+
+    public function testConfigureEnvVar()
+    {
+        @mkdir(FLEX_TEST_DIR.'/child/');
+        $dockerComposeFile = FLEX_TEST_DIR.'/child/docker-compose.yml';
+        file_put_contents($dockerComposeFile, self::ORIGINAL_CONTENT);
+        $dockerComposeOverrideFile = FLEX_TEST_DIR.'/child/docker-compose.override.yml';
+        file_put_contents($dockerComposeOverrideFile, self::ORIGINAL_CONTENT);
+
+        $sep = '\\' === \DIRECTORY_SEPARATOR ? ';' : ':';
+        $_SERVER['COMPOSE_FILE'] = $dockerComposeFile.$sep.$dockerComposeOverrideFile;
+
+        $this->configurator->configure($this->recipeDb, self::CONFIG_DB_MULTIPLE_FILES, $this->lock);
+
+        foreach ([$dockerComposeFile, $dockerComposeOverrideFile] as $file) {
+            $this->assertStringEqualsFile($file, self::ORIGINAL_CONTENT.<<<'YAML'
+
+###> doctrine/doctrine-bundle ###
+  db:
+    image: mariadb:10.3
+    environment:
+      - MYSQL_DATABASE=symfony
+      # You should definitely change the password in production
+      - MYSQL_PASSWORD=password
+      - MYSQL_RANDOM_ROOT_PASSWORD=true
+      - MYSQL_USER=symfony
+    volumes:
+      - db-data:/var/lib/mysql:rw
+      # You may use a bind-mounted host directory instead, so that it is harder to accidentally remove the volume and lose all your data!
+      # - ./docker/db/data:/var/lib/mysql:rw
+###< doctrine/doctrine-bundle ###
+
+volumes:
+###> doctrine/doctrine-bundle ###
+  db-data: {}
+###< doctrine/doctrine-bundle ###
+
+YAML
+                );
+        }
+
+        $this->configurator->unconfigure($this->recipeDb, self::CONFIG_DB_MULTIPLE_FILES, $this->lock);
+        $this->assertStringEqualsFile($dockerComposeFile, self::ORIGINAL_CONTENT);
+        $this->assertStringEqualsFile($dockerComposeOverrideFile, self::ORIGINAL_CONTENT);
+    }
+
+    public function testConfigureFileInParentDir()
+    {
+        $this->configurator = new DockerComposeConfigurator(
+            $this->composer,
+            $this->getMockBuilder(IOInterface::class)->getMock(),
+            new Options(['config-dir' => 'config', 'root-dir' => FLEX_TEST_DIR.'/child'])
+        );
+
+        @mkdir(FLEX_TEST_DIR.'/child');
+        $dockerComposeFile = FLEX_TEST_DIR.'/docker-compose.yaml';
+        file_put_contents($dockerComposeFile, self::ORIGINAL_CONTENT);
+
+        $this->configurator->configure($this->recipeDb, self::CONFIG_DB, $this->lock);
+
+        $this->assertStringEqualsFile($dockerComposeFile, self::ORIGINAL_CONTENT.<<<'YAML'
+
+###> doctrine/doctrine-bundle ###
+  db:
+    image: mariadb:10.3
+    environment:
+      - MYSQL_DATABASE=symfony
+      # You should definitely change the password in production
+      - MYSQL_PASSWORD=password
+      - MYSQL_RANDOM_ROOT_PASSWORD=true
+      - MYSQL_USER=symfony
+    volumes:
+      - db-data:/var/lib/mysql:rw
+      # You may use a bind-mounted host directory instead, so that it is harder to accidentally remove the volume and lose all your data!
+      # - ./docker/db/data:/var/lib/mysql:rw
+###< doctrine/doctrine-bundle ###
+
+volumes:
+###> doctrine/doctrine-bundle ###
+  db-data: {}
+###< doctrine/doctrine-bundle ###
+
+YAML
+        );
+
+        $this->configurator->unconfigure($this->recipeDb, self::CONFIG_DB, $this->lock);
+        $this->assertEquals(self::ORIGINAL_CONTENT, file_get_contents($dockerComposeFile));
+    }
 }
