vagrant-hostmaster 0.7.0 → 0.8.0

data/README.md

@@ -1,6 +1,6 @@
 # vagrant-hostmaster
 
-vagrant-hostmaster is a Vagrant plugin to manage /etc/hosts entries on both the host OS and guest VMs.
+`vagrant-hostmaster` is a Vagrant plugin to manage /etc/hosts entries on both the host OS and guest VMs.
 
 ## Installation
 
@@ -18,6 +18,74 @@ Or install it yourself as:
 
 ## Usage
 
+vagrant-hostmaster will automatically add/update /etc/hosts entries when you run `vagrant up`
+(or `vagrant provision`).
+
+The host entries will automatically be removed when you run `vagrant destroy`.
+
+### Configuration
+
+By default, the name specified in the `vm.host_name` configuration option will be associated
+with the address of the first network interface.
+
+For example:
+
+    Vagrant::Config.run do |config|
+      ...
+
+      config.vm.host_name = "www.example.com"
+
+      config.vm.network :hostonly, "33.33.33.60"
+    end
+
+This would result in the following hosts entry:
+
+    33.33.33.60 www.example.com # VAGRANT: ...
+
+### Using a different host name
+  
+To use a different host name, specify it in your Vagrantfile using the `hosts.name` configuration
+option.
+
+For example:
+
+    Vagrant::Config.run do |config|
+      ...
+
+      config.vm.host_name = "www.example.com"
+      config.hosts.name = "example.com"
+
+      config.vm.network :hostonly, "33.33.33.60"
+    end
+
+This would result in the following hosts entry:
+
+    33.33.33.60 example.com # VAGRANT: ...
+
+### Host aliases
+
+In addition, the `hosts.aliases` configuration option can be used to provide aliases for your host names.
+
+For example:
+
+    Vagrant::Config.run do |config|
+      ...
+
+      config.vm.host_name = "www.example.com"
+      config.hosts.aliases = %w(example.com)
+
+      config.vm.network :hostonly, "33.33.33.60"
+    end
+
+This would result in the following hosts entry:
+
+    33.33.33.60 www.example.com example.com # VAGRANT: ...
+
+## Command Line
+
+In addition to automatically updating the hosts file, the `hosts` command supports manual
+modification (or verification) of the hosts entries.
+
     Usage: vagrant hosts <command> [<args>]
 
     Available subcommands:
@@ -29,21 +97,15 @@ Or install it yourself as:
 
 ### List Host Entries
 
-    vagrant hosts list
+    vagrant hosts list [vm-name]
 
 ### Remove Host Entries
 
-    vagrant hosts remove [<vm-name> [...]]
+    vagrant hosts remove [vm-name]
 
 ### Update Host Entries
 
-    vagrant hosts update [<vm-name> [...]]
-
-## TODO
-
-1. add commands to modify guests
-
-2. add provisioning support so that changes are made automatically
+    vagrant hosts update [vm-name]
 
 ## Contributing
 

data/lib/vagrant/hostmaster.rb

@@ -1,4 +1,5 @@
 require 'vagrant/hostmaster/version'
+require 'vagrant/hostmaster/command/base'
 require 'vagrant/hostmaster/command/root'
 require 'vagrant/hostmaster/config'
 require 'vagrant/hostmaster/vm'
@@ -11,5 +12,5 @@ Vagrant.commands.register(:hosts) { Vagrant::Hostmaster::Command::Root }
 
 Vagrant.actions[:destroy].insert_after(Vagrant::Action::VM::ProvisionerCleanup, Vagrant::Hostmaster::Middleware::Remove)
 
-Vagrant.actions[:provision].insert(Vagrant::Action::VM::Provision, Vagrant::Hostmaster::Middleware::Update)
-Vagrant.actions[:start].insert(Vagrant::Action::VM::Provision, Vagrant::Hostmaster::Middleware::Update)
+Vagrant.actions[:provision].insert_after(Vagrant::Action::VM::Provision, Vagrant::Hostmaster::Middleware::Update)
+Vagrant.actions[:start].insert_after(Vagrant::Action::VM::Provision, Vagrant::Hostmaster::Middleware::Update)

data/lib/vagrant/hostmaster/command/base.rb

@@ -0,0 +1,30 @@
+module Vagrant
+  module Hostmaster
+    module Command
+      class Base < Vagrant::Command::Base
+        def execute
+          sub_command = self.class.name.split('::').last.downcase
+
+          parser = OptionParser.new do |opts|
+            opts.banner = "Usage: vagrant hosts #{sub_command} [vm-name]"
+          end
+
+          # Parse the options
+          argv = parse_options(parser)
+          return if !argv
+
+          with_target_vms(argv) do |vm|
+            if vm.created?
+              Hostmaster::VM.new(vm).send sub_command.to_sym
+            else
+              vm.ui.info I18n.t("vagrant.commands.common.vm_not_created")
+            end
+          end
+
+          # Success, exit status 0
+          0
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/hostmaster/command/list.rb

@@ -1,24 +1,7 @@
 module Vagrant
   module Hostmaster
     module Command
-      class List < Vagrant::Command::Base
-        def execute
-          options = OptionParser.new do |opts|
-            opts.banner = "Usage: vagrant hosts list"
-          end
-
-          # Parse the options
-          argv = parse_options(options)
-          return if !argv
-          raise Vagrant::Errors::CLIInvalidUsage, :help => opts.help.chomp if argv.length != 0
-
-          with_target_vms do |vm|
-            Hostmaster::VM.new(vm).list
-          end
-
-          # Success, exit status 0
-          0
-        end
+      class List < Vagrant::Hostmaster::Command::Base
       end
     end
   end

data/lib/vagrant/hostmaster/command/remove.rb

@@ -1,23 +1,7 @@
 module Vagrant
   module Hostmaster
     module Command
-      class Remove < Vagrant::Command::Base
-        def execute
-          options = OptionParser.new do |opts|
-            opts.banner = "Usage: vagrant hosts remove [<vm-name> [...]]"
-          end
-
-          # Parse the options
-          argv = parse_options(options)
-          return if !argv
-
-          with_target_vms(argv) do |vm|
-            Hostmaster::VM.new(vm).remove
-          end
-
-          # Success, exit status 0
-          0
-        end
+      class Remove < Vagrant::Hostmaster::Command::Base
       end
     end
   end

data/lib/vagrant/hostmaster/command/update.rb

@@ -1,24 +1,7 @@
 module Vagrant
   module Hostmaster
     module Command
-      class Update < Vagrant::Command::Base
-        def execute
-          options = OptionParser.new do |opts|
-            opts.banner = "Usage: vagrant hosts update [<vm-name> [...]]"
-          end
-
-          # Parse the options
-          argv = parse_options(options)
-          return if !argv
-
-          with_target_vms(argv) do |vm|
-            @env.ui.info("Updating host entry for #{vm.name} VM. Administrator privileges will be required...", :prefix => false)
-            Hostmaster::VM.new(vm).update
-          end
-
-          # Success, exit status 0
-          0
-        end
+      class Update < Vagrant::Hostmaster::Command::Base
       end
     end
   end

data/lib/vagrant/hostmaster/middleware/remove.rb

@@ -13,7 +13,7 @@ module Vagrant
 
         protected
           def remove(vm)
-            Hostmaster::VM.new(vm).remove
+            Hostmaster::VM.new(vm).remove(:guests => false)
           end
       end
     end

data/lib/vagrant/hostmaster/middleware/update.rb

@@ -7,8 +7,8 @@ module Vagrant
         end
 
         def call(env)
-          update env[:vm]
           @app.call(env)
+          update env[:vm]
         end
 
         protected

data/lib/vagrant/hostmaster/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Hostmaster
-    VERSION = "0.7.0"
+    VERSION = "0.8.0"
   end
 end

data/lib/vagrant/hostmaster/vm.rb

@@ -5,46 +5,73 @@ module Vagrant
     class VM
       extend Forwardable
 
-      def_delegators :@vm, :config, :env, :name, :uuid
+      def_delegators :@vm, :channel, :config, :env, :name, :uuid
 
       def initialize(vm)
         @vm = vm
       end
 
       def add(options = {})
-        env.ui.info("Adding host entry for #{name} VM. Administrator privileges will be required...") unless options[:quiet]
-        sudo %Q(sh -c 'echo "#{host_entry}" >>/etc/hosts')
+        if process_local?(options)
+          env.ui.info("Adding host entry for #{name} VM. Administrator privileges will be required...") unless options[:quiet]
+          sudo add_command
+        end
+
+        with_other_vms { |vm| channel.sudo vm.add_command(uuid) } if process_guests?(options)
       end
 
       def list(options = {})
-        system %Q(grep '#{signature}$' /etc/hosts)
+        if process_local?(options)
+          output = `#{list_command}`.chomp
+          env.ui.info("Local host entry for #{name}...\n#{output}\n\n", :prefix => false) unless output.empty?
+        end
+
+        if process_guests?(options)
+          entries = []
+          with_other_vms do |vm|
+            entry = ""
+            channel.execute(vm.list_command(uuid), :error_check => false) do |type, data|
+              entry << data if type == :stdout
+            end
+            entry.chomp!
+            entries << entry unless entry.empty?
+          end
+          env.ui.info("Guest host #{entries.size > 1 ? 'entries' : 'entry'} on #{name}...\n#{entries.join("\n")}\n\n", :prefix => false) unless entries.empty?
+        end
       end
 
       def remove(options = {})
-        env.ui.info("Removing host entry for #{name} VM. Administrator privileges will be required...") unless options[:quiet]
-        sudo %Q(sed -e '/#{signature}$/ d' -ibak /etc/hosts)
+        if process_local?(options)
+          env.ui.info("Removing host entry for #{name} VM. Administrator privileges will be required...") unless options[:quiet]
+          sudo remove_command
+        end
+        with_other_vms { |vm| channel.sudo vm.remove_command(uuid) } if process_guests?(options)
       end
 
       def update(options = {})
-        env.ui.info("Updating host entry for #{name} VM. Administrator privileges will be required...") unless options[:quiet]
-        remove(:quiet => true) && add(:quiet => true)
+        if process_local?(options)
+          env.ui.info("Updating host entry for #{name} VM. Administrator privileges will be required...") unless options[:quiet]
+          sudo(remove_command) && sudo(add_command)
+        end
+        with_other_vms { |vm| channel.sudo(vm.remove_command(uuid)) && channel.sudo(vm.add_command(uuid)) } if process_guests?(options)
       end
 
       protected
-        def address
-          @address ||= (addresses && addresses.first || '127.0.0.1')
+        def add_command(uuid = self.uuid)
+          %Q(sh -c 'echo "#{host_entry(uuid)}" >>/etc/hosts')
         end
 
-        def addresses
-          @network_addresses ||= (network && network.last)
+        def address
+          # network parameters consist of an address and a hash of options
+          @address ||= (network_parameters && network_parameters.first)
         end
 
         def host_aliases
           @host_aliases ||= Array(config.hosts.aliases)
         end
 
-        def host_entry
-          @host_entry ||= "#{address}  #{host_names.join(' ')}  #{signature}"
+        def host_entry(uuid = self.uuid)
+          %Q(#{address}  #{host_names.join(' ')}  #{signature(uuid)})
         end
 
         def host_name
@@ -55,16 +82,48 @@ module Vagrant
           @host_names ||= (Array(host_name) + host_aliases)
         end
 
+        def process_guests?(options = {})
+          {:guests => true}.merge(options)[:guests]
+        end
+
+        def process_local?(options = {})
+          {:local => true}.merge(options)[:local]
+        end
+
+        def list_command(uuid = self.uuid)
+          %Q(grep '#{signature(uuid)}$' /etc/hosts)
+        end
+
         def network
-          @network ||= config.vm.networks.first
+          # hostonly networks are the only ones we're interested in
+          @network ||= networks.find { |type,network_parameters| type == :hostonly }
         end
 
-        def signature
-          @signature ||= "# VAGRANT: #{uuid}"
+        def network_parameters
+          # network is a pair of a network type and the network parameters
+          @network_parameters ||= (network && network.last)
+        end
+
+        def networks
+          @networks ||= config.vm.networks
+        end
+
+        def remove_command(uuid = self.uuid)
+          %Q(sed -e '/#{signature(uuid)}$/ d' -ibak /etc/hosts)
+        end
+
+        def signature(uuid = self.uuid)
+          %Q(# VAGRANT: #{uuid} (#{name}))
         end
 
         def sudo(command)
-          system %Q(sudo #{command})
+          `sudo #{command}`
+        end
+
+        def with_other_vms
+          env.vms.each do |name,vm|
+            yield Hostmaster::VM.new(vm) if vm.config.vm.networks.any? { |type,network_parameters| type == :hostonly } && vm.name != self.name
+          end
         end
     end
   end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 7
+  - 8
   - 0
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - S. Brent Faulkner
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-18 00:00:00 -04:00
+date: 2012-08-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,7 @@ files:
 - README.md
 - Rakefile
 - lib/vagrant/hostmaster.rb
+- lib/vagrant/hostmaster/command/base.rb
 - lib/vagrant/hostmaster/command/list.rb
 - lib/vagrant/hostmaster/command/remove.rb
 - lib/vagrant/hostmaster/command/root.rb