vagrant-libvirt 0.1.2 → 0.5.0

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

@@ -0,0 +1,23 @@
+
+module VagrantPlugins
+  module ProviderLibvirt
+    module Util
+      module Ui
+        # Since v2.2.8 Vagrant support --no-tty option, which silences
+        # progress bars and other interactive elements for cleaner logs
+        # in scripts, but requires a slight change in UI object handling.
+        # This helper allows the vagrant-libvirt plugin to stay compatible
+        # with the older Vagrant versions.
+        # See: https://github.com/hashicorp/vagrant/pull/11465/
+        def rewriting(ui)
+          if ui.respond_to?(:rewriting)
+            ui.rewriting {|rw| yield rw}
+          else
+            yield ui
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/vagrant-libvirt/version

@@ -0,0 +1 @@
+0.5.0

data/lib/vagrant-libvirt/version.rb

@@ -1,5 +1,76 @@
+require 'open3'
+require 'tmpdir'
+
 module VagrantPlugins
   module ProviderLibvirt
-    VERSION = '0.1.2'.freeze
+    VERSION_FILE = File.dirname(__FILE__) + "/version"
+
+    GIT_ARCHIVE_VERSION = "$Format:%H %D$"
+
+    HOMEPAGE = 'https://github.com/vagrant-libvirt/vagrant-libvirt'
+
+    def self.get_version
+      if File.exist?(VERSION_FILE)
+        # built gem
+        version = File.read(VERSION_FILE)
+      elsif self.inside_git_repository
+        # local repo
+        git_version = `git describe --tags`
+        version = self.version_from_describe(git_version)
+      elsif !GIT_ARCHIVE_VERSION.start_with?('$Format')
+        # archive - format string replaced during export
+        hash, refs = GIT_ARCHIVE_VERSION.split(' ', 2)
+
+        tag = refs.split(',').select { |ref| ref.strip.start_with?("tag:") }.first
+        if tag != nil
+          # tagged
+          version = tag.strip.split(' ').last
+        else
+          version = ""
+          # arbitrary branch/commit
+          Dir.mktmpdir do |dir|
+            stdout_and_stderr, status = Open3.capture2e("git -C #{dir} clone --bare #{HOMEPAGE}")
+            raise "failed to clone original to resolve version: #{stdout_and_stderr}" unless status.success?
+
+            stdout_and_stderr, status = Open3.capture2e("git --git-dir=#{dir}/vagrant-libvirt.git describe --tags #{hash}")
+            raise "failed to determine version for #{hash}: #{stdout_and_stderr}" unless status.success?
+
+            version = version_from_describe(stdout_and_stderr)
+          end
+
+          # in this case write the version file to avoid cloning a second time
+          File.write(VERSION_FILE, version)
+        end
+      else
+        # no idea
+        version = "9999"
+      end
+
+      return version.freeze
+    end
+
+    def self.write_version
+      File.write(VERSION_FILE, self.get_version)
+    end
+
+    private
+
+    def self.inside_git_repository
+      _, status = Open3.capture2e("git rev-parse --git-dir")
+
+      status.success?
+    end
+
+    def self.version_from_describe(describe)
+      version_parts = describe.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
   end
 end

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

@@ -1,9 +1,43 @@
-require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
+require 'simplecov-lcov'
+
+# patch simplecov configuration
+if ! SimpleCov::Configuration.method_defined? :branch_coverage?
+  module SimpleCov
+    module Configuration
+      def branch_coverage?
+        return false
+      end
+    end
+  end
+end
+
+SimpleCov::Formatter::LcovFormatter.config do |config|
+  config.report_with_single_file = true
+  config.single_report_path = 'coverage/lcov.info'
+end
+
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::LcovFormatter,
+  ]
+)
+SimpleCov.start do
+  add_filter 'spec/'
+end
 
 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/binding_proc.rb

@@ -0,0 +1,24 @@
+##
+# A simple extension of the Proc class that supports setting a custom binding
+# and evaluates everything in the Proc using the new binding.
+
+class ProcWithBinding < Proc
+  ##
+  # Set the binding for this instance
+
+  def apply_binding(bind, *args)
+    @binding = bind
+    instance_exec(*args, &self)
+  end
+
+  def method_missing(method, *args)
+    begin
+      method_from_binding = eval("method(#{method.inspect})", @binding)
+      return method_from_binding.call(*args)
+    rescue NameError
+      # fall through on purpose
+    end
+
+    super
+  end
+end

data/spec/support/libvirt_context.rb

@@ -7,6 +7,7 @@ shared_context 'libvirt' do
   let(:id)              { 'dummy-vagrant_dummy'     }
   let(:connection)      { double('connection') }
   let(:domain)          { double('domain') }
+  let(:logger)          { double('logger') }
 
   def connection_result(options = {})
     result = options.fetch(:result, nil)
@@ -25,6 +26,7 @@ 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)
+    allow(Log4r::Logger).to receive(:new).and_return(logger)
   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/support/sharedcontext.rb

@@ -3,10 +3,14 @@ require 'spec_helper'
 shared_context 'unit' do
   include_context 'vagrant-unit'
 
+  let(:vagrantfile_providerconfig) { '' }
   let(:vagrantfile) do
     <<-EOF
     Vagrant.configure('2') do |config|
       config.vm.define :test
+      config.vm.provider :libvirt do |libvirt|
+        #{vagrantfile_providerconfig}
+      end
     end
     EOF
   end
@@ -17,7 +21,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 +32,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/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

@@ -0,0 +1,166 @@
+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)
+
+      allow(logger).to receive(:info)
+
+      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)
+    end
+
+    context 'connection => qemu:///system' do
+      context 'default pool' do
+        let(:test_file) { 'default_system_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(volumes).to_not receive(:create) # additional disks only
+
+          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).with(
+                hash_including(
+                  :path        => "/var/lib/libvirt/images/vagrant-test_default-vdb.qcow2",
+                  :owner       => 0,
+                  :group       => 0,
+                  :pool_name   => "default",
+                )
+              )
+              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
+
+    context 'connection => qemu:///session' do
+      let(:vagrantfile) do
+        <<-EOF
+        Vagrant.configure('2') do |config|
+          config.vm.define :test
+          config.vm.provider :libvirt do |libvirt|
+            libvirt.qemu_use_session = true
+          end
+        end
+        EOF
+      end
+
+      context 'default pool' do
+        let(:test_file) { 'default_user_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.qemu_use_session = true
+                libvirt.storage :file, :size => '20G'
+              end
+            end
+            EOF
+          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).with(
+                hash_including(
+                  :path        => "/var/lib/libvirt/images/vagrant-test_default-vdb.qcow2",
+                  :owner       => 9999,
+                  :group       => 9999,
+                  :pool_name   => "default",
+                )
+              )
+              expect(servers).to receive(:create).and_return(machine)
+
+              expect(subject.call(env)).to be_nil
+            end
+          end
+        end
+      end
+    end
+  end
+end