vagrant-hostmanager-rethinc 1.8.9.1

data/README.md

@@ -0,0 +1,228 @@
+Vagrant Host Manager
+====================
+
+[![Gem](https://img.shields.io/gem/v/vagrant-hostmanager.svg)](https://rubygems.org/gems/vagrant-hostmanager)
+[![Gem](https://img.shields.io/gem/dt/vagrant-hostmanager.svg)](https://rubygems.org/gems/vagrant-hostmanager)
+[![Gem](https://img.shields.io/gem/dtv/vagrant-hostmanager.svg)](https://rubygems.org/gems/vagrant-hostmanager)
+[![Twitter](https://img.shields.io/twitter/url/https/github.com/devopsgroup-io/vagrant-hostmanager.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20this%20awesome%20Vagrant%20plugin%21&url=https%3A%2F%2Fgithub.com%devopsgroup-io%2Fvagrant-hostmanager&hashtags=vagrant%hostmanager&original_referer=)
+
+`vagrant-hostmanager` is a Vagrant plugin that manages the `hosts` 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.
+
+Do you like what we do? Consider supporting us through Patreon. All of the money goes directly back into growing our collection of open source and free software.
+[![Patreon](https://img.shields.io/badge/patreon-donate-red.svg)](https://www.patreon.com/devopsgroup)
+
+Installation
+------------
+
+    $ vagrant plugin install vagrant-hostmanager
+
+Usage
+-----
+To update the `hosts` file on each active machine, run the following
+command:
+
+    $ vagrant hostmanager
+
+The plugin hooks into the `vagrant up` and `vagrant destroy` commands
+automatically.
+When a machine enters or exits the running state , all active
+machines with the same provider will have their `hosts` file updated
+accordingly. Set the `hostmanager.enabled` attribute to `true` in the
+Vagrantfile to activate this behavior.
+
+To update the host's `hosts` file, set the `hostmanager.manage_host`
+attribute to `true`.
+
+To update the guests' `hosts` file, set the `hostmanager.manage_guest`
+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.hostmanager.ignore_private_ip`
+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.
+
+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.
+
+Example configuration:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.hostmanager.enabled = true
+  config.hostmanager.manage_host = true
+  config.hostmanager.manage_guest = 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'
+    node.hostmanager.aliases = %w(example-box.localdomain example-box-alias)
+  end
+end
+```
+
+### Provisioner
+
+Starting at version 1.5.0, `vagrant up` runs hostmanager before any provisioning occurs. 
+If you would like hostmanager to run after or during your provisioning stage, 
+you can use hostmanager as a provisioner.  This allows you to use the provisioning 
+order to ensure that hostmanager runs when desired. The provisioner will collect
+hosts from boxes with the same provider as the running box.
+
+Example:
+
+```ruby
+# Disable the default hostmanager behavior
+config.hostmanager.enabled = false
+
+# ... possible provisioner config before hostmanager ...
+
+# hostmanager provisioner
+config.vm.provision :hostmanager
+
+# ... possible provisioning config after hostmanager ...
+```
+
+Custom IP resolver
+------------------
+
+You can customize way, how host manager resolves IP address
+for each machine. This might be handy in case of aws provider,
+where host name is stored in ssh_info hash of each machine.
+This causes generation of invalid /etc/hosts file.
+
+Custom IP resolver gives you oportunity to calculate IP address
+for each machine by yourself, giving You also access to the machine that is
+updating /etc/hosts. For example:
+
+```ruby
+config.hostmanager.ip_resolver = proc do |vm, resolving_vm|
+  if hostname = (vm.ssh_info && vm.ssh_info[:host])
+    `host #{hostname}`.split("\n").last[/(\d+\.\d+\.\d+\.\d+)/, 1]
+  end
+end
+```
+
+Passwordless sudo
+-----------------
+
+To avoid being asked for the password every time the hosts file is updated,
+enable passwordless sudo for the specific command that hostmanager uses to
+update the hosts file.
+
+  - Add the following snippet to the sudoers file (e.g.
+    `/etc/sudoers.d/vagrant_hostmanager`):
+
+    ```
+    Cmnd_Alias VAGRANT_HOSTMANAGER_UPDATE = /bin/cp <home-directory>/.vagrant.d/tmp/hosts.local /etc/hosts
+    %<admin-group> ALL=(root) NOPASSWD: VAGRANT_HOSTMANAGER_UPDATE
+    ```
+
+    Replace `<home-directory>` with your actual home directory (e.g.
+    `/home/joe`) and `<admin-group>` with the group that is used by the system
+    for sudo access (usually `sudo` on Debian/Ubuntu systems and `wheel`
+    on Fedora/Red Hat systems).
+
+  - If necessary, add yourself to the `<admin-group>`:
+
+    ```
+    usermod -aG <admin-group> <user-name>
+    ```
+
+    Replace `<admin-group>` with the group that is used by the system for sudo
+    access (see above) and `<user-name>` with you user name.
+
+Windows support
+---------------
+
+Hostmanager will detect Windows guests and hosts and use the appropriate
+path for the ```hosts``` file: ```%WINDIR%\System32\drivers\etc\hosts```
+
+By default on a Windows host, the ```hosts``` file is not writable without
+elevated privileges. If hostmanager detects that it cannot overwrite the file,
+it will attempt to do so with elevated privileges, causing the
+[UAC](http://en.wikipedia.org/wiki/User_Account_Control) prompt to appear.
+
+To avoid the UAC prompt, open ```%WINDIR%\System32\drivers\etc\``` in
+Explorer, right-click the hosts file, go to Properties > Security > Edit
+and give your user Modify permission.
+
+### UAC limitations
+
+Due to limitations caused by UAC, cancelling out of the UAC prompt will not cause any
+visible errors, however the ```hosts``` file will not be updated.
+
+
+Compatibility
+-------------
+This Vagrant plugin has been tested with the following host and guest operating system combinations.
+
+Date Tested | Vagrant Version | vagrant-hostmanager Version | Host (Workstation) Operating System | Guest (VirtualBox) Operating System
+------------|-----------------|-----------------------------|-------------------------------------|--------------------------------------
+03/23/2016  | 1.8.1           | 1.8.1                       | Ubuntu 14.04 LTS                    | CentOS 7.2
+03/22/2016  | 1.8.1           | 1.8.1                       | OS X 10.11.4                        | CentOS 7.2
+05/03/2017  | 1.9.4           | 1.8.6                       | macOS 10.12.4                       | Windows Server 2012 R2
+
+
+Troubleshooting
+-------------
+* Version 1.1 of the plugin prematurely introduced a feature to hook into
+commands other than `vagrant up` and `vagrant destroy`. Version 1.1 broke support
+for some providers. Version 1.2 reverts this feature until a suitable implementation
+supporting all providers is available.
+
+* Potentially breaking change in v1.5.0: the running order on `vagrant up` has changed
+so that hostmanager runs before provisioning takes place.  This ensures all hostnames are 
+available to the guest when it is being provisioned 
+(see [#73](https://github.com/devopsgroup-io/vagrant-hostmanager/issues/73)).
+Previously, hostmanager would run as the very last action.  If you depend on the old behavior, 
+see the [provisioner](#provisioner) section.
+
+
+Contribute
+----------
+To contribute, fork then clone the repository, and then the following:
+
+**Developing**
+
+1. Ideally, install the version of Vagrant as defined in the `Gemfile`
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/)
+2. Currently the Bundler version is locked to 1.14.6, please install this version.
+    * `gem install bundler -v '1.14.6'`
+3. Then install vagrant-hostmanager dependancies:
+    * `bundle _1.14.6_ install`
+
+**Testing**
+
+1. Build and package your newly developed code:
+    * `rake gem:build`
+2. Then install the packaged plugin:
+    * `vagrant plugin install pkg/vagrant-hostmanager-*.gem`
+3. Once you're done testing, roll-back to the latest released version:
+    * `vagrant plugin uninstall vagrant-hostmanager`
+    * `vagrant plugin install vagrant-hostmanager`
+4. Once you're satisfied developing and testing your new code, please submit a pull request for review.
+
+**Releasing**
+
+To release a new version of vagrant-hostmanager you will need to do the following:
+
+*(only contributors of the GitHub repo and owners of the project at RubyGems will have rights to do this)*
+
+1. First, bump, commit, and push the version in ~/lib/vagrant-hostmanager/version.rb:
+    * Follow [Semantic Versioning](http://semver.org/).
+2. Then, create a matching GitHub Release (this will also create a tag):
+    * Preface the version number with a `v`.
+    * https://github.com/devopsgroup-io/vagrant-hostmanager/releases
+3. You will then need to build and push the new gem to RubyGems:
+    * `rake gem:build`
+    * `gem push pkg/vagrant-hostmanager-1.6.1.gem`
+4. Then, when John Doe runs the following, they will receive the updated vagrant-hostmanager plugin:
+    * `vagrant plugin update`
+    * `vagrant plugin update vagrant-hostmanager`

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_helper'
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+namespace :gem do
+  Bundler::GemHelper.install_tasks
+end
+
+task :test do
+  sh 'bash test/test.sh'
+end

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

@@ -0,0 +1,52 @@
+require 'vagrant-hostmanager-rethinc/hosts_file/updater'
+require 'vagrant-hostmanager-rethinc/util'
+
+module VagrantPlugins
+  module HostManager
+    module Action
+      class UpdateAll
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @global_env = @machine.env
+          @provider = @machine.provider_name
+          @config = Util.get_config(@global_env)
+          @updater = HostsFile::Updater.new(@global_env, @provider)
+          @logger = Log4r::Logger.new('vagrant::hostmanager-rethinc::update_all')
+        end
+
+        def call(env)
+          # 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 @config.hostmanager.enabled?
+          @logger.info 'Updating /etc/hosts file automatically'
+
+          @app.call(env)
+
+          # update /etc/hosts file on active machines
+          if @machine.config.hostmanager.manage_guest?
+            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)
+                state = machine.state
+                if ['active','running'].include?(state.short_description)
+                  @updater.update_guest(machine)
+                end
+              end
+            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')
+            @updater.update_host
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require 'vagrant-hostmanager-rethinc/hosts_file/updater'
+require 'vagrant-hostmanager-rethinc/util'
+
+module VagrantPlugins
+  module HostManager
+    module Action
+      class UpdateGuest
+
+        def initialize(app, env)
+          @app = app
+          global_env = env[:global_env]
+          @config = Util.get_config(global_env)
+          @machine = env[:machine]
+          @updater = HostsFile::Updater.new(@machine.env, env[:provider])
+          @logger = Log4r::Logger.new('vagrant::hostmanager-rethinc::update_guest')
+        end
+
+        def call(env)
+          if @config.hostmanager.manage_guest?
+            env[:ui].info I18n.t('vagrant_hostmanager.action.update_guest', {
+              :name => @machine.name
+            })
+            @updater.update_guest(@machine)
+
+            @app.call(env)
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,31 @@
+require 'vagrant-hostmanager-rethinc/action/update_all'
+require 'vagrant-hostmanager-rethinc/action/update_guest'
+require 'vagrant-hostmanager-rethinc/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-rethinc/command.rb

@@ -0,0 +1,44 @@
+module VagrantPlugins
+  module HostManager
+    class Command < Vagrant.plugin('2', :command)
+
+      # Show description when `vagrant list-commands` is triggered
+      def self.synopsis
+        "plugin: vagrant-hostmanager-rethinc: manages the /etc/hosts file within a multi-machine environment"
+      end
+
+      def execute
+        options = {}
+        opts = OptionParser.new do |o|
+          o.banner = 'Usage: vagrant hostmanager-rethinc [vm-name]'
+          o.separator ''
+          o.version = VagrantPlugins::HostManager::VERSION
+          o.program_name = 'vagrant hostmanager-rethinc'
+
+          o.on('--provider provider', String,
+            'Update machines with the specific provider.') do |provider|
+            options[:provider] = provider.to_sym
+          end
+        end
+
+        argv = parse_options(opts)
+        options[:provider] ||= @env.default_provider
+
+        # update /etc/hosts file for specified guest machines
+        with_target_vms(argv, options) do |machine|
+          @env.action_runner.run(Action.update_guest, {
+            :global_env => @env,
+            :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
+end

data/lib/vagrant-hostmanager-rethinc/config.rb

@@ -0,0 +1,85 @@
+module VagrantPlugins
+  module HostManager
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :enabled
+      attr_accessor :manage_host
+      attr_accessor :manage_guest
+      attr_accessor :ignore_private_ip
+      attr_accessor :aliases
+      attr_accessor :include_offline
+      attr_accessor :ip_resolver
+
+      alias_method :enabled?, :enabled
+      alias_method :include_offline?, :include_offline
+      alias_method :manage_host?, :manage_host
+      alias_method :manage_guest?, :manage_guest
+
+      def initialize
+        @enabled            = UNSET_VALUE
+        @manage_host        = UNSET_VALUE
+        @manage_guest       = UNSET_VALUE
+        @ignore_private_ip  = UNSET_VALUE
+        @include_offline    = UNSET_VALUE
+        @aliases            = UNSET_VALUE
+        @ip_resolver        = UNSET_VALUE
+      end
+
+      def finalize!
+        @enabled            = false if @enabled == UNSET_VALUE
+        @manage_host        = false if @manage_host == UNSET_VALUE
+        @manage_guest       = true if @manage_guest == UNSET_VALUE
+        @ignore_private_ip  = false if @ignore_private_ip == UNSET_VALUE
+        @include_offline    = false if @include_offline == UNSET_VALUE
+        @aliases            = [] if @aliases == UNSET_VALUE
+        @ip_resolver        = nil if @ip_resolver == UNSET_VALUE
+
+        @aliases = [ @aliases ].flatten
+      end
+
+      def validate(machine)
+        errors = []
+
+        errors << validate_bool('hostmanager.enabled', @enabled)
+        errors << validate_bool('hostmanager.manage_host', @manage_host)
+        errors << validate_bool('hostmanager.manage_guest', @manage_guest)
+        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) &&
+            !machine.config.hostmanager.aliases.kind_of?(String)
+          errors << I18n.t('vagrant_hostmanager.config.not_an_array_or_string', {
+            :config_key => 'hostmanager.aliases',
+            :is_class   => aliases.class.to_s,
+          })
+        end
+
+        if !machine.config.hostmanager.ip_resolver.nil? &&
+           !machine.config.hostmanager.ip_resolver.kind_of?(Proc)
+          errors << I18n.t('vagrant_hostmanager.config.not_a_proc', {
+            :config_key => 'hostmanager.ip_resolver',
+            :is_class   => ip_resolver.class.to_s,
+          })
+        end
+
+        errors.compact!
+        { "HostManager configuration" => errors }
+      end
+
+      private
+
+      def validate_bool(key, value)
+        if ![TrueClass, FalseClass].include?(value.class) &&
+           value != UNSET_VALUE
+          I18n.t('vagrant_hostmanager.config.not_a_bool', {
+            :config_key => key,
+            :value      => value.class.to_s
+          })
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-hostmanager-rethinc/errors.rb

@@ -0,0 +1,6 @@
+module VagrantPlugins
+  module HostManager
+    module Errors
+    end
+  end
+end