vagrant-zfs-box 0.0.1

data/lib/vagrant/downloaders/file.rb

@@ -0,0 +1,22 @@
+require 'fileutils'
+
+module Vagrant
+  module Downloaders
+    # "Downloads" a file to a temporary file. Basically, this downloader
+    # simply does a file copy.
+    class File < Base
+      def self.match?(uri)
+        ::File.file?(::File.expand_path(uri))
+      end
+
+      def prepare(source_url)
+        raise Errors::DownloaderFileDoesntExist if !::File.file?(::File.expand_path(source_url))
+      end
+
+      def download!(source_url, destination_file)
+        @ui.info I18n.t("vagrant.downloaders.file.download")
+        FileUtils.symlink(::File.expand_path(source_url), destination_file.path, :force => true)
+      end
+    end
+  end
+end

data/lib/vagrant_init.rb

@@ -0,0 +1,6 @@
+begin
+  require 'vagrant_zfs'
+rescue LoadError
+  require 'rubygems'
+  require 'vagrant_zfs'
+end

data/lib/vagrant_zfs.rb

@@ -0,0 +1,14 @@
+require 'vagrant'
+require 'vagrant/action/builder'
+require 'vagrant_zfs/zfs_config'
+require 'vagrant_zfs/zfs'
+require 'vagrant_zfs/vboxmanage'
+require 'vagrant_zfs/actions'
+require 'vagrant_zfs/version'
+
+Vagrant.config_keys.register(:zfs) { ZfsConfig }
+Vagrant.actions[:box_remove].replace(Vagrant::Action::Box::Destroy, VagrantZFS::Action::Box::Destroy)
+Vagrant.actions[:box_add].replace(Vagrant::Action::Box::Unpackage, VagrantZFS::Action::Box::Unpackage)
+Vagrant.actions[:up].delete(Vagrant::Action::VM::DefaultName)
+Vagrant.actions[:up].replace(Vagrant::Action::VM::Import, VagrantZFS::Action::VM::Import)
+Vagrant.actions[:destroy].replace(Vagrant::Action::VM::Destroy, VagrantZFS::Action::VM::Destroy)

data/lib/vagrant_zfs/actions.rb

@@ -0,0 +1,4 @@
+require 'vagrant_zfs/actions/box/destroy'
+require 'vagrant_zfs/actions/box/unpackage'
+require 'vagrant_zfs/actions/vm/destroy'
+require 'vagrant_zfs/actions/vm/import'

data/lib/vagrant_zfs/actions/box/destroy.rb

@@ -0,0 +1,23 @@
+module VagrantZFS
+  module Action
+    module Box
+      class Destroy
+        def initialize(app, env)
+          @app = app
+          @env = env
+        end
+
+        def call(env)
+          # Delete the existing box
+          env[:ui].info I18n.t("vagrant.actions.box.destroy.destroying", :name => env[:box_name])
+          VagrantZFS::ZFS.destroy_at env['box_directory'].to_s
+
+          # Reload the box collection
+          env[:box_collection].reload!
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_zfs/actions/box/unpackage.rb

@@ -0,0 +1,82 @@
+require 'archive/tar/minitar'
+module VagrantZFS
+  module Action
+    module Box
+      # Unpackages a downloaded box to a given directory with a given
+      # name.
+      #
+      # This variant will first create a ZFS directory from a configured
+      # zpool and then unpack the box into the directory.
+      #
+      # # Required Variables
+      #
+      # * `download.temp_path` - A location for the downloaded box. This is
+      #   set by the {Download} action.
+      # * `box` - A {Vagrant::Box} object.
+      #
+      class Unpackage
+        attr_reader :box_directory
+
+        def initialize(app, env)
+          @logger   = Log4r::Logger.new("vagrant_zfs::action::box::unpackage")
+          @app = app
+          @env = env
+        end
+
+        def call(env)
+          @env = env
+
+          setup_box_directory
+          decompress
+
+          @app.call(@env)
+        end
+
+        def recover(env)
+          if box_directory && File.directory?(box_directory)
+            VagrantZFS::ZFS.destroy env[:zfs_name]
+            FileUtils.rm_rf(box_directory)
+          end
+        end
+
+        def zpool
+          # Is the zpool specified in the Vagrantfile?
+          if @env['global_config'].zfs.zpool
+            @env['global_config'].zfs.zpool
+          else
+            # If we have only one zpool available, go with that.
+            zpools = VagrantZFS::ZFS.zpool_list
+            if zpools.length == 1
+              zpools.first
+            else
+              raise Exception, "zpool not specified and more than one available."
+            end
+          end
+        end
+
+        def setup_box_directory
+          if File.directory?(@env["box_directory"])
+            raise Errors::BoxAlreadyExists, :name => @env["box_name"]
+          end
+
+          puts "ZPOOL: #{zpool}"
+          @env[:zfs_name] = "#{zpool}/vagrant_#{@env["box_name"]}"
+          mountpoint = "#{@env["box_directory"]}"
+          VagrantZFS::ZFS.create @env[:zfs_name], mountpoint
+          @box_directory = @env["box_directory"]
+        end
+
+        def decompress
+          Dir.chdir(@env["box_directory"]) do
+            @env[:ui].info I18n.t("vagrant.actions.box.unpackage.extracting")
+            begin
+              Archive::Tar::Minitar.unpack(@env["download.temp_path"], @env["box_directory"].to_s)
+            rescue SystemCallError
+              raise Errors::BoxUnpackageFailure
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_zfs/actions/vm/destroy.rb

@@ -0,0 +1,38 @@
+module VagrantZFS
+  module Action
+    module VM
+      class Destroy
+        def initialize(app, env)
+          @logger   = Log4r::Logger.new("vagrant_zfs::action::vm::destroy")
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info I18n.t("vagrant.actions.vm.destroy.destroying")
+
+          cmd = "VBoxManage showvminfo #{env[:vm].uuid}"
+          stdout, stderr, status = Open3.capture3(*cmd)
+          if status.success? and stderr.empty?
+            instance_name = stdout.lines.grep(/^Name:\s*(.+)/){$1}.first
+          else
+            raise Exception, "Could not find instance name for VM #{env[:vm].uuid}"
+          end
+
+          zpool      = 'SSD'
+          fs         = "#{zpool}/vagrant_#{env[:vm].config.vm.box}"
+          clonename    = "#{fs}/#{instance_name}"
+          snapname     = "#{fs}@#{instance_name}"
+
+          env[:vm].driver.delete
+          env[:vm].uuid = nil
+
+          VagrantZFS::ZFS.destroy clonename
+          VagrantZFS::ZFS.destroy snapname
+
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_zfs/actions/vm/import.rb

@@ -0,0 +1,72 @@
+module VagrantZFS
+  module Action
+    module VM
+      class Import
+        def initialize(app, env)
+          @logger   = Log4r::Logger.new("vagrant_zfs::action::vm::import")
+          @env = env
+          @app = app
+        end
+
+        def find_basebox_filesystem
+          fs = VagrantZFS::ZFS.mounts.select do |mountpoint,fs|
+            mountpoint == @env[:vm].box.directory.to_s
+          end.first[1]
+          @logger.debug "Found base box filesystem: #{fs}"
+          fs
+        end
+
+        def call(env)
+          env[:ui].info I18n.t("vagrant.actions.vm.import.importing", :name => env[:vm].box.name)
+
+          # Import the virtual machine
+          ovf_file = env[:vm].box.directory.join("box.ovf").to_s
+
+          fs = find_basebox_filesystem
+
+          instance_name = env[:root_path].basename.to_s + "_#{Time.now.to_i}"
+          env[:name] = instance_name
+
+          VagrantZFS::ZFS.snapshot fs, instance_name
+
+          user_home = ENV['HOME']
+          vagrant_home = "#{user_home}/.vagrant.d"
+          instance_root = vagrant_home + "/instances"
+
+          clonename = "#{fs}/#{instance_name}"
+          mountpoint = "#{instance_root}/#{instance_name}"
+          VagrantZFS::ZFS.clone! "#{fs}@#{instance_name}", clonename
+          VagrantZFS::ZFS.set_mountpoint clonename, mountpoint
+
+          hdd = instance_root + "/" + instance_name + "/box-disk1.vmdk"
+
+          env[:vm].uuid = VagrantZFS::VBoxManage.createvm instance_name, instance_root
+
+          VagrantZFS::VBoxManage.setup env[:vm].uuid, hdd
+
+          # # If we got interrupted, then the import could have been
+          # # interrupted and its not a big deal. Just return out.
+          # return if env[:interrupted]
+
+          # Flag as erroneous and return if import failed
+          raise Errors::VMImportFailure if !env[:vm].uuid
+
+          # # Import completed successfully. Continue the chain
+          @app.call(env)
+        end
+
+        def recover(env)
+          if env[:vm].created?
+            return if env["vagrant.error"].is_a?(Errors::VagrantError)
+
+            # Interrupted, destroy the VM. We note that we don't want to
+            # validate the configuration here.
+            destroy_env = env.clone
+            destroy_env[:validate] = false
+            env[:action_runner].run(:destroy, destroy_env)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_zfs/vboxmanage.rb

@@ -0,0 +1,105 @@
+require 'open3'
+module VagrantZFS
+  class VBoxManage
+    def self.exec cmd
+      cmd = "VBoxManage " + cmd
+      stdout, stderr, status = Open3.capture3(cmd)
+
+      if status.success? and stderr.empty?
+        return stdout
+      else
+        raise Exception, "VBoxManage Error: #{cmd}\n #{stdout}\n #{stderr}\n #{status}"
+      end
+    end
+
+    def self.createvm instance_name, instance_root
+      cmd = "createvm --name #{instance_name} --register --basefolder #{instance_root}"
+      lines = self.exec(cmd).split(/\n/)
+      uuid = lines.grep(/^UUID:\s*([-0-9a-z]+)/){$1}.first
+    end
+
+    def self.modifyvm uuid, arg
+      self.exec "modifyvm #{uuid} #{arg}"
+    end
+
+    def self.add_nat uuid
+      self.modifyvm  uuid, "--nic1 nat"
+    end
+
+    def self.cpus uuid, cpus
+      self.modifyvm  uuid, "--cpus #{cpus}"
+    end
+
+    def self.memory uuid, memory
+      self.modifyvm uuid, "--memory #{memory}"
+    end
+
+    def self.gethduuid file
+      # I found the line number may be 23, but search 40 just to be sure.
+      cmd="head -n 40 #{file}|grep --text --byte-offset --max-count=1 ddb.uuid.image="
+      stdout, stderr, status = Open3.capture3(cmd)
+      unless status.success? and stderr.empty?
+        raise Exception, "gethduuid Error: #{cmd}\n #{stdout}\n #{stderr}\n #{status}"
+      end
+      # UUID format is a string of hyphen-punctuated character groups of 8-4-4-4-12.
+      uuid = stdout.match(/ddb.uuid.image="(\w{8}-\w{4}-\w{4}-\w{4}-\w{12})"/).captures.first
+    end
+
+    def self.sethduuid_shell file
+      # I found the line number may be 23, but search 40 just to be sure.
+      cmd="head -n 40 #{file}|grep --text --byte-offset --max-count=1 ddb.uuid.image="
+      stdout, stderr, status = Open3.capture3(cmd)
+      unless status.success? and stderr.empty?
+        raise Exception, "gethduuid Error: #{cmd}\n #{stdout}\n #{stderr}\n #{status}"
+      end
+      # The number before : is the byte offset number.
+      uuid_offset = stdout.split(':').first.to_i + 'ddb.uuid.image="'.length
+      uuid_length = 36
+
+      # Generate a new UUID
+      stdout, stderr, status = Open3.capture3("uuidgen")
+      unless status.success? and stderr.empty?
+        raise Exception, "gethduuid Error: #{cmd}\n #{stdout}\n #{stderr}\n #{status}"
+      end
+      new_uuid = stdout.chomp
+
+      # Edit the vmdk-file inplace.
+      cmd = "echo #{new_uuid} | dd of=#{file} seek=#{uuid_offset} bs=1 count=#{uuid_length} conv=notrunc"
+      `#{cmd}` ? new_uuid : nil
+    end
+
+    def self.sethduuid file
+      self.exec "internalcommands sethduuid #{file}"
+    end
+
+    def self.add_storagectl uuid
+      self.exec "storagectl #{uuid} --name 'SATA Controller' --add sata --controller IntelAHCI --sataportcount 4 --hostiocache on  --bootable on"
+    end
+
+    def self.add_disk uuid, hddfile
+      self.exec "storageattach #{uuid} --storagectl 'SATA Controller' --port 0 --type hdd --nonrotational on --medium #{hddfile}"
+    end
+
+    def self.setup uuid, hddfile
+      uuid_pre  = self.gethduuid(hddfile)
+      self.sethduuid hddfile
+      uuid_post = self.gethduuid(hddfile)
+
+      # Did self.sethduuid work?
+      unless uuid_pre != uuid_post
+        puts "VBoxManage internalcommands sethduuid did not work. Trying shell with dd"
+        self.sethduuid_shell hddfile
+        uuid_post = self.gethduuid(hddfile)
+        unless uuid_pre != uuid_post
+          puts "Did not succeed to sethduuid."
+        end
+      end
+
+      self.add_storagectl uuid
+      self.add_disk       uuid, hddfile
+      self.add_nat        uuid
+      self.cpus           uuid, "1"
+      self.memory         uuid, "512"
+    end
+  end
+end

data/lib/vagrant_zfs/version.rb

@@ -0,0 +1,3 @@
+module VagrantZFS
+    VERSION = "0.0.1"
+end

data/lib/vagrant_zfs/zfs.rb

@@ -0,0 +1,79 @@
+require 'open3'
+module VagrantZFS
+  class ZFS
+    def self.exec cmd
+      cmd = "zfs " + cmd
+      stdout, stderr, status = Open3.capture3(cmd)
+
+      if status.success? and stderr.empty?
+        return stdout
+      else
+        raise Exception, "ZFS Error: #{cmd}\n #{stdout}\n #{stderr}\n #{status}"
+      end
+    end
+
+    def self.zpool_list
+      `zpool list -H -o name`.split(/\n/)
+    end
+
+    def self.create fs_name, mountpoint
+      cmd = "create -o mountpoint=#{mountpoint} #{fs_name}"
+      self.exec cmd
+    end
+
+    def self.destroy fs_name
+      cmd = "destroy #{fs_name}"
+      self.exec cmd
+    end
+
+    def self.destroy_at mountpoint
+        fs = VagrantZFS::ZFS.mounts.select do |mounted_at,fs|
+            mounted_at == mountpoint
+        end.first[1]
+        puts "Will destroy #{fs} mounted at #{mountpoint}"
+        self.destroy fs
+    end
+
+    def self.mounts
+      cmd = "get -rHp -oname,value mountpoint"
+      lines = self.exec(cmd).split(/\n/)
+      mounts = lines.collect do |line|
+        fs, path = line.chomp.split(/\t/, 2)
+        [path, fs]
+      end
+      Hash[mounts]
+    end
+
+    def self.set_mountpoint fs_name, mountpoint
+      cmd = "set mountpoint=#{mountpoint} #{fs_name}"
+      self.exec cmd
+    end
+
+    def self.snapshot(fsname, snapname)
+      #raise NotFound, "no such filesystem" if !exist?
+      #raise AlreadyExists, "Snapshot #{snapname} already exists" if ZFS("#{fsname}@#{snapname}").exist?
+
+      cmd = "snapshot #{fsname}@#{snapname}"
+      self.exec cmd
+      return "#{fsname}@#{snapname}"
+    end
+
+    def self.snapshot(fsname, snapname, opts={})
+      #raise NotFound, "no such filesystem" if !exist?
+      #raise AlreadyExists, "Snapshot #{snapname} already exists" if ZFS("#{fsname}@#{snapname}").exist?
+
+      cmd = "snapshot #{fsname}@#{snapname}"
+      self.exec cmd
+      return "#{fsname}@#{snapname}"
+    end
+
+    # Clone snapshot
+    def self.clone!(snapname, clonename)
+      #clonename = clone.name if clone.is_a? ZFS
+      #raise AlreadyExists if ZFS(clone).exist?
+
+      cmd = "clone #{snapname} #{clonename}"
+      self.exec cmd
+    end
+  end
+end

data/lib/vagrant_zfs/zfs_config.rb

@@ -0,0 +1,3 @@
+class ZfsConfig < Vagrant::Config::Base
+  attr_accessor :zpool
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-zfs-box
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lars Tobias Skjong-Borsting
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-18 00:00:00.000000000 Z
+dependencies: []
+description: ZFS plugin that uses snapshots and clones to speed up box creation for
+  Vagrant 1.0
+email: larstobi@relatime.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/vagrant/downloaders/file.rb
+- lib/vagrant_init.rb
+- lib/vagrant_zfs/zfs.rb
+- lib/vagrant_zfs/version.rb
+- lib/vagrant_zfs/actions/box/destroy.rb
+- lib/vagrant_zfs/actions/box/unpackage.rb
+- lib/vagrant_zfs/actions/vm/destroy.rb
+- lib/vagrant_zfs/actions/vm/import.rb
+- lib/vagrant_zfs/zfs_config.rb
+- lib/vagrant_zfs/actions.rb
+- lib/vagrant_zfs/vboxmanage.rb
+- lib/vagrant_zfs.rb
+homepage: http://rubygems.org/gems/vagrant-zfs-box
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: ZFS plugin for Vagrant 1.0
+test_files: []