vagrant-vsphere 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b214391a7269ce42e0026ec47e2f9a9964fa8d97
-  data.tar.gz: 3aea2543fc0e5b23e503991469d20319ef1f3b56
+  metadata.gz: 38f22b2b500db61a2424e1f889a8a06c3110d608
+  data.tar.gz: c046149e0f57992b4d2a6efa0e24fd92d9c98ebd
 SHA512:
-  metadata.gz: 2f36e7102acea74674c86bf8fb892c52fe24f636ef049708d038c023760271b975fd3cc90557225fcee02d648bb199099903372f5c927a14a3975e1071bbbc4e
-  data.tar.gz: f255d642094aa816e751474da9bbdb9ca855dcaebcc131f1fe941110d379bf3953d024d30c3c598120214718b4516423009a227fe1dd57ea839a844c862c40b6
+  metadata.gz: 15d78428dee29093ba9891f19d4cef5fc231ac361d39c0cce28cef0f6c506c66db67a1f436c747ecb9e019beff9f89f0864e4713c5585a126994aca63f2fba41
+  data.tar.gz: 93d239b478335c3f5848412373ba5303806843f20831f050876ea202a3f2f0589df56a75fc95d4a8b475ab14b886377419387a907e357a0b6198e69a64a3fe18

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.9.0
+current_version = 1.10.0
 tag = true
 commit = true
 

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [1.10.0 (2016-05-17)](https://github.com/nsidc/vagrant-vsphere/releases/tag/v1.10.0)
+
+  - Add support for `vagrant snapshot` and its subcommands
+    ([vagrant-vsphere:add-snapshot-support](https://github.com/nsidc/vagrant-vsphere/pull/198)).
+
 ## [1.9.0 (2016-05-17)](https://github.com/nsidc/vagrant-vsphere/releases/tag/v1.9.0)
 
   - Add real_nic_ip option/logic to support VMs with multiple bridge adapters

data/README.md

@@ -19,9 +19,9 @@ This provider is built on top of the
 * libxml2, libxml2-dev, libxslt, libxslt-dev
 
 ## Current Version
-**version: 1.9.0**
+**version: 1.10.0**
 
-vagrant-vsphere (**version: 1.9.0**) is available from
+vagrant-vsphere (**version: 1.10.0**) is available from
 [RubyGems.org](https://rubygems.org/gems/vagrant-vsphere)
 
 ## Installation

data/lib/vSphere/action.rb

@@ -176,6 +176,78 @@ module VagrantPlugins
         end
       end
 
+      # TODO: Remove the if guard when Vagrant 1.8.0 is the minimum version.
+      # rubocop:disable IndentationWidth
+      if Gem::Version.new(Vagrant::VERSION) >= Gem::Version.new('1.8.0')
+      def self.action_snapshot_delete
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectVSphere
+          b.use Call, IsCreated do |env, b2|
+            if env[:result]
+              b2.use SnapshotDelete
+            else
+              b2.use MessageNotCreated
+            end
+          end
+          b.use CloseVSphere
+        end
+      end
+
+      def self.action_snapshot_list
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectVSphere
+          b.use Call, IsCreated do |env, b2|
+            if env[:result]
+              b2.use SnapshotList
+            else
+              b2.use MessageNotCreated
+            end
+          end
+          b.use CloseVSphere
+        end
+      end
+
+      def self.action_snapshot_restore
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectVSphere
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use SnapshotRestore
+            b2.use Call, IsEnvSet, :snapshot_delete do |env2, b3|
+              # Used by vagrant push/pop
+              b3.use action_snapshot_delete if env2[:result]
+            end
+
+            b2.use action_up
+          end
+          b.use CloseVSphere
+        end
+      end
+
+      def self.action_snapshot_save
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectVSphere
+          b.use Call, IsCreated do |env, b2|
+            if env[:result]
+              b2.use SnapshotSave
+            else
+              b2.use MessageNotCreated
+            end
+          end
+          b.use CloseVSphere
+        end
+      end
+      end # Vagrant > 1.8.0 guard
+      # rubocop:enable IndentationWidth
+
       # autoload
       action_root = Pathname.new(File.expand_path('../action', __FILE__))
       autoload :Clone, action_root.join('clone')
@@ -191,6 +263,16 @@ module VagrantPlugins
       autoload :MessageNotRunning, action_root.join('message_not_running')
       autoload :PowerOff, action_root.join('power_off')
       autoload :PowerOn, action_root.join('power_on')
+
+      # TODO: Remove the if guard when Vagrant 1.8.0 is the minimum version.
+      # rubocop:disable IndentationWidth
+      if Gem::Version.new(Vagrant::VERSION) >= Gem::Version.new('1.8.0')
+      autoload :SnapshotDelete, action_root.join('snapshot_delete')
+      autoload :SnapshotList, action_root.join('snapshot_list')
+      autoload :SnapshotRestore, action_root.join('snapshot_restore')
+      autoload :SnapshotSave, action_root.join('snapshot_save')
+      end
+      # rubocop:enable IndentationWidth
     end
   end
 end

data/lib/vSphere/action/snapshot_delete.rb

@@ -0,0 +1,38 @@
+require 'vSphere/util/vim_helpers'
+require 'vSphere/util/vm_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class SnapshotDelete
+        include Util::VimHelpers
+        include Util::VmHelpers
+
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          vm = get_vm_by_uuid(env[:vSphere_connection], env[:machine])
+
+          env[:ui].info(I18n.t(
+            "vagrant.actions.vm.snapshot.deleting",
+            name: env[:snapshot_name]))
+
+          delete_snapshot(vm, env[:snapshot_name]) do |progress|
+            env[:ui].clear_line
+            env[:ui].report_progress(progress, 100, false)
+          end
+
+          env[:ui].clear_line
+
+          env[:ui].info(I18n.t(
+            "vagrant.actions.vm.snapshot.deleted",
+            name: env[:snapshot_name]))
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/snapshot_list.rb

@@ -0,0 +1,25 @@
+require 'vSphere/util/vim_helpers'
+require 'vSphere/util/vm_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class SnapshotList
+        include Util::VimHelpers
+        include Util::VmHelpers
+
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          vm = get_vm_by_uuid(env[:vSphere_connection], env[:machine])
+
+          env[:machine_snapshot_list] = enumerate_snapshots(vm).map(&:name)
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/snapshot_restore.rb

@@ -0,0 +1,34 @@
+require 'vSphere/util/vim_helpers'
+require 'vSphere/util/vm_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class SnapshotRestore
+        include Util::VimHelpers
+        include Util::VmHelpers
+
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          vm = get_vm_by_uuid(env[:vSphere_connection], env[:machine])
+
+          env[:ui].info(I18n.t(
+            "vagrant.actions.vm.snapshot.restoring",
+            name: env[:snapshot_name]))
+
+          restore_snapshot(vm, env[:snapshot_name]) do |progress|
+            env[:ui].clear_line
+            env[:ui].report_progress(progress, 100, false)
+          end
+
+          env[:ui].clear_line
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/snapshot_save.rb

@@ -0,0 +1,37 @@
+require 'vSphere/util/vim_helpers'
+require 'vSphere/util/vm_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class SnapshotSave
+        include Util::VimHelpers
+        include Util::VmHelpers
+
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          vm = get_vm_by_uuid(env[:vSphere_connection], env[:machine])
+
+          env[:ui].info(I18n.t(
+            "vagrant.actions.vm.snapshot.saving",
+            name: env[:snapshot_name]))
+
+          create_snapshot(vm, env[:snapshot_name]) do |progress|
+            env[:ui].clear_line
+            env[:ui].report_progress(progress, 100, false)
+          end
+
+          env[:ui].clear_line
+
+          env[:ui].success(I18n.t(
+            "vagrant.actions.vm.snapshot.saved",
+            name: env[:snapshot_name]))
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/cap/snapshot_list.rb

@@ -0,0 +1,15 @@
+module VagrantPlugins
+  module VSphere
+    module Cap
+      module SnapshotList
+        # Returns a list of the snapshots that are taken on this machine.
+        #
+        # @return [Array<String>] Snapshot Name
+        def self.snapshot_list(machine)
+          env = machine.action(:snapshot_list, lock: false)
+          env[:machine_snapshot_list]
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/plugin.rb

@@ -35,6 +35,16 @@ module VagrantPlugins
         Cap::PublicAddress
       end
 
+      # TODO: Remove the if guard when Vagrant 1.8.0 is the minimum version.
+      # rubocop:disable IndentationWidth
+      if Gem::Version.new(Vagrant::VERSION) >= Gem::Version.new('1.8.0')
+      provider_capability('vsphere', 'snapshot_list') do
+        require_relative 'cap/snapshot_list'
+        Cap::SnapshotList
+      end
+      end
+      # rubocop:enable IndentationWidth
+
       def self.setup_i18n
         I18n.load_path << File.expand_path('locales/en.yml', VSphere.source_root)
         I18n.reload!

data/lib/vSphere/util/vm_helpers.rb

@@ -33,6 +33,127 @@ module VagrantPlugins
         def suspended?(vm)
           get_vm_state(vm).eql?(VmState::SUSPENDED)
         end
+
+        # Enumerate VM snapshot tree
+        #
+        # This method returns an enumerator that performs a depth-first walk
+        # of the VM snapshot grap and yields each VirtualMachineSnapshotTree
+        # node.
+        #
+        # @param vm [RbVmomi::VIM::VirtualMachine]
+        #
+        # @return [Enumerator<RbVmomi::VIM::VirtualMachineSnapshotTree>]
+        def enumerate_snapshots(vm)
+          snapshot_info = vm.snapshot
+
+          if snapshot_info.nil?
+            snapshot_root = []
+          else
+            snapshot_root = snapshot_info.rootSnapshotList
+          end
+
+          recursor = lambda do |snapshot_list|
+            Enumerator.new do |yielder|
+              snapshot_list.each do |s|
+                # Yield the current VirtualMachineSnapshotTree object
+                yielder.yield s
+
+                # Recurse into child VirtualMachineSnapshotTree objects
+                children = recursor.call(s.childSnapshotList)
+                loop do
+                  yielder.yield children.next
+                end
+              end
+            end
+          end
+
+          recursor.call(snapshot_root)
+        end
+
+        # Create a named snapshot on a given VM
+        #
+        # This method creates a named snapshot on the given VM. This method
+        # blocks until the snapshot creation task is complete. An optional
+        # block can be passed which is used to report progress.
+        #
+        # @param vm [RbVmomi::VIM::VirtualMachine]
+        # @param name [String]
+        # @yield [Integer] Percentage complete as an integer. Called multiple
+        #   times.
+        #
+        # @return [void]
+        def create_snapshot(vm, name)
+          task = vm.CreateSnapshot_Task(
+            name: name,
+            memory: false,
+            quiesce: false)
+
+          if block_given?
+            task.wait_for_progress do |progress|
+              yield progress unless progress.nil?
+            end
+          else
+            task.wait_for_completion
+          end
+        end
+
+        # Delete a named snapshot on a given VM
+        #
+        # This method deletes a named snapshot on the given VM. This method
+        # blocks until the snapshot deletion task is complete. An optional
+        # block can be passed which is used to report progress.
+        #
+        # @param vm [RbVmomi::VIM::VirtualMachine]
+        # @param name [String]
+        # @yield [Integer] Percentage complete as an integer. Called multiple
+        #   times.
+        #
+        # @return [void]
+        def delete_snapshot(vm, name)
+          snapshot = enumerate_snapshots(vm).find { |s| s.name == name }
+
+          # No snapshot matching "name"
+          return nil if snapshot.nil?
+
+          task = snapshot.snapshot.RemoveSnapshot_Task(removeChildren: false)
+
+          if block_given?
+            task.wait_for_progress do |progress|
+              yield progress unless progress.nil?
+            end
+          else
+            task.wait_for_completion
+          end
+        end
+
+        # Restore a VM to a named snapshot
+        #
+        # This method restores a VM to the named snapshot state. This method
+        # blocks until the restoration task is complete. An optional block can
+        # be passed which is used to report progress.
+        #
+        # @param vm [RbVmomi::VIM::VirtualMachine]
+        # @param name [String]
+        # @yield [Integer] Percentage complete as an integer. Called multiple
+        #   times.
+        #
+        # @return [void]
+        def restore_snapshot(vm, name)
+          snapshot = enumerate_snapshots(vm).find { |s| s.name == name }
+
+          # No snapshot matching "name"
+          return nil if snapshot.nil?
+
+          task = snapshot.snapshot.RevertToSnapshot_Task(suppressPowerOn: true)
+
+          if block_given?
+            task.wait_for_progress do |progress|
+              yield progress unless progress.nil?
+            end
+          else
+            task.wait_for_completion
+          end
+        end
       end
     end
   end

data/lib/vSphere/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module VSphere
-    VERSION = '1.9.0'
+    VERSION = '1.10.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vsphere
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Andrew Grauch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -161,7 +161,12 @@ files:
 - lib/vSphere/action/message_not_running.rb
 - lib/vSphere/action/power_off.rb
 - lib/vSphere/action/power_on.rb
+- lib/vSphere/action/snapshot_delete.rb
+- lib/vSphere/action/snapshot_list.rb
+- lib/vSphere/action/snapshot_restore.rb
+- lib/vSphere/action/snapshot_save.rb
 - lib/vSphere/cap/public_address.rb
+- lib/vSphere/cap/snapshot_list.rb
 - lib/vSphere/config.rb
 - lib/vSphere/errors.rb
 - lib/vSphere/plugin.rb
@@ -202,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: VMWare vSphere provider