djo-vagrant-vsphere 1.6.1

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,64 @@
+en:
+  vsphere:
+    creating_cloned_vm: |-
+      Calling vSphere CloneVM with the following settings:
+    creating_cloned_vm_sdrs: |-
+      Calling vSphere ApplyStorageDrsRecommendation with the following settings:
+    requesting_sdrs_recommendation: |-
+      Calling vSphere RecommendDatastores with StoragePlacementSpec of the following settings:
+    vm_clone_success: |-
+      New virtual machine successfully cloned
+    destroy_vm: |-
+      Calling vSphere 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
+
+    errors:
+      missing_template: |-
+        Configured template/source VM could not be found
+      invalid_base_path: |-
+        Could not find base path for target VM, check 'vm_base_path' configuration value
+      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
+      too_many_private_networks: |-
+        There a more private networks configured than can be assigned to the customization spec
+      missing_vlan: |-
+        Configured vlan not found
+      missing_network_card: |-
+        Cannot find network card to customize
+      invalid_configuration_linked_clone_with_sdrs: |-
+        Cannot use Linked Clone with Storage DRS
+
+    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,162 @@
+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
+      @machine.state.stub(:id).and_return(:running)
+      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
+    after :each do
+      run :halt
+    end
+
+    it 'should connect to vSphere' do
+      VagrantPlugins::VSphere::Action::ConnectVSphere.any_instance.should_receive(:call)
+    end
+
+    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
+
+  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
+
+    it 'should handle the values in a base vagrant box' do
+      Vagrant::Action::Builtin::HandleBox.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
+
+  describe 'reload' do
+    after :each do
+      run :reload
+    end
+
+    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
+
+    it 'should connect to vSphere' do
+      VagrantPlugins::VSphere::Action::ConnectVSphere.any_instance.should_receive(:call)
+    end
+
+    it 'should check if the VM exits' do
+      VagrantPlugins::VSphere::Action::IsCreated.any_instance.should_receive(:call)
+    end
+
+    it 'should not 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_not_receive(:call)
+      VagrantPlugins::VSphere::Action::MessageNotCreated.any_instance.should_receive(:call)
+    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)
+      VagrantPlugins::VSphere::Action::MessageAlreadyCreated.any_instance.should_receive(:call)
+    end
+  end
+end

data/spec/clone_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+CUSTOM_VM_FOLDER = 'custom_vm_folder'
+
+describe VagrantPlugins::VSphere::Action::Clone do
+  before :each do
+    @env[:vSphere_connection] = @vim
+  end
+
+  it "should create a CloneVM task with template's parent" do
+    call
+    expect(@template).to have_received(:CloneVM_Task).with(
+      folder: @data_center,
+      name: NAME,
+      spec: { location: { pool: @child_resource_pool },
+              config: RbVmomi::VIM.VirtualMachineConfigSpec }
+    )
+  end
+
+  it 'should create a CloneVM task with custom folder when given vm base path' do
+    custom_base_folder = double(CUSTOM_VM_FOLDER,
+                                pretty_path: "#{@data_center.pretty_path}/#{CUSTOM_VM_FOLDER}")
+    @machine.provider_config.stub(:vm_base_path).and_return(CUSTOM_VM_FOLDER)
+    @data_center.vmFolder.stub(:traverse).with(CUSTOM_VM_FOLDER, RbVmomi::VIM::Folder, true).and_return(custom_base_folder)
+    call
+    expect(@template).to have_received(:CloneVM_Task).with(
+      folder: custom_base_folder,
+      name: NAME,
+      spec: { location: { pool: @child_resource_pool },
+              config: RbVmomi::VIM.VirtualMachineConfigSpec }
+    )
+  end
+
+  it 'should set the machine id to be the new UUID' do
+    call
+    expect(@machine).to have_received(:id=).with(NEW_UUID)
+  end
+
+  it 'should call the next item in the middleware stack' do
+    call
+    expect(@app).to have_received :call
+  end
+
+  it 'should create a CloneVM spec with configured vlan' do
+    @machine.provider_config.stub(:vlan).and_return('vlan')
+    network = double('network', name: 'vlan')
+    network.stub(:config).and_raise(StandardError)
+    @data_center.stub(:network).and_return([network])
+    call
+
+    expected_config = RbVmomi::VIM.VirtualMachineConfigSpec(deviceChange: Array.new)
+    expected_dev_spec = RbVmomi::VIM.VirtualDeviceConfigSpec(device: @device, operation: 'edit')
+    expected_config[:deviceChange].push expected_dev_spec
+
+    expect(@template).to have_received(:CloneVM_Task).with(
+      folder: @data_center,
+      name: NAME,
+      spec: { location:         { pool: @child_resource_pool },
+              config: expected_config
+      }
+    )
+  end
+
+  it 'should create a CloneVM spec with configured memory_mb' do
+    @machine.provider_config.stub(:memory_mb).and_return(2048)
+    call
+    expect(@template).to have_received(:CloneVM_Task).with(
+      folder: @data_center,
+      name: NAME,
+      spec: { location: { pool: @child_resource_pool },
+              config: RbVmomi::VIM.VirtualMachineConfigSpec(memoryMB: 2048) }
+    )
+  end
+
+  it 'should create a CloneVM spec with configured number of cpus' do
+    @machine.provider_config.stub(:cpu_count).and_return(4)
+    call
+    expect(@template).to have_received(:CloneVM_Task).with(
+      folder: @data_center,
+      name: NAME,
+      spec: { location: { pool: @child_resource_pool },
+              config: RbVmomi::VIM.VirtualMachineConfigSpec(numCPUs: 4) }
+    )
+  end
+
+  it 'should set static IP when given config spec' do
+    @machine.provider_config.stub(:customization_spec_name).and_return('spec')
+    call
+    expect(@ip).to have_received(:ipAddress=).with('0.0.0.0')
+  end
+
+  it 'should use root resource pool when cloning from template and no resource pool specified' do
+    @machine.provider_config.stub(:resource_pool_name).and_return(nil)
+    call
+    expect(@template).to have_received(:CloneVM_Task).with(
+      folder: @data_center,
+      name: NAME,
+      spec: { location: { pool: @root_resource_pool },
+              config: RbVmomi::VIM.VirtualMachineConfigSpec }
+    )
+  end
+end

data/spec/connect_vsphere_spec.rb

@@ -0,0 +1,26 @@
+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
+    expect(VIM).to 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,
+      proxyHost: @env[:machine].provider_config.proxy_host,
+      proxyPort: @env[:machine].provider_config.proxy_port
+    )
+  end
+
+  it 'should add the vSphere connection to the environment' do
+    expect(@env[:vSphere_connection]).to be @vim
+  end
+
+  it 'should call the next item in the middleware stack' do
+    expect(@app).to 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
+
+    expect(@env[:machine]).to 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
+
+    expect(@vm).not_to 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
+
+    expect(@vm).to have_received :Destroy_Task
+  end
+end

data/spec/get_ssh_info_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe VagrantPlugins::VSphere::Action::GetSshInfo do
+  before :each do
+    @env[:vSphere_connection] = @vim
+  end
+
+  it 'should set the ssh info to nil if machine ID is not set' do
+    call
+
+    expect(@env.key?(:machine_ssh_info)).to be true
+    expect(@env[:machine_ssh_info]).to be nil
+  end
+
+  it 'should set the ssh info to nil for a VM that does not exist' do
+    @env[:machine].stub(:id).and_return(MISSING_UUID)
+
+    call
+
+    expect(@env.key?(:machine_ssh_info)).to be true
+    expect(@env[:machine_ssh_info]).to be nil
+  end
+
+  it 'should set the ssh info host to the IP an existing VM' do
+    @env[:machine].stub(:id).and_return(EXISTING_UUID)
+
+    call
+
+    expect(@env[:machine_ssh_info][:host]).to be IP_ADDRESS
+  end
+end

data/spec/get_state_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'vSphere/util/vim_helpers'
+
+describe VagrantPlugins::VSphere::Action::GetState do
+  before :each do
+    @env[:vSphere_connection] = @vim
+  end
+
+  it 'should set state id to not created if machine ID is not set' do
+    call
+
+    expect(@env[:machine_state_id]).to be :not_created
+  end
+
+  it 'should set state id to not created if VM is not found' do
+    @env[:machine].stub(:id).and_return(MISSING_UUID)
+
+    call
+
+    expect(@env[:machine_state_id]).to be :not_created
+  end
+
+  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(VagrantPlugins::VSphere::Util::VmState::POWERED_ON)
+
+    call
+
+    expect(@env[:machine_state_id]).to be :running
+  end
+
+  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(VagrantPlugins::VSphere::Util::VmState::POWERED_OFF)
+
+    call
+
+    expect(@env[:machine_state_id]).to be :poweroff
+  end
+
+  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(VagrantPlugins::VSphere::Util::VmState::SUSPENDED)
+
+    call
+
+    expect(@env[:machine_state_id]).to be :poweroff
+  end
+
+  it 'should call the next item in the middleware stack' do
+    call
+
+    expect(@app).to have_received :call
+  end
+end