vagrant-mutate 0.1.4 → 0.1.5

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.1.5 (2013-12-17)
+* Preserve dsik interface type when coverting to KVM (#21)
+* Remove dependency in minitar (#24)
+* Support downloading input box (#9)
+* Handle errors when reading ovf file
+
 # 0.1.4 (2013-12-08)
 * Rework box and converter implementation (#7)
 * Write disk images as sparse files (#13)

data/README.md

@@ -41,14 +41,17 @@ To install from source, clone the repository and run `rake build`. That will pro
 
 The basic usage is
 
-    vagrant mutate box-name-or-file output-provider
+    vagrant mutate box-name-or-file-or-url output-provider
 
 For example, if you wanted to download a box created for virtualbox and add it to vagrant for libvirt
 
-    wget http://files.vagrantup.com/precise32.box
+    vagrant mutate http://files.vagrantup.com/precise32.box libvirt
+
+Or if you had already downloaded it
+
     vagrant mutate precise32.box libvirt
 
-Or, if you had already added the virtualbox version of the box to vagrant and now want to use it with libvirt
+Or if you had already added the virtualbox version of the box to vagrant and now want to use it with libvirt
 
     vagrant mutate precise32 libvirt
 

data/lib/vagrant-mutate/box/virtualbox.rb

@@ -26,38 +26,97 @@ module VagrantMutate
 
       # use mac from the first enabled nic
       def mac_address
+        mac = nil
+
         ovf.elements.each("//vbox:Machine/Hardware//Adapter") do |ele|
           if ele.attributes['enabled'] == 'true'
-            mac = ele.attributes['MACAddress']
-            # convert to more standarad format with colons
-            return mac[0..1] + ":" + mac[2..3] + ":" +
-              mac[4..5] + ":" + mac[6..7] + ":" +
-              mac[8..9] + ":" + mac[10..11]
+            mac = format_mac( ele.attributes['MACAddress'] )
+            break
           end
         end
+
+        if mac
+          return mac
+        else
+          raise Errors::BoxAttributeError, :error_message => 'Could not determine mac address'
+        end
       end
 
       def cpus
+        cpu_count = nil
+
         ovf.elements.each("//VirtualHardwareSection/Item") do |device|
           if device.elements["rasd:ResourceType"].text == '3'
-            return device.elements["rasd:VirtualQuantity"].text
+            cpu_count = device.elements["rasd:VirtualQuantity"].text
           end
         end
+
+        if cpu_count
+          return cpu_count
+        else
+          raise Errors::BoxAttributeError, :error_message => 'Could not determine number of CPUs'
+        end
       end
 
       def memory
+        memory_in_bytes = nil
+
         ovf.elements.each("//VirtualHardwareSection/Item") do |device|
           if device.elements["rasd:ResourceType"].text == '4'
-            return size_in_bytes(device.elements["rasd:VirtualQuantity"].text,
+            memory_in_bytes = size_in_bytes(device.elements["rasd:VirtualQuantity"].text,
               device.elements["rasd:AllocationUnits"].text)
           end
         end
+
+        if memory_in_bytes
+          return memory_in_bytes
+        else
+          raise Errors::BoxAttributeError, :error_message => 'Could not determine amount of memory'
+        end
+      end
+
+      def disk_interface
+        controller_type = {}
+        controller_used_by_disk = nil
+        ovf.elements.each("//VirtualHardwareSection/Item") do |device|
+          # when we find a controller, store its ID and type
+          # when we find a disk, store the ID of the controller it is connected to
+          case device.elements["rasd:ResourceType"].text
+          when "5"
+             controller_type[device.elements["rasd:InstanceID"].text] = 'ide'
+           when "6"
+             controller_type[device.elements["rasd:InstanceID"].text] = 'scsi'
+           when "20"
+             controller_type[device.elements["rasd:InstanceID"].text] = 'sata'
+           when "17"
+             controller_used_by_disk = device.elements["rasd:Parent"].text
+          end
+        end
+        if controller_used_by_disk and controller_type[controller_used_by_disk]
+          return controller_type[controller_used_by_disk]
+        else
+          raise Errors::BoxAttributeError, :error_message => 'Could not determine disk interface'
+        end
       end
 
       private
 
       def ovf
-        @ovf ||= REXML::Document.new( File.read( File.join( @dir, 'box.ovf') ) )
+        if @ovf
+          return @ovf
+        end
+
+        ovf_file = File.join( @dir, 'box.ovf')
+        begin
+          @ovf = REXML::Document.new( File.read(ovf_file) )
+        rescue => e
+          raise Errors::BoxAttributeError, :error_message => e.message
+        end
+      end
+
+      # convert to more standard format with colons
+      def format_mac(mac)
+        mac.scan(/(.{2})/).join(':')
       end
 
       # Takes a quantity and a unit

data/lib/vagrant-mutate/box_loader.rb

@@ -1,17 +1,16 @@
-require 'archive/tar/minitar'
 require 'fileutils'
 require 'json'
-require 'zlib'
+require 'uri'
+require "vagrant/util/subprocess"
+require "vagrant/util/downloader"
 
 module VagrantMutate
   class BoxLoader
 
-    include Archive::Tar
-
     def initialize( env )
       @env = env
       @logger = Log4r::Logger.new('vagrant::mutate')
-      @tmp_dir = nil
+      @tmp_files = []
     end
 
     def create_box(provider_name, name, dir)
@@ -36,26 +35,74 @@ module VagrantMutate
       dir = create_output_dir(name, provider_name)
       box = create_box(provider_name, name, dir)
 
-      unless box.supported_output
+      if box.supported_output
+        return box
+      else
         raise Errors::ProviderNotSupported, :provider => provider_name, :direction => 'output'
       end
+    end
+
+    def load(box_arg)
+      if box_arg =~ /:\/\//
+        box = load_from_url(box_arg)
+      elsif box_arg =~ /\.box$/
+        box = load_from_file(box_arg)
+      else
+        box = load_by_name(box_arg)
+      end
+
+      if box.supported_input
+        return box
+      else
+        raise Errors::ProviderNotSupported, :provider => provider_name, :direction => 'input'
+      end
+    end
+
+    def load_from_url(url)
+      @logger.info "Loading box from url #{url}"
+
+      # test that we have a valid url
+      url = URI(url)
+      unless url.scheme and url.host and url.path
+        raise Errors::URLError, :url => url
+      end
+
+      # extract the name of the box from the url
+      # if it ends in .box remove that extension
+      # if not just remove leading slash
+      name = nil
+      if url.path =~ /(\w+).box$/
+        name = $1
+      else
+        name = url.path.sub(/^\//, '')
+      end
+      if name.empty?
+        raise Errors::URLError, :url => url
+      end
+
+      # using same path as in vagrants box add action
+      download_path = File.join(@env.tmp_path, 'box' + Digest::SHA1.hexdigest(url.to_s))
+      @tmp_files << download_path
+
+      # if this fails it will raise an error and we'll quit
+      @env.ui.info "Downloading box #{name} from #{url}"
+      downloader = Vagrant::Util::Downloader.new(url, download_path, { :ui => @env.ui })
+      downloader.download!
 
-      return box
+      dir = unpack(download_path)
+
+      provider_name = determine_provider(dir)
+
+      box = create_box(provider_name, name, dir)
     end
 
     def load_from_file(file)
       @logger.info "Loading box from file #{file}"
       name = File.basename( file, File.extname(file) )
       dir = unpack(file)
-      @tmp_dir = dir
       provider_name = determine_provider(dir)
-      box = create_box(provider_name, name, dir)
 
-      unless box.supported_input
-        raise Errors::ProviderNotSupported, :provider => provider_name, :direction => 'input'
-      end
-
-      return box
+      box = create_box(provider_name, name, dir)
     end
 
     def load_by_name(name)
@@ -63,14 +110,15 @@ module VagrantMutate
       dir = find_input_dir(name)
       # cheat for now since only supported input is virtualbox
       box = create_box('virtualbox', name, dir)
-      return box
     end
 
     def cleanup
-      if @tmp_dir
+      unless @tmp_files.empty?
         @env.ui.info "Cleaning up temporary files."
-        @logger.info "Deleting #{@tmp_dir}"
-        FileUtils.remove_entry_secure(@tmp_dir)
+        @tmp_files.each do |f|
+          @logger.info "Deleting #{f}"
+          FileUtils.remove_entry_secure(f)
+        end
       end
     end
 
@@ -120,17 +168,12 @@ module VagrantMutate
       unless File.exists? file
         raise Errors::BoxNotFound, :box => file
       end
-      # box may or may not be gzipped
-      begin
-        tar = Zlib::GzipReader.new(File.open(file, 'rb'))
-      rescue
-        tar = file
-      end
-      begin
-        tmp_dir = Dir.mktmpdir
-        Minitar.unpack(tar, tmp_dir)
-      rescue => e
-        raise Errors::ExtractBoxFailed, :error_message => e.message
+      tmp_dir = Dir.mktmpdir(nil, @env.tmp_path)
+      @tmp_files << tmp_dir
+      result = Vagrant::Util::Subprocess.execute(
+       "bsdtar", "-v", "-x", "-m", "-C", tmp_dir.to_s, "-f", file)
+      if result.exit_code != 0
+        raise Errors::ExtractBoxFailed, :error_message => result.stderr.to_s
       end
       @logger.info "Unpacked box to #{tmp_dir}"
       return tmp_dir

data/lib/vagrant-mutate/converter/kvm.rb

@@ -16,7 +16,7 @@ module VagrantMutate
 
         uuid = nil
         gui = true
-        disk_bus = 'virtio'
+        disk_bus = @input_box.disk_interface
 
         image_type = @output_box.image_format
         disk = @output_box.image_name

data/lib/vagrant-mutate/errors.rb

@@ -46,9 +46,17 @@ module VagrantMutate
       error_key(:parse_qemu_version_failed)
     end
 
-    class Errors::DetermineImageSizeFailed < VagrantMutateError
+    class DetermineImageSizeFailed < VagrantMutateError
       error_key(:determine_image_size_failed)
     end
 
+    class BoxAttributeError < VagrantMutateError
+      error_key(:box_attribute_error)
+    end
+
+    class URLError < VagrantMutateError
+      error_key(:url_error)
+    end
+
   end
 end

data/lib/vagrant-mutate/mutate.rb

@@ -20,15 +20,11 @@ module VagrantMutate
       box_arg = argv[0]
       output_provider_arg = argv[1]
 
-      input_loader  = BoxLoader.new(@env)
-      output_loader = BoxLoader.new(@env)
 
-      if box_arg =~ /\.box$/
-        input_box = input_loader.load_from_file(box_arg)
-      else
-        input_box = input_loader.load_by_name(box_arg)
-      end
+      input_loader  = BoxLoader.new(@env)
+      input_box = input_loader.load(box_arg)
 
+      output_loader = BoxLoader.new(@env)
       output_box = output_loader.prepare_for_output( input_box.name, output_provider_arg)
 
       converter  = Converter::Converter.create(@env, input_box, output_box)

data/lib/vagrant-mutate/version.rb

@@ -1,3 +1,3 @@
 module VagrantMutate
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/locales/en.yml

@@ -29,3 +29,8 @@ en:
         Determining the version of qemu-img installed failed
       determine_image_size_failed: |-
         Determining the virtual size of the disk image failed
+      box_attribute_error: |-
+        Error determining information about the input box:
+        %{error_message}
+      url_error: |-
+          The url %{url} is not valid

data/templates/kvm/box.xml.erb

@@ -25,12 +25,16 @@
       <driver name='qemu' type='<%= image_type %>'/>
       <source file='<%= disk %>'/>
       <target dev='vda' bus='<%= disk_bus %>'/>
-    <% if disk_bus == 'virtio' %>
+  <% if disk_bus == 'virtio' %>
       <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/>
-    <% else %>
+    </disk>
+  <% else %>
       <address type='drive' controller='0' bus='0' target='0' unit='0'/>
-    <% end %>
     </disk>
+    <controller type='<%= disk_bus %>' index='0'>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/>
+    </controller>
+  <% end %>
     <controller type='usb' index='0'>
       <address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x2'/>
     </controller>

data/test/expected_output/virtualbox/kvm/box.xml

@@ -22,11 +22,14 @@
     <disk type='file' device='disk'>
       <driver name='qemu' type='qcow2'/>
       <source file='box-disk1.img'/>
-      <target dev='vda' bus='virtio'/>
-    
-      <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/>
-    
+      <target dev='vda' bus='sata'/>
+  
+      <address type='drive' controller='0' bus='0' target='0' unit='0'/>
     </disk>
+    <controller type='sata' index='0'>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x06' function='0x0'/>
+    </controller>
+  
     <controller type='usb' index='0'>
       <address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x2'/>
     </controller>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-mutate
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-08 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: archive-tar-minitar