vagrant-vsphere 1.12.1 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebe9f0396290f0413d0752d2d97266dd4b7bdda8
-  data.tar.gz: 815e05d6f5ba00a7b8ed805e11508656dc769d07
+  metadata.gz: '02349de22aa61f900e082d22099a5010bf77c1fd'
+  data.tar.gz: f3cd646a826ef3deb077a2e123992dbc8dc6ef8a
 SHA512:
-  metadata.gz: 3cec1f42099820c8e7c6e1c0c88d151aabbca18a69ca0d5849cbaa39b30540d621554ae8b2da601925fce8f4b838c67ea0e9534a389e9a9b2fe2b32d6ad6bec0
-  data.tar.gz: ecbd3ac119f4605d14e16bccab73d4831953283ef2c98c83a19f82b13134cfc5f05288a7219814f5a7ecdcb0736e3adfb21b1fa6232a437550d8ced4c1197d1f
+  metadata.gz: 3b4789843ce0833dd2d510b17a8ed5fc13328410e5f0c17518a87749b303fd58cd3e40ec1542f4abbb7982d05b613c2b164088e614010faf9931d440086fff6d
+  data.tar.gz: 87f956a7410bde5568d37187af7569733e5eec5ab63b7eb1dc471ce237149c834b9dc06a414049bce5a003921beb9f2e6a3bf6ca9c1899314df1ab59a14e45e3

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.12.1
+current_version = 1.13.0
 tag = true
 commit = true
 

data/.ruby-version

@@ -0,0 +1 @@
+2.3.5

data/.travis.yml

@@ -1,11 +1,11 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.2.3
+  - 2.3.5
 
 before_install:
   - rvm @global do gem uninstall bundler --all --executables
   - gem uninstall bundler --all --executables
-  - gem install bundler --version '1.12.5'
+  - gem install bundler --version '1.15.4'
 
 sudo: false

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [1.13.0 (2017-11-06)](https://github.com/nsidc/vagrant-vsphere/releases/tag/v1.13.0)
+
+  - Add support for the commands
+    [`suspend`](https://www.vagrantup.com/docs/cli/suspend.html) and
+    [`resume`](https://www.vagrantup.com/docs/cli/resume.html).
+
 ## [1.12.1 (2017-03-07)](https://github.com/nsidc/vagrant-vsphere/releases/tag/v1.12.1)
 
   - If no valid adapters can be found on a host when using the `real_nic_ip`

data/Gemfile

@@ -1,7 +1,5 @@
 source 'http://rubygems.org'
 
-gemspec
-
 group :development do
   # We depend on Vagrant for development, but we don't add it as a
   # gem dependency because we expect to be installed within the
@@ -10,5 +8,5 @@ group :development do
 end
 
 group :plugins do
-  gem 'vagrant-vsphere', path: '.'
+  gemspec
 end

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.12.1**
+**version: 1.13.0**
 
-vagrant-vsphere (**version: 1.12.1**) is available from
+vagrant-vsphere (**version: 1.13.0**) is available from
 [RubyGems.org](https://rubygems.org/gems/vagrant-vsphere)
 
 ## Installation

data/lib/vSphere/action.rb

@@ -157,6 +157,52 @@ module VagrantPlugins
         end
       end
 
+      def self.action_resume
+        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 Call, IsSuspended do |env2, b3|
+              unless env2[:result]
+                b3.use MessageNotSuspended
+                next
+              end
+
+              b3.use Resume
+            end
+          end
+          b.use CloseVSphere
+        end
+      end
+
+      def self.action_suspend
+        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 Call, IsRunning do |env2, b3|
+              unless env2[:result]
+                b3.use MessageNotRunning
+                next
+              end
+
+              b3.use Suspend
+            end
+          end
+          b.use CloseVSphere
+        end
+      end
+
       # vSphere specific actions
       def self.action_get_state
         Vagrant::Action::Builder.new.tap do |b|
@@ -259,11 +305,15 @@ module VagrantPlugins
       autoload :GetState, action_root.join('get_state')
       autoload :IsCreated, action_root.join('is_created')
       autoload :IsRunning, action_root.join('is_running')
+      autoload :IsSuspended, action_root.join('is_suspended')
       autoload :MessageAlreadyCreated, action_root.join('message_already_created')
       autoload :MessageNotCreated, action_root.join('message_not_created')
       autoload :MessageNotRunning, action_root.join('message_not_running')
+      autoload :MessageNotSuspended, action_root.join('message_not_suspended')
       autoload :PowerOff, action_root.join('power_off')
       autoload :PowerOn, action_root.join('power_on')
+      autoload :Resume, action_root.join('resume')
+      autoload :Suspend, action_root.join('suspend')
       autoload :WaitForIPAddress, action_root.join('wait_for_ip_address')
 
       # TODO: Remove the if guard when Vagrant 1.8.0 is the minimum version.

data/lib/vSphere/action/get_state.rb

@@ -30,8 +30,9 @@ module VagrantPlugins
 
           if powered_on?(vm)
             :running
+          elsif suspended?(vm)
+            :suspended
           else
-            # If the VM is powered off or suspended, we consider it to be powered off. A power on command will either turn on or resume the VM
             :poweroff
           end
         end

data/lib/vSphere/action/is_suspended.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module VSphere
+    module Action
+      class IsSuspended
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id == :suspended
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/message_not_suspended.rb

@@ -0,0 +1,18 @@
+require 'i18n'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class MessageNotSuspended
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info I18n.t('vsphere.vm_not_suspended')
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/resume.rb

@@ -0,0 +1,30 @@
+require 'rbvmomi'
+require 'i18n'
+require 'vSphere/util/vim_helpers'
+require 'vSphere/util/vm_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class Resume
+        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]
+
+          if suspended?(vm)
+            env[:ui].info I18n.t('vsphere.resume_vm')
+            resume_vm(vm)
+          end
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/suspend.rb

@@ -0,0 +1,32 @@
+require 'rbvmomi'
+require 'i18n'
+require 'vSphere/util/vim_helpers'
+require 'vSphere/util/vm_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class Suspend
+        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]
+
+          # Suspending is a no-op if we can't find the VM or it is already off
+          # or suspended
+          unless vm.nil? || suspended?(vm) || powered_off?(vm)
+            env[:ui].info I18n.t('vsphere.suspend_vm')
+            suspend_vm(vm)
+          end
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/util/vm_helpers.rb

@@ -18,6 +18,15 @@ module VagrantPlugins
           vm.PowerOffVM_Task.wait_for_completion
         end
 
+        # https://www.vmware.com/support/developer/converter-sdk/conv61_apireference/vim.VirtualMachine.html#powerOn
+        def resume_vm(vm)
+          vm.PowerOnVM_Task.wait_for_completion
+        end
+
+        def suspend_vm(vm)
+          vm.SuspendVM_Task.wait_for_completion
+        end
+
         def get_vm_state(vm)
           vm.runtime.powerState
         end

data/lib/vSphere/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module VSphere
-    VERSION = '1.12.1'
+    VERSION = '1.13.0'
   end
 end

data/locales/en.yml

@@ -14,12 +14,18 @@ en:
       Calling vSphere PowerOff
     power_on_vm: |-
       Calling vSphere PowerOn
+    resume_vm: |-
+      Calling vSphere PowerOn
+    suspend_vm: |-
+      Calling vSphere Suspend
     vm_already_created: |-
       The VM is already created
     vm_not_created: |-
       The VM has not been created
     vm_not_running: |-
       The VM is not running
+    vm_not_suspended: |-
+      The VM is not suspended
     wait_sysprep: |-
       Waiting for sysprep
 

data/spec/action_spec.rb

@@ -164,4 +164,66 @@ describe VagrantPlugins::VSphere::Action do
       VagrantPlugins::VSphere::Action::MessageAlreadyCreated.any_instance.should_receive(:call)
     end
   end
+
+  describe 'suspend' do
+    it 'should connect to vSphere' do
+      VagrantPlugins::VSphere::Action::ConnectVSphere.any_instance.should_receive(:call)
+      run :suspend
+    end
+
+    it 'should check if the VM exits' do
+      @machine.state.stub(:id).and_return(:running)
+      VagrantPlugins::VSphere::Action::IsCreated.any_instance.should_receive(:call)
+      run :suspend
+    end
+
+    it 'should suspend the VM when the VM is running' do
+      @machine.state.stub(:id).and_return(:running)
+      VagrantPlugins::VSphere::Action::Suspend.any_instance.should_receive(:call)
+      run :suspend
+    end
+
+    it 'should not suspend the VM when the VM is suspended' do
+      @machine.state.stub(:id).and_return(:suspended)
+      VagrantPlugins::VSphere::Action::Suspend.any_instance.should_not_receive(:call)
+      run :suspend
+    end
+
+    it 'should not suspend the VM when the VM is off' do
+      @machine.state.stub(:id).and_return(:poweroff)
+      VagrantPlugins::VSphere::Action::Suspend.any_instance.should_not_receive(:call)
+      run :suspend
+    end
+  end
+
+  describe 'resume' do
+    it 'should connect to vSphere' do
+      VagrantPlugins::VSphere::Action::ConnectVSphere.any_instance.should_receive(:call)
+      run :resume
+    end
+
+    it 'should check if the VM exits' do
+      @machine.state.stub(:id).and_return(:suspended)
+      VagrantPlugins::VSphere::Action::IsCreated.any_instance.should_receive(:call)
+      run :resume
+    end
+
+    it 'should not resume the VM when the VM is running' do
+      @machine.state.stub(:id).and_return(:running)
+      VagrantPlugins::VSphere::Action::Resume.any_instance.should_not_receive(:call)
+      run :resume
+    end
+
+    it 'should resume the VM when the VM is suspended' do
+      @machine.state.stub(:id).and_return(:suspended)
+      VagrantPlugins::VSphere::Action::Resume.any_instance.should_receive(:call)
+      run :resume
+    end
+
+    it 'should not resume the VM when the VM is off' do
+      @machine.state.stub(:id).and_return(:poweroff)
+      VagrantPlugins::VSphere::Action::Resume.any_instance.should_not_receive(:call)
+      run :resume
+    end
+  end
 end

data/spec/get_ssh_info_spec.rb

@@ -119,10 +119,11 @@ describe VagrantPlugins::VSphere::Action::GetSshInfo do
       context 'when the VM networking is uninitialized' do
         before do
           allow(@vm.guest).to receive(:net) { [] }
+          allow(@vm.guest).to receive(:ipAddress) { '123.234.156.78' }
         end
-        it 'should set the ssh info to nil if no valid adapters are present' do
+        it 'should set the ssh info to the guest ipAddress and port 22 if no valid adapters are present' do
           call
-          expect(@env[:machine_ssh_info]).to eq nil
+          expect(@env[:machine_ssh_info]).to eq(host: '123.234.156.78', port: 22)
         end
       end
     end

data/spec/get_state_spec.rb

@@ -38,13 +38,13 @@ describe VagrantPlugins::VSphere::Action::GetState do
     expect(@env[:machine_state_id]).to be :poweroff
   end
 
-  it 'should set state id to powered off if machine is suspended' do
+  it 'should set state id to suspended if machine is suspended' do
     @env[:machine].stub(:id).and_return(EXISTING_UUID)
     @vm.runtime.stub(:powerState).and_return(VagrantPlugins::VSphere::Util::VmState::SUSPENDED)
 
     call
 
-    expect(@env[:machine_state_id]).to be :poweroff
+    expect(@env[:machine_state_id]).to be :suspended
   end
 
   it 'should call the next item in the middleware stack' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vsphere
 version: !ruby/object:Gem::Version
-  version: 1.12.1
+  version: 1.13.0
 platform: ruby
 authors:
 - Andrew Grauch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-20 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -145,6 +145,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - DEVELOPMENT.md
@@ -162,15 +163,19 @@ files:
 - lib/vSphere/action/get_state.rb
 - lib/vSphere/action/is_created.rb
 - lib/vSphere/action/is_running.rb
+- lib/vSphere/action/is_suspended.rb
 - lib/vSphere/action/message_already_created.rb
 - lib/vSphere/action/message_not_created.rb
 - lib/vSphere/action/message_not_running.rb
+- lib/vSphere/action/message_not_suspended.rb
 - lib/vSphere/action/power_off.rb
 - lib/vSphere/action/power_on.rb
+- lib/vSphere/action/resume.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/action/suspend.rb
 - lib/vSphere/action/wait_for_ip_address.rb
 - lib/vSphere/cap/public_address.rb
 - lib/vSphere/cap/snapshot_list.rb
@@ -214,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: VMWare vSphere provider