djo-vagrant-vsphere 1.6.1

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 MessageNotCreated
+        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,40 @@
+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
+        end
+
+        def call(env)
+          vm = get_vm_by_uuid env[:vSphere_connection], env[:machine]
+
+          # 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')
+            power_off_vm(vm)
+          end
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/action/power_on.rb

@@ -0,0 +1,28 @@
+require 'rbvmomi'
+require 'i18n'
+require 'vSphere/util/vim_helpers'
+require 'vSphere/util/vm_helpers'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class PowerOn
+        include Util::VimHelpers
+        include Util::VmHelpers
+
+        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')
+          power_on_vm(vm)
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/cap/public_address.rb

@@ -0,0 +1,15 @@
+module VagrantPlugins
+  module VSphere
+    module Cap
+      module PublicAddress
+        def self.public_address(machine)
+          return nil if machine.state.id != :running
+
+          ssh_info = machine.ssh_info
+          return nil unless ssh_info
+          ssh_info[:host]
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/config.rb

@@ -0,0 +1,60 @@
+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 :vm_base_path
+      attr_accessor :customization_spec_name
+      attr_accessor :data_store_name
+      attr_accessor :linked_clone
+      attr_accessor :proxy_host
+      attr_accessor :proxy_port
+      attr_accessor :vlan
+      attr_accessor :addressType
+      attr_accessor :mac
+      attr_accessor :memory_mb
+      attr_accessor :cpu_count
+      attr_accessor :cpu_reservation
+      attr_accessor :mem_reservation
+
+      attr_reader :custom_attributes
+
+      def initialize
+        @custom_attributes = {}
+      end
+
+      def custom_attribute(key, value)
+        @custom_attributes[key.to_sym] = value
+      end
+
+      def validate(machine)
+        errors = _detected_errors
+
+        if password == :ask || password.nil?
+          self.password = machine.ui.ask('vSphere Password (will be hidden): ', echo: false)
+        end
+
+        # TODO: add blank?
+        errors << I18n.t('vsphere.config.host') if host.nil?
+        errors <<  I18n.t('vsphere.config.user') if user.nil?
+        errors <<  I18n.t('vsphere.config.password') if password.nil?
+        errors <<  I18n.t('vsphere.config.template') if template_name.nil?
+
+        # Only required if we're cloning from an actual template
+        errors << I18n.t('vsphere.config.compute_resource') if compute_resource_name.nil? && !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,44 @@
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'The Vagrant vSphere plugin must be run within Vagrant.'
+end
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < '1.5'
+  fail 'The Vagrant vSphere plugin is only compatible with Vagrant 1.5+'
+end
+
+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, parallel: true) do
+        # TODO: add logging
+        setup_i18n
+
+        # Return the provider
+        require_relative 'provider'
+        Provider
+      end
+
+      provider_capability('vsphere', 'public_address') do
+        require_relative 'cap/public_address'
+        Cap::PublicAddress
+      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/vim_helpers.rb

@@ -0,0 +1,91 @@
+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) || fail(Errors::VSphereError, :missing_datacenter)
+        end
+
+        def get_vm_by_uuid(connection, machine)
+          get_datacenter(connection, machine).vmFolder.findByUuid machine.id
+        end
+
+        def get_resource_pool(datacenter, machine)
+          compute_resource = get_compute_resource(datacenter, machine)
+          rp = compute_resource.resourcePool
+          unless machine.provider_config.resource_pool_name.nil?
+            rp = compute_resource.resourcePool.find(machine.provider_config.resource_pool_name)
+            fail Errors::VSphereError, :missing_resource_pool if rp.nil?
+          end
+          rp
+        end
+
+        def get_compute_resource(datacenter, machine)
+          cr = find_clustercompute_or_compute_resource(datacenter, machine.provider_config.compute_resource_name)
+          fail Errors::VSphereError, :missing_compute_resource if cr.nil?
+          cr
+        end
+
+        def find_clustercompute_or_compute_resource(datacenter, path)
+          if path.is_a? String
+            es = path.split('/').reject(&:empty?)
+          elsif path.is_a? Enumerable
+            es = path
+          else
+            fail "unexpected path class #{path.class}"
+          end
+          return datacenter.hostFolder if es.empty?
+          final = es.pop
+
+          p = es.inject(datacenter.hostFolder) do |f, e|
+            f.find(e, RbVmomi::VIM::Folder) || return
+          end
+
+          begin
+            if (x = p.find(final, RbVmomi::VIM::ComputeResource))
+              x
+            elsif (x = p.find(final, RbVmomi::VIM::ClusterComputeResource))
+              x
+            end
+          rescue Exception
+            # When looking for the ClusterComputeResource there seems to be some parser error in RbVmomi Folder.find, try this instead
+            x = p.childEntity.find { |x2| x2.name == final }
+            if x.is_a?(RbVmomi::VIM::ClusterComputeResource) || x.is_a?(RbVmomi::VIM::ComputeResource)
+              x
+            else
+              puts 'ex unknown type ' + x.to_json
+              nil
+            end
+          end
+        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
+          fail Errors::VSphereError, :null_configuration_spec_manager if manager.nil?
+
+          spec = manager.GetCustomizationSpec(name: name)
+          fail Errors::VSphereError, :missing_configuration_spec if spec.nil?
+
+          spec
+        end
+
+        def get_datastore(datacenter, machine)
+          name = machine.provider_config.data_store_name
+          return if name.nil? || name.empty?
+
+          # find_datastore uses folder datastore that only lists Datastore and not StoragePod, if not found also try datastoreFolder which contains StoragePod(s)
+          datacenter.find_datastore(name) || datacenter.datastoreFolder.traverse(name) || fail(Errors::VSphereError, :missing_datastore)
+        end
+
+        def get_network_by_name(dc, name)
+          dc.network.find { |f| f.name == name } || fail(Errors::VSphereError, :missing_vlan)
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/util/vm_helpers.rb

@@ -0,0 +1,39 @@
+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

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