vagrant-multi-hostsupdater 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 533512cd17c6ca13e71dbe1813d3270d750b887d
+  data.tar.gz: 209416ad79ae954b48fd15bf0963cbfb555233fb
+SHA512:
+  metadata.gz: e54c18e70573ad52cb72f08ffa780af88f6b7cf0d7d52efc5fc4f2707f86ecc851c6a507b159c54aec153ed661f439fde9181163bcf1e9e30cbe9297fb941a63
+  data.tar.gz: 20e512ae6e36f2c0e65b4f0e2d4a152be63288c859adebb1c1d55914bc8f6fcf841b919807aa5cc6d2a70bf7dd78c4ed6311cf7080d306fdb1042836bb6453d0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,50 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = "vagrant-hostsupdater"
+  s.version       = 0.2
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = "Falk Kühnel"
+  s.email         = "fk@cogitatio.de"
+  s.homepage      = "https://github.com/cogitatio/vagrant-hostsupdater"
+  s.summary       = "Enables Vagrant to update hosts file on the host machine"
+  s.description   = "Enables Vagrant to update hosts file on the host machine"
+
+
+  # s.add_development_dependency "rake"
+
+  # # The following block of code determines the files that should be included
+  # # in the gem. It does this by reading all the files in the directory where
+  # # this gemspec is, and parsing out the ignored files from the gitignore.
+  # # Note that the entire gitignore(5) syntax is not supported, specifically
+  # # the "!" syntax, but it should mostly work correctly.
+  # root_path      = File.dirname(__FILE__)
+  # all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
+  # all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
+  # gitignore_path = File.join(root_path, ".gitignore")
+  # gitignore      = File.readlines(gitignore_path)
+  # gitignore.map!    { |line| line.chomp.strip }
+  # gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+  # unignored_files = all_files.reject do |file|
+  #   # Ignore any directories, the gemspec only cares about files
+  #   next true if File.directory?(file)
+
+  #   # Ignore any paths that match anything in the gitignore. We do
+  #   # two tests here:
+  #   #
+  #   #   - First, test to see if the entire path matches the gitignore.
+  #   #   - Second, match if the basename does, this makes it so that things
+  #   #     like '.DS_Store' will match sub-directories too (same behavior
+  #   #     as git).
+  #   #
+  #   gitignore.any? do |ignore|
+  #     File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+  #       File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+  #   end
+  # end
+
+  # s.files         = unignored_files
+  # s.executables   = unignored_files.map { |f| f[/^bin\/(.*)/, 1] }.compact
+  # s.require_path  = 'lib'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Falk Kühnel
+
+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,69 @@
+# Vagrant::Hostsupdater
+
+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 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** and **destroy**, those entries will be removed again.
+By setting the remove\_on\_suspend option, you can have them removed on **suspend**, too:
+
+    config.hostsupdater.remove_on_suspend = true
+
+
+
+## Installation
+
+    $ vagrant plugin install vagrant-hostsupdater
+
+Uninstall it with:
+
+    $ vagrant plugin uninstall vagrant-hostsupdater
+
+## Usage
+
+At the moment, the only things you need, are the hostname and a :private_network network with a fixed ip.
+
+    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"]
+
+This ip and the hostname will be used for the entry in the /etc/hosts file.
+
+##  Versions
+
+### 0.0.11
+* bugfix: Fix additional new lines being added to hosts file (Thanks to vincentmac)
+
+### 0.0.10
+* bugfix: wrong path on Windows systems (Thanks to Im0rtality)
+
+### 0.0.9
+* bugfix: now not trying to remove anything if no machine id is given
+
+### 0.0.8
+* trying to use proper windows hosts file
+
+### 0.0.7
+* using hashed uids now to identify hosts entries (you might need to remove previous hostentries manually)
+* fixed removing of host entries
+
+### 0.0.6
+* no sudo, if /etc/hosts is writeable
+
+### 0.0.5
+* option added to not remove hosts on suspend, adding hosts on resume (Thanks to Svelix)
+
+### 0.0.4
+* fixed problem with removing hosts entries on destroy command (Thanks to Andy Bohne)
+
+### 0.0.3
+* added aliases config option to define additional hostnames
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/vagrant-multi-hostsupdater.rb

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

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

@@ -0,0 +1,20 @@
+module VagrantPlugins
+  module HostsUpdater
+    module Action
+      class CacheHosts
+        include HostsUpdater
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+        end
+
+        def call(env)
+          cacheHostEntries
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module VagrantPlugins
+  module HostsUpdater
+    module Action
+      class RemoveHosts
+        include HostsUpdater
+
+        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 || @machine.config.hostsupdater.remove_on_suspend
+              @ui.info "Removing hosts"
+              removeHostEntries
+            else
+              @ui.info "Removing hosts on suspend disabled"
+            end
+          end
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

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

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

data/lib/vagrant-multi-hostsupdater/HostsUpdater.rb

@@ -0,0 +1,129 @@
+module VagrantPlugins
+  module MultiHostsUpdater
+    module MultiHostsUpdater
+      @@hosts_path = Vagrant::Util::Platform.windows? ? File.expand_path('system32/drivers/etc/hosts', ENV['windir']) : '/etc/hosts'
+
+      def getIps
+        ips = []
+        @machine.config.vm.networks.each do |network|
+          key, options = network[0], network[1]
+          ip = options[:ip] if key == :private_network
+          ips.push(ip) if ip
+        end
+        return ips
+      end
+
+      # Get hostnames by specific IP.
+      # This option is only valid if a Hash is provided 
+      # from the `config.MultiHostsUpdater.aliases` parameter
+      def getHostnames(ip=nil)
+
+        hostnames = []
+        if @machine.config.MultiHostsUpdater.aliases.is_a?(Hash)
+          hostnames = @machine.config.MultiHostsUpdater.aliases[ip] || hostnames
+        else
+          hostnames = Array(@machine.config.vm.hostname)
+          hostnames.concat(@machine.config.MultiHostsUpdater.aliases)
+        end
+
+        return hostnames
+      end
+
+      def addHostEntries()
+        ips = getIps
+        file = File.open(@@hosts_path, "rb")
+        hostsContents = file.read
+        uuid = @machine.id
+        name = @machine.name
+        entries = []
+        ips.each do |ip|
+          hostnames = getHostnames(ip)
+          hostEntries = getHostEntries(ip, hostnames, name, uuid)
+          hostEntries.each do |hostEntry|
+            escapedEntry = Regexp.quote(hostEntry)
+            if !hostsContents.match(/#{escapedEntry}/)
+              @ui.info "adding to (#@@hosts_path) : #{hostEntry}"
+              entries.push(hostEntry)
+            end
+          end
+        end
+        addToHosts(entries)
+      end
+
+      def cacheHostEntries
+        @machine.config.MultiHostsUpdater.id = @machine.id
+      end
+
+      def removeHostEntries
+        if !@machine.id and !@machine.config.MultiHostsUpdater.id
+          @ui.warn "No machine id, nothing removed from #@@hosts_path"
+          return
+        end
+        file = File.open(@@hosts_path, "rb")
+        hostsContents = file.read
+        uuid = @machine.id || @machine.config.MultiHostsUpdater.id
+        hashedId = Digest::MD5.hexdigest(uuid)
+        if hostsContents.match(/#{hashedId}/)
+            removeFromHosts
+        end
+      end
+
+      def host_entry(ip, hostnames, name, uuid = self.uuid)
+        %Q(#{ip}  #{hostnames.join(' ')}  #{signature(name, uuid)})
+      end
+
+      def getHostEntries(ip, hostnames, name, uuid = self.uuid)
+        entries = []
+        hostnames.each do |hostname|
+          entries.push(%Q(#{ip}  #{hostname}  #{signature(name, uuid)}))
+        end
+        return entries
+      end
+
+      def addToHosts(entries)
+        return if entries.length == 0
+        content = entries.join("\n").strip
+        if !File.writable?(@@hosts_path)
+          sudo(%Q(sh -c 'echo "#{content}" >> #@@hosts_path'))
+        else
+          content = "\n" + content
+          hostsFile = File.open(@@hosts_path, "a")
+          hostsFile.write(content)
+          hostsFile.close()
+        end
+      end
+
+      def removeFromHosts(options = {})
+        uuid = @machine.id || @machine.config.MultiHostsUpdater.id
+        hashedId = Digest::MD5.hexdigest(uuid)
+        if !File.writable?(@@hosts_path)
+          sudo(%Q(sed -i -e '/#{hashedId}/ d' #@@hosts_path))
+        else
+          hosts = ""
+          File.open(@@hosts_path).each do |line|
+            hosts << line unless line.include?(hashedId)
+          end
+          hostsFile = File.open(@@hosts_path, "w")
+          hostsFile.write(hosts)
+          hostsFile.close()
+        end
+      end
+
+
+
+      def signature(name, uuid = self.uuid)
+        hashedId = Digest::MD5.hexdigest(uuid)
+        %Q(# VAGRANT: #{hashedId} (#{name}) / #{uuid})
+      end
+
+      def sudo(command)
+        return if !command
+        if Vagrant::Util::Platform.windows?
+          `#{command}`
+        else
+          `sudo #{command}`
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-multi-hostsupdater/command.rb

@@ -0,0 +1,30 @@
+module VagrantPlugins
+  module HostsUpdater
+    class Command < Vagrant.plugin('2', :command)
+      #include HostsFile
+
+      def execute
+        # options = {}
+        # opts = OptionParser.new do |o|
+        #   o.banner = 'Usage: vagrant hostmanager [vm-name]'
+        #   o.separator ''
+
+        #   o.on('--provider provider', String,
+        #     'Update machines with the specific provider.') do |provider|
+        #     options[:provider] = provider
+        #   end
+        # end
+
+        # argv = parse_options(opts)
+        # options[:provider] ||= @env.default_provider
+
+        # generate(@env, options[:provider].to_sym)
+
+        # with_target_vms(argv, options) do |machine|
+        #   update(machine)
+        # end
+        puts "ran command"
+      end
+    end
+  end
+end

data/lib/vagrant-multi-hostsupdater/config.rb

@@ -0,0 +1,16 @@
+require "vagrant"
+
+module VagrantPlugins
+  module HostsUpdater
+    class Config < Vagrant.plugin("2", :config)
+
+        # Array of hostnames to add or a Map[String => Array] of IPs to hostnames.
+        #
+        # Array syntax: aliases = ['foo.com', 'bar.com']
+        # Map syntax:   aliases = {'10.0.0.1' => ['foo.com', 'bar.com'], '10.0.0.2' => ['baz.com', 'bat.com']}
+        attr_accessor :aliases
+        attr_accessor :id
+        attr_accessor :remove_on_suspend
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+require "vagrant-hostsupdater/Action/UpdateHosts"
+require "vagrant-hostsupdater/Action/CacheHosts"
+require "vagrant-hostsupdater/Action/RemoveHosts"
+
+module VagrantPlugins
+  module HostsUpdater
+    class Plugin < Vagrant.plugin('2')
+      name 'HostsUpdater'
+      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(:hostsupdater) do
+        require_relative 'config'
+        Config
+      end
+
+      action_hook(:hostsupdater, :machine_action_up) do |hook|
+        hook.append(Action::UpdateHosts)
+      end
+
+      action_hook(:hostsupdater, :machine_action_halt) do |hook|
+        hook.append(Action::RemoveHosts)
+      end
+
+      action_hook(:hostsupdater, :machine_action_suspend) do |hook|
+        hook.append(Action::RemoveHosts)
+      end
+
+      action_hook(:hostsupdater, :machine_action_destroy) do |hook|
+        hook.prepend(Action::CacheHosts)
+      end
+
+      action_hook(:hostsupdater, :machine_action_destroy) do |hook|
+        hook.append(Action::RemoveHosts)
+      end
+
+      action_hook(:hostsupdater, :machine_action_reload) do |hook|
+        hook.append(Action::UpdateHosts)
+      end
+
+      action_hook(:hostsupdater, :machine_action_resume) do |hook|
+        hook.append(Action::UpdateHosts)
+      end
+
+      command(:hostsupdater) do
+        require_relative 'command'
+        Command
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module MultiHostsUpdater
+    VERSION = "0.0.1"
+  end
+end

data/vagrant-multi-hostsupdater.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-multi-hostsupdater/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-multi-hostsupdater"
+  spec.version       = VagrantPlugins::MultiHostsUpdater::VERSION
+  spec.authors       = ["Falk Kühnel"]
+  spec.email         = ["fk@cogitatio.de"]
+  spec.description   = %q{Enables Vagrant to update hosts file on the host machine}
+  spec.summary       = %q{Enables Vagrant to update hosts file on the host machine}
+  spec.homepage      = "https://github.com/cogitatio/vagrant-multi-hostsupdater"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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,87 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-multi-hostsupdater
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Falk Kühnel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-02 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
+email:
+- fk@cogitatio.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-multi-hostsupdater.rb
+- lib/vagrant-multi-hostsupdater/Action/CacheHosts.rb
+- lib/vagrant-multi-hostsupdater/Action/RemoveHosts.rb
+- lib/vagrant-multi-hostsupdater/Action/UpdateHosts.rb
+- lib/vagrant-multi-hostsupdater/HostsUpdater.rb
+- lib/vagrant-multi-hostsupdater/command.rb
+- lib/vagrant-multi-hostsupdater/config.rb
+- lib/vagrant-multi-hostsupdater/plugin.rb
+- lib/vagrant-multi-hostsupdater/version.rb
+- vagrant-multi-hostsupdater.gemspec
+homepage: https://github.com/cogitatio/vagrant-multi-hostsupdater
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Enables Vagrant to update hosts file on the host machine
+test_files: []