vagrant-unbundled 2.2.7.0 → 2.2.16.0

data/lib/vagrant/shared_helpers.rb

@@ -125,6 +125,14 @@ module Vagrant
     Gem::Version.new(Vagrant::VERSION).prerelease?
   end
 
+  # This returns true/false if the Vagrant should allow prerelease
+  # versions when resolving plugin dependency constraints
+  #
+  # @return [Boolean]
+  def self.allow_prerelease_dependencies?
+    !!ENV["VAGRANT_ALLOW_PRERELEASE"]
+  end
+
   # This allows control over dependency resolution when installing
   # plugins into vagrant. When true, dependency libraries that Vagrant
   # core relies upon will be hard constraints.
@@ -186,4 +194,32 @@ module Vagrant
     end
     @_global_logger
   end
+
+  # Add a new block of default CLI options which
+  # should be automatically added to all commands
+  #
+  # @param [Proc] block Proc instance containing OptParser configuration
+  # @return [nil]
+  def self.add_default_cli_options(block)
+    if !block.is_a?(Proc)
+      raise TypeError,
+        "Expecting type `Proc` but received `#{block.class}`"
+    end
+    if block.arity != 1 && block.arity != -1
+      raise ArgumentError,
+        "Proc must accept OptionParser argument"
+    end
+    @_default_cli_options = [] if !@_default_cli_options
+    @_default_cli_options << block
+    nil
+  end
+
+  # Array of default CLI options to automatically
+  # add to commands.
+  #
+  # @return [Array<Proc>] Default optparse options
+  def self.default_cli_options
+    @_default_cli_options = [] if !@_default_cli_options
+    @_default_cli_options.dup
+  end
 end

data/lib/vagrant/ui.rb

@@ -75,6 +75,13 @@ module Vagrant
       def machine(type, *data)
         @logger.info("Machine: #{type} #{data.inspect}")
       end
+
+      # Yields self (UI)
+      # Provides a way for selectively displaying or not displaying
+      # updating content like download progress.
+      def rewriting
+        yield self
+      end
     end
 
     # This is a UI implementation that does nothing.
@@ -220,7 +227,7 @@ module Vagrant
 
       # This method handles actually outputting a message of a given type
       # to the console.
-      def say(type, message, **opts)
+      def say(type, message, opts={})
         defaults = { new_line: true, prefix: true }
         opts     = defaults.merge(@opts).merge(opts)
 
@@ -252,6 +259,31 @@ module Vagrant
       end
     end
 
+
+    class NonInteractive < Basic
+      def initialize
+        super
+      end
+
+      def rewriting
+        # no-op
+      end
+
+      def report_progress(progress, total, show_parts=true)
+        # no-op
+      end
+
+      def clear_line
+        @logger.warn("Using `clear line` in a non interactive ui")
+        say(:info, "\n", opts)
+      end
+
+      def ask(*args)
+        # Non interactive can't ask for input
+        raise Errors::UIExpectsTTY
+      end
+    end
+
     # Prefixed wraps an existing UI and adds a prefix to it.
     class Prefixed < Interface
       # The prefix for `output` messages.
@@ -290,7 +322,9 @@ module Vagrant
 
       [:clear_line, :report_progress].each do |method|
         # By default do nothing, these aren't formatted
-        define_method(method) { |*args| @ui.send(method, *args) }
+        define_method(method) do |*args|
+          @ui.send(method, *args)
+        end
       end
 
       # For machine-readable output, set the prefix in the
@@ -344,6 +378,13 @@ module Vagrant
           "#{prefix}#{target} #{line}"
         end.join("\n")
       end
+
+      def rewriting
+        @ui.rewriting do |ui|
+          yield ui
+        end
+      end
+
     end
 
     # This is a UI implementation that outputs color for various types

data/lib/vagrant/util.rb

@@ -7,9 +7,11 @@ module Vagrant
     autoload :CredentialScrubber,        'vagrant/util/credential_scrubber'
     autoload :DeepMerge,                 'vagrant/util/deep_merge'
     autoload :Env,                       'vagrant/util/env'
+    autoload :Experimental,              'vagrant/util/experimental'
     autoload :HashWithIndifferentAccess, 'vagrant/util/hash_with_indifferent_access'
     autoload :GuestInspection,           'vagrant/util/guest_inspection'
     autoload :LoggingFormatter,          'vagrant/util/logging_formatter'
+    autoload :Numeric,                   'vagrant/util/numeric'
     autoload :Platform,                  'vagrant/util/platform'
     autoload :Retryable,                 'vagrant/util/retryable'
     autoload :SafeExec,                  'vagrant/util/safe_exec'

data/lib/vagrant/util/ansi_escape_code_remover.rb

@@ -19,7 +19,7 @@ module Vagrant
                     /\e\[\?[1-9][hl]/,     # Matches \e[?2h
                     /\e\[20[hl]/,          # Matches \e[20l]
                     /\e[DME78H]/,          # Matches \eD, \eH, etc.
-                    /\e\[[0-2]?[JK]/,      # Matches \e[0J, \e[K, etc.
+                    /\e\[[0-3]?[JK]/,      # Matches \e[0J, \e[K, etc.
                     ]
 
         # Take each matcher and replace it with emptiness.

data/lib/vagrant/util/caps.rb

@@ -0,0 +1,48 @@
+require "tempfile"
+require "fileutils"
+require "pathname"
+require "vagrant/util/directory"
+require "vagrant/util/subprocess"
+
+module Vagrant
+  module Util
+    module Caps
+      module BuildISO
+
+        # Builds an iso given a compatible iso_command
+        #
+        # @param [List<String>] command to build iso
+        # @param [Pathname] input directory for iso build
+        # @param [Pathname] output file for iso build
+        def build_iso(iso_command, source_directory, file_destination)
+          FileUtils.mkdir_p(file_destination.dirname)
+          if !file_destination.exist? || Vagrant::Util::Directory.directory_changed?(source_directory, file_destination.mtime)
+            result = Vagrant::Util::Subprocess.execute(*iso_command)
+            if result.exit_code != 0
+              raise Vagrant::Errors::ISOBuildFailed, cmd: iso_command.join(" "), stdout: result.stdout, stderr: result.stderr
+            end
+          end
+        end
+
+        protected
+
+        def ensure_output_iso(file_destination)
+          if file_destination.nil?
+            tmpfile = Tempfile.new(["vagrant", ".iso"])
+            file_destination = Pathname.new(tmpfile.path)
+            tmpfile.close
+            tmpfile.unlink
+          else
+            file_destination = Pathname.new(file_destination.to_s)
+            # If the file destination path is a folder, target the output to a randomly named
+            # file in that dir
+            if file_destination.extname != ".iso"
+              file_destination = file_destination.join("#{SecureRandom.hex(3)}_vagrant.iso")
+            end
+          end
+          file_destination
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/util/credential_scrubber.rb

@@ -32,7 +32,7 @@ module Vagrant
       def self.desensitize(string)
         string = string.to_s.dup
         sensitive_strings.each do |remove|
-          string.gsub!(remove, REPLACEMENT_TEXT)
+          string.gsub!(/(\W|^)#{Regexp.escape(remove)}(\W|$)/, "\\1#{REPLACEMENT_TEXT}\\2")
         end
         string
       end

data/lib/vagrant/util/curl_helper.rb

@@ -4,6 +4,7 @@ module Vagrant
 
       # Hosts that do not require notification on redirect
       SILENCED_HOSTS = [
+        "vagrantcloud-files-production.s3-accelerate.amazonaws.com".freeze,
         "vagrantcloud.com".freeze,
         "vagrantup.com".freeze
       ].freeze
@@ -21,6 +22,7 @@ module Vagrant
           # Accumulate progress_data
           progress_data << data
 
+          redirect_notify = false
           while true
             # If the download has been redirected and we are no longer downloading
             # from the original host, notify the user that the target host has
@@ -30,15 +32,16 @@ module Vagrant
               if !location.empty?
                 location_uri = URI.parse(location)
 
-                unless location_uri.host.nil?
-                  redirect_notify = false
+                if !location_uri.host.nil? && !redirect_notify
                   logger.info("download redirected to #{location}")
                   source_uri = URI.parse(source)
                   source_host = source_uri.host.to_s.split(".", 2).last
                   location_host = location_uri.host.to_s.split(".", 2).last
-                  if !redirect_notify && location_host != source_host && !SILENCED_HOSTS.include?(location_host)
-                    ui.clear_line
-                    ui.detail "Download redirected to host: #{location_uri.host}"
+                  if location_host != source_host && !SILENCED_HOSTS.include?(location_host) && !SILENCED_HOSTS.include?(location_uri.host.to_s)
+                    ui.rewriting do |_ui|
+                      _ui.clear_line
+                      _ui.detail "Download redirected to host: #{location_uri.host}"
+                    end
                   end
                   redirect_notify = true
                 end
@@ -82,10 +85,11 @@ module Vagrant
             # 9 - Time spent
             # 10 - Time left
             # 11 - Current speed
-
             output = "Progress: #{columns[0]}% (Rate: #{columns[11]}/s, Estimated time remaining: #{columns[10]})"
-            ui.clear_line
-            ui.detail(output, new_line: false)
+            ui.rewriting do |ui|
+              ui.clear_line
+              ui.detail(output, new_line: false)
+            end
           end
         end
 

data/lib/vagrant/util/directory.rb

@@ -0,0 +1,19 @@
+require 'pathname'
+
+module Vagrant
+  module Util
+    class Directory
+      # Check if directory has any new updates
+      #
+      # @param [Pathname, String] Path to directory
+      # @param [Time] time to compare to eg. has any file in dir_path
+      #               changed since this time
+      # @return [Boolean]
+      def self.directory_changed?(dir_path, threshold_time)
+        Dir.glob(Pathname.new(dir_path).join("**", "*")).any? do |path|
+          Pathname.new(path).mtime > threshold_time
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/util/downloader.rb

@@ -1,3 +1,4 @@
+require "cgi"
 require "uri"
 
 require "log4r"
@@ -28,8 +29,9 @@ module Vagrant
         "vagrantup.com".freeze
       ].freeze
 
-      attr_reader :source
+      attr_accessor :source
       attr_reader :destination
+      attr_accessor :headers
 
       def initialize(source, destination, options=nil)
         options     ||= {}
@@ -41,8 +43,8 @@ module Vagrant
         begin
           url = URI.parse(@source)
           if url.scheme && url.scheme.start_with?("http") && url.user
-            auth = "#{URI.unescape(url.user)}"
-            auth += ":#{URI.unescape(url.password)}" if url.password
+            auth = "#{CGI.unescape(url.user)}"
+            auth += ":#{CGI.unescape(url.password)}" if url.password
             url.user = nil
             url.password = nil
             options[:auth] ||= auth
@@ -57,7 +59,7 @@ module Vagrant
         @ca_cert     = options[:ca_cert]
         @ca_path     = options[:ca_path]
         @continue    = options[:continue]
-        @headers     = options[:headers]
+        @headers     = Array(options[:headers])
         @insecure    = options[:insecure]
         @ui          = options[:ui]
         @client_cert = options[:client_cert]
@@ -69,6 +71,7 @@ module Vagrant
           :sha384 => options[:sha384],
           :sha512 => options[:sha512]
         }.compact
+        @extra_download_options = options[:box_extra_download_options] || []
       end
 
       # This executes the actual download, downloading the source file
@@ -183,6 +186,7 @@ module Vagrant
 
       def execute_curl(options, subprocess_options, &data_proc)
         options = options.dup
+        options.unshift("-q")
         options << subprocess_options
 
         # Create the callback that is called if we are interrupted
@@ -230,7 +234,6 @@ module Vagrant
       def options
         # Build the list of parameters to execute with cURL
         options = [
-          "-q",
           "--fail",
           "--location",
           "--max-redirs", "10", "--verbose",
@@ -245,6 +248,8 @@ module Vagrant
         options << "-u" << @auth if @auth
         options << "--location-trusted" if @location_trusted
 
+        options.concat(@extra_download_options)
+
         if @headers
           Array(@headers).each do |header|
             options << "-H" << header

data/lib/vagrant/util/guest_hosts.rb

@@ -0,0 +1,68 @@
+module Vagrant
+  module Util
+    # Helper methods for modfiying guests /etc/hosts file
+    module GuestHosts
+
+      module Unix
+        DEAFAULT_LOOPBACK_CHECK_LIMIT = 5.freeze
+
+        # Add hostname to a loopback address on /etc/hosts if not already there
+        # Will insert name at the first free address of the form 127.0.X.1, up to
+        # the loop_bound
+        #
+        # @param [Communicator] 
+        # @param [String] full hostanme
+        # @param [int] (option) defines the upper bound for searching for an available loopback address
+        def add_hostname_to_loopback_interface(comm, name, loop_bound=DEAFAULT_LOOPBACK_CHECK_LIMIT)
+          basename = name.split(".", 2)[0]
+          comm.sudo <<-EOH.gsub(/^ {14}/, '')
+          grep -w '#{name}' /etc/hosts || {
+            for i in #{[*1..loop_bound].join(' ')}; do
+              grep -w "127.0.${i}.1" /etc/hosts || {
+                echo "127.0.${i}.1 #{name} #{basename}" >> /etc/hosts
+                break
+              }
+            done
+          }
+          EOH
+        end
+      end
+
+      # Linux specific inspection helpers
+      module Linux
+        include Unix
+        # Remove any line in /etc/hosts that contains hostname,
+        # then add hostname with associated ip 
+        #
+        # @param [Communicator] 
+        # @param [String] full hostanme
+        # @param [String] target ip
+        def replace_host(comm, name, ip)
+          basename = name.split(".", 2)[0]
+          comm.sudo <<-EOH.gsub(/^ {14}/, '')
+          sed -i '/#{name}/d' /etc/hosts
+          sed -i'' '1i '#{ip}'\\t#{name}\\t#{basename}' /etc/hosts
+          EOH
+        end
+      end
+
+      # BSD specific inspection helpers
+      module BSD
+        include Unix
+        # Remove any line in /etc/hosts that contains hostname,
+        # then add hostname with associated ip 
+        #
+        # @param [Communicator] 
+        # @param [String] full hostanme
+        # @param [String] target ip
+        def replace_host(comm, name, ip)
+          basename = name.split(".", 2)[0]
+          comm.sudo <<-EOH.gsub(/^ {14}/, '')
+          sed -i.bak '/#{name}/d' /etc/hosts
+          sed -i.bak '1i\\\n#{ip}\t#{name}\t#{basename}\n' /etc/hosts
+          EOH
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/util/guest_inspection.rb

@@ -12,7 +12,7 @@ module Vagrant
         #
         # @return [Boolean]
         def systemd?(comm)
-          comm.test("ps -o comm= 1 | grep systemd")
+          comm.test("ps -o comm= 1 | grep systemd", sudo: true)
         end
 
         # systemd-networkd.service is in use
@@ -73,6 +73,14 @@ module Vagrant
           comm.test("command -v netplan")
         end
 
+        # is networkd isntalled
+        #
+        # @param [Vagrant::Plugin::V2::Communicator] comm Guest communicator
+        # @return [Boolean]
+        def networkd?(comm)
+          comm.test("command -v networkd")
+        end
+
         ## nmcli helpers
 
         # nmcli is installed

data/lib/vagrant/util/install_cli_autocomplete.rb

@@ -0,0 +1,118 @@
+module Vagrant
+  module Util
+    # Generic installation of content to shell config file
+    class InstallShellConfig
+
+      PERPEND_STRING = "# >>>> Vagrant command completion (start)".freeze
+      APPEND_STRING = "# <<<<  Vagrant command completion (end)".freeze
+
+      attr_accessor :prepend_string
+      attr_accessor :string_insert
+      attr_accessor :append_string
+      attr_accessor :config_paths
+
+      def initialize(string_insert, config_paths)
+        @prepend_string = PERPEND_STRING
+        @string_insert = string_insert
+        @append_string = APPEND_STRING
+        @config_paths = config_paths
+        @logger = Log4r::Logger.new("vagrant::util::install_shell_config")
+      end
+
+      # Searches a users home dir for a shell config file based on a
+      # given home dir and a configured set of config paths. If there
+      # are multiple config paths, it will return the first match.
+      #
+      # @param [string] path to users home dir
+      # @return [string] path to shell config file if exists
+      def shell_installed(home)
+        @logger.info("Searching for config in home #{home}")
+        @config_paths.each do |path|
+          config_file = File.join(home, path)
+          if File.exists?(config_file)
+            @logger.info("Found config file #{config_file}")
+            return config_file
+          end
+        end
+        return nil
+      end
+
+      # Searches a given file for the existence of a set prepend string.
+      # This can be used to find if vagrant has inserted some strings to a file
+      #
+      # @param [string] path to a file (config file)
+      # @return [boolean] true if the prepend string is found in the file
+      def is_installed(path)
+        File.foreach(path) do |line|
+          if line.include?(@prepend_string)
+            @logger.info("Found completion already installed in #{path}")
+            return true
+          end
+        end
+        return false
+      end
+
+      # Given a path to the users home dir, will install some given strings
+      # marked by a prepend and append string
+      #
+      # @param [string] path to users home dir
+      # @return [string] path to shell config file that was modified if exists
+      def install(home)
+        path = shell_installed(home)
+        if path && !is_installed(path)
+          File.open(path, "a") do |f|
+            f.write("\n")
+            f.write(@prepend_string)
+            f.write("\n")
+            f.write(@string_insert)
+            f.write("\n")
+            f.write(@append_string)
+            f.write("\n")
+          end
+        end
+        return path
+      end
+    end
+
+    # Install autocomplete script to zsh config located as .zshrc
+    class InstallZSHShellConfig < InstallShellConfig
+      def initialize
+        string_insert = """fpath=(#{File.join(Vagrant.source_root, "contrib", "zsh")} $fpath)\ncompinit""".freeze
+        config_paths = [".zshrc".freeze].freeze
+        super(string_insert, config_paths)
+      end
+    end
+
+    # Install autocomplete script to bash config located as .bashrc or .bash_profile
+    class InstallBashShellConfig < InstallShellConfig
+      def initialize
+        string_insert = ". #{File.join(Vagrant.source_root, 'contrib', 'bash', 'completion.sh')}".freeze
+        config_paths = [".bashrc".freeze, ".bash_profile".freeze].freeze
+        super(string_insert, config_paths)
+      end
+    end
+
+    # Install autocomplete script for supported shells
+    class InstallCLIAutocomplete
+      SUPPORTED_SHELLS = {
+        "zsh" => Vagrant::Util::InstallZSHShellConfig.new(),
+        "bash" => Vagrant::Util::InstallBashShellConfig.new()
+      }
+
+      def self.install(shells=[])
+        shells = SUPPORTED_SHELLS.keys() if shells.empty?
+        home = Dir.home
+        written_paths = []
+        
+        shells.map do |shell|
+          if SUPPORTED_SHELLS[shell]
+            written_paths.push(SUPPORTED_SHELLS[shell].install(home))
+          else
+            raise ArgumentError, "shell must be in #{SUPPORTED_SHELLS.keys()}"
+          end
+        end.compact
+        return written_paths
+      end
+    end
+  end
+end