vagrant-auto_network 1.0.0.beta1 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d671793aef1384eda1a6563c8c5c82fb5ef080f
-  data.tar.gz: d1e246dfdc649d07761ae4d778557ff796fb66af
+  metadata.gz: f95b22bf6a47ec537f8006cc11b3c3f3997507eb
+  data.tar.gz: 6c54bb78892dfca504042ccfd29d69fe9a7e7ca2
 SHA512:
-  metadata.gz: de702cdcb9d60ab2d1f55116b9a6d7a4cd4f392892e49fba9ae4764c87fe2c0024e6916f439f963e2bec84b77d568a6b73bef3abd427e1f0a1499bb19a7a8d77
-  data.tar.gz: e83c9eb3a06775ccf5fa59e5ab837a6d05f767f36babc1ce9ee7a5f08a1826a7ea18107df9df2df230032cc792cb377fc1da20e67538b1c53ada63f0b1c64e5d
+  metadata.gz: 6f54e0c340517c61c20969df5fd69cc4d40757ab2f355a053c5de4b1a14bc2794c8585fae6fd50d6975d5d9a2a5cd12bfc75cc83e1d43ed1f4440dd1b1d1378c
+  data.tar.gz: f3d2054ae710fd14231ae1ff7e3f2c058f717d468a284244f74b059bb0c4ad5b3979e35e07582013740869e8ccc3d88a2ebb76ae08f29a4991e85e515e9e184d

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle
+.yardoc
+Gemfile.local
+Gemfile.lock
+acceptance/artifacts
+coverage
+doc

data/CHANGELOG

@@ -4,7 +4,7 @@ vagrant-auto_network
 1.0.0
 -----
 
-2014-05-05
+Unreleased
 
 This is a mostly-backwards compatible feature release.
 
@@ -26,6 +26,26 @@ Specifically, the following issues have been addressed:
 	  storage mechanism that offers more resiliance to race conditions and data
 		loss from aborted actions.
 
+	* (GH-14) Remove depreciated AutoNetwork mixin module.
+
+1.0.0.beta2
+-----------
+
+2014-05-09
+
+Bug Fixes:
+
+  * (GH-20) Compatibility fixes for Vagrant 1.6
+
+  * Ensure directories exist when creating `pool.yaml` for the first time.
+
+1.0.0.beta1
+-----------
+
+2014-05-05
+
+First beta release of AutoNetwork 1.0.0.
+
 
 0.2.2
 -----

data/Gemfile

@@ -1,10 +1,17 @@
 source 'https://rubygems.org'
 ruby '2.0.0'
 
-gemspec
+# Using the :plugins group causes Vagrant to automagially load auto_network
+# during acceptance tests.
+group :plugins do
+  gemspec
+end
 
 group :development do
   gem 'vagrant', :github => 'mitchellh/vagrant', :tag => 'v1.5.4'
+  # Pinned on 05/05/2014.
+  gem 'vagrant-spec', :github => 'mitchellh/vagrant-spec', :ref => 'aae28ee'
+  gem 'rake'
 end
 
 if File.exists? "#{__FILE__}.local"

data/Rakefile

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

data/acceptance/auto_network/auto_network_spec.rb

@@ -0,0 +1,33 @@
+shared_examples 'provider/auto_network' do |provider, options|
+  if !File.file?(options[:box])
+    raise ArgumentError,
+      "A box file must be downloaded for provider: #{provider}. Try: rake acceptance:setup"
+  end
+
+  include_context 'acceptance'
+  let(:extra_env) { options[:env_vars] }
+
+  before do
+    environment.skeleton('auto_network')
+    assert_execute('vagrant', 'box', 'add', 'box', options[:box])
+  end
+
+  after do
+    # Ensure any VMs that survived tests are cleaned up.
+    execute('vagrant', 'destroy', '--force', log: false)
+  end
+
+  # NOTE: This is a bit tightly coupled as it strings together tests for
+  # vagrant up, status, reload and destroy in a single case. However, each
+  # invocation is dependant on the state created by the prior command.
+  it 'manages IP address allocation for the lifecycle of a VM' do
+    result = assert_execute('vagrant', 'up', "--provider=#{provider}")
+    expect(result.stdout).to match(/Assigning "\S+" to 'default'/)
+
+    assert_execute('vagrant', 'status')
+    assert_execute('vagrant', 'reload', 'default')
+
+    result = assert_execute('vagrant', 'destroy', '--force')
+    expect(result.stdout).to match(/Releasing "\S+" from default/)
+  end
+end

data/acceptance/skeletons/auto_network/Vagrantfile

@@ -0,0 +1,15 @@
+# If this test is being run on a host that also uses auto_network in a normal
+# Vagrant environment then there will already be network interfaces listening.
+# Most likely in the range of 10.20.0.0/16. The following environment variable
+# is set per-provider in the vagrant-spec config.
+AutoNetwork.default_pool = ENV["AUTO_NETWORK_TEST_RANGE"]
+
+Vagrant.configure('2') do |config|
+  config.vm.provider 'virtualbox' do |vb|
+    # Clean up network interface after tests.
+    vb.destroy_unused_network_interfaces = true
+  end
+
+  config.vm.box = 'box'
+  config.vm.network 'private_network', :auto_network => true
+end

data/lib/auto_network/action/filter_networks.rb

@@ -23,7 +23,6 @@ class AutoNetwork::Action::FilterNetworks
   def call(env)
     @env = env
 
-    @pool       = @env[:auto_network_pool]
     @global_env = @env[:env]
 
     filter if has_working_env?
@@ -49,7 +48,7 @@ class AutoNetwork::Action::FilterNetworks
 
   def assign_address(machine)
     machine_auto_networks(machine).each do |net|
-      addr = @pool.address_for(machine)
+      addr = AutoNetwork.pool_manager.address_for(machine)
       @logger.info "Reassigning #{addr.inspect} to existing machine #{machine.name}"
       filter_private_network(net, addr)
     end

data/lib/auto_network/action/load_pool.rb

@@ -20,7 +20,7 @@ class AutoNetwork::Action::LoadPool
 
     if env_ready?
       setup_ivars
-      deserialize!
+      deserialize! if AutoNetwork.pool_manager.nil?
       @app.call(@env)
     else
       @app.call(@env)
@@ -30,15 +30,15 @@ class AutoNetwork::Action::LoadPool
   private
 
   def env_ready?
-    !!@env[:home_path]
+    !!@env[:env].home_path
   end
 
   def setup_ivars
-    @config_path = @env[:home_path].join('auto_network')
+    @config_path = @env[:env].home_path.join('auto_network')
     @statefile   = @config_path.join('pool.yaml')
   end
 
   def deserialize!
-    @env[:auto_network_pool] = AutoNetwork::PoolManager.new(@statefile)
+    AutoNetwork.pool_manager = AutoNetwork::PoolManager.new(@statefile)
   end
 end

data/lib/auto_network/action/release.rb

@@ -20,7 +20,6 @@ class AutoNetwork::Action::Release
     @env = env
 
     @machine = @env[:machine]
-    @pool    = @env[:auto_network_pool]
 
     release_network_addresses if machine_has_address?(@machine)
 
@@ -30,8 +29,8 @@ class AutoNetwork::Action::Release
   private
 
   def release_network_addresses
-    addr = @pool.address_for(@machine)
+    addr = AutoNetwork.pool_manager.address_for(@machine)
     @env[:ui].info "Releasing #{addr.inspect} from #{@machine.name}", :prefix => true
-    @pool.release(@machine)
+    AutoNetwork.pool_manager.release(@machine)
   end
 end

data/lib/auto_network/action/request.rb

@@ -19,7 +19,6 @@ class AutoNetwork::Action::Request
   def call(env)
     @env = env
 
-    @pool    = @env[:auto_network_pool]
     @machine = @env[:machine]
 
     request_address unless machine_has_address?(@machine)
@@ -31,7 +30,7 @@ class AutoNetwork::Action::Request
 
   def request_address
     machine_auto_networks(@machine).each do |net|
-      addr = @pool.request(@machine)
+      addr = AutoNetwork.pool_manager.request(@machine)
       @env[:ui].info "Assigning #{addr.inspect} to '#{@machine.name}'", :prefix => true
       filter_private_network(net, addr)
     end

data/lib/auto_network/action_helpers.rb

@@ -7,7 +7,7 @@ module AutoNetwork
     #
     # @return [true, false]
     def machine_has_address?(machine)
-      !!(machine and @pool.address_for(machine))
+      !!(machine and AutoNetwork.pool_manager.address_for(machine))
     end
 
     # Fetch all private networks that are tagged for auto networking

data/lib/auto_network/plugin.rb

@@ -10,13 +10,12 @@ module AutoNetwork
     networks.
     DESC
 
-    action_hook('Auto network: initialize address pool') do |hook|
-      hook.prepend AutoNetwork::Action::LoadPool
-    end
-
     action_hook('Auto network: filter private networks', :environment_load) do |hook|
-      action = AutoNetwork::Action::LoadPool
-      hook.after(action, AutoNetwork::Action::FilterNetworks)
+      load_pool = AutoNetwork::Action::LoadPool
+
+      # TODO: This should be re-factored to use ActionBuilder.
+      hook.prepend(load_pool)
+      hook.after(load_pool, AutoNetwork::Action::FilterNetworks)
     end
 
     action_hook('Auto network: request address') do |hook|

data/lib/auto_network/pool_storage.rb

@@ -1,3 +1,4 @@
+require 'pathname'
 require 'yaml/store'
 require 'auto_network/pool'
 
@@ -19,6 +20,10 @@ module AutoNetwork
     # @param path [String, Pathname] the location of the new pool file.
     # @return [void]
     def self.init(path)
+      path = Pathname.new(path)
+      dir = path.dirname
+
+      dir.mkpath unless dir.exist?
       File.write(path, POOLFILE_SKELETON.to_yaml)
     end
 

data/lib/auto_network/settings.rb

@@ -0,0 +1,51 @@
+require 'ipaddr'
+require 'vagrant/errors'
+
+module AutoNetwork
+  # This module is used by AutoNetwork to store global state when running under
+  # Vagrant. This module is mixed into the top-level AutoNetwork namespace.
+  module Settings
+
+    # An error class raised when an invalid value is assigned to a setting.
+    #
+    # @api private
+    class InvalidSettingErrror < Vagrant::Errors::VagrantError
+      error_key(:invalid_setting, 'vagrant_auto_network')
+    end
+
+    # @!attribute [rw] pool_manager
+    #   @return [AutoNetwork::PoolManager, nil]
+    attr_accessor :pool_manager
+
+    # Unless overriden, this will be the IP range assigned to the very first
+    # {AutoNetwork::Pool} created by {AutoNetwork::PoolManager} instances.
+    DEFAULT_POOL = '10.20.1.0/24'
+
+    # Retrieve the default pool that {AutoNetwork::PoolManager} instances will
+    # assign to the first {AutoNetwork::Pool} they create.
+    #
+    # @return [String]
+    def default_pool
+      @default_pool ||= DEFAULT_POOL
+    end
+
+    # Set the default pool to a new IP range.
+    #
+    # @param pool [String]
+    # @raise [InvalidSettingErrror] if an IPAddr object cannot be initialized
+    #   from the value of pool.
+    # @return [void]
+    def default_pool=(pool)
+      # Ensure the pool is valid.
+      begin
+        IPAddr.new pool
+      rescue ArgumentError
+        raise InvalidSettingErrror,
+          :setting_name => 'default_pool',
+          :value => pool
+      end
+
+      @default_pool = pool
+    end
+  end
+end

data/lib/auto_network/version.rb

@@ -1,3 +1,3 @@
 module AutoNetwork
-  VERSION = '1.0.0.beta1'
+  VERSION = '1.0.0.beta2'
 end

data/lib/auto_network.rb

@@ -1,10 +1,9 @@
 module AutoNetwork
 
-  require 'auto_network/default_pool'
-  extend DefaultPool
+  require 'auto_network/settings'
+  extend Settings
 
   require 'auto_network/action'
-  require 'auto_network/mixin'
   require 'auto_network/plugin'
   require 'auto_network/version'
   require 'auto_network/pool_manager'

data/spec/integration/plugin_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe AutoNetwork::Plugin do
+  include_context 'vagrant-unit'
+
+  context 'when a vagrant environment is initialized' do
+    let(:settings) {
+      Module.new do
+        extend AutoNetwork::Settings
+      end
+    }
+    let(:manager_double) { double().as_null_object }
+
+    it 'sets the global pool_manager' do
+      allow(AutoNetwork).to receive(:pool_manager=) do |pool_manager|
+        settings.pool_manager = pool_manager
+      end
+      allow(manager_double).to receive(:new).and_return('a_pool_manager')
+      stub_const('AutoNetwork::PoolManager', manager_double)
+
+      # Create an environment \o/
+      isolated_environment.create_vagrant_env
+
+      expect(settings.pool_manager).to eq('a_pool_manager')
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,8 @@
 $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 
-require 'rspec'
+# 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'
 require 'auto_network'

data/spec/unit/settings_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'auto_network/settings'
+
+describe AutoNetwork::Settings do
+  subject {
+    Module.new do
+      extend AutoNetwork::Settings
+    end
+  }
+
+  describe 'default_pool' do
+
+    it 'returns DEFAULT_POOL if nothing has been set' do
+      expect(subject.default_pool).to eq(AutoNetwork::Settings::DEFAULT_POOL)
+    end
+
+    it 'raises an error when set to an invalid value' do
+      expect { subject.default_pool=nil }.to raise_error(AutoNetwork::Settings::InvalidSettingErrror)
+    end
+
+  end
+end

data/tasks/acceptance.rake

@@ -0,0 +1,25 @@
+namespace :acceptance do
+  ARTIFACT_DIR = File.join('acceptance', 'artifacts')
+  TEST_BOXES = %w[
+    https://vagrantcloud.com/puppetlabs/centos-6.5-64-nocm/version/2/provider/virtualbox.box
+  ]
+
+  directory ARTIFACT_DIR
+  TEST_BOXES.each do |box_url|
+    file File.join(ARTIFACT_DIR, File.basename(box_url)) => ARTIFACT_DIR do |path|
+      puts 'Downloading: ' + box_url
+      Kernel.system 'curl', '-L', '-o', path.to_s, box_url
+    end
+  end
+
+  desc 'downloads test boxes and other artifacts'
+  task :setup => TEST_BOXES.map {|box_url| File.join(ARTIFACT_DIR, File.basename(box_url))}
+
+  desc 'runs acceptance tests'
+  task :run => :setup do
+    command = 'vagrant-spec test'
+    puts command
+    puts
+    exec(command)
+  end
+end

data/templates/locales/en.yml

@@ -7,3 +7,6 @@ en:
       probably due to VMs being deleted outside of Vagrant. Check the
       auto_network pool configuration file and remove the machine IDs from
       addresses that are no longer in use, or add addresses to the pool.
+
+    invalid_setting: |-
+      The following value is not a valid setting for '%{setting_name}': '%{value}'

data/vagrant-spec.config.rb

@@ -0,0 +1,16 @@
+require 'pathname'
+require 'vagrant-spec/acceptance'
+
+Vagrant::Spec::Acceptance.configure do |c|
+  acceptance_dir = Pathname.new File.expand_path('../acceptance', __FILE__)
+
+  c.component_paths = [acceptance_dir.to_s]
+  c.skeleton_paths = [(acceptance_dir + 'skeletons').to_s]
+
+  c.provider 'virtualbox',
+    box: (acceptance_dir + 'artifacts' + 'virtualbox.box').to_s,
+    env_vars: {
+      'VBOX_USER_HOME' => '{{homedir}}',
+      'AUTO_NETWORK_TEST_RANGE' => '10.42.1.0/24',
+    }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-auto_network
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2014-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,10 +30,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .yardopts
 - CHANGELOG
 - Gemfile
 - README.markdown
+- Rakefile
+- acceptance/auto_network/auto_network_spec.rb
+- acceptance/skeletons/auto_network/Vagrantfile
 - lib/auto_network.rb
 - lib/auto_network/action.rb
 - lib/auto_network/action/filter_networks.rb
@@ -41,18 +45,21 @@ files:
 - lib/auto_network/action/release.rb
 - lib/auto_network/action/request.rb
 - lib/auto_network/action_helpers.rb
-- lib/auto_network/default_pool.rb
-- lib/auto_network/mixin.rb
 - lib/auto_network/plugin.rb
 - lib/auto_network/pool.rb
 - lib/auto_network/pool_manager.rb
 - lib/auto_network/pool_storage.rb
+- lib/auto_network/settings.rb
 - lib/auto_network/version.rb
 - lib/vagrant-auto_network.rb
-- spec/auto_network/pool/pool_spec.rb
+- spec/integration/plugin_spec.rb
 - spec/spec_helper.rb
+- spec/unit/pool_spec.rb
+- spec/unit/settings_spec.rb
+- tasks/acceptance.rake
 - templates/locales/en.yml
 - vagrant-auto_network.gemspec
+- vagrant-spec.config.rb
 homepage: https://github.com/adrienthebo/vagrant-auto_network
 licenses:
 - Apache 2.0

data/lib/auto_network/default_pool.rb

@@ -1,9 +0,0 @@
-module AutoNetwork::DefaultPool
-  def default_pool
-    @default_pool ||= '10.20.1.0/24'
-  end
-
-  def default_pool=(pool)
-    @default_pool = pool
-  end
-end

data/lib/auto_network/mixin.rb

@@ -1,12 +0,0 @@
-require 'auto_network/pool'
-
-module AutoNetwork
-  # Extension to vagrant VM configuration to automatically configure an
-  # internal network.
-  module Mixin
-    def auto_network!
-      puts "AutoNetwork::Mixin is deprecated, use config.vm.network :private_network, :auto_network => true"
-      network :private_network, :auto_network => true
-    end
-  end
-end