vagrant-zfs 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.vagrant
+.bundle
+bin/
+pkg/
+tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+#before_script:
+#  - sudo apt-get -y install linux-headers-$(uname -r)
+#  - sudo apt-get install virtualbox
+script: "bundle exec rake test:unit"
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    vagrant-zfs (0.0.1)
+      zfs
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    childprocess (0.3.7)
+      ffi (~> 1.0, >= 1.0.6)
+    erubis (2.7.0)
+    ffi (1.3.1)
+    i18n (0.6.1)
+    json (1.5.4)
+    log4r (1.1.10)
+    minitest (3.5.0)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-ssh (2.2.2)
+    rake (0.9.2.2)
+    vagrant (1.0.6)
+      archive-tar-minitar (= 0.5.2)
+      childprocess (~> 0.3.1)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6.0)
+      json (~> 1.5.1)
+      log4r (~> 1.1.9)
+      net-scp (~> 1.0.4)
+      net-ssh (~> 2.2.2)
+    zfs (0.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  rake
+  vagrant (= 1.0.6)
+  vagrant-zfs!

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 JD Harrington
+
+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,90 @@
+# Vagrant-ZFS
+
+Vagrant-ZFS is a plugin for [Vagrant][1] to automate cloning and sharing
+ZFS filesystems from the host machine to a guest VM. This is useful for
+things like bringing up multiple VMs to test database clustering without
+requiring you to manually copy large amounts of data into multiple
+locations on your host machine or syncing data from host to VMs.
+
+This project is still in the very early stages, so proceed with caution.
+
+## Using Vagrant-ZFS in your project
+
+1. Install the vagrant-zfs gem into Vagrant's isolated environment.
+
+    ```
+    $ vagrant gem install vagrant-zfs
+    ```
+
+2. Configure filesystems to be cloned and shared in your Vagrantfile.
+
+    ```ruby
+    Vagrant::Config.run do |config|
+      ...
+      
+      logical_name = "mysql"
+      guest_path   = "/data/mysql"
+      zfs_name     = "mysql/baseline" # Expects pool/filesystem_name
+ 
+      config.zfs.share_cloned_folder logical_name, guest_path, zfs_name
+
+      ...
+    end
+    ``` 
+
+## Trying out Vagrant-ZFS
+
+1. Make sure you have ZFS. On OS X, you can install [Zevo][2].
+2. You'll also need [VirtualBox][3] and [Vagrant][1] installed.
+3. Get the vagrant-zfs repository.
+
+    ```
+    $ git clone https://github.com/psi/vagrant-zfs
+    $ cd vagrant-zfs
+    $ bundle install
+    ```
+
+3. Create a sandbox zpool and filesystem.
+
+    ```
+    $ bundle exec rake sandbox:create
+    ```
+
+4. Bring up a test VM.
+
+    ```
+    $ bundle exec vagrant up
+    $ bundle exec vagrant ssh
+    
+    # Take a look in /data/vagrant-zfs-test on the VM and you'll
+    # see the on_zfs.txt file that we touched earlier.
+    #
+    # Now, exit the VM...
+    
+    $ zfs list | grep vagrant_zfs_test/test
+    vagrant_zfs_test/test                                       33.5Ki 27.2Mi  33.5Ki  /Volumes/vagrant_zfs_test/test
+    vagrant_zfs_test/test-94813591-df75-4cc9-8067-faaaff291bd7     1Ki 27.2Mi  33.5Ki  /Volumes/vagrant_zfs_test/test-94813591-df75-4cc9-8067-faaaff291bd7
+    
+    # Notice the original filesystem you created and the cloned filesystem
+    # that is now attached to the VM. The UUID of the Vagrant instance is
+    # appended to the clone name so you can bring up multiple VMs, each with
+    # their own clone of the original filesystem.
+    ```
+    
+5. Destroy your VM and cleanup
+
+    ```
+    $ bundle exec vagrant destroy
+    
+    $ zfs list | grep vagrant_zfs_test/test
+    vagrant_zfs_test/test    33.5Ki  27.1Mi  33.5Ki /Volumes/vagrant_zfs_test/test
+    
+    # Destroying the VM also destroys the cloned filesystem and the snapshot
+    # that was used to make it so you won't end up with tons of crufty clones.
+
+    $ bundle exec rake sandbox:destroy
+    ```
+
+[1]: http://www.vagrantup.com/
+[2]: http://getgreenbytes.com/solutions/zevo/
+[3]: https://www.virtualbox.org/

data/Rakefile

@@ -0,0 +1,69 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "zfs"
+
+task :default => "test:unit"
+
+Rake::TestTask.new do |t|
+  t.name = "test:all"
+  t.pattern = "test/**/*_test.rb"
+end
+
+Rake::TestTask.new do |t|
+  t.name = "test:unit"
+  t.pattern = "test/unit/**/*_test.rb"
+end
+
+Rake::TestTask.new do |t|
+  t.name = "test:integration"
+  t.pattern = "test/integration/**/*_test.rb"
+end
+
+task "test:integration_setup"    => %w(sandbox:create vagrant:up)
+task "test:integration_teardown" => %w(vagrant:destroy sandbox:destroy)
+
+namespace :vagrant do
+  desc "Bring test Vagrant VM up"
+  task :up do
+    system "bundle exec vagrant up"
+  end
+
+  desc "Destroy test Vagrant VM"
+  task :destroy do
+    system "bundle exec vagrant destroy -f"
+  end
+end
+
+def test_vdev_path
+  File.expand_path("../tmp/test_vdev", __FILE__)
+end
+
+namespace :sandbox do
+  desc "Create a ZFS filesystem for testing"
+  task :create do
+    # Create a zpool
+    sh "mkfile 64m #{test_vdev_path}"
+    sh "zpool create vagrant_zfs_test #{test_vdev_path}"
+   
+    # Create a filesystem
+    fs = ZFS("vagrant_zfs_test/test")
+    fs.create
+
+    # Populate the filesystem
+    sh "touch #{fs.mountpoint}/on_zfs.txt"
+  end
+
+  desc "Destroy ZFS filesystem created for testing"
+  task :destroy do
+    # Destroy the filesystem
+    fs = ZFS("vagrant_zfs_test/test")
+    fs.destroy!
+
+    # Destroy the zpool
+
+    # With Zevo on OS X 10.8.x, `zpool create` works as a normal user, but
+    # `zpool destroy` appears to require root privileges, so we sudo here.
+    sh "sudo zpool destroy -f vagrant_zfs_test"
+    sh "rm #{test_vdev_path}"
+  end
+end

data/Vagrantfile

@@ -0,0 +1,6 @@
+Vagrant::Config.run do |config|
+  config.vm.box     = "opscode_centos_6.3"
+  config.vm.box_url = "https://opscode-vm.s3.amazonaws.com/vagrant/opscode_centos-6.3_chef-10.18.2.box"
+
+  config.zfs.share_cloned_folder "vagrant-zfs-test", "/data/vagrant-zfs-test", "vagrant_zfs_test/test"
+end

data/lib/vagrant_init.rb

@@ -0,0 +1 @@
+require "vagrant_zfs"

data/lib/vagrant_zfs.rb

@@ -0,0 +1,5 @@
+require "zfs"
+
+require "vagrant_zfs/version"
+require "vagrant_zfs/config"
+require "vagrant_zfs/middleware"

data/lib/vagrant_zfs/config.rb

@@ -0,0 +1,19 @@
+module VagrantZFS
+  class Config < Vagrant::Config::Base
+    attr_accessor :cloned_folders
+
+    def cloned_folders
+      @cloned_folders ||= {}
+    end
+
+    def share_cloned_folder(name, guestpath, filesystem, options = {})
+      self.cloned_folders[name] = {
+        :guestpath  => guestpath,
+        :filesystem => filesystem,
+        :options    => options
+      }
+    end
+  end
+end
+
+Vagrant.config_keys.register(:zfs) { VagrantZFS::Config }

data/lib/vagrant_zfs/middleware.rb

@@ -0,0 +1,3 @@
+Dir[File.dirname(__FILE__) + '/middleware/**/*.rb'].each do |file|
+  require file
+end

data/lib/vagrant_zfs/middleware/clone_zfs.rb

@@ -0,0 +1,27 @@
+module VagrantZFS
+  module Middleware
+    class CloneZFS
+      def initialize(app, env)
+        @app = app
+      end
+
+      def call(env)
+        uuid = env[:vm].uuid
+
+        env[:vm].config.zfs.cloned_folders.each do |name, data|
+          source_fs = ZFS(data[:filesystem])
+
+          snapshot = source_fs.snapshot(uuid)
+          new_fs = snapshot.clone!("#{data[:filesystem]}-#{uuid}")
+
+          env[:vm].config.vm.share_folder name, data[:guestpath], new_fs.mountpoint, data[:options]
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end
+
+Vagrant.actions[:start].insert_before Vagrant::Action::VM::ShareFolders,
+                                      VagrantZFS::Middleware::CloneZFS

data/lib/vagrant_zfs/middleware/destroy_zfs.rb

@@ -0,0 +1,27 @@
+module VagrantZFS
+  module Middleware
+    class DestroyZFS
+      def initialize(app, env)
+        @app = app
+        @env = env
+      end
+
+      def call(env)
+        uuid = @env[:vm].uuid
+
+        env[:vm].config.zfs.cloned_folders.each do |name, data|
+          new_fs = ZFS("#{data[:filesystem]}-#{uuid}")
+          snapshot = new_fs.origin
+
+          new_fs.destroy!
+          snapshot.destroy!
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end
+
+Vagrant.actions[:destroy].insert_before Vagrant::Action::VM::Destroy,
+                                        VagrantZFS::Middleware::DestroyZFS

data/lib/vagrant_zfs/version.rb

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

data/test/integration/integration_test.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + "/../test_helper"
+
+describe "When bringing up a VM" do
+  before do
+    unless $vm_booted
+      system "bundle exec rake test:integration_setup"
+      $vm_booted = true
+    end
+  end
+
+  MiniTest::Unit.after_tests do
+    system "bundle exec rake test:integration_teardown"
+  end
+
+  it "attaches a clone to the VM" do
+    assert system("bundle exec vagrant ssh --command 'ls /data/vagrant-zfs-test/on_zfs.txt' >/dev/null")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "minitest/autorun"
+require "vagrant"
+
+include Vagrant::TestHelpers

data/test/unit/middleware/clone_zfs_test.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + "/../../test_helper"
+require "vagrant_zfs/middleware/clone_zfs"
+
+describe VagrantZFS::Middleware::CloneZFS do
+  it "should rule" do
+    assert true
+  end
+end

data/vagrant-zfs.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant_zfs/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "vagrant-zfs"
+  gem.version       = VagrantZFS::VERSION
+  gem.authors       = ["JD Harrington"]
+  gem.email         = ["jd@jdharrington.net"]
+
+  gem.description   = <<-EOF
+    Vagrant-ZFS is a plugin for Vagrant to automate cloning and sharing
+    ZFS filesystems from the host machine to a guest VM. This is useful
+    for things like bringing up multiple VMs to test database clustering
+    without requiring you to manually copy large amounts of data into
+    multiple locations on your host or syncing data from host to VMs.
+
+    This project is still in the very early stages, so proceed with caution.
+  EOF
+
+  gem.summary       = "A Vagrant plugin to automate cloning and sharing ZFS filesystems with VMs"
+  gem.homepage      = "http://github.com/psi/vagrant-zfs"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "zfs"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "vagrant", "1.0.6"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-zfs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- JD Harrington
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zfs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: vagrant
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+description: ! "    Vagrant-ZFS is a plugin for Vagrant to automate cloning and sharing\n
+  \   ZFS filesystems from the host machine to a guest VM. This is useful\n    for
+  things like bringing up multiple VMs to test database clustering\n    without requiring
+  you to manually copy large amounts of data into\n    multiple locations on your
+  host or syncing data from host to VMs.\n\n    This project is still in the very
+  early stages, so proceed with caution.\n"
+email:
+- jd@jdharrington.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- Vagrantfile
+- lib/vagrant_init.rb
+- lib/vagrant_zfs.rb
+- lib/vagrant_zfs/config.rb
+- lib/vagrant_zfs/middleware.rb
+- lib/vagrant_zfs/middleware/clone_zfs.rb
+- lib/vagrant_zfs/middleware/destroy_zfs.rb
+- lib/vagrant_zfs/version.rb
+- test/integration/integration_test.rb
+- test/test_helper.rb
+- test/unit/middleware/clone_zfs_test.rb
+- tmp/.gitkeep
+- vagrant-zfs.gemspec
+homepage: http://github.com/psi/vagrant-zfs
+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'
+      segments:
+      - 0
+      hash: 1065014889121101321
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1065014889121101321
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Vagrant plugin to automate cloning and sharing ZFS filesystems with VMs
+test_files:
+- test/integration/integration_test.rb
+- test/test_helper.rb
+- test/unit/middleware/clone_zfs_test.rb