vagrant-goodhosts 1.0.8 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e083ea939c0b8d617df7e7edd73baf1d56fa3b34898009596811ed7741fb7809
-  data.tar.gz: 5dc851d568aef47c267dcddfb6cdc4474887423c3d50a4904ce6b1536d57ca71
+  metadata.gz: 9078c31120178731d174a2aa15a12b957d3057e11816127c0f89a319c1c6a400
+  data.tar.gz: f6fb7224ef9ee4eca57a100eb8cafde6ef684eae61fa9aadbc1160554c6d36f1
 SHA512:
-  metadata.gz: f1da2f9460ac88dd0b98170cba82383d9cde45d9b55ee3f0ab70a8ad73a8ea1aab9204e6babf225a7508f63d566162e11115f2da0b2449a4272e38d8e1ca6cb4
-  data.tar.gz: be40aee11d67c11c296ae6be6570cc6331660fd15091f6731c2c2345b4274482f7fca353889a80421ba40b5918e845ad442c6785b64647f46e877847b007bc7e
+  metadata.gz: 0456d61e925bbf2dbc232c4adbc3767c36722fd1f4708283201c9a654b5d972828b4cfb8c550d41b937da3fc960243f59d7e9bda8c8b4d5f8365aa1cad1db158
+  data.tar.gz: 91abd5a594aa8b79a605f9841725f394511907a477bf879a11cb5331d6ded560854cace147e21797c0350afed9aa44a80bae924c4caffc29a161c801b9ae2601

data/.gitignore

@@ -1,16 +1,35 @@
+# OS-specific
+.DS_Store
+
+# editors
+*.swp
+
+# Bundler/Rubygems
 *.gem
+.bundle
+pkg/*
+tags
+Gemfile.lock
+
+# Vagrant
+.vagrant
+Vagrantfile
+!example_box/Vagrantfile
+
+# RVM files for gemset/ruby setting
+.ruby-*
+.rvmrc
+
 .idea
 *.rbc
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
 doc/
 lib/bundler/man
-pkg
 rdoc
 spec/reports
 test/tmp

data/Gemfile

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

data/README.md

@@ -1,10 +1,10 @@
 # Vagrant::Goodhosts
 
-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.  
+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.goodhosts.remove_on_suspend  = false`, **suspend** and **halt** will not remove them. 
+On **halt**, **destroy**, and **suspend**, those entries will be removed again. By setting the `config.goodhosts.remove_on_suspend  = false`, **suspend** and **halt** will not remove them.
 
 ## Installation
 
@@ -38,7 +38,7 @@ This IP address and the hostname will be used for the entry in the `/etc/hosts`
 
 ### 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.  
+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
@@ -78,15 +78,24 @@ config.goodhosts.remove_on_suspend = false
 
 This disables `vagrant-goodhosts` from running on **suspend** and **halt**.
 
+### Disable file hosts clean
+
+If you want `/etc/hosts` file cleaned add in your `VagrantFile`:
+
+```ruby
+config.goodhosts.disable_clean = false
+```
+
+This enable `vagrant-goodhosts` 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. 
+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_goodhosts`.  
+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_goodhosts`.
 The command path is printed when there are errors with sudo.
 
 For Ubuntu and most Linux environments:
@@ -96,15 +105,15 @@ For Ubuntu and most Linux environments:
 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 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 
+    cacls %SYSTEMROOT%\system32\drivers\etc\hosts /E /G %USERNAME%:W
 
 ## Installing The Development Version
 
@@ -113,7 +122,6 @@ If you would like to install `vagrant-goodhosts` to make contributions or change
 ```shell
 git clone https://github.com/goodhosts/vagrant vagrant-goodhosts
 cd vagrant-goodhosts
-git checkout develop
 ./package.sh
 vagrant plugin install vagrant-goodhosts-*.gem
 ```

data/Rakefile

@@ -1,3 +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-goodhosts/Action/BaseAction.rb

@@ -0,0 +1,39 @@
+module VagrantPlugins
+  module GoodHosts
+    module Action
+      class BaseAction
+        include GoodHosts
+
+        # 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)
+          if not @@completed.key?(self.class.name)
+            run(env)
+            @@completed[self.class.name] = true
+          end
+
+          @app.call(env)
+        end
+
+        def run(env)
+          raise NotImplementedError.new("Must be implemented!")
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,16 +1,9 @@
 module VagrantPlugins
   module GoodHosts
     module Action
-      class RemoveHosts
-        include GoodHosts
+      class RemoveHosts < BaseAction
 
-        def initialize(app, env)
-          @app = app
-          @machine = env[:machine]
-          @ui = env[:ui]
-        end
-
-        def call(env)
+        def run(env)
           machine_action = env[:machine_action]
           if machine_action != :destroy || !@machine.id
             if machine_action != :suspend || false != @machine.config.goodhosts.remove_on_suspend
@@ -22,7 +15,6 @@ module VagrantPlugins
               end
             end
           end
-          @app.call(env)
         end
 
       end

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

@@ -1,20 +1,11 @@
-require_relative "../GoodHosts"
 module VagrantPlugins
   module GoodHosts
     module Action
-      class UpdateHosts
-        include GoodHosts
+      class UpdateHosts < BaseAction
 
-        def initialize(app, env)
-          @app = app
-          @machine = env[:machine]
-          @ui = env[:ui]
-        end
-
-        def call(env)
+        def run(env)
           @ui.info "[vagrant-goodhosts] Checking for host entries"
           addHostEntries()
-          @app.call(env)
         end
 
       end

data/lib/vagrant-goodhosts/GoodHosts.rb

@@ -5,10 +5,6 @@ module VagrantPlugins
   module GoodHosts
     module GoodHosts
       def getIps
-        if Vagrant.has_plugin?("vagrant-hostsupdater")
-          @ui.warn "[vagrant-goodhosts] Warning: The vagrant-hostsupdater plugin is installed, hostsupdater always adds the VM name even if the VagrantFile says not to. This shouldn't cause issues, but if it does, uninstall hostsupdater"
-        end
-
         ips = []
 
         @machine.config.vm.networks.each do |network|
@@ -16,7 +12,7 @@ module VagrantPlugins
           ip = options[:ip] if (key == :private_network || key == :public_network) && options[:goodhosts] != "skip"
           ips.push(ip) if ip
           if options[:goodhosts] == "skip"
-            @ui.info '[vagrant-goodhosts] Skipping adding host entries (config.vm.network goodhosts: "skip" is set)'
+            @ui.info '[vagrant-goodhosts] Skipped adding host entries (config.vm.network goodhosts: "skip" is set)'
           end
 
           @machine.config.vm.provider :hyperv do |v|
@@ -36,7 +32,7 @@ module VagrantPlugins
             end
           end
 
-          
+
         end
         return ips
       end
@@ -83,21 +79,39 @@ module VagrantPlugins
 
         return hostnames
       end
+      
+      def disableClean(ip_address)
+        unless ip_address.nil?
+          return @machine.config.goodhosts.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-goodhosts] Error adding some hosts, no IP was provided for the following hostnames: #{hostnames}"
             next
           end
           if cli.include? ".exe"
-            stdin, stdout, stderr, wait_thr = Open3.popen3("powershell", "-Command", "Start-Process '#{cli}' -ArgumentList \"add\",\"--clean\",\"#{ip_address}\",\"#{hostnames}\" -Verb RunAs")
+            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
-            stdin, stdout, stderr, wait_thr = Open3.popen3("sudo", cli, "add", "--clean", ip_address, hostnames)
+            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
@@ -112,15 +126,26 @@ module VagrantPlugins
         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-goodhosts] Error adding some hosts, no IP was provided for the following hostnames: #{hostnames}"
             next
           end
           if cli.include? ".exe"
-            stdin, stdout, stderr, wait_thr = Open3.popen3("powershell", "-Command", "Start-Process '#{cli}' -ArgumentList \"remove\",\"--clean\",\"#{ip_address}\",\"#{hostnames}\" -Verb RunAs")
+            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
-            stdin, stdout, stderr, wait_thr = Open3.popen3("sudo", cli, "remove", "--clean", ip_address, hostnames)
+            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
@@ -147,25 +172,32 @@ module VagrantPlugins
       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
-            hostnames[ip].each do |hostname|
-              if !ip_address.nil?
-                @ui.info "[vagrant-goodhosts] - found entry for: #{ip_address} #{hostname}"
+            if hostnames[ip].count() > 1
+              hostnames[ip].each do |hostname|
+                if !ip_address.nil?
+                  @ui.info "[vagrant-goodhosts] - found entry for: #{ip_address} #{hostname}"
+                end
               end
+              hostnames_by_ips = { ip_address => hostnames[ip].join(" ") }
             end
-            hostnames_by_ips = { ip_address => hostnames[ip].join(" ") }
           end
         else
           ip_address = ips[0]
-          hostnames[ip_address].each do |hostname|
-            if !ip_address.nil?
-              @ui.info "[vagrant-goodhosts] - found entry for: #{ip_address} #{hostname}"
+          if hostnames[ip_address].count() > 1
+            hostnames[ip_address].each do |hostname|
+              if !ip_address.nil?
+                @ui.info "[vagrant-goodhosts] - found entry for: #{ip_address} #{hostname}"
+              end
             end
+            hostnames_by_ips = { ip_address => hostnames[ip_address].join(" ") }
           end
-          hostnames_by_ips = { ip_address => hostnames[ip_address].join(" ") }
         end
 
         return hostnames_by_ips

data/lib/vagrant-goodhosts/config.rb

@@ -6,6 +6,11 @@ module VagrantPlugins
         attr_accessor :aliases
         attr_accessor :id
         attr_accessor :remove_on_suspend
+        attr_accessor :disable_clean
+        
+        def initialize
+            @disable_clean = true
+        end
     end
   end
 end

data/lib/vagrant-goodhosts/plugin.rb

@@ -1,5 +1,7 @@
-require "vagrant-goodhosts/Action/UpdateHosts"
-require "vagrant-goodhosts/Action/RemoveHosts"
+require_relative "GoodHosts"
+require_relative "Action/BaseAction"
+require_relative "Action/UpdateHosts"
+require_relative "Action/RemoveHosts"
 
 module VagrantPlugins
   module GoodHosts

data/lib/vagrant-goodhosts/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module GoodHosts
-    VERSION = '1.0.8'
+    VERSION = '1.0.13'
   end
 end

data/vagrant-goodhosts.gemspec

@@ -3,22 +3,23 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'vagrant-goodhosts/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = 'vagrant-goodhosts'
-  spec.version       = VagrantPlugins::GoodHosts::VERSION
-  spec.authors       = ['Daniele Scasciafratte']
-  spec.email         = ['mte90net@gmail.com']
-  spec.description   = %q{Enables Vagrant to update hosts file on the host machine with goodhosts}
-  spec.summary       = spec.description
-  spec.homepage      = 'https://github.com/goodhosts/vagrant'
-  spec.license       = 'MIT'
+Gem::Specification.new do |s|
+  s.name          = 'vagrant-goodhosts'
+  s.version       = VagrantPlugins::GoodHosts::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ['Daniele Scasciafratte']
+  s.email         = ['mte90net@gmail.com']
+  s.description   = "Enables Vagrant to update hosts file on the host machine with goodhosts"
+  s.summary       = s.description
+  s.homepage      = 'https://github.com/goodhosts/vagrant'
+  s.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.files     += Dir.glob("lib/vagrant-goodhosts/bundle/*")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  s.files         = `git ls-files`.split($/)
+  s.files        += Dir.glob("lib/vagrant-goodhosts/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']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-goodhosts
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.13
 platform: ruby
 authors:
 - Daniele Scasciafratte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -51,6 +51,7 @@ files:
 - README.md
 - Rakefile
 - lib/vagrant-goodhosts.rb
+- lib/vagrant-goodhosts/Action/BaseAction.rb
 - lib/vagrant-goodhosts/Action/RemoveHosts.rb
 - lib/vagrant-goodhosts/Action/UpdateHosts.rb
 - lib/vagrant-goodhosts/GoodHosts.rb
@@ -81,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.1
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Enables Vagrant to update hosts file on the host machine with goodhosts