vagrant-auto_network 0.1.0 → 0.2.0

data/CHANGELOG

@@ -0,0 +1,12 @@
+vagrant-auto_network
+====================
+
+0.2.0
+-----
+
+2013-08-07
+
+This is a backwards compatible feature release. It reimplements the
+auto_network functionality as part of the :private_network network config
+method. It also implements persistent leases so that machines in different
+Vagrant environments all have unique addresses.

data/README.markdown

@@ -26,14 +26,13 @@ Usage
         node.vm.box = "centos-5-i386"
 
         node.vm.extend AutoNetwork::Mixin
-        node.vm.auto_network!
+        node.vm.network :private_network, :auto_network => true
       end
 
       config.vm.define 'second' do |node|
         node.vm.box = "centos-5-i386"
 
-        node.vm.extend AutoNetwork::Mixin
-        node.vm.auto_network!
+        node.vm.network :private_network, :auto_network => true
       end
     end
 
@@ -54,8 +53,8 @@ To change this, add the following _before_ the Vagrant configuration block:
 Contact
 -------
 
-  * Source code: https://github.com/adrienthebo/vagrant-auto\_network
-  * Issue tracker: https://github.com/adrienthebo/vagrant-auto\_network/issues
+  * [Source code](https://github.com/adrienthebo/vagrant-auto_network)
+  * [Issue tracker](https://github.com/adrienthebo/vagrant-auto_network/issues)
 
 If you have questions or concerns about this module, contact finch on Freenode,
 or email adrien@puppetlabs.com.

data/lib/auto_network.rb

@@ -1,13 +1,12 @@
-require 'auto_network/mixin'
-
 module AutoNetwork
-  class << self
-    def default_pool
-      @default_pool ||= '10.20.1.0/24'
-    end
 
-    def default_pool=(pool)
-      @default_pool = pool
-    end
-  end
+  require 'auto_network/default_pool'
+  extend DefaultPool
+
+  require 'auto_network/action'
+  require 'auto_network/mixin'
+  require 'auto_network/plugin'
+  require 'auto_network/version'
 end
+
+I18n.load_path << File.expand_path('../templates/locales/en.yml', File.dirname(__FILE__))

data/lib/auto_network/action.rb

@@ -0,0 +1,8 @@
+module AutoNetwork
+  module Action
+    require 'auto_network/action/load_pool'
+    require 'auto_network/action/filter_networks'
+    require 'auto_network/action/release'
+    require 'auto_network/action/request'
+  end
+end

data/lib/auto_network/action/filter_networks.rb

@@ -0,0 +1,49 @@
+require 'auto_network/action_helpers'
+require 'log4r'
+
+class AutoNetwork::Action::FilterNetworks
+
+  include AutoNetwork::ActionHelpers
+
+  def initialize(app, env)
+    @app, @env = app, env
+
+    @logger = Log4r::Logger.new('vagrant::auto_network::filter_networks')
+  end
+
+  # Convert auto_network interfaces to static private_network interfaces.
+  #
+  # @param env [Hash]
+  #
+  # @option env [AutoNetwork::Pool] auto_network_pool The global auto network pool
+  # @option env [Vagrant::Environment] env The Vagrant environment containing
+  #   the active machines that need to be filtered.
+  #
+  # @return [void]
+  def call(env)
+    @env = env
+
+    @pool      = @env[:auto_network_pool]
+    global_env = @env[:env]
+
+    machines_for_env(global_env).each do |machine|
+      assign_address(machine) if machine_has_address?(machine)
+    end
+
+    @app.call(@env)
+  end
+
+  private
+
+  def machines_for_env(global_env)
+    global_env.active_machines.map { |vm_id| global_env.machine(*vm_id) }
+  end
+
+  def assign_address(machine)
+    machine_auto_networks(machine).each do |net|
+      addr = @pool.address_for(machine)
+      @logger.info "Reassigning #{addr.inspect} to existing machine #{machine.id}"
+      filter_private_network(net, addr)
+    end
+  end
+end

data/lib/auto_network/action/load_pool.rb

@@ -0,0 +1,50 @@
+require 'auto_network'
+require 'yaml'
+
+class AutoNetwork::Action::LoadPool
+
+  def initialize(app, env)
+    @app, @env = app, env
+
+    @config_path = @env[:home_path].join('auto_network')
+    @statefile   = @config_path.join('pool.yaml')
+  end
+
+  # Handle the loading and unloading of the auto_network pool
+  #
+  # @param env [Hash]
+  #
+  # @option env [AutoNetwork::Pool] auto_network_pool The global auto network pool
+  # @option env [Vagrant::Environment] env The Vagrant environment containing
+  #   the active machines that need to be filtered.
+  #
+  # @return [void]
+  def call(env)
+    @env = env
+
+    deserialize!
+    @app.call(@env)
+    serialize!
+  end
+
+  private
+
+  def deserialize!
+    pool = nil
+    if @statefile.exist?
+      pool = YAML.load(@statefile.read)
+    else
+      range = AutoNetwork.default_pool
+      @env[:ui].info "No auto_network pool available, generating a pool with the range #{range}"
+      pool = AutoNetwork::Pool.new(range)
+    end
+    @env[:auto_network_pool] = pool
+  end
+
+  def serialize!
+    @config_path.mkpath unless @config_path.exist?
+
+    pool_data = YAML.dump(@env[:auto_network_pool])
+    @statefile.open('w') { |fh| fh.write(pool_data) }
+  end
+end

data/lib/auto_network/action/release.rb

@@ -0,0 +1,37 @@
+require 'auto_network/action_helpers'
+
+class AutoNetwork::Action::Release
+
+  include AutoNetwork::ActionHelpers
+
+  def initialize(app, env)
+    @app, @env = app, env
+  end
+
+  # Release auto_network IP address on VM destruction
+  #
+  # @param env [Hash]
+  #
+  # @option env [AutoNetwork::Pool] auto_network_pool The global auto network pool
+  # @option env [Vagrant::Machine] machine The Vagrant machine being destroyed
+  #
+  # @return [void]
+  def call(env)
+    @env = env
+
+    @machine = @env[:machine]
+    @pool    = @env[:auto_network_pool]
+
+    release_network_addresses if machine_has_address?(@machine)
+
+    @app.call(@env)
+  end
+
+  private
+
+  def release_network_addresses
+    addr = @pool.address_for(@machine)
+    @env[:ui].info "Releasing #{addr.inspect} from #{@machine.id}", :prefix => true
+    @pool.release(@machine)
+  end
+end

data/lib/auto_network/action/request.rb

@@ -0,0 +1,39 @@
+require 'auto_network/action_helpers'
+
+class AutoNetwork::Action::Request
+
+  include AutoNetwork::ActionHelpers
+
+  def initialize(app, env)
+    @app, @env = app, env
+  end
+
+  # Request an auto_network IP address on VM creation
+  #
+  # @param env [Hash]
+  #
+  # @option env [AutoNetwork::Pool] auto_network_pool The global auto network pool
+  # @option env [Vagrant::Machine] machine The Vagrant machine being created
+  #
+  # @return [void]
+  def call(env)
+    @env = env
+
+    @pool    = @env[:auto_network_pool]
+    @machine = @env[:machine]
+
+    request_address unless machine_has_address?(@machine)
+
+    @app.call(@env)
+  end
+
+  private
+
+  def request_address
+    machine_auto_networks(@machine).each do |net|
+      addr = @pool.request(@machine)
+      @env[:ui].info "Assigning #{addr.inspect} to '#{@machine.id}'", :prefix => true
+      filter_private_network(net, addr)
+    end
+  end
+end

data/lib/auto_network/action_helpers.rb

@@ -0,0 +1,40 @@
+module AutoNetwork
+  module ActionHelpers
+
+    # Determine if the given machine exists and has an auto_network address
+    #
+    # @param [Vagrant::Machine]
+    #
+    # @return [true, false]
+    def machine_has_address?(machine)
+      !!(machine and @pool.address_for(machine))
+    end
+
+    # Fetch all private networks that are tagged for auto networking
+    #
+    # @param iface [Array<Symbol, Hash>]
+    #
+    # @return [Array<Symbol, Hash>] All auto_networks
+    def machine_auto_networks(machine)
+      machine.config.vm.networks.select do |(net_type, options)|
+        net_type == :private_network and options[:auto_network]
+      end
+    end
+
+    # Convert an auto network to a private network with a static IP address.
+    #
+    # This does an in-place modification of the private_network options hash
+    # to strip out the auto_network configuration and make this behave like a
+    # normal private network interface with a static IP address.
+    #
+    # @param iface [Array<Symbol, Hash>]
+    # @param addr [String] The static IP address to assign to the private network
+    #
+    # @return [void]
+    def filter_private_network(iface, addr)
+      opts = iface[1]
+      opts.delete(:auto_network)
+      opts[:ip] = addr
+    end
+  end
+end

data/lib/auto_network/default_pool.rb

@@ -0,0 +1,9 @@
+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,15 +1,12 @@
 require 'auto_network/pool'
 
 module AutoNetwork
-
-# Extension to vagrant VM configuration to automatically configure an
-# internal network.
-module Mixin
-
-  def auto_network!
-    pool = AutoNetwork::Pool.instance
-    addr = pool.next
-    network :private_network, :ip => addr
+  # 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
-end

data/lib/auto_network/plugin.rb

@@ -0,0 +1,32 @@
+require 'vagrant'
+require 'auto_network/action'
+
+module AutoNetwork
+  class Plugin < Vagrant.plugin('2')
+    name 'auto_network'
+
+    description <<-DESC
+    This plugin adds support for automatically configuring Vagrant hostonly
+    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)
+    end
+
+    action_hook('Auto network: request address', :machine_action_up) do |hook|
+      action = VagrantPlugins::ProviderVirtualBox::Action::Network
+      hook.before(action, AutoNetwork::Action::Request)
+    end
+
+    action_hook('Auto network: release address', :machine_action_destroy) do |hook|
+      action = VagrantPlugins::ProviderVirtualBox::Action::Destroy
+      hook.before(action, AutoNetwork::Action::Release)
+    end
+  end
+end

data/lib/auto_network/pool.rb

@@ -1,39 +1,73 @@
-require 'auto_network'
-
-require 'ipaddress'
+require 'ipaddr'
 
 module AutoNetwork
-class Pool
+  class Pool
 
-  class PoolExhaustedError < StandardError; end
+    class PoolExhaustedError < Vagrant::Errors::VagrantError
+      error_key(:pool_exhausted, 'vagrant_auto_network')
+    end
 
-  # Provide a single instance of this class
-  #
-  # @return [AutoNetwork::Pool]
-  def self.instance
-    @myself ||= new
-  end
+    # @param network_addr [String] The network address range to use as the
+    #   address pool.
+    def initialize(network_range)
+      @network_range = network_range
+      generate_pool
+    end
 
-  # @param addr [String] The network address range to use as the address pool.
-  #   Defaults to `AutoNetwork.default_pool`
-  def initialize(addr = AutoNetwork.default_pool)
-    @addr    = addr
-    @network = IPAddress.parse(addr)
+    # Retrieve an IP address for the given machine. If a machine already has
+    # an IP address requested, then return that.
+    #
+    # @param machine [Vagrant::Machine]
+    def request(machine)
+      if (address = address_for(machine))
+        return address
+      elsif (address = next_available_lease)
+        @pool[address] = machine.id
+        return address
+      else
+        raise PoolExhaustedError,
+          :name    => machine.name,
+          :network => @network_range
+      end
+    end
 
-    @range = @network.hosts
-    # Drop the first IP address as it should be reserved for the host system
-    @range.shift
-  end
+    # Release an IP address associated with a machine
+    #
+    # @param machine [Vagrant::Machine]
+    def release(machine)
+      if (address = address_for(machine))
+        @pool[address] = nil
+      end
+    end
 
-  # @return [String] The string representation of the next available address
-  # @raise [PoolExhaustedError] There are no remaining addresses in the pool.
-  def next
-    if @range.empty?
-      raise PoolExhaustedError, "No addresses remaining in network address pool #{addr.inspect}"
+    def address_for(machine)
+      return nil if machine.id.nil?
+      next_addr, _ = @pool.find { |(addr, id)| machine.id == id }
+
+      next_addr
     end
 
-    addr = @range.shift
-    addr.address
+    private
+
+    def next_available_lease
+      next_addr, _ = @pool.find { |(addr, id)| id.nil? }
+
+      next_addr
+    end
+
+    def generate_pool
+      network = IPAddr.new(@network_range)
+      addresses = network.to_range.to_a
+
+      addresses.delete_at(-1) # Strip out the broadcast address
+      addresses.delete_at(1)  # And the first address (should be used by the host)
+      addresses.delete_at(0)  # And the network address
+
+      @pool = {}
+
+      addresses.map(&:to_s).each do |addr|
+        @pool[addr] = nil
+      end
+    end
   end
 end
-end

data/lib/auto_network/version.rb

@@ -1,3 +1,3 @@
 module AutoNetwork
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/templates/locales/en.yml

@@ -0,0 +1,9 @@
+---
+en:
+  vagrant_auto_network:
+    pool_exhausted: |-
+      The machine '%{name}' tried to get an automatic network address, but all
+      ip addresses in the network range '%{network}' have been used. This is
+      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.

data/vagrant-auto_network.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |gem|
 
   gem.summary     = "Automatically create an internal network for all vagrant boxes"
 
-  gem.add_dependency 'ipaddress'
-
   gem.files        = %x{git ls-files -z}.split("\0")
   gem.require_path = 'lib'
+
+  gem.license = 'Apache 2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-auto_network
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,40 +9,35 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-07 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: ipaddress
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2013-08-08 00:00:00.000000000 Z
+dependencies: []
 description: 
 email: adrien@somethingsinistral.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG
 - Gemfile
 - README.markdown
 - lib/auto_network.rb
+- lib/auto_network/action.rb
+- lib/auto_network/action/filter_networks.rb
+- lib/auto_network/action/load_pool.rb
+- 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/version.rb
 - lib/vagrant-auto_network.rb
+- templates/locales/en.yml
 - vagrant-auto_network.gemspec
 homepage: https://github.com/adrienthebo/vagrant-auto_network
-licenses: []
+licenses:
+- Apache 2.0
 post_install_message: 
 rdoc_options: []
 require_paths: