vagrant-vbox-snapshot 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWYyMDIzMDlmMTUwZDlhZGJlOTEwMmU2NTU3YzgzMTFmNmExMDc1OA==
+  data.tar.gz: !binary |-
+    NzQ3NDZhOTg5NjBhODk0Mzk0YTFiZTIxZTU3YzAwNzljOWYwOWQxMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZTFkOGQxY2E0YzU0MWM4YTZiMTQ5OTVhNThjMWI5NzM2ZjgyNzMwYTYzN2Ri
+    YjA4MTIyN2IxNWI1ZWU4MzI1M2UxNWRiZDE2ODk5MWYwMDFmOWU5YTlmODIy
+    MTAxN2I3OGMxMDNiYjUzNWFiYzUzMTBlMmQzOTllMmRmYzVmYTU=
+  data.tar.gz: !binary |-
+    YWU2MjhkMTM4MWNkZmNlYTNhMmUwODU1MjAyMjA1YzM0YzhkZDVlZTRkM2Qy
+    YmJkNDhmMzQ3M2ZiOGVlNmVhYjljODVmODVjN2NkMzFkNzRhZGY5ODRmYjM3
+    ZWJhNGE5NzI5NDA0NTZlZmM1YjY5YjdmNGIwYzM3NjM3OTU4Mzg=

data/.gitignore

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

data/DEVNOTES.md

@@ -0,0 +1,27 @@
+## Updating to vagrant 1.1 plugin API
+
+Resources:
+
+* http://docs.vagrantup.com/v2/plugins/development-basics.html
+
+Example code:
+
+* https://gist.github.com/dergachev/5367385#vagrant-snapshot.rb
+* https://github.com/mitchellh/vagrant/issues/143#add-vagrant-snapshot-option
+* https://github.com/fgrehm/vagrant-notify
+* https://github.com/RiotGames/berkshelf-vagrant
+* https://github.com/mitchellh/vagrant-aws/blob/master/lib/vagrant-aws/plugin.rb
+* sahara 1.1 update commit: https://github.com/ryuzee/sahara/commit/b80a621a9200bb4935c782bd4e538886c42b8643
+* vagrant-snap: https://github.com/t9md/vagrant-snap/blob/master/lib/vagrant_snap.rb
+* https://github.com/dotless-de/vagrant-plugins-env/blob/master/.gitmodules
+
+Vagrant source code:
+
+* https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/registry.rb
+* https://github.com/mitchellh/vagrant/tree/master/plugins/provisioners/shell
+* https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/plugin/v2/provisioner.rb
+* https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/plugin/v2/command.rb
+
+## other ideas related to snapshots
+
+* http://code.chrisroberts.org/blog/2012/05/09/cooking-up-partial-run-lists-with-chef/

data/Gemfile

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

data/README.md

@@ -0,0 +1,37 @@
+vagrant-vbox-snapshot
+==================================
+Vagrant plugin that exposes the `VBoxManage snapshot` command.
+
+## Install
+
+Ensure you have Vagrant 1.1+ installed, then run:
+
+    vagrant plugin install vagrant-vbox-snapshot
+
+## Usage
+
+The following commands are added by this plugin:
+
+     vagrant snap back                   # back to current snapshot
+     vagrant snap delete SNAP_NAME       # delete snapshot
+     vagrant snap go SNAP_NAME           # go to specified snapshot
+     vagrant snap help [COMMAND]         # Describe subcommands or one specific subcommand
+     vagrant snap list                   # list snapshot
+     vagrant snap take [NAME]            # take snapshot
+
+## Other solutions
+
+There have been a number of similar plugins, but none worked for Vagrant 1.1:
+
+* [vagrant-snap](https://github.com/t9md/vagrant-snap)
+  - originally published as a gist: https://gist.github.com/t9md/1008031
+  - fork of above gist, with Vagrant 1.0.6 compatibility: https://gist.github.com/tombh/5142237 
+    - [source](https://github.com/mitchellh/vagrant/issues/143#issuecomment-14781762)
+    - primary inspiration for vagrant-vbox-snapshot
+* [sahara](https://github.com/jedi4ever/sahara)
+  - fork exists with 1.1 functionality: https://github.com/ryuzee/sahara
+
+## Development
+
+See [DEVNOTES.md](https://github.com/dergachev/vagrant-vbox-snapshot/blob/master/DEVNOTES.md)
+for the notes I compiled while developing this plugin.

data/lib/vagrant-vbox-snapshot/commands/back.rb

@@ -0,0 +1,28 @@
+module VagrantPlugins
+  module VBoxSnapshot
+    module Command
+      class Back < Vagrant.plugin(2, :command)
+        def execute
+          options = {}
+
+          opts = OptionParser.new do |opts|
+            opts.banner = "Back to current snapshot"
+            opts.separator ""
+            opts.separator "Usage: vagrant snapshot back"
+          end
+          # Parse the options
+          argv = parse_options(opts)
+          return if !argv
+
+          with_target_vms do |machine|
+            vm_id = machine.id
+            system "VBoxManage snapshot #{vm_id} list --details"
+            system "VBoxManage controlvm #{vm_id} poweroff"
+            system "VBoxManage snapshot  #{vm_id} restorecurrent"
+            system "VBoxManage startvm   #{vm_id} --type headless"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vbox-snapshot/commands/delete.rb

@@ -0,0 +1,31 @@
+module VagrantPlugins
+  module VBoxSnapshot
+    module Command
+      class Delete < Vagrant.plugin(2, :command)
+        def execute
+          options = {}
+
+          opts = OptionParser.new do |opts|
+            opts.banner = "Delete snapshot"
+            opts.separator ""
+            opts.separator "Usage: vagrant snapshot delete <SNAPSHOT_NAME>"
+          end
+          # Parse the options
+          argv = parse_options(opts)
+          return if !argv
+
+          if !argv[0]
+            @env.ui.info(opts.help, :prefix => false)
+            return
+          end
+
+          with_target_vms do |machine|
+            vm_id = machine.id
+            snapshot_name = argv[0]
+            system "VBoxManage snapshot #{vm_id} delete #{snapshot_name}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vbox-snapshot/commands/go.rb

@@ -0,0 +1,33 @@
+module VagrantPlugins
+  module VBoxSnapshot
+    module Command
+      class Go < Vagrant.plugin(2, :command)
+        def execute
+          options = {}
+
+          opts = OptionParser.new do |opts|
+            opts.banner = "Go to specified snapshot"
+            opts.separator ""
+            opts.separator "Usage: vagrant snapshot go <SNAPSHOT_NAME>"
+          end
+          # Parse the options
+          argv = parse_options(opts)
+          return if !argv
+
+          if !argv[0]
+            @env.ui.info(opts.help, :prefix => false)
+            return
+          end
+
+          with_target_vms do |machine|
+            vm_id = machine.id
+            snapshot_name = argv[0]
+            system "VBoxManage controlvm #{vm_id} poweroff"
+            system "VBoxManage snapshot  #{vm_id} restore #{snapshot_name}"
+            system "VBoxManage startvm   #{vm_id} --type headless"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vbox-snapshot/commands/list.rb

@@ -0,0 +1,25 @@
+module VagrantPlugins
+  module VBoxSnapshot
+    module Command
+      class List < Vagrant.plugin(2, :command)
+        def execute
+          options = {}
+
+          opts = OptionParser.new do |opts|
+            opts.banner = "List snapshots"
+            opts.separator ""
+            opts.separator "Usage: vagrant snapshot list"
+          end
+          # Parse the options
+          argv = parse_options(opts)
+          return if !argv
+
+          with_target_vms do |machine|
+            vm_id = machine.id
+            system "VBoxManage snapshot #{vm_id} list --details"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vbox-snapshot/commands/root.rb

@@ -0,0 +1,75 @@
+module VagrantPlugins
+  module VBoxSnapshot
+    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(:list) do
+            require_relative('list')
+            List
+          end
+          @subcommands.register(:go) do
+            require_relative('go')
+            Go
+          end
+          @subcommands.register(:back) do
+            require_relative('back')
+            Back
+          end
+          @subcommands.register(:delete) do
+            require_relative('delete')
+            Delete
+          end
+        end
+        
+        def execute
+          if @main_args.include?("-h") || @main_args.include?("--help")
+            # Print the help for all the box commands.
+            return help
+          end
+
+          # If we reached this far then we must have a subcommand. If not,
+          # then we also just print the help and exit.
+          command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
+          return help if !command_class || !@sub_command
+          @logger.debug("Invoking command class: #{command_class} #{@sub_args.inspect}")
+
+          # Initialize and execute the command class
+          command_class.new(@sub_args, @env).execute
+        end
+
+        # Prints the help out for this command
+        def help
+          opts = OptionParser.new do |opts|
+            opts.banner = "Usage: vagrant snapshot <command> [<args>]"
+            opts.separator ""
+            opts.separator "Available subcommands:"
+
+            # Add the available subcommands as separators in order to print them
+            # out as well.
+            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 snapshot <command> -h`"
+          end
+
+          @env.ui.info(opts.help, :prefix => false)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-vbox-snapshot/commands/take.rb

@@ -0,0 +1,31 @@
+module VagrantPlugins
+  module VBoxSnapshot
+    module Command
+      class Take < Vagrant.plugin(2, :command)
+        def execute
+          options = {}
+
+          opts = OptionParser.new do |opts|
+            opts.banner = "Take snapshot"
+            opts.separator ""
+            opts.separator "Usage: vagrant snapshot take <SNAPSHOT_NAME>"
+          end
+          # Parse the options
+          argv = parse_options(opts)
+          return if !argv
+
+          if !argv[0]
+            @env.ui.info(opts.help, :prefix => false)
+            return
+          end
+
+          with_target_vms do |machine|
+            vm_id = machine.id
+            snapshot_name = argv[0]
+            system "VBoxManage snapshot #{vm_id} take #{snapshot_name} --pause"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vbox-snapshot/plugin.rb

@@ -0,0 +1,20 @@
+begin
+    require "vagrant"
+rescue LoadError
+    raise "The Vagrant VBox Snapshot plugin must be run within Vagrant."
+end
+
+module VagrantPlugins
+  module VBoxSnapshot
+    class Plugin < Vagrant.plugin("2")
+      name "Vagrant VBox Snapshot"
+      description "Wrapper on the `VBoxManage snapshot` command."
+
+      command "snapshot" do
+        require_relative 'commands/root.rb'
+        Command::Root
+      end
+
+    end
+  end
+end

data/lib/vagrant-vbox-snapshot/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module VBoxSnapshot
+    VERSION = "0.0.1"
+  end
+end

data/lib/vagrant-vbox-snapshot.rb

@@ -0,0 +1,2 @@
+require_relative 'vagrant-vbox-snapshot/version.rb'
+require_relative 'vagrant-vbox-snapshot/plugin.rb'

data/vagrant-vbox-snapshot.gemspec

@@ -0,0 +1,21 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'vagrant-vbox-snapshot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-vbox-snapshot"
+  spec.version       = VagrantPlugins::VBoxSnapshot::VERSION
+  spec.authors       = "Alex Dergachev"
+  spec.email         = "alex@evolvingweb.ca"
+  spec.summary       = 'Vagrant plugin that exposes the `VBoxManage snapshot` command.'
+  spec.description   = 'Vagrant plugin that exposes the `VBoxManage snapshot` command.'
+  spec.homepage      = 'https://github.com/dergachev/vagrant-vbox-snapshot'
+  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_path  = 'lib'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-vbox-snapshot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Dergachev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Vagrant plugin that exposes the `VBoxManage snapshot` command.
+email: alex@evolvingweb.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- DEVNOTES.md
+- Gemfile
+- README.md
+- lib/vagrant-vbox-snapshot.rb
+- lib/vagrant-vbox-snapshot/commands/back.rb
+- lib/vagrant-vbox-snapshot/commands/delete.rb
+- lib/vagrant-vbox-snapshot/commands/go.rb
+- lib/vagrant-vbox-snapshot/commands/list.rb
+- lib/vagrant-vbox-snapshot/commands/root.rb
+- lib/vagrant-vbox-snapshot/commands/take.rb
+- lib/vagrant-vbox-snapshot/plugin.rb
+- lib/vagrant-vbox-snapshot/version.rb
+- vagrant-vbox-snapshot.gemspec
+homepage: https://github.com/dergachev/vagrant-vbox-snapshot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Vagrant plugin that exposes the `VBoxManage snapshot` command.
+test_files: []