vagrant 1.5.0 → 2.4.4

data/plugins/providers/docker/driver.rb

@@ -0,0 +1,416 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "json"
+require "log4r"
+
+require_relative "./driver/compose"
+
+module VagrantPlugins
+  module DockerProvider
+    class Driver
+      # The executor is responsible for actually executing Docker commands.
+      # This is set by the provider, but defaults to local execution.
+      attr_accessor :executor
+
+      def initialize
+        @logger   = Log4r::Logger.new("vagrant::docker::driver")
+        @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
+        opts = {with_stderr: true}
+        result = execute('docker', 'build', *args, **opts, &block)
+        # Check for the new output format 'writing image sha256...'
+        # In this case, docker buildkit is enabled. Its format is different
+        # from standard docker
+        matches = result.scan(/writing image .+:([^\s]+)/i).last
+        if !matches
+          # Check for outout of docker using containerd backend store
+          matches = result.scan(/exporting manifest list .+:([^\s]+)/i).last
+        end
+        if !matches
+          if podman?
+            # Check for podman format when it is emulating docker CLI.
+            # Podman outputs the full hash of the container on
+            # the last line after a successful build.
+            match = result.split.select { |str| str.match?(/^[0-9a-z]{64}/) }.last
+            return match[0..7] unless match.nil?
+          else
+            matches = result.scan(/Successfully built (.+)$/i).last
+          end
+
+          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 matched group `id`
+        matches[0].strip
+      end
+
+      # Check if podman emulating docker CLI is enabled.
+      #
+      # @return [Bool]
+      def podman?
+        execute('docker', '--version').include?("podman")
+      end
+
+      def create(params, **opts, &block)
+        image   = params.fetch(:image)
+        links   = params.fetch(:links)
+        ports   = Array(params[:ports])
+        volumes = Array(params[:volumes])
+        name    = params.fetch(:name)
+        cmd     = Array(params.fetch(:cmd))
+        env     = params.fetch(:env)
+        expose  = Array(params[:expose])
+
+        run_cmd = %W(docker run --name #{name})
+        run_cmd << "-d" if params[:detach]
+        run_cmd += env.map { |k,v| ['-e', "#{k}=#{v}"] }
+        run_cmd += expose.map { |p| ['--expose', "#{p}"] }
+        run_cmd += links.map { |k, v| ['--link', "#{k}:#{v}"] }
+        run_cmd += ports.map { |p| ['-p', p.to_s] }
+        run_cmd += volumes.map { |v|
+          v = v.to_s
+          if v.include?(":") && @executor.windows?
+            if v.index(":") != v.rindex(":")
+              # If we have 2 colons, the host path is an absolute Windows URL
+              # and we need to remove the colon from it
+              host, _, guest = v.rpartition(":")
+              host = "//" + host[0].downcase + host[2..-1]
+              v = [host, guest].join(":")
+            else
+              host, guest = v.split(":", 2)
+              host = Vagrant::Util::Platform.windows_path(host)
+              # NOTE: Docker does not support UNC style paths (which also
+              # means that there's no long path support). Hopefully this
+              # will be fixed someday and the gsub below can be removed.
+              host.gsub!(/^[^A-Za-z]+/, "")
+              v = [host, guest].join(":")
+            end
+          end
+
+          ['-v', v.to_s]
+        }
+        run_cmd += %W(--privileged) if params[:privileged]
+        run_cmd += %W(-h #{params[:hostname]}) if params[:hostname]
+        run_cmd << "-t" if params[:pty]
+        run_cmd << "--rm=true" if params[:rm]
+        run_cmd += params[:extra_args] if params[:extra_args]
+        run_cmd += [image, cmd]
+
+        execute(*run_cmd.flatten, **opts, &block).chomp.lines.last
+      end
+
+      def state(cid)
+        case
+        when running?(cid)
+          :running
+        when created?(cid)
+          :stopped
+        else
+          :not_created
+        end
+      end
+
+      def created?(cid)
+        result = execute('docker', 'ps', '-a', '-q', '--no-trunc').to_s
+        result =~ /^#{Regexp.escape cid}$/
+      end
+
+      def image?(id)
+        result = execute('docker', 'images', '-q', '--no-trunc').to_s
+        result =~ /\b#{Regexp.escape(id)}\b/
+      end
+
+      # Reads all current docker containers and determines what ports
+      # are currently registered to be forwarded
+      # {2222=>#<Set: {"127.0.0.1"}>, 8080=>#<Set: {"*"}>, 9090=>#<Set: {"*"}>}
+      #
+      # Note: This is this format because of what the builtin action for resolving colliding
+      # port forwards expects.
+      #
+      # @return [Hash[Set]] used_ports - {forward_port: #<Set: {"host ip address"}>}
+      def read_used_ports
+        used_ports = Hash.new{|hash,key| hash[key] = Set.new}
+
+        all_containers.each do |c|
+          container_info = inspect_container(c)
+
+          active = container_info["State"]["Running"]
+          next unless active # Ignore used ports on inactive containers
+
+          if container_info["HostConfig"]["PortBindings"]
+            port_bindings = container_info["HostConfig"]["PortBindings"]
+            next if port_bindings.empty? # Nothing defined, but not nil either
+
+            port_bindings.each do |guest_port,host_mapping|
+              host_mapping.each do |h|
+                if h["HostIp"] == ""
+                  hostip = "*"
+                else
+                  hostip = h["HostIp"]
+                end
+                hostport = h["HostPort"]
+                used_ports[hostport].add(hostip)
+              end
+            end
+          end
+        end
+
+        used_ports
+      end
+
+      def running?(cid)
+        result = execute('docker', 'ps', '-q', '--no-trunc')
+        result =~ /^#{Regexp.escape cid}$/m
+      end
+
+      def privileged?(cid)
+        inspect_container(cid)['HostConfig']['Privileged']
+      end
+
+      def login(email, username, password, server)
+        cmd = %W(docker login)
+        cmd += ["-e", email] if email != ""
+        cmd += ["-u", username] if username != ""
+        cmd += ["-p", password] if password != ""
+        cmd << server if server && server != ""
+
+        execute(*cmd.flatten)
+      end
+
+      def logout(server)
+        cmd = %W(docker logout)
+        cmd << server if server && server != ""
+        execute(*cmd.flatten)
+      end
+
+      def pull(image)
+        execute('docker', 'pull', image)
+      end
+
+      def start(cid)
+        if !running?(cid)
+          execute('docker', 'start', cid)
+          # This resets the cached information we have around, allowing `vagrant reload`s
+          # to work properly
+          @data = nil
+        end
+      end
+
+      def stop(cid, timeout)
+        if running?(cid)
+          execute('docker', 'stop', '-t', timeout.to_s, cid)
+        end
+      end
+
+      def rm(cid)
+        if created?(cid)
+          execute('docker', 'rm', '-f', '-v', cid)
+        end
+      end
+
+      def rmi(id)
+        execute('docker', 'rmi', id)
+        return true
+      rescue => e
+        return false if e.to_s.include?("is using it") or
+                        e.to_s.include?("is being used") or
+                        e.to_s.include?("is in use")
+        raise if !e.to_s.include?("No such image")
+      end
+
+      # Inspect the provided container
+      #
+      # @param [String] cid ID or name of container
+      # @return [Hash]
+      def inspect_container(cid)
+        JSON.parse(execute('docker', 'inspect', cid)).first
+      end
+
+      # @return [Array<String>] list of all container IDs
+      def all_containers
+        execute('docker', 'ps', '-a', '-q', '--no-trunc').to_s.split
+      end
+
+      # Attempts to first use the docker-cli tool to inspect the default bridge subnet
+      # Falls back to using /sbin/ip if that fails
+      #
+      # @return [String] IP address of the docker bridge
+      def docker_bridge_ip
+        bridge = inspect_network("bridge")&.first
+        if bridge 
+          bridge_ip = bridge.dig("IPAM", "Config", 0, "Gateway")
+        end
+        return bridge_ip if bridge_ip
+        @logger.debug("Failed to get bridge ip from docker, falling back to `ip`")
+        docker_bridge_ip_fallback
+      end
+
+      def docker_bridge_ip_fallback
+        output = execute('ip', '-4', 'addr', 'show', 'scope', 'global', 'docker0')
+        if output =~ /^\s+inet ([0-9.]+)\/[0-9]+\s+/
+          return $1.to_s
+        else
+          # TODO: Raise an user friendly message
+          raise 'Unable to fetch docker bridge IP!'
+        end
+      end
+
+      # @param [String] network - name of network to connect conatiner to
+      # @param [String] cid - container id
+      # @param [Array]  opts - An array of flags used for listing networks
+      def connect_network(network, cid, opts=nil)
+        command = ['docker', 'network', 'connect', network, cid].push(*opts)
+        output = execute(*command)
+        output
+      end
+
+      # @param [String] network - name of network to create
+      # @param [Array]  opts - An array of flags used for listing networks
+      def create_network(network, opts=nil)
+        command = ['docker', 'network', 'create', network].push(*opts)
+        output = execute(*command)
+        output
+      end
+
+      # @param [String] network - name of network to disconnect container from
+      # @param [String] cid - container id
+      def disconnect_network(network, cid)
+        command = ['docker', 'network', 'disconnect', network, cid, "--force"]
+        output = execute(*command)
+        output
+      end
+
+      # @param [Array]  networks - list of networks to inspect
+      # @param [Array]  opts - An array of flags used for listing networks
+      def inspect_network(network, opts=nil)
+        command = ['docker', 'network', 'inspect'] + Array(network)
+        command = command.push(*opts)
+        output = execute(*command)
+        begin
+          JSON.load(output)
+        rescue JSON::ParserError
+          @logger.warn("Failed to parse network inspection of network: #{network}")
+          @logger.debug("Failed network output content: `#{output.inspect}`")
+          nil
+        end
+      end
+
+      # @param [String] opts - Flags used for listing networks
+      def list_network(*opts)
+        command = ['docker', 'network', 'ls', *opts]
+        output = execute(*command)
+        output
+      end
+
+      # Will delete _all_ defined but unused networks in the docker engine. Even
+      # networks not created by Vagrant.
+      #
+      # @param [Array] opts - An array of flags used for listing networks
+      def prune_network(opts=nil)
+        command = ['docker', 'network', 'prune', '--force'].push(*opts)
+        output = execute(*command)
+        output
+      end
+
+      # Delete network(s)
+      #
+      # @param [String] network - name of network to remove
+      def rm_network(*network)
+        command = ['docker', 'network', 'rm', *network]
+        output = execute(*command)
+        output
+      end
+
+      # @param [Array] opts - An array of flags used for listing networks
+      def execute(*cmd, **opts, &block)
+        @executor.execute(*cmd, **opts, &block)
+      end
+
+      # ######################
+      # Docker network helpers
+      # ######################
+
+      # Determines if a given network has been defined through vagrant with a given
+      # subnet string
+      #
+      # @param [String] subnet_string - Subnet to look for
+      # @return [String] network name - Name of network with requested subnet.`nil` if not found
+      def network_defined?(subnet_string)
+        all_networks = list_network_names
+
+        network_info = inspect_network(all_networks)
+        network_info.each do |network|
+          config = Array(network.dig("IPAM", "Config"))
+          next if config.empty? || !config.first.is_a?(Hash)
+          if (config.first["Subnet"] == subnet_string)
+            @logger.debug("Found existing network #{network["Name"]} already configured with #{subnet_string}")
+            return network["Name"]
+          end
+        end
+        return nil
+      end
+
+      # Locate network which contains given address
+      #
+      # @param [String] address IP address
+      # @return [String] network name
+      def network_containing_address(address)
+        names = list_network_names
+        networks = inspect_network(names)
+        return if !networks
+        networks.each do |net|
+          next if !net["IPAM"]
+          config = net["IPAM"]["Config"]
+          next if !config || config.size < 1
+          config.each do |opts|
+            subnet = IPAddr.new(opts["Subnet"])
+            if subnet.include?(address)
+              return net["Name"]
+            end
+          end
+        end
+        nil
+      end
+
+      # Looks to see if a docker network has already been defined
+      # with the given name
+      #
+      # @param [String] network_name - name of network to look for
+      # @return [Bool]
+      def existing_named_network?(network_name)
+        result = list_network_names
+        result.any?{|net_name| net_name == network_name}
+      end
+
+      # @return [Array<String>] list of all docker networks
+      def list_network_names
+        list_network("--format={{.Name}}").split("\n").map(&:strip)
+      end
+
+      # Returns true or false if network is in use or not.
+      # Nil if Vagrant fails to receive proper JSON from `docker network inspect`
+      #
+      # @param [String] network - name of network to look for
+      # @return [Bool,nil]
+      def network_used?(network)
+        result = inspect_network(network)
+        return nil if !result
+        return result.first["Containers"].size > 0
+      end
+
+    end
+  end
+end

data/plugins/providers/docker/errors.rb

@@ -0,0 +1,108 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+module VagrantPlugins
+  module DockerProvider
+    module Errors
+      class DockerError < Vagrant::Errors::VagrantError
+        error_namespace("docker_provider.errors")
+      end
+
+      class BuildError < DockerError
+        error_key(:build_error)
+      end
+
+      class CommunicatorNonDocker < DockerError
+        error_key(:communicator_non_docker)
+      end
+
+      class ComposeLockTimeoutError < DockerError
+        error_key(:compose_lock_timeout)
+      end
+
+      class ContainerNotRunningError < DockerError
+        error_key(:not_running)
+      end
+
+      class ContainerNotCreatedError < DockerError
+        error_key(:not_created)
+      end
+
+      class DockerComposeNotInstalledError < DockerError
+        error_key(:docker_compose_not_installed)
+      end
+
+      class ExecuteError < DockerError
+        error_key(:execute_error)
+      end
+
+      class ExecCommandRequired < DockerError
+        error_key(:exec_command_required)
+      end
+
+      class HostVMCommunicatorNotReady < DockerError
+        error_key(:host_vm_communicator_not_ready)
+      end
+
+      class ImageNotConfiguredError < DockerError
+        error_key(:docker_provider_image_not_configured)
+      end
+
+      class NfsWithoutPrivilegedError < DockerError
+        error_key(:docker_provider_nfs_without_privileged)
+      end
+
+      class NetworkAddressInvalid < DockerError
+        error_key(:network_address_invalid)
+      end
+
+      class NetworkIPAddressRequired < DockerError
+        error_key(:network_address_required)
+      end
+
+      class NetworkSubnetInvalid < DockerError
+        error_key(:network_subnet_invalid)
+      end
+
+      class NetworkInvalidOption < DockerError
+        error_key(:network_invalid_option)
+      end
+
+      class NetworkNameMissing < DockerError
+        error_key(:network_name_missing)
+      end
+
+      class NetworkNameUndefined < DockerError
+        error_key(:network_name_undefined)
+      end
+
+      class NetworkNoInterfaces < DockerError
+        error_key(:network_no_interfaces)
+      end
+
+      class PackageNotSupported < DockerError
+        error_key(:package_not_supported)
+      end
+
+      class StateNotRunning < DockerError
+        error_key(:state_not_running)
+      end
+
+      class StateStopped < DockerError
+        error_key(:state_stopped)
+      end
+
+      class SuspendNotSupported < DockerError
+        error_key(:suspend_not_supported)
+      end
+
+      class SyncedFolderNonDocker < DockerError
+        error_key(:synced_folder_non_docker)
+      end
+
+      class VagrantfileNotFound < DockerError
+        error_key(:vagrantfile_not_found)
+      end
+    end
+  end
+end

data/plugins/providers/docker/executor/local.rb

@@ -0,0 +1,48 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "vagrant/util/busy"
+require "vagrant/util/subprocess"
+
+module VagrantPlugins
+  module DockerProvider
+    module Executor
+      # The Local executor executes a Docker client that is running
+      # locally.
+      class Local
+        def execute(*cmd, **opts, &block)
+          # Append in the options for subprocess
+          cmd << { notify: [:stdout, :stderr] }
+
+          interrupted  = false
+          int_callback = ->{ interrupted = true }
+          result = ::Vagrant::Util::Busy.busy(int_callback) do
+            ::Vagrant::Util::Subprocess.execute(*cmd, &block)
+          end
+
+          result.stderr.gsub!("\r\n", "\n")
+          result.stdout.gsub!("\r\n", "\n")
+
+          if result.exit_code != 0 && !interrupted
+            raise Errors::ExecuteError,
+              command: cmd.inspect,
+              stderr: result.stderr,
+              stdout: result.stdout
+          end
+
+          if opts
+            if opts[:with_stderr]
+              return result.stdout + " " + result.stderr
+            else
+              return result.stdout
+            end
+          end
+        end
+
+        def windows?
+          ::Vagrant::Util::Platform.windows? || ::Vagrant::Util::Platform.wsl?
+        end
+      end
+    end
+  end
+end

data/plugins/providers/docker/executor/vagrant.rb

@@ -0,0 +1,88 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "vagrant/util/shell_quote"
+
+module VagrantPlugins
+  module DockerProvider
+    module Executor
+      # The Vagrant executor runs Docker over SSH against the given
+      # Vagrant-managed machine.
+      class Vagrant
+        def initialize(host_machine)
+          @host_machine = host_machine
+        end
+
+        def execute(*cmd, **opts, &block)
+          quote = '"'
+          cmd   = cmd.map do |a|
+            "#{quote}#{::Vagrant::Util::ShellQuote.escape(a, quote)}#{quote}"
+          end.join(" ")
+
+          # If we want stdin, we just run in a full subprocess
+          return ssh_run(cmd) if opts[:stdin]
+
+          # Add a start fence so we know when to start reading output.
+          # We have to do this because boot2docker outputs a login shell
+          # boot2docker version that we get otherwise and messes up output.
+          start_fence = "========== VAGRANT DOCKER BEGIN =========="
+          ssh_cmd     = "echo -n \"#{start_fence}\"; #{cmd}"
+
+          stderr = ""
+          stdout = ""
+          fenced = false
+          comm   = @host_machine.communicate
+          code   = comm.execute(ssh_cmd, error_check: false) do |type, data|
+            next if ![:stdout, :stderr].include?(type)
+            stderr << data if type == :stderr
+            stdout << data if type == :stdout
+
+            if !fenced
+              index = stdout.index(start_fence)
+              if index
+                fenced = true
+
+                index += start_fence.length
+                stdout = stdout[index..-1]
+                stdout.chomp!
+
+                # We're now fenced, send all the data through
+                if block
+                  block.call(:stdout, stdout) if stdout != ""
+                  block.call(:stderr, stderr) if stderr != ""
+                end
+              end
+            else
+              # If we're already fenced, just send the data through.
+              block.call(type, data) if block && fenced
+            end
+          end
+
+          if code != 0
+            raise Errors::ExecuteError,
+              command: cmd,
+              stderr: stderr.chomp,
+              stdout: stdout.chomp
+          end
+
+          stdout.chomp
+        end
+
+        def windows?
+          false
+        end
+
+        protected
+
+        def ssh_run(cmd)
+          @host_machine.action(
+            :ssh_run,
+            ssh_run_command: cmd,
+          )
+
+          ""
+        end
+      end
+    end
+  end
+end

data/plugins/providers/docker/hostmachine/Vagrantfile

@@ -0,0 +1,3 @@
+Vagrant.configure("2") do |config|
+  config.vm.box = "hashicorp/boot2docker"
+end