From 2df64a3023eba7574a52dda09edf4ddfc5ea530f Mon Sep 17 00:00:00 2001
From: Chris Roberts <croberts@hashicorp.com>
Date: Fri, 9 Aug 2024 15:32:18 -0700
Subject: [PATCH] Fix read_ip lookup ordering to use guest tools first

This updates the read_ip helper to use the guest tools first when
attempting to lookup a guest address, and falling back to using
the DHCP lease address when it is unavailable.
---
 lib/vagrant-vmware-desktop/driver/base.rb | 67 ++++++++++++-----------
 1 file changed, 34 insertions(+), 33 deletions(-)

diff --git a/lib/vagrant-vmware-desktop/driver/base.rb b/lib/vagrant-vmware-desktop/driver/base.rb
index d26141c..41a7f17 100644
--- a/lib/vagrant-vmware-desktop/driver/base.rb
+++ b/lib/vagrant-vmware-desktop/driver/base.rb
@@ -586,6 +586,40 @@ def scrub_forwarded_ports
         def read_ip(enable_vmrun_ip_lookup=true)
           @logger.info("Reading an accessible IP for machine...")
 
+          if enable_vmrun_ip_lookup
+            # Try to read the IP using vmrun getGuestIPAddress. This
+            # won't work if the guest doesn't have guest tools installed or
+            # is using an old version of VMware.
+            begin
+              @logger.info("Trying vmrun getGuestIPAddress...")
+              result = vmrun("getGuestIPAddress", host_vmx_path)
+              result = result.stdout.chomp
+
+              # If returned address ends with a ".1" do not accept address
+              # and allow lookup via VMX.
+              # see: https://github.com/vmware/open-vm-tools/issues/93
+              if result.end_with?(".1")
+                @logger.warn("vmrun getGuestIPAddress returned: #{result}. Result resembles address retrieval from wrong " \
+                  "interface. Discarding value and proceeding with VMX based lookup.")
+                result = nil
+              else
+                # Try to parse the IP Address. This will raise an exception
+                # if it fails, which will halt our attempt to use it.
+                IPAddr.new(result)
+                @logger.info("vmrun getGuestIPAddress success: #{result}")
+                return result
+              end
+            rescue Errors::VMRunError
+              @logger.info("vmrun getGuestIPAddress failed: VMRunError")
+              # Ignore, try the MAC address way.
+            rescue IPAddr::InvalidAddressError
+              @logger.info("vmrun getGuestIPAddress failed: InvalidAddressError for #{result.inspect}")
+              # Ignore, try the MAC address way.
+            end
+          else
+            @logger.info("Skipping vmrun getGuestIPAddress as requested by config.")
+          end
+
           # NOTE: Read from DHCP leases first so we can attempt to fetch the address
           # for the vmnet8 device first. If multiple networks are defined on the guest
           # it will return the address of the last device, which will fail when doing
@@ -628,39 +662,6 @@ def read_ip(enable_vmrun_ip_lookup=true)
             return dhcp_ip if dhcp_ip
           end
 
-          if enable_vmrun_ip_lookup
-            # Try to read the IP using vmrun getGuestIPAddress. This
-            # won't work if the guest doesn't have guest tools installed or
-            # is using an old version of VMware.
-            begin
-              @logger.info("Trying vmrun getGuestIPAddress...")
-              result = vmrun("getGuestIPAddress", host_vmx_path)
-              result = result.stdout.chomp
-
-              # If returned address ends with a ".1" do not accept address
-              # and allow lookup via VMX.
-              # see: https://github.com/vmware/open-vm-tools/issues/93
-              if result.end_with?(".1")
-                @logger.warn("vmrun getGuestIPAddress returned: #{result}. Result resembles address retrieval from wrong " \
-                  "interface. Discarding value and proceeding with VMX based lookup.")
-                result = nil
-              else
-                # Try to parse the IP Address. This will raise an exception
-                # if it fails, which will halt our attempt to use it.
-                IPAddr.new(result)
-                @logger.info("vmrun getGuestIPAddress success: #{result}")
-                return result
-              end
-            rescue Errors::VMRunError
-              @logger.info("vmrun getGuestIPAddress failed: VMRunError")
-              # Ignore, try the MAC address way.
-            rescue IPAddr::InvalidAddressError
-              @logger.info("vmrun getGuestIPAddress failed: InvalidAddressError for #{result.inspect}")
-              # Ignore, try the MAC address way.
-            end
-          else
-            @logger.info("Skipping vmrun getGuestIPAddress as requested by config.")
-          end
           nil
         end