vagrant-vsphere 0.5.0

data/lib/vSphere/action/sync_folders.rb

@@ -0,0 +1,65 @@
+require 'i18n'
+require "vagrant/util/subprocess"
+require "vagrant/util/scoped_hash_override"
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      # This middleware uses `rsync` to sync the folders over to the vSphere instance
+      # Borrowed from the Vagrant AWS gem, see https://github.com/mitchellh/vagrant-aws/blob/master/lib/vagrant-aws/action/sync_folders.rb 
+      class SyncFolders
+        include Vagrant::Util::ScopedHashOverride
+
+        def initialize(app, env)
+          @app    = app
+        end
+
+        def call(env)
+          @app.call(env)
+          
+          ssh_info = env[:machine].ssh_info
+
+          env[:machine].config.vm.synced_folders.each do |id, data|
+            data = scoped_hash_override(data, :vsphere)
+
+            # Ignore disabled shared folders
+            next if data[:disabled]
+
+            hostpath  = File.expand_path(data[:hostpath], env[:root_path])
+            guestpath = data[:guestpath]
+
+            # Make sure there is a trailing slash on the host path to
+            # avoid creating an additional directory with rsync
+            hostpath = "#{hostpath}/" if hostpath !~ /\/$/
+
+            env[:ui].info(I18n.t("vsphere.rsync_folder",
+                                :hostpath => hostpath,
+                                :guestpath => guestpath))
+            
+            # Create the guest path
+            env[:machine].communicate.sudo("mkdir -p '#{guestpath}'")
+            env[:machine].communicate.sudo(
+              "chown #{ssh_info[:username]} '#{guestpath}'")
+
+            # Rsync over to the guest path using the SSH info
+            command = [
+              "rsync", "--verbose", "--archive", "-z",
+              "--exclude", ".vagrant/",
+              "-e", "ssh -p #{ssh_info[:port]} -o StrictHostKeyChecking=no -i '#{ssh_info[:private_key_path]}'",
+              hostpath,
+              "#{ssh_info[:username]}@#{ssh_info[:host]}:#{guestpath}"]
+            
+
+            r = Vagrant::Util::Subprocess.execute(*command)
+            if r.exit_code != 0
+              raise Errors::RsyncError,
+                :guestpath => guestpath,
+                :hostpath => hostpath,
+                :stderr => r.stderr
+            end            
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action.rb

@@ -0,0 +1,151 @@
+require 'vagrant'
+require 'vagrant/action/builder'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      include Vagrant::Action::Builtin
+
+      #Vagrant commands
+      def self.action_destroy
+        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
+            end
+          end
+          b.use Destroy
+        end
+      end
+
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            
+            b2.use Call, IsRunning do |env, b3|
+              if !env[:result]
+                b3.use MessageNotRunning
+                next       
+              end
+              
+              b3.use Provision
+              b3.use SyncFolders 
+            end        
+          end
+        end
+      end
+
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            
+            b2.use Call, IsRunning do |env, b3|
+              if !env[:result]
+                b3.use MessageNotRunning
+                next
+              end
+              
+              b3.use SSHExec
+            end
+          end
+        end
+      end
+
+      def self.action_up
+        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 MessageAlreadyCreated
+              next
+            end
+
+            b2.use Clone 
+          end
+          b.use Call, IsRunning do |env, b2|
+            if !env[:result]
+              b2.use PowerOn
+            end
+          end
+          b.use CloseVSphere 
+          b.use Provision          
+          b.use SyncFolders          
+        end
+      end
+
+      def self.action_halt
+        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 MessageNotCreated
+              next
+            end
+            
+            b2.use Call, IsRunning do |env, b3|
+              if !env[:result]
+                b3.use MessageNotRunning
+                next
+              end
+              
+              b3.use PowerOff
+            end
+          end
+          b.use CloseVSphere
+        end
+      end
+
+      #vSphere specific actions
+      def self.action_get_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectVSphere
+          b.use GetState
+          b.use CloseVSphere
+        end
+      end
+
+      def self.action_get_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectVSphere
+          b.use GetSshInfo
+          b.use CloseVSphere
+        end
+      end
+
+      #autoload
+      action_root = Pathname.new(File.expand_path('../action', __FILE__))
+      autoload :Clone, action_root.join('clone')
+      autoload :CloseVSphere, action_root.join('close_vsphere')
+      autoload :ConnectVSphere, action_root.join('connect_vsphere')
+      autoload :Destroy, action_root.join('destroy')
+      autoload :GetSshInfo, action_root.join('get_ssh_info')
+      autoload :GetState, action_root.join('get_state')
+      autoload :IsCreated, action_root.join('is_created')
+      autoload :IsRunning, action_root.join('is_running')
+      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 :PowerOff, action_root.join('power_off')
+      autoload :PowerOn, action_root.join('power_on')
+      autoload :SyncFolders, action_root.join('sync_folders')
+    end
+  end
+end
+

data/lib/vSphere/config.rb

@@ -0,0 +1,37 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module VSphere
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :host
+      attr_accessor :insecure
+      attr_accessor :user
+      attr_accessor :password
+      attr_accessor :data_center_name
+      attr_accessor :compute_resource_name
+      attr_accessor :resource_pool_name
+      attr_accessor :clone_from_vm
+      attr_accessor :template_name
+      attr_accessor :name
+      attr_accessor :customization_spec_name
+      attr_accessor :data_store_name
+
+      def validate(machine)
+        errors = _detected_errors
+
+        #TODO: add blank?
+        errors << I18n.t('config.host') if host.nil?
+        errors <<  I18n.t('config.user') if user.nil?
+        errors <<  I18n.t('config.password') if password.nil?
+        errors <<  I18n.t('config.name') if name.nil?
+        errors <<  I18n.t('config.template') if template_name.nil?
+
+        #These are only required if we're cloning from an actual template
+        errors << I18n.t('config.compute_resource') if compute_resource_name.nil? and not clone_from_vm
+        errors << I18n.t('config.resource_pool') if resource_pool_name.nil? and not clone_from_vm
+
+        { 'vSphere Provider' => errors }
+      end
+    end
+  end
+end

data/lib/vSphere/errors.rb

@@ -0,0 +1,11 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module VSphere
+    module Errors
+      class VSphereError < Vagrant::Errors::VagrantError
+        error_namespace('vsphere.errors')
+      end
+    end
+  end
+end

data/lib/vSphere/plugin.rb

@@ -0,0 +1,30 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module VSphere
+    class Plugin < Vagrant.plugin('2')
+      name 'vsphere'
+      description 'Allows Vagrant to manage machines with VMWare vSphere'
+
+      config(:vsphere, :provider) do
+        require_relative 'config'
+        Config
+      end
+
+      provider(:vsphere) do
+        # TODO: add logging
+        setup_i18n
+
+        # Return the provider
+        require_relative 'provider'
+        Provider
+      end
+
+
+      def self.setup_i18n
+        I18n.load_path << File.expand_path('locales/en.yml', VSphere.source_root)
+        I18n.reload!
+      end
+    end
+  end
+end

data/lib/vSphere/provider.rb

@@ -0,0 +1,39 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module VSphere
+    class Provider < Vagrant.plugin('2', :provider)
+      def initialize(machine)
+        @machine = machine
+      end
+
+      def action(name)
+        action_method = "action_#{name}"
+        return Action.send(action_method) if Action.respond_to?(action_method)
+        nil
+      end
+
+      def ssh_info
+        env = @machine.action('get_ssh_info')
+        env[:machine_ssh_info]
+      end
+
+      def state
+        env = @machine.action('get_state')
+
+        state_id = env[:machine_state_id]
+
+        short = "vagrant_vsphere.states.short_#{state_id}"
+        long  = "vagrant_vsphere.states.long_#{state_id}"
+
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, long)
+      end
+
+      def to_s
+        id = @machine.id.nil? ? 'new' : @machine.id
+        "vSphere (#{id})"
+      end
+    end
+  end
+end

data/lib/vSphere/util/machine_helpers.rb

@@ -0,0 +1,15 @@
+module VagrantPlugins
+  module VSphere
+    module Util
+      module MachineHelpers
+        def wait_for_ssh(env)
+          env[:ui].info(I18n.t("vsphere.waiting_for_ssh"))
+          while true                        
+            break if env[:machine].communicate.ready?
+            sleep 5
+          end  
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/util/vim_helpers.rb

@@ -0,0 +1,37 @@
+require 'rbvmomi'
+
+module VagrantPlugins
+  module VSphere
+    module Util
+      module VimHelpers
+        def get_datacenter(connection, machine)
+          connection.serviceInstance.find_datacenter(machine.provider_config.data_center_name) or fail Errors::VSphereError, :message => I18n.t('errors.missing_datacenter')
+        end
+
+        def get_vm_by_uuid(connection, machine)
+          get_datacenter(connection, machine).vmFolder.findByUuid machine.id
+        end
+
+        def get_resource_pool(connection, machine)
+          cr = get_datacenter(connection, machine).find_compute_resource(machine.provider_config.compute_resource_name) or fail Errors::VSphereError, :message => I18n.t('errors.missing_compute_resource')
+          cr.resourcePool.find(machine.provider_config.resource_pool_name) or fail Errors::VSphereError, :message => I18n.t('errors.missing_resource_pool')
+        end
+        
+        def get_customization_spec_info_by_name(connection, machine)
+          name = machine.provider_config.customization_spec_name
+          return if name.nil? || name.empty?
+          
+          manager = connection.serviceContent.customizationSpecManager or fail Errors::VSphereError, :message => I18n.t('errors.null_configuration_spec_manager') if manager.nil?            
+          spec = manager.GetCustomizationSpec(:name => name) or fail Errors::VSphereError, :message => I18n.t('errors.missing_configuration_spec') if spec.nil?
+        end
+        
+        def get_datastore(connection, machine)
+          name = machine.provider_config.data_store_name
+          return if name.nil? || name.empty?
+          
+          get_datacenter(connection, machine).find_datastore name or fail Errors::VSphereError, :message => I18n.t('errors.missing_datastore')
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module VSphere
+    VERSION = '0.5.0'
+  end
+end

data/lib/vagrant-vsphere.rb

@@ -0,0 +1,18 @@
+require 'pathname'
+
+require 'vSphere/plugin'
+
+module VagrantPlugins
+  module VSphere
+    lib_path = Pathname.new(File.expand_path('../vSphere', __FILE__))
+    autoload :Action, lib_path.join('action')
+    autoload :Errors, lib_path.join('errors')
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end

data/locales/en.yml

@@ -0,0 +1,61 @@
+en:
+  vsphere:
+    creating_cloned_vm: |-
+      Calling vSphere CloneVM with the following settings:
+    vm_clone_success: |-
+      New virtual machine successfully cloned and started
+    destroy_vm: |-
+      Calling vShpere Destroy
+    power_off_vm: |-
+      Calling vSphere PowerOff
+    power_on_vm: |-
+      Calling vSphere PowerOn
+    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
+    waiting_for_ssh: |-
+      Waiting for SSH to become available...
+    rsync_folder: |-
+      Rsyncing folder: %{hostpath} => %{guestpath}
+  errors:
+    missing_template: |-
+      Configured template/source VM could not be found
+    missing_datacenter: |-
+      Configured data center not found
+    missing_compute_resource: |-
+      Configured compute resource not found
+    missing_resource_pool: |-
+      Configured resource pool not found
+    null_configuration_spec_manager: |-
+      Configuration spec manager not configured in the ServiceInstance
+    missing_configuration_spec: |-
+      Configured configuration spec not found
+    missing_datastore: |-
+      Configured data store not found 
+    rsync_error: |-
+      There was an error when attemping to rsync a share folder.
+      Please inspect the error message below for more info.
+
+      Host path: %{hostpath}
+      Guest path: %{guestpath}
+      Error: %{stderr}
+    too_many_private_networks: |-
+      There a more private networks configured than can be assigned to the customization spec
+  config:
+    host: |-
+      Configuration must specify a vSphere host
+    user: |-
+      Configuration must specify a vSphere user
+    password: |-
+      Configuration must specify a vSphere password
+    name: |-
+      Configuration must specify a VM name
+    template: |-
+      Configuration must specify a template name
+    compute_resource: |-
+      Configuration must specify a compute resource name
+    resource_pool: |-
+      Configuration must specify a resource pool name

data/spec/action_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+require 'vagrant'
+
+describe VagrantPlugins::VSphere::Action do
+  def run(action)
+    Vagrant::Action::Runner.new.run described_class.send("action_#{action}"), @env
+  end
+  
+  before :each do
+    @machine.stub(:id).and_return(EXISTING_UUID)
+  end
+
+  describe 'up' do
+    def run_up
+      run :up
+    end
+
+    it 'should connect to vSphere' do
+      VagrantPlugins::VSphere::Action::ConnectVSphere.any_instance.should_receive(:call)
+
+      run_up
+    end
+
+    it 'should check if the VM exits' do
+      VagrantPlugins::VSphere::Action::IsCreated.any_instance.should_receive(:call)
+
+      run_up
+    end
+
+    it 'should create the VM when the VM does already not exist' do
+      @machine.state.stub(:id).and_return(:not_created)
+
+      VagrantPlugins::VSphere::Action::Clone.any_instance.should_receive(:call)
+
+      run_up
+    end
+
+    it 'should not create the VM when the VM already exists' do
+      @machine.state.stub(:id).and_return(:running)
+
+      VagrantPlugins::VSphere::Action::Clone.any_instance.should_not_receive(:call)
+
+      run_up
+    end
+  end
+
+  describe 'destroy' do
+    def run_destroy
+      run :destroy
+    end
+
+    it 'should connect to vSphere' do
+      VagrantPlugins::VSphere::Action::ConnectVSphere.any_instance.should_receive(:call)
+
+      run_destroy
+    end
+
+    it 'should power off the VM' do
+      VagrantPlugins::VSphere::Action::PowerOff.any_instance.should_receive(:call)
+
+      run_destroy
+    end
+
+    it 'should destroy the VM' do
+      VagrantPlugins::VSphere::Action::Destroy.any_instance.should_receive(:call)
+
+      run_destroy
+    end
+  end
+
+  describe 'halt' do
+    it 'should power off the VM' do
+      @machine.state.stub(:id).and_return(:running)
+      
+      VagrantPlugins::VSphere::Action::PowerOff.any_instance.should_receive(:call)
+
+      run :halt
+    end
+  end
+
+  describe 'get state' do
+    def run_get_state
+      run :get_state
+    end
+
+    it 'should connect to vSphere' do
+      VagrantPlugins::VSphere::Action::ConnectVSphere.any_instance.should_receive(:call)
+
+      run_get_state
+    end
+
+    it 'should get the power state' do
+      VagrantPlugins::VSphere::Action::GetState.any_instance.should_receive(:call)
+
+      run_get_state
+    end
+  end
+
+  describe 'get ssh info' do
+    def run_get_ssh_info
+      run :get_ssh_info
+    end
+
+    it 'should connect to vSphere' do
+      VagrantPlugins::VSphere::Action::ConnectVSphere.any_instance.should_receive(:call)
+
+      run_get_ssh_info
+    end
+
+    it 'should get the power state' do
+      VagrantPlugins::VSphere::Action::GetSshInfo.any_instance.should_receive(:call)
+
+      run_get_ssh_info
+    end
+  end
+end

data/spec/clone_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe VagrantPlugins::VSphere::Action::Clone do
+  before :each do
+    @env[:vSphere_connection] = @vim
+  end
+
+  it 'should create a CloneVM task' do
+    call    
+    @template.should have_received(:CloneVM_Task).with({
+      :folder => @data_center,
+      :name => NAME,
+      :spec => {}
+    })
+  end
+
+  it 'should set the machine id to be the new UUID' do
+    call
+    @machine.should have_received(:id=).with(NEW_UUID)
+  end
+
+  it 'should call the next item in the middleware stack' do
+    call
+    @app.should have_received :call
+  end
+  
+  it 'should set static IP when given config spec' do
+    @machine.provider_config.stub(:customization_spec_name).and_return('spec')
+    call
+    @ip.should have_received(:ipAddress=).with('0.0.0.0')
+  end
+end

data/spec/connect_vsphere_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe VagrantPlugins::VSphere::Action::ConnectVSphere do
+  before :each do
+    described_class.new(@app, @env).call(@env)
+  end
+
+  it 'should connect to vSphere' do
+    VIM.should have_received(:connect).with({
+      :host => @env[:machine].provider_config.host,
+      :user => @env[:machine].provider_config.user,
+      :password => @env[:machine].provider_config.password,
+      :insecure => @env[:machine].provider_config.insecure,
+    })
+  end
+
+  it 'should add the vSphere connection to the environment' do
+    @env[:vSphere_connection].should be @vim
+  end
+
+  it 'should call the next item in the middleware stack' do
+    @app.should have_received :call
+  end
+end

data/spec/destroy_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe VagrantPlugins::VSphere::Action::Destroy do
+  before :each do
+    @env[:vSphere_connection] = @vim
+  end
+
+  it 'should set the machine id to nil' do
+    @env[:machine].stub(:id).and_return(MISSING_UUID)
+
+    call
+
+    @env[:machine].should have_received(:id=).with(nil)
+  end
+
+  it 'should not create a Destroy task if VM is not found' do
+    @env[:machine].stub(:id).and_return(MISSING_UUID)
+
+    call
+
+    @vm.should_not have_received :Destroy_Task
+  end
+
+  it 'should create a VM Destroy task if the VM exists' do
+    @env[:machine].stub(:id).and_return(EXISTING_UUID)
+
+    call
+
+    @vm.should have_received :Destroy_Task
+  end
+end