vagrant-libvirt 0.1.0 → 0.4.1

data/lib/vagrant-libvirt/driver.rb

@@ -60,12 +60,12 @@ module VagrantPlugins
         @@system_connection
       end
 
-      def get_domain(mid)
+      def get_domain(machine)
         begin
-          domain = connection.servers.get(mid)
+          domain = connection.servers.get(machine.id)
         rescue Libvirt::RetrieveError => e
           if e.libvirt_code == ProviderLibvirt::Util::ErrorCodes::VIR_ERR_NO_DOMAIN
-            @logger.debug("machine #{mid} not found #{e}.")
+            @logger.debug("machine #{machine.name} domain not found #{e}.")
             return nil
           else
             raise e
@@ -75,36 +75,35 @@ module VagrantPlugins
         domain
       end
 
-      def created?(mid)
-        domain = get_domain(mid)
+      def created?(machine)
+        domain = get_domain(machine)
         !domain.nil?
       end
 
       def get_ipaddress(machine)
         # Find the machine
-        domain = get_domain(machine.id)
-        if @machine.provider_config.qemu_use_session
-          return get_ipaddress_system domain.mac
-        end
+        domain = get_domain(machine)
 
         if domain.nil?
           # The machine can't be found
           return nil
         end
 
-        # Get IP address from arp table
-        ip_address = nil
+        get_domain_ipaddress(machine, domain)
+      end
+
+      def get_domain_ipaddress(machine, domain)
+        if @machine.provider_config.qemu_use_session
+          return get_ipaddress_from_system domain.mac
+        end
+
+        # Get IP address from dhcp leases table
         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 unless ip[0].nil?
-            end
-            !ip_address.nil?
-          end
+          ip_address = get_ipaddress_from_domain(domain)
         rescue Fog::Errors::TimeoutError
           @logger.info('Timeout at waiting for an ip address for machine %s' % machine.name)
+
+          raise
         end
 
         unless ip_address
@@ -115,7 +114,24 @@ module VagrantPlugins
         ip_address
       end
 
-      def get_ipaddress_system(mac)
+      def state(machine)
+        # may be other error states with initial retreival we can't handle
+        begin
+          domain = get_domain(machine)
+        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?
+        return :not_created if domain.nil? || domain.state.to_sym == :terminated
+
+        domain.state.tr('-', '_').to_sym
+      end
+
+      private
+
+      def get_ipaddress_from_system(mac)
         ip_address = nil
 
         system_connection.list_all_networks.each do |net|
@@ -125,23 +141,24 @@ module VagrantPlugins
           break if ip_address
         end
 
-        return ip_address
+        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
+      def get_ipaddress_from_domain(domain)
+        ip_address = nil
+        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
 
-        # TODO: terminated no longer appears to be a valid fog state, remove?
-        return :not_created if domain.nil? || domain.state.to_sym == :terminated
+          ip_address != nil
+        end
 
-        domain.state.tr('-', '_').to_sym
+        ip_address
       end
+
     end
   end
 end

data/lib/vagrant-libvirt/plugin.rb

@@ -26,6 +26,7 @@ module VagrantPlugins
       end
 
       action_hook(:remove_libvirt_image) do |hook|
+        require_relative 'action'
         hook.after Vagrant::Action::Builtin::BoxRemove, Action.remove_libvirt_image
       end
 
@@ -39,6 +40,11 @@ module VagrantPlugins
         Cap::NicMacAddresses
       end
 
+      provider_capability(:libvirt, :public_address) do
+        require_relative 'cap/public_address'
+        Cap::PublicAddress
+      end
+
       # lower priority than nfs or rsync
       # https://github.com/vagrant-libvirt/vagrant-libvirt/pull/170
       synced_folder('9p', 4) do

data/lib/vagrant-libvirt/provider.rb

@@ -68,14 +68,7 @@ module VagrantPlugins
           forward_x11: @machine.config.ssh.forward_x11
         }
 
-        if @machine.provider_config.connect_via_ssh
-          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'
-
-        end
+        ssh_info[:proxy_command] = @machine.provider_config.proxy_command if @machine.provider_config.proxy_command
 
         ssh_info
       end
@@ -98,7 +91,7 @@ module VagrantPlugins
         state_id = nil
         state_id = :not_created unless @machine.id
         state_id = :not_created if
-          !state_id && (!@machine.id || !driver.created?(@machine.id))
+          !state_id && (!@machine.id || !driver.created?(@machine))
         # Query the driver for the current state of the machine
         state_id = driver.state(@machine) if @machine.id && !state_id
         state_id = :unknown unless state_id

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

@@ -1,5 +1,7 @@
 <domain type='<%= @domain_type %>' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
   <name><%= @name %></name>
+  <title><%= @title %></title>
+  <description><%= @description %></description>
   <uuid><%= @uuid %></uuid>
   <memory><%= @memory_size %></memory>
   <vcpu<% if @cpuset %> cpuset='<%= @cpuset %>'<% end %>><%= @cpus %></vcpu>
@@ -102,14 +104,22 @@
     </hyperv>
     <% end %>
   </features>
-  <clock offset='utc'/>
+  <clock offset='<%= @clock_offset %>'>
+  <% @clock_timers.each do |clock_timer| %>
+    <timer<% clock_timer.each do |attr, value| %> <%= attr %>='<%= value %>'<% end %>/>
+  <% end %>
+  </clock>
   <devices>
     <% if @emulator_path %>
     <emulator><%= @emulator_path %></emulator>
     <% end %>
     <% if @domain_volume_path %>
     <disk type='file' device='disk'>
-      <driver name='qemu' type='qcow2' cache='<%= @domain_volume_cache %>'/>
+      <driver name='qemu' type='qcow2' <%=
+        @disk_driver_opts.empty? ? "cache='#{@domain_volume_cache}'" :
+            @disk_driver_opts.reject { |k,v| v.nil? }
+                             .map { |k,v| "#{k}='#{v}'"}
+                             .join(' ') -%>/>
       <source file='<%= @domain_volume_path %>'/>
       <%# we need to ensure a unique target dev -%>
       <target dev='<%= @disk_device %>' bus='<%= @disk_bus %>'/>
@@ -118,7 +128,12 @@
 <%# additional disks -%>
 <% @disks.each do |d| -%>
     <disk type='file' device='disk'>
-      <driver name='qemu' type='<%= d[:type] %>' cache='<%= d[:cache] %>'/>
+      <driver name='qemu' type='<%= d[:type] %>' <%=
+        d.select { |k,_| [:cache, :io, :copy_on_read, :discard, :detect_zeroes].include? k }
+         .reject { |k,v| v.nil? }
+         .map { |k,v| "#{k}='#{v}'"}
+         .join(' ')
+      -%>/>
       <source file='<%= d[:absolute_path] %>'/>
       <target dev='<%= d[:device] %>' bus='<%= d[:bus] %>'/>
       <% if d[:shareable] %>
@@ -127,6 +142,9 @@
       <% if d[:serial] %>
         <serial><%= d[:serial] %></serial>
       <% end %>
+      <% if d[:wwn] %>
+        <wwn><%= d[:wwn] %></wwn>
+      <% end %>
 <%# this will get auto generated by Libvirt
       <address type='pci' domain='0x0000' bus='0x00' slot='???' function='0x0'/>
 -%>
@@ -252,11 +270,13 @@
       <% end %>
     <% end -%>
 
-    <% if @tpm_path -%>
+    <% if @tpm_path || @tpm_version -%>
     <%# TPM Device -%>
     <tpm model='<%= @tpm_model %>'>
-      <backend type='<%= @tpm_type %>'>
+      <backend type='<%= @tpm_type %>'<% if @tpm_version %> version='<%= @tpm_version %>'<% end %>>
+        <% if @tpm_path -%>
         <device path='<%= @tpm_path %>'/>
+        <% end -%>
       </backend>
     </tpm>
     <% end -%>
@@ -264,6 +284,15 @@
     <%# USB Controller -%>
     <controller type='usb' model='<%= @usbctl_dev[:model] %>' <%= "ports=\"#{@usbctl_dev[:ports]}\" " if @usbctl_dev[:ports] %>/>
     <% end %>
+    <% unless @memballoon_enabled.nil? %>
+    <% if @memballoon_enabled %>
+    <memballoon model='<%= @memballoon_model %>'>
+      <address type='pci' domain='0x0000' bus='<%= @memballoon_pci_bus %>' slot='<%= @memballoon_pci_slot %>' function='0x0'/>
+    </memballoon>
+    <% else %>
+    <memballoon model='none'/>
+    <% end %>
+    <% end %>
   </devices>
 
   <% if not @qemu_args.empty? or not @qemu_env.empty? %>

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

@@ -18,7 +18,11 @@
     <driver name='<%=@driver_name%>'/>
   <% end %>
   <% if @ovs %>
-  <virtualport type='openvswitch'/>
+  <virtualport type='openvswitch'>
+    <% if @ovs_interfaceid %>
+      <parameters interfaceid='<%=@ovs_interfaceid%>'/>
+    <% end %>
+  </virtualport>
   <% end %>
   <% if @pci_bus and @pci_slot %>
   <address type='pci' bus='<%=@pci_bus%>' slot='<%=@pci_slot%>' />

data/lib/vagrant-libvirt/util.rb

@@ -7,6 +7,7 @@ module VagrantPlugins
       autoload :NetworkUtil, 'vagrant-libvirt/util/network_util'
       autoload :StorageUtil, 'vagrant-libvirt/util/storage_util'
       autoload :ErrorCodes, 'vagrant-libvirt/util/error_codes'
+      autoload :Ui, 'vagrant-libvirt/util/ui'
     end
   end
 end

data/lib/vagrant-libvirt/util/erb_template.rb

@@ -1,20 +1,19 @@
-require 'erubis'
-
 module VagrantPlugins
   module ProviderLibvirt
     module Util
       module ErbTemplate
         # TODO: remove and use nokogiri builder
-        # TODO: might be a chance to use vagrant template system according to https://github.com/mitchellh/vagrant/issues/3231
         def to_xml(template_name = nil, data = binding)
           erb = template_name || self.class.to_s.split('::').last.downcase
-          path = File.join(File.dirname(__FILE__), '..', 'templates',
-                           "#{erb}.xml.erb")
-          template = File.read(path)
+          path = File.join(File.dirname(__FILE__), '..', 'templates')
+          template = "#{erb}.xml"
 
           # TODO: according to erubis documentation, we should rather use evaluate and forget about
           # binding since the template may then change variables values
-          Erubis::Eruby.new(template, trim: true).result(data)
+          Vagrant::Util::TemplateRenderer.render_with(:render, template, template_root: path) do |renderer|
+            iv = data.eval ("instance_variables.collect {|i| [i, instance_variable_get(i.to_sym)]}")
+            iv.each {|k, v| renderer.instance_variable_set(k, v)}
+          end
         end
       end
     end

data/lib/vagrant-libvirt/util/ui.rb

@@ -0,0 +1,23 @@
+
+module VagrantPlugins
+  module ProviderLibvirt
+    module Util
+      module Ui
+        # Since v2.2.8 Vagrant support --no-tty option, which silences
+        # progress bars and other interactive elements for cleaner logs
+        # in scripts, but requires a slight change in UI object handling.
+        # This helper allows the vagrant-libvirt plugin to stay compatible
+        # with the older Vagrant versions.
+        # See: https://github.com/hashicorp/vagrant/pull/11465/
+        def rewriting(ui)
+          if ui.respond_to?(:rewriting)
+            ui.rewriting {|rw| yield rw}
+          else
+            yield ui
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/vagrant-libvirt/version

@@ -0,0 +1 @@
+0.4.1

data/lib/vagrant-libvirt/version.rb

@@ -1,5 +1,76 @@
+require 'open3'
+require 'tmpdir'
+
 module VagrantPlugins
   module ProviderLibvirt
-    VERSION = '0.1.0'.freeze
+    VERSION_FILE = File.dirname(__FILE__) + "/version"
+
+    GIT_ARCHIVE_VERSION = "$Format:%H %D$"
+
+    HOMEPAGE = 'https://github.com/vagrant-libvirt/vagrant-libvirt'
+
+    def self.get_version
+      if File.exist?(VERSION_FILE)
+        # built gem
+        version = File.read(VERSION_FILE)
+      elsif self.inside_git_repository
+        # local repo
+        git_version = `git describe --tags`
+        version = self.version_from_describe(git_version)
+      elsif !GIT_ARCHIVE_VERSION.start_with?('$Format')
+        # archive - format string replaced during export
+        hash, refs = GIT_ARCHIVE_VERSION.split(' ', 2)
+
+        tag = refs.split(',').select { |ref| ref.strip.start_with?("tag:") }.first
+        if tag != nil
+          # tagged
+          version = tag.strip.split(' ').last
+        else
+          version = ""
+          # arbitrary branch/commit
+          Dir.mktmpdir do |dir|
+            stdout_and_stderr, status = Open3.capture2e("git -C #{dir} clone --bare #{HOMEPAGE}")
+            raise "failed to clone original to resolve version: #{stdout_and_stderr}" unless status.success?
+
+            stdout_and_stderr, status = Open3.capture2e("git --git-dir=#{dir}/vagrant-libvirt.git describe --tags #{hash}")
+            raise "failed to determine version for #{hash}: #{stdout_and_stderr}" unless status.success?
+
+            version = version_from_describe(stdout_and_stderr)
+          end
+
+          # in this case write the version file to avoid cloning a second time
+          File.write(VERSION_FILE, version)
+        end
+      else
+        # no idea
+        version = "9999"
+      end
+
+      return version.freeze
+    end
+
+    def self.write_version
+      File.write(VERSION_FILE, self.get_version)
+    end
+
+    private
+
+    def self.inside_git_repository
+      _, status = Open3.capture2e("git rev-parse --git-dir")
+
+      status.success?
+    end
+
+    def self.version_from_describe(describe)
+      version_parts = describe.split('-').first(2) # drop the git sha if it exists
+      if version_parts.length > 1
+        # increment the patch number so that this is marked as a pre-release of the
+        # next possible release
+        main_version_parts = Gem::Version.new(version_parts[0]).segments
+        main_version_parts[-1] = main_version_parts.last + 1
+        version_parts = main_version_parts + ["pre", version_parts[1]]
+      end
+      version = version_parts.join(".")
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,31 @@
-require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
+require 'simplecov-lcov'
+
+# patch simplecov configuration
+if ! SimpleCov::Configuration.method_defined? :branch_coverage?
+  module SimpleCov
+    module Configuration
+      def branch_coverage?
+        return false
+      end
+    end
+  end
+end
+
+SimpleCov::Formatter::LcovFormatter.config do |config|
+  config.report_with_single_file = true
+  config.single_report_path = 'coverage/lcov.info'
+end
+
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::LcovFormatter,
+  ]
+)
+SimpleCov.start do
+  add_filter 'spec/'
+end
 
 require 'vagrant-libvirt'
 require 'support/environment_helper'