vagrant-mutate 0.1.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 0.1.2 (2013-11-20)
+
+* Rework provider and converter implementation (#7)
+
+# 0.1.1 (2013-11-12)
+
+* Fix handling of fractional virtual disk sizes (#11)
+
+# 0.1.0 (2013-11-02)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-mutate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Pitts
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# Vagrant-Mutate
+
+Vagrant-mutate is a [vagrant](http://www.vagrantup.com/) plugin to convert vagrant boxes to work with different providers. Currently the only supported conversion is from virtualbox to [libvirt](https://github.com/pradels/vagrant-libvirt).
+
+## Installation
+
+### qemu-img
+
+First, you must install [qemu-img](http://wiki.qemu.org/Main_Page). Support for the disk image format most commonly used in vagrant boxes for virtualbox was added in [version 1.2.0](http://wiki.qemu.org/ChangeLog/1.2#VMDK); if you have an older version vagrant-mutate will warn you and most likely won't work.
+
+#### Debian and derivatives
+
+    apt-get install qemu-utils
+
+#### Red Hat and derivatives
+
+    yum install qemu-img
+
+#### OS X
+
+QEMU is available from [homebrew](http://brew.sh/)
+
+#### Windows
+
+Download and install it from [Stefan Weil](http://qemu.weilnetz.de/) or compile it yourself.
+
+### vagrant-mutate
+
+Then you can install vagrant-mutate. Once it has proven stable I will publish it to RubyGems, but for now you must build it from source.
+
+    git clone https://github.com/sciurus/vagrant-mutate.git
+    cd vagrant-mutate
+    rake build
+    vagrant plugin install pkg/*
+
+## Usage
+
+The basic usage is
+
+    vagrant mutate box-name-or-file 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 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
+
+    vagrant mutate precise32 libvirt
+
+To export a box you created with vagrant mutate, just repackage it, e.g.
+
+    vagrant box repackage precise32 libvirt
+
+
+## Debugging
+
+vagrant and vagrant-mutate will output lots of information as they run if you set the VAGRANT_LOG environment variable to INFO. See [here](http://docs-v1.vagrantup.com/v1/docs/debugging.html) for information on how to do that on your operating system.
+
+If you experience any problems, please open an issue on [github](https://github.com/sciurus/vagrant-mutate/issues).
+
+## Contributing
+
+Contributions are welcome! I'd especially like to see support for converting between more providers added. Be forewarned that I've made some assumptions in the code that may have to be reworked in order to support more than just virtualbox to libvirt.
+
+To contribute, follow the standard flow of
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Even if you can't contribute code, if you have an idea for an improvement please open an [issue](https://github.com/sciurus/vagrant-mutate/issues).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vagrant-mutate.rb

@@ -0,0 +1,22 @@
+require 'vagrant-mutate/version'
+require 'vagrant-mutate/errors'
+
+module VagrantMutate
+
+  class Plugin < Vagrant.plugin('2')
+    name 'vagrant-mutate'
+
+    command 'mutate' do
+      setup_i18n
+      require 'vagrant-mutate/mutate'
+      Mutate
+    end
+
+    def self.setup_i18n
+      I18n.load_path << File.expand_path('../../locales/en.yml', __FILE__)
+      I18n.reload!
+    end
+
+  end
+
+end

data/lib/vagrant-mutate/box.rb

@@ -0,0 +1,130 @@
+require 'archive/tar/minitar'
+require 'fileutils'
+require 'json'
+require 'zlib'
+
+module VagrantMutate
+  class Box
+
+    include Archive::Tar
+
+    attr_reader :dir, :name, :provider
+
+    def initialize( env )
+      @env = env
+      @logger = Log4r::Logger.new('vagrant::mutate')
+    end
+
+    def prepare_for_output( box_name, provider_name )
+      @logger.info "Preparing #{box_name} for output as #{provider_name}"
+      @name = box_name
+      @provider = Provider::Provider.create( provider_name )
+      @dir = create_output_dir()
+      @dir_is_tmp = false
+
+      unless @provider.supported_output
+        raise Errors::ProviderNotSupported, :provider => provider_name, :direction => 'output'
+      end
+    end
+
+    def load_from_file(file)
+      @logger.info "Loading box from file #{file}"
+      @name = File.basename( file, File.extname(file) )
+      @dir = unpack(file)
+      @dir_is_tmp = true
+      @provider = determine_provider()
+
+      unless @provider.supported_input
+        raise Errors::ProviderNotSupported, :provider => provider_name, :direction => 'input'
+      end
+    end
+
+    def load_by_name(name)
+      @logger.info "Loading box from name #{name}"
+      @name = name
+      # cheat for now since only supported input is virtualbox
+      @provider = Provider::Provider.create('virtualbox')
+      @dir = find_input_dir()
+      @dir_is_tmp = false
+    end
+
+    def cleanup
+      if @dir_is_tmp
+        @env.ui.info "Cleaning up temporary files."
+        @logger.info "Deleting #{dir}"
+        FileUtils.remove_entry_secure(@dir)
+      end
+    end
+
+    def determine_provider
+      metadata_file = File.join(@dir, 'metadata.json')
+      if File.exists? metadata_file
+        begin
+          metadata = JSON.load( File.new( metadata_file, 'r') )
+        rescue => e
+          raise Errors::DetermineProviderFailed, :error_message => e.message
+        end
+        @logger.info "Determined input provider is #{metadata['provider']}"
+        return Provider::Provider.create( metadata['provider'] )
+      else
+        @logger.info "No metadata found, so assuming input provider is virtualbox"
+        return Provider::Provider.create('virtualbox')
+      end
+    end
+
+    def find_input_dir
+      in_dir = File.join( @env.boxes_path, @name, 'virtualbox' )
+      if File.directory?(in_dir)
+        @logger.info "Found input directory #{in_dir}"
+        return in_dir
+      else
+        raise Errors::BoxNotFound, :box => in_dir
+      end
+    end
+
+    def create_output_dir
+      # e.g. $HOME/.vagrant.d/boxes/fedora-19/libvirt
+      out_dir = File.join( @env.boxes_path, @name, @provider.name )
+      begin
+        FileUtils.mkdir_p(out_dir)
+      rescue => e
+        raise Errors::CreateBoxDirFailed, :error_message => e.message
+      end
+      @logger.info "Created output directory #{out_dir}"
+      return out_dir
+    end
+
+    def unpack(file)
+      @env.ui.info "Extracting box file to a temporary directory."
+      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
+      end
+      @logger.info "Unpacked box to #{tmp_dir}"
+      return tmp_dir
+    end
+
+    def determine_virtual_size
+      input_file = File.join( @dir, @provider.image_name )
+      info = `qemu-img info #{input_file}`
+      @logger.debug "qemu-img info output\n#{info}"
+      if info =~ /(\d+) bytes/
+        return $1
+      else
+        raise Errors::DetermineImageSizeFailed
+      end
+    end
+
+  end
+end

data/lib/vagrant-mutate/converter.rb

@@ -0,0 +1,111 @@
+require 'fileutils'
+
+module VagrantMutate
+  class Converter
+
+    def initialize(env)
+      @env = env
+      @logger = Log4r::Logger.new('vagrant::mutate')
+      verify_qemu_installed
+      verify_qemu_version
+    end
+
+    # http://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
+    def verify_qemu_installed
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "qemu-img#{ext}")
+          if File.executable? exe
+            @logger.info "Found qemu"
+            return
+          end
+        end
+      end
+      # if we make it here qemu-img command was not found
+      raise Errors::QemuNotFound
+    end
+
+    def verify_qemu_version
+      usage = `qemu-img`
+      if usage =~ /(\d+\.\d+\.\d+)/
+        recommended_version = Gem::Version.new('1.2.0')
+        installed_version = Gem::Version.new($1)
+        if installed_version < recommended_version
+          @env.ui.warn "You have qemu #{installed_version} installed. "\
+            "This version is too old to read some virtualbox boxes. "\
+            "If conversion fails, try upgrading to qemu 1.2.0 or newer."
+        end
+      else
+        raise Errors::ParseQemuVersionFailed
+      end
+    end
+
+    def write_metadata(input_box, output_box)
+      metadata = output_box.provider.generate_metadata(input_box, output_box)
+      begin
+        File.open( File.join( output_box.dir, 'metadata.json'), 'w') do |f|
+          f.write( JSON.generate(metadata) )
+        end
+      rescue => e
+        raise Errors::WriteMetadataFailed, :error_message => e.message
+      end
+      @logger.info "Wrote metadata"
+    end
+
+    def copy_vagrantfile(input_box, output_box)
+      input = File.join( input_box.dir, 'Vagrantfile' )
+      if File.exists? input
+        output = File.join( output_box.dir, 'Vagrantfile' )
+        @logger.info "Copying #{input} to #{output}"
+        begin
+          FileUtils.copy_file(input, output)
+        rescue => e
+          raise Errors::WriteVagrantfileFailed, :error_message => e.message
+        end
+      end
+    end
+
+    def write_disk(input_box, output_box)
+      if input_box.provider.image_format == output_box.provider.image_format
+        copy_disk(input_box, output_box)
+      else
+        convert_disk(input_box, output_box)
+      end
+    end
+
+    def copy_disk(input_box, output_box)
+      input = File.join( input_box.dir, input_box.provider.image_name )
+      output = File.join( output_box.dir, output_box.provider.image_name )
+      @logger.info "Copying #{input} to #{output}"
+      begin
+        FileUtils.copy_file(input, output)
+      rescue => e
+        raise Errors::WriteDiskFailed, :error_message => e.message
+      end
+    end
+
+    def convert_disk(input_box, output_box)
+      input_file    = File.join( input_box.dir, input_box.provider.image_name )
+      output_file   = File.join( output_box.dir, output_box.provider.image_name )
+      input_format  = input_box.provider.image_format
+      output_format = output_box.provider.image_format
+
+      command = "qemu-img convert -p -f #{input_format} -O #{output_format} #{input_file} #{output_file}"
+      @logger.info "Running #{command}"
+      unless system(command)
+        raise Errors::WriteDiskFailed, :error_message => "qemu-img exited with status #{$?.exitstatus}"
+      end
+    end
+
+    def convert(input_box, output_box)
+      @env.ui.info "Converting #{input_box.name} from #{input_box.provider.name} "\
+        "to #{output_box.provider.name}."
+      write_metadata(input_box, output_box)
+      # will have to rethink this if any providers need to alter the vagrantfile
+      copy_vagrantfile(input_box, output_box)
+      write_disk(input_box, output_box)
+    end
+
+  end
+end

data/lib/vagrant-mutate/errors.rb

@@ -0,0 +1,54 @@
+require 'vagrant'
+
+module VagrantMutate
+  module Errors
+    class VagrantMutateError < Vagrant::Errors::VagrantError
+      error_namespace('vagrant_mutate.errors')
+    end
+
+    class ProviderNotSupported < VagrantMutateError
+      error_key(:provider_not_supported)
+    end
+
+    class QemuNotFound < VagrantMutateError
+      error_key(:qemu_not_found)
+    end
+
+    class BoxNotFound < VagrantMutateError
+      error_key(:box_not_found)
+    end
+
+    class ExtractBoxFailed < VagrantMutateError
+      error_key(:extract_box_failed)
+    end
+
+    class DetermineProviderFailed < VagrantMutateError
+      error_key(:determine_provider_failed)
+    end
+
+    class CreateBoxDirFailed < VagrantMutateError
+      error_key(:create_box_dir_failed)
+    end
+
+    class WriteMetadataFailed < VagrantMutateError
+      error_key(:write_metadata_failed)
+    end
+
+    class WriteVagrantfileFailed < VagrantMutateError
+      error_key(:write_vagrantfile_failed)
+    end
+
+    class WriteDiskFailed < VagrantMutateError
+      error_key(:write_disk_failed)
+    end
+
+    class ParseQemuVersionFailed < VagrantMutateError
+      error_key(:parse_qemu_version_failed)
+    end
+
+    class Errors::DetermineImageSizeFailed < VagrantMutateError
+      error_key(:determine_image_size_failed)
+    end
+
+  end
+end

data/lib/vagrant-mutate/mutate.rb

@@ -0,0 +1,46 @@
+require 'vagrant-mutate/box'
+require 'vagrant-mutate/converter'
+require 'vagrant-mutate/provider/provider'
+
+module VagrantMutate
+
+  class Mutate < Vagrant.plugin(2, :command)
+
+    def execute
+      opts = OptionParser.new do |o|
+        o.banner = 'Usage: vagrant mutate <box-name-or-file> <provider>'
+      end
+      argv = parse_options(opts)
+      return if !argv
+
+      unless argv.length == 2
+        @env.ui.info(opts.help)
+        return
+      end
+
+      box_arg = argv[0]
+      output_provider_arg = argv[1]
+
+      c = Converter.new(@env)
+      input_box = Box.new(@env)
+      output_box = Box.new(@env)
+
+      if box_arg =~ /\.box$/
+        input_box.load_from_file(box_arg)
+      else
+        input_box.load_by_name(box_arg)
+      end
+
+      output_box.prepare_for_output( input_box.name, output_provider_arg)
+
+      c.convert(input_box, output_box)
+
+      input_box.cleanup
+
+      @env.ui.info "The box #{output_box.name} (#{output_box.provider.name}) is now ready to use."
+
+    end
+
+  end
+
+end

data/lib/vagrant-mutate/provider/libvirt.rb

@@ -0,0 +1,22 @@
+module VagrantMutate
+  module Provider
+    class Libvirt < Provider
+      def initialize
+          @name             = 'libvirt'
+          @supported_input  = true,
+          @supported_output = true,
+          @image_format     = 'qcow2',
+          @image_name       = 'box.img'
+      end
+
+      def generate_metadata(input_box, output_box)
+        metadata = {
+          'provider' => output_box.provider.name,
+          'format'   => 'qcow2',
+          'virtual_size' => ( input_box.determine_virtual_size.to_f / (1024 * 1024 * 1024) ).ceil
+        }
+      end
+
+    end
+  end
+end

data/lib/vagrant-mutate/provider/provider.rb

@@ -0,0 +1,21 @@
+module VagrantMutate
+  module Provider
+    class Provider
+      attr_reader :name, :supported_input, :supported_output, :image_format, :image_name
+
+      def self.create(name)
+        case name
+        when 'libvirt'
+          require_relative 'libvirt'
+          Libvirt.new
+        when 'virtualbox'
+          require_relative 'virtualbox'
+          Virtualbox.new
+        else
+          raise Errors::ProviderNotSupported, :provider => name, :direction => 'input or output'
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module VagrantMutate
+  module Provider
+
+    class Virtualbox < Provider
+      def initialize
+          @name             = 'virtualbox'
+          @supported_input  = true,
+          @supported_output = false,
+          @image_format     = 'vmdk',
+          @image_name       = 'box-disk1.vmdk'
+      end
+    end
+
+  end
+end
+

data/lib/vagrant-mutate/version.rb

@@ -0,0 +1,3 @@
+module VagrantMutate
+  VERSION = '0.1.2'
+end

data/locales/en.yml

@@ -0,0 +1,31 @@
+en:
+  vagrant_mutate:
+    errors:
+      provider_not_supported: |-
+        Vagrant-mutate does not support %{provider} for %{direction}
+      qemu_not_found: |-
+        Qemu-img was not found in your path
+      box_not_found: |-
+        The box at %{box} was not found
+      extract_box_failed: |-
+        Extracting box failed with error:
+        %{error_message}
+      determine_provider_failed: |-
+        Determining provider for box failed with error:
+        %{error_message}
+      create_box_dir_failed: |-
+        Creating directory for box failed with error:
+        %{error_message}
+      write_metadata_failed: |-
+        Writing metadata for box failed with error:
+        %{error_message}
+      write_vagrantfile_failed: |-
+        Writing vagrantfile for box failed with error:
+        %{error_message}
+      write_disk_failed: |-
+        Writing disk image for box failed with error:
+        %{error_message}
+      parse_qemu_version_failed: |-
+        Determining the version of qemu-img installed failed
+      determine_image_size_failed: |-
+        Determining the virtual size of the disk image failed

data/vagrant-mutate.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-mutate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-mutate"
+  spec.version       = VagrantMutate::VERSION
+  spec.authors       = ["Brian Pitts"]
+  spec.email         = ["brian@polibyte.com"]
+  spec.description   = %q{Convert vagrant boxes to work with different providers}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "archive-tar-minitar", "~> 0.5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-mutate
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Brian Pitts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: archive-tar-minitar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Convert vagrant boxes to work with different providers
+email:
+- brian@polibyte.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-mutate.rb
+- lib/vagrant-mutate/box.rb
+- lib/vagrant-mutate/converter.rb
+- lib/vagrant-mutate/errors.rb
+- lib/vagrant-mutate/mutate.rb
+- lib/vagrant-mutate/provider/libvirt.rb
+- lib/vagrant-mutate/provider/provider.rb
+- lib/vagrant-mutate/provider/virtualbox.rb
+- lib/vagrant-mutate/version.rb
+- locales/en.yml
+- test/mutate-test.box
+- vagrant-mutate.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Convert vagrant boxes to work with different providers
+test_files:
+- test/mutate-test.box