vagrant-virtual-hostsupdater 1.1.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6aca82124501a1c94a59ccee3849e3c43bfa5049
-  data.tar.gz: 8bf2e43df77ad8a3951e95ce848267aaae4f1993
+SHA256:
+  metadata.gz: cf3391d6244305c873b8834efcf5b5e5c893e7baa370e5104d28902b96e76597
+  data.tar.gz: 86a47931ca6969f238aad159bdcae64b580e7997cc77536643d5e082364813ef
 SHA512:
-  metadata.gz: 6224d8d17cbdcc211aee1848357e8b12506946202ebdc92998bde5ec0ae5ee86923ebdc8de175727796255ad88e6de8973a2f8b36443d9aa7f9d54e8aba113cf
-  data.tar.gz: 16796cfb0cdd4870028ff230ef783a144ebc06fd398ca0b27a873c7a6146251fa0bbc6195d2c06ebd186c7bf2ccafd3592aae4e03aa5e1844c8ef1a1b94c47af
+  metadata.gz: 907a8beaa9333e35530a92248e07f82dda257e82cecd7c118f07ea79de50766422b722bb1f18d2766d592ad6fc115ff98e6ecc8f77a46e5e9a83e43b8a06e422
+  data.tar.gz: ed97599fa8b29267a0798dc6a6a9b9fdaf29d90ccf28b98524ee9eee21598fa4598b8f104e07854e48830f07c3ab65bc4d3fda488304f3c37bd69b6a3e99f96c

data/Gemfile

@@ -1,7 +1,7 @@
 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/mitchellh/vagrant.git', :tag => 'v2.2.19'
 end
 
 group :plugins do

data/README.md

@@ -10,10 +10,10 @@
 
 This plugin adds an entry to your /etc/hosts file on the host system.
 
-On **up**, **resume** and **reload** commands, it tries to add the information, if it does not already exist in your hosts file. If it needs to be added, you will be asked for an administrator password, since it uses sudo to edit the file.
+On **up**, **resume** and **reload** commands, it tries to add the information, if its not already existant in your hosts file. If it needs to be added, you will be asked for an administrator password, since it uses sudo to edit the file.
 
 On **halt**, **destroy**, and **suspend**, those entries will be removed again.
-By setting the `config.hostsupdater.remove_on_suspend  = false`, **suspend** and **halt** will not remove them. 
+By setting the `config.virtualhostsupdater.remove_on_suspend  = false`, **suspend** and **halt** will not remove them. 
 
 
 ## Installation
@@ -34,7 +34,7 @@ You currently only need the `hostname` and a `:private_network` network with a f
 
     config.vm.network :private_network, ip: "192.168.3.10"
     config.vm.hostname = "www.testing.de"
-    config.hostsupdater.aliases = ["alias.testing.de", "alias2.somedomain.com"]
+    config.virtualhostsupdater.aliases = ["alias.testing.de", "alias2.somedomain.com"]
 
 This IP address and the hostname will be used for the entry in the `/etc/hosts` file.
 
@@ -47,7 +47,7 @@ If you have multiple network adapters i.e.:
 
 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.:
 
-    config.hostsupdater.aliases = {
+    config.virtualhostsupdater.aliases = {
         '10.0.0.1' => ['foo.com', 'bar.com'],
         '10.0.0.2' => ['baz.com', 'bat.com']
     }
@@ -77,65 +77,22 @@ Example:
 
 To keep your /etc/hosts file unchanged simply add the line below to your `VagrantFile`:
 
-    config.hostsupdater.remove_on_suspend = false
+    config.virtualhostsupdater.remove_on_suspend = false
     
 This disables vagrant-hostsupdater from running on **suspend** and **halt**.
         
 
-## Suppressing prompts for elevating privileges
+## Passwordless sudo
 
-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_hostsupdater`.
-
-For Ubuntu and most Linux environments:
-
-    # Allow passwordless startup of Vagrant with vagrant-hostsupdater.
-    Cmnd_Alias VAGRANT_HOSTS_ADD = /bin/sh -c echo "*" >> /etc/hosts
-    Cmnd_Alias VAGRANT_HOSTS_REMOVE = /bin/sed -i -e /*/ d /etc/hosts
-    %sudo ALL=(root) NOPASSWD: VAGRANT_HOSTS_ADD, VAGRANT_HOSTS_REMOVE
-
-For MacOS:
+Add the following snippet to the top of the sudoers file using `sudo visudo`. It will make vagrant
+stop asking password when updating hosts file:
 
     # Allow passwordless startup of Vagrant with vagrant-hostsupdater.
     Cmnd_Alias VAGRANT_HOSTS_ADD = /bin/sh -c echo "*" >> /etc/hosts
     Cmnd_Alias VAGRANT_HOSTS_REMOVE = /usr/bin/sed -i -e /*/ d /etc/hosts
     %admin ALL=(root) NOPASSWD: VAGRANT_HOSTS_ADD, VAGRANT_HOSTS_REMOVE
     
-- If vagrant still asks for a password on commands that trigger the `VAGRANT_HOSTS_ADD` alias above (like **up**), you might need to wrap the echo statement in quotes, i.e. `Cmnd_Alias VAGRANT_HOSTS_ADD = /bin/sh -c 'echo "*" >> /etc/hosts'`. This seems to be a problem with older versions of Linux and MacOS.
-- If vagrant still asks for a password on commands that trigger the `VAGRANT_HOSTS_REMOVE` alias above (like
-**halt** or **suspend**), this might indicate that the location of **sed** in the `VAGRANT_HOSTS_REMOVE` alias is
-pointing to the wrong location. The solution is to find the location of **sed** (ex. `which sed`) and
-replace that location in the `VAGRANT_HOSTS_REMOVE` alias.
-    
-### 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 
-
-## Using AWS as a Provider
-
-If you'd like AWS as a provider using [vagrant-aws](https://github.com/mitchellh/vagrant-aws) or other plugin,
-this plugin will detect the instance public IP by the tag infomations.  
-For example, [vagrant-aws](https://github.com/mitchellh/vagrant-aws) configures a tag infomations like the following.
-
-    config.vm.provider :aws do |aws, override|
-      aws.tags = {
-        "Name" => "vagrant",
-        ...
-      }
-      aws.elastic_ip = true
-      ...
-    end
-
-* [AWS CLI](https://aws.amazon.com/cli/) is required
-* The tag informations be unique for the instance
-* Enable Elastic IP for the instance
+        
 
 ## Installing development version
 
@@ -160,21 +117,16 @@ vagrant plugin install vagrant-hostsupdater-*.gem
 
 ## Versions
 
-### 1.1.2
-TODO: gseng
+### 1.4.0
+
+* Avoid duplicated hosts update entries
+
+### 1.3.0
 
-### 1.1.1
-* Bugfix: AWS Feature broke part of the code [#155](/../../issues/155)
+* Fix issue with Vagrant versions > 2.2.7
 
-### 1.1.0
-* Feature: Added AWS support [#74](/../../pull/74)
-* Feature: Added libvirt provider [#122](/../../pull/122)
-* Feature: Add support for multiple private network adapters [#96](/../../pull/96)
-* Feature: Add support for VMs without private/public networking [#23](/../../issues/23)
-* Feature: Add Docker support [#149](/../../pull/149)
-* Bugfix: Windows users get UAC prompt [#40](/../../issues/40)
-* Bugfix: Documentation update and type fix
-* Misc: Added a note about suppressing UAC prompts
+### 1.2.0
+* Have multiple private network support working cross-platform
 
 ### 1.0.2
 * Feature: Added `remove_on_suspend` for `vagrant_halt` [#71](/../../issues/71)
@@ -223,4 +175,4 @@ TODO: gseng
 * fixed problem with removing hosts entries on destroy command (Thanks to Andy Bohne)
 
 ### 0.0.3
-* added aliases config option to define additional hostnames
+* added aliases config option to define additional hostnames

data/lib/vagrant-virtual-hostsupdater/Action/BaseAction.rb

@@ -0,0 +1,44 @@
+module VagrantPlugins
+  module VirtualHostsUpdater
+    module Action
+      class BaseAction
+        include VirtualHostsUpdater
+
+        # 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/agiledivider/vagrant-hostsupdater/issues/187
+        @@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/agiledivider/vagrant-hostsupdater/issues/198
+          if @machine.id and not @@completed.key?("#{self.class.name}-#{@machine.name}")
+            run(env)
+            @@completed["#{self.class.name}-#{@machine.name}"] = true
+          end
+
+          @app.call(env)
+        end
+
+        def run(env)
+          raise NotImplementedError.new("Must be implemented!")
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-virtual-hostsupdater/Action/CacheHosts.rb

@@ -1,17 +1,10 @@
 module VagrantPlugins
   module VirtualHostsUpdater
     module Action
-      class CacheHosts
-        include VirtualHostsUpdater
+      class CacheHosts < BaseAction
 
-        def initialize(app, env)
-          @app = app
-          @machine = env[:machine]
-        end
-
-        def call(env)
+        def run(env)
           cacheHostEntries
-          @app.call(env)
         end
 
       end

data/lib/vagrant-virtual-hostsupdater/Action/RemoveHosts.rb

@@ -1,28 +1,21 @@
 module VagrantPlugins
   module VirtualHostsUpdater
     module Action
-      class RemoveHosts
-        include VirtualHostsUpdater
+      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.virtualhostsupdater.remove_on_suspend
-              if machine_action != :halt || false != @machine.config.virtualhostsupdater.remove_on_suspend
-                @ui.info "[vagrant-virtual-hostsupdater] Removing hosts"
-                removeHostEntries
-              else
-                @ui.info "[vagrant-virtual-hostsupdater] Removing hosts on suspend disabled"
-              end
+          if [:suspend, :halt].include? machine_action
+            if @machine.config.virtualhostsupdater.remove_on_suspend == false
+              @ui.info "[vagrant-virtual-hostsupdater] Not removing hosts (remove_on_suspend false)"
+            else
+              @ui.info "[vagrant-virtual-hostsupdater] Removing hosts on suspend"
+              removeHostEntries
             end
+          else
+            @ui.info "[vagrant-virtual-hostsupdater] Removing hosts"
+            removeHostEntries
           end
-          @app.call(env)
         end
 
       end

data/lib/vagrant-virtual-hostsupdater/Action/UpdateHosts.rb

@@ -1,24 +1,14 @@
-require_relative "../VirtualHostsUpdater"
 module VagrantPlugins
   module VirtualHostsUpdater
     module Action
-      class UpdateHosts
-        include VirtualHostsUpdater
+      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-virtual-hostsupdater] Checking for host entries"
           addHostEntries()
-          @app.call(env)
         end
 
       end
     end
   end
-end
+end

data/lib/vagrant-virtual-hostsupdater/VirtualHostsUpdater.rb

@@ -1,14 +1,7 @@
-require 'open3'
-
 module VagrantPlugins
   module VirtualHostsUpdater
     module VirtualHostsUpdater
-      if ENV['VAGRANT_HOSTSUPDATER_PATH']
-        @@hosts_path = ENV['VAGRANT_HOSTSUPDATER_PATH']
-      else
-        @@hosts_path = Vagrant::Util::Platform.windows? ? File.expand_path('system32/drivers/etc/hosts', ENV['windir']) : '/etc/hosts'
-      end
-      @isWindowsHost = Vagrant::Util::Platform.windows?
+      @@hosts_path = Vagrant::Util::Platform.windows? ? File.expand_path('system32/drivers/etc/hosts', ENV['windir']) : '/etc/hosts'
 
       # Get a hash of hostnames indexed by ip, e.g. { 'ip1': ['host1'], 'ip2': ['host2', 'host3'] }
       def getHostnames()
@@ -20,8 +13,6 @@ module VagrantPlugins
           # complex definition of aliases for various ips
           @machine.config.virtualhostsupdater.aliases.each do |ip, hosts|
             hostnames[ip] += Array(hosts)
-        # else
-        #   @ui.error "[vagrant-virtual-hostsupdater] this version only supports the hash format!"
           end
         end
 
@@ -62,9 +53,9 @@ module VagrantPlugins
         file = File.open(@@hosts_path, "rb")
         hostsContents = file.read
         uuid = @machine.id || @machine.config.virtualhostsupdater.id
-        hashedId = Digest::MD5.hexdigest(uuid)
+        hashedId = Digest::MD5.hexdigest(uuid.to_s)
         if hostsContents.match(/#{hashedId}/)
-          removeFromHosts
+            removeFromHosts
         end
       end
 
@@ -89,24 +80,15 @@ module VagrantPlugins
 
         @ui.info "[vagrant-virtual-hostsupdater] Writing the following entries to (#@@hosts_path)"
         @ui.info "[vagrant-virtual-hostsupdater]   " + entries.join("\n[vagrant-virtual-hostsupdater]   ")
+        @ui.info "[vagrant-virtual-hostsupdater] This operation requires administrative access. You may " +
+          "skip it by manually adding equivalent entries to the hosts file."
         if !File.writable_real?(@@hosts_path)
-          @ui.info "[vagrant-virtual-hostsupdater] This operation requires administrative access. You may " +
-                       "skip it by manually adding equivalent entries to the hosts file."
           if !sudo(%Q(sh -c 'echo "#{content}" >> #@@hosts_path'))
             @ui.error "[vagrant-virtual-hostsupdater] Failed to add hosts, could not use sudo"
             adviseOnSudo
           end
-        elsif Vagrant::Util::Platform.windows?
-          require 'tmpdir'
-          uuid = @machine.id || @machine.config.virtualhostsupdater.id
-          tmpPath = File.join(Dir.tmpdir, 'hosts-' + uuid + '.cmd')
-          File.open(tmpPath, "w") do |tmpFile|
-          entries.each { |line| tmpFile.puts(">>\"#{@@hosts_path}\" echo #{line}") }
-          end
-          sudo(tmpPath)
-          File.delete(tmpPath)
         else
-          content = "\n" + content + "\n"
+          content = "\n" + content
           hostsFile = File.open(@@hosts_path, "a")
           hostsFile.write(content)
           hostsFile.close()
@@ -115,8 +97,8 @@ module VagrantPlugins
 
       def removeFromHosts(options = {})
         uuid = @machine.id || @machine.config.virtualhostsupdater.id
-        hashedId = Digest::MD5.hexdigest(uuid)
-        if !File.writable_real?(@@hosts_path) || Vagrant::Util::Platform.windows?
+        hashedId = Digest::MD5.hexdigest(uuid.to_s)
+        if !File.writable_real?(@@hosts_path)
           if !sudo(%Q(sed -i -e '/#{hashedId}/ d' #@@hosts_path))
             @ui.error "[vagrant-virtual-hostsupdater] Failed to remove hosts, could not use sudo"
             adviseOnSudo
@@ -126,26 +108,23 @@ module VagrantPlugins
           File.open(@@hosts_path).each do |line|
             hosts << line unless line.include?(hashedId)
           end
-          hosts.strip!
           hostsFile = File.open(@@hosts_path, "w")
           hostsFile.write(hosts)
           hostsFile.close()
         end
       end
 
+
+
       def signature(name, uuid = self.uuid)
-        hashedId = Digest::MD5.hexdigest(uuid)
+        hashedId = Digest::MD5.hexdigest(uuid.to_s)
         %Q(# VAGRANT: #{hashedId} (#{name}) / #{uuid})
       end
 
       def sudo(command)
         return if !command
         if Vagrant::Util::Platform.windows?
-          require 'win32ole'
-          args = command.split(" ")
-          command = args.shift
-          sh = WIN32OLE.new('Shell.Application')
-          sh.ShellExecute(command, args.join(" "), '', 'runas', 0)
+          `#{command}`
         else
           return system("sudo #{command}")
         end
@@ -153,25 +132,7 @@ module VagrantPlugins
 
       def adviseOnSudo
         @ui.error "[vagrant-virtual-hostsupdater] Consider adding the following to your sudoers file:"
-        @ui.error "[vagrant-virtual-hostsupdater]   https://github.com/cogitatio/vagrant-hostsupdater#suppressing-prompts-for-elevating-privileges"
-      end
-
-      def getAwsPublicIp
-        return nil if ! Vagrant.has_plugin?("vagrant-aws")
-        aws_conf = @machine.config.vm.get_provider_config(:aws)
-        return nil if ! aws_conf.is_a?(VagrantPlugins::AWS::Config)
-        filters = ( aws_conf.tags || [] ).map {|k,v| sprintf('"Name=tag:%s,Values=%s"', k, v) }.join(' ')
-        return nil if filters == ''
-        cmd = 'aws ec2 describe-instances --filter '+filters
-        stdout, stderr, stat = Open3.capture3(cmd)
-        @ui.error sprintf("Failed to execute '%s' : %s", cmd, stderr) if stderr != ''
-        return nil if stat.exitstatus != 0
-        begin
-          return JSON.parse(stdout)["Reservations"].first()["Instances"].first()["PublicIpAddress"]
-        rescue => e
-          @ui.error sprintf("Failed to get IP from the result of '%s' : %s", cmd, e.message)
-          return nil
-        end
+        @ui.error "[vagrant-virtual-hostsupdater]   https://github.com/gokhansengun/vagrant-virtual-hostsupdater#passwordless-sudo"
       end
     end
   end

data/lib/vagrant-virtual-hostsupdater/plugin.rb

@@ -1,3 +1,5 @@
+require "vagrant-virtual-hostsupdater/VirtualHostsUpdater.rb"
+require "vagrant-virtual-hostsupdater/Action/BaseAction"
 require "vagrant-virtual-hostsupdater/Action/UpdateHosts"
 require "vagrant-virtual-hostsupdater/Action/CacheHosts"
 require "vagrant-virtual-hostsupdater/Action/RemoveHosts"
@@ -34,9 +36,6 @@ module VagrantPlugins
 
       action_hook(:virtualhostsupdater, :machine_action_destroy) do |hook|
         hook.prepend(Action::CacheHosts)
-      end
-
-      action_hook(:virtualhostsupdater, :machine_action_destroy) do |hook|
         hook.append(Action::RemoveHosts)
       end
 

data/lib/vagrant-virtual-hostsupdater/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module VirtualHostsUpdater
-    VERSION = '1.1.2'
+    VERSION = '1.4.0'
   end
 end

data/vagrant-virtual-hostsupdater.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'vagrant-virtual-hostsupdater'
   spec.version       = VagrantPlugins::VirtualHostsUpdater::VERSION
   spec.authors       = ['Falk Kühnel', 'Chris Smith', 'Gökhan Şengün']
-  spec.email         = ['fk@cogitatio.de', 'chris@cgsmith.net']
+  spec.email         = ['fk@cogitatio.de', 'chris@cgsmith.net', 'gokhansengun@gmail.com']
   spec.description   = %q{Enables Vagrant to update hosts file on the host machine}
   spec.summary       = spec.description
   spec.homepage      = 'https://github.com/gokhansengun/vagrant-hostsupdater'
@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
   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 'bundler', '~> 2.2.32'
   spec.add_development_dependency 'rake'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-virtual-hostsupdater
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Falk Kühnel
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.32
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.32
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +44,7 @@ description: Enables Vagrant to update hosts file on the host machine
 email:
 - fk@cogitatio.de
 - chris@cgsmith.net
+- gokhansengun@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -54,6 +55,7 @@ files:
 - README.md
 - Rakefile
 - lib/vagrant-virtual-hostsupdater.rb
+- lib/vagrant-virtual-hostsupdater/Action/BaseAction.rb
 - lib/vagrant-virtual-hostsupdater/Action/CacheHosts.rb
 - lib/vagrant-virtual-hostsupdater/Action/RemoveHosts.rb
 - lib/vagrant-virtual-hostsupdater/Action/UpdateHosts.rb
@@ -82,8 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Enables Vagrant to update hosts file on the host machine