vagrant-hosts 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 802263ab44d128add4e915e7a5ebaf01a67c547c
-  data.tar.gz: ab286d7e0b2d74f1b951169ae255cc5922ab1cbc
+  metadata.gz: 5e280c9aab6f0c95b6d900daa557e0204d5fb139
+  data.tar.gz: cfed85229e73ccf44feba8e0dab64832f542373f
 SHA512:
-  metadata.gz: 5cafc5418e59b07c379d1f227651c42bbac05418cdbbb4bf909ca853b7b87ac6f17f5630b99039f0a76e7b550cfebc81ef71ffad69645128657275e89014fe5a
-  data.tar.gz: 5c47aa690303b42436d1bf432e0f2060ed09ae53a3562e305881c44655446c7ce827233388ca19b13ae4092e5623464ef961788cfbfda642b280a2e7f07d5df8
+  metadata.gz: 588ee4e96c2eef297928753d15694fc3fa3abb2477c91a53431d16332102e3fb729352b703dcf833c1a67452777a42c9529a84a92e7452f782a4210c823047ca
+  data.tar.gz: dc5626e84d6ae921e60dd66f3b005fa5243d406c41642142750903c698279310eb59b0322f29cf8a224b09666e974ae384d335babf02cbdc66a56b77e2a290d1

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle
+.ruby-version
+.yardoc
+/doc
+Gemfile.lock
+Gemfile.local
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,18 @@
+---
+language: ruby
+sudo: false
+before_install:
+  - gem install bundler --version $BUNDLER_VERSION
+install: bundle _${BUNDLER_VERSION}_ install --without development
+script: bundle _${BUNDLER_VERSION}_ exec rspec --color --format documentation
+notifications:
+  email: false
+rvm:
+  - 2.0.0
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+  matrix:
+    - TEST_VAGRANT_VERSION=v1.6.5 BUNDLER_VERSION=1.6.9
+    - TEST_VAGRANT_VERSION=v1.7.4 BUNDLER_VERSION=1.10.5
+    - TEST_VAGRANT_VERSION=HEAD   BUNDLER_VERSION=1.10.5

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/CHANGELOG

@@ -1,6 +1,19 @@
 CHANGELOG
 =========
 
+2.6.0
+-----
+
+2015-11-08
+
+This is a backwards compatible feature release.
+
+  * (GH-17) Added a new `sync_hosts` option which triggers an update of all
+    hosts whenever one host is changed. This also occurs on VM destruction.
+
+  * Updated README with much missing documentation.
+
+
 2.5.0
 -----
 

data/Gemfile

@@ -0,0 +1,28 @@
+source 'https://rubygems.org'
+ruby '2.0.0' # Required by Vagrant 1.4 and newer.
+
+ENV['TEST_VAGRANT_VERSION'] ||= 'v1.7.4'
+
+# Wrapping gemspec in the :plugins group causes Vagrant 1.5 and newer to
+# automagically load this plugin during acceptance tests.
+group :plugins do
+  gemspec
+end
+
+group :development do
+  gem 'yard', '~> 0.8.7'
+  gem 'redcarpet'
+end
+
+group :test do
+  if ENV['TEST_VAGRANT_VERSION'] == 'HEAD'
+    gem 'vagrant', :github => 'mitchellh/vagrant', :branch => 'master'
+  else
+    gem 'vagrant', :github => 'mitchellh/vagrant', :tag => ENV['TEST_VAGRANT_VERSION']
+  end
+
+  # Pinned on 12/10/2014. Compatible with Vagrant 1.5.x, 1.6.x and 1.7.x.
+  gem 'vagrant-spec', :github => 'mitchellh/vagrant-spec', :ref => '1df5a3a'
+end
+
+eval_gemfile "#{__FILE__}.local" if File.exists? "#{__FILE__}.local"

data/README.markdown

@@ -3,14 +3,45 @@ vagrant-hosts
 
 Manage vagrant guest local DNS resolution.
 
+[![Build Status](https://travis-ci.org/oscar-stack/vagrant-hosts.svg?branch=master)](https://travis-ci.org/oscar-stack/vagrant-hosts)
+
 Synopsis
---------
+========
+
+The `vagrant-hosts` plugin provides a `hosts` provisioner which assembles hosts file content based on explicit information and `private_network` settings. Dynamic sources of hostname info, such as DHCP or provider-specific SSH info are currently not considered.
+
+
+Provisioner Settings
+--------------------
+
+These settings are on a per provisioner basis. They configure the individual
+behaviors of each provisioner instance.
+
+  * `hosts`
+    * Description: An array of tuples containing:
+      - An IP address
+      - A list of hostnames match with that address.
+    * Default: `[]`
+  * `autoconfigure`
+    * Description: A boolean which controls whether hosts are pulled in from other machines.
+    * Default: `true` if hosts is empty, otherwise `false`.
+  * `add_localhost_hostnames`
+    * Description: A boolean which controls whether the hostname of the machine is added as an alias for `127.0.1.1`
+    * Default: `true`
+  * `sync_hosts`
+    * Description: A boolean which controls whether running the hosts provisioner causes an update on all other running machines.
+      This also happens during machine destruction.
+    * Default: `false`
+
+
+Example Usage
+-------------
 
 Manually specify addresses:
 
 ```ruby
 Vagrant.configure('2') do |config|
-  config.vm.box = "ubuntu-12.04-server-i386"
+  config.vm.box = "puppetlabs/ubuntu-14.04-64-nocm"
 
   config.vm.provision :hosts do |provisioner|
     # Add a single hostname
@@ -41,15 +72,15 @@ Autodetect internal network addresses and autoconfigure hosts:
 Vagrant.configure('2') do |config|
 
   config.vm.define :first do |node|
-    node.vm.box = "ubuntu-12.04-server-i386"
+    node.vm.box = "puppetlabs/ubuntu-14.04-64-nocm"
     node.vm.network :private_network, :ip => '10.20.1.2'
-    node.vm.provision :hosts
+    node.vm.provision :hosts, :sync_hosts => true
   end
 
   config.vm.define :second do |node|
-    node.vm.box = "ubuntu-12.04-server-i386"
+    node.vm.box = "puppetlabs/ubuntu-14.04-64-nocm"
     node.vm.network :private_network, :ip => '10.20.1.3'
-    node.vm.provision :hosts
+    node.vm.provision :hosts, :sync_hosts => true
   end
 end
 ```
@@ -62,26 +93,36 @@ Use autodetection with manual entries
 Vagrant.configure('2') do |config|
 
   config.vm.define :first do |node|
-    node.vm.box = "ubuntu-12.04-server-i386"
+    node.vm.box = "puppetlabs/ubuntu-14.04-64-nocm"
     node.vm.network :private_network, :ip => '10.20.1.2'
     node.vm.provision :hosts do |provisioner|
       provisioner.autoconfigure = true
+      provisioner.sync_hosts = true
       provisioner.add_host '172.16.3.10', ['yum.mirror.local']
     end
 
   end
 
   config.vm.define :second do |node|
-    node.vm.box = "ubuntu-12.04-server-i386"
+    node.vm.box = "puppetlabs/ubuntu-14.04-64-nocm"
     node.vm.network :private_network, :ip => '10.20.1.3'
     node.vm.provision :hosts do |provisioner|
       provisioner.autoconfigure = true
+      provisioner.sync_hosts = true
       provisioner.add_host '172.16.3.11', ['apt.mirror.local']
     end
   end
 end
 ```
 
+Vagrant Commands
+----------------
+
+The `vagrant-hosts` plugin provides two Vagrant commands:
+
+  - `vagrant hosts list`: List private_network host info in /etc/hosts format
+  - `vagrant hosts puppetize`: List private_network host info as Puppet Host resources
+
 Supported Platforms
 -------------------
 
@@ -89,7 +130,8 @@ As of version 1.0.0 or later Vagrant 1.1 is required.
 
 Supported guests:
 
-  * Linux
+  * POSIX
+  * Windows
 
 Installation
 ------------

data/Rakefile

@@ -0,0 +1,5 @@
+task_dir = File.expand_path('../tasks', __FILE__)
+
+Dir["#{task_dir}/**/*.rake"].each do |task_file|
+  load task_file
+end

data/lib/vagrant-hosts/command.rb

@@ -11,6 +11,10 @@ module VagrantHosts
     require 'vagrant-hosts/command/puppetize'
     require 'vagrant-hosts/command/list'
 
+    def self.synopsis
+      'Information about hostnames managed by the vagrant-hosts plugin'
+    end
+
     def initialize(argv, env)
       @argv     = argv
       @env      = env

data/lib/vagrant-hosts/command/list.rb

@@ -3,6 +3,10 @@ class VagrantHosts::Command::List < Vagrant.plugin('2', :command)
   include VagrantHosts::Command::Helpers
   include VagrantHosts::Addresses
 
+  def self.synopsis
+    'List private_network host info in /etc/hosts format'
+  end
+
   def initialize(argv, env)
     @argv     = argv
     @env      = env

data/lib/vagrant-hosts/command/puppetize.rb

@@ -3,6 +3,10 @@ class VagrantHosts::Command::Puppetize < Vagrant.plugin('2', :command)
   include VagrantHosts::Command::Helpers
   include VagrantHosts::Addresses
 
+  def self.synopsis
+    'List private_network host info as Puppet Host resources'
+  end
+
   def initialize(argv, env)
     @argv     = argv
     @env      = env

data/lib/vagrant-hosts/config.rb

@@ -12,16 +12,24 @@ module VagrantHosts
     #                                   other vagrant machines
     attr_accessor :autoconfigure
 
-    # @!attribute autoconfigure
+    # @!attribute add_localhost_hostnames
     #   @return [TrueClass, FalseClass] A boolean indicating whether a
     #     `127.0.1.1` entry should be added mapping to the FQDN of the VM.
     #     Default: `true`.
     attr_accessor :add_localhost_hostnames
 
+    # @!attribute sync_hosts
+    #   @return [TrueClass, FalseClass] When set to true, running the hosts
+    #     provisioner on this VM will update all other running machines that
+    #     use the hosts provisioner. This action will also occur on machine
+    #     destruction. Defaults to `false`.
+    attr_accessor :sync_hosts
+
     def initialize
       @hosts = []
       @autoconfigure = UNSET_VALUE
       @add_localhost_hostnames = UNSET_VALUE
+      @sync_hosts = UNSET_VALUE
     end
 
     # Register a host for entry
@@ -53,14 +61,17 @@ module VagrantHosts
       if @add_localhost_hostnames == UNSET_VALUE
         @add_localhost_hostnames = true
       end
+
+      @sync_hosts = false if @sync_hosts == UNSET_VALUE
     end
 
     # @param other [VagrantHosts::Config]
     # @return [VagrantHosts::Config] The merged results
     def merge(other)
-      super.tap do |result|
-        result.hosts += other.hosts
-      end
+      result = super
+      result.instance_variable_set(:@hosts, self.hosts.dup + other.hosts.dup)
+
+      result
     end
 
     def validate(machine)

data/lib/vagrant-hosts/config_builder.rb

@@ -10,6 +10,8 @@ module VagrantHosts
       attr_accessor :autoconfigure
       # @!attribute [rw] add_localhost_hostnames
       attr_accessor :add_localhost_hostnames
+      # @!attribute [rw] sync_hosts
+      attr_accessor :sync_hosts
 
       def initialize
         @hosts = []
@@ -20,6 +22,7 @@ module VagrantHosts
           vm_config.provision :hosts do |h_config|
             h_config.autoconfigure = attr(:autoconfigure) unless attr(:autoconfigure).nil?
             h_config.add_localhost_hostnames = attr(:add_localhost_hostnames) unless attr(:add_localhost_hostnames).nil?
+            h_config.sync_hosts = attr(:sync_hosts) unless attr(:sync_hosts).nil?
 
             @hosts.each do |(address, aliases)|
               h_config.add_host address, aliases

data/lib/vagrant-hosts/provisioner/hosts.rb

@@ -4,12 +4,51 @@ module VagrantHosts
   module Provisioner
     class Hosts < Vagrant.plugin('2', :provisioner)
 
-      def initialize(machine, config)
-        super
-      end
-
       def provision
         @machine.guest.capability(:sync_hosts, @config)
+        sync_hosts! if @config.sync_hosts
+      end
+
+      def cleanup
+        sync_hosts! if @config.sync_hosts
+      end
+
+      private
+
+      # Update hosts on other VMs.
+      def sync_hosts!
+        env = @machine.env
+
+        # Gathers every _other_ machine in the vagrant environment which is
+        # running and has a hosts provider.
+        machines_to_provision = env.active_machines.map do |name, provider|
+          env.machine(name, provider)
+        end.select do |vm|
+          calling_machine = (vm.name.to_s == machine.name.to_s)
+          running = begin
+            vm.communicate.ready?
+          rescue Vagrant::Errors::VagrantError
+            # WinRM will raise an error if the VM isn't running instead of
+            # returning false (mitchellh/vagrant#6356).
+            false
+          end
+          has_hosts = vm.config.provisioners.any? {|p| p.type.intern == :hosts}
+
+          running && has_hosts && (not calling_machine)
+        end
+
+        machines_to_provision.each do |vm|
+          vm.ui.info "Updating hosts on: #{vm.name}"
+          vm.config.vm.provisioners.select {|p| p.type.intern == :hosts}.each do |p|
+            # Duplicate the hosts configuration.
+            hosts_config = @config.class.new.merge(p.config)
+            # Set sync_hosts to false to avoid recursion.
+            hosts_config.sync_hosts = false
+            hosts_config.finalize!
+
+            self.class.new(vm, hosts_config).provision
+          end
+        end
       end
 
     end

data/lib/vagrant-hosts/version.rb

@@ -1,3 +1,3 @@
 module VagrantHosts
-  VERSION = '2.5.0'
+  VERSION = '2.6.0'
 end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+# Disable Vagrant autoloading so that other plugins defined in the Gemfile for
+# Acceptance tests are not loaded.
+ENV['VAGRANT_NO_PLUGINS'] = '1'
+
+require 'vagrant-spec/unit'

data/spec/unit/config_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+require 'vagrant-hosts/config'
+
+describe VagrantHosts::Config do
+  let(:machine)  { double('machine') }
+
+  describe 'hosts' do
+    it 'requires aliases to be an array' do
+      subject.add_host '127.0.0.1', 'local.server'
+      subject.finalize!
+
+      errors = subject.validate(machine)
+
+      expect(errors['Vagrant Hosts'].to_s).to match(/should have an array of aliases/)
+    end
+
+    it 'accepts an array of aliases' do
+      subject.add_host '127.0.0.1', ['local.server']
+      subject.finalize!
+
+      errors = subject.validate(machine)
+
+      expect(errors['Vagrant Hosts']).to eq []
+    end
+
+    it 'can be merged' do
+      subject.add_host '127.0.0.1', ['local.server']
+      subject.finalize!
+
+      other = described_class.new
+      other.add_host '10.0.20.1', ['other.server']
+      other.finalize!
+
+      result = subject.merge(other)
+
+      expect(result.hosts).to eq [
+        ["127.0.0.1", ["local.server"]],
+        ["10.0.20.1", ["other.server"]]]
+    end
+
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/vagrant-hosts.gemspec

@@ -21,4 +21,8 @@ Gem::Specification.new do |gem|
 
   gem.files        = %x{git ls-files -z}.split("\0")
   gem.require_path = 'lib'
+
+  gem.add_development_dependency 'rake'
+  # Pin to 2.14.x for compatibility with vagrant-spec.
+  gem.add_development_dependency 'rspec', '~> 2.14.0'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-hosts
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
-dependencies: []
+date: 2015-11-08 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
 description: |2
       Manage static DNS entries and configuration for Vagrant guests.
 email: adrien@somethingsinistral.net
@@ -17,9 +45,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
 - CHANGELOG
+- Gemfile
 - LICENSE
 - README.markdown
+- Rakefile
 - lib/vagrant-hosts.rb
 - lib/vagrant-hosts/addresses.rb
 - lib/vagrant-hosts/cap.rb
@@ -35,6 +69,9 @@ files:
 - lib/vagrant-hosts/plugin.rb
 - lib/vagrant-hosts/provisioner/hosts.rb
 - lib/vagrant-hosts/version.rb
+- spec/spec_helper.rb
+- spec/unit/config_spec.rb
+- tasks/spec.rake
 - templates/locales/en.yml
 - vagrant-hosts.gemspec
 homepage: https://github.com/adrienthebo/vagrant-hosts
@@ -47,19 +84,18 @@ 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.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Manage static DNS on vagrant guests
 test_files: []
-has_rdoc: true