boxcar 0.10005.1

data/lib/vagrant/action/vm/match_mac_address.rb

@@ -0,0 +1,21 @@
+module Vagrant
+  module Action
+    module VM
+      class MatchMACAddress
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          raise Errors::VMBaseMacNotSpecified if !env[:vm].config.vm.base_mac
+
+          # Create the proc which we want to use to modify the virtual machine
+          env[:ui].info I18n.t("vagrant.actions.vm.match_mac.matching")
+          env[:vm].driver.set_mac_address(env[:vm].config.vm.base_mac)
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/action/vm/network.rb

@@ -0,0 +1,403 @@
+require 'set'
+
+require 'log4r'
+
+require 'vagrant/util/network_ip'
+
+module Vagrant
+  module Action
+    module VM
+      # This action handles all `config.vm.network` configurations by
+      # setting up the VM properly and enabling the networks afterword.
+      class Network
+        # Utilities to deal with network addresses
+        include Util::NetworkIP
+
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant::action::vm::network")
+
+          @app = app
+        end
+
+        def call(env)
+          @env = env
+
+          # First we have to get the array of adapters that we need
+          # to create on the virtual machine itself, as well as the
+          # driver-agnostic network configurations for each.
+          @logger.debug("Determining adapters and networks...")
+          adapters = []
+          networks = []
+          env[:vm].config.vm.networks.each do |type, args|
+            # Get the normalized configuration we'll use around
+            config = send("#{type}_config", args)
+
+            # Get the virtualbox adapter configuration
+            adapter = send("#{type}_adapter", config)
+            adapters << adapter
+
+            # Get the network configuration
+            network = send("#{type}_network_config", config)
+            network[:_auto_config] = true if config[:auto_config]
+            networks << network
+          end
+
+          if !adapters.empty?
+            # Automatically assign an adapter number to any adapters
+            # that aren't explicitly set.
+            @logger.debug("Assigning adapter locations...")
+            assign_adapter_locations(adapters)
+
+            # Verify that our adapters are good just prior to enabling them.
+            verify_adapters(adapters)
+
+            # Create all the network interfaces
+            @logger.info("Enabling adapters...")
+            env[:ui].info I18n.t("vagrant.actions.vm.network.preparing")
+            env[:vm].driver.enable_adapters(adapters)
+          end
+
+          # Continue the middleware chain. We're done with our VM
+          # setup until after it is booted.
+          @app.call(env)
+
+          if !adapters.empty? && !networks.empty?
+            # Determine the interface numbers for the guest.
+            assign_interface_numbers(networks, adapters)
+
+            # Configure all the network interfaces on the guest. We only
+            # want to configure the networks that have `auto_config` setup.
+            networks_to_configure = networks.select { |n| n[:_auto_config] }
+            env[:ui].info I18n.t("vagrant.actions.vm.network.configuring")
+            env[:vm].guest.configure_networks(networks_to_configure)
+          end
+        end
+
+        # This method assigns the adapter to use for the adapter.
+        # e.g. it says that the first adapter is actually on the
+        # virtual machine's 2nd adapter location.
+        #
+        # It determines the adapter numbers by simply finding the
+        # "next available" in each case.
+        #
+        # The adapters are modified in place by adding an ":adapter"
+        # field to each.
+        def assign_adapter_locations(adapters)
+          available  = Set.new(1..8)
+
+          # Determine which NICs are actually available.
+          interfaces = @env[:vm].driver.read_network_interfaces
+          interfaces.each do |number, nic|
+            # Remove the number from the available NICs if the
+            # NIC is in use.
+            available.delete(number) if nic[:type] != :none
+          end
+
+          # Based on the available set, assign in order to
+          # the adapters.
+          available = available.to_a.sort
+          @logger.debug("Available NICs: #{available.inspect}")
+          adapters.each do |adapter|
+            # Ignore the adapters that already have been assigned
+            if !adapter[:adapter]
+              # If we have no available adapters, then that is an exceptional
+              # event.
+              raise Errors::NetworkNoAdapters if available.empty?
+
+              # Otherwise, assign as the adapter the next available item
+              adapter[:adapter] = available.shift
+            end
+          end
+        end
+
+        # Verifies that the adapter configurations look good. This will
+        # raise an exception in the case that any errors occur.
+        def verify_adapters(adapters)
+          # Verify that there are no collisions in the adapters being used.
+          used = Set.new
+          adapters.each do |adapter|
+            raise Errors::NetworkAdapterCollision if used.include?(adapter[:adapter])
+            used.add(adapter[:adapter])
+          end
+        end
+
+        # Assigns the actual interface number of a network based on the
+        # enabled NICs on the virtual machine.
+        #
+        # This interface number is used by the guest to configure the
+        # NIC on the guest VM.
+        #
+        # The networks are modified in place by adding an ":interface"
+        # field to each.
+        def assign_interface_numbers(networks, adapters)
+          current = 0
+          adapter_to_interface = {}
+
+          # Make a first pass to assign interface numbers by adapter location
+          vm_adapters = @env[:vm].driver.read_network_interfaces
+          vm_adapters.sort.each do |number, adapter|
+            if adapter[:type] != :none
+              # Not used, so assign the interface number and increment
+              adapter_to_interface[number] = current
+              current += 1
+            end
+          end
+
+          # Make a pass through the adapters to assign the :interface
+          # key to each network configuration.
+          adapters.each_index do |i|
+            adapter = adapters[i]
+            network = networks[i]
+
+            # Figure out the interface number by simple lookup
+            network[:interface] = adapter_to_interface[adapter[:adapter]]
+          end
+        end
+
+        def hostonly_config(args)
+          ip      = args[0]
+          options = args[1] || {}
+
+          # Determine if we're dealing with a static IP or a DHCP-served IP.
+          type    = ip == :dhcp ? :dhcp : :static
+
+          # Default IP is in the 20-bit private network block for DHCP based networks
+          ip = "172.28.128.1" if type == :dhcp
+
+          options = {
+            :type    => type,
+            :ip      => ip,
+            :netmask => "255.255.255.0",
+            :adapter => nil,
+            :mac     => nil,
+            :name    => nil,
+            :auto_config => true
+          }.merge(options)
+
+          # Verify that this hostonly network wouldn't conflict with any
+          # bridged interfaces
+          verify_no_bridge_collision(options)
+
+          # Get the network address and IP parts which are used for many
+          # default calculations
+          netaddr  = network_address(options[:ip], options[:netmask])
+          ip_parts = netaddr.split(".").map { |i| i.to_i }
+
+          # Calculate the adapter IP, which we assume is the IP ".1" at the
+          # end usually.
+          adapter_ip    = ip_parts.dup
+          adapter_ip[3] += 1
+          options[:adapter_ip] ||= adapter_ip.join(".")
+
+          if type == :dhcp
+            # Calculate the DHCP server IP, which is the network address
+            # with the final octet + 2. So "172.28.0.0" turns into "172.28.0.2"
+            dhcp_ip    = ip_parts.dup
+            dhcp_ip[3] += 2
+            options[:dhcp_ip] ||= dhcp_ip.join(".")
+
+            # Calculate the lower and upper bound for the DHCP server
+            dhcp_lower    = ip_parts.dup
+            dhcp_lower[3] += 3
+            options[:dhcp_lower] ||= dhcp_lower.join(".")
+
+            dhcp_upper    = ip_parts.dup
+            dhcp_upper[3] = 254
+            options[:dhcp_upper] ||= dhcp_upper.join(".")
+          end
+
+          # Return the hostonly network configuration
+          return options
+        end
+
+        def hostonly_adapter(config)
+          @logger.debug("Searching for matching network: #{config[:ip]}")
+          interface = find_matching_hostonly_network(config)
+
+          if !interface
+            @logger.debug("Network not found. Creating if we can.")
+
+            # It is an error case if a specific name was given but the network
+            # doesn't exist.
+            if config[:name]
+              raise Errors::NetworkNotFound, :name => config[:name]
+            end
+
+            # Otherwise, we create a new network and put the net network
+            # in the list of available networks so other network definitions
+            # can use it!
+            interface = create_hostonly_network(config)
+            @logger.debug("Created network: #{interface[:name]}")
+          end
+
+          if config[:type] == :dhcp
+            # Check that if there is a DHCP server attached on our interface,
+            # then it is identical. Otherwise, we can't set it.
+            if interface[:dhcp]
+              valid = interface[:dhcp][:ip] == config[:dhcp_ip] &&
+                interface[:dhcp][:lower] == config[:dhcp_lower] &&
+                interface[:dhcp][:upper] == config[:dhcp_upper]
+
+              raise Errors::NetworkDHCPAlreadyAttached if !valid
+
+              @logger.debug("DHCP server already properly configured")
+            else
+              # Configure the DHCP server for the network.
+              @logger.debug("Creating a DHCP server...")
+              @env[:vm].driver.create_dhcp_server(interface[:name], config)
+            end
+          end
+
+          return {
+            :adapter     => config[:adapter],
+            :type        => :hostonly,
+            :hostonly    => interface[:name],
+            :mac_address => config[:mac],
+            :nic_type    => config[:nic_type]
+          }
+        end
+
+        def hostonly_network_config(config)
+          return {
+            :type    => config[:type],
+            :ip      => config[:ip],
+            :netmask => config[:netmask]
+          }
+        end
+
+        # Creates a new hostonly network that matches the network requested
+        # by the given host-only network configuration.
+        def create_hostonly_network(config)
+          # Create the options that are going to be used to create our
+          # new network.
+          options = config.dup
+          options[:ip] = options[:adapter_ip]
+
+          @env[:vm].driver.create_host_only_network(options)
+        end
+
+        # Finds a host only network that matches our configuration on VirtualBox.
+        # This will return nil if a matching network does not exist.
+        def find_matching_hostonly_network(config)
+          this_netaddr = network_address(config[:ip], config[:netmask])
+
+          @env[:vm].driver.read_host_only_interfaces.each do |interface|
+            if config[:name] && config[:name] == interface[:name]
+              return interface
+            elsif this_netaddr == network_address(interface[:ip], interface[:netmask])
+              return interface
+            end
+          end
+
+          nil
+        end
+
+        # Verifies that a host-only network subnet would not collide with
+        # a bridged networking interface.
+        #
+        # If the subnets overlap in any way then the host only network
+        # will not work because the routing tables will force the traffic
+        # onto the real interface rather than the virtualbox interface.
+        def verify_no_bridge_collision(options)
+          this_netaddr = network_address(options[:ip], options[:netmask])
+
+          @env[:vm].driver.read_bridged_interfaces.each do |interface|
+            that_netaddr = network_address(interface[:ip], interface[:netmask])
+            raise Errors::NetworkCollision if this_netaddr == that_netaddr && interface[:status] != "Down"
+          end
+        end
+
+        def bridged_config(args)
+          options = args[0] || {}
+          options = {} if !options.is_a?(Hash)
+
+          return {
+            :adapter => nil,
+            :mac     => nil,
+            :bridge  => nil,
+            :auto_config => true
+          }.merge(options)
+        end
+
+        def bridged_adapter(config)
+          # Find the bridged interfaces that are available
+          bridgedifs = @env[:vm].driver.read_bridged_interfaces
+          bridgedifs.delete_if { |interface| interface[:status] == "Down" }
+
+          # The name of the chosen bridge interface will be assigned to this
+          # variable.
+          chosen_bridge = nil
+
+          if config[:bridge]
+            @logger.debug("Bridge was directly specified in config, searching for: #{config[:bridge]}")
+
+            # Search for a matching bridged interface
+            bridgedifs.each do |interface|
+              if interface[:name].downcase == config[:bridge].downcase
+                @logger.debug("Specific bridge found as configured in the Vagrantfile. Using it.")
+                chosen_bridge = interface[:name]
+                break
+              end
+            end
+
+            # If one wasn't found, then we notify the user here.
+            if !chosen_bridge
+              @env[:ui].info I18n.t("vagrant.actions.vm.bridged_networking.specific_not_found",
+                                    :bridge => config[:bridge])
+            end
+          end
+
+          # If we still don't have a bridge chosen (this means that one wasn't
+          # specified in the Vagrantfile, or the bridge specified in the Vagrantfile
+          # wasn't found), then we fall back to the normal means of searchign for a
+          # bridged network.
+          if !chosen_bridge
+            if bridgedifs.length == 1
+              # One bridgable interface? Just use it.
+              chosen_bridge = bridgedifs[0][:name]
+              @logger.debug("Only one bridged interface available. Using it by default.")
+            else
+              # More than one bridgable interface requires a user decision, so
+              # show options to choose from.
+              @env[:ui].info I18n.t("vagrant.actions.vm.bridged_networking.available",
+                                    :prefix => false)
+              bridgedifs.each_index do |index|
+                interface = bridgedifs[index]
+                @env[:ui].info("#{index + 1}) #{interface[:name]}", :prefix => false)
+              end
+
+              # The range of valid choices
+              valid = Range.new(1, bridgedifs.length)
+
+              # The choice that the user has chosen as the bridging interface
+              choice = nil
+              while !valid.include?(choice)
+                choice = @env[:ui].ask("What interface should the network bridge to? ")
+                choice = choice.to_i
+              end
+
+              chosen_bridge = bridgedifs[choice - 1][:name]
+            end
+          end
+
+          @logger.info("Bridging adapter #{config[:adapter]} to #{chosen_bridge}")
+
+          # Given the choice we can now define the adapter we're using
+          return {
+            :adapter     => config[:adapter],
+            :type        => :bridged,
+            :bridge      => chosen_bridge,
+            :mac_address => config[:mac],
+            :nic_type    => config[:nic_type],
+          }
+        end
+
+        def bridged_network_config(config)
+          return {
+            :type => :dhcp
+          }
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/action/vm/nfs.rb

@@ -0,0 +1,196 @@
+require 'digest/md5'
+require 'fileutils'
+require 'pathname'
+
+require 'log4r'
+
+module Vagrant
+  module Action
+    module VM
+      # Enables NFS based shared folders. `nfsd` must already be installed
+      # on the host machine, and NFS client must already be installed on
+      # the guest machine.
+      #
+      # This is a two part process:
+      #
+      #   1. Adds an entry to `/etc/exports` on the host machine using
+      #      the host class to export the proper folder to the proper
+      #      machine.
+      #   2. After boot, runs `mount` on the guest to mount the shared
+      #      folder.
+      #
+      class NFS
+        def initialize(app,env)
+          @logger = Log4r::Logger.new("vagrant::action::vm::nfs")
+          @app = app
+          @env = env
+
+          verify_settings if nfs_enabled?
+        end
+
+        def call(env)
+          @env = env
+
+          extract_folders
+
+          if !folders.empty?
+            prepare_folders
+            export_folders
+          end
+
+          @app.call(env)
+
+          mount_folders if !folders.empty?
+        end
+
+        # Returns the folders which are to be synced via NFS.
+        def folders
+          @folders ||= {}
+        end
+
+        # Removes the NFS enabled shared folders from the configuration,
+        # so they will no longer be mounted by the actual shared folder
+        # task.
+        def extract_folders
+          # Load the NFS enabled shared folders
+          @folders = {}
+          @env[:vm].config.vm.shared_folders.each do |key, opts|
+            if opts[:nfs]
+              # Duplicate the options, set the hostpath, and set disabled on the original
+              # options so the ShareFolders middleware doesn't try to mount it.
+              folder = opts.dup
+              hostpath = Pathname.new(opts[:hostpath]).expand_path(@env[:root_path])
+
+              if !hostpath.directory? && opts[:create]
+                # Host path doesn't exist, so let's create it.
+                @logger.debug("Host path doesn't exist, creating: #{hostpath}")
+
+                begin
+                  FileUtils.mkpath(hostpath)
+                rescue Errno::EACCES
+                  raise Errors::SharedFolderCreateFailed, :path => hostpath.to_s
+                end
+              end
+
+              # Set the hostpath now that it exists.
+              folder[:hostpath] = hostpath.to_s
+
+              # Assign the folder to our instance variable for later use
+              @folders[key] = folder
+
+              # Disable the folder so that regular shared folders don't try to
+              # mount it.
+              opts[:disabled] = true
+            end
+          end
+        end
+
+        # Prepares the settings for the NFS folders, such as setting the
+        # options on the NFS folders.
+        def prepare_folders
+          @folders = @folders.inject({}) do |acc, data|
+            key, opts = data
+            opts[:map_uid] = prepare_permission(:uid, opts)
+            opts[:map_gid] = prepare_permission(:gid, opts)
+            opts[:nfs_version] ||= 3
+
+            # The poor man's UUID. An MD5 hash here is sufficient since
+            # we need a 32 character "uuid" to represent the filesystem
+            # of an export. Hashing the host path is safe because two of
+            # the same host path will hash to the same fsid.
+            opts[:uuid]    = Digest::MD5.hexdigest(opts[:hostpath])
+
+            acc[key] = opts
+            acc
+          end
+        end
+
+        # Prepares the UID/GID settings for a single folder.
+        def prepare_permission(perm, opts)
+          key = "map_#{perm}".to_sym
+          return nil if opts.has_key?(key) && opts[key].nil?
+
+          # The options on the hash get priority, then the default
+          # values
+          value = opts.has_key?(key) ? opts[key] : @env[:vm].config.nfs.send(key)
+          return value if value != :auto
+
+          # Get UID/GID from folder if we've made it this far
+          # (value == :auto)
+          stat = File.stat(opts[:hostpath])
+          return stat.send(perm)
+        end
+
+        # Uses the host class to export the folders via NFS. This typically
+        # involves adding a line to `/etc/exports` for this VM, but it is
+        # up to the host class to define the specific behavior.
+        def export_folders
+          @env[:ui].info I18n.t("vagrant.actions.vm.nfs.exporting")
+          @env[:host].nfs_export(@env[:vm].uuid, guest_ip, folders)
+        end
+
+        # Uses the system class to mount the NFS folders.
+        def mount_folders
+          @env[:ui].info I18n.t("vagrant.actions.vm.nfs.mounting")
+
+          # Only mount the folders which have a guest path specified
+          mount_folders = {}
+          folders.each do |name, opts|
+            if opts[:guestpath]
+              mount_folders[name] = opts.dup
+            end
+          end
+
+          @env[:vm].guest.mount_nfs(host_ip, mount_folders)
+        end
+
+        # Returns the IP address of the first host only network adapter
+        #
+        # @return [String]
+        def host_ip
+          @env[:vm].driver.read_network_interfaces.each do |adapter, opts|
+            if opts[:type] == :hostonly
+              @env[:vm].driver.read_host_only_interfaces.each do |interface|
+                if interface[:name] == opts[:hostonly]
+                  return interface[:ip]
+                end
+              end
+            end
+          end
+
+          nil
+        end
+
+        # Returns the IP address of the guest by looking at the first
+        # enabled host only network.
+        #
+        # @return [String]
+        def guest_ip
+          @env[:vm].config.vm.networks.each do |type, args|
+            if type == :hostonly && args[0].is_a?(String)
+              return args[0]
+            end
+          end
+
+          nil
+        end
+
+        # Checks if there are any NFS enabled shared folders.
+        def nfs_enabled?
+          @env[:vm].config.vm.shared_folders.each do |key, opts|
+            return true if opts[:nfs]
+          end
+
+          false
+        end
+
+        # Verifies that the host is set and supports NFS.
+        def verify_settings
+          raise Errors::NFSHostRequired if @env[:host].nil?
+          raise Errors::NFSNotSupported if !@env[:host].nfs?
+          raise Errors::NFSNoHostNetwork if !guest_ip
+        end
+      end
+    end
+  end
+end