vagrant-hosts 1.1.1 → 1.1.2

data/CHANGELOG

@@ -1,6 +1,20 @@
 CHANGELOG
 =========
 
+1.1.2
+-----
+
+2013-08-07
+
+This is a backwards compatible bugfix release.
+
+  * GH-6 provisioner `autoconfigure` option works with explicit hosts
+  * GH-7 all host aliases are respected
+  * Autoconfigured entries should ensure private_networks have an IP address
+  * Remove hardcoded dependency on virtualbox vm provider
+
+Thanks to Tom Linkin for his help on this release.
+
 1.1.1
 -----
 

data/lib/vagrant-hosts.rb

@@ -1,7 +1,6 @@
-# Declare top level vagrant hosts module.
 module VagrantHosts
-  REQUIRED_VAGRANT_VERSION = '1.1.0'
+  require 'vagrant-hosts/version'
+  require 'vagrant-hosts/plugin'
 end
 
-require 'vagrant-hosts/version'
-require 'vagrant-hosts/plugin'
+I18n.load_path << File.expand_path('../templates/locales/en.yml', File.dirname(__FILE__))

data/lib/vagrant-hosts/config.rb

@@ -1,62 +1,66 @@
 require 'vagrant'
 
 module VagrantHosts
-class Config < Vagrant.plugin('2', :config)
+  class Config < Vagrant.plugin('2', :config)
 
-  # @!attribute hosts
-  #   @return [Array<Array<String, Array<String>>>] A list of IP addresses and their aliases
-  attr_reader :hosts
+    # @!attribute hosts
+    #   @return [Array<Array<String, Array<String>>>] A list of IP addresses and their aliases
+    attr_reader :hosts
 
-  # @!attribute autoconfigure
-  #   @return [TrueClass, FalseClass] If hosts should be generated from the
-  #                                   other vagrant machines
-  attr_accessor :autoconfigure
+    # @!attribute autoconfigure
+    #   @return [TrueClass, FalseClass] If hosts should be generated from the
+    #                                   other vagrant machines
+    attr_accessor :autoconfigure
 
-  def initialize
-    @hosts = []
-    @autoconfigure = UNSET_VALUE
-  end
-
-  # Register a host for entry
-  #
-  # @param [String] address The IP address for aliases
-  # @param [Array] aliases An array of hostnames to assign to the IP address
-  def add_host(address, aliases)
-    @hosts << [address, aliases]
-  end
+    def initialize
+      @hosts = []
+      @autoconfigure = UNSET_VALUE
+    end
 
-  # All IPv6 multicast addresses
-  def add_ipv6_multicast
-    add_host '::1',     ['ip6-localhost', 'ip6-loopback']
-    add_host 'fe00::0', ['ip6-localnet']
-    add_host 'ff00::0', ['ip6-mcastprefix']
-    add_host 'ff02::1', ['ip6-allnodes']
-    add_host 'ff02::2', ['ip6-allrouters']
-  end
+    # Register a host for entry
+    #
+    # @param [String] address The IP address for aliases
+    # @param [Array] aliases An array of hostnames to assign to the IP address
+    def add_host(address, aliases)
+      @hosts << [address, aliases]
+    end
 
-  def finalize!
-    if @autoconfigure == UNSET_VALUE or @hosts.empty?
-      @autoconfigure = true
+    # All IPv6 multicast addresses
+    def add_ipv6_multicast
+      add_host '::1',     ['ip6-localhost', 'ip6-loopback']
+      add_host 'fe00::0', ['ip6-localnet']
+      add_host 'ff00::0', ['ip6-mcastprefix']
+      add_host 'ff02::1', ['ip6-allnodes']
+      add_host 'ff02::2', ['ip6-allrouters']
     end
-  end
 
-  # @param other [VagrantHosts::Config]
-  # @return [VagrantHosts::Config] The merged results
-  def merge(other)
-    super.tap do |result|
-      result.hosts += other.hosts
+    def finalize!
+      if @autoconfigure == UNSET_VALUE
+       if  @hosts.empty?
+          @autoconfigure = true
+        else
+          @autoconfigure = false
+        end
+      end
     end
-  end
 
-  def validate(machine)
-    errors = []
-    @hosts.each do |(address, aliases)|
-      unless aliases.is_a? Array
-        errors << "#{address} should have an array of aliases, got #{aliases.inspect}:#{aliases.class}"
+    # @param other [VagrantHosts::Config]
+    # @return [VagrantHosts::Config] The merged results
+    def merge(other)
+      super.tap do |result|
+        result.hosts += other.hosts
       end
     end
 
-    {"Vagrant Hosts" => errors}
+    def validate(machine)
+      errors = []
+      @hosts.each do |(address, aliases)|
+        unless aliases.is_a? Array
+          errors << "#{address} should have an array of aliases, got #{aliases.inspect}:#{aliases.class}"
+        end
+      end
+
+      {"Vagrant Hosts" => errors}
+    end
   end
 end
-end

data/lib/vagrant-hosts/config_builder.rb

@@ -0,0 +1,31 @@
+require 'config_builder/model'
+
+module VagrantHosts
+  module ConfigBuilder
+    class Model < ::ConfigBuilder::Model::Base
+
+      # @!attribute [rw] hosts
+      attr_accessor :hosts
+      # @!attribute [rw] autoconfigure
+      attr_accessor :autoconfigure
+
+      def initialize
+        @hosts = []
+      end
+
+      def to_proc
+        Proc.new do |vm_config|
+          vm_config.provision :hosts do |h_config|
+            h_config.autoconfigure = @autoconfigure if defined? @autoconfigure
+
+            @hosts.each do |(address, aliases)|
+              h_config.add_host address, aliases
+            end
+          end
+        end
+      end
+
+      ::ConfigBuilder::ModelCollection.provisioner.register('hosts', self)
+    end
+  end
+end

data/lib/vagrant-hosts/plugin.rb

@@ -2,11 +2,6 @@ require 'vagrant'
 require 'vagrant-hosts'
 require 'vagrant-hosts/version'
 
-if Vagrant::VERSION < VagrantHosts::REQUIRED_VAGRANT_VERSION
-  raise "vagrant-hosts version #{VagrantHosts::VERSION} requires Vagrant " +
-    "#{VagrantHosts::REQUIRED_VAGRANT_VERSION} or later"
-end
-
 class VagrantHosts::Plugin < Vagrant.plugin(2)
   name 'hosts'
 
@@ -24,4 +19,8 @@ class VagrantHosts::Plugin < Vagrant.plugin(2)
     require_relative 'config'
     VagrantHosts::Config
   end
+
+  action_hook(:hosts, :config_builder_extension) do
+    require_relative 'config_builder'
+  end
 end

data/lib/vagrant-hosts/provisioner.rb

@@ -2,95 +2,19 @@ require 'vagrant'
 require 'tempfile'
 
 module VagrantHosts
-class Provisioner < Vagrant.plugin('2', :provisioner)
+  class Provisioner < Vagrant.plugin('2', :provisioner)
 
-  def initialize(machine, config)
-    @machine, @config = machine, config
-  end
-
-  def provision
-    # too tired to do this. detect target platform, select according provider,
-    # add entries that are specified in the config and are not on the client
-
-    driver = Linux.new(@machine, @config)
-    driver.sync!
-  end
-
-  class Linux
-
-    # This has to be inside of this class, because otherwise the hostname mixin
-    # will create this class with a different superclass. It makes me sad. :(
     require 'vagrant-hosts/provisioner/hostname'
-    include VagrantHosts::Provisioner::Hostname
-
+    require 'vagrant-hosts/provisioner/linux'
 
     def initialize(machine, config)
       @machine, @config = machine, config
     end
 
-    def sync!
-      upload_tmphosts
-      update_hosts
-    end
-
-    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
-      hostname = @machine.config.vm.hostname || @machine.name.to_s
-      change_host_name(hostname)
-      @machine.communicate.sudo('install -m 644 /tmp/hosts /etc/hosts')
-    end
-
-    # Generates content appropriate for a linux hosts file
-    #
-    # @return [String] All hosts in the config joined into hosts records
-    def format_hosts
-      all_hosts.inject('') do |str, (address, aliases)|
-        str << "#{address} #{aliases.join(' ')}\n"
-      end
-    end
-
-    def all_hosts
-      all_hosts = []
-
-      if @config.autoconfigure
-        all_hosts += vagrant_hosts
-      else
-        all_hosts += @config.hosts
-      end
-
-      all_hosts.unshift(['127.0.0.1', ['localhost']])
-      all_hosts.unshift(['127.0.1.1', [@machine.name]])
-    end
-
-    def vagrant_hosts
-      hosts = []
-      env = @machine.env
-      names = env.machine_names
-
-      # Assume that all VMs are using the current provider
-      provider = @machine.provider
-
-      names.each do |name|
-        network_settings = env.machine(name, :virtualbox).config.vm.networks
-        hostname = env.machine(name, :virtualbox).config.vm.hostname
-        network_settings.each do |entry|
-          if entry[0] == :private_network
-            ipaddr = entry[1][:ip]
-            hosts << [ipaddr, [hostname, name]]
-          end
-        end
-      end
-
-      hosts
+    # @todo use guest capabilities instead of hardcoded provisioner provider
+    def provision
+      driver = Linux.new(@machine, @config)
+      driver.sync!
     end
   end
 end
-end

data/lib/vagrant-hosts/provisioner/hostname.rb

@@ -1,15 +1,17 @@
 require 'vagrant'
-require 'vagrant-hosts/provisioner'
+require 'vagrant/errors'
 
-module VagrantHosts
-class Provisioner
-module Hostname
-  # Abstract the details of setting a guest hostname on different versions of
-  # Vagrant.
-  #
-  # Vagrant commit 61d2f9f96fc0f0ef5869c732674f25c4ccc85c8c converts the
-  # #change_host_name # method to a capability, which breaks the API between
-  # 1.1 and 1.2. :(
+# Abstract the details of setting a guest hostname on different versions of
+# Vagrant.
+#
+# Vagrant commit 61d2f9f96fc0f0ef5869c732674f25c4ccc85c8c converts the
+# #change_host_name # method to a capability, which breaks the API between
+# 1.1 and 1.2. :(
+module VagrantHosts::Provisioner::Hostname
+
+  class UnknownVersion < Vagrant::Errors::VagrantError
+    error_key(:unknown_version, 'vagrant_hosts')
+  end
 
   # @param name [String] The new hostname to apply on the guest
   def change_host_name(name)
@@ -19,10 +21,7 @@ module Hostname
     when /1\.2/
       @machine.guest.capability(:change_host_name, name)
     else
-      raise RuntimeError, "#{Vagrant::VERSION} isn't a recognized Vagrant version, can't reliably shim `change_host_name`"
+      raise UnknownVersion, :vagrant_version => Vagrant::VERSION
     end
   end
-
-end
-end
 end

data/lib/vagrant-hosts/provisioner/linux.rb

@@ -0,0 +1,80 @@
+class VagrantHosts::Provisioner::Linux
+
+  include VagrantHosts::Provisioner::Hostname
+
+  def initialize(machine, config)
+    @machine, @config = machine, config
+
+    @env = @machine.env
+  end
+
+  def sync!
+    upload_tmphosts
+    update_hosts
+  end
+
+  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
+    hostname = @machine.config.vm.hostname || @machine.name.to_s
+    change_host_name(hostname)
+    @machine.communicate.sudo('install -m 644 /tmp/hosts /etc/hosts')
+  end
+
+  # Generates content appropriate for a linux hosts file
+  #
+  # @return [String] All hosts in the config joined into hosts records
+  def format_hosts
+    all_hosts.inject('') do |str, (address, aliases)|
+      str << "#{address} #{aliases.join(' ')}\n"
+    end
+  end
+
+  def all_hosts
+    all_hosts = []
+    all_hosts += local_hosts
+
+    if @config.autoconfigure
+      all_hosts += vagrant_hosts
+    end
+    all_hosts += @config.hosts
+
+    all_hosts
+  end
+
+  def local_hosts
+    [
+      ['127.0.0.1', ['localhost']],
+      ['127.0.1.1', [@machine.name]],
+    ]
+  end
+
+  def vagrant_hosts
+    hosts = []
+
+    all_machines.each do |m|
+      m_networks = m.config.vm.networks
+      m_hostname = m.config.vm.hostname
+
+      m_networks.each do |(net_type, opts)|
+        next unless net_types == :private_network
+        addr = opts[:ip]
+        hosts << [addr, [m_hostname, @machine.name]]
+      end
+    end
+
+    hosts
+  end
+
+  # @return [Array<Vagrant::Machine>]
+  def all_machines
+    @env.active_machines.map { |vm_id| @env.machine(*vm_id) }
+  end
+end

data/lib/vagrant-hosts/version.rb

@@ -1,3 +1,3 @@
 module VagrantHosts
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

data/templates/locales/en.yml

@@ -0,0 +1,6 @@
+---
+en:
+  vagrant_hosts:
+    unknown_version: |-
+      %{vagrant_version} isn't a recognized Vagrant version, vagrant-hosts can't reliably
+      detect the `change_host_name` method.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-hosts
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-08 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies: []
 description: ! '    Manage static DNS entries and configuration for Vagrant guests.
 
@@ -24,10 +24,13 @@ files:
 - README.markdown
 - lib/vagrant-hosts.rb
 - lib/vagrant-hosts/config.rb
+- lib/vagrant-hosts/config_builder.rb
 - lib/vagrant-hosts/plugin.rb
 - lib/vagrant-hosts/provisioner.rb
 - lib/vagrant-hosts/provisioner/hostname.rb
+- lib/vagrant-hosts/provisioner/linux.rb
 - lib/vagrant-hosts/version.rb
+- templates/locales/en.yml
 - vagrant-hosts.gemspec
 homepage: https://github.com/adrienthebo/vagrant-hosts
 licenses: