vagrant-vbox-snapshot 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59803a44c1dfd4762ad171ac328e8281b5b0798c
-  data.tar.gz: 8ff585dcf406ac9c1932310283c695dabc0a5a68
+  metadata.gz: 33e9abe0b4d5521bffb2509f88c1aad9a2d6152f
+  data.tar.gz: 9a3ffca4dec1a13a32bcd420e5c26e4d55755cd5
 SHA512:
-  metadata.gz: 2ff4aea7a11ac98f5f934c259e66723b3041fe3a57dd131873e6edda4f3a6da9c36f47d08458c391be3dd5bd914d36ebca5b3a47114644ea446e156cc37a3669
-  data.tar.gz: 35c4d93a36cb0c04e3074ce272ddfde3ec260105d15893cde898b372f5af0f979c5eb7117cf3703d7b0f92291c99ab8a76edaeaa08d201120b8c95424837842e
+  metadata.gz: 73151d2048746312481aff7ad37b2c4fb8f525e2ac8ce88a80984be697e569a9e0c1d9fec58ca11be31df150fac5fafb23d5a1fbac38193e94768a995bb09e9e
+  data.tar.gz: 91bc767c5c6813f4d2daf0169f6b7d2399f4e14e4f86cad5d236347d7306e9806fcb6b99b60f443e90e3cc095c83aae9a31daa0d8954fbba83eada4add3575cb

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.0.4](https://github.com/dergachev/vagrant-vbox-snapshot/compare/v0.0.3...v0.0.4) (Sep 23, 2013)
+
+BACKWARDS INCOMPATIBILITIES:
+
+  - none
+
+FEATURES:
+
+  - Add Windows compatibility [#12](https://github.com/dergachev/vagrant-vbox-snapshot/issues/12)
+
+IMPROVEMENTS:
+
+  - Clean up `vagrant snapshot go` output when target is already in poweroff state. [#14](https://github.com/dergachev/vagrant-vbox-snapshot/pull/14)
+
 ## [0.0.3](https://github.com/dergachev/vagrant-vbox-snapshot/compare/v0.0.2...v0.0.3) (Sep 3, 2013)
 
 BACKWARDS INCOMPATIBILITIES:

data/DEVNOTES.md

@@ -1,31 +1,24 @@
-## Updating to vagrant 1.1 plugin API
-
-Resources:
+# Developer notes for vagrant-vbox-snapshot
 
-* http://docs.vagrantup.com/v2/plugins/development-basics.html
-* http://railscasts.com/episodes/245-new-gem-with-bundler?view=asciicast (Gem tutorial)
+## Forking and hacking on vagrant-vbox-snapshot
 
-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:
+```
+# fork vagrant-vbox-snapshot on github.com, and clone locally
+cd ~/code # or wherever you like to put coding projects
+git clone git@github.com/USERNAME/vagrant-vbox-snapshot.git
+cd vagrant-vbox-snapshot
 
-* 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
+# create a new branch for your work
+git checkout -b FEATURE_NAME
 
-## other ideas related to snapshots
+bundle install # not 100% sure this is necessary
+# hack away...
+# then test, possibly modifying Vagrantfile to suit scenario
+vagrant up 
+vagrant snapshot take TEST1  # and so on...
 
-* http://code.chrisroberts.org/blog/2012/05/09/cooking-up-partial-run-lists-with-chef/
+# then commit, push, and create pull request
+```
 
 ## Reviewing a pull request
 
@@ -41,28 +34,71 @@ git push -u origin master
 
 ## Pushing out a new release of the gem
 
+Do a local build:
+
 ```
-# make commits
-# consider creating/updating CHANGELOG.txt
 vim lib/vagrant-vbox-snapshot/version.rb +/VERSION # increment version counter, eg to 0.0.3
-gem build vagrant-vbox-snapshot.gemspec # creates vagrant-vbox-snapshot-0.0.3.gem
+gem build vagrant-vbox-snapshot.gemspec # creates vagrant-vbox-snapshot-0.0.3.gem  
+```
 
+Test the local build:
+
+```
 # test the gem locally, in a random vagrant project
 cd ~/code/screengif
 vagrant plugin uninstall vagrant-vbox-snapshot
-vagrant plugin install ~/code/vagrant-vbox-snapshot/vagrant-vbox-snapshot-0.0.3.gem
-# test it out, ensure basic sanity, eg for 0.0.3:
-vagrant snapshot list -h
-# cleanup
-vagrant plugin uninstall
+vagrant plugin install ~/code/vagrant-vbox-snapshot/vagrant-vbox-snapshot-VERSION.gem # replace VERSION with 0.0.3
+vagrant plugin list | grep snapshot   # ensure that correct version is installed
+vagrant snapshot list -h   # quick sanity check
+vagrant plugin uninstall    # cleanup
+```
+
+Now commit and tag:
+
+
+```
+cd ~/code/vagrant-vbox-snapshot
+
+vim CHANGELOG.txt        # update CHANGELOG
+# git commit everything
 
-cd ~/code/vagrant-vbox-snapshot/
 gem push vagrant-vbox-snapshot-0.0.3.gem
-git tag 0.0.3
+git tag vN.N.N     # eg v0.0.3
 git push --tags
+```
 
 # test installing from rubygems
 cd ~/code/screengif
 vagrant plugin install vagrant-vbox-snapshot
 vagrant plugin list
 ```
+
+
+## Updating to vagrant 1.1 plugin API
+
+Resources:
+
+* http://docs.vagrantup.com/v2/plugins/development-basics.html
+* http://railscasts.com/episodes/245-new-gem-with-bundler?view=asciicast (Gem tutorial)
+
+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/README.md

@@ -21,7 +21,6 @@ The following commands are added by this plugin:
 ## Caveats
 
 * Not compatible with Vagrant <1.1. If you need this, try [another solution](#other-solutions).
-* Only minimally tested.
 
 ## Other solutions
 

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

@@ -15,11 +15,22 @@ module VagrantPlugins
           return if !argv
 
           with_target_vms(argv, single_target: true) 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"
+
+            if machine.state.id != :poweroff
+              machine.provider.driver.execute("controlvm", machine.id, "poweroff")
+            end
+
+            machine.provider.driver.execute("snapshot", machine.id, "restorecurrent") do |type, data|
+              machine.env.ui.info(data, :color => type == :stderr ? :red : :white, :new_line => false)
+            end
+
+            if options[:reload]
+              @env.ui.info("Reloading VM, since --reload passed")
+              machine.action(:reload, :provision_enabled => false)
+            else
+              @env.ui.info("Starting restored VM")
+              machine.action(:up, :provision_enabled => false)
+            end
           end
         end
       end

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

@@ -1,3 +1,6 @@
+# this command is very slow
+# consider removing it; or replacing with this idea: http://superuser.com/questions/590968/quickest-way-to-merge-snapshots-in-virtualbox
+
 require_relative 'multi_vm_args'
 
 module VagrantPlugins
@@ -10,7 +13,7 @@ module VagrantPlugins
           options = {}
 
           opts = OptionParser.new do |opts|
-            opts.banner = "Delete snapshot"
+            opts.banner = "Delete snapshot (warning: this is a very slow operation)"
             opts.separator ""
             opts.separator "Usage: vagrant snapshot delete [vm-name] <SNAPSHOT_NAME>"
           end
@@ -22,8 +25,9 @@ module VagrantPlugins
           return if !snapshot_name
 
           with_target_vms(vm_name, single_target: true) do |machine|
-            vm_id = machine.id
-            system "VBoxManage snapshot #{vm_id} delete #{snapshot_name}"
+            machine.provider.driver.execute("snapshot", machine.id, "delete", snapshot_name) do |type, data|
+              machine.env.ui.info(data, :color => type == :stderr ? :red : :white)
+            end
           end
         end
       end

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

@@ -6,9 +6,9 @@ module VagrantPlugins
       class Go < Vagrant.plugin(2, :command)
         include MultiVmArgs
 
-        def get_shared_folders(vm_id)
+        def get_shared_folders(machine)
           shared_folders = []
-          info = `VBoxManage showvminfo #{vm_id} --machinereadable`
+          info = machine.provider.driver.execute("showvminfo", machine.id, "--machinereadable")
           info.split("\n").each do |line|
             if line =~ /^SharedFolderNameMachineMapping\d+="(.+?)"$/
               shared_folders << $1.to_s
@@ -17,14 +17,13 @@ module VagrantPlugins
           return shared_folders
         end
 
-        def before_restore(vm_id)
-          @shared_folders_before = get_shared_folders(vm_id)
+        def before_restore(machine)
+          @shared_folders_before = get_shared_folders(machine)
         end
 
-        def after_restore(vm_id)
-          @shared_folders_after = get_shared_folders(vm_id)
+        def after_restore(machine)
+          @shared_folders_after = get_shared_folders(machine)
           if @shared_folders_before != @shared_folders_after
-            missing_folders = @shared_folders_before - @shared_folders_after
             @env.ui.warn("Synced folders have changed after restoring snapshot. Consider running 'vagrant reload'.")
             @env.ui.warn("   Before restore: #{@shared_folders_before}")
             @env.ui.warn("    After restore: #{@shared_folders_after}")
@@ -55,21 +54,26 @@ module VagrantPlugins
           with_target_vms(vm_name, single_target: true) do |machine|
             vm_id = machine.id
 
-            before_restore(vm_id)
+            before_restore(machine)
 
-            system "VBoxManage controlvm #{vm_id} poweroff"
-            system "VBoxManage snapshot #{vm_id} restore #{snapshot_name}"
+            if machine.state.id != :poweroff
+              @env.ui.info("Powering off machine #{vm_id}")
+              machine.provider.driver.execute("controlvm", machine.id, "poweroff")
+            end
+
+            machine.provider.driver.execute("snapshot", machine.id, "restore", snapshot_name) do |type, data|
+              machine.env.ui.info(data, :color => type == :stderr ? :red : :white, :new_line => false)
+            end
 
             if options[:reload]
-              @env.ui.info("Reloading VM")
+              @env.ui.info("Reloading VM, since --reload passed")
               machine.action(:reload, :provision_enabled => false)
             else
-              @env.ui.info("Starting VM from restored snapshot (#{snapshot_name})")
-              @logger.info("starting VM")
-              system "VBoxManage startvm #{vm_id} --type headless"
+              @env.ui.info("Starting restored VM")
+              machine.action(:up, :provision_enabled => false)
             end
 
-            after_restore(vm_id)
+            after_restore(machine)
           end
         end
       end

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

@@ -15,8 +15,11 @@ module VagrantPlugins
           return if !argv
 
           with_target_vms(argv, single_target: true) do |machine|
-            vm_id = machine.id
-            system "VBoxManage snapshot #{vm_id} list --details"
+            puts "Listing snapshots for '#{machine.name}':"
+
+            res = machine.provider.driver.execute("snapshot", machine.id, "list", "--details") do |type, data|
+              machine.env.ui.info(data, :color => :green) if (type == :stdout)
+            end
           end
         end
       end

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

@@ -22,8 +22,10 @@ module VagrantPlugins
           return if !snapshot_name
 
           with_target_vms(vm_name, single_target: true) do |machine|
-            vm_id = machine.id
-            system "VBoxManage snapshot #{vm_id} take #{snapshot_name} --pause"
+            machine.env.ui.info("Taking snapshot #{snapshot_name}")
+            machine.provider.driver.execute("snapshot", machine.id, "take", snapshot_name, "--pause") do |type, data|
+              machine.env.ui.info(data, :color => type == :stderr ? :red : :white, :new_line => false)
+            end
           end
         end
       end

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

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module VBoxSnapshot
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vbox-snapshot
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Alex Dergachev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler