vagrant-libvirt 0.0.30 → 0.0.31

data/lib/vagrant-libvirt/config.rb

@@ -47,6 +47,7 @@ module VagrantPlugins
       attr_accessor :management_network_name
       attr_accessor :management_network_address
       attr_accessor :management_network_mode
+      attr_accessor :management_network_mac
 
       # Default host prefix (alternative to use project folder name)
       attr_accessor :default_prefix
@@ -55,9 +56,11 @@ module VagrantPlugins
       attr_accessor :memory
       attr_accessor :cpus
       attr_accessor :cpu_mode
+      attr_accessor :loader
       attr_accessor :boot_order
       attr_accessor :machine_type
       attr_accessor :machine_arch
+      attr_accessor :machine_virtual_size
       attr_accessor :disk_bus
       attr_accessor :nic_model_type
       attr_accessor :nested
@@ -74,9 +77,17 @@ module VagrantPlugins
       attr_accessor :video_vram
       attr_accessor :keymap
 
+      # Sets the max number of NICs that can be created
+      # Default set to 8. Don't change the default unless you know
+      # what are doing
+      attr_accessor :nic_adapter_count
+
       # Storage
       attr_accessor :disks
-  	  attr_accessor :cdroms
+      attr_accessor :cdroms
+
+      # Inputs
+      attr_accessor :inputs
 
       def initialize
         @uri               = UNSET_VALUE
@@ -91,13 +102,16 @@ module VagrantPlugins
         @management_network_name    = UNSET_VALUE
         @management_network_address = UNSET_VALUE
         @management_network_mode = UNSET_VALUE
+        @management_network_mac  = UNSET_VALUE
 
         # Domain specific settings.
         @memory            = UNSET_VALUE
         @cpus              = UNSET_VALUE
         @cpu_mode          = UNSET_VALUE
+        @loader            = UNSET_VALUE
         @machine_type      = UNSET_VALUE
         @machine_arch      = UNSET_VALUE
+        @machine_virtual_size = UNSET_VALUE
         @disk_bus          = UNSET_VALUE
         @nic_model_type    = UNSET_VALUE
         @nested            = UNSET_VALUE
@@ -114,13 +128,18 @@ module VagrantPlugins
         @video_vram        = UNSET_VALUE
         @keymap            = UNSET_VALUE
 
+        @nic_adapter_count = UNSET_VALUE
+
         # Boot order
         @boot_order = []
         # Storage
         @disks             = []
-        @cdroms			       = []
+        @cdroms			   = []
+
+        # Inputs
+        @inputs            = UNSET_VALUE
       end
-      
+
       def boot(device)
         @boot_order << device	# append
       end
@@ -153,7 +172,22 @@ module VagrantPlugins
         end
 
         # is it better to raise our own error, or let libvirt cause the exception?
-        raise "Only four cdroms may be attached at a time"
+        raise 'Only four cdroms may be attached at a time'
+      end
+
+      def input(options={})
+        if options[:type].nil? || options[:bus].nil?
+          raise 'Input type AND bus must be specified'
+        end
+
+        if @inputs == UNSET_VALUE
+          @inputs = []
+        end
+
+        @inputs.push({
+          type: options[:type],
+          bus:  options[:bus]
+        })
       end
 
       # NOTE: this will run twice for each time it's needed- keep it idempotent
@@ -277,6 +311,7 @@ module VagrantPlugins
         @management_network_name = 'vagrant-libvirt' if @management_network_name == UNSET_VALUE
         @management_network_address = '192.168.121.0/24' if @management_network_address == UNSET_VALUE
         @management_network_mode = 'nat' if @management_network_mode == UNSET_VALUE
+        @management_network_mac = nil if @management_network_mac == UNSET_VALUE
 
         # generate a URI if none is supplied
         @uri = _generate_uri() if @uri == UNSET_VALUE
@@ -285,8 +320,10 @@ module VagrantPlugins
         @memory = 512 if @memory == UNSET_VALUE
         @cpus = 1 if @cpus == UNSET_VALUE
         @cpu_mode = 'host-model' if @cpu_mode == UNSET_VALUE
+        @loader = nil if @loader == UNSET_VALUE
         @machine_type = nil if @machine_type == UNSET_VALUE
         @machine_arch = nil if @machine_arch == UNSET_VALUE
+        @machine_virtual_size = nil if @machine_virtual_size == UNSET_VALUE
         @disk_bus = 'virtio' if @disk_bus == UNSET_VALUE
         @nic_model_type = 'virtio' if @nic_model_type == UNSET_VALUE
         @nested = false if @nested == UNSET_VALUE
@@ -306,13 +343,15 @@ module VagrantPlugins
         @video_type = 'cirrus' if @video_type == UNSET_VALUE
         @video_vram = 9216 if @video_vram == UNSET_VALUE
         @keymap = 'en-us' if @keymap == UNSET_VALUE
-        
+        @nic_adapter_count = 8 if @nic_adapter_count == UNSET_VALUE
+
         # Boot order
         @boot_order = [] if @boot_order == UNSET_VALUE
 
         # Storage
         @disks = [] if @disks == UNSET_VALUE
         @cdroms = [] if @cdroms == UNSET_VALUE
+        @inputs = [{:type => "mouse", :bus => "ps2"}] if @inputs == UNSET_VALUE
       end
 
       def validate(machine)

data/lib/vagrant-libvirt/driver.rb

@@ -0,0 +1,121 @@
+require 'fog/libvirt'
+require 'log4r'
+
+module VagrantPlugins
+  module ProviderLibvirt
+    class Driver
+
+      # store the connection at the process level
+      #
+      # possibly this should be a connection pool using the connection
+      # settings as a key to allow per machine connection attributes
+      # to be used.
+      @@connection = nil
+
+      def initialize(machine)
+        @logger = Log4r::Logger.new('vagrant_libvirt::driver')
+        @machine = machine
+      end
+
+      def connection
+        # If already connected to libvirt, just use it and don't connect
+        # again.
+        return @@connection if @@connection
+
+        # Get config options for libvirt provider.
+        config = @machine.provider_config
+        uri = config.uri
+
+        conn_attr = {}
+        conn_attr[:provider] = 'libvirt'
+        conn_attr[:libvirt_uri] = uri
+        conn_attr[:libvirt_username] = config.username if config.username
+        conn_attr[:libvirt_password] = config.password if config.password
+
+        # Setup command for retrieving IP address for newly created machine
+        # with some MAC address. Get it from dnsmasq leases table
+        ip_command = %q[ awk "/$mac/ {print \$1}" /proc/net/arp ]
+        conn_attr[:libvirt_ip_command] = ip_command
+
+        @logger.info("Connecting to Libvirt (#{uri}) ...")
+        begin
+          @@connection = Fog::Compute.new(conn_attr)
+        rescue Fog::Errors::Error => e
+          raise Errors::FogLibvirtConnectionError,
+            :error_message => e.message
+        end
+
+        @@connection
+      end
+
+      def get_domain(mid)
+        begin
+          domain = connection.servers.get(mid)
+        rescue Libvirt::RetrieveError => e
+          if e.libvirt_code == ProviderLibvirt::Util::ErrorCodes::VIR_ERR_NO_DOMAIN
+            @logger.debug("machine #{mid} not found #{e}.")
+            return nil
+          else
+            raise e
+          end
+        end
+
+        domain
+      end
+
+      def created?(mid)
+        domain = get_domain(mid)
+        !domain.nil?
+      end
+
+      def get_ipaddress(machine)
+        # Find the machine
+        domain = get_domain(machine.id)
+
+        if domain.nil?
+          # The machine can't be found
+          return nil
+        end
+
+        # Get IP address from arp table
+        ip_address = nil
+        begin
+          domain.wait_for(2) do
+            addresses.each_pair do |type, ip|
+              # Multiple leases are separated with a newline, return only
+              # the most recent address
+              ip_address = ip[0].split("\n").first if ip[0] != nil
+            end
+            ip_address != nil
+          end
+        rescue Fog::Errors::TimeoutError
+          @logger.info("Timeout at waiting for an ip address for machine %s" % machine.name)
+        end
+
+        if not ip_address
+          @logger.info("No arp table entry found for machine %s" % machine.name)
+          return nil
+        end
+
+        ip_address
+      end
+
+      def state(machine)
+        # may be other error states with initial retreival we can't handle
+        begin
+          domain = get_domain(machine.id)
+        rescue Libvirt::RetrieveError => e
+          @logger.debug("Machine #{machine.id} not found #{e}.")
+          return :not_created
+        end
+
+        # TODO: terminated no longer appears to be a valid fog state, remove?
+        if domain.nil? || domain.state.to_sym == :terminated
+          return :not_created
+        end
+
+        return domain.state.gsub("-", "_").to_sym
+      end
+    end
+  end
+end

data/lib/vagrant-libvirt/errors.rb

@@ -106,6 +106,10 @@ module VagrantPlugins
         error_key(:activate_network_error)
       end
 
+      class TunnelPortNotDefined < VagrantLibvirtError
+        error_key(:tunnel_port_not_defined)
+      end
+
       # Other exceptions
       class InterfaceSlotNotAvailable < VagrantLibvirtError
         error_key(:interface_slot_not_available)

data/lib/vagrant-libvirt/plugin.rb

@@ -23,11 +23,7 @@ module VagrantPlugins
         Config
       end
 
-      provider('libvirt', parallel: true) do
-        # Setup logging and i18n
-        setup_logging
-        setup_i18n
-
+      provider('libvirt', parallel: true, box_optional: true) do
         require_relative 'provider'
         Provider
       end
@@ -90,6 +86,12 @@ module VagrantPlugins
         end
       end
 
+      # Setup logging and i18n before any autoloading loads other classes
+      # with logging configured as this prevents inheritance of the log level
+      # from the parent logger.
+      setup_logging
+      setup_i18n
+
     end
   end
 end

data/lib/vagrant-libvirt/provider.rb

@@ -2,6 +2,7 @@ require 'vagrant'
 
 module VagrantPlugins
   module ProviderLibvirt
+    autoload :Driver, 'vagrant-libvirt/driver'
 
     # This is the base class for a provider for the V2 API. A provider
     # is responsible for creating compute resources to match the
@@ -22,6 +23,12 @@ module VagrantPlugins
         nil
       end
 
+      def driver
+        return @driver if @driver
+
+        @driver = Driver.new(@machine)
+      end
+
       # This method is called if the underying machine ID changes. Providers
       # can use this method to load in new data for the actual backing
       # machine or to realize that the machine is now gone (the ID can
@@ -33,9 +40,8 @@ module VagrantPlugins
       # SSH into the machine. If the machine is not at a point where
       # SSH is even possible, then `nil` should be returned.
       def ssh_info
-        # Run a custom action called "read_ssh_info" which does what it says
-        # and puts the resulting SSH info into the `:machine_ssh_info` key in
-        # the environment.
+        # Return the ssh_info if already retrieved otherwise call the driver
+        # and save the result.
         #
         # Ssh info has following format..
         #
@@ -45,8 +51,32 @@ module VagrantPlugins
         #  :username => "mitchellh",
         #  :private_key_path => "/path/to/my/key"
         #}
-        env = @machine.action('read_ssh_info')
-        env[:machine_ssh_info]
+        # note that modifing @machine.id or accessing @machine.state is not
+        # thread safe, so be careful to avoid these here as this method may
+        # be called from other threads of execution.
+        return nil if state.id != :running
+
+        ip = driver.get_ipaddress(@machine)
+
+        # if can't determine the IP, just return nil and let the core
+        # deal with it, similar to the docker provider
+        return nil if !ip
+
+        ssh_info = {
+          :host          => ip,
+          :port          => @machine.config.ssh.guest_port,
+          :forward_agent => @machine.config.ssh.forward_agent,
+          :forward_x11   => @machine.config.ssh.forward_x11,
+        }
+
+        ssh_info[:proxy_command] = (
+          "ssh '#{@machine.provider_config.host}' " +
+          "-l '#{@machine.provider_config.username}' " +
+          "-i '#{@machine.provider_config.id_ssh_key_file}' " +
+          "nc %h %p"
+        ) if @machine.provider_config.connect_via_ssh
+
+        ssh_info
       end
 
       def mac_addresses
@@ -64,16 +94,28 @@ module VagrantPlugins
       # This should return the state of the machine within this provider.
       # The state must be an instance of {MachineState}.
       def state
-        # Run a custom action we define called "read_state" which does
-        # what it says. It puts the state in the `:machine_state_id`
-        # key in the environment.
-        env = @machine.action('read_state')
 
-        state_id = env[:machine_state_id]
+        state_id = nil
+        state_id = :not_created if !@machine.id
+        state_id = :not_created if (
+          !state_id && (!@machine.id || !driver.created?(@machine.id)))
+        # Query the driver for the current state of the machine
+        state_id = driver.state(@machine) if @machine.id && !state_id
+        state_id = :unknown if !state_id
+
+        # This is a special pseudo-state so that we don't set the
+        # NOT_CREATED_ID while we're setting up the machine. This avoids
+        # clearing the data dir.
+        state_id = :preparing if @machine.id == "preparing"
 
         # Get the short and long description
-        short = I18n.t("vagrant_libvirt.states.short_#{state_id}")
-        long  = I18n.t("vagrant_libvirt.states.long_#{state_id}")
+        short = state_id.to_s.gsub("_", " ")
+        long  = I18n.t("vagrant_libvirt.states.#{state_id}")
+
+        # If we're not created, then specify the special ID flag
+        if state_id == :not_created
+          state_id = Vagrant::MachineState::NOT_CREATED_ID
+        end
 
         # Return the MachineState object
         Vagrant::MachineState.new(state_id, short, long)

data/lib/vagrant-libvirt/templates/domain.xml.erb

@@ -3,15 +3,17 @@
   <memory><%= @memory_size %></memory>
   <vcpu><%= @cpus %></vcpu>
 
-  <% if @nested %>
-    <cpu mode='<%= @cpu_mode %>'>
-      <% if @cpu_mode != 'host-passthrough' %>
-        <model fallback='allow'>qemu64</model>
+
+  <cpu mode='<%= @cpu_mode %>'>
+    <% if @cpu_mode != 'host-passthrough' %>
+      <model fallback='allow'>qemu64</model>
+      <% if @nested %>
         <feature policy='optional' name='vmx'/>
         <feature policy='optional' name='svm'/>
       <% end %>
-    </cpu>
-  <% end %>
+    <% end %>
+  </cpu>
+
 
   <os>
     <% if @machine_type %>
@@ -27,13 +29,11 @@
         <type>hvm</type>
       <% end %>
     <% end %>
+    <% if @loader %>
+      <loader readonly='yes' type='rom'><%= @loader %></loader>
+    <% end %>
     <% if @boot_order.count >= 1 %>
-      <% @boot_order.each do |b| %>
-        <boot dev='<%= b %>'/>
-      <% end %> 
       <bootmenu enable='yes'/>
-    <% else %>
-      <boot dev='hd' />
     <% end %>
     <kernel><%= @kernel %></kernel>
     <initrd><%= @initrd %></initrd>
@@ -46,12 +46,14 @@
   </features>
   <clock offset='utc'/>
   <devices>
+    <% if @domain_volume_path %>
     <disk type='file' device='disk'>
       <driver name='qemu' type='qcow2' cache='<%= @domain_volume_cache %>'/>
       <source file='<%= @domain_volume_path %>'/>
       <%# we need to ensure a unique target dev -%>
       <target dev='vda' bus='<%= @disk_bus %>'/>
     </disk>
+    <% end %>
 <%# additional disks -%>
 <% @disks.each do |d| -%>
     <disk type='file' device='disk'>
@@ -78,7 +80,11 @@
     <console type='pty'>
       <target port='0'/>
     </console>
-    <input type='mouse' bus='ps2'/>
+
+<% @inputs.each do |input| %>
+    <input type='<%= input[:type] %>' bus='<%= input[:bus] %>'/>
+<% end %>
+
     <%# Video device -%>
     <graphics type='<%= @graphics_type %>' port='<%= @graphics_port %>' autoport='<%= @graphics_autoport %>' listen='<%= @graphics_ip %>' keymap='<%= @keymap %>' <%= @graphics_passwd%> />
       <video>