vagrant-vbox-snapshot 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    M2Q3MjFmMjUyYjY1Yzk1OThlOGRlZWI3YWU1YTM3YmY4NDNjYTFjNg==
-  data.tar.gz: !binary |-
-    YzlmYjhjN2M1MjY2OWUyNGE2MzU2OGQzYmFiOWU2MTBlYmU3NzYyMg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NDU4ZmZkMTdlMjVjNzc5ZWMxNTIzZDYzNTViNDRkYThkODYzMmUyN2NkMzcx
-    NzBhNWI5ZGY5ZWExYTE5NGNmMWQ3NTY0YTY1YzJkN2I3MGJkMmMzMGY3NzZl
-    NTllMGU4M2Q2NGQwZWI1YTlmNDk1NzA5NDYyOTlhYjM2MWFlNTA=
-  data.tar.gz: !binary |-
-    MTU2ZDY1NzgxOWM5YmUxNzYyZDg5Y2RhNmVhYTUxYTlhYTIzOGI5YjhiYzBj
-    NmQzNjE4Yjc5NzRmNDgxMWQ1OWRlZDExMGZiNTFjNDJkNzA4NjlhYmFiNWI4
-    NWMzMjdmZTgwNGM0MTMxZTkxYjUwZjYzMTEwYjMwMWY5MzNjZDE=
+SHA1:
+  metadata.gz: 59803a44c1dfd4762ad171ac328e8281b5b0798c
+  data.tar.gz: 8ff585dcf406ac9c1932310283c695dabc0a5a68
+SHA512:
+  metadata.gz: 2ff4aea7a11ac98f5f934c259e66723b3041fe3a57dd131873e6edda4f3a6da9c36f47d08458c391be3dd5bd914d36ebca5b3a47114644ea446e156cc37a3669
+  data.tar.gz: 35c4d93a36cb0c04e3074ce272ddfde3ec260105d15893cde898b372f5af0f979c5eb7117cf3703d7b0f92291c99ab8a76edaeaa08d201120b8c95424837842e

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [0.0.3](https://github.com/dergachev/vagrant-vbox-snapshot/compare/v0.0.2...v0.0.3) (Sep 3, 2013)
+
+BACKWARDS INCOMPATIBILITIES:
+
+  - none
+
+FEATURES:
+
+  - Add multi-vm support [#6](https://github.com/dergachev/vagrant-vbox-snapshot/pull/6)
+
+IMPROVEMENTS:
+
+  - Run `vagrant reload` when restoring snapshots with changed config [#2](https://github.com/dergachev/vagrant-vbox-snapshot/issues/2)

data/DEVNOTES.md

@@ -26,3 +26,43 @@ Vagrant source code:
 ## other ideas related to snapshots
 
 * http://code.chrisroberts.org/blog/2012/05/09/cooking-up-partial-run-lists-with-chef/
+
+## Reviewing a pull request
+
+```
+git clone https://github.com/dergachev/vagrant-vbox-snapshot.git
+cd vagrant-vbox-snapshot
+# consider branching if you aren't sure about merging it (not the case here, of course!)
+# git checkout dubious-pull-request
+git pull https://github.com/fgrehm/vagrant-vbox-snapshot multi-vm-environments-support
+# test, fix stuff, etc
+git push -u origin master
+```
+
+## Pushing out a new release of the gem
+
+```
+# 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
+
+# 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
+
+cd ~/code/vagrant-vbox-snapshot/
+gem push vagrant-vbox-snapshot-0.0.3.gem
+git tag 0.0.3
+git push --tags
+
+# test installing from rubygems
+cd ~/code/screengif
+vagrant plugin install vagrant-vbox-snapshot
+vagrant plugin list
+```

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in vagrant-snap.gemspec
 gemspec
+
+gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"

data/README.md

@@ -12,31 +12,47 @@ Ensure you have Vagrant 1.1+ installed, then run:
 
 The following commands are added by this plugin:
 
-     vagrant snapshot take [NAME]            # take snapshot, labeled by NAME
-     vagrant snapshot list                   # list snapshots
-     vagrant snapshot back                   # restore last taken snapshot
-     vagrant snapshot delete SNAP_NAME       # delete specified snapshot
-     vagrant snapshot go SNAP_NAME           # restore specified snapshot
+     vagrant snapshot take [vm-name] [NAME]            # take snapshot, labeled by NAME
+     vagrant snapshot list [vm-name]                   # list snapshots
+     vagrant snapshot back [vm-name]                   # restore last taken snapshot
+     vagrant snapshot delete [vm-name] [NAME]          # delete specified snapshot
+     vagrant snapshot go [vm-name] [NAME]              # restore specified snapshot
 
 ## Caveats
 
 * Not compatible with Vagrant <1.1. If you need this, try [another solution](#other-solutions).
-* Does not support multiple VMs. (Pull requests encouraged).
 * Only minimally tested.
 
 ## Other solutions
 
-There have been a number of similar plugins, but none worked for Vagrant 1.1:
+This plugin is primarily a port of vagrant-snap to 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
+  - fork with Vagrant 1.0.4-1.0.7 compatibility: https://gist.github.com/tombh/5142237 [source](https://github.com/mitchellh/vagrant/issues/143#issuecomment-14781762)
 * [sahara](https://github.com/jedi4ever/sahara)
   - fork exists with 1.1 functionality: https://github.com/ryuzee/sahara
 
 ## Development
 
+To develop on this plugin, do the following:
+
+```
+# get the repo, and then make a feature branch (REPLACE WITH YOUR FORK)
+git clone https://github.com/dergachev/vagrant-vbox-snapshot.git
+cd vagrant-vbox-snapshot
+git checkout -b MY-NEW-FEATURE
+
+# installs the vagrant gem, which is a dev dependency
+bundle install 
+
+# hack on the plugin
+vim lib/vagrant-vbox-snapshot.rb # or any other file
+
+# test out your changes, in the context provided by the development vagrant gem, and the local Vagrantfile.
+bundle exec vagrant snapshot ...
+
+# commit, push, and do a pull-request
+```
+
 See [DEVNOTES.md](https://github.com/dergachev/vagrant-vbox-snapshot/blob/master/DEVNOTES.md)
 for the notes I compiled while developing this plugin.

data/Vagrantfile

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+require_relative 'lib/vagrant-vbox-snapshot.rb'
+
+Vagrant.configure("2") do |config|
+
+  TEST_MULTI_VM = false
+  TEST_SHARED_FOLDERS = false
+
+  if TEST_MULTI_VM
+    config.vm.define :web do |web|
+      web.vm.box = "precise64"
+    end
+    config.vm.define :db do |web|
+      web.vm.box = "precise64"
+    end
+  else
+    config.vm.box = "precise64"
+    config.vm.box_url = "http://files.vagrantup.com/precise64.box"
+  end
+
+  if TEST_SHARED_FOLDERS
+    config.vm.synced_folder "/tmp", "/tmp/host-tmp"
+    config.vm.synced_folder "/tmp", "/tmp/host-tmp2"
+  end
+end

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

@@ -8,13 +8,13 @@ module VagrantPlugins
           opts = OptionParser.new do |opts|
             opts.banner = "Back to current snapshot"
             opts.separator ""
-            opts.separator "Usage: vagrant snapshot back"
+            opts.separator "Usage: vagrant snapshot back [vm-name]"
           end
           # Parse the options
           argv = parse_options(opts)
           return if !argv
 
-          with_target_vms do |machine|
+          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"

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

@@ -1,27 +1,28 @@
+require_relative 'multi_vm_args'
+
 module VagrantPlugins
   module VBoxSnapshot
     module Command
       class Delete < Vagrant.plugin(2, :command)
+        include MultiVmArgs
+
         def execute
           options = {}
 
           opts = OptionParser.new do |opts|
             opts.banner = "Delete snapshot"
             opts.separator ""
-            opts.separator "Usage: vagrant snapshot delete <SNAPSHOT_NAME>"
+            opts.separator "Usage: vagrant snapshot delete [vm-name] <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
+          vm_name, snapshot_name = parse_vm_and_snapshot_options(argv, opts)
+          return if !snapshot_name
 
-          with_target_vms do |machine|
+          with_target_vms(vm_name, single_target: true) do |machine|
             vm_id = machine.id
-            snapshot_name = argv[0]
             system "VBoxManage snapshot #{vm_id} delete #{snapshot_name}"
           end
         end

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

@@ -1,30 +1,75 @@
+require_relative 'multi_vm_args'
+
 module VagrantPlugins
   module VBoxSnapshot
     module Command
       class Go < Vagrant.plugin(2, :command)
+        include MultiVmArgs
+
+        def get_shared_folders(vm_id)
+          shared_folders = []
+          info = `VBoxManage showvminfo #{vm_id} --machinereadable`
+          info.split("\n").each do |line|
+            if line =~ /^SharedFolderNameMachineMapping\d+="(.+?)"$/
+              shared_folders << $1.to_s
+            end
+          end
+          return shared_folders
+        end
+
+        def before_restore(vm_id)
+          @shared_folders_before = get_shared_folders(vm_id)
+        end
+
+        def after_restore(vm_id)
+          @shared_folders_after = get_shared_folders(vm_id)
+          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}")
+          end
+        end
+
         def execute
           options = {}
+          options[:reload] = false
 
           opts = OptionParser.new do |opts|
             opts.banner = "Go to specified snapshot"
             opts.separator ""
-            opts.separator "Usage: vagrant snapshot go <SNAPSHOT_NAME>"
+            opts.separator "Usage: vagrant snapshot go [vm-name] <SNAPSHOT_NAME>"
+
+            opts.on("-r", "--reload", "Runs 'vagrant reload --no-provision' after restoring snapshot to ensure Vagrantfile config is applied.") do |reload|
+              options[:reload] = reload
+            end
+
           end
           # Parse the options
           argv = parse_options(opts)
           return if !argv
 
-          if !argv[0]
-            @env.ui.info(opts.help, :prefix => false)
-            return
-          end
+          vm_name, snapshot_name = parse_vm_and_snapshot_options(argv, opts)
+          return if !snapshot_name
 
-          with_target_vms do |machine|
+          with_target_vms(vm_name, single_target: true) do |machine|
             vm_id = machine.id
-            snapshot_name = argv[0]
+
+            before_restore(vm_id)
+
             system "VBoxManage controlvm #{vm_id} poweroff"
-            system "VBoxManage snapshot  #{vm_id} restore #{snapshot_name}"
-            system "VBoxManage startvm   #{vm_id} --type headless"
+            system "VBoxManage snapshot #{vm_id} restore #{snapshot_name}"
+
+            if options[:reload]
+              @env.ui.info("Reloading VM")
+              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"
+            end
+
+            after_restore(vm_id)
           end
         end
       end

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

@@ -14,7 +14,7 @@ module VagrantPlugins
           argv = parse_options(opts)
           return if !argv
 
-          with_target_vms do |machine|
+          with_target_vms(argv, single_target: true) do |machine|
             vm_id = machine.id
             system "VBoxManage snapshot #{vm_id} list --details"
           end

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

@@ -0,0 +1,20 @@
+module VagrantPlugins
+  module VBoxSnapshot
+    module Command
+      module MultiVmArgs
+        def parse_vm_and_snapshot_options(argv, opts)
+          unless [1, 2].include?(argv.size)
+            @env.ui.info(opts.help, :prefix => false)
+            return
+          end
+
+          if argv.size == 1
+            [nil, argv[0]]
+          else
+            [argv[0], argv[1]]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,27 +1,28 @@
+require_relative 'multi_vm_args'
+
 module VagrantPlugins
   module VBoxSnapshot
     module Command
       class Take < Vagrant.plugin(2, :command)
+        include MultiVmArgs
+
         def execute
           options = {}
 
           opts = OptionParser.new do |opts|
             opts.banner = "Take snapshot"
             opts.separator ""
-            opts.separator "Usage: vagrant snapshot take <SNAPSHOT_NAME>"
+            opts.separator "Usage: vagrant snapshot take [vm-name] <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
+          vm_name, snapshot_name = parse_vm_and_snapshot_options(argv, opts)
+          return if !snapshot_name
 
-          with_target_vms do |machine|
+          with_target_vms(vm_name, single_target: true) do |machine|
             vm_id = machine.id
-            snapshot_name = argv[0]
             system "VBoxManage snapshot #{vm_id} take #{snapshot_name} --pause"
           end
         end

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

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

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vbox-snapshot
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alex Dergachev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-22 00:00:00.000000000 Z
+date: 2013-09-03 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.
@@ -45,15 +45,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - DEVNOTES.md
 - Gemfile
 - README.md
 - Rakefile
+- Vagrantfile
 - 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/multi_vm_args.rb
 - lib/vagrant-vbox-snapshot/commands/root.rb
 - lib/vagrant-vbox-snapshot/commands/take.rb
 - lib/vagrant-vbox-snapshot/plugin.rb
@@ -69,12 +72,12 @@ 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: []