vagrant-kvm 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 050ef979981ce83ec1d1afe226a6f4b7f6da29d9
-  data.tar.gz: 95b009356ebd8e0058e2ba18b2debaa43e2015ad
+  metadata.gz: a9a60c53d1481a84c960b7f3abef307b431ceadb
+  data.tar.gz: 51c04fe1ec462079d8d7711d101544227a418c14
 SHA512:
-  metadata.gz: 34a150ca16164e872cd72291c846312013346c659f22bf680f213c877477f9c404e46a5beb5c2dff16955bbb5e2b0b6efc6a8fb80a2eb8112230caf4f7bfbdd1
-  data.tar.gz: 0f8761c309f8f5b4acdcc11068300266bcbfacb306c167b65dc869e3818bd8cd55b8478357d9d6c73044feaa0246208c5ef6ab51904740dfc6e8aa84e424bb47
+  metadata.gz: 40ce772d899d500bebfbc56f639936a1028c1c7e5bf22f5fc481734e95920702cf14498da92bbc2846933ad8e33e72d63678803c0a4f83f33d433cef9af368d8
+  data.tar.gz: 4ca877c4945e9e8fc67a1c28259c805afbfbf349ed06338ead92855039a069997176d1739770b9ac0b797402f3591444bf9ce6d5f34630a7a0c29ffa7a95be9b

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.1.6 (April, ?, 2014)
+
+* Support Vagrant 1.5.x[GH-188][GH-187][GH-186][GH-174]
+* Handle Vagrant 1.5 migration with box folder structure change
+* Document vagrant-1.4 to 1.5 migration [GH-189]
+* Fix spec test error
+
 # 0.1.5 (March 22, 2014)
 
 * Change default box format to qcow2 [GH-63]

data/README.md

@@ -32,6 +32,68 @@ OVF boxes conversion as been removed, you should use `vagrant-mutate` instead.
 
 ## Known issues
 
+### Vagrant 1.5 migration
+
+Vagrant 1.5 changes a structure of user boxes directories.
+vagrant-KVM handle box directory as libvirt/qemu temporary spool,
+but Vagrant 1.5 changes it at first time launched.
+
+If you got `Call to virStoragePoolCreate failed: cannot open path` error, or
+`Your vagrant-kvm environment should be fixed. see README`,
+please follow the instructions bellow.
+
+1. Upgrade vagrant-kvm to vagrant-kvm  0.1.6 or after
+
+2. Clear all vagrant storage pool definitions
+
+3. restart libvirt daemon
+
+#### how to clear storage pool
+
+```bash
+$ sudo -i
+# ls /etc/libvirt/storage/vagrant*
+/etc/libvirt/storage/vagrant_1000_archlinux-x86_64-20140325.xml
+/etc/libvirt/storage/vagrant_1000_centos-6.5-20140316.xml
+/etc/libvirt/storage/vagrant_1000_centos-6.5-20140324.xml
+/etc/libvirt/storage/vagrant_1000_vagrant-kvm.xml
+/etc/libvirt/storage/vagrant.xml
+# rm -i /etc/libvirt/storage/vagrant*
+rm: remove regular file ‘/etc/libvirt/storage/vagrant_1000_archlinux-x86_64-20140325.xml’? y
+rm: remove regular file ‘/etc/libvirt/storage/vagrant_1000_centos-6.5-20140316.xml’? y
+rm: remove regular file ‘/etc/libvirt/storage/vagrant_1000_centos-6.5-20140324.xml’? y
+rm: remove regular file ‘/etc/libvirt/storage/vagrant_1000_vagrant-kvm.xml’? y
+rm: remove regular file ‘/etc/libvirt/storage/vagrant.xml’? y
+# ls /etc/libvirt/storage/vagrant*
+ls: cannot access /etc/libvirt/storage/vagrant*: No such file or directory
+# exit
+```
+
+alternative way:
+
+* open virt-manager
+* connect to localhost
+* right click connection and open details
+* click storage tab
+* right click each 'vagrant*' storage pool and delete it.
+
+#### how to restart libvirt daemon
+
+Ubuntu/Debian
+```bash
+$ sudo service libvirt-bin restart
+```
+
+Fedora/CentOS/SuSE/Arch previous versions
+```bash
+$ sudo service libvirtd restart
+```
+
+Fedora/CentOS/SuSE/Arch recent versions
+```bash
+$ sudo systemctl restart libvirtd
+```
+
 ### Ubuntu
 Some versions of Ubuntu kernel has a bug that will cause vagrant-kvm
 to fail with a permission error on `vagrant up`. It is a kernel bug with the AppArmor security framework.

data/lib/vagrant-kvm/action.rb

@@ -260,7 +260,11 @@ module VagrantPlugins
           b.use Call, Created do |env, b2|
             # If the VM is NOT created yet, then do the setup steps
             if !env[:result]
-              b2.use CheckBox
+              if Vagrant::VERSION < "1.5.0"
+                b2.use CheckBox
+              else
+                b2.use HandleBox
+              end
               b2.use SetName
               b2.use Import
               b2.use MatchMACAddress

data/lib/vagrant-kvm/action/check_kvm.rb

@@ -12,7 +12,7 @@ module VagrantPlugins
           # set-up and the driver is ready to function. If not, then an
           # exception will be raised which will break us out of execution
           # of the middleware sequence.
-          Driver::Driver.new.verify!
+          env[:machine].provider.driver.verify!
 
           # Carry on.
           @app.call(env)

data/lib/vagrant-kvm/action/import.rb

@@ -43,6 +43,16 @@ module VagrantPlugins
           box_file = @env[:machine].box.directory.join("box.xml").to_s
           raise Errors::KvmBadBoxFormat unless File.file?(box_file)
 
+          # check pool migration neccesary?
+          if @env[:machine].provider.driver.pool_migrate
+            @env[:ui].output "Your vagrant-kvm environment should be fixed. see README"
+          end
+
+          # repair directories permission
+          home_path = File.expand_path("../../", @env[:tmp_path])
+          boxes_path = File.expand_path("../boxes/", @env[:tmp_path])
+          repair_permissions!(home_path, boxes_path)
+
           # import box volume
           volume_name = import_volume(storage_path, box_file, args)
 
@@ -118,6 +128,26 @@ module VagrantPlugins
           new_disk
         end
 
+        # Repairs $HOME an $HOME/.vagrangt.d/boxes permissions.
+        #
+        # work around for
+        # https://github.com/adrahon/vagrant-kvm/issues/193
+        # https://github.com/adrahon/vagrant-kvm/issues/163
+        # https://github.com/adrahon/vagrant-kvm/issues/130
+        #
+        def repair_permissions!(home_path, boxes_path)
+          # check pathes
+          [home_path, boxes_path].each do |d|
+            s = File::Stat.new(d)
+            @logger.debug("#{d} permission: #{s.mode}")
+            if (s.mode & 1 == 0)
+              @env[:ui].info I18n.t("vagrant_kvm.repair_permission",:directory => d,
+                :old_mode => sprintf("%o",s.mode), :new_mode => sprintf("%o", s.mode|1))
+              File.chmod(s.mode | 1, d)
+            end
+          end
+        end
+
         def recover(env)
           if env[:machine].provider.state.id != :not_created
             return if env["vagrant.error"].is_a?(Vagrant::Errors::VagrantError)

data/lib/vagrant-kvm/driver/driver.rb

@@ -36,40 +36,20 @@ module VagrantPlugins
         # KVM support status
         attr_reader :kvm
 
-        def initialize(uuid=nil, conn=nil)
+        # Vagrant 1.5.x pool migration
+        attr_reader :pool_migrate
+
+        def initialize(uuid=nil)
           @logger = Log4r::Logger.new("vagrant::provider::kvm::driver")
           @uuid = uuid
           # This should be configurable
           @pool_name = "vagrant"
           @network_name = "vagrant"
+          @pool_migrate = false
 
           load_kvm_module!
-
-          # Open a connection to the qemu driver
-          begin
-            @conn = conn || Libvirt::open('qemu:///system')
-          rescue Libvirt::Error => e
-            if e.libvirt_code == 5
-              # can't connect to hypervisor
-              raise Vagrant::Errors::KvmNoConnection
-            else
-              raise e
-            end
-          end
-
-          @version = read_version
-          if @conn.version.to_i < 1001000
-            raise Errors::KvmInvalidVersion,
-              :actual => @version, :required => ">= 1.1.0"
-          end
-
-          # Get storage pool if it exists
-          begin
-            @pool = @conn.lookup_storage_pool_by_name(@pool_name)
-            @logger.info("Init storage pool #{@pool_name}")
-          rescue Libvirt::RetrieveError
-            # storage pool doesn't exist yet
-          end
+          connect_libvirt_qemu!
+          init_storage_pool!
 
           if @uuid
             # Verify the VM exists, and if it doesn't, then don't worry
@@ -174,11 +154,11 @@ module VagrantPlugins
           @logger.info("Importing VM #{@name}")
           # create vm definition from xml
           definition = File.open(definition) { |f| Util::VmDefinition.new(f.read) }
-          volume = @pool.lookup_volume_by_name(volume_name)
+          volume_path = lookup_volume_path_by_name(volume_name)
           args = {
             :image_type => "qcow2",
             :qemu_bin => "/usr/bin/qemu",
-            :disk => volume.path,
+            :disk => volume_path,
             :name => @name
           }.merge(args)
           definition.update(args)
@@ -235,12 +215,13 @@ module VagrantPlugins
           # Storage pool doesn't exist so we create it
           # create dir if it doesn't exist
           # if we let libvirt create the dir it is owned by root
-          pool_path = base_path.join("storage-pool")
-          pool_path.mkpath unless Dir.exists?(pool_path)
-          @pool = init_storage_directory(
+          pool_path = File.join(base_path, "/storage-pool")
+          FileUtils.mkpath(pool_path) unless Dir.exists?(pool_path)
+          init_storage_directory(
                      :pool_path => pool_path,
                      :pool_name => @pool_name,
                      :owner => uid, :group=>gid, :mode=>'755')
+          init_storage_pool!
         end
 
         def init_storage_directory(args={})
@@ -263,8 +244,29 @@ module VagrantPlugins
               </target>
               </pool>
              EOF
-            pool = @conn.define_storage_pool_xml(storage_pool_xml)
-            pool.build
+            # create transient pool
+            #
+            # WARN:
+            #  vagrant-kvm 0.1.5 uses
+            #     pool = @conn.define_storage_pool_xml(storage_pool_xml)
+            #  that made 'pesistent' storage pool
+            #  this caused problem when following sinario:
+            #
+            #  1. user use vagrant-kvm 0.1.5 with vagrant-1.4.x
+            #  2. user upgrade vagrant 1.5.x
+            #  3. user upgrade vagrant 0.1.5.1 and after
+            #
+            #  vagrant-kvm 0.1.5 don't work with vagrant 1.5.x
+            #  previous synario can be happned on many user.
+            #
+            # We use transient pool instead of persistent one
+            # in vagrant-kvm 0.1.5.x, 0.1.6 and after
+            #
+            #  Pools defined here will be removed after system reboot.
+            #
+            pool = @conn.create_storage_pool_xml(storage_pool_xml)
+            pool.build unless pool.active?
+            #XXX use? pool.build(Libvirt::StoragePool::BUILD_NO_OVERWRITE)
             @logger.info("Creating storage pool #{args[:pool_name]} in #{args[:pool_path]}")
           end
           pool.create unless pool.active?
@@ -272,9 +274,27 @@ module VagrantPlugins
           pool
         end
 
+        def check_migrate_box_storage_pool
+          # Migration to new pool directory structure in vagrant 1.5.x
+          # delete if created with <vagrant-1.4.x
+          if Vagrant::VERSION >= "1.5.0"
+            begin
+              if @pool && @pool.persistent?
+                # pool was made by vagrant-kvm-0.1.5 and before
+                # vagrant-kvm-0.1.5 NOT working in vagrant 1.5.x
+                # so need migrate
+                @pool_migrate = true
+              end
+            rescue Libvirt::RetrieveError
+              @logger.info("fail to retrieve storage pool")
+            end
+          end
+        end
+
         def free_storage_pool(pool_name)
           begin
             pool = @conn.lookup_storage_pool_by_name(pool_name)
+            # XXX  check reference counter for parallel action?
             pool.destroy
             pool.free
           rescue Libvirt::RetrieveError
@@ -282,6 +302,11 @@ module VagrantPlugins
           end
         end
 
+        def lookup_volume_path_by_name(volume_name)
+          volume = @pool.lookup_volume_by_name(volume_name)
+          volume.path
+        end
+
         # Returns a list of network interfaces of the VM.
         #
         # @return [Hash]
@@ -324,17 +349,6 @@ module VagrantPlugins
           VM_STATE[state]
         end
 
-        # Return the qemu version
-        #
-        # @return [String] of the form "1.2.2"
-        def read_version
-          # libvirt returns a number like 1002002 for version 1.2.2
-          maj = @conn.version / 1000000
-          min = (@conn.version - maj*1000000) / 1000
-          rel = @conn.version % 1000
-          "#{maj}.#{min}.#{rel}"
-        end
-
         def read_mac_address
           domain = @conn.lookup_domain_by_uuid(@uuid)
           definition = Util::VmDefinition.new(domain.xml_desc)
@@ -494,6 +508,18 @@ module VagrantPlugins
         end
 
         private
+
+        # Return the qemu version
+        #
+        # @return [String] of the form "1.2.2"
+        def read_version
+          # libvirt returns a number like 1002002 for version 1.2.2
+          maj = @conn.version / 1000000
+          min = (@conn.version - maj*1000000) / 1000
+          rel = @conn.version % 1000
+          "#{maj}.#{min}.#{rel}"
+        end
+
         def load_kvm_module!
           @logger.info("Check KVM kernel modules")
           kvm = File.readlines('/proc/modules').any? { |line| line =~ /kvm_(intel|amd)/ }
@@ -511,6 +537,38 @@ module VagrantPlugins
           raise Errors::VagrantKVMError, "KVM is unavailable" unless kvm
           true
         end
+
+        def connect_libvirt_qemu!
+          # Open a connection to the qemu driver
+          begin
+            @conn = Libvirt::open('qemu:///system')
+          rescue Libvirt::Error => e
+            if e.libvirt_code == 5
+              # can't connect to hypervisor
+              raise Vagrant::Errors::KvmNoConnection
+            else
+              raise e
+            end
+          end
+
+          @version = read_version
+          if @conn.version.to_i < 1001000
+            raise Errors::KvmInvalidVersion,
+              :actual => @version, :required => ">= 1.1.0"
+          end
+        end
+
+        def init_storage_pool!
+          # Get storage pool if it exists
+          begin
+            @pool = @conn.lookup_storage_pool_by_name(@pool_name)
+            # this is happen when user has already used vagrant-kvm 0.1.5 and after
+            # check neccesity of migration
+            check_migrate_box_storage_pool
+          rescue Libvirt::RetrieveError
+            # storage pool doesn't exist yet
+          end
+        end
       end
     end
   end

data/lib/vagrant-kvm/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module ProviderKvm
-    VERSION = "0.1.5"
+    VERSION = "0.1.7"
   end
 end

data/locales/en.yml

@@ -2,6 +2,8 @@ en:
   vagrant_kvm:
     test_message: |-
       This is a test message.
+    repair_permission: |-
+      Change directory %{directory} permission from %{old_mode} to %{new_mode}.
     errors:
       kvm_no_connection: |-
         Cannot connect to KVM through Libvirt. Please check kernel module

data/spec/test_files/box.xml

@@ -1,5 +1,5 @@
-<domain type='kvm' id='37'>
-  <name>winxp_base</name>
+<domain type='kvm'>
+  <name>test_base</name>
   <memory unit='KiB'>524288</memory>
   <currentMemory unit='KiB'>524288</currentMemory>
   <vcpu placement='static'>1</vcpu>
@@ -15,20 +15,21 @@
   <clock offset='utc'/>
   <on_poweroff>destroy</on_poweroff>
   <on_reboot>restart</on_reboot>
-  <on_crash>restart</on_crash>
+  <on_crash>destroy</on_crash>
   <devices>
     <emulator>/usr/bin/kvm</emulator>
     <disk type='file' device='disk'>
       <driver name='qemu' type='qcow2'/>
-      <source file='winxp.qcow2'/>
+      <source file='box-disk1.img'/>
       <target dev='vda' bus='virtio'/>
-      <alias name='virtio-disk0'/>
-      <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x04' function='0x0'/>
     </disk>
     <controller type='usb' index='0'>
-      <alias name='usb0'/>
       <address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x2'/>
     </controller>
+    <controller type='ide' index='0'>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x1'/>
+    </controller>
     <controller type='virtio-serial' index='0'>
       <alias name='virtio-serial0'/>
       <address type='pci' domain='0x0000' bus='0x00' slot='0x05' function='0x0'/>
@@ -36,39 +37,26 @@
     <interface type='network'>
       <mac address='08:00:27:30:3b:ea'/>
       <source network='vagrant'/>
-      <target dev='vnet0'/>
       <model type='virtio'/>
-      <alias name='net0'/>
       <address type='pci' domain='0x0000' bus='0x00' slot='0x03' function='0x0'/>
     </interface>
     <serial type='pty'>
-      <source path='/dev/pts/1'/>
       <target port='0'/>
-      <alias name='serial0'/>
     </serial>
-    <console type='pty' tty='/dev/pts/1'>
-      <source path='/dev/pts/1'/>
+    <console type='pty'>
       <target type='serial' port='0'/>
-      <alias name='serial0'/>
     </console>
     <input type='mouse' bus='ps2'/>
     <graphics type='vnc' port='5900' autoport='no' listen='0.0.0.0'>
       <listen type='address' address='0.0.0.0'/>
     </graphics>
-    <sound model='ich6'>
-      <alias name='sound0'/>
-      <address type='pci' domain='0x0000' bus='0x00' slot='0x04' function='0x0'/>
-    </sound>
     <video>
       <model type='cirrus' vram='9216' heads='1'/>
-      <alias name='video0'/>
       <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0'/>
     </video>
     <memballoon model='virtio'>
-      <alias name='balloon0'/>
-      <address type='pci' domain='0x0000' bus='0x00' slot='0x07' function='0x0'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/>
     </memballoon>
   </devices>
   <seclabel type='none'/>
 </domain>
-

data/spec/vagrant-kvm/config_spec.rb

@@ -2,6 +2,31 @@ require 'spec_helper'
 require "vagrant-kvm/config"
 
 describe  VagrantPlugins::ProviderKvm::Config do
+  describe "#image_type" do
+    it "defaults to qcow2" do
+      should_default(:image_type, 'qcow2')
+    end
+  end
+
+  describe "#image_backing" do
+    it "default to true" do
+      subject.finalize!
+      subject.image_backing.should be_true
+    end
+  end
+
+  describe "#cpu_model" do
+    it "default to x86-64" do
+      should_default(:cpu_model, 'x86_64')
+    end
+  end
+
+  describe "#core_number" do
+    it "default to 1" do
+      should_default(:core_number, 1)
+    end
+  end
+
   describe "#machine_type" do
     it "defaults to pc-1.2" do
       should_default(:machine_type, "pc-1.2")

data/spec/vagrant-kvm/driver/driver_spec.rb

@@ -5,28 +5,56 @@ module VagrantPlugins
     module Driver
       describe Driver do
         let(:xml) { test_file "box.xml" }
-        let(:volume_name) { "" }
+        let(:name) { 'spec-test' }
+        let(:disk_name) { 'spec-test' }
+        let(:box_path) { test_file "box-disk1.img" }
+        let(:box_pool) { test_file "" }
+        let(:capacity) { {:size=>256, :unit=>'KB'} }
+        let(:image_path) { '/tmp/pool-storage/box-disk1.img' }
+        let(:image_type) { 'qcow2' }
+        let(:uid) { 1000 }
+        let(:gid) { 1000 }
 
         before do
           described_class.any_instance.stub(:load_kvm_module!) { true }
+          described_class.any_instance.stub(:lookup_volume_path_by_name) { "/tmp/pool-storage/box-disk1.img" }
         end
 
         describe "#import" do
-          # FIXME All of these required stubs are a symptom of bad design in the
-          # driver class. 
-          let(:volume) { double(path: "foo") }
-          let(:pool) { double(refresh: nil, lookup_volume_by_name: volume) }
-          let(:domain) { double(uuid: "abc") }
-          let(:conn) { double(version: 1000000000, 
-                              lookup_storage_pool_by_name: pool, 
-                              define_domain_xml: domain) }
+
           subject do
-            described_class.new(nil, conn)
+            described_class.new(nil)
+          end
+
+          it "does not raise exeption" do
+            expect do
+              subject.set_name(name)
+            end.to_not raise_exception
+          end
+
+          it "does not raise execption" do
+            expect do
+              subject.init_storage("/tmp", uid, gid)
+            end.to_not raise_exception
+          end
+
+          it "does not raise exception" do
+            expect do
+              subject.init_storage("/tmp", uid, gid)
+              subject.create_volume(
+                  :disk_name  => disk_name,
+                  :capacity   => capacity,
+                  :path       => image_path,
+                  :image_type => image_type,
+                  :box_path   => box_path,
+                  :backing    => true)
+              end.to_not raise_exception
           end
 
           it "does not raise exception" do
             expect do
-              subject.import(xml, volume_name)
+              subject.set_name(name)
+              subject.import(xml, disk_name)
             end.to_not raise_exception
           end
         end

data/spec/vagrant-kvm/util/vm_definition_spec.rb

@@ -31,7 +31,7 @@ describe VagrantPlugins::ProviderKvm::Util::VmDefinition do
 
       it "should set and load the GUI settings" do
         should_set(:gui, true) do |xml|
-          xml.should include("<graphics type='vnc'")
+          xml.should include("type='vnc'")
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-kvm
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Alex Drahon
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-22 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-libvirt
@@ -105,6 +105,7 @@ files:
 - vagrant-kvm.gemspec
 - spec/acceptance/vagrant-kvm_spec.rb
 - spec/test_files/box.xml
+- spec/test_files/box-disk1.img
 - spec/fedora/50-vagrant-libvirt-access.pkla
 - spec/fedora/10.virt.rules
 - spec/vagrant-kvm/errors_spec.rb