pleschev-vagrant-hostmaster 0.8.1

data/.gitignore

@@ -0,0 +1,21 @@
+.DS_Store
+*.gem
+*.rbc
+*.swo
+*.swp
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-hostmaster.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 S. Brent Faulkner
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# vagrant-hostmaster
+
+`vagrant-hostmaster` is a Vagrant plugin to manage /etc/hosts entries on both the host OS and guest VMs.
+
+## Installation
+
+Install into vagrant's isolated RubyGems instance using:
+
+    $ vagrant gem install vagrant-hostmaster
+
+## 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:
+         list
+         remove
+         update
+
+    For help on any individual command run `vagrant hosts COMMAND -h`
+
+### List Host Entries
+
+    vagrant hosts list [vm-name]
+
+### Remove Host Entries
+
+    vagrant hosts remove [vm-name]
+
+### Update Host Entries
+
+    vagrant hosts update [vm-name]
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/vagrant/hostmaster.rb

@@ -0,0 +1,15 @@
+require 'vagrant'
+require 'vagrant/hostmaster/command/base'
+require 'vagrant/hostmaster/command/root'
+require 'vagrant/hostmaster/config'
+require 'vagrant/hostmaster/vm'
+require 'vagrant/hostmaster/middleware/remove'
+require 'vagrant/hostmaster/middleware/update'
+
+Vagrant.commands.register(:hosts) { Vagrant::Hostmaster::Command::Root }
+Vagrant.config_keys.register(:hosts) { Vagrant::Hostmaster::Config }
+
+Vagrant.actions[:destroy].insert_after(Vagrant::Action::VM::ProvisionerCleanup, Vagrant::Hostmaster::Middleware::Remove)
+
+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,32 @@
+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.state == :running
+              Hostmaster::VM.new(vm).send sub_command.to_sym
+            elsif vm.created?
+              vm.ui.info I18n.t("vagrant.commands.common.vm_not_running")
+            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

@@ -0,0 +1,8 @@
+module Vagrant
+  module Hostmaster
+    module Command
+      class List < Vagrant::Hostmaster::Command::Base
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Vagrant
+  module Hostmaster
+    module Command
+      class Remove < Vagrant::Hostmaster::Command::Base
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+module Vagrant
+  module Hostmaster
+    module Command
+      class Root < Vagrant::Command::Base
+        def initialize(argv, env)
+          super
+
+          @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+
+          @subcommands = Vagrant::Registry.new
+          @subcommands.register(:list) do
+            require File.expand_path("../list", __FILE__)
+            List
+          end
+
+          @subcommands.register(:remove) do
+            require File.expand_path("../remove", __FILE__)
+            Remove
+          end
+
+          @subcommands.register(:update) do
+            require File.expand_path("../update", __FILE__)
+            Update
+          end
+        end
+
+        def execute
+          if @main_args.include?("-h") || @main_args.include?("--help")
+            # Print the help for all the hosts commands.
+            return help
+          end
+
+          # If we reached this far then we must have a subcommand. If not,
+          # then we also just print the help and exit.
+          command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
+          return help if !command_class || !@sub_command
+          @logger.debug("Invoking command class: #{command_class} #{@sub_args.inspect}")
+
+          # Initialize and execute the command class
+          command_class.new(@sub_args, @env).execute
+        end
+
+        # Prints the help out for this command
+        def help
+          opts = OptionParser.new do |opts|
+            opts.banner = "Usage: vagrant hosts <command> [<args>]"
+            opts.separator ""
+            opts.separator "Available subcommands:"
+
+            # Add the available subcommands as separators in order to print them
+            # out as well.
+            keys = []
+            @subcommands.each { |key, value| keys << key.to_s }
+
+            keys.sort.each do |key|
+              opts.separator "     #{key}"
+            end
+
+            opts.separator ""
+            opts.separator "For help on any individual command run `vagrant hosts COMMAND -h`"
+          end
+
+          @env.ui.info(opts.help, :prefix => false)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Vagrant
+  module Hostmaster
+    module Command
+      class Update < Vagrant::Hostmaster::Command::Base
+      end
+    end
+  end
+end

data/lib/vagrant/hostmaster/config.rb

@@ -0,0 +1,11 @@
+module Vagrant
+  module Hostmaster
+    class Config < Vagrant::Config::Base
+      attr_accessor :name
+      attr_accessor :aliases
+      attr_accessor :local
+      attr_accessor :quiet
+      attr_accessor :guests
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Vagrant
+  module Hostmaster
+    module Middleware
+      class Remove
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          remove env[:vm] if env["vm"].created?
+          @app.call(env)
+        end
+
+        protected
+          def remove(vm)
+            Hostmaster::VM.new(vm).remove(:guests => false)
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Vagrant
+  module Hostmaster
+    module Middleware
+      class Update
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          @app.call(env)
+          update env[:vm] if env["vm"].state == :running
+        end
+
+        protected
+          def update(vm)
+            Hostmaster::VM.new(vm).update
+          end
+      end
+    end
+  end
+end

data/lib/vagrant/hostmaster/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module Hostmaster
+    VERSION = "0.8.1"
+  end
+end

data/lib/vagrant/hostmaster/vm.rb

@@ -0,0 +1,165 @@
+require 'forwardable'
+
+module Vagrant
+  module Hostmaster
+    class VM
+      extend Forwardable
+
+      def_delegators :@vm, :channel, :config, :env, :name, :uuid
+
+      class << self
+        def expand_path(relative_path, relative_to)
+          File.expand_path(relative_path, relative_to)
+        end
+
+        def hosts_path
+          Util::Platform.windows? ? expand_path('system32/drivers/etc/hosts', ENV['SYSTEMROOT']) : '/etc/hosts'
+        end
+      end
+
+      def initialize(vm)
+        @vm = vm
+      end
+
+      def add(options = {})
+        options.merge! config_to_h
+        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 => uuid, :hosts_path => hosts_path) } if process_guests?(options)
+      end
+
+      def hosts_path
+        # TODO: if windows guests are supported, this will need to be smarter
+        "/etc/hosts"
+      end
+
+      def list(options = {})
+        options.merge! config_to_h
+        if process_local?(options)
+          output = `#{list_command}`.chomp
+          env.ui.info("[local] #{output}\n\n", :prefix => false) unless output.empty?
+        end
+
+        if process_guests?(options)
+          entries = ""
+          with_other_vms do |vm|
+            channel.execute(vm.list_command(:uuid => uuid, :hosts_path => hosts_path), :error_check => false) do |type, data|
+              entries << data if type == :stdout
+            end
+          end
+          entries = entries.split($/).collect { |entry| "[#{name}] #{entry}" }.join("\n")
+          env.ui.info("#{entries}\n\n", :prefix => false) unless entries.empty?
+        end
+      end
+
+      def remove(options = {})
+        options.merge! config_to_h
+        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 => uuid, :hosts_path => hosts_path) } if process_guests?(options)
+      end
+
+      def update(options = {})
+        options.merge! config_to_h
+        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 => uuid, :hosts_path => hosts_path)) && channel.sudo(vm.add_command(:uuid => uuid, :hosts_path => hosts_path)) } if process_guests?(options)
+      end
+
+      protected
+        def add_command(options = {})
+          uuid = options[:uuid] || self.uuid
+          hosts_path = options[:hosts_path] || self.class.hosts_path
+          %Q(sh -c 'echo "#{host_entry(uuid)}" >>#{hosts_path}')
+        end
+
+        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(uuid = self.uuid)
+          %Q(#{address}  #{host_names.join(' ')}  #{signature(uuid)})
+        end
+
+        def host_name
+          @host_name ||= (config.hosts.name || config.vm.host_name)
+        end
+
+        def host_names
+          @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(options = {})
+          uuid = options[:uuid] || self.uuid
+          hosts_path = options[:hosts_path] || self.class.hosts_path
+          %Q(grep '#{signature(uuid)}$' #{hosts_path})
+        end
+
+        def network
+          # hostonly networks are the only ones we're interested in
+          @network ||= networks.find { |type,network_parameters| type == :hostonly }
+        end
+
+        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(options = {})
+          uuid = options[:uuid] || self.uuid
+          hosts_path = options[:hosts_path] || self.class.hosts_path
+          %Q(sed -e '/#{signature(uuid)}$/ d' -ibak #{hosts_path})
+        end
+
+        def signature(uuid = self.uuid)
+          %Q(# VAGRANT: #{uuid} (#{name}))
+        end
+
+        def sudo(command)
+          if Util::Platform.windows?
+            `#{command}`
+          else
+            `sudo #{command}`
+          end
+        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 && vm.state == :running
+          end
+        end
+
+        def config_to_h
+          {
+            :local  => config.hosts.local.nil?  ? true  : config.hosts.local,
+            :guests => config.hosts.guests.nil? ? true  : config.hosts.guests,
+            :quiet  => config.hosts.quiet.nil?  ? false : config.hosts.quiet
+          }
+        end
+    end
+  end
+end