vagrant-vsphere 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b063bf190dceeafef58aa04ce867ebc9667d5c0b
-  data.tar.gz: f43cc9c9d34d8a988166bd06aed7973fea7ea70c
+  metadata.gz: ca7707beee33ab9618da472c660a46a05e2ca8f4
+  data.tar.gz: bd28c6055786c007862865c0768f053d8309498c
 SHA512:
-  metadata.gz: b947f9e482a26aebc7a723427aea0f2bb675738b4ea82114f92ac892026560dbe4e473d6d8de79d946a1a518e5d7953ca47f251d6b0c0f079080089dc2937db7
-  data.tar.gz: fb835079c46f46143fdb719eeca089b5fe09dcd7255c442238081a1b0e293db2e08842a1839730554a8ba57c17cecf82aa026f5fcdaf49f80a29f6d298971710
+  metadata.gz: 7a83daf3b86d22e1346e463b82d5f54536663cca554d7b4dcd554fdb5cd85bfd114bb02e0a15b126b4f9c6cb5a5e0eba7304484bd050c2cf62ddc7900043e172
+  data.tar.gz: e5457be35238ac4eed9e1c95329ec9f699711d90c80432265dbce8a37cf288adaeb858c8edcbb8d21e1340fb2607f2b66f8fc804c7af0b51e323812f46732096

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.17.0
+current_version = 0.18.0
 tag = true
 commit = true
 

data/README.md

@@ -9,21 +9,21 @@ This provider is built on top of the [RbVmomi](https://github.com/vmware/rbvmomi
 
 ## Requirements
 * Vagrant 1.6.3+
-* VMware + vSphere API
+* VMware with vSphere API
 * Ruby 1.9+
 * libxml2, libxml2-dev, libxslt, libxslt-dev
 
 ## Current Version
-**version: 0.17.0**
+**version: 0.18.0**
 
-vagrant-vsphere (**version: 0.17.0**) is available from [RubyGems.org](https://rubygems.org/gems/vagrant-vsphere)
+vagrant-vsphere (**version: 0.18.0**) is available from [RubyGems.org](https://rubygems.org/gems/vagrant-vsphere)
 
 ## Installation
 
 Install using standard Vagrant plugin method:
 
-```
-$ vagrant plugin install vagrant-vsphere
+```bash
+vagrant plugin install vagrant-vsphere
 ```
 
 This will install the plugin from RubyGems.org.
@@ -31,9 +31,9 @@ This will install the plugin from RubyGems.org.
 Alternatively, you can clone this repository and build the source with `gem build vSphere.gemspec`.
 After the gem is built, run the plugin install command from the build directory.
 
-### Potential Intallation Problems
+### Potential Installation Problems
 
-The requirements for [Nokogiri](http://nokogiri.org/) must be installed before the plugin can be installed. See Nokogiri's [tutorial](http://nokogiri.org/tutorials/installing_nokogiri.html) for
+The requirements for [Nokogiri](http://nokogiri.org/) must be installed before the plugin can be installed. See the [Nokogiri tutorial](http://nokogiri.org/tutorials/installing_nokogiri.html) for
 detailed instructions.
 
 The plugin forces use of Nokogiri ~> 1.5 to prevent conflicts with older versions of system libraries, specifically zlib.
@@ -43,8 +43,8 @@ The plugin forces use of Nokogiri ~> 1.5 to prevent conflicts with older version
 After installing the plugin, you must create a vSphere box. The example_box directory contains a metadata.json file
 that can be used to create a dummy box with the command:
 
-```
-$ tar cvzf dummy.box ./metadata.json
+```bash
+tar cvzf dummy.box ./metadata.json
 ```
 
 This can be installed using the standard Vagrant methods or specified in the Vagrantfile.
@@ -77,7 +77,8 @@ and the Vagrant [AWS provider](https://github.com/mitchellh/vagrant-aws/tree/mas
 
 ### Supported Commands
 
-Currently the only implemented actions are `up`, `halt`, `destroy`, and `ssh`.
+Currently the only implemented actions are `up`, `halt`, `reload`, `destroy`,
+and `ssh`.
 
 `up` supports provisioning of the new VM with the standard Vagrant provisioners.
 
@@ -97,7 +98,7 @@ This provider has the following settings, all are required unless noted:
 * `resource_pool_name` - the resource pool for the new VM. If not supplied, and cloning from a template, uses the root resource pool
 * `clone_from_vm` - _Optional_ use a virtual machine instead of a template as the source for the cloning operation
 * `template_name` - the VM or VM template to clone
-* `vm_base_path` - _Optional_ path to folder where new VM sould be created, if not specified template's parent folder will be used
+* `vm_base_path` - _Optional_ path to folder where new VM should be created, if not specified template's parent folder will be used
 * `name` - _Optional_ name of the new VM, if missing the name will be auto generated
 * `customization_spec_name` - _Optional_ customization spec for the new VM
 * `data_store_name` - _Optional_ the datastore where the VM will be located
@@ -107,11 +108,34 @@ This provider has the following settings, all are required unless noted:
 * `vlan` - _Optional_ vlan to connect the first NIC to
 * `memory_mb` - _Optional_ Configure the amount of memory (in MB) for the new VM
 * `cpu_count` - _Optional_ Configure the number of CPUs for the new VM
+* `mac` - _Optional_ Used to set the mac address of the new VM
 
 ### Cloning from a VM rather than a template
 
 To clone from an existing VM rather than a template, set `clone_from_vm` to true. If this value is set, `compute_resource_name` and `resource_pool_name` are not required.
 
+### Template_Name
+
+* The template name includes the actual template name and the directory path containing the template.
+* **For example:** if the template is a directory called **vagrant-templates** and the template is called **ubuntu-lucid-template** the `template_name` setting would be:
+```
+vsphere.template_name = "vagrant-templates/ubuntu-lucid-template"
+```
+![Vagrant Vsphere Screenshot](https://raw.githubusercontent.com/nsidc/vagrant-vsphere/master/vsphere_screenshot.png)
+
+
+### VM_Base_Path
+
+* The new vagrant VM will be created in the same directory as the template it originated from.
+* To create the VM in a directory other than the one where the template was located, include the **vm_base_path** setting.
+* **For example:** if the machines will be stored in a directory called **vagrant-machines** the `vm_base_path` would be:
+```
+vsphere.vm_base_path = "vagrant-machines"
+```
+
+![Vagrant Vsphere Screenshot](https://raw.githubusercontent.com/nsidc/vagrant-vsphere/master/vsphere_screenshot.png)
+
+
 ### Setting a static IP address
 
 To set a static IP, add a private network to your vagrant file:
@@ -128,12 +152,67 @@ The name for the new VM will be automagically generated from the Vagrant machine
 
 This is useful if running Vagrant from multiple directories or if multiple machines are defined in the Vagrantfile.
 
+### Setting the MAC address
+
+To set a static MAC address, add a `vsphere.mac` to your `Vagrantfile`:
+
+```ruby
+vsphere.mac = '00:50:56:XX:YY:ZZ'
+```
+
+Take care to avoid using invalid or duplicate VMware MAC addresses, as this can
+easily break networking.
+
+## Example Usage
+
+### FILE: Vagrantfile
+```ruby
+VAGRANT_INSTANCE_NAME   = "vagrant-vsphere"
+
+Vagrant.configure("2") do |config|
+  config.vm.box     = 'vsphere'
+  config.vm.box_url = 'https://vagrantcloud.com/ssx/boxes/vsphere-dummy/versions/0.0.1/providers/vsphere.box'
+
+  config.vm.hostname = VAGRANT_INSTANCE_NAME
+  config.vm.define VAGRANT_INSTANCE_NAME do |d|
+  end
+
+  config.vm.provider :vsphere do |vsphere|
+    vsphere.host                  = 'vsphere.local'
+    vsphere.name                  = VAGRANT_INSTANCE_NAME
+    vsphere.compute_resource_name = 'vagrant01.vsphere.local'
+    vsphere.resource_pool_name    = 'vagrant'
+    vsphere.template_name         = 'vagrant-templates/ubuntu14041'
+    vsphere.vm_base_path          = "vagrant-machines"
+
+    vsphere.user     = 'vagrant-user@vsphere'
+    vsphere.password = '***************'
+    vsphere.insecure = true
+  end
+end
+```
+
+### Vagrant Up
+```bash
+vagrant up --provider=vsphere
+```
+
+### Vagrant SSH
+```bash
+vagrant ssh
+```
+
+### Vagrant Destroy
+```bash
+vagrant destroy
+```
+
 ## Version History
 * 0.0.1
   * Initial release
 * 0.1.0
   * Add folder syncing with guest OS
-  * Add provisoning
+  * Add provisioning
 * 0.2.0
   * Merge halt action from [catharsis](https://github.com/catharsis)
 * 0.3.0
@@ -182,7 +261,9 @@ This is useful if running Vagrant from multiple directories or if multiple machi
   * Instruct vagrant to set the guest hostname according to Vagrantfile [#69 ddub:set-hostname](https://github.com/nsidc/vagrant-vsphere/pull/69)
 * 0.10.0
   * new optional parameter to clone into custom folder in vSphere [#73 mikola-spb:vm-base-path](https://github.com/nsidc/vagrant-vsphere/pull/73)
-  * follows semvar better, this adds functionality in a backwards compatible way, so bumps the minor. 0.9.0, should have been a major version.
+  * follows [semver](http://semver.org/) better, this adds functionality in a
+    backwards compatible way, so bumps the minor. 0.9.0, should have been a
+    major version.
 * 0.11.0
   * Create the VM target folder if it doesn't exist #76 marnovdm:feature/create_vm_folder.
 * 0.12.0
@@ -210,6 +291,12 @@ This is useful if running Vagrant from multiple directories or if multiple machi
   * Fix compatibility with Vagrant 1.7 to use vSphere connection info from a base
     box
     [#111 mkuzmin:get-state](https://github.com/nsidc/vagrant-vsphere/pull/111).
+* 0.18.0
+  * Gracefully power off the VM with `vagrant halt`, and shutdown before
+    deleting the VM with `vagrant destroy`
+    [#104 clintoncwolfe:shutdown-guest-on-halt](https://github.com/nsidc/vagrant-vsphere/pull/104).
+  * Add configuration option `mac` to specify a MAC address for the VM
+    [#108 dataplayer:master](https://github.com/nsidc/vagrant-vsphere/pull/108).
 
 ## Versioning
 

data/lib/vSphere/action.rb

@@ -11,10 +11,14 @@ module VagrantPlugins
         Vagrant::Action::Builder.new.tap do |b|
           b.use ConfigValidate
           b.use ConnectVSphere
+
           b.use Call, IsRunning do |env, b2|
             if [:result]
-                b2.use PowerOff
-                next
+              b2.use Call, GracefulHalt, :poweroff, :running do |env, b3|
+                if !env[:result]
+                  b3.use PowerOff
+                end
+              end
             end
           end
           b.use Destroy
@@ -126,7 +130,11 @@ module VagrantPlugins
                 next
               end
 
-              b3.use PowerOff
+              b3.use Call, GracefulHalt, :poweroff, :running do |env, b4|
+                if !env[:result]
+                  b4.use PowerOff
+                end
+              end
             end
           end
           b.use CloseVSphere

data/lib/vSphere/action/clone.rb

@@ -32,6 +32,7 @@ module VagrantPlugins
             customization_info = get_customization_spec_info_by_name connection, machine
 
             spec[:customization] = get_customization_spec(machine, customization_info) unless customization_info.nil?
+            add_custom_mac(template, spec, config.mac) unless config.mac.nil?
             add_custom_vlan(template, dc, spec, config.vlan) unless config.vlan.nil?
             add_custom_memory(spec, config.memory_mb) unless config.memory_mb.nil?
             add_custom_cpu(spec, config.cpu_count) unless config.cpu_count.nil?
@@ -139,20 +140,37 @@ module VagrantPlugins
           end
         end
 
+        def modify_network_card(template, spec)
+          spec[:config][:deviceChange] ||= []
+          @card ||= template.config.hardware.device.grep(RbVmomi::VIM::VirtualEthernetCard).first
+
+          fail Errors::VSphereError, :missing_network_card if @card.nil?
+
+          yield(@card)
+
+          dev_spec = RbVmomi::VIM.VirtualDeviceConfigSpec(:device => @card, :operation => "edit")
+          spec[:config][:deviceChange].push dev_spec
+          spec[:config][:deviceChange].uniq!
+        end
+
+        def add_custom_mac(template, spec, mac)
+          modify_network_card(template, spec) do |card|
+            card.macAddress = mac
+          end
+        end
+
         def add_custom_vlan(template, dc, spec, vlan)
-          spec[:config][:deviceChange] = []
           network = get_network_by_name(dc, vlan)
-          config = template.config
-          card = config.hardware.device.grep(RbVmomi::VIM::VirtualEthernetCard).first or fail Errors::VSphereError, :missing_network_card
-          begin
-            switch_port = RbVmomi::VIM.DistributedVirtualSwitchPortConnection(:switchUuid => network.config.distributedVirtualSwitch.uuid, :portgroupKey => network.key)
-            card.backing.port = switch_port
-          rescue
-            # not connected to a distibuted switch?
-            card.backing.deviceName = network.name
+
+          modify_network_card(template, spec) do |card|
+            begin
+              switch_port = RbVmomi::VIM.DistributedVirtualSwitchPortConnection(:switchUuid => network.config.distributedVirtualSwitch.uuid, :portgroupKey => network.key)
+              card.backing.port = switch_port
+            rescue
+              # not connected to a distibuted switch?
+              card.backing = RbVmomi::VIM::VirtualEthernetCardNetworkBackingInfo(:network => network, :deviceName => network.name)
+            end
           end
-          dev_spec = RbVmomi::VIM.VirtualDeviceConfigSpec(:device => card, :operation => "edit")
-          spec[:config][:deviceChange].push dev_spec
         end
 
         def add_custom_memory(spec, memory_mb)

data/lib/vSphere/config.rb

@@ -20,6 +20,7 @@ module VagrantPlugins
       attr_accessor :proxy_host
       attr_accessor :proxy_port
       attr_accessor :vlan
+      attr_accessor :mac
       attr_accessor :memory_mb
       attr_accessor :cpu_count
 

data/lib/vSphere/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module VSphere
-    VERSION = '0.17.0'
+    VERSION = '0.18.0'
   end
 end

data/spec/action_spec.rb

@@ -69,12 +69,17 @@ describe VagrantPlugins::VSphere::Action do
   end
 
   describe 'halt' do
-    it 'should power off the VM' do
-      @machine.state.stub(:id).and_return(:running)
+    after :each do
+      run :halt
+    end
 
-      VagrantPlugins::VSphere::Action::PowerOff.any_instance.should_receive(:call)
+    it 'should connect to vSphere' do
+      VagrantPlugins::VSphere::Action::ConnectVSphere.any_instance.should_receive(:call)
+    end
 
-      run :halt
+    it 'should gracefully power off the VM' do
+      @machine.state.stub(:id).and_return(:running)
+      VagrantPlugins::VSphere::Action::GracefulHalt.any_instance.should_receive(:call)
     end
   end
 
@@ -125,10 +130,10 @@ describe VagrantPlugins::VSphere::Action do
       run :reload
     end
 
-    it 'should power off the VM' do
+    it 'should gracefully power off the VM' do
       @machine.state.stub(:id).and_return(:running)
 
-      VagrantPlugins::VSphere::Action::PowerOff.any_instance.should_receive(:call)
+      VagrantPlugins::VSphere::Action::GracefulHalt.any_instance.should_receive(:call)
     end
 
     it 'should connect to vSphere' do

data/spec/spec_helper.rb

@@ -55,7 +55,8 @@ RSpec.configure do |config|
         :proxy_port => nil,
         :vlan => nil,
         :memory_mb => nil,
-        :cpu_count => nil)
+        :cpu_count => nil,
+        :mac => nil)
     vm_config = double(
       :vm => double('config_vm',
                     :box => nil,
@@ -63,7 +64,8 @@ RSpec.configure do |config|
                     :provisioners => [],
                     :hostname => nil,
                     :communicator => nil,
-                    :networks => [[:private_network, {:ip => '0.0.0.0'}]]),
+                    :networks => [[:private_network, {:ip => '0.0.0.0'}]],
+                    :graceful_halt_timeout => 0.1),
       :validate => []
     )
     @app = double 'app', :call => true
@@ -75,12 +77,13 @@ RSpec.configure do |config|
                       :ssh_info => {},
                       :data_dir => Pathname.new(''),
                       :id => nil,
-                      :id= => nil
+                      :id= => nil,
+                      :guest => double('guest', :capability => nil)
 
 
     @env = {
         :machine => @machine,
-        :ui => double('ui', :info => nil)
+        :ui => double('ui', :info => nil, :output => nil)
     }
 
     @vm = double('vm',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vsphere
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Andrew Grauch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-30 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -157,6 +157,7 @@ files:
 - spec/power_off_spec.rb
 - spec/spec_helper.rb
 - vSphere.gemspec
+- vsphere_screenshot.png
 homepage: ''
 licenses:
 - MIT