vagrant-libvirt 0.0.43 → 0.3.0

data/lib/vagrant-libvirt/version

@@ -0,0 +1 @@
+0.3.0

data/lib/vagrant-libvirt/version.rb

@@ -1,5 +1,28 @@
 module VagrantPlugins
   module ProviderLibvirt
-    VERSION = '0.0.43'.freeze
+    VERSION_FILE = File.dirname(__FILE__) + "/version"
+
+    def self.get_version
+      if File.exist?(VERSION_FILE)
+        version = File.read(VERSION_FILE)
+      else
+        git_version = `git describe --tags`
+        version_parts = git_version.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
+
+      return version.freeze
+    end
+
+    def self.write_version
+      File.write(VERSION_FILE, self.get_version)
+    end
   end
 end

data/locales/en.yml

@@ -16,7 +16,7 @@ en:
       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...
+      Uploading base box image as volume into Libvirt storage...
     creating_domain_volume: |-
       Creating image (snapshot of base box volume).
     removing_domain_volume: |-
@@ -35,6 +35,8 @@ en:
       Resuming domain...
     suspending_domain: |-
       Suspending domain...
+    package_domain: |-
+      Packaging domain...
     waiting_for_ready: |-
       Waiting for domain to become "ready"...
     waiting_for_ip: |-
@@ -58,7 +60,7 @@ en:
         Forwarding UDP ports is not supported. Ignoring.
 
     errors:
-      package_not_supported: No support for package with libvirt. Create box manually.
+      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:
@@ -95,7 +97,7 @@ en:
       wrong_box_format: |-
         Wrong image format specified for box.
       fog_libvirt_connection_error: |-
-        Error while connecting to libvirt: %{error_message}
+        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: |-
@@ -106,9 +108,11 @@ en:
         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}
+        There was error while creating Libvirt storage pool: %{error_message}
       image_upload_error: |-
         Error while uploading image to storage pool: %{error_message}
+      image_download_error: |-
+        Error while downloading volume '%{volume_name}' from storage pool '%{pool_name}': %{error_message}
       no_domain_error: |-
         No domain found. %{error_message}
       attach_device_error: |-

data/spec/support/environment_helper.rb

@@ -18,7 +18,7 @@ class EnvironmentHelper
     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|
+  %w(cpus cpu_mode loader nvram 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

data/spec/support/libvirt_context.rb

@@ -25,6 +25,6 @@ shared_context 'libvirt' do
     # return some information for domain when needed
     allow(domain).to receive(:mac).and_return('9C:D5:53:F1:5A:E7')
 
-    machine.stub(id: id)
+    allow(machine).to receive(:id).and_return(id)
   end
 end

data/spec/support/sharedcontext.rb

@@ -17,7 +17,7 @@ shared_context 'unit' do
   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(:ui)               { Vagrant::UI::Silent.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.
@@ -28,7 +28,7 @@ shared_context 'unit' do
   let(:plugin)           { register_plugin }
 
   before (:each) do
-    machine.stub(guest: guest)
-    machine.stub(communicator: communicator)
+    allow(machine).to receive(:guest).and_return(guest)
+    allow(machine).to receive(:communicator).and_return(communicator)
   end
 end

data/spec/unit/action/create_domain_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+require 'support/sharedcontext'
+require 'support/libvirt_context'
+
+require 'vagrant-libvirt/errors'
+require 'vagrant-libvirt/action/create_domain'
+
+describe VagrantPlugins::ProviderLibvirt::Action::CreateDomain do
+  subject { described_class.new(app, env) }
+
+  include_context 'unit'
+  include_context 'libvirt'
+
+  let(:libvirt_client) { double('libvirt_client') }
+  let(:servers) { double('servers') }
+  let(:volumes) { double('volumes') }
+
+  let(:storage_pool_xml) { File.read(File.join(File.dirname(__FILE__), File.basename(__FILE__, '.rb'), test_file)) }
+  let(:libvirt_storage_pool) { double('storage_pool') }
+
+  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(:servers).and_return(servers)
+      allow(connection).to receive(:volumes).and_return(volumes)
+    end
+
+    context 'default pool' do
+      let(:test_file) { 'default_storage_pool.xml' }
+
+      it 'should execute correctly' do
+        expect(libvirt_client).to receive(:lookup_storage_pool_by_name).and_return(libvirt_storage_pool)
+        expect(libvirt_storage_pool).to receive(:xml_desc).and_return(storage_pool_xml)
+        expect(servers).to receive(:create).and_return(machine)
+
+        expect(subject.call(env)).to be_nil
+      end
+
+      context 'additional disks' do
+        let(:vagrantfile) do
+          <<-EOF
+          Vagrant.configure('2') do |config|
+            config.vm.define :test
+            config.vm.provider :libvirt do |libvirt|
+              libvirt.storage :file, :size => '20G'
+            end
+          end
+          EOF
+        end
+
+        context 'volume create failed' do
+          it 'should raise an exception' do
+            expect(libvirt_client).to receive(:lookup_storage_pool_by_name).and_return(libvirt_storage_pool)
+            expect(libvirt_storage_pool).to receive(:xml_desc).and_return(storage_pool_xml)
+            expect(volumes).to receive(:create).and_raise(Libvirt::Error)
+
+            expect{ subject.call(env) }.to raise_error(VagrantPlugins::ProviderLibvirt::Errors::FogCreateDomainVolumeError)
+          end
+        end
+
+        context 'volume create succeeded' do
+          it 'should complete' do
+            expect(libvirt_client).to receive(:lookup_storage_pool_by_name).and_return(libvirt_storage_pool)
+            expect(libvirt_storage_pool).to receive(:xml_desc).and_return(storage_pool_xml)
+            expect(volumes).to receive(:create)
+            expect(servers).to receive(:create).and_return(machine)
+
+            expect(subject.call(env)).to be_nil
+          end
+        end
+      end
+    end
+
+    context 'no default pool' do
+      it 'should raise an exception' do
+        expect(libvirt_client).to receive(:lookup_storage_pool_by_name).and_return(nil)
+
+        expect{ subject.call(env) }.to raise_error(VagrantPlugins::ProviderLibvirt::Errors::NoStoragePool)
+      end
+    end
+  end
+end

data/spec/unit/action/create_domain_spec/default_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/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

data/spec/unit/action/set_name_of_domain_spec.rb

@@ -10,12 +10,12 @@ describe VagrantPlugins::ProviderLibvirt::Action::SetNameOfDomain do
     dmn = VagrantPlugins::ProviderLibvirt::Action::SetNameOfDomain.new(Object.new, @env)
     first  = dmn.build_domain_name(@env)
     second = dmn.build_domain_name(@env)
-    first.should_not eq(second)
+    expect(first).to_not eq(second)
   end
 
   it 'builds simple domain name' do
-    @env.default_prefix = 'pre'
+    @env.default_prefix = 'pre_'
     dmn = VagrantPlugins::ProviderLibvirt::Action::SetNameOfDomain.new(Object.new, @env)
-    dmn.build_domain_name(@env).should eq('pre_')
+    expect(dmn.build_domain_name(@env)).to eq('pre_')
   end
 end

data/spec/unit/action/start_domain_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'support/sharedcontext'
+require 'support/libvirt_context'
+
+require 'vagrant-libvirt/errors'
+require 'vagrant-libvirt/action/start_domain'
+
+describe VagrantPlugins::ProviderLibvirt::Action::StartDomain 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(:servers) { double('servers') }
+
+  let(:domain_xml) { File.read(File.join(File.dirname(__FILE__), File.basename(__FILE__, '.rb'), test_file)) }
+
+  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(libvirt_client).to receive(:lookup_domain_by_uuid).and_return(libvirt_domain)
+
+      allow(connection).to receive(:servers).and_return(servers)
+      allow(servers).to receive(:get).and_return(domain)
+    end
+
+    context 'default config' do
+      let(:test_file) { 'default.xml' }
+
+      before do
+        allow(libvirt_domain).to receive(:xml_desc).and_return(domain_xml)
+
+        allow(libvirt_domain).to receive(:max_memory).and_return(512*1024)
+        allow(libvirt_domain).to receive(:num_vcpus).and_return(1)
+      end
+
+      it 'should execute correctly' do
+        expect(libvirt_domain).to receive(:autostart=)
+        expect(domain).to receive(:start)
+
+        expect(subject.call(env)).to be_nil
+      end
+    end
+  end
+end

data/spec/unit/action/start_domain_spec/default.xml

@@ -0,0 +1,48 @@
+<domain xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0' type=''>
+  <name/>
+  <title/>
+  <description/>
+  <uuid/>
+  <memory/>
+  <vcpu>1</vcpu>
+
+
+  <cpu mode='host-model'>
+      <model fallback='allow'></model>
+  </cpu>
+
+
+  <os>
+        <type>hvm</type>
+    <kernel/>
+    <initrd></initrd>
+    <cmdline/>
+  </os>
+  <features>
+    <acpi/>
+    <apic/>
+    <pae/>
+  </features>
+  <clock offset='utc'/>
+  <devices>
+
+
+    <serial type='pty'>
+      <target port='0'/>
+    </serial>
+    <console type='pty'>
+      <target port='0'/>
+    </console>
+
+
+    <input bus='ps2' type='mouse'/>
+
+      <graphics autoport='yes' keymap='en-us' listen='127.0.0.1' port='-1' type='vnc'/>
+      <video>
+        <model heads='1' type='cirrus' vram='9216'/>
+      </video>
+
+
+  </devices>
+
+</domain>

data/spec/unit/config_spec.rb

@@ -6,12 +6,185 @@ require 'vagrant-libvirt/config'
 describe VagrantPlugins::ProviderLibvirt::Config do
   include_context 'unit'
 
+  let(:fake_env) { Hash.new }
+
+  describe '#finalize!' do
+    it 'is valid with defaults' do
+      subject.finalize!
+    end
+
+    context '@uri' do
+      before(:example) do
+        stub_const("ENV", fake_env)
+      end
+
+      context 'when LIBVIRT_DEFAULT_URI is defined' do
+        it 'should always use this value' do
+          fake_env['LIBVIRT_DEFAULT_URI'] = "custom:///custom_path"
+
+          subject.finalize!
+          expect(subject.uri).to eq("custom:///custom_path")
+          expect(subject.qemu_use_session).to eq(false)
+        end
+
+        context 'when LIBVIRT_DEFAULT_URI contains "qemu"' do
+          [
+            [
+              'set qemu_use_session if "session" present',
+              'qemu:///session',
+              true,
+            ],
+            [
+              'handle different protocol additions',
+              'qemu+ssh:///session',
+              true,
+            ],
+            [
+              'handle options before and after path',
+              'qemu://remote/session?keyfile=my_id_rsa',
+              true,
+            ],
+            [
+              'identify when session not set',
+              'qemu://remote/system',
+              false,
+            ],
+            [
+              'handle session appearing elsewhere',
+              'qemu://remote/system?keyfile=my_session_id',
+              false,
+            ],
+          ].each do |title, uri, session|
+            it "should #{title}" do
+              fake_env['LIBVIRT_DEFAULT_URI'] = uri
+
+              subject.finalize!
+              expect(subject.uri).to eq(uri)
+              expect(subject.qemu_use_session).to eq(session)
+            end
+          end
+        end
+      end
+
+      context 'when @driver is defined' do
+        defaults = {'id_ssh_key_file' => nil}
+        [
+          [
+            {'driver' => 'kvm'},
+            'qemu:///system?no_verify=1',
+            false,
+          ],
+          [
+            {'driver' => 'qemu'},
+            'qemu:///system?no_verify=1',
+            false,
+          ],
+          [
+            {'driver' => 'qemu', 'qemu_use_session' => true},
+            'qemu:///session?no_verify=1',
+            true,
+          ],
+          [
+            {'driver' => 'openvz'},
+            'openvz:///system?no_verify=1',
+            false,
+          ],
+          [
+            {'driver' => 'vbox'},
+            'vbox:///session?no_verify=1',
+            false,
+          ],
+        ].each do |inputs, output_uri, output_session|
+          it "should detect #{inputs}" do
+            inputs.merge(defaults).each do |k, v|
+              subject.instance_variable_set("@#{k}", v)
+            end
+
+            subject.finalize!
+            expect(subject.uri).to eq(output_uri)
+            expect(subject.qemu_use_session).to eq(output_session)
+          end
+        end
+
+        it "should raise exception for unrecognized" do
+          subject.driver = "bad-driver"
+
+          expect { subject.finalize! }.to raise_error("Require specify driver bad-driver")
+        end
+      end
+
+      context 'when @connect_via_ssh defined' do
+        defaults = {'driver' => 'qemu', 'id_ssh_key_file' => nil}
+        [
+          [
+            {'connect_via_ssh' => true},
+            'qemu+ssh://localhost/system?no_verify=1',
+          ],
+          [
+            {'connect_via_ssh' => true, 'username' => 'my_user'},
+            'qemu+ssh://my_user@localhost/system?no_verify=1',
+          ],
+          [
+            {'connect_via_ssh' => true, 'host' => 'remote_server'},
+            'qemu+ssh://remote_server/system?no_verify=1',
+          ],
+        ].each do |inputs, output_uri|
+          it "should detect #{inputs}" do
+            inputs.merge(defaults).each do |k, v|
+              subject.instance_variable_set("@#{k}", v)
+            end
+
+            subject.finalize!
+            expect(subject.uri).to eq(output_uri)
+          end
+        end
+      end
+
+      context 'when @id_ssh_key_file defined' do
+        defaults = {'driver' => 'qemu'}
+        [
+          [
+            {},
+            'qemu:///system?no_verify=1&keyfile=/home/user/.ssh/id_rsa',
+          ],
+          [
+            {'id_ssh_key_file' => '/path/to/keyfile'},
+            'qemu:///system?no_verify=1&keyfile=/path/to/keyfile',
+          ],
+        ].each do |inputs, output_uri|
+          it "should detect #{inputs}" do
+            inputs.merge(defaults).each do |k, v|
+              subject.instance_variable_set("@#{k}", v)
+            end
+
+            fake_env['HOME'] = '/home/user'
+
+            subject.finalize!
+            expect(subject.uri).to eq(output_uri)
+          end
+        end
+      end
+
+      context 'when @socket defined' do
+        it "should detect @socket set" do
+          subject.socket = '/var/run/libvirt/libvirt-sock'
+          subject.id_ssh_key_file = false
+
+          subject.finalize!
+          expect(subject.uri).to eq('qemu:///system?no_verify=1&socket=/var/run/libvirt/libvirt-sock')
+        end
+      end
+    end
+  end
+
   def assert_invalid
+    subject.finalize!
     errors = subject.validate(machine)
     raise "No errors: #{errors.inspect}" if errors.values.all?(&:empty?)
   end
 
   def assert_valid
+    subject.finalize!
     errors = subject.validate(machine)
     raise "Errors: #{errors.inspect}" unless errors.values.all?(&:empty?)
   end