vagrant-goodhosts 1.0.0.pre.beta4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13ef1e50681184f9636c42cb63ef886051aab4f19c388f913f81e3ccee5c9c61
+  data.tar.gz: 60da586ec22b7387b3b7ca20641ec49316e3ecd4ed10e672c82fc48f1c8bb8d0
+SHA512:
+  metadata.gz: f140337609b3baae16139812a8013c7bb2396765340db63b8bb8ad740a115ee62fc089327bf9366113029cbc17419b418cc1309c5cfa176e0f863298ac5b75e0
+  data.tar.gz: da008e6cc94397d22242e2b75a5d4c3e15c9c6d0cc7bc7a4a3b508361572304ab0a949211dea4430ce1b5c7b3f68cf8ee3b8f213dac9043d50715953b34025f2

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+.idea
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bundle/

data/Gemfile

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

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,98 @@
+# 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.
+
+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. 
+
+
+## Installation
+
+    $ vagrant plugin install vagrant-goodhosts
+
+Uninstall it with:
+
+    $ vagrant plugin uninstall vagrant-goodhosts
+
+Update the plugin with:
+
+    $ 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"]
+
+This IP address and the hostname will be used for the entry in the `/etc/hosts` file.
+
+### 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"
+
+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']
+    }
+
+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`:
+
+    config.goodhosts.remove_on_suspend = false
+    
+This disables vagrant-goodhosts from running on **suspend** and **halt**.
+
+
+## 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_goodhosts`.  
+Change the cli path as printed in the vagrant output.
+
+For Ubuntu and most Linux environments:
+
+    %sudo ALL=(root) NOPASSWD: [the-path]
+
+For MacOS:
+
+    %admin ALL=(root) NOPASSWD: [the-path]
+
+### 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 development version
+
+If you would like to install vagrant-goodhosts on the development version perform the following:
+
+```
+git clone https://github.com/goodhosts/vagrant
+cd vagrant-goodhosts
+git checkout develop
+./package.sh
+vagrant plugin install vagrant-goodhosts-*.gem
+```

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks

data/lib/vagrant-goodhosts.rb

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

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

@@ -0,0 +1,31 @@
+module VagrantPlugins
+  module GoodHosts
+    module Action
+      class RemoveHosts
+        include GoodHosts
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @ui = env[:ui]
+        end
+
+        def call(env)
+          machine_action = env[:machine_action]
+          if machine_action != :destroy || !@machine.id
+            if machine_action != :suspend || false != @machine.config.goodhosts.remove_on_suspend
+              if machine_action != :halt || false != @machine.config.goodhosts.remove_on_suspend
+                @ui.info "[vagrant-goodhosts] Removing hosts"
+                removeHostEntries
+              else
+                @ui.info "[vagrant-goodhosts] Removing hosts on suspend disabled"
+              end
+            end
+          end
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

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

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

data/lib/vagrant-goodhosts/GoodHosts.rb

@@ -0,0 +1,162 @@
+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!" 
+        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
+            end
+            
+            return ips
+        end
+      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
+        )
+      end
+      
+      def get_cli
+          cli = get_OS
+          path = File.expand_path(File.dirname(File.dirname(__FILE__))) + '/vagrant-goodhosts/bundle/'
+          path = "#{path}#{cli}"
+          
+          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.goodhosts.aliases
+        when Array
+          # simple list of aliases to link to all ips
+          ips.each do |ip|
+            hostnames[ip] += @machine.config.goodhosts.aliases
+          end
+        when Hash
+          # complex definition of aliases for various ips
+          @machine.config.goodhosts.aliases.each do |ip, hosts|
+            hostnames[ip] += Array(hosts)
+          end
+        end
+
+        # handle default hostname(s) if not already specified in the aliases
+        Array(@machine.config.vm.hostname).each do |host|
+          if hostnames.none? { |k, v| v.include?(host) }
+            ips.each do |ip|
+              hostnames[ip].unshift host
+            end
+          end
+        end
+
+        return hostnames
+      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
+          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
+          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"
+        end
+          
+      end
+
+    end
+  end
+end 

data/lib/vagrant-goodhosts/command.rb

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

data/lib/vagrant-goodhosts/config.rb

@@ -0,0 +1,11 @@
+require "vagrant"
+
+module VagrantPlugins
+  module GoodHosts
+    class Config < Vagrant.plugin("2", :config)
+        attr_accessor :aliases
+        attr_accessor :id
+        attr_accessor :remove_on_suspend
+    end
+  end
+end

data/lib/vagrant-goodhosts/plugin.rb

@@ -0,0 +1,54 @@
+require "vagrant-goodhosts/Action/UpdateHosts"
+require "vagrant-goodhosts/Action/RemoveHosts"
+
+module VagrantPlugins
+  module GoodHosts
+    class Plugin < Vagrant.plugin('2')
+      name 'GoodHosts'
+      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(:goodhosts) do
+        require_relative 'config'
+        Config
+      end
+
+      action_hook(:goodhosts, :machine_action_up) do |hook|
+        hook.append(Action::UpdateHosts)
+      end
+
+      action_hook(:goodhosts, :machine_action_provision) do |hook|
+        hook.before(Vagrant::Action::Builtin::Provision, Action::UpdateHosts)
+      end
+
+      action_hook(:goodhosts, :machine_action_halt) do |hook|
+        hook.append(Action::RemoveHosts)
+      end
+
+      action_hook(:goodhosts, :machine_action_suspend) do |hook|
+        hook.append(Action::RemoveHosts)
+      end
+
+      action_hook(:goodhosts, :machine_action_destroy) do |hook|
+        hook.append(Action::RemoveHosts)
+      end
+
+      action_hook(:goodhosts, :machine_action_reload) do |hook|
+        hook.prepend(Action::RemoveHosts)
+        hook.append(Action::UpdateHosts)
+      end
+
+      action_hook(:goodhosts, :machine_action_resume) do |hook|
+        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

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

data/package.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+mkdir -p ./lib/vagrant-goodhosts/bundle
+cd ./lib/vagrant-goodhosts/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-goodhosts.gemspec

data/vagrant-goodhosts.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+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/mte90/vagrant-goodhosts'
+  spec.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']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-goodhosts
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.beta4
+platform: ruby
+authors:
+- Daniele Scasciafratte
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-05 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enables Vagrant to update hosts file on the host machine with goodhosts
+email:
+- mte90net@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-goodhosts.rb
+- lib/vagrant-goodhosts/Action/RemoveHosts.rb
+- lib/vagrant-goodhosts/Action/UpdateHosts.rb
+- lib/vagrant-goodhosts/GoodHosts.rb
+- 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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Enables Vagrant to update hosts file on the host machine with goodhosts
+test_files: []