vagrant-libvirt 0.11.2 → 0.12.0

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

@@ -18,22 +18,23 @@ module VagrantPlugins
       module NetworkUtil
         include Vagrant::Util::NetworkIP
 
-        def configured_networks(env, logger)
-          qemu_use_session = env[:machine].provider_config.qemu_use_session
-          qemu_use_agent = env[:machine].provider_config.qemu_use_agent
-          management_network_device = env[:machine].provider_config.management_network_device
-          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
-          management_network_domain = env[:machine].provider_config.management_network_domain
-          management_network_mtu = env[:machine].provider_config.management_network_mtu
-          management_network_keep = env[:machine].provider_config.management_network_keep
-          management_network_driver_iommu = env[:machine].provider_config.management_network_driver_iommu
+        def configured_networks(machine, logger)
+          qemu_use_session = machine.provider_config.qemu_use_session
+          qemu_use_agent = machine.provider_config.qemu_use_agent
+          management_network_device = machine.provider_config.management_network_device
+          management_network_name = machine.provider_config.management_network_name
+          management_network_address = machine.provider_config.management_network_address
+          management_network_mode = machine.provider_config.management_network_mode
+          management_network_mac = machine.provider_config.management_network_mac
+          management_network_guest_ipv6 = machine.provider_config.management_network_guest_ipv6
+          management_network_autostart = machine.provider_config.management_network_autostart
+          management_network_pci_bus = machine.provider_config.management_network_pci_bus
+          management_network_pci_slot = machine.provider_config.management_network_pci_slot
+          management_network_domain = machine.provider_config.management_network_domain
+          management_network_mtu = machine.provider_config.management_network_mtu
+          management_network_keep = machine.provider_config.management_network_keep
+          management_network_driver_iommu = machine.provider_config.management_network_driver_iommu
+          management_network_model_type = machine.provider_config.management_network_model_type
           logger.info "Using #{management_network_name} at #{management_network_address} as the management network #{management_network_mode} is the mode"
 
           begin
@@ -54,6 +55,7 @@ module VagrantPlugins
           if qemu_use_session
             management_network_options = {
               iface_type: :public_network,
+              model_type: management_network_model_type,
               dev: management_network_device,
               mode: 'bridge',
               type: 'bridge',
@@ -63,6 +65,7 @@ module VagrantPlugins
           else
             management_network_options = {
               iface_type: :private_network,
+              model_type: management_network_model_type,
               network_name: management_network_name,
               ip: Regexp.last_match(1),
               netmask: Regexp.last_match(2),
@@ -101,23 +104,23 @@ module VagrantPlugins
           # if there is a box and management network is disabled
           # need qemu agent enabled and at least one network that can be accessed
           if (
-            env[:machine].config.vm.box &&
-            !env[:machine].provider_config.mgmt_attach &&
-            !env[:machine].provider_config.qemu_use_agent &&
-            !env[:machine].config.vm.networks.any? { |type, _| ["private_network", "public_network"].include?(type.to_s) }
+            machine.config.vm.box &&
+            !machine.provider_config.mgmt_attach &&
+            !machine.provider_config.qemu_use_agent &&
+            !machine.config.vm.networks.any? { |type, _| ["private_network", "public_network"].include?(type.to_s) }
           )
             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
+          networks = if machine.provider_config.mgmt_attach
                        [management_network_options]
                      else
                        []
                      end
 
-          env[:machine].config.vm.networks.each do |type, original_options|
+          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 => ...).

data/lib/vagrant-libvirt/version

@@ -1 +1 @@
-0.11.2
+0.12.0

data/spec/support/libvirt_acceptance_context.rb

@@ -71,7 +71,7 @@ shared_context 'libvirt_acceptance' do
     # allows for a helper Vagrantfile to force specific provider options if testing
     # environment needs them
     vagrantfile = File.join(vagrant_home, 'Vagrantfile')
-    if File.exists?(vagrantfile) and !File.exists?(File.join(target_env.homedir, 'Vagrantfile'))
+    if File.exist?(vagrantfile) and !File.exist?(File.join(target_env.homedir, 'Vagrantfile'))
       FileUtils.cp(vagrantfile, target_env.homedir)
     end
   end

data/spec/support/matchers/have_file_content.rb

@@ -45,7 +45,7 @@ require "rspec/expectations/version"
 #     end
 RSpec::Matchers.define :have_file_content do |expected|
   match do |actual|
-    next false unless File.exists?(actual)
+    next false unless File.exist?(actual)
 
     @actual   = File.read(actual).chomp
     @expected = if expected.is_a? String

data/spec/support/unit_context.rb

@@ -29,12 +29,9 @@ shared_context 'unit' do
 
   # 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) {} }
 
   before (:each) do
-    allow(machine).to receive(:guest).and_return(guest)
     allow(machine).to receive(:communicate).and_return(communicator)
     allow(machine).to receive(:ui).and_return(ui)
   end

data/spec/unit/action/clean_machine_folder_spec.rb

@@ -20,7 +20,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::CleanMachineFolder do
 
         expect(subject.call(env)).to be_nil
 
-        expect(File.exists?(machine.data_dir)).to eq(true)
+        expect(File.exist?(machine.data_dir)).to eq(true)
         expect(Dir.entries(machine.data_dir)).to match_array([".", ".."])
       end
     end
@@ -38,7 +38,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::CleanMachineFolder do
 
         expect(subject.call(env)).to be_nil
 
-        expect(File.exists?(machine.data_dir)).to eq(true)
+        expect(File.exist?(machine.data_dir)).to eq(true)
         expect(Dir.entries(machine.data_dir)).to match_array([".", ".."])
       end
     end
@@ -51,7 +51,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::CleanMachineFolder do
 
         expect(subject.call(env)).to be_nil
 
-        expect(File.exists?(machine.data_dir)).to eq(true)
+        expect(File.exist?(machine.data_dir)).to eq(true)
         expect(Dir.entries(machine.data_dir)).to match_array([".", ".."])
       end
     end

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

@@ -8,6 +8,7 @@
       <group>0</group>
       <label>virt_image_t</label>
     </permissions>
+    <compat>1.1</compat>
   </target>
   <backingStore>
     <path>/test/path_0.img</path>

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

@@ -8,6 +8,7 @@
       <group>0</group>
       <label>virt_image_t</label>
     </permissions>
+    <compat>1.1</compat>
   </target>
   <backingStore>
     <path>/test/path_0.img</path>

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

@@ -8,6 +8,7 @@
       <group>0</group>
       <label>virt_image_t</label>
     </permissions>
+    <compat>1.1</compat>
   </target>
   <backingStore>
     <path>/test/path_1.img</path>

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

@@ -8,6 +8,7 @@
       <group>0</group>
       <label>virt_image_t</label>
     </permissions>
+    <compat>1.1</compat>
   </target>
   <backingStore>
     <path>/test/path_2.img</path>

data/spec/unit/action/create_network_interfaces.rb

@@ -0,0 +1,305 @@
+# frozen_string_literal: true
+
+require_relative '../../spec_helper'
+
+require 'vagrant-libvirt/errors'
+require 'vagrant-libvirt/action/create_network_interfaces'
+require 'vagrant-libvirt/util/unindent'
+
+describe VagrantPlugins::ProviderLibvirt::Action::CreateNetworkInterfaces do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+  include_context 'libvirt'
+
+  let(:networks) { [
+    instance_double(::Libvirt::Network),
+    instance_double(::Libvirt::Network),
+  ] }
+  let(:default_network_xml) {
+    <<-EOF
+    <network>
+      <name>default</name>
+      <uuid>e5f871eb-2899-48b2-83df-78aa43efa360</uuid>
+      <forward mode='nat'>
+        <nat>
+          <port start='1024' end='65535'/>
+        </nat>
+      </forward>
+      <bridge name='virbr0' stp='on' delay='0'/>
+      <mac address='52:54:00:71:ce:a6'/>
+      <ip address='192.168.122.1' netmask='255.255.255.0'>
+        <dhcp>
+          <range start='192.168.122.2' end='192.168.122.254'/>
+        </dhcp>
+      </ip>
+    </network>
+    EOF
+  }
+  let(:management_network_xml) {
+    <<-EOF
+    <network ipv6='yes'>
+      <name>vagrant-libvirt</name>
+      <uuid>46360938-0607-4168-a182-1352fac4a4f9</uuid>
+      <forward mode='nat'/>
+      <bridge name='virbr1' stp='on' delay='0'/>
+      <mac address='52:54:00:c2:d5:a5'/>
+      <ip address='192.168.121.1' netmask='255.255.255.0'>
+        <dhcp>
+          <range start='192.168.121.1' end='192.168.121.254'/>
+        </dhcp>
+      </ip>
+    </network>
+    EOF
+  }
+  let(:default_management_nic_xml) {
+    <<-EOF.unindent
+    <interface type="network">
+      <alias name="ua-net-0"></alias>
+      <source network="vagrant-libvirt"></source>
+      <target dev="vnet0"></target>
+      <model type="virtio"></model>
+      <driver iommu="off"></driver>
+    </interface>
+    EOF
+  }
+
+  before do
+    allow(app).to receive(:call)
+    allow(libvirt_client).to receive(:lookup_domain_by_uuid).and_return(libvirt_domain)
+
+    allow(driver).to receive(:list_all_networks).and_return(networks)
+
+    allow(networks[0]).to receive(:xml_desc).and_return(default_network_xml)
+    allow(networks[0]).to receive(:name).and_return('default')
+    allow(networks[0]).to receive(:bridge_name).and_return('virbr0')
+    allow(networks[0]).to receive(:active?).and_return(true)
+    allow(networks[0]).to receive(:autostart?).and_return(true)
+    allow(networks[1]).to receive(:xml_desc).and_return(management_network_xml)
+    allow(networks[1]).to receive(:name).and_return('vagrant-libvirt')
+    allow(networks[1]).to receive(:bridge_name).and_return('virbr1')
+    allow(networks[1]).to receive(:active?).and_return(true)
+    allow(networks[1]).to receive(:autostart?).and_return(false)
+
+    allow(logger).to receive(:info)
+    allow(logger).to receive(:debug)
+  end
+
+  describe '#call' do
+    it 'should inject the management network definition' do
+      expect(driver).to receive(:attach_device).with(default_management_nic_xml)
+
+      expect(subject.call(env)).to be_nil
+    end
+
+    context 'private network' do
+      let(:vagrantfile) do
+        <<-EOF
+        Vagrant.configure('2') do |config|
+          config.vm.box = "vagrant-libvirt/test"
+          config.vm.define :test
+          config.vm.provider :libvirt do |libvirt|
+            #{vagrantfile_providerconfig}
+          end
+
+          config.vm.network :private_network, :ip => "10.20.30.40"
+        end
+        EOF
+      end
+      let(:private_network) { instance_double(::Libvirt::Network) }
+      let(:private_network_xml) {
+        <<-EOF
+        <network ipv6='yes'>
+          <name>test1</name>
+          <uuid>46360938-0607-4168-a182-1352fac4a4f9</uuid>
+          <forward mode='nat'/>
+          <bridge name='virbr2' stp='on' delay='0'/>
+          <mac address='52:54:00:c2:d5:a5'/>
+          <ip address='10.20.30.1' netmask='255.255.255.0'>
+            <dhcp>
+              <range start='10.20.30.1' end='10.20.30.254'/>
+            </dhcp>
+          </ip>
+        </network>
+        EOF
+      }
+      let(:private_nic_xml) {
+        <<-EOF.unindent
+        <interface type="network">
+          <alias name="ua-net-1"></alias>
+          <source network="test1"></source>
+          <target dev="vnet1"></target>
+          <model type="virtio"></model>
+          <driver iommu="off"></driver>
+        </interface>
+        EOF
+      }
+
+      before do
+        allow(private_network).to receive(:xml_desc).and_return(private_network_xml)
+        allow(private_network).to receive(:name).and_return('test1')
+        allow(private_network).to receive(:bridge_name).and_return('virbr2')
+        allow(private_network).to receive(:active?).and_return(true)
+        allow(private_network).to receive(:autostart?).and_return(false)
+      end
+
+      it 'should attach for two networks' do
+        expect(driver).to receive(:list_all_networks).and_return(networks + [private_network])
+        expect(driver).to receive(:attach_device).with(default_management_nic_xml)
+        expect(driver).to receive(:attach_device).with(private_nic_xml)
+        expect(guest).to receive(:capability).with(:configure_networks, any_args)
+
+        expect(subject.call(env)).to be_nil
+      end
+
+      context 'when iface name is set' do
+        let(:private_nic_xml) {
+          <<-EOF.unindent
+          <interface type="network">
+            <alias name="ua-net-1"></alias>
+            <source network="test1"></source>
+            <target dev="myvnet0"></target>
+            <model type="virtio"></model>
+            <driver iommu="off"></driver>
+          </interface>
+          EOF
+        }
+
+        before do
+          machine.config.vm.networks[0][1][:libvirt__iface_name] = "myvnet0"
+        end
+
+        it 'should set target appropriately' do
+          expect(driver).to receive(:list_all_networks).and_return(networks + [private_network])
+          expect(driver).to receive(:attach_device).with(default_management_nic_xml)
+          expect(driver).to receive(:attach_device).with(private_nic_xml)
+          expect(guest).to receive(:capability).with(:configure_networks, any_args)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+
+      it 'should skip configuring networks in guest without box' do
+        machine.config.vm.box = nil
+
+        expect(driver).to receive(:list_all_networks).and_return(networks + [private_network])
+        expect(driver).to receive(:attach_device).with(default_management_nic_xml)
+        expect(driver).to receive(:attach_device).with(private_nic_xml)
+        expect(guest).to_not receive(:capability).with(:configure_networks, any_args)
+
+        expect(subject.call(env)).to be_nil
+      end
+    end
+
+    context 'public network' do
+      let(:vagrantfile) do
+        <<-EOF
+        Vagrant.configure('2') do |config|
+          config.vm.box = "vagrant-libvirt/test"
+          config.vm.define :test
+          config.vm.provider :libvirt do |libvirt|
+            #{vagrantfile_providerconfig}
+          end
+
+          config.vm.network :public_network, :dev => "virbr1", :mode => "bridge", :type => "bridge"
+        end
+        EOF
+      end
+      let(:public_network) { instance_double(::Libvirt::Network) }
+      let(:public_network_xml) {
+        <<-EOF
+        <network ipv6='yes'>
+          <name>test1</name>
+          <uuid>46360938-0607-4168-a182-1352fac4a4f9</uuid>
+          <forward mode='nat'/>
+          <bridge name='virbr2' stp='on' delay='0'/>
+          <mac address='52:54:00:c2:d5:a5'/>
+          <ip address='10.20.30.1' netmask='255.255.255.0'>
+            <dhcp>
+              <range start='10.20.30.1' end='10.20.30.254'/>
+            </dhcp>
+          </ip>
+        </network>
+        EOF
+      }
+      let(:public_nic_xml) {
+        <<-EOF.unindent
+        <interface type='bridge'>
+          <alias name='ua-net-1'/>
+          <source bridge='virbr1'/>
+          <model type='virtio'/>
+        </interface>
+        EOF
+      }
+      let(:domain_xml) {
+        # don't need full domain here, just enough for the network element to work
+        <<-EOF.unindent
+        <domain type='qemu'>
+          <devices>
+            <interface type='network'>
+              <alias name='ua-net-0'/>
+              <mac address='52:54:00:7d:14:0e'/>
+              <source network='vagrant-libvirt'/>
+              <model type='virtio'/>
+              <driver iommu='off'/>
+              <address type='pci' domain='0x0000' bus='0x00' slot='0x05' function='0x0'/>
+            </interface>
+            <interface type='network'>
+              <alias name='ua-net-1'/>
+              <mac address='52:54:00:7d:14:0f'/>
+              <source bridge='virbr1'/>
+              <model type='virtio'/>
+              <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/>
+            </interface>
+          </devices>
+        </domain>
+        EOF
+      }
+
+      before do
+        allow(public_network).to receive(:xml_desc).and_return(public_network_xml)
+        allow(public_network).to receive(:name).and_return('test1')
+        allow(public_network).to receive(:bridge_name).and_return('virbr2')
+        allow(public_network).to receive(:active?).and_return(true)
+        allow(public_network).to receive(:autostart?).and_return(false)
+
+        allow(libvirt_domain).to receive(:xml_desc).and_return(domain_xml)
+      end
+
+      it 'should attach for two networks' do
+        expect(driver).to receive(:list_all_networks).and_return(networks + [public_network])
+        expect(driver).to receive(:attach_device).with(default_management_nic_xml)
+        expect(driver).to receive(:attach_device).with(public_nic_xml)
+        expect(guest).to receive(:capability).with(:configure_networks, any_args)
+
+        expect(subject.call(env)).to be_nil
+      end
+
+      context 'when iface name is set' do
+        let(:public_nic_xml) {
+          <<-EOF.unindent
+          <interface type='bridge'>
+            <alias name='ua-net-1'/>
+            <source bridge='virbr1'/>
+            <target dev='myvnet0'/>
+            <model type='virtio'/>
+          </interface>
+          EOF
+        }
+
+        before do
+          machine.config.vm.networks[0][1][:libvirt__iface_name] = "myvnet0"
+        end
+
+        it 'should set target appropriately' do
+          expect(driver).to receive(:list_all_networks).and_return(networks + [public_network])
+          expect(driver).to receive(:attach_device).with(default_management_nic_xml)
+          expect(driver).to receive(:attach_device).with(public_nic_xml)
+          expect(guest).to receive(:capability).with(:configure_networks, any_args)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+    end
+  end
+end

data/spec/unit/action/handle_box_image_spec.rb

@@ -88,6 +88,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::HandleBoxImage do
               :virtual_size=>byte_number_5G,
               :format=>"qcow2",
               :device=>'vda',
+              :compat=>"1.1",
             }
           ]
         )
@@ -118,6 +119,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::HandleBoxImage do
                 :virtual_size=>byte_number_5G,
                 :format=>"qcow2",
                 :device=>'vda',
+                :compat=>"1.1",
               }
             ]
           )
@@ -156,6 +158,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::HandleBoxImage do
                 :virtual_size=>byte_number_5G,
                 :format=>"qcow2",
                 :device=>'vda',
+                :compat=>"1.1",
               }
             ]
           )
@@ -177,6 +180,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::HandleBoxImage do
                 :virtual_size=>byte_number_20G,
                 :format=>"qcow2",
                 :device=>'vda',
+                :compat=>"1.1",
               }
             ]
           )
@@ -269,18 +273,21 @@ describe VagrantPlugins::ProviderLibvirt::Action::HandleBoxImage do
               :virtual_size=>byte_number_5G,
               :format=>"qcow2",
               :device=>'vda',
+              :compat=>"0.10"
             },
             {
               :path=>"/test/disk.qcow2",
               :name=>"test_vagrant_box_image_1.1.1_disk.img",
               :virtual_size=>byte_number_10G,
-              :format=>"qcow2"
+              :format=>"qcow2",
+              :compat=>"0.10"
             },
             {
               :path=>"/test/box_2.img",
               :name=>"test_vagrant_box_image_1.1.1_box_2.img",
               :virtual_size=>byte_number_20G,
-              :format=>"qcow2"
+              :format=>"qcow2",
+              :compat=>"0.10"
             }
           ]
         )

data/spec/unit/action/start_domain_spec.rb

@@ -349,6 +349,48 @@ describe VagrantPlugins::ProviderLibvirt::Action::StartDomain do
           expect(subject.call(env)).to be_nil
         end
       end
+
+      [
+        [
+          'when port explicitly set, should set autoport=no',
+          proc { |config|
+            config.graphics_port = 5901
+          },
+          "<graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket='-1'/>",
+          "<graphics autoport='no' keymap='en-us' listen='127.0.0.1' port='5901' type='vnc' websocket='-1'/>",
+        ],
+        [
+          'when port updated, should set autoport=no and update port',
+          proc { |config|
+            config.graphics_port = 5902
+          },
+          "<graphics autoport='no' keymap='en-us' listen='127.0.0.1' port='5901' type='vnc' websocket='-1'/>",
+          "<graphics autoport='no' keymap='en-us' listen='127.0.0.1' port='5902' type='vnc' websocket='-1'/>",
+        ],
+        [
+          'when autoport set and no port, should set autoport=yes and update port to -1',
+          proc { |config|
+            config.graphics_autoport = 'yes'
+          },
+          "<graphics autoport='no' keymap='en-us' listen='127.0.0.1' port='5901' type='vnc' websocket='-1'/>",
+          "<graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc' websocket='-1'/>",
+        ],
+      ].each do |description, config_proc, graphics_xml_start, graphics_xml_output|
+        it "#{description}" do
+          config_proc.call(machine.provider_config)
+
+          initial_domain_xml = domain_xml.gsub(/<graphics .*\/>/, graphics_xml_start)
+          updated_domain_xml = domain_xml.gsub(/<graphics .*\/>/, graphics_xml_output)
+
+          expect(ui).to_not receive(:warn)
+          expect(connection).to receive(:define_domain).with(match(graphics_xml_output)).and_return(libvirt_domain)
+          expect(libvirt_domain).to receive(:xml_desc).and_return(initial_domain_xml, updated_domain_xml, updated_domain_xml)
+          expect(libvirt_domain).to receive(:autostart=)
+          expect(domain).to receive(:start)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
     end
 
     context 'nvram' do