chef-provisioning-vsphere 2.2.2 → 2.3.0

data/lib/chef/provisioning/vsphere_driver/driver.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'chef'
-require 'cheffish/merged_config'
-require 'chef/provisioning/driver'
-require 'chef/provisioning/machine/windows_machine'
-require 'chef/provisioning/machine/unix_machine'
-require 'chef/provisioning/vsphere_driver/clone_spec_builder'
-require 'chef/provisioning/vsphere_driver/version'
-require 'chef/provisioning/vsphere_driver/vsphere_helpers'
-require 'chef/provisioning/vsphere_driver/vsphere_url'
-require 'chef/provisioning/vsphere_driver/vm_helper'
+require "chef"
+require "cheffish/merged_config"
+require "chef/provisioning/driver"
+require "chef/provisioning/machine/windows_machine"
+require "chef/provisioning/machine/unix_machine"
+require "chef/provisioning/vsphere_driver/clone_spec_builder"
+require "chef/provisioning/vsphere_driver/version"
+require "chef/provisioning/vsphere_driver/vsphere_helpers"
+require "chef/provisioning/vsphere_driver/vsphere_url"
+require "chef/provisioning/vsphere_driver/vm_helper"
 
 # Provisions machines in vSphere.
 module ChefProvisioningVsphere
@@ -44,10 +44,10 @@ module ChefProvisioningVsphere
     #
     # @param [Object] h converts to key:value
     def self.symbolize_keys(h)
-      Hash === h ?
+      Hash === h ? # rubocop:disable Style/MultilineTernaryOperator
         Hash[
           h.map do |k, v|
-            [k.respond_to?(:to_sym) ? k.to_sym : k, symbolize_keys(v)]
+            [k.respond_to?(:to_sym) ? k.to_sym : k, symbolize_keys(v)] # rubocop:disable Style/NestedTernaryOperator
           end
         ] : h
     end
@@ -56,7 +56,8 @@ module ChefProvisioningVsphere
     #
     # @param [Object] hash_like converts to key:value
     def deep_symbolize(hash_like)
-      return {} if hash_like.nil? || hash_like.empty?
+      return {} if hash_like.nil?
+
       r = {}
       hash_like.each do |key, value|
         value = deep_symbolize(value) if value.respond_to?(:values)
@@ -74,12 +75,12 @@ module ChefProvisioningVsphere
 
       uri = URI(driver_url)
       @connect_options = {
-        provider: 'vsphere',
+        provider: "vsphere",
         host: uri.host,
         port: uri.port,
         use_ssl: uri.use_ssl,
         insecure: uri.insecure,
-        path: uri.path
+        path: uri.path,
       }
 
       if driver_options
@@ -150,13 +151,13 @@ module ChefProvisioningVsphere
         )
         vm = vm_for(machine_spec)
         if vm
-          Chef::Log.warn 'returning existing machine'
+          Chef::Log.warn "returning existing machine"
           return vm
         else
           Chef::Log.warn machine_msg(
             machine_spec.name,
-            machine_spec.location['server_id'],
-            'no longer exists.  Recreating ...'
+            machine_spec.location["server_id"],
+            "no longer exists.  Recreating ..."
           )
         end
       end
@@ -173,7 +174,7 @@ module ChefProvisioningVsphere
       action_handler.performed_action(machine_msg(
                                         machine_spec.name,
                                         vm.config.instanceUuid,
-                                        'created'
+                                        "created"
       ))
       vm
     end
@@ -195,12 +196,12 @@ module ChefProvisioningVsphere
     # @param [Object] vm taken from Chef provisioning for all the vm state.
     def add_machine_spec_location(vm, machine_spec)
       machine_spec.location = {
-        'driver_url' => driver_url,
-        'driver_version' => VERSION,
-        'server_id' => vm.config.instanceUuid,
-        'is_windows' => is_windows?(vm),
-        'allocated_at' => Time.now.utc.to_s,
-        'ipaddress' => vm.guest.ipAddress
+        "driver_url" => driver_url,
+        "driver_version" => VERSION,
+        "server_id" => vm.config.instanceUuid,
+        "is_windows" => is_windows?(vm),
+        "allocated_at" => Time.now.utc.to_s,
+        "ipaddress" => vm.guest.ipAddress,
       }
     end
 
@@ -218,7 +219,7 @@ module ChefProvisioningVsphere
         Chef::Log.info machine_msg(
           machine_spec.name,
           vm.config.instanceUuid,
-          'already created'
+          "already created"
         )
       else
         vm = clone_vm(
@@ -239,14 +240,14 @@ module ChefProvisioningVsphere
       bootstrap_options.to_hash.each_pair do |key, value|
         if value.is_a?(Hash)
           temp_value = value.clone
-          temp_value[:password] = '*********' if value.key?(:password)
+          temp_value[:password] = "*********" if value.key?(:password)
         else
           temp_value = value
         end
         description << "  #{key}: #{temp_value.inspect}"
       end
       description
-     end
+    end
 
     # Creates a string of specific Machine information
     #
@@ -270,7 +271,7 @@ module ChefProvisioningVsphere
       vm = start_machine(action_handler, machine_spec, machine_options)
       if vm.nil?
         raise "Machine #{machine_spec.name} does not have a server "\
-        'associated with it, or server does not exist.'
+        "associated with it, or server does not exist."
       end
 
       bootstrap_options = machine_options[:bootstrap_options]
@@ -291,7 +292,7 @@ module ChefProvisioningVsphere
       end
 
       ## Check if true available after added nic
-      vm_helper.open_port?(machine_spec.location['ipaddress'], vm_helper.port) unless machine_spec.location['ipaddress'].nil?
+      vm_helper.open_port?(machine_spec.location["ipaddress"], vm_helper.port) unless machine_spec.location["ipaddress"].nil?
       machine
     end
 
@@ -312,7 +313,7 @@ module ChefProvisioningVsphere
         bootstrap_options,
         vm
       )
-      if is_windows?(vm) && !new_nics.nil? && vm_helper.open_port?(machine_spec.location['ipaddress'], vm_helper.port)
+      if is_windows?(vm) && !new_nics.nil? && vm_helper.open_port?(machine_spec.location["ipaddress"], vm_helper.port)
         new_nics.each do |nic|
           nic_label = nic.device.deviceInfo.label
           machine.execute_always(
@@ -341,13 +342,13 @@ module ChefProvisioningVsphere
       # Customization below may change this to a valid ip
       wait_until_ready(action_handler, machine_spec, machine_options, vm)
 
-      if !machine_spec.location['ipaddress'] || !has_ip?(machine_spec.location['ipaddress'], vm)
+      if !machine_spec.location["ipaddress"] || !has_ip?(machine_spec.location["ipaddress"], vm)
         # find the ip we actually want
         # this will be the static ip to assign
         # or the ip reported back by the vm if using dhcp
         # it *may* be nil if just cloned
         vm_ip = ip_to_bootstrap(bootstrap_options, vm) || vm.guest.ipAddress
-        machine_spec.location['ipaddress'] = vm_ip
+        machine_spec.location["ipaddress"] = vm_ip
         transport = nil
         unless vm_ip.nil?
           transport = transport_for(machine_spec, bootstrap_options[:ssh], vm_ip)
@@ -356,7 +357,7 @@ module ChefProvisioningVsphere
         unless !transport.nil? && transport.available? && has_ip?(vm_ip, vm)
           attempt_ip(machine_options, action_handler, vm, machine_spec)
         end
-        machine_spec.location['ipaddress'] = vm_ip # vm.guest.ipAddress vmWare ip_address here can be 0.0.0.0
+        machine_spec.location["ipaddress"] = vm_ip # vm.guest.ipAddress vmWare ip_address here can be 0.0.0.0
         action_handler.report_progress(
           "IP address obtained: #{machine_spec.location['ipaddress']}"
         )
@@ -368,14 +369,14 @@ module ChefProvisioningVsphere
         wait_for_transport(action_handler, machine_spec, machine_options, vm)
       rescue Timeout::Error
         # Only ever reboot once, and only if it's been less than 10 minutes since we stopped waiting
-        if machine_spec.location['started_at'] ||
-           remaining_wait_time(machine_spec, machine_options) < -(10 * 60)
+        if machine_spec.location["started_at"] ||
+            remaining_wait_time(machine_spec, machine_options) < -(10 * 60)
           raise
         else
           Chef::Log.warn(machine_msg(
                            machine_spec.name,
                            vm.config.instanceUuid,
-                           'started but SSH did not come up.  Rebooting...'
+                           "started but SSH did not come up.  Rebooting..."
           ))
           restart_server(action_handler, machine_spec, machine_options)
           wait_until_ready(action_handler, machine_spec, machine_options, vm)
@@ -392,18 +393,18 @@ module ChefProvisioningVsphere
     # @param [Object] machine_spec The spec required to talk to the VM.
     def attempt_ip(machine_options, action_handler, vm, machine_spec)
       vm_ip = ip_to_bootstrap(machine_options[:bootstrap_options], vm)
-      machine_spec.location['ipaddress'] = vm_ip
+      machine_spec.location["ipaddress"] = vm_ip
 
       wait_for_ip(vm, machine_options, machine_spec, action_handler)
 
       unless has_ip?(vm_ip, vm)
-        action_handler.report_progress 'rebooting...'
-        if vm.guest.toolsRunningStatus != 'guestToolsRunning'
-          msg = 'tools have stopped. current power state is '
+        action_handler.report_progress "rebooting..."
+        if vm.guest.toolsRunningStatus != "guestToolsRunning"
+          msg = "tools have stopped. current power state is "
           msg << vm.runtime.powerState
-          msg << ' and tools state is '
+          msg << " and tools state is "
           msg << vm.guest.toolsRunningStatus
-          msg << '. powering up server...'
+          msg << ". powering up server..."
           action_handler.report_progress(msg)
           vsphere_helper.start_vm(vm)
         else
@@ -430,11 +431,11 @@ module ChefProvisioningVsphere
                  spec.identity.domain
                else
                  bootstrap_options[:customization_spec][:domain]
-      end
+               end
 
       return unless domain
 
-      if is_windows?(vm) && domain != 'local'
+      if is_windows?(vm) && domain != "local"
         start = Time.now.utc
         trimmed_name = machine_spec.name.byteslice(0, 15)
         expected_name = "#{trimmed_name}.#{domain}"
@@ -442,8 +443,8 @@ module ChefProvisioningVsphere
           "waiting to domain join and be named #{expected_name}"
         )
         until (Time.now.utc - start) > 30 ||
-              (vm.guest.hostName == expected_name)
-          print '.'
+            (vm.guest.hostName == expected_name)
+          print "."
           sleep 5
         end
       end
@@ -460,12 +461,12 @@ module ChefProvisioningVsphere
       ip_to_bootstrap(bootstrap_options, vm)
       ready_timeout = machine_options[:ready_timeout] || 300
       msg1 = "waiting up to #{ready_timeout} seconds for customization"
-      msg2 = " and find #{machine_spec.location['ipaddress']}" unless machine_spec.location['ipaddress'].nil? # unless vm_ip == vm.guest.ipAddress # RuntimeError: can't modify frozen String
+      msg2 = " and find #{machine_spec.location['ipaddress']}" unless machine_spec.location["ipaddress"].nil? # unless vm_ip == vm.guest.ipAddress # RuntimeError: can't modify frozen String
       msg = [msg1, msg2].join
       action_handler.report_progress msg
 
       vm_ip = ip_to_bootstrap(bootstrap_options, vm) || vm.guest.ipAddress
-      machine_spec.location['ipaddress'] = vm_ip
+      machine_spec.location["ipaddress"] = vm_ip
       until transport_for(
         machine_spec,
         machine_options[:bootstrap_options][:ssh],
@@ -475,7 +476,7 @@ module ChefProvisioningVsphere
           "IP addresses found: #{all_ips_for(vm)}"
         )
         vm_ip = ip_to_bootstrap(bootstrap_options, vm) || vm.guest.ipAddress
-        machine_spec.location['ipaddress'] = vm_ip
+        machine_spec.location["ipaddress"] = vm_ip
         if has_ip?(vm_ip, vm)
           transport_for(
             machine_spec,
@@ -527,7 +528,7 @@ module ChefProvisioningVsphere
             vsphere_helper.stop_vm(vm, machine_options[:stop_timeout])
             vm.Destroy_Task.wait_for_completion
           rescue RbVmomi::Fault => fault
-            raise fault unless fault.fault.class.wsdl_name == 'ManagedObjectNotFound'
+            raise fault unless fault.fault.class.wsdl_name == "ManagedObjectNotFound"
           ensure
             machine_spec.location = nil
           end
@@ -579,7 +580,7 @@ module ChefProvisioningVsphere
       action_handler.perform_action "restart machine #{machine_spec.name} (#{driver_url})" do
         stop_machine(action_handler, machine_spec, machine_options)
         start_machine(action_handler, machine_spec, machine_options)
-        machine_spec.location['started_at'] = Time.now.utc.to_s
+        machine_spec.location["started_at"] = Time.now.utc.to_s
       end
     end
 
@@ -591,24 +592,24 @@ module ChefProvisioningVsphere
     # @param [Object] _machine_spec The machine spec required to start the VM.
     # @param [Object] machine Machine object to connect to.
     def setup_ubuntu_dns(machine, bootstrap_options, _machine_spec)
-      host_lookup = machine.execute_always('host google.com')
+      host_lookup = machine.execute_always("host google.com")
       if host_lookup.exitstatus != 0
-        if host_lookup.stdout.include?('setlocale: LC_ALL')
-          machine.execute_always('locale-gen en_US && update-locale LANG=en_US')
+        if host_lookup.stdout.include?("setlocale: LC_ALL")
+          machine.execute_always("locale-gen en_US && update-locale LANG=en_US")
         end
         distro = machine.execute_always("lsb_release -i | sed -e 's/Distributor ID://g'").stdout.strip
         Chef::Log.info "Found distro:#{distro}"
-        if distro == 'Ubuntu'
-          distro_version = machine.execute_always('lsb_release -r | sed -e s/[^0-9.]//g').stdout.strip.to_f
+        if distro == "Ubuntu"
+          distro_version = machine.execute_always("lsb_release -r | sed -e s/[^0-9.]//g").stdout.strip.to_f
           Chef::Log.info "Found distro version:#{distro_version}"
           if distro_version >= 12.04
-            Chef::Log.info 'Ubuntu version 12.04 or greater. Need to patch DNS.'
-            interfaces_file = '/etc/network/interfaces'
-            nameservers = bootstrap_options[:customization_spec][:ipsettings][:dnsServerList].join(' ')
+            Chef::Log.info "Ubuntu version 12.04 or greater. Need to patch DNS."
+            interfaces_file = "/etc/network/interfaces"
+            nameservers = bootstrap_options[:customization_spec][:ipsettings][:dnsServerList].join(" ")
             machine.execute_always("if ! cat #{interfaces_file} | grep -q dns-search ; then echo 'dns-search #{bootstrap_options[:customization_spec][:domain]}' >> #{interfaces_file} ; fi")
             machine.execute_always("if ! cat #{interfaces_file} | grep -q dns-nameservers ; then echo 'dns-nameservers #{nameservers}' >> #{interfaces_file} ; fi")
-            machine.execute_always('/etc/init.d/networking restart')
-            machine.execute_always('apt-get -qq update')
+            machine.execute_always("/etc/init.d/networking restart")
+            machine.execute_always("apt-get -qq update")
           end
         end
       end
@@ -633,22 +634,22 @@ module ChefProvisioningVsphere
     end
 
     def remaining_wait_time(machine_spec, machine_options)
-      if machine_spec.location['started_at']
+      if machine_spec.location["started_at"]
         (machine_options[:start_timeout] || 600) -
-          (Time.now.utc - Time.parse(machine_spec.location['started_at']))
+          (Time.now.utc - Time.parse(machine_spec.location["started_at"]))
       else
         (machine_options[:create_timeout] || 600) -
-          (Time.now.utc - Time.parse(machine_spec.location['allocated_at']))
+          (Time.now.utc - Time.parse(machine_spec.location["allocated_at"]))
       end
     end
 
     def wait_until_ready(action_handler, machine_spec, machine_options, vm)
-      if vm.guest.toolsRunningStatus != 'guestToolsRunning'
+      if vm.guest.toolsRunningStatus != "guestToolsRunning"
         if action_handler.should_perform_actions
           action_handler.report_progress "waiting for #{machine_spec.name} (#{vm.config.instanceUuid} on #{driver_url}) to be ready ..."
           until remaining_wait_time(machine_spec, machine_options) < 0 ||
-                (vm.guest.toolsRunningStatus == 'guestToolsRunning' && vm.guest.ipAddress && !vm.guest.ipAddress.empty?)
-            print '.'
+              (vm.guest.toolsRunningStatus == "guestToolsRunning" && vm.guest.ipAddress && !vm.guest.ipAddress.empty?)
+            print "."
             sleep 5
           end
           action_handler.report_progress "#{machine_spec.name} is now ready"
@@ -658,7 +659,7 @@ module ChefProvisioningVsphere
 
     def vm_for(machine_spec)
       if machine_spec.location
-        vsphere_helper.find_vm_by_id(machine_spec.location['server_id'])
+        vsphere_helper.find_vm_by_id(machine_spec.location["server_id"])
       end
     end
 
@@ -719,7 +720,7 @@ module ChefProvisioningVsphere
       )
       strategy = convergence_strategy_for(machine_spec, machine_options)
 
-      if machine_spec.location['is_windows']
+      if machine_spec.location["is_windows"]
         Chef::Provisioning::Machine::WindowsMachine.new(
           machine_spec, transport, strategy
         )
@@ -732,13 +733,13 @@ module ChefProvisioningVsphere
 
     def is_windows?(vm)
       return false if vm.nil?
-      vm.config.guestId.start_with?('win')
+      vm.config.guestId.start_with?("win")
     end
 
     def convergence_strategy_for(machine_spec, machine_options)
-      require 'chef/provisioning/convergence_strategy/install_msi'
-      require 'chef/provisioning/convergence_strategy/install_cached'
-      require 'chef/provisioning/convergence_strategy/no_converge'
+      require "chef/provisioning/convergence_strategy/install_msi"
+      require "chef/provisioning/convergence_strategy/install_cached"
+      require "chef/provisioning/convergence_strategy/no_converge"
 
       mopts = machine_options[:convergence_options].to_hash.dup
       if mopts[:chef_server]
@@ -752,7 +753,7 @@ module ChefProvisioningVsphere
         )
       end
 
-      if machine_spec.location['is_windows']
+      if machine_spec.location["is_windows"]
         Chef::Provisioning::ConvergenceStrategy::InstallMsi.new(
           mopts, config
         )
@@ -780,7 +781,7 @@ module ChefProvisioningVsphere
           action_handler.report_progress "waiting for #{machine_spec.name} (#{vm.config.instanceUuid} on #{driver_url}) to be connectable (transport up and running) ..."
 
           until remaining_wait_time(machine_spec, machine_options) < 0 || transport.available?
-            print '.'
+            print "."
             sleep 5
           end
 
@@ -797,9 +798,9 @@ module ChefProvisioningVsphere
     def transport_for(
       machine_spec,
       remoting_options,
-      ip = machine_spec.location['ipaddress']
+      ip = machine_spec.location["ipaddress"]
     )
-      if machine_spec.location['is_windows']
+      if machine_spec.location["is_windows"]
         create_winrm_transport(ip, remoting_options)
       else
         create_ssh_transport(ip, remoting_options)
@@ -811,7 +812,7 @@ module ChefProvisioningVsphere
     # @param [String] host The host the VM is connecting to
     # @param [Object] options Options that are required to connect to the host from Chef-Provisioning
     def create_winrm_transport(host, options)
-      require 'chef/provisioning/transport/winrm'
+      require "chef/provisioning/transport/winrm"
       winrm_transport = if options[:port] == 5986
                           :ssl
                         else
@@ -820,7 +821,7 @@ module ChefProvisioningVsphere
       port = options[:port] || vm_helper.port
       winrm_options = {
         user: (options[:user]).to_s,
-        pass: options[:password]
+        pass: options[:password],
       }
       if options[:winrm_opts].nil?
         opt = options[:user].include?('\\') ? :disable_sspi : :basic_auth_only
@@ -828,12 +829,12 @@ module ChefProvisioningVsphere
       else
         winrm_options.merge!(options[:winrm_opts])
       end
-      scheme = winrm_transport == :ssl ? 'https' : 'http'
+      scheme = winrm_transport == :ssl ? "https" : "http"
       endpoint = URI::Generic.build(
         scheme: scheme,
         host: host,
         port: port,
-        path: '/wsman'
+        path: "/wsman"
       ).to_s
 
       Chef::Provisioning::Transport::WinRM.new(
@@ -849,14 +850,14 @@ module ChefProvisioningVsphere
     # @param [String] host The host the VM is connecting to
     # @param [Object] options Options that are required to connect to the host from Chef-Provisioning
     def create_ssh_transport(host, options)
-      require 'chef/provisioning/transport/ssh'
+      require "chef/provisioning/transport/ssh"
       ssh_user = options[:user]
       options = options.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; }
       Chef::Provisioning::Transport::SSH.new(
         host,
         ssh_user,
         options.to_hash,
-        @config[:machine_options][:sudo] ? { prefix: 'sudo ' } : {},
+        @config[:machine_options][:sudo] ? { prefix: "sudo " } : {},
         config
       )
     end
@@ -883,7 +884,7 @@ module ChefProvisioningVsphere
         vm_ip = wait_for_ipv4(bootstrap_ipv4_timeout(bootstrap_options), vm)
       else
         until vm_guest_ip?(vm) || Time.now.utc - start_time > timeout
-          print '.'
+          print "."
           sleep 1
         end
         vm_ip = vm.guest.ipAddress
@@ -891,7 +892,7 @@ module ChefProvisioningVsphere
 
       # Then check that it is reachable
       until Time.now.utc - start_time > timeout
-        print '.'
+        print "."
         return vm_ip.to_s if vm_helper.open_port?(vm_ip, vm_helper.port, 1)
         sleep 1
       end
@@ -940,14 +941,14 @@ module ChefProvisioningVsphere
           end
         end
       end
-      raise 'Timed out waiting for ipv4 address!'
+      raise "Timed out waiting for ipv4 address!"
     end
 
     # What is the VM guest IP
     #
     # @param [Object] vm The VM object from Chef-Provisioning
     def vm_guest_ip?(vm)
-      vm.guest.guestState == 'running' && vm.guest.toolsRunningStatus == 'guestToolsRunning' && !vm.guest.ipAddress.nil?
+      vm.guest.guestState == "running" && vm.guest.toolsRunningStatus == "guestToolsRunning" && !vm.guest.ipAddress.nil?
     end
   end
 end