Merge pull request #11205 from briancain/DOCKER-BUILDKIT-FIXUP

Enhance docker build method for the Docker provider to include buildkit output

plugins/providers/docker/driver.rb

@@ -15,19 +15,31 @@ module VagrantPlugins
         @executor = Executor::Local.new
       end
 
+      # Returns the id for a new container built from `docker build`. Raises
+      # an exception if the id was unable to be captured from the output
+      #
+      # @return [String] id - ID matched from the docker build output.
       def build(dir, **opts, &block)
-        args   = Array(opts[:extra_args])
-        args   << dir
-        result = execute('docker', 'build', *args, &block)
-        matches = result.scan(/Successfully built (.+)$/i)
-        if matches.empty?
-          # This will cause a stack trace in Vagrant, but it is a bug
-          # if this happens anyways.
-          raise "UNKNOWN OUTPUT: #{result}"
+        args = Array(opts[:extra_args])
+        args << dir
+        opts = {with_stderr: true}
+        result = execute('docker', 'build', *args, opts, &block)
+        matches = result.match(/Successfully built (?<id>.+)$/i)
+        if !matches
+          # Check for the new output format 'writing image sha256...'
+          # In this case, docker builtkit is enabled. Its format is different
+          # from standard docker
+          @logger.warn("Could not determine docker container ID. Scanning for buildkit output instead")
+          matches = result.match(/writing image .+:(?<id>[0-9a-z]+) done/i)
+          if !matches
+            # This will cause a stack trace in Vagrant, but it is a bug
+            # if this happens anyways.
+            raise Errors::BuildError, result: result
+          end
         end
 
-        # Return the last match, and the capture of it
-        matches[-1][0]
+        # Return the matched group `id`
+        matches[:id]
       end
 
       def create(params, **opts, &block)

plugins/providers/docker/errors.rb

@@ -5,6 +5,10 @@ module VagrantPlugins
         error_namespace("docker_provider.errors")
       end
 
+      class BuildError < DockerError
+        error_key(:build_error)
+      end
+
       class CommunicatorNonDocker < DockerError
         error_key(:communicator_non_docker)
       end

plugins/providers/docker/executor/local.rb

@@ -27,7 +27,13 @@ module VagrantPlugins
               stdout: result.stdout
           end
 
-          result.stdout
+          if opts
+            if opts[:with_stderr]
+              return result.stdout + " " + result.stderr
+            else
+              return result.stdout
+            end
+          end
         end
 
         def windows?

templates/locales/providers_docker.yml

@@ -159,6 +159,8 @@ en:
         run exits and doesn't keep running.
 
     errors:
+      build_error: |-
+        Vagrant received unknown output from `docker build` while building a container: %{result}
       compose_lock_timeout: |-
         Vagrant encountered a timeout waiting for the docker compose driver
         to become available. Please try to run your command again. If you

test/unit/plugins/providers/docker/driver_test.rb

@@ -152,6 +152,27 @@ describe VagrantPlugins::DockerProvider::Driver do
 ].to_json }
 
 
+  describe '#build' do
+    let(:result) { "Successfully built 1a2b3c4d" }
+    let(:buildkit_result) { "writing image sha256:1a2b3c4d done" }
+    let(:cid) { "1a2b3c4d" }
+
+    it "builds a container with standard docker" do
+      allow(subject).to receive(:execute).and_return(result)
+
+      container_id = subject.build("/tmp/fakedir")
+
+      expect(container_id).to eq(cid)
+    end
+
+    it "builds a container with buildkit docker" do
+      allow(subject).to receive(:execute).and_return(buildkit_result)
+
+      container_id = subject.build("/tmp/fakedir")
+
+      expect(container_id).to eq(cid)
+    end
+  end
 
   describe '#create' do
     let(:params) { {