Merge pull request #161 from damiantw/docker-build-arg

Support Docker --build-arg option

Author: nunomaduro

src/BuildProcess/BuildContainerImage.php

@@ -8,7 +8,30 @@
 
 class BuildContainerImage
 {
-    use ParticipatesInBuildProcess;
+    use ParticipatesInBuildProcess {
+        ParticipatesInBuildProcess::__construct as baseConstructor;
+    }
+
+    /**
+     * The Docker build arguments.
+     *
+     * @var array
+     */
+    protected $buildArgs;
+
+    /**
+     * Create a new project builder.
+     *
+     * @param  string|null  $environment
+     * @param  array  $buildArgs
+     * @return void
+     */
+    public function __construct($environment = null, $buildArgs = [])
+    {
+        $this->baseConstructor($environment);
+
+        $this->buildArgs = $buildArgs;
+    }
 
     /**
      * Execute the build process step.
@@ -23,7 +46,7 @@ public function __invoke()
 
         Helpers::step('<options=bold>Building Container Image</>');
 
-        Docker::build($this->appPath, Manifest::name(), $this->environment);
+        Docker::build($this->appPath, Manifest::name(), $this->environment, $this->buildArgs);
     }
 
     /**

src/Commands/BuildCommand.php

@@ -43,6 +43,7 @@ protected function configure()
             ->setName('build')
             ->addArgument('environment', InputArgument::OPTIONAL, 'The environment name', 'staging')
             ->addOption('asset-url', null, InputOption::VALUE_OPTIONAL, 'The asset base URL')
+            ->addOption('build-arg', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Docker build argument')
             ->setDescription('Build the project archive');
     }
 
@@ -85,7 +86,7 @@ public function handle()
             new ExtractVendorToSeparateDirectory($this->argument('environment')),
             new CompressApplication($this->argument('environment')),
             new CompressVendor($this->argument('environment')),
-            new BuildContainerImage($this->argument('environment')),
+            new BuildContainerImage($this->argument('environment'), $this->option('build-arg')),
         ])->each->__invoke();
 
         $time = (new DateTime())->diff($startedAt)->format('%im%Ss');

src/Commands/DeployCommand.php

@@ -33,6 +33,7 @@ protected function configure()
             ->addOption('message', null, InputOption::VALUE_OPTIONAL, 'The message for the commit that is being deployed')
             ->addOption('without-waiting', null, InputOption::VALUE_NONE, 'Deploy without waiting for progress')
             ->addOption('fresh-assets', null, InputOption::VALUE_NONE, 'Upload a fresh copy of all assets')
+            ->addOption('build-arg', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Docker build argument')
             ->setDescription('Deploy an environment');
     }
 
@@ -119,6 +120,7 @@ protected function buildProject(array $project)
             'environment' => $this->argument('environment'),
             '--asset-url' => $this->assetDomain($project).'/'.$uuid,
             '--manifest' => Path::manifest(),
+            '--build-arg' => $this->option('build-arg'),
         ]);
 
         return $this->uploadArtifact(

src/Docker.php

@@ -2,6 +2,7 @@
 
 namespace Laravel\VaporCli;
 
+use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use Symfony\Component\Process\Process;
 
@@ -15,19 +16,43 @@ class Docker
      * @param  string  $environment
      * @return void
      */
-    public static function build($path, $project, $environment)
+    public static function build($path, $project, $environment, $cliBuildArgs)
     {
         Process::fromShellCommandline(
-            sprintf('docker build --pull --file=%s.Dockerfile --tag=%s .',
-                $environment,
-                Str::slug($project).':'.$environment
-            ),
+            static::buildCommand($project, $environment, $cliBuildArgs, Manifest::dockerBuildArgs($environment)),
             $path
         )->setTimeout(null)->mustRun(function ($type, $line) {
             Helpers::write($line);
         });
     }
 
+    /**
+     * Create the Docker build command string.
+     *
+     * @param  string  $project
+     * @param  string  $environment
+     * @param  array  $cliBuildArgs
+     * @param  array  $manifestBuildArgs
+     * @return string
+     */
+    public static function buildCommand($project, $environment, $cliBuildArgs, $manifestBuildArgs)
+    {
+        return sprintf('docker build --pull --file=%s.Dockerfile --tag=%s %s.',
+            $environment,
+            Str::slug($project).':'.$environment,
+            Collection::make($manifestBuildArgs)
+                ->merge(Collection::make($cliBuildArgs)
+                    ->mapWithKeys(function ($value) {
+                        [$key, $value] = explode('=', $value, 2);
+
+                        return [$key => $value];
+                    })
+                )->map(function ($value, $key) {
+                    return '--build-arg='.escapeshellarg("{$key}={$value}").' ';
+                })->implode('')
+        );
+    }
+
     /**
      * Publish a docker image.
      *

src/Manifest.php

@@ -55,6 +55,17 @@ public static function buildCommands($environment)
         return static::current()['environments'][$environment]['build'] ?? [];
     }
 
+    /**
+     * Get the Docker build arguments.
+     *
+     * @param  string  $environment
+     * @return array
+     */
+    public static function dockerBuildArgs($environment)
+    {
+        return static::current()['environments'][$environment]['docker-build-args'] ?? [];
+    }
+
     /**
      * Determine if the environment uses a database proxy.
      *

tests/DockerTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Laravel\VaporCli\Tests;
+
+use Laravel\VaporCli\Docker;
+use PHPUnit\Framework\TestCase;
+
+class DockerTest extends TestCase
+{
+    public function test_build_command_no_build_args()
+    {
+        $command = Docker::buildCommand('my-project', 'production', [], []);
+        $expectedCommand = 'docker build --pull --file=production.Dockerfile --tag=my-project:production .';
+        $this->assertEquals($expectedCommand, $command);
+    }
+
+    public function test_build_command_cli_build_args()
+    {
+        $cliBuildArgs = ['FOO=BAR', 'FIZZ=BUZZ'];
+        $command = Docker::buildCommand('my-project', 'production', $cliBuildArgs, []);
+        $expectedCommand = 'docker build --pull --file=production.Dockerfile --tag=my-project:production '.
+            "--build-arg='FOO=BAR' --build-arg='FIZZ=BUZZ' .";
+        $this->assertEquals($expectedCommand, $command);
+    }
+
+    public function test_build_command_manifest_build_args()
+    {
+        $manifestBuildArgs = ['FOO' => 'BAR', 'FIZZ' => 'BUZZ'];
+        $command = Docker::buildCommand('my-project', 'production', [], $manifestBuildArgs);
+        $expectedCommand = 'docker build --pull --file=production.Dockerfile --tag=my-project:production '.
+            "--build-arg='FOO=BAR' --build-arg='FIZZ=BUZZ' .";
+        $this->assertEquals($expectedCommand, $command);
+    }
+
+    public function test_build_command_cli_and_manifest_build_args()
+    {
+        $cliBuildArgs = ['BAR=FOO', 'FIZZ=BAZZ'];
+        $manifestBuildArgs = ['FOO' => 'BAR', 'FIZZ' => 'BUZZ'];
+        $command = Docker::buildCommand('my-project', 'production', $cliBuildArgs, $manifestBuildArgs);
+        $expectedCommand = 'docker build --pull --file=production.Dockerfile --tag=my-project:production '.
+            "--build-arg='FOO=BAR' --build-arg='FIZZ=BAZZ' --build-arg='BAR=FOO' .";
+        $this->assertEquals($expectedCommand, $command);
+    }
+}