vagrant-betterhosts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 674b9ba6010434da286903277af9e899b2d2a982a8a4ce1434b523b460350b53
+  data.tar.gz: 4b635e5ddc088af98faa0c59b200fd9346b01ac0b540ca6a70375f4a01d852cb
+SHA512:
+  metadata.gz: 38c82c8b5344f0cc3d64521746dfdf1bd987f6362468b8fece767aff2ac1a1117d78fca0f30579f331ba38b5e45ee476cdb04ca2d5387a113ac92c6a9a3f7b39
+  data.tar.gz: 37ead61d094950df99c39c10638bf223360d619b3fc0fbd8cc35330884486e3ac1e01d2382cc7994467eaf0b374e9ac1b8fe0a766539f79e86cf10499c94819f

data/.gitignore

@@ -0,0 +1,32 @@
+# OS-specific
+.DS_Store
+
+# editors
+*.swp
+
+# Bundler/Rubygems
+*.gem
+.bundle
+pkg/*
+tags
+
+# Vagrant
+.vagrant
+Vagrantfile
+!example_box/Vagrantfile
+
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bundle/

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Editor-based HTTP Client requests
+/httpRequests/

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="RVM: ruby-2.6.6" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/vagrant-betterhosts.iml" filepath="$PROJECT_DIR$/.idea/vagrant-betterhosts.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vagrant-betterhosts.iml

@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="jdk" jdkName="RVM: ruby-2.7.2 [vagrant-betterhosts]" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bcrypt_pbkdf (v1.0.1, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="builder (v3.2.4, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.1.4, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="childprocess (v4.0.0, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.9, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="domain_name (v0.5.20190701, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ed25519 (v1.2.4, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="erubi (v1.10.0, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ffi (v1.15.1, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="gssapi (v1.3.1, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="gyoku (v1.3.1, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="hashicorp-checkpoint (v0.1.5, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="http-cookie (v1.0.3, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="httpclient (v2.8.3, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="i18n (v1.8.10, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="listen (v3.5.1, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="little-plugger (v1.1.4, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="log4r (v1.1.10, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="logging (v2.3.0, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mime (v0.4.4, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mime-types (v3.3.1, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mime-types-data (v3.2021.0225, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="multi_json (v1.15.0, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="net-scp (v1.2.1, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="net-sftp (v3.0.0, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="net-ssh (v6.1.0, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="netrc (v0.11.0, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="nori (v2.6.0, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rb-fsevent (v0.11.0, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rb-inotify (v0.10.1, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rb-kqueue (v0.2.6, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rest-client (v2.0.2, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby_dep (v1.3.1, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubyntlm (v0.6.3, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubyzip (v2.3.0, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unf (v0.1.4, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unf_ext (v0.0.7.7, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="vagrant (v2.2.11.dev@22795b, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="vagrant_cloud (v2.0.3, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="wdm (v0.1.1, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="winrm (v2.3.6, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="winrm-elevated (v1.2.3, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="winrm-fs (v1.3.5, RVM: ruby-2.7.2 [vagrant-betterhosts]) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake" />
+    </option>
+  </component>
+</module>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.ruby-gemset

@@ -0,0 +1 @@
+vagrant-betterhosts

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.2

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+group :development do
+  gem "vagrant", git: "https://github.com/hashicorp/vagrant.git"
+end
+
+group :plugins do
+  gem "vagrant-betterhosts", path: "."
+end

data/Gemfile.lock

@@ -0,0 +1,120 @@
+GIT
+  remote: https://github.com/hashicorp/vagrant.git
+  revision: 22795b161bf67a4c0ebbe32c9ce8777cb888c4a7
+  specs:
+    vagrant (2.2.11.dev)
+      bcrypt_pbkdf (~> 1.0.0)
+      childprocess (~> 4.0.0)
+      ed25519 (~> 1.2.4)
+      erubi
+      hashicorp-checkpoint (~> 0.1.5)
+      i18n (~> 1.8)
+      listen (~> 3.1)
+      log4r (~> 1.1.9, < 1.1.11)
+      mime (~> 0.4.4)
+      net-scp (~> 1.2.0)
+      net-sftp (~> 3.0)
+      net-ssh (~> 6.0)
+      rb-kqueue (~> 0.2.0)
+      rest-client (>= 1.6.0, < 3.0)
+      ruby_dep (<= 1.3.1)
+      rubyzip (~> 2.0)
+      vagrant_cloud (~> 2.0.3)
+      wdm (~> 0.1.0)
+      winrm (>= 2.3.4, < 3.0)
+      winrm-elevated (>= 1.2.1, < 2.0)
+      winrm-fs (>= 1.3.4, < 2.0)
+
+PATH
+  remote: .
+  specs:
+    vagrant-betterhosts (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bcrypt_pbkdf (1.0.1)
+    builder (3.2.4)
+    childprocess (4.0.0)
+    concurrent-ruby (1.1.9)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ed25519 (1.2.4)
+    erubi (1.10.0)
+    ffi (1.15.1)
+    gssapi (1.3.1)
+      ffi (>= 1.0.1)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    hashicorp-checkpoint (0.1.5)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    httpclient (2.8.3)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    listen (3.5.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    little-plugger (1.1.4)
+    log4r (1.1.10)
+    logging (2.3.0)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.14)
+    mime (0.4.4)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    multi_json (1.15.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-sftp (3.0.0)
+      net-ssh (>= 5.0.0, < 7.0.0)
+    net-ssh (6.1.0)
+    netrc (0.11.0)
+    nori (2.6.0)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rb-kqueue (0.2.6)
+      ffi (>= 0.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    ruby_dep (1.3.1)
+    rubyntlm (0.6.3)
+    rubyzip (2.3.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    vagrant_cloud (2.0.3)
+      rest-client (~> 2.0.2)
+    wdm (0.1.1)
+    winrm (2.3.6)
+      builder (>= 2.1.2)
+      erubi (~> 1.8)
+      gssapi (~> 1.2)
+      gyoku (~> 1.0)
+      httpclient (~> 2.2, >= 2.2.0.2)
+      logging (>= 1.6.1, < 3.0)
+      nori (~> 2.0)
+      rubyntlm (~> 0.6.0, >= 0.6.3)
+    winrm-elevated (1.2.3)
+      erubi (~> 1.8)
+      winrm (~> 2.0)
+      winrm-fs (~> 1.0)
+    winrm-fs (1.3.5)
+      erubi (~> 1.8)
+      logging (>= 1.6.1, < 3.0)
+      rubyzip (~> 2.0)
+      winrm (~> 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  vagrant!
+  vagrant-betterhosts!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright 2018 Chris Smith
+
+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,127 @@
+# Vagrant::Betterhosts
+
+This vagrant plugin adds host file entries to the host pointing to the guest VM, using the [GoodHosts](https://github.com/goodhosts/cli) cli tool. This plugin is based on [vagrant-hostsupdater](https://github.com/cogitatio/vagrant-hostsupdater) and aims to be compatible with the same config parameters.
+
+On **up**, **resume** and **reload** commands, it tries to add the hosts if they do not already exist in your hosts file. If it needs to be added, you will be asked for the `sudo` password to make the necessary edits.
+
+On **halt**, **destroy**, and **suspend**, those entries will be removed again. By setting the `config.betterhosts.remove_on_suspend  = false`, **suspend** and **halt** will not remove them.
+
+## Installation
+
+```shell
+vagrant plugin install vagrant-betterhosts
+```
+
+To uninstall :
+
+```shell
+vagrant plugin uninstall vagrant-betterhosts
+```
+
+To update the plugin:
+
+```shell
+vagrant plugin update vagrant-betterhosts
+```
+
+## Usage
+
+You currently only need the `hostname` and a `:private_network` network with a fixed IP address.
+
+```ruby
+config.vm.network :private_network, ip: "192.168.3.10"
+config.vm.hostname = "www.testing.de" # This is not used by the plugin
+config.betterhosts.aliases = ["alias.testing.de", "alias2.somedomain.com"]
+```
+
+This IP address and the hostname will be used for the entry in the `/etc/hosts` file.
+
+### vagrant-hostsupdater conflicts
+
+The original plugin has the issue of be executed in any vagrant environment, also that is not using and will add a rule in the hosts file that is not generated by this one.
+To avoid issues is better to remove that plugin and in case update accordingly the Vagrantfile if use it. Require just a change of the reference of the plugin name as the example above.
+
+### Multiple private network adapters
+
+If you have multiple network adapters i.e.:
+
+```ruby
+config.vm.network :private_network, ip: "10.0.0.1"
+config.vm.network :private_network, ip: "10.0.0.2"
+```
+
+You can specify which hostnames are bound to which IP by passing a hash mapping the IP of the network to an array of hostnames to create, e.g.:
+
+```ruby
+config.betterhosts.aliases = {
+    '10.0.0.1' => ['foo.com', 'bar.com'],
+    '10.0.0.2' => ['baz.com', 'bat.com']
+}
+```
+
+This will produce `/etc/hosts` entries like so:
+
+```
+10.0.0.1 foo.com
+10.0.0.1 bar.com
+10.0.0.2 baz.com
+10.0.0.2 bat.com
+```
+
+### Keeping Host Entries After Suspend/Halt
+
+To keep your `/etc/hosts` file unchanged simply add the line below to your `VagrantFile`:
+
+```ruby
+config.betterhosts.remove_on_suspend = false
+```
+
+This disables `vagrant-betterhosts` from running on **suspend** and **halt**.
+
+### Disable file hosts clean
+
+If you want `/etc/hosts` file cleaned add in your `VagrantFile`:
+
+```ruby
+config.betterhosts.disable_clean = false
+```
+
+This enable `vagrant-betterhosts` from running the clean command in every call.
+
+## Suppressing prompts for elevating privileges
+
+These prompts exist to prevent anything that is being run by the user from inadvertently updating the hosts file.
+If you understand the risks that go with supressing them, here's how to do it.
+
+### Linux/OS X: Passwordless sudo
+
+To allow vagrant to automatically update the hosts file without asking for a sudo password, add one of the following snippets to a new sudoers file include, i.e. `sudo visudo -f /etc/sudoers.d/vagrant_betterhosts`.
+The command path is printed when there are errors with sudo.
+
+For Ubuntu and most Linux environments:
+
+    %sudo ALL=(root) NOPASSWD: [the-path]
+
+For MacOS:
+
+    %admin ALL=(root) NOPASSWD: [the-path]
+
+Replace in both %sudo/%admin with the username it if it is not working for you.
+
+### Windows: UAC Prompt
+
+You can use `cacls` or `icacls` to grant your user account permanent write permission to the system's hosts file.
+You have to open an elevated command prompt; hold `❖ Win` and press `X`, then choose "Command Prompt (Admin)"
+
+    cacls %SYSTEMROOT%\system32\drivers\etc\hosts /E /G %USERNAME%:W
+
+## Installing The Development Version
+
+If you would like to install `vagrant-betterhosts` to make contributions or changes, run the following commands::
+
+```shell
+git clone https://github.com/ajxb/vagrant-betterhosts vagrant-betterhosts
+cd vagrant-betterhosts
+./package.sh
+vagrant plugin install vagrant-betterhosts-*.gem
+```

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+
+# 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

data/lib/vagrant-betterhosts.rb

@@ -0,0 +1,11 @@
+require "vagrant-betterhosts/version"
+require "vagrant-betterhosts/plugin"
+
+module VagrantPlugins
+  module BetterHosts
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end
+

data/lib/vagrant-betterhosts/Action/BaseAction.rb

@@ -0,0 +1,45 @@
+module VagrantPlugins
+  module BetterHosts
+    module Action
+      class BaseAction
+        include BetterHosts
+
+        # Vagrant 2.2.14 has changed the hooks execution policy so they
+        # started to be triggered more than once (a lot actually) which
+        # is non-performant and floody. With this static property, we
+        # control the executions and allowing just one.
+        #
+        # - https://github.com/hashicorp/vagrant/issues/12070#issuecomment-732271918
+        # - https://github.com/hashicorp/vagrant/compare/v2.2.13..v2.2.14#diff-4d1af7c67af870f20d303c3c43634084bab8acc101055b2e53ddc0d07f6f64dcL176-L180
+        # - https://github.com/goodhosts/vagrant/issues/25
+        @@completed = {}
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @ui = env[:ui]
+        end
+
+        def call(env)
+          # Check whether the plugin has been executed for a particular
+          # VM as it may happen that a single Vagrantfile defines multiple
+          # machines and having a static flag will result in a plugin being
+          # executed just once.
+          # https://github.com/goodhosts/vagrant/issues/30
+          @@completed[@machine.name] = [] unless @@completed.key?(@machine.name)
+          unless @@completed[@machine.name].include? self.class.name
+            run(env)
+            @@completed[@machine.name] << self.class.name
+          end
+
+          @app.call(env)
+        end
+
+        def run(env)
+          raise NotImplementedError.new("Must be implemented!")
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-betterhosts/Action/RemoveHosts.rb

@@ -0,0 +1,23 @@
+module VagrantPlugins
+  module BetterHosts
+    module Action
+      class RemoveHosts < BaseAction
+
+        def run(env)
+          machine_action = env[:machine_action]
+
+          return unless @machine.id
+          return unless %i[destroy halt suspend].include? machine_action
+
+          if (%i[halt suspend].include? machine_action) && (false == @machine.config.goodhosts.remove_on_suspend)
+            @ui.info '[vagrant-betterhosts] Removing hosts on suspend disabled'
+          else
+            @ui.info '[vagrant-betterhosts] Removing hosts'
+            removeHostEntries
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-betterhosts/Action/UpdateHosts.rb

@@ -0,0 +1,14 @@
+module VagrantPlugins
+  module BetterHosts
+    module Action
+      class UpdateHosts < BaseAction
+
+        def run(env)
+          @ui.info "[vagrant-betterhosts] Checking for host entries"
+          addHostEntries()
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-betterhosts/BetterHosts.rb

@@ -0,0 +1,212 @@
+require "rbconfig"
+require "open3"
+
+module VagrantPlugins
+  module BetterHosts
+    module BetterHosts
+      def getIps
+        ips = []
+
+        if @machine.config.vm.networks.length == 0
+            @ui.error("[vagrant-betterhosts] No ip address found for this virtual machine")
+            exit
+        end
+        
+        @machine.config.vm.networks.each do |network|
+          key, options = network[0], network[1]
+          ip = options[:ip] if (key == :private_network || key == :public_network) && options[:betterhosts] != "skip"
+          ips.push(ip) if ip
+          if options[:betterhosts] == "skip"
+            @ui.info '[vagrant-betterhosts] Skipped adding host entries (config.vm.network betterhosts: "skip" is set)'
+          end
+
+          @machine.config.vm.provider :hyperv do |v|
+            timeout = @machine.provider_config.ip_address_timeout
+            @ui.output("[vagrant-betterhosts] Waiting for the guest machine to report its IP address ( this might take some time, have patience )...")
+            @ui.detail("Timeout: #{timeout} seconds")
+
+            options = {
+              vmm_server_address: @machine.provider_config.vmm_server_address,
+              proxy_server_address: @machine.provider_config.proxy_server_address,
+              timeout: timeout,
+              machine: @machine,
+            }
+            network = @machine.provider.driver.read_guest_ip(options)
+            if network["ip"]
+              ips.push(network["ip"]) unless ips.include? network["ip"]
+            end
+          end
+
+
+        end
+        return ips
+      end
+
+      # https://stackoverflow.com/a/13586108/1902215
+      def get_os_binary
+        return os ||= (host_os = RbConfig::CONFIG["host_os"]
+                 case host_os
+               when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+                 :'cli.exe'
+               when /darwin|mac os/
+                 :'cli_osx'
+               when /linux/
+                 :'cli'
+               else
+                 raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
+               end)
+      end
+
+      def get_cli
+        binary = get_os_binary
+        path = File.expand_path(File.dirname(File.dirname(__FILE__))) + "/vagrant-betterhosts/bundle/"
+        path = "#{path}#{binary}"
+
+        return path
+      end
+
+      # Get a hash of hostnames indexed by ip, e.g. { 'ip1': ['host1'], 'ip2': ['host2', 'host3'] }
+      def getHostnames(ips)
+        hostnames = Hash.new { |h, k| h[k] = [] }
+
+        case @machine.config.betterhosts.aliases
+        when Array
+          # simple list of aliases to link to all ips
+          ips.each do |ip|
+            hostnames[ip] += @machine.config.betterhosts.aliases
+          end
+        when Hash
+          # complex definition of aliases for various ips
+          @machine.config.betterhosts.aliases.each do |ip, hosts|
+            hostnames[ip] += Array(hosts)
+          end
+        end
+
+        return hostnames
+      end
+      
+      def disableClean(ip_address)
+        unless ip_address.nil?
+          return @machine.config.betterhosts.disable_clean
+        end
+        return true
+      end
+
+      def addHostEntries
+        error = false
+        errorText = ""
+        cli = get_cli
+        hostnames_by_ips = generateHostnamesByIps
+        
+        return if not hostnames_by_ips.any?
+
+        hostnames_by_ips.each do |ip_address, hostnames|
+          if ip_address.nil?
+            @ui.error "[vagrant-betterhosts] Error adding some hosts, no IP was provided for the following hostnames: #{hostnames}"
+            next
+          end
+          if cli.include? ".exe"
+            clean = "\"--clean\","
+            if disableClean(ip_address)
+                clean = ''
+            end
+            stdin, stdout, stderr, wait_thr = Open3.popen3("powershell", "-Command", "Start-Process '#{cli}' -ArgumentList \"add\",#{clean}\"#{ip_address}\",\"#{hostnames}\" -Verb RunAs")
+          else
+            clean = "--clean"
+            if disableClean(ip_address)
+                clean = ''
+            end
+            stdin, stdout, stderr, wait_thr = Open3.popen3("sudo '#{cli}' add #{clean} #{ip_address} #{hostnames}")
+          end
+          if !wait_thr.value.success?
+            error = true
+            errorText = stderr.read.strip
+          end
+        end
+        printReadme(error, errorText)
+      end
+
+      def removeHostEntries
+        error = false
+        errorText = ""
+        cli = get_cli
+        hostnames_by_ips = generateHostnamesByIps
+
+        return if not hostnames_by_ips.any?
+
+        hostnames_by_ips.each do |ip_address, hostnames|
+          if ip_address.nil?
+            @ui.error "[vagrant-betterhosts] Error adding some hosts, no IP was provided for the following hostnames: #{hostnames}"
+            next
+          end
+          if cli.include? ".exe"
+            clean = "\"--clean\","
+            if disableClean(ip_address)
+                clean = ''
+            end
+            stdin, stdout, stderr, wait_thr = Open3.popen3("powershell", "-Command", "Start-Process '#{cli}' -ArgumentList \"remove\",#{clean}\"#{ip_address}\",\"#{hostnames}\" -Verb RunAs")
+          else
+            clean = "\"--clean\","
+            if disableClean(ip_address)
+                clean = ''
+            end
+            stdin, stdout, stderr, wait_thr = Open3.popen3("sudo '#{cli}' remove #{clean} #{ip_address} #{hostnames}")
+          end
+          if !wait_thr.value.success?
+            error = true
+            errorText = stderr.read.strip
+          end
+        end
+        printReadme(error, errorText)
+      end
+
+      def printReadme(error, errorText)
+        if error
+          cli = get_cli
+          @ui.error "[vagrant-betterhosts] Issue executing goodhosts CLI: #{errorText}"
+          @ui.error "[vagrant-betterhosts] Cli path: #{cli}"
+          if cli.include? ".exe"
+            @ui.error "[vagrant-betterhosts] Check the readme at https://github.com/ajxb/vagrant-betterhosts#windows-uac-prompt"
+            exit
+          else
+            @ui.error "[vagrant-betterhosts] Check the readme at https://github.com/ajxb/vagrant-betterhosts#passwordless-sudo"
+          end
+        end
+      end
+
+      def generateHostnamesByIps()
+        hostnames_by_ips = []
+        ips = getIps
+        if ips.count() < 1
+          return hostnames_by_ips
+        end
+        hostnames = getHostnames(ips)
+        if ips.count() > 1
+          ips.each do |ip|
+            ip_address = ip
+            if hostnames[ip].count() > 0
+              hostnames[ip].each do |hostname|
+                if !ip_address.nil?
+                  @ui.info "[vagrant-betterhosts] - found entry for: #{ip_address} #{hostname}"
+                end
+              end
+              hostnames_by_ips = { ip_address => hostnames[ip].join(" ") }
+            end
+          end
+        else
+          ip_address = ips[0]
+          if hostnames[ip_address].count() > 0
+            hostnames[ip_address].each do |hostname|
+              if !ip_address.nil?
+                @ui.info "[vagrant-betterhosts] - found entry for: #{ip_address} #{hostname}"
+              end
+            end
+            hostnames_by_ips = { ip_address => hostnames[ip_address].join(" ") }
+          end
+        end
+
+        return hostnames_by_ips
+      end
+    end
+  end
+end

data/lib/vagrant-betterhosts/config.rb

@@ -0,0 +1,17 @@
+require "vagrant"
+
+module VagrantPlugins
+  module BetterHosts
+    class Config < Vagrant.plugin("2", :config)
+      attr_accessor :aliases
+      attr_accessor :id
+      attr_accessor :remove_on_suspend
+      attr_accessor :disable_clean
+
+      def initialize
+        @remove_on_suspend = true
+        @disable_clean = true
+      end
+    end
+  end
+end

data/lib/vagrant-betterhosts/plugin.rb

@@ -0,0 +1,51 @@
+require_relative "BetterHosts"
+require_relative "Action/BaseAction"
+require_relative "Action/UpdateHosts"
+require_relative "Action/RemoveHosts"
+
+module VagrantPlugins
+  module BetterHosts
+    class Plugin < Vagrant.plugin('2')
+      name 'BetterHosts'
+      description <<-DESC
+        This plugin manages the /etc/hosts file for the host machine. An entry is
+        created for the hostname attribute in the vm.config.
+      DESC
+
+      config(:betterhosts) do
+        require_relative 'config'
+        Config
+      end
+
+      action_hook(:betterhosts, :machine_action_up) do |hook|
+        hook.append(Action::UpdateHosts)
+      end
+
+      action_hook(:betterhosts, :machine_action_provision) do |hook|
+        hook.before(Vagrant::Action::Builtin::Provision, Action::UpdateHosts)
+      end
+
+      action_hook(:betterhosts, :machine_action_halt) do |hook|
+        hook.append(Action::RemoveHosts)
+      end
+
+      action_hook(:betterhosts, :machine_action_suspend) do |hook|
+        hook.append(Action::RemoveHosts)
+      end
+
+      action_hook(:betterhosts, :machine_action_destroy) do |hook|
+        hook.append(Action::RemoveHosts)
+      end
+
+      action_hook(:betterhosts, :machine_action_reload) do |hook|
+        hook.prepend(Action::RemoveHosts)
+        hook.append(Action::UpdateHosts)
+      end
+
+      action_hook(:betterhosts, :machine_action_resume) do |hook|
+        hook.prepend(Action::RemoveHosts)
+        hook.append(Action::UpdateHosts)
+      end
+    end
+  end
+end

data/lib/vagrant-betterhosts/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module BetterHosts
+    VERSION = '0.1.0'
+  end
+end

data/package.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+mkdir -p ./lib/vagrant-betterhosts/bundle
+cd ./lib/vagrant-betterhosts/bundle
+# Download
+curl -s https://api.github.com/repos/goodhosts/cli/releases/latest | jq --raw-output '.assets[] | .browser_download_url' | xargs wget -i
+# Extract
+tar -zxvf goodhosts_darwin_amd64.tar.gz goodhosts && mv goodhosts cli_osx
+tar -zxvf goodhosts_linux_amd64.tar.gz goodhosts && mv goodhosts cli
+tar -zxvf goodhosts_windows_amd64.tar.gz goodhosts.exe && mv goodhosts.exe cli.exe
+rm -f ./*.tar.gz
+rm -f ./*.txt
+# Generate
+cd ../../../
+gem build vagrant-betterhosts.gemspec

data/vagrant-betterhosts.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-betterhosts/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'vagrant-betterhosts'
+  s.version       = VagrantPlugins::BetterHosts::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ['Adam Butler']
+  s.email         = ['adam.j.butler@protonmail.com']
+  s.description   = 'Enables Vagrant to update hosts file on the host machine using the goodhosts cli tool'
+  s.summary       = 'Vagrant plugin to manage the hosts file on the host machine'
+  s.homepage      = 'https://github.com/ajxb/vagrant-betterhosts'
+  s.license       = 'MIT'
+
+  s.required_ruby_version = "~> 2.5", "< 2.8"
+  s.files                 = `git ls-files`.split($/)
+  s.files                += Dir.glob("lib/vagrant-betterhosts/bundle/*")
+  s.executables           = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files            = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths         = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake', '~> 13.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-betterhosts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Butler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-19 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: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Enables Vagrant to update hosts file on the host machine using the goodhosts
+  cli tool
+email:
+- adam.j.butler@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.gitignore"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vagrant-betterhosts.iml"
+- ".idea/vcs.xml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-betterhosts.rb
+- lib/vagrant-betterhosts/Action/BaseAction.rb
+- lib/vagrant-betterhosts/Action/RemoveHosts.rb
+- lib/vagrant-betterhosts/Action/UpdateHosts.rb
+- lib/vagrant-betterhosts/BetterHosts.rb
+- lib/vagrant-betterhosts/bundle/cli
+- lib/vagrant-betterhosts/bundle/cli.exe
+- lib/vagrant-betterhosts/bundle/cli_osx
+- lib/vagrant-betterhosts/config.rb
+- lib/vagrant-betterhosts/plugin.rb
+- lib/vagrant-betterhosts/version.rb
+- package.sh
+- vagrant-betterhosts.gemspec
+homepage: https://github.com/ajxb/vagrant-betterhosts
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '2.8'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Vagrant plugin to manage the hosts file on the host machine
+test_files: []