vagrant-hostmanager 0.4.0 → 1.0.0

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
-gem 'vagrant', :git => 'git://github.com/mitchellh/vagrant.git', :tag => 'v1.2.1'
+group :development do
+  gem 'vagrant', :git => 'git://github.com/mitchellh/vagrant.git', :tag => 'v1.2.2'
+end
+
 gemspec

data/README.md

@@ -1,17 +1,9 @@
 Vagrant Host Manager
 ====================
 `vagrant-hostmanager` is a Vagrant 1.1+ plugin that manages the `/etc/hosts`
-file on guest machines. Its goal is to enable resolution of multi-machine
-environments deployed with a cloud provider where IP addresses are not known
-in advance.
-
-Status
-------
-The current implementation is a proof-of-concept supporting the larger
-objective of using Vagrant as a cloud management interface for development
-and production environments.
-
-The plugin has been tested with Vagrant 1.1.5.
+file on guest machines (and optionally the host). Its goal is to enable
+resolution of multi-machine environments deployed with a cloud provider
+where IP addresses are not known in advance.
 
 Installation
 ------------
@@ -32,6 +24,9 @@ machines with the same provider will have their `/etc/hosts` file updated
 accordingly. Set the `hostmanager.enabled` attribute to `true` in the
 Vagrantfile to activate this behavior.
 
+To update the host's `/etc/hosts` file, set the `hostmanager.manage_host`
+attribute to `true`.
+
 A machine's IP address is defined by either the static IP for a private
 network configuration or by the SSH host configuration. To disable
 using the private network IP address, set `config.hostmanger.ignore_private_ip`
@@ -40,9 +35,8 @@ to true.
 A machine's host name is defined by `config.vm.hostname`. If this is not
 set, it falls back to the symbol defining the machine in the Vagrantfile.
 
-When using include_offline set to true, only boxes that are up or have a
-private ip configured will be added to the hosts file. You will receive a
-warning on skipped boxes.
+If the `hostmanager.include_offline` attribute is set to `true`, boxes that are
+up or have a private ip configured will be added to the hosts file.
 
 In addition, the `hostmanager.aliases` configuration attribute can be used
 to provide aliases for your host names.
@@ -52,17 +46,18 @@ Example configuration:
 ```ruby
 Vagrant.configure("2") do |config|
   config.hostmanager.enabled = true
+  config.hostmanager.manage_host = true
   config.hostmanager.ignore_private_ip = false
   config.hostmanager.include_offline = true
-  config.vm.define "example-box" do |node|
-    node.vm.hostname = "example-box-hostname"
-    node.vm.network :private_network, ip: "192.168.42.42"
+  config.vm.define 'example-box' do |node|
+    node.vm.hostname = 'example-box-hostname'
+    node.vm.network :private_network, ip: '192.168.42.42'
     node.hostmanager.aliases = %w(example-box.localdomain example-box-alias)
   end
 end
 ```
 
-As a last option, you can also choose hostmanager as a provisioner.
+As a last option, you can use hostmanager as a provisioner.
 This allows you to use the provisioning order to ensure that hostmanager
 runs before or after provisioning. The provisioner will collect hosts from
 boxes with the same provider as the running box.

data/lib/vagrant-hostmanager/action.rb

@@ -0,0 +1,31 @@
+require 'vagrant-hostmanager/action/update_all'
+require 'vagrant-hostmanager/action/update_guest'
+require 'vagrant-hostmanager/action/update_host'
+
+module VagrantPlugins
+  module HostManager
+    module Action
+      include Vagrant::Action::Builtin
+
+      def self.update_all
+        Vagrant::Action::Builder.new.tap do |builder|
+          builder.use ConfigValidate
+          builder.use UpdateAll
+        end
+      end
+
+      def self.update_guest
+        Vagrant::Action::Builder.new.tap do |builder|
+          builder.use ConfigValidate
+          builder.use UpdateGuest
+        end
+      end
+
+      def self.update_host
+        Vagrant::Action::Builder.new.tap do |builder|
+          builder.use UpdateHost
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager/action/update_all.rb

@@ -0,0 +1,47 @@
+require 'vagrant-hostmanager/hosts_file'
+
+module VagrantPlugins
+  module HostManager
+    module Action
+      class UpdateAll
+        include HostsFile
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @global_env = @machine.env
+          @provider = @machine.provider_name
+          @logger = Log4r::Logger.new('vagrant::hostmanager::update_all')
+        end
+
+        def call(env)
+          # skip if machine is already active on up action
+          return @app.call(env) if @machine.id && env[:machine_action] == :up
+          # skip if machine is not active on destroy action
+          return @app.call(env) if !@machine.id && env[:machine_action] == :destroy
+
+          # check config to see if the hosts file should be update automatically
+          return @app.call(env) unless @machine.config.hostmanager.enabled?
+          @logger.info 'Updating /etc/hosts file automatically'
+
+          @app.call(env)
+
+          # update /etc/hosts file on active machines
+          env[:ui].info I18n.t('vagrant_hostmanager.action.update_guests')
+          @global_env.active_machines.each do |name, p|
+            if p == @provider
+              machine = @global_env.machine(name, p)
+              update_guest(machine)
+            end
+          end
+
+          # update /etc/hosts files on host if enabled
+          if @machine.config.hostmanager.manage_host?
+            env[:ui].info I18n.t('vagrant_hostmanager.action.update_host')
+            update_host
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager/action/update_guest.rb

@@ -0,0 +1,28 @@
+require 'vagrant-hostmanager/hosts_file'
+
+module VagrantPlugins
+  module HostManager
+    module Action
+      class UpdateGuest
+        include HostsFile
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @global_env = @machine.env
+          @provider = env[:provider]
+          @logger = Log4r::Logger.new('vagrant::hostmanager::update_guest')
+        end
+
+        def call(env)
+          env[:ui].info I18n.t('vagrant_hostmanager.action.update_guest', {
+            :name => @machine.name
+          })
+          update_guest(@machine)
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager/action/update_host.rb

@@ -0,0 +1,28 @@
+require 'vagrant-hostmanager/hosts_file'
+
+module VagrantPlugins
+  module HostManager
+    module Action
+      class UpdateHost
+        include HostsFile
+
+        def initialize(app, env)
+          @app = app
+          @global_env = env[:global_env]
+          @provider = env[:provider]
+          @logger = Log4r::Logger.new('vagrant::hostmanager::update_host')
+        end
+
+        def call(env)
+          if @global_env.config_global.hostmanager.manage_host?
+            env[:ui].info I18n.t('vagrant_hostmanager.action.update_host')
+            update_host
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end
+

data/lib/vagrant-hostmanager/command.rb

@@ -18,15 +18,21 @@ module VagrantPlugins
         end
 
         argv = parse_options(opts)
-        return if !argv
-
         options[:provider] ||= @env.default_provider
 
-        generate(@env, options[:provider].to_sym)
-
+        # update /etc/hosts file for specified guest machines
         with_target_vms(argv, options) do |machine|
-          update(machine)
+          @env.action_runner.run(Action.update_guest, {
+            :machine => machine,
+            :provider => options[:provider]
+          })
         end
+
+        # update /etc/hosts file for host
+        @env.action_runner.run(Action.update_host, {
+          :global_env => @env,
+          :provider => options[:provider]
+        })
       end
     end
   end

data/lib/vagrant-hostmanager/config.rb

@@ -2,41 +2,41 @@ module VagrantPlugins
   module HostManager
     class Config < Vagrant.plugin('2', :config)
       attr_accessor :enabled
+      attr_accessor :manage_host
       attr_accessor :ignore_private_ip
       attr_accessor :aliases
       attr_accessor :include_offline
 
       alias_method :enabled?, :enabled
       alias_method :include_offline?, :include_offline
+      alias_method :manage_host?, :manage_host
 
       def initialize
-        @enabled = false
+        @enabled = UNSET_VALUE
+        @manage_host = UNSET_VALUE
         @ignore_private_ip = UNSET_VALUE
-        @aliases = Array.new
-        @include_offline = false
+        @include_offline = UNSET_VALUE
+        @aliases = []
       end
 
       def finalize!
+        @enabled = false if @enabled == UNSET_VALUE
+        @manage_host = false if @managed_host == UNSET_VALUE
         @ignore_private_ip = false if @ignore_private_ip == UNSET_VALUE
+        @include_offline = false if @include_offline == UNSET_VALUE
         @aliases = [ @aliases ].flatten
       end
 
       def validate(machine)
-        errors = Array.new
+        errors = []
 
-        # check if enabled option is either true or false
-        errors << validate_bool('hostmanager.enabled', enabled)
-
-        # check if include_offline is either true or false
-        errors << validate_bool('hostmanager.include_offline', include_offline)
-
-        # check if ignore_private_ip option is either true or false (or UNSET_VALUE)
-        if @ignore_private_ip != UNSET_VALUE
-          errors << validate_bool('hostmanager.ignore_private_ip', ignore_private_ip)
-        end
+        errors << validate_bool('hostmanager.enabled', @enabled)
+        errors << validate_bool('hostmanager.manage_host', @manage_host)
+        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
-        if  !machine.config.hostmanager.aliases.kind_of?(Array) and
+        if !machine.config.hostmanager.aliases.kind_of?(Array) and
             !machine.config.hostmanager.aliases.kind_of?(String)
           errors << I18n.t('vagrant_hostmanager.config.not_an_array_or_string', {
             :config_key => 'hostmanager.aliases',
@@ -44,22 +44,21 @@ module VagrantPlugins
           })
         end
 
-        errors.compact!
-        { "HostManager configuration" => errors }
+        { 'HostManager configuration' => errors }
       end
 
       private
+
       def validate_bool(key, value)
         if ![TrueClass, FalseClass].include?(value.class)
           I18n.t('vagrant_hostmanager.config.not_a_bool', {
             :config_key => key,
-            :value      => value.class.to_s,
+            :value      => value.class.to_s
           })
         else
           nil
         end
       end
-
     end
   end
 end

data/lib/vagrant-hostmanager/hosts_file.rb

@@ -1,86 +1,90 @@
+require 'tempfile'
+
 module VagrantPlugins
   module HostManager
     module HostsFile
-      # Generate a hosts file containing the the active machines
-      # in the Vagrant environment backed by the specified provider.
-      # The file is written to the Vagrant temporary path.
-      def generate(env, provider)
-        machines = []
+      def update_guest(machine)
+        return unless machine.communicate.ready?
 
-        # define a lambda for looking up a machine's ip address
-        get_ip_address = lambda do |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
-            end
+        # download and modify file with Vagrant-managed entries
+        file = @global_env.tmp_path.join("hosts.#{machine.name}")
+        machine.communicate.download('/etc/hosts', file)
+        update_file(file)
+
+        # upload modified file and remove temporary file
+        machine.communicate.upload(file, '/tmp/hosts')
+        machine.communicate.sudo('mv /tmp/hosts /etc/hosts')
+        FileUtils.rm(file)
+      end
+
+      def update_host
+        # copy and modify hosts file on host with Vagrant-managed entries
+        file = @global_env.tmp_path.join('hosts.local')
+        FileUtils.cp('/etc/hosts', file)
+        update_file(file)
+
+        # copy modified file using sudo for permission
+        `sudo cp #{file} /etc/hosts`
+      end
+
+      private
+
+      def update_file(file)
+        # build array of host file entries from Vagrant configuration
+        entries = []
+        get_machines.each do |name, p|
+          if @provider == p
+            machine = @global_env.machine(name, p)
+            host = machine.config.vm.hostname || name
+            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"
           end
-          ip || (machine.ssh_info ? machine.ssh_info[:host] : nil)
         end
 
-        # create the temporary hosts file
-        path = env.tmp_path.join('hosts')
-        File.open(path, 'w') do |file|
-          file << "127.0.0.1\tlocalhost\slocalhost.localdomain\n"
-          get_machines(env, provider).each do |name, p|
-            if provider == p
-              machines << machine = env.machine(name, provider)
-              host = machine.config.vm.hostname || name
-              ip = get_ip_address.call(machine)
-              if ip
-                host_aliases = machine.config.hostmanager.aliases.join("\s").chomp
-                machine.env.ui.info I18n.t('vagrant_hostmanager.action.add_host', {
-                  :ip       => ip,
-                  :host     => host,
-                  :aliases  => host_aliases,
-                })
-                file << "#{ip}\t#{host}\s#{host_aliases}\n"
-              else
-                machine.env.ui.warn I18n.t('vagrant_hostmanager.action.host_no_ip', {
-                  :name => name,
-                })
-              end
-            end
+        tmp_file = Tempfile.open('hostmanager', @global_env.tmp_path, 'a')
+        begin
+          # copy each line not managed by Vagrant
+          File.open(file).each_line do |line|
+            tmp_file << line unless line =~ /# VAGRANT ID:/
           end
+
+          # write a line for each Vagrant-managed entry
+          entries.each { |entry| tmp_file << entry }
+        ensure
+          tmp_file.close
+          FileUtils.cp(tmp_file, file)
+          tmp_file.unlink
         end
-        machines
       end
 
-      # Copy the temporary hosts file to the specified machine overwritting
-      # the existing /etc/hosts file.
-      def update(machine)
-        path = machine.env.tmp_path.join('hosts')
-        if machine.communicate.ready?
-          machine.env.ui.info I18n.t('vagrant_hostmanager.action.update', {
-            :name => machine.name
-          })
-          machine.communicate.upload(path, '/tmp/hosts')
-          machine.communicate.sudo("mv /tmp/hosts /etc/hosts")
+      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
+          end
         end
+        ip || (machine.ssh_info ? machine.ssh_info[:host] : nil)
       end
 
-      private
-      # Either use the active machines, or loop over all available machines and
-      # get those with the same provider (aka, ignore boxes that throw MachineNotFound errors).
-      #
-      # Returns an array with the same structure as env.active_machines:
-      # [ [:machine, :virtualbox], [:foo, :virtualbox] ]
-      def get_machines(env, provider)
-        if env.config_global.hostmanager.include_offline?
+      def get_machines
+        # check if offline machines should be included in host entries
+        if @global_env.config_global.hostmanager.include_offline?
           machines = []
-          env.machine_names.each do |name|
+          @global_env.machine_names.each do |name|
             begin
-              m = env.machine(name, provider)
-              machines << [name, provider]
-            rescue Vagrant::Errors::MachineNotFound => ex
-              # ignore this box.
+              @global_env.machine(name, @provider)
+              machines << [name, @provider]
+            rescue Vagrant::Errors::MachineNotFound
             end
           end
           machines
         else
-          env.active_machines
+          @global_env.active_machines
         end
       end
 

data/lib/vagrant-hostmanager/plugin.rb

@@ -1,12 +1,12 @@
-require 'vagrant-hostmanager/action/update_hosts_file'
+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 guest machines. An entry is
-        created for each active machine using the hostname attribute.
+        This plugin manages the /etc/hosts file for the host and guest machines.
+        An entry is created for each active machine using the hostname attribute.
 
         You can also use the hostmanager provisioner to update the hosts file.
       DESC
@@ -17,11 +17,11 @@ module VagrantPlugins
       end
 
       action_hook(:hostmanager, :machine_action_up) do |hook|
-        hook.prepend(Action::UpdateHostsFile)
+        hook.prepend(Action.update_all)
       end
 
       action_hook(:hostmanager, :machine_action_destroy) do |hook|
-        hook.append(Action::UpdateHostsFile)
+        hook.prepend(Action.update_all)
       end
 
       provisioner(:hostmanager) do

data/lib/vagrant-hostmanager/provisioner.rb

@@ -3,9 +3,17 @@ module VagrantPlugins
     class Provisioner < Vagrant.plugin('2', :provisioner)
       include HostsFile
 
+      def initialize(machine, config)
+        super(machine, config)
+        @global_env = machine.env
+        @provider = machine.provider_name
+      end
+
       def provision
-        generate(@machine.env, @machine.box.provider.to_sym)
-        update(@machine)
+        update_guest(@machine)
+        if @global_env.config_global.hostmanager.manage_host?
+          update_host
+        end
       end
     end
   end

data/lib/vagrant-hostmanager/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module HostManager
-    VERSION = '0.4.0'
+    VERSION = '1.0.0'
   end
 end

data/locales/en.yml

@@ -1,9 +1,9 @@
 en:
   vagrant_hostmanager:
     action:
-      add_host: "Adding /etc/hosts entry: %{ip} %{host} %{aliases}"
-      host_no_ip: "Could not determine ip for machine '%{name}': no private ip configured or machine not up."
-      update: "[%{name}] Updating /etc/hosts file"
+      update_guests: "Updating /etc/hosts file on active guest machines..."
+      update_guest: "[%{name}] Updating /etc/hosts file..."
+      update_host: "Updating /etc/hosts file on host machine (password may be required)..."
     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}'"

data/test/Vagrantfile

@@ -4,14 +4,16 @@
 Vagrant.require_plugin('vagrant-hostmanager')
 
 Vagrant.configure('2') do |config|
-  config.vm.box = 'precise64-chef11.2'
-  config.vm.box_url = 'https://opscode-vm.s3.amazonaws.com/vagrant/opscode_ubuntu-12.04_chef-11.2.0.box'
+  config.vm.box = 'precise64'
+  config.vm.box_url = 'http://cloud-images.ubuntu.com/precise/current/precise-server-cloudimg-vagrant-amd64-disk1.box'
 
   config.hostmanager.enabled = true
+  config.hostmanager.manage_host = true
 
   config.vm.define :server1 do |server|
     server.vm.hostname = 'fry'
     server.vm.network :private_network, :ip => '10.0.5.2'
+    server.hostmanager.aliases = %w(test-alias)
   end
 
   config.vm.define :server2 do |server|

data/vagrant-hostmanager.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'vagrant-hostmanager/version'
@@ -14,4 +15,7 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.3'
+  gem.add_development_dependency 'rake'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-hostmanager
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-07 00:00:00.000000000 Z
-dependencies: []
+date: 2013-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Vagrant plugin that manages the /etc/hosts file within a multi-machine
   environment
 email:
@@ -25,7 +57,10 @@ files:
 - README.md
 - Rakefile
 - lib/vagrant-hostmanager.rb
-- lib/vagrant-hostmanager/action/update_hosts_file.rb
+- lib/vagrant-hostmanager/action.rb
+- lib/vagrant-hostmanager/action/update_all.rb
+- lib/vagrant-hostmanager/action/update_guest.rb
+- lib/vagrant-hostmanager/action/update_host.rb
 - lib/vagrant-hostmanager/command.rb
 - lib/vagrant-hostmanager/config.rb
 - lib/vagrant-hostmanager/errors.rb

data/lib/vagrant-hostmanager/action/update_hosts_file.rb

@@ -1,33 +0,0 @@
-require 'vagrant-hostmanager/hosts_file'
-
-module VagrantPlugins
-  module HostManager
-    module Action
-      class UpdateHostsFile
-        include HostsFile
-
-        def initialize(app, env)
-          @app = app
-          @machine = env[:machine]
-          @logger = Log4r::Logger.new('vagrant::hostmanager::update_hosts_file')
-        end
-
-        def call(env)
-          # check if machine is already active
-          return @app.call(env) if @machine.id
-
-          # check config to see if the hosts file should be update automatically
-          return @app.call(env) unless @machine.config.hostmanager.enabled?
-          @logger.info 'Updating /etc/hosts file automatically'
-
-          # continue the action stack so the machine will be created
-          @app.call(env)
-
-          # update /etc/hosts file on each active machine
-          machines = generate(@machine.env, @machine.provider_name)
-          machines.each { |machine| update(machine) }
-        end
-      end
-    end
-  end
-end