vagrant-hosts-provisioner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e71f7143025972e9abaa8d937ac44545cff5c4a
+  data.tar.gz: f64b81d1d369dc6d7f74c520b1be99543b7b19f1
+SHA512:
+  metadata.gz: 4acbd5edb6c4d6a529fc1f607f6ec87f1c6a40c6a4c00fe5107af9993066bbc34253702fa9ded52b3142a41c27daaaf82e583270e104db04a9bd375cc31acbe1
+  data.tar.gz: 611aa551f03a4a034b0f6d045941c4d99250f535d13f0195bc9d1001a7d1c22b958eb8305cd31c88825aa57cde6a65f1ab773f21eb88572bd50d440b505eb79a

data/.gitignore

@@ -0,0 +1,16 @@
+.bundle/
+.yardoc
+Gemfile.lock
+test/single/.vagrant
+test/multi/.vagrant
+_yardoc/
+coverage/
+doc/
+pkg/
+tmp/
+*.gem
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'vagrant', :git => 'git://github.com/mitchellh/vagrant.git', :tag => 'v1.6.3'
+end
+
+group :plugins do
+  gemspec
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mohamed Elkholy
+
+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,21 @@
+# VagrantPlugins::HostsProvisioner
+
+A Vagrant provisioner for managing the /etc/hosts file of the host and guest machines. This plugin is currently being used by [#Dashboard VM](https://github.com/mdkholy/Dashboard)..
+
+## Installation
+
+Install into vagrant's isolated RubyGems instance using:
+
+    $ vagrant plugin install vagrant-hosts-provisioner
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/setup'
+require 'bundler/gem_helper'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks
+
+task :test_single do
+  sh 'bash test/single/test.sh'
+end
+
+task :test_multi do
+  sh 'bash test/multi/test.sh'
+end

data/lib/vagrant-hosts-provisioner.rb

@@ -0,0 +1,18 @@
+require "pathname"
+require "vagrant-hosts-provisioner/plugin"
+require "vagrant-hosts-provisioner/version"
+
+module VagrantPlugins
+  module HostsProvisioner
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+
+    # This initializes the internationalization strings.
+    I18n.load_path << File.expand_path("locales/en.yml", self.source_root)
+    I18n.reload!
+  end
+end

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

@@ -0,0 +1,67 @@
+module VagrantPlugins
+  module HostsProvisioner
+    class Config < Vagrant.plugin("2", :config)
+      attr_accessor :hostname
+      attr_accessor :manage_guest
+      attr_accessor :manage_host
+      attr_accessor :aliases
+      attr_accessor :files
+
+      def initialize
+        @hostname           = UNSET_VALUE
+        @manage_guest       = UNSET_VALUE
+        @manage_host        = UNSET_VALUE
+        @aliases            = UNSET_VALUE
+        @files              = UNSET_VALUE
+      end
+
+      def finalize!
+        @hostname           = nil if @hostname == UNSET_VALUE
+        @manage_guest       = false if @manage_guest == UNSET_VALUE
+        @manage_host        = false if @manage_host == UNSET_VALUE
+        @aliases            = [] if @aliases == UNSET_VALUE
+        @files              = [] if @files == UNSET_VALUE
+
+        @aliases            = [ @aliases ].flatten
+        @files              = [ @files ].flatten
+      end
+
+      def validate(machine)
+        errors = []
+
+        errors << validate_bool('manage_guest', manage_guest)
+        errors << validate_bool('manage_host', manage_host)
+        errors << validate_array_or_string('aliases', aliases)
+        errors << validate_array_or_string('files', files)
+        errors.compact!
+
+        { "HostsProvisioner configuration" => errors }
+      end
+
+      # Checks if a option is boolean
+      def validate_bool(key, value)
+        if ![TrueClass, FalseClass].include?(value.class) && value != UNSET_VALUE
+          I18n.t('vagrant_hostsprovisioner.error.invalid_bool', {
+            :config_key    => key,
+            :invalid_class => value.class.to_s
+          })
+        else
+          nil
+        end
+      end
+
+      # Checks if a option is an Array
+      def validate_array_or_string(key, value)
+        if !aliases.kind_of?(Array) && !aliases.kind_of?(String)
+          I18n.t('vagrant_hostsprovisioner.error.not_an_array_or_string', {
+            :config_key    => key,
+            :invalid_class => value.class.to_s
+          })
+        else
+          nil
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require "vagrant"
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < "1.5.0"
+  raise "Vagrant HostsProvisioner plugin is only compatible with Vagrant 1.5+"
+end
+
+module VagrantPlugins
+  module HostsProvisioner
+    class Plugin < Vagrant.plugin('2')
+      name 'HostsProvisioner'
+      description <<-DESC
+      A Vagrant provisioner for managing the /etc/hosts file of the host and guest machines.
+      DESC
+
+      config(:hostsupdate, :provisioner) do
+        require File.expand_path("../config", __FILE__)
+        Config
+      end
+
+      provisioner(:hostsupdate) do
+        require File.expand_path("../provisioner", __FILE__)
+        Provisioner
+      end
+    end
+  end
+end

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

@@ -0,0 +1,241 @@
+require 'tempfile'
+
+module VagrantPlugins
+  module HostsProvisioner
+    class Provisioner < Vagrant.plugin('2', :provisioner)
+
+      def initialize(machine, config)
+        super
+      end
+
+      def provision
+        # Update the guest machine if manage_guest is enabled
+        if @config.manage_guest
+          update_guest
+        end
+        
+        # Update the host machine if manage_host is enabled
+        if @config.manage_host
+          update_host
+        end
+      end
+
+      def update_guest
+        return unless @machine.communicate.ready?
+
+        handle_comm(:stdout, I18n.t("vagrant_hostsprovisioner.provisioner.update_guest"))
+
+        if (@machine.communicate.test("uname -s | grep SunOS"))
+          realhostfile = '/etc/inet/hosts'
+          move_cmd = 'mv'
+        elsif (@machine.communicate.test("test -d $Env:SystemRoot"))
+          windir = ""
+          @machine.communicate.execute("echo %SYSTEMROOT%", {:shell => :cmd}) do |type, contents|
+            windir << contents.gsub("\r\n", '') if type == :stdout
+          end
+          realhostfile = "#{windir}\\System32\\drivers\\etc\\hosts"
+          move_cmd = 'mv -force'
+        else 
+          realhostfile = '/etc/hosts'
+          move_cmd = 'mv -f'
+        end
+
+        # download and modify file with Vagrant-managed entries
+        file = @machine.env.tmp_path.join("hosts.#{@machine.name}")
+        @machine.communicate.download(realhostfile, file)
+        if update_file(file, false)
+          # upload modified file and remove temporary file
+          @machine.communicate.upload(file, '/tmp/hosts')
+          @machine.communicate.sudo("#{move_cmd} /tmp/hosts #{realhostfile}")
+          handle_comm(:stdout, I18n.t("vagrant_hostsprovisioner.provisioner.hosts_file_updated", {:file => realhostfile}))
+        end
+
+        begin
+          FileUtils.rm(file) 
+        rescue Exception => e
+        end
+      end
+
+      def update_host
+        # copy and modify hosts file on host with Vagrant-managed entries
+        file = @machine.env.tmp_path.join('hosts.local')
+
+        handle_comm(:stdout, I18n.t("vagrant_hostsprovisioner.provisioner.update_host"))
+
+        if WindowsSupport.windows?
+          # lazily include windows Module
+          class << self
+            include WindowsSupport unless include? WindowsSupport
+          end
+
+          hosts_location = "#{ENV['WINDIR']}\\System32\\drivers\\etc\\hosts"
+          copy_proc = Proc.new { windows_copy_file(file, hosts_location) }
+        else
+          hosts_location = '/etc/hosts'
+          copy_proc = Proc.new { `sudo cp #{file} #{hosts_location}` }
+        end
+
+        FileUtils.cp(hosts_location, file)
+        if update_file(file, true)
+          copy_proc.call
+          handle_comm(:stdout, I18n.t("vagrant_hostsprovisioner.provisioner.hosts_file_updated", {:file => hosts_location}))
+        end
+      end
+
+      def update_file(file, include_id)
+        file = Pathname.new(file)
+        old_file_content = file.read
+        new_file_content = update_content(old_file_content, include_id)
+        file.open('w') { |io| io.write(new_file_content) }
+        old_file_content != new_file_content
+      end
+
+      def update_content(file_content, include_id)
+        id = include_id ? " id: #{read_or_create_id}" : ""
+        header = "## vagrant-hosts-provisioner-start#{id}\n"
+        footer = "## vagrant-hosts-provisioner-end\n"
+        body = get_hosts_file_entry
+        get_new_content(header, footer, body, file_content) 
+      end
+
+      def get_hosts_file_entry
+        # Get the vm ip address
+        ip = get_ip_address
+
+        # Return empy string if we don't have an ip address
+        if ip === nil
+          handle_comm(:stderr, I18n.t("vagrant_hostsprovisioner.error.no_vm_ip"))
+          return ''
+        end
+
+        # Add the machine hostname
+        hosts = []
+        unless @config.hostname === false
+          hosts.push(@config.hostname || @machine.config.vm.hostname || @machine.name)
+        end
+
+        # Add the defined aliases
+        hosts.concat(@config.aliases)
+
+        # Add the contents of the defined hosts files
+        if @config.files.count > 0
+          hosts.concat(get_files_data)
+        end
+
+        # Remove duplicates
+        hosts = hosts.uniq.join(' ').strip
+
+        "#{ip}\t#{hosts}\n"
+      end
+
+      def get_files_data
+        require 'json'
+        data = []
+        @config.files.each do |file|
+          file_path = File.join(@machine.env.root_path, file)
+          if File.exist?(file_path)
+            file_data = JSON.parse(File.read(file_path))
+            data.concat([ file_data ].flatten)
+          else
+            handle_comm(:stderr, I18n.t("vagrant_hostsprovisioner.error.file_not_found", {:file => file.to_s}))
+          end
+        end
+        data.collect(&:strip)
+      end
+
+      def get_ip_address
+        ip = nil
+        @machine.config.vm.networks.each do |network|
+          key, options = network[0], network[1]
+          ip = options[:ip] if key == :private_network
+          break if ip
+        end
+        # If no ip is defined in private_network then use the ssh host ip instead
+        ip || (@machine.ssh_info ? @machine.ssh_info[:host] : nil)
+      end
+
+      def get_new_content(header, footer, body, old_content)
+        if body.empty?
+          block = "\n"
+        else
+          block = "\n\n" + header + body + footer + "\n"
+        end
+        # Pattern for finding existing block
+        header_pattern = Regexp.quote(header)
+        footer_pattern = Regexp.quote(footer)
+        pattern = Regexp.new("\n*#{header_pattern}.*?#{footer_pattern}\n*", Regexp::MULTILINE)
+        # Replace existing block or append
+        old_content.match(pattern) ? old_content.sub(pattern, block) : old_content.rstrip + block
+      end
+
+      def read_or_create_id
+        file = Pathname.new("#{@machine.env.local_data_path}/hostsprovisioner/#{@machine.name}")
+        if (file.file?)
+          id = file.read.strip
+        else
+          id = SecureRandom.uuid
+          file.dirname.mkpath
+          file.open('w') { |f| f.write(id) }
+        end
+        id
+      end
+
+      ## Windows support for copying files, requesting elevated privileges if necessary
+      module WindowsSupport
+        require 'rbconfig'
+
+        def self.windows?
+          RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+        end
+
+        require 'win32ole' if windows?
+
+        def windows_copy_file(source, dest)
+          begin
+            # First, try Ruby copy
+            FileUtils.cp(source, dest)
+          rescue Errno::EACCES
+            # Access denied, try with elevated privileges
+            windows_copy_file_elevated(source, dest)
+          end
+        end
+
+        private 
+
+        def windows_copy_file_elevated(source, dest)
+          # copy command only supports backslashes as separators
+          source, dest = [source, dest].map { |s| s.to_s.gsub(/\//, '\\') }
+          
+          # run 'cmd /C copy ...' with elevated privilege, minimized
+          copy_cmd = "copy \"#{source}\" \"#{dest}\""        
+          WIN32OLE.new('Shell.Application').ShellExecute('cmd', "/C #{copy_cmd}", nil, 'runas', 7)
+
+          # Unfortunately, ShellExecute does not give us a status code,
+          # and it is non-blocking so we can't reliably compare the file contents
+          # to see if they were copied.
+          #
+          # If the user rejects the UAC prompt, vagrant will silently continue 
+          # without updating the hostsfile.
+        end
+      end
+
+      # This handles outputting the communication data back to the UI
+      def handle_comm(type, data)
+        if [:stderr, :stdout].include?(type)
+          # Output the data with the proper color based on the stream.
+          color = type == :stdout ? :green : :red
+
+          # Clear out the newline since we add one
+          data = data.chomp
+          return if data.empty?
+
+          options = {}
+          options[:color] = color
+
+          @machine.ui.info(data.chomp, options)
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module HostsProvisioner
+    VERSION = "1.0.0"
+  end
+end

data/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  vagrant_hostsprovisioner:
+    provisioner:
+      update_guest: "Updating hosts file on the guest machine..."
+      update_host: "Updating hosts file on the host machine (password may be required)..."
+      hosts_file_updated: "'%{file}' file updated successfully"
+    error:
+      invalid_bool: "Invalid data type '%{invalid_class}' provided for %{config_key}, expected 'boolean' value"
+      not_an_array_or_string: "Invalid data type '%{invalid_class}' provided for %{config_key}, expected an Array or String"
+      no_vm_ip: "Unable to find the ip address of the guest machine"
+      file_not_found: "Unable to find the file '%{file}'"

data/test/multi/Vagrantfile

@@ -0,0 +1,43 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure('2') do |config|
+
+  config.vm.box = 'ubuntu/trusty64'
+
+  config.vm.hostname = "multi-testbox"
+
+  config.vm.define :mark do |node|
+    node.vm.hostname = 'mark'
+    node.vm.network :private_network, :ip => '10.0.5.2'
+    node.vm.provision :hostsupdate do |provision|
+      provision.hostname = 'mark-hostname.dev'
+      provision.manage_guest = true
+      provision.manage_host = true
+      provision.aliases = ['mark-aliase1', 'mark-aliase2']
+    end
+  end
+
+  config.vm.define :john do |node|
+    node.vm.hostname = 'john'
+    node.vm.network :private_network, :ip => '10.0.5.3'
+    node.vm.provision :hostsupdate do |provision|
+      provision.hostname = 'john-hostname.dev'
+      provision.manage_guest = true
+      provision.manage_host = true
+      provision.aliases = ['john-aliase1', 'john-aliase2']
+      provision.files = ['config/hosts.json']
+    end
+  end
+
+  config.vm.define :brad do |node|
+    node.vm.hostname = 'brad'
+    node.vm.network :private_network, :ip => '10.0.5.4'
+    node.vm.provision :hostsupdate do |provision|
+      provision.manage_guest = true
+      provision.manage_host = true
+      provision.files = ['config/notfile.json']
+    end
+  end
+
+end

data/test/multi/config/hosts.json

@@ -0,0 +1 @@
+["local.dev","www.local.dev","localhost.dev","www.localhost.dev"]

data/test/multi/test.sh

@@ -0,0 +1,16 @@
+cd test
+
+vagrant up
+
+echo "[mark] /etc/hosts file:"
+vagrant ssh mark -c 'cat /etc/hosts'
+
+echo "[john] /etc/hosts file:"
+vagrant ssh john -c 'cat /etc/hosts'
+
+echo "[brad] /etc/hosts file:"
+vagrant ssh brad -c 'cat /etc/hosts'
+
+vagrant destroy -f
+
+cd ..

data/test/single/Vagrantfile

@@ -0,0 +1,18 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure('2') do |config|
+
+  config.vm.box = 'ubuntu/trusty64'
+
+  config.vm.hostname = "single-testbox"
+
+  config.vm.provision :hostsupdate do |host|
+  	host.hostname = 'single-testbox-hostname'
+    host.manage_guest = true
+  	host.manage_host = true
+  	host.aliases = ['testbox-aliase1', 'testbox-aliase2']
+    host.files = ['config/hosts.json']
+  end
+
+end

data/test/single/config/hosts.json

@@ -0,0 +1 @@
+["local.dev","www.local.dev","localhost.dev","www.localhost.dev"]

data/test/single/test.sh

@@ -0,0 +1,10 @@
+cd test
+
+vagrant up
+
+echo "/etc/hosts file:"
+vagrant ssh -c 'cat /etc/hosts'
+
+vagrant destroy -f
+
+cd ..

data/vagrant-hosts-provisioner.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-hosts-provisioner/version'
+
+Gem::Specification.new do |spec|
+  spec.name               = "vagrant-hosts-provisioner"
+  spec.version            = VagrantPlugins::HostsProvisioner::VERSION
+  spec.authors            = ["Mohamed Elkholy"]
+  spec.email              = ["mkh117@gmail.com"]
+  spec.description        = %q{A Vagrant provisioner for managing the /etc/hosts file of the host and guest machines.}
+  spec.summary            = spec.description
+  spec.homepage           = "https://github.com/mdkholy/Dashboard"
+  spec.license            = "MIT"
+  spec.rubyforge_project  = "vagrant-hosts-provisioner"
+
+  spec.files              = `git ls-files`.split($/)
+  spec.test_files         = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths      = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-hosts-provisioner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mohamed Elkholy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Vagrant provisioner for managing the /etc/hosts file of the host and
+  guest machines.
+email:
+- mkh117@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-hosts-provisioner.rb
+- lib/vagrant-hosts-provisioner/config.rb
+- lib/vagrant-hosts-provisioner/plugin.rb
+- lib/vagrant-hosts-provisioner/provisioner.rb
+- lib/vagrant-hosts-provisioner/version.rb
+- locales/en.yml
+- test/multi/Vagrantfile
+- test/multi/config/hosts.json
+- test/multi/test.sh
+- test/single/Vagrantfile
+- test/single/config/hosts.json
+- test/single/test.sh
+- vagrant-hosts-provisioner.gemspec
+homepage: https://github.com/mdkholy/Dashboard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: vagrant-hosts-provisioner
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: A Vagrant provisioner for managing the /etc/hosts file of the host and guest
+  machines.
+test_files:
+- test/multi/Vagrantfile
+- test/multi/config/hosts.json
+- test/multi/test.sh
+- test/single/Vagrantfile
+- test/single/config/hosts.json
+- test/single/test.sh