From 06e31d39189bdee584999f0c4a968556001c5ef6 Mon Sep 17 00:00:00 2001
From: Darragh Bailey <daragh.bailey@gmail.com>
Date: Fri, 23 Oct 2020 14:31:29 +0100
Subject: [PATCH] Add rudimentary create domain spec test (#1158)

Provide a simple create domain test that uncovered a bug with an
exception in addition to fixing the tests to avoid unnecessary output
when the code sends messages via the UI.
---
 lib/vagrant-libvirt/action/create_domain.rb   |  2 +-
 spec/support/sharedcontext.rb                 |  2 +-
 spec/unit/action/create_domain_spec.rb        | 85 +++++++++++++++++++
 .../default_storage_pool.xml                  | 17 ++++
 4 files changed, 104 insertions(+), 2 deletions(-)
 create mode 100644 spec/unit/action/create_domain_spec.rb
 create mode 100644 spec/unit/action/create_domain_spec/default_storage_pool.xml

diff --git a/lib/vagrant-libvirt/action/create_domain.rb b/lib/vagrant-libvirt/action/create_domain.rb
index d637f46..2ee3a11 100644
--- a/lib/vagrant-libvirt/action/create_domain.rb
+++ b/lib/vagrant-libvirt/action/create_domain.rb
@@ -188,7 +188,7 @@ module VagrantPlugins
               if e.message == msg and disk[:allow_existing]
                 disk[:preexisting] = true
               else
-                raise Errors::FogDomainVolumeCreateError,
+                raise Errors::FogCreateDomainVolumeError,
                       error_message: e.message
               end
             end
diff --git a/spec/support/sharedcontext.rb b/spec/support/sharedcontext.rb
index 0b33375..264fc3b 100644
--- a/spec/support/sharedcontext.rb
+++ b/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.
diff --git a/spec/unit/action/create_domain_spec.rb b/spec/unit/action/create_domain_spec.rb
new file mode 100644
index 0000000..dedecde
--- /dev/null
+++ b/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
diff --git a/spec/unit/action/create_domain_spec/default_storage_pool.xml b/spec/unit/action/create_domain_spec/default_storage_pool.xml
new file mode 100644
index 0000000..751f896
--- /dev/null
+++ b/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>