vagrant-goodhosts 1.0.0.pre.beta4 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13ef1e50681184f9636c42cb63ef886051aab4f19c388f913f81e3ccee5c9c61
-  data.tar.gz: 60da586ec22b7387b3b7ca20641ec49316e3ecd4ed10e672c82fc48f1c8bb8d0
+  metadata.gz: 7d08aeb238e55a6b9c10399ed2bb6cdf227e223bbde08e4a6dfb11366e67e5ee
+  data.tar.gz: 59169325206bd3f62a0b040d259fe14dc42dd3fa310822e5bccd4fc04beb15c0
 SHA512:
-  metadata.gz: f140337609b3baae16139812a8013c7bb2396765340db63b8bb8ad740a115ee62fc089327bf9366113029cbc17419b418cc1309c5cfa176e0f863298ac5b75e0
-  data.tar.gz: da008e6cc94397d22242e2b75a5d4c3e15c9c6d0cc7bc7a4a3b508361572304ab0a949211dea4430ce1b5c7b3f68cf8ee3b8f213dac9043d50715953b34025f2
+  metadata.gz: 4be9ec9e1d21b768de7c7a711f49daebec9606d28bdaf0a897f6deacb45faa76c1c6aec786a1701f119b5e6f4a4152a39315b58bfef77e9fd6dfa14744656519
+  data.tar.gz: 2a3e60b74d59745cea020b37dbd946ab0a1a14cbd77041727b20c0f55d9879871704512540578cbe8a247a86d55608c72692b016b061438569d231d4606e14b8

data/README.md

@@ -1,63 +1,82 @@
 # Vagrant::Goodhosts
 
-This plugin adds an entry to your /etc/hosts file on the host system using [GoodHosts](https://github.com/goodhosts/cli). This plugin is based on [vagrant-hostsupdater](https://github.com/cogitatio/vagrant-hostsupdater) 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 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 **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 **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. 
 
 ## Installation
 
-    $ vagrant plugin install vagrant-goodhosts
+```shell
+vagrant plugin install vagrant-goodhosts
+```
 
-Uninstall it with:
+To uninstall :
 
-    $ vagrant plugin uninstall vagrant-goodhosts
+```shell
+vagrant plugin uninstall vagrant-goodhosts
+```
 
-Update the plugin with:
+To update the plugin:
 
-    $ vagrant plugin update vagrant-goodhosts
+```shell
+vagrant plugin update vagrant-goodhosts
+```
 
 ## Usage
 
 You currently only need the `hostname` and a `:private_network` network with a fixed IP address.
 
-    config.vm.network :private_network, ip: "192.168.3.10"
-    config.vm.hostname = "www.testing.de"
-    config.goodhosts.aliases = ["alias.testing.de", "alias2.somedomain.com"]
+```ruby
+config.vm.network :private_network, ip: "192.168.3.10"
+config.vm.hostname = "www.testing.de"
+config.goodhosts.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.:
 
-    config.vm.network :private_network, ip: "10.0.0.1"
-    config.vm.network :private_network, ip: "10.0.0.2"
+```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.:
+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.goodhosts.aliases = {
-        '10.0.0.1' => ['foo.com', 'bar.com'],
-        '10.0.0.2' => ['baz.com', 'bat.com']
-    }
+```ruby
+config.goodhosts.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
-        
+```
+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`:
+To keep your `/etc/hosts` file unchanged simply add the line below to your `VagrantFile`:
 
-    config.goodhosts.remove_on_suspend = false
-    
-This disables vagrant-goodhosts from running on **suspend** and **halt**.
+```ruby
+config.goodhosts.remove_on_suspend = false
+```
+
+This disables `vagrant-goodhosts` from running on **suspend** and **halt**.
 
 
 ## Suppressing prompts for elevating privileges
@@ -68,7 +87,7 @@ 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`.  
-Change the cli path as printed in the vagrant output.
+The command path is printed when there are errors with sudo.
 
 For Ubuntu and most Linux environments:
 
@@ -77,6 +96,8 @@ 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
 
@@ -85,12 +106,12 @@ You have to open an elevated command prompt; hold `❖ Win` and press `X`, then
 
     cacls %SYSTEMROOT%\system32\drivers\etc\hosts /E /G %USERNAME%:W 
 
-## Installing development version
+## Installing The Development Version
 
-If you would like to install vagrant-goodhosts on the development version perform the following:
+If you would like to install `vagrant-goodhosts` to make contributions or changes, run the following commands::
 
-```
-git clone https://github.com/goodhosts/vagrant
+```shell
+git clone https://github.com/goodhosts/vagrant vagrant-goodhosts
 cd vagrant-goodhosts
 git checkout develop
 ./package.sh

data/lib/vagrant-goodhosts/GoodHosts.rb

@@ -1,69 +1,67 @@
-require 'rbconfig'
-require 'open3'
+require "rbconfig"
+require "open3"
 
 module VagrantPlugins
   module GoodHosts
     module GoodHosts
-
       def getIps
         if Vagrant.has_plugin?("vagrant-hostsupdater")
-            @ui.error "The Vagrant plugin vagrant-hostsupdater is installed but is executed always also when is not configured in your Vagrantfile!" 
+          @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|
-              key, options = network[0], network[1]
-              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)'
-            end
-            
-            @machine.config.vm.provider :hyperv do |v|
-                timeout = @machine.provider_config.ip_address_timeout
-                @ui.output("Waiting for the machine to report its IP address(might take some time, have a 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
+        @machine.config.vm.networks.each do |network|
+          key, options = network[0], network[1]
+          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)'
+          end
+
+          @machine.config.vm.provider :hyperv do |v|
+            timeout = @machine.provider_config.ip_address_timeout
+            @ui.output("[vagrant-goodhosts] 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
-            
-            return ips
+          end
+
+          
         end
+        return ips
       end
-      
+
       # https://stackoverflow.com/a/13586108/1902215
-      def get_OS
-        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
-        )
+      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
-          cli = get_OS
-          path = File.expand_path(File.dirname(File.dirname(__FILE__))) + '/vagrant-goodhosts/bundle/'
-          path = "#{path}#{cli}"
-          
-          return path
+        binary = get_os_binary
+        path = File.expand_path(File.dirname(File.dirname(__FILE__))) + "/vagrant-goodhosts/bundle/"
+        path = "#{path}#{binary}"
+
+        return path
       end
 
       # Get a hash of hostnames indexed by ip, e.g. { 'ip1': ['host1'], 'ip2': ['host2', 'host3'] }
@@ -96,67 +94,91 @@ module VagrantPlugins
       end
 
       def addHostEntries
-        ips = getIps
-        hostnames = getHostnames(ips)
         error = false
         errorText = ""
         cli = get_cli
-        ips.each do |ip|
-          hostnames[ip].each do |hostname|
-              ip_address = ip
-              if !ip_address.nil?
-                @ui.info "[vagrant-goodhosts]   found entry for: #{ip_address} #{hostname}"
-                if cli.include? ".exe"
-                    stdin, stdout, stderr, wait_thr = Open3.popen3(cli, "a", ip_address, hostname)
-                else
-                    stdin, stdout, stderr, wait_thr = Open3.popen3('sudo', cli, "a", ip_address, hostname)
-                end
-                if !wait_thr.value.success?
-                    error = true
-                    errorText = stderr.read.strip
-                end
-              end
+        hostnames_by_ips = generateHostnamesByIps
+        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(cli, "add", ip_address, hostnames)
+          else
+            stdin, stdout, stderr, wait_thr = Open3.popen3("sudo", cli, "add", ip_address, hostnames)
+          end
+          if !wait_thr.value.success?
+            error = true
+            errorText = stderr.read.strip
           end
         end
         printReadme(error, errorText)
       end
 
       def removeHostEntries
-        ips = getIps
-        hostnames = getHostnames(ips)
         error = false
         errorText = ""
         cli = get_cli
-        ips.each do |ip|
-          hostnames[ip].each do |hostname|
-              ip_address = ip
-              if !ip_address.nil?
-                @ui.info "[vagrant-goodhosts]   remove entry for: #{ip_address} #{hostname}"
-                if cli.include? ".exe"
-                    stdin, stdout, stderr, wait_thr = Open3.popen3(cli, "r", ip_address, hostname)
-                else
-                    stdin, stdout, stderr, wait_thr = Open3.popen3('sudo', cli, "r", ip_address, hostname)
-                end
-                if !wait_thr.value.success?
-                    error = true
-                    errorText = stderr.read.strip
-                end
-              end
+        hostnames_by_ips = generateHostnamesByIps
+        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(cli, "remove", ip_address, hostnames)
+          else
+            stdin, stdout, stderr, wait_thr = Open3.popen3("sudo", cli, "remove", 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-goodhosts] Issue on executing goodhosts: #{errorText}"
-            @ui.error "[vagrant-goodhosts] Cli path: #{cli}"            
-            @ui.error "[vagrant-goodhosts] Check the readme at https://github.com/Mte90/vagrant-goodhosts#passwordless-sudo"
+          cli = get_cli
+          @ui.error "[vagrant-goodhosts] Issue executing goodhosts CLI: #{errorText}"
+          @ui.error "[vagrant-goodhosts] Cli path: #{cli}"
+          if cli.include? ".exe"
+            @ui.error "[vagrant-goodhosts] Check the readme at https://github.com/goodhosts/vagrant#windows-uac-prompt"
+            exit
+          else
+            @ui.error "[vagrant-goodhosts] Check the readme at https://github.com/goodhosts/vagrant#passwordless-sudo"
+          end
         end
-          
       end
 
+      def generateHostnamesByIps()
+        hostnames_by_ips = []
+        ips = getIps
+        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}"
+              end
+            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}"
+            end
+          end
+          hostnames_by_ips = { ip_address => hostnames[ip_address].join(" ") }
+        end
+
+        return hostnames_by_ips
+      end
     end
   end
-end 
+end

data/lib/vagrant-goodhosts/plugin.rb

@@ -44,11 +44,6 @@ module VagrantPlugins
         hook.prepend(Action::RemoveHosts)
         hook.append(Action::UpdateHosts)
       end
-
-      command(:goodhosts) do
-        require_relative 'command'
-        Command
-      end
     end
   end
 end

data/lib/vagrant-goodhosts/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module GoodHosts
-    VERSION = '1.0.0-beta4'
+    VERSION = '1.0.4'
   end
 end

data/vagrant-goodhosts.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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/mte90/vagrant-goodhosts'
+  spec.homepage      = 'https://github.com/goodhosts/vagrant'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-goodhosts
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta4
+  version: 1.0.4
 platform: ruby
 authors:
 - Daniele Scasciafratte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,13 +57,12 @@ files:
 - lib/vagrant-goodhosts/bundle/cli
 - lib/vagrant-goodhosts/bundle/cli.exe
 - lib/vagrant-goodhosts/bundle/cli_osx
-- lib/vagrant-goodhosts/command.rb
 - lib/vagrant-goodhosts/config.rb
 - lib/vagrant-goodhosts/plugin.rb
 - lib/vagrant-goodhosts/version.rb
 - package.sh
 - vagrant-goodhosts.gemspec
-homepage: https://github.com/mte90/vagrant-goodhosts
+homepage: https://github.com/goodhosts/vagrant
 licenses:
 - MIT
 metadata: {}
@@ -78,9 +77,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: 

data/lib/vagrant-goodhosts/command.rb

@@ -1,10 +0,0 @@
-module VagrantPlugins
-  module GoodHosts
-    class Command < Vagrant.plugin('2', :command)
-
-      def execute
-        puts "ran command"
-      end
-    end
-  end
-end