vagrant-vmware-esxi 1.5.0 → 1.5.1

data/example_box/Vagrantfile-multimachine

@@ -1,5 +1,5 @@
 #
-# This is a Vagrantfile multi machine example.
+#  Multi machine, essential options Vagrant file example. (documentation removed)
 #
 
 nodes = [
@@ -7,7 +7,7 @@ nodes = [
   { hostname: 'VM-multi2', box: 'hashicorp/precise64' }
 ]
 
-Vagrant.configure("2") do |config|
+Vagrant.configure('2') do |config|
   nodes.each do |node|
     config.vm.define node[:hostname] do |node_config|
       node_config.vm.hostname = node[:hostname]
@@ -20,17 +20,14 @@ Vagrant.configure("2") do |config|
     #
     #   Provider settings
     #
-    esxi.esxi_hostname = "esxi"
-    esxi.esxi_username = "root"
-    esxi.esxi_password = "file:"
+    esxi.esxi_hostname = 'esxi'
+    esxi.esxi_username = 'root'
+    esxi.esxi_password = 'file:'
     #esxi.esxi_hostport = 22
-    #esxi.virtual_network = "vmnet_example"
-    #esxi.nic_type = 'e1000'
-    #esxi.vm_disk_store = "DS_001"
-    #esxi.vmname_prefix = "V-"
-    #esxi.memsize = "2048"
-    #esxi.numvcpus = "2"
-    #esxi.resource_pool = "/Vagrant"
-    #esxi.allow_overwrite = 'True'
+    #esxi.virtual_network = 'vmnet_example'
+    #esxi.vm_disk_store = 'DS_001'
+    #esxi.memsize = '2048'
+    #esxi.numvcpus = '2'
+    #esxi.resource_pool = '/Vagrant'
   end
 end

data/lib/vagrant-vmware-esxi/action/boot.rb

@@ -34,7 +34,7 @@ module VagrantPlugins
             env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
                                  message: 'Cannot boot in this state')
           else
-            Net::SSH.start( config.esxi_hostname, config.esxi_username,
+            Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
               keys:                       config.esxi_private_keys,

data/lib/vagrant-vmware-esxi/action/createvm.rb

@@ -78,12 +78,13 @@ module VagrantPlugins
             #
             #  Figure out DataStore
             r = ssh.exec!(
-                    'df | grep "^[VMFS|NFS]" | sort -nk4 |'\
-                    'sed "s|.*/vmfs/volumes/||g" | tail +2')
+                    'df 2>/dev/null| grep "^[VMFS|NFS].*/vmfs/volumes/" | '\
+                    'sort -nk4 | sed "s|.*/vmfs/volumes/||g"')
 
             availvolumes = r.split(/\n/)
-            if (config.debug =~ %r{true}i)
-               puts "Available DS Volumes: #{availvolumes}"
+            if config.debug =~ %r{true}i
+              env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                   message: "Avail DS vols   : #{availvolumes}")
             end
             if (r == '') || (r.exitstatus != 0)
               raise Errors::ESXiError,
@@ -93,6 +94,10 @@ module VagrantPlugins
             #  Use least-used if vm_disk_store is not set (or not found)
             if config.vm_disk_store.nil?
               desired_ds = '--- Least Used ---'
+              env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                   message: 'WARNING         : '\
+                                            "vm_disk_store not set, using "\
+                                            "\"--- Least Used ---\"")
             else
               desired_ds = config.vm_disk_store.to_s
             end
@@ -122,8 +127,9 @@ module VagrantPlugins
                     'grep Portgroups | sed "s/^   Portgroups: //g" |'\
                     'sed "s/,./\n/g"')
             availnetworks = r.split(/\n/)
-            if (config.debug =~ %r{true}i)
-               puts "Available Networks: #{availnetworks}"
+            if config.debug =~ %r{true}i
+              env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                   message: "Avail Networks  : #{availnetworks}")
             end
             if (availnetworks == '') || (r.exitstatus != 0)
               raise Errors::ESXiError,
@@ -131,30 +137,62 @@ module VagrantPlugins
                              "#{r.stderr}"
             end
 
-            @guestvm_network = []
-            counter = 0
-            if config.virtual_network.nil?
-              @guestvm_network[0] = availnetworks.first
+            #   How many vm.network are there?
+            vm_network_index = 0
+            env[:machine].config.vm.networks.each do |type, options|
+              # I only handle private and public networks
+              next if type != :private_network && type != :public_network
+              vm_network_index += 1
+            end
+
+            if config.debug =~ %r{true}i
               env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
-                                    message: 'WARNING         : '\
-                                             "config.virtual_network not "\
-                                             "set, using #{availnetworks.first}")
-            else
-              networkID = 0
-              for aVirtNet in Array(config.virtual_network) do
-                if availnetworks.include? aVirtNet
-                  @guestvm_network << aVirtNet
+                                   message: "virtual_network : #{config.virtual_network}")
+            end
+
+            #  If there is more vm.network than virtual_network's configured
+            #  I need to add more virtual_networks.  Setting each to ---NotSet---
+            #  to give a warning below...
+            if vm_network_index >= config.virtual_network.count
+              config.virtual_network.count.upto(vm_network_index) do |index|
+                config.virtual_network << '--NotSet--'
+              end
+            end
+
+            #  Go through each virtual_network and make sure it's good.  If not
+            #  display a WARNING that we are choosing the first found.
+            @guestvm_network = []
+            networkID = 0
+            for aVirtNet in Array(config.virtual_network) do
+              if config.virtual_network == [''] ||
+                config.virtual_network[0] == '--NotSet--'
+                #  First (and only ) interface is not configure or not set
+                @guestvm_network = [availnetworks.first]
+                config.virtual_network = [availnetworks.first]
+                env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                      message: 'WARNING         : '\
+                                               "virtual_network[#{networkID}] not "\
+                                               "set, using #{availnetworks.first}")
+              elsif availnetworks.include? aVirtNet
+                # Network interface is good
+                @guestvm_network << aVirtNet
+              else
+                # Network interface is NOT good.
+                @guestvm_network[networkID] = availnetworks.first
+                config.virtual_network[networkID] = availnetworks.first
+                if aVirtNet == '--NotSet--'
+                  aVirtNet_msg = "virtual_network[#{networkID}]"
                 else
-                  @guestvm_network << availnetworks.first
-                  env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
-                                       message: 'WARNING         : '\
-                                                "#{aVirtNet} not "\
-                                                "found, using #{availnetworks.first}")
-                end
-                networkID += 1
-                if networkID >= 4
-                  break
+                  aVirtNet_msg = aVirtNet
                 end
+                env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                     message: 'WARNING         : '\
+                                              "#{aVirtNet_msg} not "\
+                                              "found, using #{availnetworks.first}")
+              end
+              networkID += 1
+              if networkID >= 4
+                break
               end
             end
           end
@@ -231,8 +269,9 @@ module VagrantPlugins
           netOpts = ""
           networkID = 0
           for element in @guestvm_network do
-            if (config.debug =~ %r{true}i)
-              puts "guestvm_network[#{networkID}]: #{element}"
+            if config.debug =~ %r{true}i
+              env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                   message: "Network[#{networkID}]      : #{element}")
             end
             new_vmx_contents << "ethernet#{networkID}.networkName = \"net#{networkID}\"\n"
             new_vmx_contents << "ethernet#{networkID}.present = \"TRUE\"\n"
@@ -419,12 +458,13 @@ module VagrantPlugins
                 "#{$encoded_esxi_password}@#{config.esxi_hostname}"\
                 "#{resource_pool}"
 
-          #  Security bug if unremarked! Password will be exposed in log file.
-          if (config.debug =~ %r{password}i)
+          #
+          #  Security alert! If password debugging is enabled, Password will
+          #  be exposed in log file.
+          if config.debug =~ %r{password}i
             @logger.info("vagrant-vmware-esxi, createvm: ovf_cmd #{ovf_cmd}")
             puts "ovftool command: #{ovf_cmd}"
-          end
-          if (config.debug =~ %r{true}i)
+          elsif config.debug =~ %r{true}i
             ovf_cmd_nopw = ovf_cmd.gsub(/#{$encoded_esxi_password}/, '******')
             puts "ovftool command: #{ovf_cmd_nopw}"
           end
@@ -433,8 +473,9 @@ module VagrantPlugins
           end
 
           # VMX file is not needed any longer. Delete it
-          if (config.debug =~ %r{true}i)
-            puts "Keeping file: #{new_vmx_file}"
+          if config.debug =~ %r{true}i
+            env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                 message: "Keeping file    : #{new_vmx_file}")
           else
             File.delete(new_vmx_file)
           end
@@ -442,7 +483,7 @@ module VagrantPlugins
           #
           #  Re-open the network connection to get VMID
           #
-          Net::SSH.start( config.esxi_hostname, config.esxi_username,
+          Net::SSH.start(config.esxi_hostname, config.esxi_username,
             password:                   $esxi_password,
             port:                       config.esxi_hostport,
             keys:                       config.esxi_private_keys,
@@ -461,7 +502,7 @@ module VagrantPlugins
 
             env[:machine].id = vmid.to_i
             env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
-                                 message: "VMID: #{env[:machine].id}")
+                                 message: "VMID            : #{env[:machine].id}")
 
             #
             #   -=-=-=-=-=-=-
@@ -478,7 +519,7 @@ module VagrantPlugins
 
             #  Get vmx file in memory
             esxi_orig_vmx_file = ssh.exec!("cat #{dst_vmx_file} 2>/dev/null")
-            if (config.debug =~ %r{vmx}i)
+            if config.debug =~ %r{vmx}i
               puts "orig vmx: #{esxi_orig_vmx_file}"
               puts "\n\n"
             end
@@ -597,7 +638,7 @@ module VagrantPlugins
 
             #  If there was changes, update esxi
             if vmx_need_change_flag == true
-              if (config.debug =~ %r{vmx}i)
+              if config.debug =~ %r{vmx}i
                 puts "new vmx: #{new_vmx_contents}"
                 puts "\n\n"
               end
@@ -614,8 +655,9 @@ module VagrantPlugins
               end
               ssh.loop
             else
-              if (config.debug =~ %r{vmx}i)
-                puts "no changes requried to vmx file"
+              if config.debug =~ %r{vmx}i
+                env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                     message: 'ESXi vmx file    : Unmodified')
               end
             end
           end

data/lib/vagrant-vmware-esxi/action/destroy.rb

@@ -33,7 +33,7 @@ module VagrantPlugins
             raise Errors::ESXiError,
                   message: 'Guest VM should have been powered off...'
           else
-            Net::SSH.start( config.esxi_hostname, config.esxi_username,
+            Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
               keys:                       config.esxi_private_keys,

data/lib/vagrant-vmware-esxi/action/esxi_password.rb

@@ -8,7 +8,7 @@ module VagrantPlugins
       # This action set the global variable esxi_password and attempt to
       # login to the esxi server to verify connectivity.
       class SetESXiPassword
-        def initialize(app, env)
+        def initialize(app, _env)
           @app    = app
           @logger = Log4r::Logger.new('vagrant_vmware_esxi::action::set_esxi_password')
         end
@@ -22,26 +22,25 @@ module VagrantPlugins
           @logger.info('vagrant-vmware-esxi, set_esxi_password: start...')
 
           # Get config.
-          machine = env[:machine]
           config = env[:machine].provider_config
 
           #
           #  Set global variable $esxi_password
           #
           if $esxi_password.nil?
-            if (config.esxi_password =~ %r{^prompt:}i)
+            if config.esxi_password =~ %r{^prompt:}i
               #
               #  Prompt for password
               #
               begin
                 print "#{config.esxi_hostname} password:"
                 $esxi_password = STDIN.noecho(&:gets).chomp
-                puts ""
+                puts ''
               rescue
                 raise Errors::ESXiError,
-                      message: "Prompt for password error???"
+                      message: 'Prompt for password error???'
               end
-            elsif (config.esxi_password =~ %r{^env:}i)
+            elsif config.esxi_password =~ %r{^env:}i
               #
               #  Get pw from environment variable
               #
@@ -56,19 +55,19 @@ module VagrantPlugins
                 raise Errors::ESXiError,
                       message: "Unable to read environment variable: #{esxi_password_env}"
               end
-            elsif (config.esxi_password =~ %r{^file:}i)
+            elsif config.esxi_password =~ %r{^file:}i
               #
               #  Get password from file
               #
               esxi_password_file = config.esxi_password.gsub(/file:/i, '').chomp
-              if esxi_password_file.length < 1
+              if esxi_password_file.empty?
                 esxi_password_file = '~/.esxi_password'
               end
               esxi_password_file = File.expand_path(esxi_password_file)
               #  Get password from file
               begin
                 if File.file?(esxi_password_file)
-                  file_pw=""
+                  file_pw = ''
                   fh = File.open(File.expand_path(esxi_password_file))
                   file_pw = fh.readline
                   fh.close
@@ -79,13 +78,13 @@ module VagrantPlugins
               rescue
                 raise Errors::ESXiError, message: "Unable to open #{esxi_password_file}"
               end
-            elsif (config.esxi_password =~ %r{^key:}i)
+            elsif config.esxi_password =~ %r{^key:}i
               #
               #  use ssh keys
               #
-              $esxi_password = ""
+              $esxi_password = ''
               esxi_password_key = config.esxi_password.gsub(/key:/i, '').chomp
-              if esxi_password_key.length < 1
+              if esxi_password_key.empty?
                 config.esxi_private_keys = config.system_private_keys_path
               else
                 config.esxi_private_keys = esxi_password_key
@@ -99,11 +98,11 @@ module VagrantPlugins
           #
           #  Encode special characters in PW
           #
-          $encoded_esxi_password = $esxi_password.gsub('@', '%40').gsub(\
+          $encoded_esxi_password = $esxi_password.gsub('%', '%25').gsub(\
             '<', '%3c').gsub('>', '%3e').gsub(\
             '[', '%5b').gsub(']', '%5d').gsub(\
             '(', '%28').gsub(')', '%29').gsub(\
-            '%', '%25').gsub('#', '%23').gsub(\
+            '@', '%40').gsub('#', '%23').gsub(\
             '&', '%26').gsub(':', '%3a').gsub(\
             '/', '%2f').gsub('\\','%5c').gsub(\
             '"', '%22').gsub('\'','%27').gsub(\
@@ -117,7 +116,7 @@ module VagrantPlugins
           #  Test ESXi host connectivity
           #
           begin
-            Net::SSH.start( config.esxi_hostname, config.esxi_username,
+            Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
               keys:                       config.esxi_private_keys,
@@ -126,31 +125,33 @@ module VagrantPlugins
               non_interactive:            true
             ) do |ssh|
 
-              esxi_version = ssh.exec!("vmware -v")
+              esxi_version = ssh.exec!('vmware -v')
               ssh.close
 
               @logger = Log4r::Logger.new('vagrant_vmware_esxi::action::set_esxi_password')
-              if esxi_version =~ %r{^vmware esxi}i
-                @logger.info('vagrant-vmware-esxi, set_esxi_password: '\
-                             "ESXi version: #{esxi_version}")
-              else
+              if (config.debug =~ %r{true}i) && $showVersionFlag.nil?
+                $showVersionFlag = true
+                env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                     message: "ESXi version    : #{esxi_version}")
+              end
+              if esxi_version !~ %r{^vmware esxi}i
                 @logger.info('vagrant-vmware-esxi, set_esxi_password: '\
                              "ESXi version: #{esxi_version}")
                 raise Errors::ESXiError,
-                      message: "Unable to connect to ESXi host!"
+                      message: 'Unable to connect to ESXi host!'
               end
             end
           rescue
-            if (config.esxi_password =~ %r{^prompt:}i)
-              access_error_message = "Prompt for password"
-            elsif (config.esxi_password =~ %r{^env:}i)
+            if config.esxi_password =~ %r{^prompt:}i
+              access_error_message = 'Prompt for password'
+            elsif config.esxi_password =~ %r{^env:}i
               access_error_message = "env:#{esxi_password_env}"
-            elsif (config.esxi_password =~ %r{^file:}i)
+            elsif config.esxi_password =~ %r{^file:}i
               access_error_message = "file:#{esxi_password_file}"
-            elsif (config.esxi_password =~ %r{^key:}i)
+            elsif config.esxi_password =~ %r{^key:}i
               access_error_message = "key:#{config.esxi_private_keys}"
             else
-              access_error_message = "password in Vagrantfile"
+              access_error_message = 'password in Vagrantfile'
             end
 
             env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
@@ -160,7 +161,7 @@ module VagrantPlugins
                         "ESXi host access : #{access_error_message}")
 
             raise Errors::ESXiError,
-                  message: "Unable to connect to ESXi host!"
+                  message: 'Unable to connect to ESXi host!'
           end
         end
       end

data/lib/vagrant-vmware-esxi/action/halt.rb

@@ -6,7 +6,7 @@ module VagrantPlugins
     module Action
       # This action will halt (power off) the VM
       class Halt
-        def initialize(app, env)
+        def initialize(app, _env)
           @app    = app
           @logger = Log4r::Logger.new('vagrant_vmware_esxi::action::halt')
         end
@@ -28,7 +28,7 @@ module VagrantPlugins
           elsif env[:machine_state].to_s == 'not_created'
             env[:ui].info I18n.t('vagrant_vmware_esxi.already_destroyed')
           else
-            Net::SSH.start( config.esxi_hostname, config.esxi_username,
+            Net::SSH.start(config.esxi_hostname, config.esxi_username,
               password:                   $esxi_password,
               port:                       config.esxi_hostport,
               keys:                       config.esxi_private_keys,
@@ -41,8 +41,7 @@ module VagrantPlugins
 
               if r.exitstatus != 0
                 raise Errors::ESXiError,
-                      message: "Unable to power off the VM:\n"
-                               "  #{r}"
+                      message: "Unable to power off the VM:\n    #{r}"
               end
               env[:ui].info I18n.t('vagrant_vmware_esxi.states.powered_off.short')
             end