vagrant-libvirt 0.1.2 → 0.5.0

data/spec/unit/action/create_domain_spec/default_system_storage_pool.xml

@@ -0,0 +1,17 @@
+<pool type='dir'>
+  <name>default</name>
+  <uuid>434e1b75-4a72-45d7-8a98-ebd90c125d22</uuid>
+  <capacity unit='bytes'>10737418240</capacity>
+  <allocation unit='bytes'>10737418240</allocation>
+  <available unit='bytes'>10737418240</available>
+  <source>
+  </source>
+  <target>
+    <path>/var/lib/libvirt/images</path>
+    <permissions>
+      <mode>0755</mode>
+      <owner>0</owner>
+      <group>0</group>
+    </permissions>
+  </target>
+</pool>

data/spec/unit/action/create_domain_spec/default_user_storage_pool.xml

@@ -0,0 +1,17 @@
+<pool type='dir'>
+  <name>default</name>
+  <uuid>434e1b75-4a72-45d7-8a98-ebd90c125d22</uuid>
+  <capacity unit='bytes'>10737418240</capacity>
+  <allocation unit='bytes'>10737418240</allocation>
+  <available unit='bytes'>10737418240</available>
+  <source>
+  </source>
+  <target>
+    <path>/var/lib/libvirt/images</path>
+    <permissions>
+      <mode>0755</mode>
+      <owner>0</owner>
+      <group>0</group>
+    </permissions>
+  </target>
+</pool>

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

@@ -33,7 +33,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::DestroyDomain do
       before do
         allow(libvirt_domain).to receive(:list_snapshots).and_return([])
         allow(libvirt_domain).to receive(:has_managed_save?).and_return(nil)
-        root_disk.stub(name: 'test.img')
+        allow(root_disk).to receive(:name).and_return('test.img')
       end
 
       context 'when only has root disk' do
@@ -57,7 +57,7 @@ describe VagrantPlugins::ProviderLibvirt::Action::DestroyDomain do
 
         let(:extra_disk) { double('libvirt_extra_disk') }
         before do
-          extra_disk.stub(name: 'test-vdb.qcow2')
+          allow(extra_disk).to receive(:name).and_return('test-vdb.qcow2')
         end
 
         it 'destroys disks individually' do
@@ -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

data/spec/unit/action/forward_ports_spec.rb

@@ -0,0 +1,202 @@
+require 'spec_helper'
+require 'support/sharedcontext'
+require 'support/libvirt_context'
+
+require 'vagrant-libvirt/errors'
+require 'vagrant-libvirt/action/forward_ports'
+
+describe VagrantPlugins::ProviderLibvirt::Action::ForwardPorts do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+
+  let(:machine_config) { double("machine_config") }
+  let(:vm_config) { double("vm_config") }
+  let(:provider_config) { double("provider_config") }
+
+  before (:each) do
+    allow(machine).to receive(:config).and_return(machine_config)
+    allow(machine).to receive(:provider_config).and_return(provider_config)
+    allow(machine_config).to receive(:vm).and_return(vm_config)
+    allow(vm_config).to receive(:networks).and_return([])
+    allow(provider_config).to receive(:forward_ssh_port).and_return(false)
+  end
+
+  describe '#call' do
+    context 'with none defined' do
+      it 'should skip calling forward_ports' do
+        expect(subject).to_not receive(:forward_ports)
+        expect(subject.call(env)).to be_nil
+      end
+    end
+
+    context 'with network including one forwarded port' do
+      let(:networks) { [
+        [:private_network, {:ip=>"10.20.30.40", :protocol=>"tcp", :id=>"6b8175ed-3220-4b63-abaf-0bb8d7cdd723"}],
+        [:forwarded_port, port_options],
+      ]}
+
+      let(:port_options){ {guest: 80, host: 8080} }
+
+      it 'should compile a single port forward to set up' do
+        expect(vm_config).to receive(:networks).and_return(networks)
+        expect(ui).to_not receive(:warn)
+        expect(subject).to receive(:forward_ports).and_return(nil)
+
+        expect(subject.call(env)).to be_nil
+
+        expect(env[:forwarded_ports]).to eq([networks[1][1]])
+      end
+
+      context 'when host port in protected range' do
+        let(:port_options){ {guest: 8080, host: 80} }
+
+        it 'should emit a warning' do
+          expect(vm_config).to receive(:networks).and_return(networks)
+          expect(ui).to receive(:warn).with(include("You are trying to forward to privileged ports"))
+          expect(subject).to receive(:forward_ports).and_return(nil)
+
+          expect(subject.call(env)).to be_nil
+        end
+      end
+    end
+
+    context 'when udp protocol is selected' do
+      let(:port_options){ {guest: 80, host: 8080, protocol: "udp"} }
+
+      it 'should skip and emit warning' do
+        expect(vm_config).to receive(:networks).and_return([[:forwarded_port, port_options]])
+        expect(ui).to receive(:warn).with("Forwarding UDP ports is not supported. Ignoring.")
+        expect(subject).to_not receive(:forward_ports)
+
+        expect(subject.call(env)).to be_nil
+      end
+    end
+
+    context 'when default ssh port forward provided' do
+      let(:networks){ [
+        [:private_network, {:ip=>"10.20.30.40", :protocol=>"tcp", :id=>"6b8175ed-3220-4b63-abaf-0bb8d7cdd723"}],
+        [:forwarded_port, {guest: 80, host: 8080}],
+        [:forwarded_port, {guest: 22, host: 2222, host_ip: '127.0.0.1', id: 'ssh'}],
+      ]}
+
+      context 'with default config' do
+        it 'should not forward the ssh port' do
+          expect(vm_config).to receive(:networks).and_return(networks)
+          expect(subject).to receive(:forward_ports)
+
+          expect(subject.call(env)).to be_nil
+
+          expect(env[:forwarded_ports]).to eq([networks[1][1]])
+        end
+      end
+
+      context 'with forward_ssh_port enabled' do
+        before do
+          allow(provider_config).to receive(:forward_ssh_port).and_return(true)
+        end
+
+        it 'should forward the port' do
+          expect(vm_config).to receive(:networks).and_return(networks)
+          expect(subject).to receive(:forward_ports)
+
+          expect(subject.call(env)).to be_nil
+
+          expect(env[:forwarded_ports]).to eq(networks.drop(1).map { |_, opts| opts })
+        end
+      end
+    end
+  end
+
+  describe '#forward_ports' do
+    let(:pid_dir){ machine.data_dir.join('pids') }
+
+    before (:each) do
+      allow(env).to receive(:[]).and_call_original
+      allow(machine).to receive(:ssh_info).and_return(
+        {
+          :host => "localhost",
+          :username => "vagrant",
+          :port => 22,
+          :private_key_path => ["/home/test/.ssh/id_rsa"],
+        }
+      )
+      allow(provider_config).to receive(:proxy_command).and_return(nil)
+    end
+
+    context 'with port to forward' do
+      let(:port_options){ {guest: 80, host: 8080, guest_ip: "192.168.1.121"} }
+
+      it 'should spawn ssh to setup forwarding' do
+        expect(env).to receive(:[]).with(:forwarded_ports).and_return([port_options])
+        expect(ui).to receive(:info).with("#{port_options[:guest]} (guest) => #{port_options[:host]} (host) (adapter eth0)")
+        expect(subject).to receive(:spawn).with(/ssh -n -o User=vagrant -o Port=22.*-L \*:8080:192.168.1.121:80 -N localhost/, anything).and_return(9999)
+
+        expect(subject.forward_ports(env)).to eq([port_options])
+
+        expect(pid_dir.join('ssh_8080.pid')).to have_file_content("9999")
+      end
+    end
+
+    context 'with privileged host port' do
+      let(:port_options){ {guest: 80, host: 80, guest_ip: "192.168.1.121"} }
+
+      it 'should spawn ssh to setup forwarding' do
+        expect(env).to receive(:[]).with(:forwarded_ports).and_return([port_options])
+        expect(ui).to receive(:info).with("#{port_options[:guest]} (guest) => #{port_options[:host]} (host) (adapter eth0)")
+        expect(ui).to receive(:info).with('Requesting sudo for host port(s) <= 1024')
+        expect(subject).to receive(:system).with('sudo -v').and_return(true)
+        expect(subject).to receive(:spawn).with(/sudo ssh -n -o User=vagrant -o Port=22.*-L \*:80:192.168.1.121:80 -N localhost/, anything).and_return(10000)
+
+        expect(subject.forward_ports(env)).to eq([port_options])
+
+        expect(pid_dir.join('ssh_80.pid')).to have_file_content("10000")
+      end
+    end
+  end
+end
+
+describe VagrantPlugins::ProviderLibvirt::Action::ClearForwardedPorts do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+  include_context 'libvirt'
+
+  describe '#call' do
+    context 'no forwarded ports' do
+      it 'should skip checking if pids are running' do
+        expect(subject).to_not receive(:ssh_pid?)
+        expect(logger).to receive(:info).with('No ssh pids found')
+
+        expect(subject.call(env)).to be_nil
+      end
+    end
+
+    context 'multiple forwarded ports' do
+      before do
+        data_dir = machine.data_dir.join('pids')
+        data_dir.mkdir unless data_dir.directory?
+
+        [
+          {:port => '8080', :pid => '10001'},
+          {:port => '8081', :pid => '10002'},
+        ].each do |port_pid|
+          File.write(data_dir.to_s + "/ssh_#{port_pid[:port]}.pid", port_pid[:pid])
+        end
+      end
+      it 'should terminate each of the processes' do
+        expect(logger).to receive(:info).with(no_args) # don't know how to test translations from vagrant
+        expect(subject).to receive(:ssh_pid?).with("10001").and_return(true)
+        expect(subject).to receive(:ssh_pid?).with("10002").and_return(true)
+        expect(logger).to receive(:debug).with(/Killing pid/).twice()
+        expect(logger).to receive(:info).with('Removing ssh pid files')
+        expect(subject).to receive(:system).with("kill 10001")
+        expect(subject).to receive(:system).with("kill 10002")
+
+        expect(subject.call(env)).to be_nil
+
+        expect(Dir.entries(machine.data_dir.join('pids'))).to match_array(['.', '..'])
+      end
+    end
+  end
+end