vagrant-vsphere 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18ea9f258ae0478f7b099bd5f90ab8cee9e5de79
-  data.tar.gz: 39813243c2ded6a1e451f504533cea4b4c230745
+  metadata.gz: c011d25a3f928fd80cd7fc8c9df74e647de432a8
+  data.tar.gz: c4f6350c4ac9090a4fa87a167f9ae73e18069768
 SHA512:
-  metadata.gz: 6be072277703883e5e6876dc16c456656ca90073ea5c4d7b0fdb7ba8fab42792075abf3c598c0f6c69f273b9d349703ad08a18104af227c894eda3a8ccb68b40
-  data.tar.gz: 2281f71c3ad514d185aecda5962291ae1114019ad0b37d0089f4cfb186fea556d9df8a80169b8f8a57359582c0c2787295952f1805f883271bb8319c9980dbcd
+  metadata.gz: 51261468c611ba92faf5803e6883b7fa5219efe4c4be61a18cd54c42122a9bc6a8afd8261b9dcd26f7508d6dbec569916bf505021a34921c97ce550410830325
+  data.tar.gz: 45038a038b302e6c82a06d8e9bf459f35daa25f329b937ca1795d32795217383e2a17a57dcec9195b3978e58f876d98442dc5680cc43566a9841362c256aac0f

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.14.0
+current_version = 0.15.0
 tag = true
 commit = true
 

data/README.md

@@ -12,9 +12,9 @@ This provider is built on top of the [RbVmomi](https://github.com/vmware/rbvmomi
 * libxml2, libxml2-dev, libxslt, libxslt-dev
 
 ## Current Version
-**version: 0.14.0**
+**version: 0.15.0**
 
-vagrant-vsphere (**version: 0.14.0**) is available from [RubyGems.org](https://rubygems.org/gems/vagrant-vsphere)
+vagrant-vsphere (**version: 0.15.0**) is available from [RubyGems.org](https://rubygems.org/gems/vagrant-vsphere)
 
 ## Installation
 
@@ -100,6 +100,7 @@ This provider has the following settings, all are required unless noted:
 * `linked_clone` - _Optional_ link the cloned VM to the parent to share virtual disks
 * `proxy_host` - _Optional_ proxy host name for connecting to vSphere via proxy
 * `proxy_port` - _Optional_ proxy port number for connecting to vSphere via proxy
+* `vlan` - _Optional_ vlan to connect the first NIC to
 
 ### Cloning from a VM rather than a template
 
@@ -187,6 +188,10 @@ This is useful if running Vagrant from multiple directories or if multiple machi
 * 0.14.0 Add vlan configuration [#91 rylarson:add-vlan-configuration](https://github.com/nsidc/vagrant-vsphere/pull/91)
   * Added a new configuration option 'vlan' that lets you specify the vlan string
   * If vlan is set, the clone spec is modified with an edit action to connect the first NIC on the VM to the configured VLAN.
+* 0.15.0 Make destroy work in all vm states [#93 rylarson:make-destroy-work-in-all-vm-states](https://github.com/nsidc/vagrant-vsphere/pull/93) (fixes #77)
+  * If the VM is powered on, then it is powered off, and destroyed.
+  * If the VM is powered off, it is just destroyed.
+  * If the VM is suspended, it is powered on, then powered off, then destroyed.
 
 
 ## Versioning

data/lib/vSphere/action/get_state.rb

@@ -1,16 +1,13 @@
 require 'rbvmomi'
 require 'vSphere/util/vim_helpers'
+require 'vSphere/util/vm_helpers'
 
 module VagrantPlugins
   module VSphere
     module Action
       class GetState
         include Util::VimHelpers
-
-        # the three possible values of a vSphere VM's power state
-        POWERED_ON = 'poweredOn'
-        POWERED_OFF = 'poweredOff'
-        SUSPENDED = 'suspended'
+        include Util::VmHelpers
 
         def initialize(app, env)
           @app = app
@@ -33,7 +30,7 @@ module VagrantPlugins
             return :not_created
           end
 
-          if vm.runtime.powerState.eql?(POWERED_ON)
+          if powered_on?(vm)
             :running
           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

data/lib/vSphere/action/power_off.rb

@@ -1,12 +1,14 @@
 require 'rbvmomi'
 require 'i18n'
 require 'vSphere/util/vim_helpers'
+require 'vSphere/util/vm_helpers'
 
 module VagrantPlugins
   module VSphere
     module Action
       class PowerOff
         include Util::VimHelpers
+        include Util::VmHelpers
 
         def initialize(app, env)
           @app = app
@@ -15,9 +17,19 @@ module VagrantPlugins
         def call(env)
           vm = get_vm_by_uuid env[:vSphere_connection], env[:machine]
 
-          unless vm.nil?
+          # If the vm is suspended, we need to turn it on so that we can turn it off.
+          # This may seem counterintuitive, but the vsphere API documentation states
+          # that the Power Off task for a VM will fail if the state is not poweredOn
+          # see: https://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/vim.VirtualMachine.html#powerOff
+          if suspended?(vm)
+            env[:ui].info I18n.t('vsphere.power_on_vm')
+            power_on_vm(vm)
+          end
+
+          # Powering off is a no-op if we can't find the VM or if it is already off
+          unless vm.nil? || powered_off?(vm)
             env[:ui].info I18n.t('vsphere.power_off_vm')
-            vm.PowerOffVM_Task.wait_for_completion
+            power_off_vm(vm)
           end
 
           @app.call env

data/lib/vSphere/action/power_on.rb

@@ -2,12 +2,14 @@ require 'rbvmomi'
 require 'i18n'
 require 'vSphere/util/vim_helpers'
 require 'vSphere/util/machine_helpers'
+require 'vSphere/util/vm_helpers'
 
 module VagrantPlugins
   module VSphere
     module Action
       class PowerOn
         include Util::VimHelpers
+        include Util::VmHelpers
         include Util::MachineHelpers
 
         def initialize(app, env)
@@ -18,7 +20,7 @@ module VagrantPlugins
           vm = get_vm_by_uuid env[:vSphere_connection], env[:machine]
 
           env[:ui].info I18n.t('vsphere.power_on_vm')
-          vm.PowerOnVM_Task.wait_for_completion
+          power_on_vm(vm)
           
           # wait for SSH to be available 
           wait_for_ssh env

data/lib/vSphere/util/vm_helpers.rb

@@ -0,0 +1,40 @@
+require 'rbvmomi'
+
+module VagrantPlugins
+  module VSphere
+    module Util
+
+      module VmState
+        POWERED_ON = 'poweredOn'
+        POWERED_OFF = 'poweredOff'
+        SUSPENDED = 'suspended'
+      end
+
+      module VmHelpers
+        def power_on_vm(vm)
+          vm.PowerOnVM_Task.wait_for_completion
+        end
+
+        def power_off_vm(vm)
+          vm.PowerOffVM_Task.wait_for_completion
+        end
+
+        def get_vm_state(vm)
+          vm.runtime.powerState
+        end
+
+        def powered_on?(vm)
+          get_vm_state(vm).eql?(VmState::POWERED_ON)
+        end
+
+        def powered_off?(vm)
+          get_vm_state(vm).eql?(VmState::POWERED_OFF)
+        end
+
+        def suspended?(vm)
+          get_vm_state(vm).eql?(VmState::SUSPENDED)
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module VSphere
-    VERSION = '0.14.0'
+    VERSION = '0.15.0'
   end
 end

data/spec/get_state_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'vSphere/util/vim_helpers'
 
 describe VagrantPlugins::VSphere::Action::GetState do
   before :each do
@@ -21,7 +22,7 @@ describe VagrantPlugins::VSphere::Action::GetState do
 
   it 'should set state id to running if machine is powered on' do
     @env[:machine].stub(:id).and_return(EXISTING_UUID)
-    @vm.runtime.stub(:powerState).and_return(described_class::POWERED_ON)
+    @vm.runtime.stub(:powerState).and_return(VagrantPlugins::VSphere::Util::VmState::POWERED_ON)
 
     call
 
@@ -30,7 +31,7 @@ describe VagrantPlugins::VSphere::Action::GetState do
 
   it 'should set state id to powered off if machine is powered off' do
     @env[:machine].stub(:id).and_return(EXISTING_UUID)
-    @vm.runtime.stub(:powerState).and_return(described_class::POWERED_OFF)
+    @vm.runtime.stub(:powerState).and_return(VagrantPlugins::VSphere::Util::VmState::POWERED_OFF)
 
     call
 
@@ -39,7 +40,7 @@ describe VagrantPlugins::VSphere::Action::GetState do
 
   it 'should set state id to powered off if machine is suspended' do
     @env[:machine].stub(:id).and_return(EXISTING_UUID)
-    @vm.runtime.stub(:powerState).and_return(described_class::SUSPENDED)
+    @vm.runtime.stub(:powerState).and_return(VagrantPlugins::VSphere::Util::VmState::SUSPENDED)
 
     call
 

data/spec/power_off_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe VagrantPlugins::VSphere::Action::PowerOff do
+  before :each do
+    @env[:vSphere_connection] = @vim
+  end
+
+  it 'should power off the VM if it is powered on' do
+    @machine.stub(:id).and_return(EXISTING_UUID)
+    @machine.state.stub(:id).and_return(VagrantPlugins::VSphere::Util::VmState::POWERED_ON)
+
+    call
+
+    expect(@vm).to have_received :PowerOffVM_Task
+  end
+
+  it 'should not power off the VM if is powered off' do
+    @machine.stub(:id).and_return(EXISTING_UUID)
+    @vm.runtime.stub(:powerState).and_return(VagrantPlugins::VSphere::Util::VmState::POWERED_OFF)
+
+    call
+
+    expect(@vm).not_to have_received :PowerOffVM_Task
+  end
+
+  it 'should power on and off the VM if is suspended' do
+    @machine.stub(:id).and_return(EXISTING_UUID)
+    @vm.runtime.stub(:powerState).and_return(VagrantPlugins::VSphere::Util::VmState::SUSPENDED)
+
+    call
+
+    expect(@vm).to have_received :PowerOnVM_Task
+    expect(@vm).to have_received :PowerOffVM_Task
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vsphere
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Andrew Grauch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2014-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -142,6 +142,7 @@ files:
 - lib/vSphere/provider.rb
 - lib/vSphere/util/machine_helpers.rb
 - lib/vSphere/util/vim_helpers.rb
+- lib/vSphere/util/vm_helpers.rb
 - lib/vSphere/version.rb
 - lib/vagrant-vsphere.rb
 - locales/en.yml
@@ -152,6 +153,7 @@ files:
 - spec/get_ssh_info_spec.rb
 - spec/get_state_spec.rb
 - spec/is_created_spec.rb
+- spec/power_off_spec.rb
 - spec/spec_helper.rb
 - vSphere.gemspec
 homepage: ''
@@ -174,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: VMWare vSphere provider
@@ -186,4 +188,5 @@ test_files:
 - spec/get_ssh_info_spec.rb
 - spec/get_state_spec.rb
 - spec/is_created_spec.rb
+- spec/power_off_spec.rb
 - spec/spec_helper.rb