vagrant-vsphere 0.5.0

data/.gitignore

@@ -0,0 +1,6 @@
+*~
+.vagrant/*
+Vagrantfile
+pkg/*
+*.box
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,10 @@
+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
+  # Vagrant environment itself using `vagrant plugin`.
+  gem 'vagrant', :git => 'git://github.com/mitchellh/vagrant.git'
+end

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2013 Regents of the University of Colorado
+
+This software was developed by the National Snow and Ice Data Center with funding from multiple sources.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,151 @@
+# Vagrant vSphere Provider
+
+This is a [Vagrant](http://www.vagrantup.com) 1.2+ plugin that adds a [vSphere](http://pubs.vmware.com/vsphere-50/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc_50%2Fright-pane.html)
+provider to Vagrant, allowing Vagrant to control and provision machines using VMware. New machines are created from virtual machines or templates which must be configured prior to using using this provider.
+
+This provider is built on top of the [RbVmomi](https://github.com/vmware/rbvmomi) Ruby interface to the vSphere API.
+
+## Requirements
+* Vagrant 1.2+
+* VMware + vSphere API
+* Ruby 1.9+
+* libxml2, libxml2-dev, libxslt, libxslt-dev
+
+## Building the gem
+
+The gem needs to be built before the provider can be added to Vagrant:
+
+```
+gem build vSphere.gemspec
+```
+
+## Installation
+
+Install using standard Vagrant plugin method:
+
+```
+$ vagrant plugin install vagrant-vsphere
+```
+
+This command needs to be run in vagrant-vsphere build directory so that vagrant can find the gem.
+
+### Potential Intallation 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 
+detailed instructions. 
+
+The plugin forces use of Nokogiri 1.5.10 to prevent conflicts with older versions of system libraries, specifically zlib.
+
+## Usage
+
+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
+```
+
+This can be installed using the standard Vagrant methods or specified in the Vagrantfile.
+
+After creating the dummy box, make a Vagrantfile that looks like the following:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = 'dummy'
+  config.vm.box_url = './example_box/dummy.box'
+
+  config.vm.provider :vsphere do |vsphere|
+    vsphere.host = 'HOST NAME OF YOUR VSPHERE INSTANCE'
+    vsphere.compute_resource_name = 'YOUR COMPUTE RESOURCE'
+    vsphere.resource_pool_name = 'YOUR RESOURCE POOL'
+    vsphere.template_name = 'YOUR VM TEMPLATE'
+    vsphere.name = 'NEW VM NAME'
+    vsphere.user = 'YOUR VMWARE USER'
+    vsphere.password = 'YOUR VMWARE PASSWORD'
+  end
+end
+```
+
+And then run `vagrant up --provider=vsphere`.
+
+### Custom Box
+
+The bulk of this configuration can be included as part of a custom box. See the [Vagrant documentation](http://docs.vagrantup.com/v2/boxes.html)
+and the Vagrant [AWS provider](https://github.com/mitchellh/vagrant-aws/tree/master/example_box) for more information and an example.
+
+### Supported Commands
+
+Currently the only implemented actions are `up`, `halt`, `destroy`, and `ssh`.
+
+`up` supports provisioning of the new VM with the standard Vagrant provisioners.
+
+
+## Configuration
+
+This provider has the following settings, all are required unless noted:
+
+* `host` -  IP or name for the vSphere API
+* `insecure` - _Optional_ verify SSL certificate from the host
+* `user' - user name for connecting to vSphere
+* `password` - password  for connecting to vSphere
+* `data_center_name` - _Optional_ datacenter containing the computed resource, the template and where the new VM will be created, if not specified the first datacenter found will be used
+* `compute_resource_name` - _Required if cloning from template_ the name of the host containing the resource pool for the new VM
+* `resource_pool_name` - _Required if cloning from template_ the resource pool for the new VM
+* `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
+* `name` - name of the new VM
+* `customization_spec_name` - _Optional_ customization spec for the new VM
+* `data_store_name` - _Optional_ the datastore where the VM will be located
+
+### 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` not required.
+
+### Setting a static IP address
+
+To set a static IP, add a private network to your vagrant file:
+
+```ruby
+config.vm.network 'private_network', ip: '192.168.50.4'
+```
+
+The IP address will only be set if a customization spec name is given. The customization spec must have network adapter settings configured. For each private network specified, there needs to be a corresponding network adapter in the customization spec. An error  will be thrown if there are more networks than adapters.
+
+## Version History
+* 0.0.1
+  * Initial release
+* 0.1.0
+  * Add folder syncing with guest OS
+  * Add provisoning
+* 0.2.0
+  * Merge halt action from [catharsis](https://github.com/catharsis)
+* 0.3.0
+  * Lock Nokogiri version at 1.5.10 to prevent library conflicts
+  * Add support for customization specs
+* 0.4.0
+  * Add support for specifying datastore location for new VMs
+* 0.5.0
+  * Allow setting static ip addresses using Vagrant private networks
+  * Allow cloning from VM or template
+
+## Versioning
+
+This plugin follows the principles of [Semantic Versioning 2.0.0](http://semver.org/)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+GI-Cat Driver is licensed under the MIT license. See [LICENSE.txt][license].
+
+[license]: https://raw.github.com/nsidc/vagrant-vsphere/master/LICENSE.txt
+
+## Credit
+
+This software was developed by the National Snow and Ice Data Center with funding from multiple sources.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path('../', __FILE__))
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new
+
+task :default => 'spec'

data/example_box/metadata.json

@@ -0,0 +1,3 @@
+{
+  "provider": "vSphere"
+}

data/lib/vSphere/action/clone.rb

@@ -0,0 +1,83 @@
+require 'rbvmomi'
+require 'i18n'
+require 'vSphere/util/vim_helpers'
+require 'vSphere/util/machine_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class Clone
+        include Util::VimHelpers
+        include Util::MachineHelpers
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          config = env[:machine].provider_config          
+          connection = env[:vSphere_connection]
+          machine = env[:machine]
+          
+          dc = get_datacenter connection, machine
+          template = dc.find_vm config.template_name
+
+          raise Error::VSphereError, :message => I18n.t('errors.missing_template') if template.nil?
+
+          begin
+            location = RbVmomi::VIM.VirtualMachineRelocateSpec
+            location[:pool] = get_resource_pool(connection, machine) unless config.clone_from_vm
+            
+            datastore = get_datastore connection, machine
+            location[:datastore] = datastore unless datastore.nil?
+            
+            spec = RbVmomi::VIM.VirtualMachineCloneSpec :location => location, :powerOn => true, :template => false
+            
+            customization = get_customization_spec_info_by_name connection, machine
+            spec[:customization] = configure_networks(customization.spec, machine) unless customization.nil?
+            
+            env[:ui].info I18n.t('vsphere.creating_cloned_vm')
+            env[:ui].info " -- #{config.clone_from_vm ? "Source" : "Template"} VM: #{config.template_name}"
+            env[:ui].info " -- Name: #{config.name}"
+
+            new_vm = template.CloneVM_Task(:folder => template.parent, :name => config.name, :spec => spec).wait_for_completion
+          rescue Exception => e
+            puts e.message
+            raise Errors::VSphereError, :message => e.message
+          end
+
+          #TODO: handle interrupted status in the environment, should the vm be destroyed?
+
+          machine.id = new_vm.config.uuid
+          
+          # wait for SSH to be available 
+          wait_for_ssh env
+          
+          env[:ui].info I18n.t('vsphere.vm_clone_success')          
+            
+          @app.call env
+        end
+        
+        private
+        
+        def configure_networks(spec, machine)
+          customization_spec = spec.clone
+          
+          # find all the configured private networks
+          private_networks = machine.config.vm.networks.find_all { |n| n[0].eql? :private_network }
+          return customization_spec if private_networks.nil?
+          
+          # make sure we have enough NIC settings to override with the private network settings
+          raise Error::VSphereError, :message => I18n.t('errors.too_many_private_networks') if private_networks.length > customization_spec.nicSettingMap.length
+          
+          # assign the private network IP to the NIC
+          private_networks.each_index do |idx|
+            customization_spec.nicSettingMap[idx].adapter.ip.ipAddress = private_networks[idx][1][:ip]  
+          end
+          
+          customization_spec
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/close_vsphere.rb

@@ -0,0 +1,24 @@
+require 'rbvmomi'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class CloseVSphere
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          begin
+            env[:vSphere_connection].close
+            @app.call env
+          rescue Exception => e
+            puts e
+            #raise a properly namespaced error for Vagrant
+            raise Errors::VSphereError, :message => e.message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/connect_vsphere.rb

@@ -0,0 +1,25 @@
+require 'rbvmomi'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class ConnectVSphere
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          config = env[:machine].provider_config
+
+          begin
+            env[:vSphere_connection] = RbVmomi::VIM.connect host: config.host, user: config.user, password: config.password, insecure: config.insecure
+            @app.call env
+          rescue Exception => e
+            puts e.backtrace
+            raise VagrantPlugins::VSphere::Errors::VSphereError, :message => e.message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/destroy.rb

@@ -0,0 +1,38 @@
+require 'rbvmomi'
+require 'i18n'
+require 'vSphere/util/vim_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class Destroy
+        include Util::VimHelpers
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          destroy_vm env
+          env[:machine].id = nil
+
+          @app.call env
+        end
+
+        private 
+        
+        def destroy_vm(env)
+          vm = get_vm_by_uuid env[:vSphere_connection], env[:machine]
+          return if vm.nil?
+
+          begin
+            env[:ui].info I18n.t('vsphere.destroy_vm')
+            vm.Destroy_Task.wait_for_completion
+          rescue Exception => e
+            raise Errors::VSphereError, :message => e.message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/get_ssh_info.rb

@@ -0,0 +1,38 @@
+require 'rbvmomi'
+require 'vSphere/util/vim_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class GetSshInfo
+        include Util::VimHelpers
+
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:machine_ssh_info] = get_ssh_info(env[:vSphere_connection], env[:machine])
+
+          @app.call env
+        end
+
+        private
+
+        def get_ssh_info(connection, machine)
+          return nil if machine.id.nil?
+
+          vm = get_vm_by_uuid connection, machine
+
+          return nil if vm.nil?
+
+          return {
+              :host => vm.guest.ipAddress,
+              :port => 22
+          }
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/get_state.rb

@@ -0,0 +1,46 @@
+require 'rbvmomi'
+require 'vSphere/util/vim_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'
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:machine_state_id] = get_state(env[:vSphere_connection], env[:machine])
+
+          @app.call env
+        end
+
+        private
+
+        def get_state(connection, machine)
+          return :not_created  if machine.id.nil?
+
+          vm = get_vm_by_uuid connection, machine
+
+          if vm.nil?
+            return :not_created
+          end
+
+          if vm.runtime.powerState.eql?(POWERED_ON)
+            :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
+            :poweroff
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/is_created.rb

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

data/lib/vSphere/action/is_running.rb

@@ -0,0 +1,20 @@
+require 'vSphere/util/machine_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class IsRunning
+        include Util::MachineHelpers
+        
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id == :running
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/message_already_created.rb

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

data/lib/vSphere/action/message_not_created.rb

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

data/lib/vSphere/action/message_not_running.rb

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

data/lib/vSphere/action/power_off.rb

@@ -0,0 +1,28 @@
+require 'rbvmomi'
+require 'i18n'
+require 'vSphere/util/vim_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class PowerOff
+        include Util::VimHelpers
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          vm = get_vm_by_uuid env[:vSphere_connection], env[:machine]
+
+          unless vm.nil?
+            env[:ui].info I18n.t('vsphere.power_off_vm')
+            vm.PowerOffVM_Task.wait_for_completion
+          end
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/power_on.rb

@@ -0,0 +1,31 @@
+require 'rbvmomi'
+require 'i18n'
+require 'vSphere/util/vim_helpers'
+require 'vSphere/util/machine_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class PowerOn
+        include Util::VimHelpers
+        include Util::MachineHelpers
+
+        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('vsphere.power_on_vm')
+          vm.PowerOnVM_Task.wait_for_completion
+          
+          # wait for SSH to be available 
+          wait_for_ssh env
+          
+          @app.call env
+        end
+      end
+    end
+  end
+end