vagrant-libvirt 0.4.1 → 0.5.0

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

@@ -1,6 +1,6 @@
 <network ipv6='<%= @guest_ipv6 %>'>
   <name><%= @network_name %></name>
-  <bridge name="<%= @network_bridge_name %>" />
+  <bridge name="<%= @network_bridge_name %>" stp="<%= @network_bridge_stp %>" delay="<%= @network_bridge_delay %>" />
 
   <% if @network_domain_name %>
     <domain name="<%= @network_domain_name %>" localOnly="yes" />

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

@@ -1,6 +1,15 @@
+require 'ipaddr'
 require 'nokogiri'
 require 'vagrant/util/network_ip'
 
+class IPAddr
+  def get_mask
+    if @addr
+      _to_string(@mask_addr)
+    end
+  end
+end
+
 module VagrantPlugins
   module ProviderLibvirt
     module Util
@@ -19,6 +28,7 @@ module VagrantPlugins
           management_network_pci_bus = env[:machine].provider_config.management_network_pci_bus
           management_network_pci_slot = env[:machine].provider_config.management_network_pci_slot
           management_network_domain = env[:machine].provider_config.management_network_domain
+          management_network_mtu = env[:machine].provider_config.management_network_mtu
           logger.info "Using #{management_network_name} at #{management_network_address} as the management network #{management_network_mode} is the mode"
 
           begin
@@ -70,6 +80,10 @@ module VagrantPlugins
             management_network_options[:domain_name] = management_network_domain
           end
 
+          unless management_network_mtu.nil?
+            management_network_options[:mtu] = management_network_mtu
+          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
@@ -97,14 +111,18 @@ module VagrantPlugins
             # store type in options
             # use default values if not already set
             options = {
-              iface_type:  type,
-              netmask:      '255.255.255.0',
+              iface_type:   type,
+              netmask:      options[:network_address] ?
+                            IPAddr.new(options[:network_address]).get_mask :
+                            '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'
+              options[:network_name] = options[:network_name] ?
+                                       options[:network_name] :
+                                       'vagrant-private-dhcp'
             end
 
             # add to list of networks to check

data/lib/vagrant-libvirt/version

@@ -1 +1 @@
-0.4.1
+0.5.0

data/locales/en.yml

@@ -72,6 +72,14 @@ en:
       no_storage_pool: |-
         No usable storage pool found! Please check if storage pool is
         created and available.
+      box_format_duplicate_volume: |-
+        Encountered a duplicate volume name '%{volume}' generated for disk '%{new_disk}', due to already allocated for disk '%{orig_disk}'.
+      box_format_missing_attribute: |-
+        Invalid box metadata, missing expected attribute: '%{attribute}'
+      bad_box_image: |-
+        Received error when query the box image details from '%{image}'.
+        Stdout: %{out}
+        Stderr: %{err}
       no_box_volume: |-
         Volume for box image is missing in storage pools. Try to run vagrant
         again, or check if storage volume is accessible.
@@ -92,10 +100,14 @@ en:
         Error: %{stderr}
       no_box_virtual_size: |-
         No image virtual size specified for box.
+      no_disk_virtual_size: |-
+        No image virtual size specified for disk with index %{disk_index}.
       no_box_format: |-
         No image format specified for box.
       wrong_box_format: |-
         Wrong image format specified for box.
+      wrong_disk_format: |-
+        Wrong image format specified for disk with index %{disk_index}.
       fog_libvirt_connection_error: |-
         Error while connecting to Libvirt: %{error_message}
       fog_create_volume_error: |-

data/spec/spec_helper.rb

@@ -31,5 +31,13 @@ require 'vagrant-libvirt'
 require 'support/environment_helper'
 require 'vagrant-spec/unit'
 
-RSpec.configure do |spec|
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |f| require f }
+
+RSpec.configure do |config|
+  # ensure that setting of LIBVIRT_DEFAULT_URI in the environment is not picked
+  # up directly by tests, instead they must set as needed. Some build envs will
+  # may have it set to 'qemu:///session'.
+  config.before(:suite) do
+    ENV.delete('LIBVIRT_DEFAULT_URI')
+  end
 end

data/spec/support/matchers/have_file_content.rb

@@ -0,0 +1,63 @@
+require "rspec/expectations/version"
+#
+# Taken from https://github.com/cucumber/aruba/blob/main/lib/aruba/matchers/file/have_file_content.rb
+# with minor modifications
+#
+# @!method have_file_content(content)
+#   This matchers checks if <file> has content. `content` can be a string,
+#   regexp or an RSpec matcher.
+#
+#   @param [String, Regexp, Matcher] content
+#     Specifies the content of the file
+#
+#   @return [Boolean] The result
+#
+#     false:
+#     * if file does not exist
+#     * if file content is not equal string
+#     * if file content does not include regexp
+#     * if file content does not match the content specification
+#
+#     true:
+#     * if file content includes regexp
+#     * if file content is equal string
+#     * if file content matches the content specification
+#
+#   @example Use matcher with string
+#
+#     RSpec.describe do
+#       it { expect(file1).to have_file_content('a') }
+#     end
+#
+#   @example Use matcher with regexp
+#
+#     RSpec.describe do
+#       it { expect(file1).to have_file_content(/a/) }
+#     end
+#
+#   @example Use matcher with an RSpec matcher
+#
+#     RSpec.describe do
+#       it { expect(file1).to have_file_content(a_string_starting_with 'a') }
+#       it { expect(files1).to include a_file_having_content(a_string_starting_with 'a') }
+#     end
+RSpec::Matchers.define :have_file_content do |expected|
+  match do |actual|
+    next false unless File.exists?(actual)
+
+    @actual   = File.read(actual).chomp
+    @expected = if expected.is_a? String
+                  expected.chomp
+                else
+                  expected
+                end
+
+    values_match?(@expected, @actual)
+  end
+
+  diffable if expected.is_a? String
+
+  description { "have file content: #{description_of expected}" }
+end
+
+RSpec::Matchers.alias_matcher :a_file_having_content, :have_file_content

data/spec/unit/action/clean_machine_folder_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'support/sharedcontext'
+
+require 'vagrant-libvirt/action/clean_machine_folder'
+
+describe VagrantPlugins::ProviderLibvirt::Action::CleanMachineFolder do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+
+  describe '#call' do
+    context 'with default options' do
+      it 'should verbosely remove the folder' do
+        expect(ui).to receive(:info).with('Deleting the machine folder')
+        expect(FileUtils).to receive(:rm_rf).with(machine.data_dir, {:secure => true})
+
+        expect(subject.call(env)).to be_nil
+      end
+    end
+
+    context 'when the data dir doesn\'t exist' do
+      before do
+        Dir.mktmpdir do |d|
+          # returns a temporary directory that has been already deleted when running
+          expect(machine).to receive(:data_dir).and_return(d.to_s).exactly(2).times
+        end
+      end
+
+      it 'should remove the folder' do
+        expect(ui).to receive(:info).with('Deleting the machine folder')
+        expect(FileUtils).to receive(:rm_rf).with(machine.data_dir, {:secure => true})
+
+        expect(subject.call(env)).to be_nil
+      end
+    end
+
+    context 'with quiet option enabled' do
+      subject { described_class.new(app, env, {:quiet => true}) }
+
+      it 'should quietly remove the folder' do
+        expect(ui).to_not receive(:info).with('Deleting the machine folder')
+        expect(FileUtils).to receive(:rm_rf).with(machine.data_dir, {:secure => true})
+
+        expect(subject.call(env)).to be_nil
+      end
+    end
+  end
+end

data/spec/unit/action/create_domain_spec.rb

@@ -31,6 +31,12 @@ describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
 
       env[:domain_name] = "vagrant-test_default"
 
+      env[:box_volumes] = []
+      env[:box_volumes].push({
+        :path=>"/test/box.img",
+        :name=>"test_vagrant_box_image_1.1.1_0.img", 
+        :virtual_size=>5
+      })
       # should be ignored for system session and used for user session
       allow(Process).to receive(:uid).and_return(9999)
       allow(Process).to receive(:gid).and_return(9999)

data/spec/unit/action/create_domain_volume_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+require 'support/sharedcontext'
+require 'support/libvirt_context'
+
+require 'vagrant-libvirt/action/destroy_domain'
+
+describe VagrantPlugins::ProviderLibvirt::Action::CreateDomainVolume do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+  include_context 'libvirt'
+
+  let(:libvirt_domain) { double('libvirt_domain') }
+  let(:libvirt_client) { double('libvirt_client') }
+  let(:volumes) { double('volumes') }
+  let(:all) { double('all') }
+  let(:box_volume) { double('box_volume') }
+
+  def read_test_file(name)
+    File.read(File.join(File.dirname(__FILE__), File.basename(__FILE__, '.rb'), name))
+  end
+
+  describe '#call' do
+    before do
+      allow_any_instance_of(VagrantPlugins::ProviderLibvirt::Driver)
+        .to receive(:connection).and_return(connection)
+      allow(connection).to receive(:client).and_return(libvirt_client)
+      allow(connection).to receive(:volumes).and_return(volumes)
+      allow(volumes).to receive(:all).and_return(all)
+      allow(all).to receive(:first).and_return(box_volume)
+      allow(box_volume).to receive(:id).and_return(nil)
+      env[:domain_name] = 'test'
+    end
+
+    context 'when one disk' do
+      before do
+        allow(box_volume).to receive(:path).and_return('/test/path_0.img')
+        env[:box_volumes] = [
+          {
+            :name=>"test_vagrant_box_image_1.1.1_0.img",
+            :virtual_size=>5
+          }
+        ]
+      end
+
+      it 'should create one disk in storage' do
+        expected_xml = read_test_file('one_disk_in_storage.xml')
+        expect(ui).to receive(:info).with('Creating image (snapshot of base box volume).')
+        expect(logger).to receive(:debug).with('Using pool default for base box snapshot')
+        expect(volumes).to receive(:create).with(
+          :xml => expected_xml,
+          :pool_name => "default"
+        )
+        expect(subject.call(env)).to be_nil
+      end
+    end
+
+    context 'when three disks' do
+      before do
+        allow(box_volume).to receive(:path).and_return(
+          '/test/path_0.img',
+          '/test/path_1.img',
+          '/test/path_2.img',
+        )
+        env[:box_volumes] = [
+          {
+            :name=>"test_vagrant_box_image_1.1.1_0.img",
+            :virtual_size=>5
+          },
+          {
+            :name=>"test_vagrant_box_image_1.1.1_1.img",
+            :virtual_size=>10
+          },
+          {
+            :name=>"test_vagrant_box_image_1.1.1_2.img",
+            :virtual_size=>20
+          }
+        ]
+      end
+
+      it 'should create three disks in storage' do
+        expect(ui).to receive(:info).with('Creating image (snapshot of base box volume).')
+        expect(logger).to receive(:debug).with('Using pool default for base box snapshot')
+        expect(volumes).to receive(:create).with(
+          :xml => read_test_file('three_disks_in_storage_disk_0.xml'),
+          :pool_name => "default"
+        )
+        expect(logger).to receive(:debug).with('Using pool default for base box snapshot')
+        expect(volumes).to receive(:create).with(
+          :xml => read_test_file('three_disks_in_storage_disk_1.xml'),
+          :pool_name => "default"
+        )
+        expect(logger).to receive(:debug).with('Using pool default for base box snapshot')
+        expect(volumes).to receive(:create).with(
+          :xml => read_test_file('three_disks_in_storage_disk_2.xml'),
+          :pool_name => "default"
+        )
+        expect(subject.call(env)).to be_nil
+      end
+    end
+  end
+end

data/spec/unit/action/create_domain_volume_spec/one_disk_in_storage.xml

@@ -0,0 +1,21 @@
+<volume>
+  <name>test.img</name>
+  <capacity unit="G">5</capacity>
+  <target>
+    <format type="qcow2"></format>
+    <permissions>
+      <owner>0</owner>
+      <group>0</group>
+      <label>virt_image_t</label>
+    </permissions>
+  </target>
+  <backingStore>
+    <path>/test/path_0.img</path>
+    <format type="qcow2"></format>
+    <permissions>
+      <owner>0</owner>
+      <group>0</group>
+      <label>virt_image_t</label>
+    </permissions>
+  </backingStore>
+</volume>

data/spec/unit/action/create_domain_volume_spec/three_disks_in_storage_disk_0.xml

@@ -0,0 +1,21 @@
+<volume>
+  <name>test.img</name>
+  <capacity unit="G">5</capacity>
+  <target>
+    <format type="qcow2"></format>
+    <permissions>
+      <owner>0</owner>
+      <group>0</group>
+      <label>virt_image_t</label>
+    </permissions>
+  </target>
+  <backingStore>
+    <path>/test/path_0.img</path>
+    <format type="qcow2"></format>
+    <permissions>
+      <owner>0</owner>
+      <group>0</group>
+      <label>virt_image_t</label>
+    </permissions>
+  </backingStore>
+</volume>

data/spec/unit/action/create_domain_volume_spec/three_disks_in_storage_disk_1.xml

@@ -0,0 +1,21 @@
+<volume>
+  <name>test_1.img</name>
+  <capacity unit="G">10</capacity>
+  <target>
+    <format type="qcow2"></format>
+    <permissions>
+      <owner>0</owner>
+      <group>0</group>
+      <label>virt_image_t</label>
+    </permissions>
+  </target>
+  <backingStore>
+    <path>/test/path_1.img</path>
+    <format type="qcow2"></format>
+    <permissions>
+      <owner>0</owner>
+      <group>0</group>
+      <label>virt_image_t</label>
+    </permissions>
+  </backingStore>
+</volume>

data/spec/unit/action/create_domain_volume_spec/three_disks_in_storage_disk_2.xml

@@ -0,0 +1,21 @@
+<volume>
+  <name>test_2.img</name>
+  <capacity unit="G">20</capacity>
+  <target>
+    <format type="qcow2"></format>
+    <permissions>
+      <owner>0</owner>
+      <group>0</group>
+      <label>virt_image_t</label>
+    </permissions>
+  </target>
+  <backingStore>
+    <path>/test/path_2.img</path>
+    <format type="qcow2"></format>
+    <permissions>
+      <owner>0</owner>
+      <group>0</group>
+      <label>virt_image_t</label>
+    </permissions>
+  </backingStore>
+</volume>

data/spec/unit/action/destroy_domain_spec.rb

@@ -85,7 +85,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::DestroyDomain do
 
         it 'uses explicit removal of disks' do
           allow(libvirt_domain).to receive(:name).and_return('test')
-          allow(domain).to receive(:volumes).and_return([root_disk])
+          allow(domain).to receive(:volumes).and_return([root_disk, nil])
 
           expect(domain).to_not receive(:destroy).with(destroy_volumes: true)
           expect(root_disk).to receive(:destroy)  # root disk remove