vagrant-libvirt 0.0.41 → 0.0.42

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

@@ -0,0 +1,151 @@
+require 'nokogiri'
+require 'vagrant/util/network_ip'
+
+module VagrantPlugins
+  module ProviderLibvirt
+    module Util
+      module NetworkUtil
+        include Vagrant::Util::NetworkIP
+
+        def configured_networks(env, logger)
+          management_network_name = env[:machine].provider_config.management_network_name
+          management_network_address = env[:machine].provider_config.management_network_address
+          management_network_mode = env[:machine].provider_config.management_network_mode
+          management_network_mac = env[:machine].provider_config.management_network_mac
+          management_network_guest_ipv6 = env[:machine].provider_config.management_network_guest_ipv6
+          management_network_autostart = env[:machine].provider_config.management_network_autostart
+          management_network_pci_bus = env[:machine].provider_config.management_network_pci_bus
+          management_network_pci_slot = env[:machine].provider_config.management_network_pci_slot
+          logger.info "Using #{management_network_name} at #{management_network_address} as the management network #{management_network_mode} is the mode"
+
+          begin
+            management_network_ip = IPAddr.new(management_network_address)
+          rescue ArgumentError
+            raise Errors::ManagementNetworkError,
+                  error_message: "#{management_network_address} is not a valid IP address"
+          end
+
+          # capture address into $1 and mask into $2
+          management_network_ip.inspect =~ /IPv4:(.*)\/(.*)>/
+
+          if Regexp.last_match(2) == '255.255.255.255'
+            raise Errors::ManagementNetworkError,
+                  error_message: "#{management_network_address} does not include both an address and subnet mask"
+          end
+
+          management_network_options = {
+            iface_type: :private_network,
+            network_name: management_network_name,
+            ip: Regexp.last_match(1),
+            netmask: Regexp.last_match(2),
+            dhcp_enabled: true,
+            forward_mode: management_network_mode,
+            guest_ipv6: management_network_guest_ipv6,
+            autostart: management_network_autostart,
+            bus: management_network_pci_bus,
+            slot: management_network_pci_slot
+          }
+
+          unless management_network_mac.nil?
+            management_network_options[:mac] = management_network_mac
+          end
+
+          unless management_network_pci_bus.nil? and management_network_pci_slot.nil?
+            management_network_options[:bus] = management_network_pci_bus
+            management_network_options[:slot] = management_network_pci_slot
+          end
+
+          if (env[:machine].config.vm.box &&
+              !env[:machine].provider_config.mgmt_attach)
+            raise Errors::ManagementNetworkRequired
+          end
+
+          # add management network to list of networks to check
+          # unless mgmt_attach set to false
+          networks = if env[:machine].provider_config.mgmt_attach
+                       [management_network_options]
+                     else
+                       []
+                     end
+
+          env[:machine].config.vm.networks.each do |type, original_options|
+            logger.debug "In config found network type #{type} options #{original_options}"
+            # Options can be specified in Vagrantfile in short format (:ip => ...),
+            # or provider format # (:libvirt__network_name => ...).
+            # https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/util/scoped_hash_override.rb
+            options = scoped_hash_override(original_options, :libvirt)
+            # store type in options
+            # use default values if not already set
+            options = {
+              iface_type:  type,
+              netmask:      '255.255.255.0',
+              dhcp_enabled: true,
+              forward_mode: 'nat'
+            }.merge(options)
+
+            if options[:type].to_s == 'dhcp' && options[:ip].nil?
+              options[:network_name] = 'vagrant-private-dhcp'
+            end
+
+            # add to list of networks to check
+            networks.push(options)
+          end
+
+          networks
+        end
+
+        # Return a list of all (active and inactive) libvirt networks as a list
+        # of hashes with their name, network address and status (active or not)
+        def libvirt_networks(libvirt_client)
+          libvirt_networks = []
+
+          active = libvirt_client.list_networks
+          inactive = libvirt_client.list_defined_networks
+
+          # Iterate over all (active and inactive) networks.
+          active.concat(inactive).each do |network_name|
+            libvirt_network = libvirt_client.lookup_network_by_name(
+              network_name
+            )
+
+            # Parse ip address and netmask from the network xml description.
+            xml = Nokogiri::XML(libvirt_network.xml_desc)
+            ip = xml.xpath('/network/ip/@address').first
+            ip = ip.value if ip
+            netmask = xml.xpath('/network/ip/@netmask').first
+            netmask = netmask.value if netmask
+
+            dhcp_enabled = if xml.at_xpath('//network/ip/dhcp')
+                             true
+                           else
+                             false
+                           end
+
+            domain_name = xml.at_xpath('/network/domain/@name')
+            domain_name = domain_name.value if domain_name
+
+            # Calculate network address of network from ip address and
+            # netmask.
+            network_address = (network_address(ip, netmask) if ip && netmask)
+
+            libvirt_networks << {
+              name:             network_name,
+              ip_address:       ip,
+              netmask:          netmask,
+              network_address:  network_address,
+              dhcp_enabled:     dhcp_enabled,
+              bridge_name:      libvirt_network.bridge_name,
+              domain_name:      domain_name,
+              created:          true,
+              active:           libvirt_network.active?,
+              autostart:        libvirt_network.autostart?,
+              libvirt_network:  libvirt_network
+            }
+          end
+
+          libvirt_networks
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module VagrantPlugins
+  module ProviderLibvirt
+    module Util
+      class Timer
+        # A basic utility method that times the execution of the given
+        # block and returns it.
+        def self.time
+          start_time = Time.now.to_f
+          yield
+          end_time = Time.now.to_f
+
+          end_time - start_time
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-libvirt/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module ProviderLibvirt
+    VERSION = '0.0.42'.freeze
+  end
+end

data/locales/en.yml

@@ -0,0 +1,162 @@
+en:
+  vagrant_libvirt:
+    already_created: |-
+      The domain is already created.
+    not_created: |-
+      Domain is not created. Please run `vagrant up` first.
+    not_running: |-
+      Domain is not running. Please run `vagrant up` or `vagrant resume` first.
+    not_suspended: |-
+      Domain is not suspended.
+    finding_volume: |-
+      Checking if volume is available.
+    creating_domain: |-
+      Creating domain with the following settings...
+    manual_resize_required: |-
+      Created volume larger than box defaults, will require manual resizing of
+      filesystems to utilize.
+    uploading_volume: |-
+      Uploading base box image as volume into libvirt storage...
+    creating_domain_volume: |-
+      Creating image (snapshot of base box volume).
+    removing_domain_volume: |-
+      Removing image (snapshot of base box volume).
+    starting_domain: |-
+      Starting domain.
+    terminating: |-
+      Removing domain...
+    poweroff_domain: |-
+      Poweroff domain.
+    destroy_domain: |-
+      Removing domain...
+    halt_domain: |-
+      Halting domain...
+    resuming_domain: |-
+      Resuming domain...
+    suspending_domain: |-
+      Suspending domain...
+    waiting_for_ready: |-
+      Waiting for domain to become "ready"...
+    waiting_for_ip: |-
+      Waiting for domain to get an IP address...
+    waiting_for_ssh: |-
+      Waiting for SSH to become available...
+    booted: |-
+      Machine is booted.
+    rsync_folder: |-
+      Rsyncing folder: %{hostpath} => %{guestpath}
+    ready: |-
+      Machine is booted and ready for use!
+    remove_stale_volume: |-
+      Remove stale volume...
+
+    warnings:
+      ignoring_virtual_size_too_small: |-
+        Ignoring requested virtual disk size of '%{requested}' as it is below
+        the minimum box image size of '%{minimum}'.
+      forwarding_udp: |-
+        Forwarding UDP ports is not supported. Ignoring.
+
+    errors:
+      package_not_supported: No support for package with libvirt. Create box manually.
+      fog_error: |-
+        There was an error talking to Libvirt. The error message is shown
+        below:
+
+        %{message}
+      no_matching_volume: |-
+        No matching volume was found! Please check your volume setting
+        to make sure you have a valid volume chosen.
+      no_storage_pool: |-
+        No usable storage pool found! Please check if storage pool is
+        created and available.
+      no_box_volume: |-
+        Volume for box image is missing in storage pools. Try to run vagrant
+        again, or check if storage volume is accessible.
+      domain_volume_exists: |-
+        Volume for domain is already created. Please run 'vagrant destroy' first.
+      no_domain_volume: |-
+        Volume for domain is missing. Try to run 'vagrant up' again.
+      interface_slot_not_available: |-
+        Interface adapter number is already in use. Please specify other adapter number.
+      interface_slot_exhausted: |-
+        Available interface adapters have been exhausted. Please increase the nic_adapter_count.
+      rsync_error: |-
+        There was an error when attempting to rsync a share folder.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Guest path: %{guestpath}
+        Error: %{stderr}
+      no_box_virtual_size: |-
+        No image virtual size specified for box.
+      no_box_format: |-
+        No image format specified for box.
+      wrong_box_format: |-
+        Wrong image format specified for box.
+      fog_libvirt_connection_error: |-
+        Error while connecting to libvirt: %{error_message}
+      fog_create_volume_error: |-
+        Error while creating a storage pool volume: %{error_message}
+      fog_create_domain_volume_error: |-
+        Error while creating volume for domain: %{error_message}
+      fog_create_server_error: |-
+        Error while creating domain: %{error_message}
+      domain_name_exists: |-
+        Name `%{domain_name}` of domain about to create is already taken. Please try to run
+        `vagrant up` command again.
+      creating_storage_pool_error: |-
+        There was error while creating libvirt storage pool: %{error_message}
+      image_upload_error: |-
+        Error while uploading image to storage pool: %{error_message}
+      no_domain_error: |-
+        No domain found. %{error_message}
+      attach_device_error: |-
+        Error while attaching new device to domain. %{error_message}
+      detach_device_error: |-
+        Error while detaching device from domain. %{error_message}
+      no_ip_address_error: |-
+        No IP address found.
+      management_network_error: |-
+        Error in specification of management network: %{error_message}.
+      network_name_and_address_mismatch: |-
+        Address %{ip_address} does not match with network name %{network_name}.
+        Please fix your configuration and run vagrant again.
+      dhcp_mismatch: |-
+        Network %{network_name} exists but does not have dhcp %{requested}.
+        Please fix your configuration and run vagrant again.
+      create_network_error: |-
+        Error occurred while creating new network: %{error_message}.
+      network_not_available_error: |-
+        Network %{network_name} is not available. Specify available network
+        name, or an ip address if you want to create a new network.
+      activate_network_error: |-
+        Error while activating network: %{error_message}.
+      autostart_network_error: |-
+        Error while setting up autostart on network: %{error_message}.
+      destroy_network_error: |-
+        Error while removing network %{network_name}. %{error_message}.
+      delete_snapshot_error: |-
+        Error while deleting snapshot: %{error_message}.
+      tunnel_port_not_defined: |-
+         tunnel UDP or TCP port not defined.
+      management_network_required: |-
+        Management network can't be disabled when VM use box.
+        Please fix your configuration and run vagrant again.
+
+    states:
+      paused: |-
+        The Libvirt domain is suspended. Run `vagrant resume` to resume it.
+      shutting_down: |-
+        The Libvirt domain is shutting down. Wait for it to complete and
+        then run `vagrant up` to start it or `vagrant destroy` to remove.
+      shutoff: |-
+        The Libvirt domain is not running. Run `vagrant up` to start it.
+      not_created: |-
+        The Libvirt domain is not created. Run `vagrant up` to create it.
+      running: |-
+        The Libvirt domain is running. To stop this machine, you can run
+        `vagrant halt`. To destroy the machine, you can run `vagrant destroy`.
+      preparing: |-
+        The vagrant machine is being prepared for creation, please wait for
+        it to reach a steady state before issuing commands on it.

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'vagrant-libvirt'
+require 'support/environment_helper'
+require 'vagrant-spec/unit'
+
+RSpec.configure do |spec|
+end

data/spec/support/environment_helper.rb

@@ -0,0 +1,46 @@
+require 'ostruct'
+require 'pathname'
+
+class EnvironmentHelper
+  attr_writer :domain_name
+
+  attr_accessor :random_hostname, :name, :default_prefix
+
+  def [](value)
+    send(value.to_sym)
+  end
+
+  def cpus
+    4
+  end
+
+  def memory
+    1024
+  end
+
+  %w(cpus cpu_mode loader boot_order machine_type disk_bus disk_device nested volume_cache kernel cmd_line initrd graphics_type graphics_autoport graphics_port graphics_ip graphics_passwd video_type video_vram keymap storage_pool_name disks cdroms driver).each do |name|
+    define_method(name.to_sym) do
+      nil
+    end
+  end
+
+  def machine
+    self
+  end
+
+  def provider_config
+    self
+  end
+
+  def root_path
+    Pathname.new('./spec/support/foo')
+  end
+
+  def domain_name
+    # noop
+  end
+
+  def libvirt_compute
+    OpenStruct.new(servers: [])
+  end
+end

data/spec/support/libvirt_context.rb

@@ -0,0 +1,30 @@
+require 'fog/libvirt'
+
+shared_context 'libvirt' do
+  include_context 'unit'
+
+  let(:libvirt_context) { true                      }
+  let(:id)              { 'dummy-vagrant_dummy'     }
+  let(:connection)      { double('connection') }
+  let(:domain)          { double('domain') }
+
+  def connection_result(options = {})
+    result = options.fetch(:result, nil)
+    double('connection_result' => result)
+  end
+
+  before (:each) do
+    # we don't want unit tests to ever run commands on the system; so we wire
+    # in a double to ensure any unexpected messages raise exceptions
+    stub_const('::Fog::Compute', connection)
+
+    # drivers also call vm_exists? during init;
+    allow(connection).to receive(:servers).with(kind_of(String))
+      .and_return(connection_result(result: nil))
+
+    # return some information for domain when needed
+    allow(domain).to receive(:mac).and_return('9C:D5:53:F1:5A:E7')
+
+    machine.stub(id: id)
+  end
+end

data/spec/support/sharedcontext.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+shared_context 'unit' do
+  include_context 'vagrant-unit'
+
+  let(:vagrantfile) do
+    <<-EOF
+    Vagrant.configure('2') do |config|
+      config.vm.define :test
+    end
+    EOF
+  end
+  let(:test_env) do
+    test_env = isolated_environment
+    test_env.vagrantfile vagrantfile
+    test_env
+  end
+  let(:env)              { { env: iso_env, machine: machine, ui: ui, root_path: '/rootpath' } }
+  let(:conf)             { Vagrant::Config::V2::DummyConfig.new }
+  let(:ui)               { Vagrant::UI::Basic.new }
+  let(:iso_env)          { test_env.create_vagrant_env ui_class: Vagrant::UI::Basic }
+  let(:machine)          { iso_env.machine(:test, :libvirt) }
+  # Mock the communicator to prevent SSH commands for being executed.
+  let(:communicator)     { double('communicator') }
+  # Mock the guest operating system.
+  let(:guest)            { double('guest') }
+  let(:app)              { ->(env) {} }
+  let(:plugin)           { register_plugin }
+
+  before (:each) do
+    machine.stub(guest: guest)
+    machine.stub(communicator: communicator)
+  end
+end