vagrant-hostmanager-ext 1.8.7.rc1

data/lib/vagrant-hostmanager/config.rb

@@ -0,0 +1,95 @@
+module VagrantPlugins
+  module HostManager
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :enabled
+      attr_accessor :manage_host
+      attr_accessor :manage_guest
+      attr_accessor :ignore_private_ip
+      attr_accessor :aliases
+      attr_accessor :include_offline
+      attr_accessor :ip_resolver
+      attr_accessor :extra_hosts
+
+      alias_method :enabled?, :enabled
+      alias_method :include_offline?, :include_offline
+      alias_method :manage_host?, :manage_host
+      alias_method :manage_guest?, :manage_guest
+
+      def initialize
+        @enabled            = UNSET_VALUE
+        @manage_host        = UNSET_VALUE
+        @manage_guest       = UNSET_VALUE
+        @ignore_private_ip  = UNSET_VALUE
+        @include_offline    = UNSET_VALUE
+        @aliases            = UNSET_VALUE
+        @ip_resolver        = UNSET_VALUE
+        @extra_hosts        = UNSET_VALUE
+      end
+
+      def finalize!
+        @enabled            = false if @enabled == UNSET_VALUE
+        @manage_host        = false if @manage_host == UNSET_VALUE
+        @manage_guest       = true if @manage_guest == UNSET_VALUE
+        @ignore_private_ip  = false if @ignore_private_ip == UNSET_VALUE
+        @include_offline    = false if @include_offline == UNSET_VALUE
+        @aliases            = [] if @aliases == UNSET_VALUE
+        @ip_resolver        = nil if @ip_resolver == UNSET_VALUE
+        @extra_hosts        = [] if @extra_hosts == UNSET_VALUE
+
+        @aliases = [ @aliases ].flatten
+      end
+
+      def validate(machine)
+        errors = []
+
+        errors << validate_bool('hostmanager.enabled', @enabled)
+        errors << validate_bool('hostmanager.manage_host', @manage_host)
+        errors << validate_bool('hostmanager.manage_guest', @manage_guest)
+        errors << validate_bool('hostmanager.ignore_private_ip', @ignore_private_ip)
+        errors << validate_bool('hostmanager.include_offline', @include_offline)
+        errors.compact!
+
+        # check if aliases option is an Array or String
+        if  !machine.config.hostmanager.aliases.kind_of?(Array) &&
+            !machine.config.hostmanager.aliases.kind_of?(String)
+          errors << I18n.t('vagrant_hostmanager.config.not_an_array_or_string', {
+            :config_key => 'hostmanager.aliases',
+            :is_class   => aliases.class.to_s,
+          })
+        end
+
+        if  !machine.config.hostmanager.extra_hosts.kind_of?(Array)
+          errors << I18n.t('vagrant_hostmanager.config.not_an_array', {
+            :config_key => 'hostmanager.extra_hosts',
+            :is_class   => extra_hosts.class.to_s,
+          })
+        end
+
+        if !machine.config.hostmanager.ip_resolver.nil? &&
+           !machine.config.hostmanager.ip_resolver.kind_of?(Proc)
+          errors << I18n.t('vagrant_hostmanager.config.not_a_proc', {
+            :config_key => 'hostmanager.ip_resolver',
+            :is_class   => ip_resolver.class.to_s,
+          })
+        end
+
+        errors.compact!
+        { "HostManager configuration" => errors }
+      end
+
+      private
+
+      def validate_bool(key, value)
+        if ![TrueClass, FalseClass].include?(value.class) &&
+           value != UNSET_VALUE
+          I18n.t('vagrant_hostmanager.config.not_a_bool', {
+            :config_key => key,
+            :value      => value.class.to_s
+          })
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager/errors.rb

@@ -0,0 +1,6 @@
+module VagrantPlugins
+  module HostManager
+    module Errors
+    end
+  end
+end

data/lib/vagrant-hostmanager/hosts_file/updater.rb

@@ -0,0 +1,238 @@
+require 'tempfile'
+
+module VagrantPlugins
+  module HostManager
+    module HostsFile
+
+      class Updater
+
+        def initialize(global_env, provider)
+          @global_env = global_env
+          @config = Util.get_config(@global_env)
+          @provider = provider
+          @logger = Log4r::Logger.new('vagrant::hostmanager::updater')
+          @logger.debug("init updater")
+        end
+
+        def update_guest(machine)
+          return unless machine.communicate.ready?
+
+          if (machine.communicate.test("uname -s | grep SunOS"))
+            realhostfile = "/etc/inet/hosts"
+            line_endings = "lf"
+          elsif (machine.communicate.test("test -d $Env:SystemRoot"))
+            windir = ""
+            machine.communicate.execute("echo %SYSTEMROOT%", {:shell => :cmd}) do |type, contents|
+              windir << contents.gsub("\r\n", '') if type == :stdout
+            end
+            realhostfile = "#{windir}\\System32\\drivers\\etc\\hosts"
+            line_endings = "crlf"
+          else
+            realhostfile = "/etc/hosts"
+            line_endings = "lf"
+          end
+
+          # download and modify file with Vagrant-managed entries
+          file = @global_env.tmp_path.join("hosts.#{machine.name}")
+          machine.communicate.download(realhostfile, file)
+
+          @logger.debug("file is: #{file.to_s}")
+          @logger.debug("class of file is: #{file.class}")
+
+          if update_file(file, machine, false, line_endings)
+            # upload modified file and remove temporary file
+            machine.communicate.upload(file.to_s, "/tmp/hosts.#{machine.name}")
+            if windir
+              machine.communicate.sudo("mv -force /tmp/hosts.#{machine.name} #{realhostfile}")
+            else
+              machine.communicate.sudo("cat /tmp/hosts.#{machine.name} > #{realhostfile} && rm /tmp/hosts.#{machine.name}")
+            end
+          end
+
+        end
+
+        def update_host
+          # copy and modify hosts file on host with Vagrant-managed entries
+          file = @global_env.tmp_path.join('hosts.local')
+
+          if WindowsSupport.windows?
+            # lazily include windows Module
+            class << self
+              include WindowsSupport unless include? WindowsSupport
+            end
+            hosts_location = "#{ENV['WINDIR']}\\System32\\drivers\\etc\\hosts"
+            copy_proc = Proc.new { windows_copy_file(file, hosts_location) }
+            line_endings = "crlf"
+          else
+            hosts_location = '/etc/hosts'
+            copy_proc = Proc.new { `[ -w #{hosts_location} ] && cat #{file} > #{hosts_location} || sudo cp #{file} #{hosts_location}` }
+            line_endings = "lf"
+          end
+
+          FileUtils.cp(hosts_location, file)
+
+          if update_file(file, nil, true, line_endings)
+            copy_proc.call
+          end
+        end
+
+        private
+
+        def update_file(file, resolving_machine = nil, include_id = true, line_endings)
+          file = Pathname.new(file)
+          old_file_content = file.read
+          new_file_content = update_content(old_file_content, resolving_machine, include_id, line_endings)
+          file.open('wb') { |io| io.write(new_file_content) }
+          old_file_content != new_file_content
+        end
+
+        def update_content(file_content, resolving_machine, include_id, line_endings)
+          id = include_id ? " id: #{read_or_create_id}" : ""
+          header = "## vagrant-hostmanager-start#{id}\n"
+          footer = "## vagrant-hostmanager-end\n"
+          body = get_machines
+            .map { |machine| get_hosts_file_entry(machine, resolving_machine) }
+            .join
+          unless body.empty? #only when there is at least one active machine
+              extra_hosts = @config.hostmanager.extra_hosts
+              case depth(extra_hosts)
+              #allow single defs: config.hostmanager.extra_hosts = ['172.28.128.100', ['db.dev']]
+              when 1
+                  body << extra_hosts
+                      .map { |ip, aliases| "#{ip}\t#{aliases}"}.join(" ") + "\n\n"
+              #and multiple ones, config.hostmanager.extra_hosts = [['172.28.128.100', ['db.dev']], ['0.0.0.0', ['db.io', 'db.dev']] ]
+              when 2
+                  body << extra_hosts
+                      .map { |ip, aliases| aliases.map{|a| "#{ip}\t#{a}"}.join("\n") + "\n\n" }
+                      .join
+              end
+          end
+          get_new_content(header, footer, body, file_content, line_endings)
+        end
+
+        def depth(array)
+            return 0 unless array.is_a?(Array)
+            return 1 + depth(array[0])
+        end
+
+        def get_hosts_file_entry(machine, resolving_machine)
+          ip = get_ip_address(machine, resolving_machine)
+          host = machine.config.vm.hostname || machine.name
+          aliases = machine.config.hostmanager.aliases
+          if ip != nil
+            "#{ip}\t#{host}\n" + aliases.map{|a| "#{ip}\t#{a}"}.join("\n") + "\n"
+          end
+        end
+
+        def get_ip_address(machine, resolving_machine)
+          custom_ip_resolver = machine.config.hostmanager.ip_resolver
+          if custom_ip_resolver
+            custom_ip_resolver.call(machine, resolving_machine)
+          else
+            ip = nil
+            if machine.config.hostmanager.ignore_private_ip != true
+              machine.config.vm.networks.each do |network|
+                key, options = network[0], network[1]
+                ip = options[:ip] if key == :private_network
+                break if ip
+              end
+            end
+            ip || (machine.ssh_info ? machine.ssh_info[:host] : nil)
+          end
+        end
+
+        def get_machines
+          if @config.hostmanager.include_offline?
+            machines = @global_env.machine_names
+          else
+            machines = @global_env.active_machines
+              .select { |name, provider| provider == @provider }
+              .collect { |name, provider| name }
+          end
+          # Collect only machines that exist for the current provider
+          machines.collect do |name|
+                begin
+                  machine = @global_env.machine(name, @provider)
+                rescue Vagrant::Errors::MachineNotFound
+                  # ignore
+                end
+                machine
+              end
+            .reject(&:nil?)
+        end
+
+        def get_new_content(header, footer, body, old_content, line_endings)
+          if body.empty?
+            block = "\n"
+          else
+            block = "\n\n" + header + body + footer + "\n"
+          end
+          # Pattern for finding existing block
+          header_pattern = Regexp.quote(header)
+          footer_pattern = Regexp.quote(footer)
+          pattern = Regexp.new("\n*#{header_pattern}.*?#{footer_pattern}\n*", Regexp::MULTILINE)
+          # Replace existing block or append
+          content = old_content.match(pattern) ? old_content.sub(pattern, block) : old_content.rstrip + block
+          if line_endings == "crlf"
+            content.encode(content.encoding, :universal_encoding => true).encode(content.encoding, :crlf_newline => true)
+          elsif line_endings == "lf"
+            content.encode(content.encoding, :universal_encoding => true)
+          else
+            content.encode(content.encoding, :universal_encoding => true)
+          end
+        end
+
+        def read_or_create_id
+          file = Pathname.new("#{@global_env.local_data_path}/hostmanager/id")
+          if (file.file?)
+            id = file.read.strip
+          else
+            id = SecureRandom.uuid
+            file.dirname.mkpath
+            file.open('w') { |io| io.write(id) }
+          end
+          id
+        end
+
+        ## Windows support for copying files, requesting elevated privileges if necessary
+        module WindowsSupport
+          require 'rbconfig'
+
+          def self.windows?
+            RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+          end
+
+          require 'win32ole' if windows?
+
+          def windows_copy_file(source, dest)
+            begin
+              # First, try Ruby copy
+              FileUtils.cp(source, dest)
+            rescue Errno::EACCES
+              # Access denied, try with elevated privileges
+              windows_copy_file_elevated(source, dest)
+            end
+          end
+
+          private
+
+          def windows_copy_file_elevated(source, dest)
+            # copy command only supports backslashes as separators
+            source, dest = [source, dest].map { |s| s.to_s.gsub(/\//, '\\') }
+
+            # run 'cmd /C copy ...' with elevated privilege, minimized
+            copy_cmd = "copy \"#{source}\" \"#{dest}\""
+            WIN32OLE.new('Shell.Application').ShellExecute('cmd', "/C #{copy_cmd}", nil, 'runas', 7)
+
+            # Unfortunately, ShellExecute does not give us a status code,
+            # and it is non-blocking so we can't reliably compare the file contents
+            # to see if they were copied.
+            #
+            # If the user rejects the UAC prompt, vagrant will silently continue
+            # without updating the hostsfile.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager/plugin.rb

@@ -0,0 +1,44 @@
+require 'vagrant-hostmanager/action'
+
+module VagrantPlugins
+  module HostManager
+    class Plugin < Vagrant.plugin('2')
+      name 'HostManager'
+      description <<-DESC
+        This plugin manages the /etc/hosts file for the host and guest machines.
+        An entry is created for each running machine using the hostname attribute.
+
+        You can also use the hostmanager provisioner to update the hosts file.
+      DESC
+
+      config(:hostmanager) do
+        require_relative 'config'
+        Config
+      end
+
+      action_hook(:hostmanager, :machine_action_up) do |hook|
+        hook.after(Vagrant::Action::Builtin::Provision, Action.update_all)
+      end
+
+      action_hook(:hostmanager, :machine_action_destroy) do |hook|
+        hook.prepend(Action.update_all)
+      end
+
+      provisioner(:hostmanager) do
+        require_relative 'provisioner'
+        Provisioner
+      end
+
+      # Work-around for vagrant >= 1.5
+      # It breaks without a provisioner config, so we provide a dummy one
+      config(:hostmanager, :provisioner) do
+        ::Vagrant::Config::V2::DummyConfig.new
+      end
+
+      command(:hostmanager) do
+        require_relative 'command'
+        Command
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager/provisioner.rb

@@ -0,0 +1,24 @@
+require 'vagrant-hostmanager/hosts_file/updater'
+
+module VagrantPlugins
+  module HostManager
+    class Provisioner < Vagrant.plugin('2', :provisioner)
+
+      def initialize(machine, config)
+        super(machine, config)
+        global_env = machine.env
+        @config = Util.get_config(global_env)
+        @updater = HostsFile::Updater.new(global_env, machine.provider_name)
+      end
+
+      def provision
+        if @config.hostmanager.manage_guest?
+          @updater.update_guest(@machine)
+        end
+        if @config.hostmanager.manage_host?
+          @updater.update_host
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager/util.rb

@@ -0,0 +1,14 @@
+module VagrantPlugins
+  module HostManager
+    module Util
+      def self.get_config(env)
+        # config_global has been removed from v1.5
+        if Gem::Version.new(::Vagrant::VERSION) >= Gem::Version.new('1.5')
+          env.vagrantfile.config
+        else
+          env.config_global
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module HostManager
+    VERSION = '1.8.7.rc1'
+  end
+end

data/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  vagrant_hostmanager:
+    action:
+      update_guests: "[vagrant-hostmanager:guests] Updating hosts file on active guest virtual machines..."
+      update_guest: "[vagrant-hostmanager:guest] Updating hosts file on the virtual machine %{name}..."
+      update_host: "[vagrant-hostmanager:host] Updating hosts file on your workstation (password may be required)..."
+    config:
+      not_a_bool: "[vagrant-hostmanager:config:error] A value for %{config_key} can only be true or false, not type '%{value}'"
+      not_an_array: "[vagrant-hostmanager:config:error] A value for %{config_key} must be an Array, not type '%{is_class}'"
+      not_an_array_or_string: "[vagrant-hostmanager:config:error] A value for %{config_key} must be an Array or String, not type '%{is_class}'"
+      not_a_proc: "[vagrant-hostmanager:config:error] A value for %{config_key} must be a Proc, not type '%{is_class}'"