vagrant-zz-multiprovider-snap 0.0.1

data/README.md

@@ -0,0 +1,78 @@
+Vagrant Multi-Provder Snap
+==========================
+
+Description
+-----------
+
+This Vagrant plugin provides a consistent interface to taking snapshots of
+running Vagrant boxes.  It currently supports the following providers:
+
+ * VirtualBox
+ * VMWare Fusion (via the commercial VMWare plugin)
+
+
+Installation
+------------
+
+The easiest way to install this plugin is via the published gem.
+
+```
+vagrant plugin install vagrant-zz-multiprovider-snap
+```
+
+(The 'zz' in the gem name is a workaround for a bug in Vagrant plugin loading
+which prevents the mixins in this module from working correctly - we need to
+force this plugin to be loaded after the vmware plugin otherwise this fails)
+
+
+Usage
+-----
+
+Typical usage:
+
+  * Take a new snapshot
+    ```vagrant snap take [vm]```
+
+  * Roll back to the last snapshot
+    ```vagrant snap rollback [vm]```
+
+  * List snapshots
+    ```vagrant snap list [vm]```
+
+Limitations
+-----------
+
+It's currently not possible to do any of the following:
+
+ * Give a custom snapshot name
+ * Roll back to a specific named snapshot
+ * Disable snapshotting
+
+My own requirements don't include these features, but I could be tempted to
+add them if anyone would find them useful.
+
+
+Hacking
+-------
+
+Working on this module is a little tricky because of the obfuscation used by
+the commercial VMWare module.  The following approach should get you up and
+running - although it's a bundler environment, you'll also need a packaged
+Vagrant install in order to get access to the rgloader libraries.
+
+```
+git@github.com:scalefactory/vagrant-multiprovider-snap.git
+cd vagrant-multiprovider-snap
+cp ~/.vagrant.d/license-vagrant-vmware-fusion.lic .
+bundle install
+bundle install --deployment
+```
+
+You should now find that ```bundle exec vagrant status``` returns correctly,
+and you can hack on the code from there.
+
+Once you've made changes that you're happy with, I'd recommend using
+```rake build``` to create a gem, then installing that into your packaged
+Vagrant install since some things which work in the bundler environment might
+not work as expected in the packaged copy due to differences in how the plugins
+are handled.

data/lib/vagrant-multiprovider-snap/command/list.rb

@@ -0,0 +1,54 @@
+require 'optparse'
+require 'vagrant'
+
+module VagrantSnap
+
+    module Command
+
+        class List < Vagrant.plugin("2", :command)
+
+            def execute
+
+                options = {}
+
+                opts = OptionParser.new do |o|
+                    o.banner    = "Usage: vagrant snap list [vm-name]"
+                    o.separator ""
+                end
+
+                argv = parse_options(opts)
+                return if !argv
+
+                results = []
+
+                with_target_vms(argv) do |machine|
+
+                    results << "#{machine.name.to_s}"
+
+                    snaps = machine.provider.driver.snapshot_list
+
+                    if snaps.length == 0
+                        results << "  (none)"
+                    else
+                        snaps.each do |snap|
+                            results << "  + #{snap}"
+                        end
+                    end
+
+                    results << "\n"
+
+                end
+
+                @env.ui.info(I18n.t("vagrant_snap.commands.list.output",
+                                    :snapshots => results.join("\n")),
+                             :prefix => false)
+
+                0
+
+            end
+
+        end
+
+    end
+
+end

data/lib/vagrant-multiprovider-snap/command/rollback.rb

@@ -0,0 +1,36 @@
+require 'optparse'
+require 'vagrant'
+
+module VagrantSnap
+
+    module Command
+
+        class Rollback < Vagrant.plugin("2", :command)
+
+            def execute
+
+                options = {}
+
+                opts = OptionParser.new do |o|
+                    o.banner    = "Usage: vagrant snap rollback [vm-name]"
+                    o.separator ""
+                end
+
+                argv = parse_options(opts)
+                return if !argv
+
+                with_target_vms(argv) do |vm|
+
+                    vm.action(:snapshot_rollback)
+
+                end
+
+                0
+
+            end
+
+        end
+
+    end
+
+end

data/lib/vagrant-multiprovider-snap/command/root.rb

@@ -0,0 +1,73 @@
+require 'optparse'
+
+module VagrantSnap
+
+    module Command
+
+        class Root < Vagrant.plugin("2", :command)
+
+            def initialize(argv, env)
+
+                super
+
+                @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+
+                @subcommands = Vagrant::Registry.new
+
+                @subcommands.register(:take) do
+                    require_relative "take"
+                    Take
+                end
+
+                @subcommands.register(:rollback) do
+                    require_relative "rollback"
+                    Rollback
+                end
+
+                @subcommands.register(:list) do
+                    require_relative "list"
+                    List
+                end
+
+
+            end
+
+            def execute
+
+                if @main_args.include?("-h") || @main_args.include?("--help")
+                    return help
+                end
+
+                command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
+                return help if !command_class || !@sub_command
+
+                # Initialize and execute the command class
+                command_class.new(@sub_args, @env).execute
+
+            end
+
+            def help
+                opts = OptionParser.new do |opts|
+                    opts.banner = 'Usage: vagrant snap <command> [<args>]'
+                    opts.separator ""
+                    opts.separator "Available subcommands:"
+
+                    keys = []
+                    @subcommands.each { |key, value| keys << key.to_s }
+
+                    keys.sort.each do |key|
+                        opts.separator "     #{key}"
+                    end
+
+                    opts.separator ""
+                    opts.separator "For help on any individual command run 'vagrant snap COMMAND -h'"
+                end
+
+                @env.ui.info(opts.help, :prefix => false)
+            end
+
+        end
+
+    end
+
+end

data/lib/vagrant-multiprovider-snap/command/take.rb

@@ -0,0 +1,36 @@
+require 'optparse'
+require 'vagrant'
+
+module VagrantSnap
+
+    module Command
+
+        class Take < Vagrant.plugin("2", :command)
+
+            def execute
+
+                options = {}
+
+                opts = OptionParser.new do |o|
+                    o.banner    = "Usage: vagrant snap take [vm-name]"
+                    o.separator ""
+                end
+
+                argv = parse_options(opts)
+                return if !argv
+
+                with_target_vms(argv) do |vm|
+
+                    vm.action(:snapshot_take)
+
+                end
+
+                0
+
+            end
+
+        end
+
+    end
+
+end

data/lib/vagrant-multiprovider-snap/plugin.rb

@@ -0,0 +1,30 @@
+require 'vagrant'
+
+module VagrantSnap
+    class Plugin < Vagrant.plugin("2")
+
+        require_relative "command/root"
+        require_relative "providers/virtualbox/action"
+        require_relative "providers/virtualbox/driver/base"
+        require_relative "providers/vmware_fusion/action"
+        require_relative "providers/vmware_fusion/driver/base"
+
+        name "snap command"
+
+        description <<-DESC
+        This command provides snapshot features across multiple
+        Vagrant providers
+        DESC
+
+        command("snap") do
+            setup_i18n
+            Command::Root
+        end
+
+        def self.setup_i18n
+            I18n.load_path << File.expand_path("locales/en.yml", VagrantSnap.source_root)
+            I18n.reload!
+        end
+
+    end
+end

data/lib/vagrant-multiprovider-snap/providers/virtualbox/action/snapshot_rollback.rb

@@ -0,0 +1,33 @@
+module VagrantPlugins
+
+    module ProviderVirtualBox
+
+        module Action
+
+            class SnapshotRollback
+
+                def initialize(app, env)
+                    @app = app
+                end
+
+                def call(env)
+
+                    env[:ui].info I18n.t("vagrant_snap.actions.vm.snapshot_rollback.rolling_back")
+
+                    # Snapshot rollback involves powering off and on the VM
+                    #  so we need to find the gui state
+                    boot_mode = env[:machine].provider_config.gui ? "gui" : "headless"
+
+                    env[:machine].provider.driver.snapshot_rollback(boot_mode)
+
+                    @app.call(env)
+
+                end
+
+            end
+
+        end
+
+    end
+
+end

data/lib/vagrant-multiprovider-snap/providers/virtualbox/action/snapshot_take.rb

@@ -0,0 +1,28 @@
+module VagrantPlugins
+
+    module ProviderVirtualBox
+
+        module Action
+
+            class SnapshotTake
+
+                def initialize(app, env)
+                    @app = app
+                end
+
+                def call(env)
+
+                    env[:ui].info I18n.t("vagrant_snap.actions.vm.snapshot_take.taking")
+                    env[:machine].provider.driver.snapshot_take
+
+                    @app.call(env)
+
+                end
+
+            end
+
+        end
+
+    end
+
+end

data/lib/vagrant-multiprovider-snap/providers/virtualbox/action.rb

@@ -0,0 +1,46 @@
+require "vagrant/action/builder"
+
+module VagrantPlugins
+
+    module ProviderVirtualBox
+
+        module Action
+
+            autoload :SnapshotTake,     File.expand_path("../action/snapshot_take.rb", __FILE__)
+            autoload :SnapshotRollback, File.expand_path("../action/snapshot_rollback.rb", __FILE__)
+
+            def self.action_snapshot_take
+                Vagrant::Action::Builder.new.tap do |b|
+                    b.use CheckVirtualbox
+                    b.use Call, Created do |env, b2|
+                        if env[:result]
+                            b2.use CheckAccessible
+                            b2.use SnapshotTake
+                        else
+                            b2.use MessageNotCreated
+                        end
+                    end
+                end
+            end
+
+            def self.action_snapshot_rollback
+                Vagrant::Action::Builder.new.tap do |b|
+                    b.use CheckVirtualbox
+                    b.use Call, Created do |env, b2|
+                        if env[:result]
+                            b2.use CheckAccessible
+                            b2.use SnapshotRollback
+                        else
+                            b2.use MessageNotCreated
+                        end
+                    end
+                end
+            end
+
+       end
+
+    end
+
+end
+
+        

data/lib/vagrant-multiprovider-snap/providers/virtualbox/driver/base.rb

@@ -0,0 +1,38 @@
+module VagrantPlugins
+
+    module ProviderVirtualBox
+
+        module Driver
+
+            class Base
+
+                def snapshot_take
+                    execute("snapshot", @uuid, "take", "vagrant-snap-#{Time.now.to_i}", "--pause")
+                end
+
+                def snapshot_rollback(bootmode)
+                    halt
+                    sleep 2 # race condition on locked VMs otherwise?
+                    execute("snapshot",  @uuid, "restore", snapshot_list.first)
+                    start(bootmode)
+                end
+
+                def snapshot_list
+                    # XXX blows up if no snapshots on the VM - how to prevent this?
+                    info = execute("showvminfo", @uuid, "--machinereadable")
+                    snapshots = []
+                    info.split("\n").each do |line|
+                        if line =~ /^SnapshotName="(.+?)"$/
+                            snapshots << $1.to_s
+                        end
+                    end
+                    snapshots
+                end
+
+            end
+
+        end
+
+    end
+
+end

data/lib/vagrant-multiprovider-snap/providers/vmware_fusion/action/snapshot_rollback.rb

@@ -0,0 +1,33 @@
+module HashiCorp
+
+    module VagrantVMwarefusion
+
+        module Action
+
+            class SnapshotRollback
+
+                def initialize(app, env)
+                    @app = app
+                end
+
+                def call(env)
+
+                    env[:ui].info I18n.t("vagrant_snap.actions.vm.snapshot_rollback.rolling_back")
+
+                    # Snapshot rollback involves powering off and on the VM
+                    #  so we need to find the gui state
+                    boot_mode = env[:machine].provider_config.gui ? "gui" : "headless"
+
+                    env[:machine].provider.driver.snapshot_rollback(boot_mode)
+
+                    @app.call(env)
+
+                end
+
+            end
+
+        end
+
+    end
+
+end

data/lib/vagrant-multiprovider-snap/providers/vmware_fusion/action/snapshot_take.rb

@@ -0,0 +1,28 @@
+module HashiCorp
+
+    module VagrantVMwarefusion
+
+        module Action
+
+            class SnapshotTake
+
+                def initialize(app, env)
+                    @app = app
+                end
+
+                def call(env)
+
+                    env[:ui].info I18n.t("vagrant_snap.actions.vm.snapshot_take.taking")
+                    env[:machine].provider.driver.snapshot_take
+
+                    @app.call(env)
+
+                end
+
+            end
+
+        end
+
+    end
+
+end

data/lib/vagrant-multiprovider-snap/providers/vmware_fusion/action.rb

@@ -0,0 +1,44 @@
+require "vagrant/action/builder"
+
+module HashiCorp
+
+    module VagrantVMwarefusion
+
+        module Action
+
+            autoload :SnapshotTake,     File.expand_path("../action/snapshot_take.rb", __FILE__)
+            autoload :SnapshotRollback, File.expand_path("../action/snapshot_rollback.rb", __FILE__)
+
+            def self.action_snapshot_take
+                Vagrant::Action::Builder.new.tap do |b|
+                    b.use CheckVMware
+                    b.use Call, Created do |env, b2|
+                        if env[:result]
+                            b2.use SnapshotTake
+                        else
+                            b2.use MessageNotCreated
+                        end
+                    end
+                end
+            end
+
+            def self.action_snapshot_rollback
+                Vagrant::Action::Builder.new.tap do |b|
+                    b.use CheckVMware
+                    b.use Call, Created do |env, b2|
+                        if env[:result]
+                            b2.use SnapshotRollback
+                        else
+                            b2.use MessageNotCreated
+                        end
+                    end
+                end
+            end
+
+       end
+
+    end
+
+end
+
+        

data/lib/vagrant-multiprovider-snap/providers/vmware_fusion/driver/base.rb

@@ -0,0 +1,34 @@
+module HashiCorp
+
+    module VagrantVMwarefusion
+
+        module Driver
+
+            class Fusion
+
+                def snapshot_take
+                    vmrun("snapshot", "#{vmx_path}", "vagrant-snap-#{Time.now.to_i}")
+                end
+
+                def snapshot_rollback(bootmode)
+                   vmrun("revertToSnapshot", "#{vmx_path}", snapshot_list.first)
+                   start
+                end
+
+                def snapshot_list
+                    snapshots = []
+                    vmrun("listSnapshots", "#{vmx_path}").stdout.split("\n").each do |line|
+                        if line =~ /^vagrant-snap-/
+                            snapshots << line
+                        end
+                    end
+                    snapshots.sort
+                end
+
+            end
+
+        end
+
+    end
+
+end

data/lib/vagrant-multiprovider-snap/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module Snap
+    VERSION = "0.0.1"
+  end
+end

data/lib/vagrant-multiprovider-snap.rb

@@ -0,0 +1,8 @@
+require "vagrant-multiprovider-snap/version"
+require "vagrant-multiprovider-snap/plugin"
+
+module VagrantSnap
+   def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+   end
+end

data/lib/vagrant-zz-multiprovider-snap.rb

@@ -0,0 +1,8 @@
+require "vagrant-multiprovider-snap/version"
+require "vagrant-multiprovider-snap/plugin"
+
+module VagrantSnap
+   def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+   end
+end

data/locales/en.yml

@@ -0,0 +1,19 @@
+en:
+  vagrant_snap:
+    commands:
+      list:
+        output: |-
+          Current available snapshots by VM:
+
+          %{snapshots}
+
+    actions:
+      vm:
+        snapshot_take:
+          taking: |-
+            Taking snapshot.
+        snapshot_rollback:
+          rolling_back: |-
+            Rolling back to previous snapshot
+
+      

data/vagrant-multiprovider-snap.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "vagrant-multiprovider-snap/version"
+
+Gem::Specification.new do |s|
+  s.name        = "vagrant-zz-multiprovider-snap"
+  s.version     = Vagrant::Snap::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jon Topper"]
+  s.email       = ["jon@scalefactory.com"]
+  s.homepage    = "http://github.com/scalefactory/vagrant-multiprovider-snap"
+
+  s.summary     = %q{Multi-provider snapshots for Vagrant}
+  s.description = %q{Multi-provider snapshots for Vagrant}
+
+  s.rubyforge_project = "vagrant-multiprovider-snap"
+
+  files = `git ls-files`.split("\n")
+  ignore = %w{rgloader/* Gemfile Rakefile Vagrantfile .gitignore}
+
+  files.delete_if do |f|
+      ignore.any? do |i|
+          File.fnmatch(i, f, File::FNM_PATHNAME) ||
+          File.fnmatch(i, File.basename(f), File::FNM_PATHNAME)
+      end
+  end
+
+  s.files         = files
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-zz-multiprovider-snap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jon Topper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-12 00:00:00.000000000 Z
+dependencies: []
+description: Multi-provider snapshots for Vagrant
+email:
+- jon@scalefactory.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/vagrant-multiprovider-snap.rb
+- lib/vagrant-multiprovider-snap/command/list.rb
+- lib/vagrant-multiprovider-snap/command/rollback.rb
+- lib/vagrant-multiprovider-snap/command/root.rb
+- lib/vagrant-multiprovider-snap/command/take.rb
+- lib/vagrant-multiprovider-snap/plugin.rb
+- lib/vagrant-multiprovider-snap/providers/virtualbox/action.rb
+- lib/vagrant-multiprovider-snap/providers/virtualbox/action/snapshot_rollback.rb
+- lib/vagrant-multiprovider-snap/providers/virtualbox/action/snapshot_take.rb
+- lib/vagrant-multiprovider-snap/providers/virtualbox/driver/base.rb
+- lib/vagrant-multiprovider-snap/providers/vmware_fusion/action.rb
+- lib/vagrant-multiprovider-snap/providers/vmware_fusion/action/snapshot_rollback.rb
+- lib/vagrant-multiprovider-snap/providers/vmware_fusion/action/snapshot_take.rb
+- lib/vagrant-multiprovider-snap/providers/vmware_fusion/driver/base.rb
+- lib/vagrant-multiprovider-snap/version.rb
+- lib/vagrant-zz-multiprovider-snap.rb
+- locales/en.yml
+- vagrant-multiprovider-snap.gemspec
+homepage: http://github.com/scalefactory/vagrant-multiprovider-snap
+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: vagrant-multiprovider-snap
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Multi-provider snapshots for Vagrant
+test_files: []