rethinc-vagrant-hostmanager 1.8.9.1

data/lib/vagrant-hostmanager/hosts_file/updater.rb

@@ -0,0 +1,222 @@
+require 'tempfile'
+
+module VagrantPlugins
+  module HostManager
+    module HostsFile
+
+      class Updater
+
+        def initialize(global_env, provider)
+          @global_env = global_env
+          @config = Util.get_config(@global_env)
+          @provider = provider
+          @logger = Log4r::Logger.new('vagrant::hostmanager::updater')
+          @logger.debug("init updater")
+        end
+
+        def update_guest(machine)
+          return unless machine.communicate.ready?
+
+          if (machine.communicate.test("uname -s | grep SunOS"))
+            realhostfile = "/etc/inet/hosts"
+            is_windows = false
+          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"
+            is_windows = true
+          else
+            realhostfile = "/etc/hosts"
+            is_windows = false
+          end
+
+          # download and modify file with Vagrant-managed entries
+          file = @global_env.tmp_path.join("hosts.#{machine.name}")
+          machine.communicate.download(realhostfile, file)
+
+          @logger.debug("file is: #{file.to_s}")
+          @logger.debug("class of file is: #{file.class}")
+
+          if update_file(file, machine, false, is_windows)
+            # upload modified file and remove temporary file
+            machine.communicate.upload(file.to_s, "/tmp/hosts.#{machine.name}")
+            if windir
+              machine.communicate.sudo("mv -force /tmp/hosts.#{machine.name} #{realhostfile}")
+            else
+              machine.communicate.sudo("cat /tmp/hosts.#{machine.name} > #{realhostfile} && rm -f /tmp/hosts.#{machine.name}")
+            end
+          end
+
+        end
+
+        def update_host
+          # copy and modify hosts file on host with Vagrant-managed entries
+          file = @global_env.tmp_path.join('hosts.local')
+
+          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) }
+            is_windows = true
+          else
+            hosts_location = '/etc/hosts'
+            copy_proc = Proc.new { `[ -w "#{hosts_location}" ] && cat "#{file}" > "#{hosts_location}" || sudo cp "#{file}" "#{hosts_location}"` }
+            is_windows = false
+          end
+
+          FileUtils.cp(hosts_location, file)
+
+          if update_file(file, nil, true, is_windows)
+            copy_proc.call
+          end
+        end
+
+        private
+
+        def update_file(file, resolving_machine = nil, include_id = true, is_windows)
+          file = Pathname.new(file)
+          old_file_content = file.read
+          # Don't care what's been read by Pathname, just convert to universal line endings for comparison
+          old_file_content = old_file_content.encode(old_file_content.encoding, universal_newline: true)
+          new_file_content = update_content(old_file_content, resolving_machine, include_id)
+          is_hosts_file_changed = (old_file_content != new_file_content)
+
+          if is_hosts_file_changed
+            if is_windows
+              new_file_content = new_file_content.encode(new_file_content.encoding, :crlf_newline => true)
+            end
+
+            file.open('wb') { |io| io.write(new_file_content) }
+          end
+          is_hosts_file_changed
+        end
+
+        def update_content(file_content, resolving_machine, include_id)
+          id = include_id ? " id: #{read_or_create_id}" : ""
+          header = "## vagrant-hostmanager-start#{id}"
+          footer = "## vagrant-hostmanager-end"
+          body = get_machines
+            .map { |machine| get_hosts_file_entry(machine, resolving_machine) }
+            .join
+            get_new_content(header, footer, body, file_content)
+        end
+
+        def get_hosts_file_entry(machine, resolving_machine)
+          ip = get_ip_address(machine, resolving_machine)
+          host = machine.config.vm.hostname || machine.name
+          aliases = machine.config.hostmanager.aliases
+          if ip != nil
+            "#{ip}\t#{host}\n" + aliases.map{|a| "#{ip}\t#{a}"}.join("\n") + "\n"
+          end
+        end
+
+        def get_ip_address(machine, resolving_machine)
+          custom_ip_resolver = machine.config.hostmanager.ip_resolver
+          if custom_ip_resolver
+            custom_ip_resolver.call(machine, resolving_machine)
+          else
+            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
+                break if ip
+              end
+            end
+            ip || (machine.ssh_info ? machine.ssh_info[:host] : nil)
+          end
+        end
+
+        def get_machines
+          if @config.hostmanager.include_offline?
+            machines = @global_env.machine_names
+          else
+            machines = @global_env.active_machines
+              .select { |name, provider| provider == @provider }
+              .collect { |name, provider| name }
+          end
+          # Collect only machines that exist for the current provider
+          machines.collect do |name|
+                begin
+                  machine = @global_env.machine(name, @provider)
+                rescue Vagrant::Errors::MachineNotFound
+                  # ignore
+                end
+                machine
+              end
+            .reject(&:nil?)
+        end
+
+        def get_new_content(header, footer, body, old_content)
+          if body.empty?
+            block = "\n"
+          else
+            block = "\n\n" + header + "\n" + body + footer + "\n\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
+          content = old_content.match(pattern) ? old_content.sub(pattern, block) : old_content.rstrip + block
+        end
+
+        def read_or_create_id
+          file = Pathname.new("#{@global_env.local_data_path}/hostmanager/id")
+          if (file.file?)
+            id = file.read.strip
+          else
+            id = SecureRandom.uuid
+            file.dirname.mkpath
+            file.open('w') { |io| io.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
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager/plugin.rb

@@ -0,0 +1,44 @@
+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 the host and guest machines.
+        An entry is created for each running machine using the hostname attribute.
+
+        You can also use the hostmanager provisioner to update the hosts file.
+      DESC
+
+      config(:hostmanager) do
+        require_relative 'config'
+        Config
+      end
+
+      action_hook(:hostmanager, :machine_action_up) do |hook|
+        hook.after(Vagrant::Action::Builtin::Provision, Action.update_all)
+      end
+
+      action_hook(:hostmanager, :machine_action_destroy) do |hook|
+        hook.prepend(Action.update_all)
+      end
+
+      provisioner(:hostmanager) do
+        require_relative 'provisioner'
+        Provisioner
+      end
+
+      # Work-around for vagrant >= 1.5
+      # It breaks without a provisioner config, so we provide a dummy one
+      config(:hostmanager, :provisioner) do
+        ::Vagrant::Config::V2::DummyConfig.new
+      end
+
+      command(:hostmanager) do
+        require_relative 'command'
+        Command
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager/provisioner.rb

@@ -0,0 +1,24 @@
+require 'vagrant-hostmanager/hosts_file/updater'
+
+module VagrantPlugins
+  module HostManager
+    class Provisioner < Vagrant.plugin('2', :provisioner)
+
+      def initialize(machine, config)
+        super(machine, config)
+        global_env = machine.env
+        @config = Util.get_config(global_env)
+        @updater = HostsFile::Updater.new(global_env, machine.provider_name)
+      end
+
+      def provision
+        if @config.hostmanager.manage_guest?
+          @updater.update_guest(@machine)
+        end
+        if @config.hostmanager.manage_host?
+          @updater.update_host
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager/util.rb

@@ -0,0 +1,14 @@
+module VagrantPlugins
+  module HostManager
+    module Util
+      def self.get_config(env)
+        # config_global has been removed from v1.5
+        if Gem::Version.new(::Vagrant::VERSION) >= Gem::Version.new('1.5')
+          env.vagrantfile.config
+        else
+          env.config_global
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module HostManager
+    VERSION = '1.8.9.1'
+  end
+end

data/lib/vagrant-hostmanager.rb

@@ -0,0 +1,14 @@
+require 'vagrant-hostmanager/plugin'
+require 'vagrant-hostmanager/version'
+require 'vagrant-hostmanager/errors'
+
+module VagrantPlugins
+  module HostManager
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+
+    I18n.load_path << File.expand_path('locales/en.yml', source_root)
+    I18n.reload!
+  end
+end

data/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  vagrant_hostmanager:
+    action:
+      update_guests: "[vagrant-hostmanager:guests] Updating hosts file on active guest virtual machines..."
+      update_guest: "[vagrant-hostmanager:guest] Updating hosts file on the virtual machine %{name}..."
+      update_host: "[vagrant-hostmanager:host] Updating hosts file on your workstation (password may be required)..."
+    config:
+      not_a_bool: "[vagrant-hostmanager:config:error] A value for %{config_key} can only be true or false, not type '%{value}'"
+      not_an_array_or_string: "[vagrant-hostmanager:config:error] A value for %{config_key} must be an Array or String, not type '%{is_class}'"
+      not_a_proc: "[vagrant-hostmanager:config:error] A value for %{config_key} must be a Proc, not type '%{is_class}'"

data/test/Vagrantfile

@@ -0,0 +1,42 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+if Gem::Version.new(::Vagrant::VERSION) < Gem::Version.new('1.5')
+  Vagrant.require_plugin('vagrant-hostmanager')
+end
+
+Vagrant.configure('2') do |config|
+
+  if ENV.key? 'VAGRANT_BOX'
+    config.vm.box = ENV['VAGRANT_BOX']
+  else
+    config.vm.box = 'precise64'
+    config.vm.box_url = 'http://cloud-images.ubuntu.com/precise/current/precise-server-cloudimg-vagrant-amd64-disk1.box'
+  end
+
+  config.hostmanager.enabled = true
+  config.hostmanager.manage_host = true
+  config.hostmanager.manage_guest = 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|
+    server.vm.hostname = 'bender'
+    server.vm.network :private_network, :ip => '10.0.5.3'
+  end
+
+  config.vm.define :server3 do |server|
+    server.vm.hostname = 'leena'
+    server.vm.network :private_network, :ip => '10.0.5.4'
+    server.vm.provision :hostmanager
+  end
+
+  config.vm.define :server4 do |server|
+    server.vm.hostname = 'scruffy'
+    server.vm.provision :hostmanager
+  end
+end

data/test/test.sh

@@ -0,0 +1,14 @@
+cd test
+
+vagrant up
+
+vagrant hostmanager
+
+echo "[server1] /etc/hosts file:"
+vagrant ssh server1 -c 'cat /etc/hosts'
+echo "[server2] /etc/hosts file:"
+vagrant ssh server2 -c 'cat /etc/hosts'
+
+vagrant destroy -f
+
+cd ..

data/vagrant-hostmanager.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-hostmanager/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'rethinc-vagrant-hostmanager'
+  gem.version       = VagrantPlugins::HostManager::VERSION
+  gem.authors       = ['Shawn Dahlen','Seth Reeser']
+  gem.email         = ['shawn@dahlen.me','info@devopsgroup.io']
+  gem.description   = %q{A Vagrant plugin that manages the /etc/hosts file within a multi-machine environment}
+  gem.summary       = gem.description
+  gem.license       = 'MIT'
+
+  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

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rethinc-vagrant-hostmanager
+version: !ruby/object:Gem::Version
+  version: 1.8.9.1
+platform: ruby
+authors:
+- Shawn Dahlen
+- Seth Reeser
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-14 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 plugin that manages the /etc/hosts file within a multi-machine
+  environment
+email:
+- shawn@dahlen.me
+- info@devopsgroup.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/vagrant-hostmanager.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
+- lib/vagrant-hostmanager/hosts_file/updater.rb
+- lib/vagrant-hostmanager/plugin.rb
+- lib/vagrant-hostmanager/provisioner.rb
+- lib/vagrant-hostmanager/util.rb
+- lib/vagrant-hostmanager/version.rb
+- locales/en.yml
+- test/Vagrantfile
+- test/test.sh
+- vagrant-hostmanager.gemspec
+homepage:
+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: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A Vagrant plugin that manages the /etc/hosts file within a multi-machine
+  environment
+test_files:
+- test/Vagrantfile
+- test/test.sh