vagrant-hosts 2.8.3 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17835dd36d0ddc4a0c5f81f689524b27f631a948
-  data.tar.gz: c00d66d9f43d293eaeaa25f65f32d917fb4140f2
+  metadata.gz: 322a1b0f577132bf7a26d7e6cf30dbbd4b534cae
+  data.tar.gz: 808c7e2296002dcacd7986f3a026fca00e726175
 SHA512:
-  metadata.gz: 17f0584cd999d50b1fc17b26724c25423a79240a69da295af12cf8cc107bf47975b22bc363373d93b16d9ca1bb1fd83b2c5b21f5be4e8f735ec52a8bb121fafd
-  data.tar.gz: bf34838c4b82a6bf5de3dbad2a53b03f02ec65271db839c032e9e879f2959d90349a192c845e0504cfe4fdd3aefc785c8cbfce9a03479912bcc75340c566b1a3
+  metadata.gz: 5bc7ab2fd9c7531111315349d6630bb9fbc913f199b8fe52f3aa6e1e508da0b53156e25e9a86d5ed006cd7bb616e20a9093d5cb28d987a5cb11673d8c8bd09d2
+  data.tar.gz: 160746015fcf52be6d95f6334fbbe35d6ce1ce3ae70bc70ab5e34b9222c64a09e221bed3165b1064991c9392caae7ed084eeae4f17c5c5975eebde6a04c557c7

data/.travis.yml

@@ -20,8 +20,6 @@ env:
 
 matrix:
   include:
-    - rvm: 2.0.0
-      env: TEST_VAGRANT_VERSION=v1.7.4 BUNDLER_VERSION=1.10.5
     - rvm: 2.2.5
       env: TEST_VAGRANT_VERSION=v1.8.7 BUNDLER_VERSION=1.12.5
     - rvm: 2.3.4
@@ -29,6 +27,8 @@ matrix:
     - rvm: 2.4.4
       env: TEST_VAGRANT_VERSION=v2.0.4 BUNDLER_VERSION=1.16.1
     - rvm: 2.4.4
-      env: TEST_VAGRANT_VERSION=v2.1.2 BUNDLER_VERSION=1.16.1
+      env: TEST_VAGRANT_VERSION=v2.1.5 BUNDLER_VERSION=1.16.1
+    - rvm: 2.4.4
+      env: TEST_VAGRANT_VERSION=v2.2.2 BUNDLER_VERSION=1.16.1
     - rvm: 2.4.4
       env: TEST_VAGRANT_VERSION=HEAD BUNDLER_VERSION=1.16.1

data/CHANGELOG

@@ -1,6 +1,25 @@
 CHANGELOG
 =========
 
+2.9.0
+-----
+
+2019-01-03
+
+This is a backwards compatible feature and bugfix release.
+
+### Added
+
+  * New `change_hostname` config setting that controls whether the provisioner
+    will attempt to set the hostname of the VM.
+
+### Fixed
+
+  * Hostnames can now be removed from Windows VMs.
+
+  * Provisioning hostnames on Windows VMs will no longer fail when a large
+    number of names is added.
+
 2.8.2
 -----
 

data/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 require 'rubygems/version'
 
-vagrant_branch = ENV['TEST_VAGRANT_VERSION'] || 'v2.1.2'
+vagrant_branch = ENV['TEST_VAGRANT_VERSION'] || 'v2.2.2'
 vagrant_version = nil
 
 # Wrapping gemspec in the :plugins group causes Vagrant 1.5 and newer to

data/README.markdown

@@ -38,6 +38,9 @@ behaviors of each provisioner instance.
   * `add_localhost_hostnames`
     * Description: A boolean which controls whether the hostname of the machine is added as an alias for `127.0.1.1`
     * Default: `true`
+  * `change_hostname`
+    * Description: A boolean which controls whether the hostname of the machine will be set during provisioning.
+    * Default: `true`
   * `sync_hosts`
     * Description: A boolean which controls whether running the hosts provisioner causes an update on all other running machines.
       This also happens during machine destruction.

data/lib/vagrant-hosts/cap/sync_hosts/base.rb

@@ -1,7 +1,10 @@
-# Provide an abstract base class for syncing hosts entries
-class VagrantHosts::Cap::SyncHosts::Base
+require 'vagrant-hosts/addresses'
 
-  require 'vagrant-hosts/addresses'
+# Abstract guest capability for syncing host resources
+#
+# @abstract
+# @since 2.0.0
+class VagrantHosts::Cap::SyncHosts::Base
   include VagrantHosts::Addresses
 
   def self.sync_hosts(machine, config)
@@ -20,15 +23,37 @@ class VagrantHosts::Cap::SyncHosts::Base
     # FIXME: Write tests for this behavior.
     # TODO: Move this behavior into a config block on the hosts provisioner
     # so that this capability can remain focused on updating /etc/hosts.
-    hostname = @machine.config.vm.hostname || @machine.name.to_s
-    change_host_name(hostname)
+    if @config.change_hostname
+      hostname = @machine.config.vm.hostname || @machine.name.to_s
+      change_host_name(hostname)
+    end
 
-    # call to method not implemented by abstract base class
     update_hosts
   end
 
   private
 
+  # Upload /etc/hosts content to a temporary file on the guest
+  def upload_temphosts(hosts_content, dest_path = '/tmp/vagrant-hosts.txt')
+    temp_file = nil
+
+    temp_file = Tempfile.new('vagrant-hosts')
+    temp_file.binmode # Don't convert line endings.
+
+    temp_file.write(hosts_content)
+    temp_file.flush
+    @machine.communicate.upload(temp_file.path, dest_path)
+  ensure
+    temp_file.close unless temp_file.nil?
+  end
+
+  # Update the hosts file on a machine
+  #
+  # Subclasses should implement this method with OS-specific logic.
+  def update_hosts
+    raise NotImplementedError
+  end
+
   # @param name [String] The new hostname to apply on the guest
   def change_host_name(name)
     case Vagrant::VERSION
@@ -38,5 +63,4 @@ class VagrantHosts::Cap::SyncHosts::Base
       @machine.guest.capability(:change_host_name, name)
     end
   end
-
 end

data/lib/vagrant-hosts/cap/sync_hosts/posix.rb

@@ -1,20 +1,15 @@
-# Provide a base class for syncing hosts entries on POSIX systems.
-
 require 'tempfile'
 
+# Guest capability for syncing /etc/hosts on POSIX systems
+#
+# @since 2.0.0
 class VagrantHosts::Cap::SyncHosts::POSIX < VagrantHosts::Cap::SyncHosts::Base
 
   private
 
-  def upload_tmphosts
-    cache = Tempfile.new('tmp-hosts')
-    cache.write(format_hosts)
-    cache.flush
-    @machine.communicate.upload(cache.path, '/tmp/hosts')
-  end
-
   def update_hosts
-    upload_tmphosts
+    hosts_content = format_hosts
+    upload_temphosts(hosts_content, '/tmp/vagrant-hosts.txt')
 
     # Switch to PTY mode as this provider may execute across multiple machines
     # which may not have requiretty set to false (i.e. because they're still
@@ -24,7 +19,10 @@ class VagrantHosts::Cap::SyncHosts::POSIX < VagrantHosts::Cap::SyncHosts::Base
     old_pty_setting = @machine.config.ssh.pty
     @machine.config.ssh.pty = true
 
-    @machine.communicate.sudo('cat /tmp/hosts > /etc/hosts')
+    # NOTE: cat is used here instead of mv to work around issues with
+    #       Docker filesystem layers not allowing the creation of a
+    #       new file.
+    @machine.communicate.sudo('cat /tmp/vagrant-hosts.txt > /etc/hosts')
   ensure
     @machine.config.ssh.pty = old_pty_setting
   end
@@ -37,5 +35,4 @@ class VagrantHosts::Cap::SyncHosts::POSIX < VagrantHosts::Cap::SyncHosts::Base
       str << "#{address} #{aliases.join(' ')}\n"
     end
   end
-
 end

data/lib/vagrant-hosts/cap/sync_hosts/windows.rb

@@ -1,22 +1,39 @@
-# Provide a base class for syncing hosts entries on Windows systems.
+# Guest capability for updating System32/drivers/etc/hosts on Windows
+#
+# @see https://docs.microsoft.com/en-us/previous-versions//bb727005(v=technet.10)#EDAA
+#   Microsoft docs on hostname resolution.
+# @since 2.0.0
 class VagrantHosts::Cap::SyncHosts::Windows < VagrantHosts::Cap::SyncHosts::Base
 
+  private
+
   def update_hosts
-    host_entries = []
-    all_hosts(@config).each do |(address, aliases)|
-      aliases.each do |name|
-        host_entries << "#{address} #{name}"
-      end
-    end
+    hosts_content = format_hosts
+    temp_file = [get_tempdir, 'vagrant-hosts.txt'].join('/')
+    upload_temphosts(hosts_content, temp_file)
+
+    @machine.communicate.sudo(<<-EOS)
+Copy-Item `
+  -Path "#{temp_file}" `
+  -Destination "${Env:WINDIR}/System32/drivers/etc/hosts"
+EOS
+  end
 
-    script = []
-    script << '$HostsPath = "$env:windir\\System32\\drivers\\etc\\hosts"'
-    script << '$Hosts = gc $HostsPath'
+  # Return the path of the Windows temporary directory
+  def get_tempdir
+    sudo('Write-Host -Object $Env:TEMP')[:stdout].chomp.gsub("\\", '/')
+  end
 
-    host_defs = "'" + host_entries.join('\', \'') + "'"
-    script << "@(#{host_defs}) | % { if (\$Hosts -notcontains \$_) { Add-Content -Path \$HostsPath -Value \$_ }}"
+  def format_hosts
+    all_hosts(@config).inject('') do |str, (address, aliases)|
+      # Unlike UNIXy systems, Windows limits the number of host aliases
+      # that can appear on a line to 9.
+      aliases.each_slice(9) do |slice|
+        str << "#{address} #{slice.join(' ')}\r\n"
+      end
 
-    @machine.communicate.sudo(script.join("; "))
+      str
+    end
   end
 
   # Windows needs a modification of the base method because Windows guest names
@@ -81,4 +98,19 @@ if ($success -eq $True) {exit 0} else {exit 1}
     @machine.communicate.sudo(powershell)
   end
 
+  # FIXME: de-duplicate with the facts implementation.
+  def sudo(cmd)
+    stdout = ''
+    stderr = ''
+
+    retval = @machine.communicate.sudo(cmd) do |type, data|
+      if type == :stderr
+        stderr << data
+      else
+        stdout << data
+      end
+    end
+
+    {:stdout => stdout, :stderr => stderr, :retval => retval}
+  end
 end

data/lib/vagrant-hosts/config.rb

@@ -41,6 +41,15 @@ module VagrantHosts
     #   @since 2.7.0
     attr_accessor :imports
 
+    # @!attribute [rw] change_hostname
+    #   @return [TrueClass, FalseClass] When set to true, running the hosts
+    #   provisioner on this VM will change the hostname of the machine to be
+    #   the hostname configured or the name of the machine.
+    #   Defaults to 'true'.
+    #
+    #   @since 2.9.0
+    attr_accessor :change_hostname
+
     def initialize
       @hosts = []
       @exports = {}
@@ -48,6 +57,7 @@ module VagrantHosts
       @autoconfigure = UNSET_VALUE
       @add_localhost_hostnames = UNSET_VALUE
       @sync_hosts = UNSET_VALUE
+      @change_hostname = UNSET_VALUE
     end
 
     # Register a host for entry
@@ -81,6 +91,7 @@ module VagrantHosts
       end
 
       @sync_hosts = false if @sync_hosts == UNSET_VALUE
+      @change_hostname = true if @change_hostname == UNSET_VALUE
     end
 
     # @param other [VagrantHosts::Config]

data/lib/vagrant-hosts/config_builder/1_x.rb

@@ -19,6 +19,8 @@ module VagrantHosts
       def_model_attribute :exports
       # @!attribute [rw] exports
       def_model_attribute :imports
+      # @!attribute [rw] change_hostname
+      def_model_attribute :change_hostname
 
       # @private
       def configure_exports(config, val)

data/lib/vagrant-hosts/version.rb

@@ -1,3 +1,3 @@
 module VagrantHosts
-  VERSION = '2.8.3'.freeze
+  VERSION = '2.9.0'.freeze
 end

data/vagrant-hosts.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |gem|
   gem.email    = ['adrien@somethingsinistral.net', 'source@sharpsteen.net']
   gem.homepage = 'https://github.com/oscar-stack/vagrant-hosts'
 
-  gem.has_rdoc = true
   gem.license  = 'Apache 2.0'
 
   gem.files        = %x{git ls-files -z}.split("\0")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-hosts
 version: !ruby/object:Gem::Version
-  version: 2.8.3
+  version: 2.9.0
 platform: ruby
 authors:
 - Adrien Thebo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2019-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -39,8 +39,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
-description: |2
-      Manage static DNS entries and configuration for Vagrant guests.
+description: "    Manage static DNS entries and configuration for Vagrant guests.\n"
 email:
 - adrien@somethingsinistral.net
 - source@sharpsteen.net
@@ -105,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Manage static DNS on vagrant guests