vagrant-hostmanager 1.2.3 → 1.3.0

data/README.md

@@ -72,6 +72,41 @@ Use:
 config.vm.provision :hostmanager
 ```
 
+Custom IP resolver
+------------------
+
+You can customize way, how host manager resolves IP address
+for each machine. This might be handy in case of aws provider,
+where host name is stored in ssh_info hash of each machine.
+This causes generation of invalid /etc/hosts file.
+
+Custom IP resolver gives you oportunity to calculate IP address
+for each machine by yourself. For example:
+
+```ruby
+config.hostmanager.ip_resolver = proc do |vm|
+  if hostname = (vm.ssh_info && vm.ssh_info[:host])
+    `host #{hostname}`.split("\n").last[/(\d+\.\d+\.\d+\.\d+)/, 1]
+  end
+end
+```
+
+Windows support
+---------------
+
+Hostmanager will detect Windows guests and hosts and use the appropriate 
+path for the ```hosts``` file: ```%WINDIR%\System32\drivers\etc\hosts```
+
+By default on a Windows host, the ```hosts``` file is not writable without
+elevated privileges. If hostmanager detects that it cannot overwrite the file,
+it will attempt to do so with elevated privileges, causing the 
+[UAC](http://en.wikipedia.org/wiki/User_Account_Control) prompt to appear.
+
+### UAC limitations
+
+Due to limitations caused by UAC, cancelling out of the UAC prompt will not cause any
+visible errors, however the ```hosts``` file will not be updated.
+
 Contribute
 ----------
 Contributions are welcome.

data/lib/vagrant-hostmanager/command.rb

@@ -13,7 +13,7 @@ module VagrantPlugins
 
           o.on('--provider provider', String,
             'Update machines with the specific provider.') do |provider|
-            options[:provider] = provider
+            options[:provider] = provider.to_sym
           end
         end
 

data/lib/vagrant-hostmanager/config.rb

@@ -6,6 +6,7 @@ module VagrantPlugins
       attr_accessor :ignore_private_ip
       attr_accessor :aliases
       attr_accessor :include_offline
+      attr_accessor :ip_resolver
 
       alias_method :enabled?, :enabled
       alias_method :include_offline?, :include_offline
@@ -17,6 +18,9 @@ module VagrantPlugins
         @ignore_private_ip = UNSET_VALUE
         @include_offline = UNSET_VALUE
         @aliases = []
+        @aliases = Array.new
+        @include_offline = false
+        @ip_resolver = nil
       end
 
       def finalize!
@@ -35,7 +39,8 @@ module VagrantPlugins
         errors << validate_bool('hostmanager.include_offline', @include_offline)
         errors.compact!
 
-        if !machine.config.hostmanager.aliases.kind_of?(Array) and
+        # check if aliases option is an Array
+        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',
@@ -43,7 +48,16 @@ module VagrantPlugins
           })
         end
 
-        { 'HostManager configuration' => errors }
+        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

data/lib/vagrant-hostmanager/hosts_file.rb

@@ -8,13 +8,13 @@ module VagrantPlugins
 
         if (machine.communicate.test("uname -s | grep SunOS"))
           realhostfile = '/etc/inet/hosts'
-		  move_cmd = 'mv'
+          move_cmd = 'mv'
         elsif (machine.communicate.test("test -d $Env:SystemRoot"))
-		  realhostfile = 'C:\Windows\System32\Drivers\etc\hosts'
-		  move_cmd = 'mv -force'
+          realhostfile = "#{ENV['WINDIR']}\\System32\\drivers\\etc\\hosts"
+          move_cmd = 'mv -force'
         else 
           realhostfile = '/etc/hosts'
-		  move_cmd = 'mv'
+          move_cmd = 'mv'
         end
         # download and modify file with Vagrant-managed entries
         file = @global_env.tmp_path.join("hosts.#{machine.name}")
@@ -34,19 +34,23 @@ module VagrantPlugins
       def update_host
         # copy and modify hosts file on host with Vagrant-managed entries
         file = @global_env.tmp_path.join('hosts.local')
-        # add a "if windows..."
-        hosts_location = '/etc/hosts'
-        copy_cmd = 'sudo cp'
-        # handles the windows hosts file...
-        if ENV['OS'] == 'Windows_NT'
+
+        if WindowsSupport.windows?
+          # lazily include windows Module
+          class << self
+            include WindowsSupport unless include? WindowsSupport
+          end
+
           hosts_location = "#{ENV['WINDIR']}\\System32\\drivers\\etc\\hosts"
-          copy_cmd = 'cp'
+          copy_proc = Proc.new { windows_copy_file(file, hosts_location) }
+        else
+          hosts_location = '/etc/hosts'
+          copy_proc = Proc.new { `sudo cp #{file} #{hosts_location}` }
         end
+
         FileUtils.cp(hosts_location, file)
         update_file(file)
-
-        # copy modified file using sudo for permission
-        `#{copy_cmd} #{file} #{hosts_location}`
+        copy_proc.call
       end
 
       private
@@ -54,6 +58,7 @@ module VagrantPlugins
       def update_file(file)
         # build array of host file entries from Vagrant configuration
         entries = []
+        destroyed_entries = []
         ids = []
         get_machines.each do |name, p|
           if @provider == p
@@ -62,8 +67,12 @@ module VagrantPlugins
             id = machine.id
             ip = get_ip_address(machine)
             aliases = machine.config.hostmanager.aliases.join(' ').chomp
-            entries <<  "#{ip}\t#{host} #{aliases}\t# VAGRANT ID: #{id}\n"
-            ids << id unless ids.include?(id)
+            if id.nil?
+              destroyed_entries << "#{ip}\t#{host} #{aliases}"
+            else
+              entries <<  "#{ip}\t#{host} #{aliases}\t# VAGRANT ID: #{id}\n"
+              ids << id unless ids.include?(id)
+            end
           end
         end
 
@@ -71,6 +80,8 @@ module VagrantPlugins
         begin
           # copy each line not managed by Vagrant
           File.open(file).each_line do |line|
+            # Eliminate lines for machines that have been destroyed
+            next if destroyed_entries.any? { |entry| line =~ /^#{entry}\t# VAGRANT ID: .*/ }
             tmp_file << line unless ids.any? { |id| line =~ /# VAGRANT ID: #{id}/ }
           end
 
@@ -84,12 +95,17 @@ module VagrantPlugins
       end
 
       def get_ip_address(machine)
-        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
-            next if ip
+        custom_ip_resolver = machine.config.hostmanager.ip_resolver
+        if custom_ip_resolver
+          custom_ip_resolver.call(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
+              next if ip
+            end
           end
         end
         ip || (machine.ssh_info ? machine.ssh_info[:host] : nil)
@@ -110,6 +126,45 @@ module VagrantPlugins
           @global_env.active_machines
         end
       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

data/lib/vagrant-hostmanager/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module HostManager
-    VERSION = '1.2.3'
+    VERSION = '1.3.0'
   end
 end

data/locales/en.yml

@@ -7,3 +7,4 @@ en:
     config:
       not_a_bool: "A value for %{config_key} can only be true or false, not type '%{value}'"
       not_an_array_or_string: "A value for %{config_key} must be an Array or String, not type '%{is_class}'"
+      not_a_proc: "A value for %{config_key} must be a Proc, not type '%{is_class}'"

data/vagrant-hostmanager.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.email         = ['shawn@dahlen.me']
   gem.description   = %q{A Vagrant plugin that manages the /etc/hosts file within a multi-machine environment}
   gem.summary       = gem.description
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-hostmanager
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2013-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,7 +73,8 @@ files:
 - test/test.sh
 - vagrant-hostmanager.gemspec
 homepage: 
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: