ssh : use forwarded port for ssh

Use localhost instead of guest IP
Guerying guest IP takes time

Author: naveenrajm7

lib/vagrant_utm/driver/base.rb

@@ -103,6 +103,11 @@ def import(utm_file_url); end
         # @return [void]
         def set_name(name); end # rubocop:disable Naming/AccessorMethodName
 
+        # Reads the SSH port of this VM.
+        #
+        # @param [Integer] expected Expected guest port of SSH.
+        def ssh_port(expected); end
+
         # Starts the virtual machine referenced by this driver.
         # @return [void]
         def start; end

lib/vagrant_utm/driver/meta.rb

@@ -105,6 +105,7 @@ def initialize(uuid = nil) # rubocop:disable Metrics/CyclomaticComplexity,Metric
                        :read_state,
                        :restore_snapshot,
                        :set_name,
+                       :ssh_port,
                        :start,
                        :start_disposable,
                        :suspend,

lib/vagrant_utm/driver/version_4_5.rb

@@ -191,6 +191,17 @@ def read_network_interfaces
           nics
         end
 
+        def ssh_port(expected_port)
+          @logger.debug("Searching for SSH port: #{expected_port.inspect}")
+
+          # Look for the forwarded port only by comparing the guest port
+          read_forwarded_ports.each do |_, _, hostport, guestport|
+            return hostport if guestport == expected_port
+          end
+
+          nil
+        end
+
         # virtualbox plugin style
         def read_state
           output = execute("status", @uuid)

lib/vagrant_utm/provider.rb

@@ -78,24 +78,25 @@ def machine_id_changed
 
       # Returns the SSH info for accessing the UTM VM.
       def ssh_info
-        # If the VM is not running (utm, started) that we can't possibly SSH into it
+        # If the VM is not running (utm, started) then we can't possibly SSH into it
         # TODO: We should use the state 'running', rather than 'started'
-        # This is a workaround for the UTM provider, which does not expose 'running' state
+        # UTM provider, which does not expose 'running' state. So we use 'started' state
         return nil if state.id != :started
 
-        # If there is port forwarding, GuestPort 22 to HostPort XXXX,
-        # We can use host as "127.0.0.1" and port as XXXX (forwarded ports)
-        # But we keep it simple for now, and just use the IP address of the VM
-        #
         # Return what we know
-        # host = get the IP address of the VM from first IP of utmctl ip-address
-        # port = 22, the default SSH port (Since we use IP address of VM, we don't need to forward ports)
+        # host = IP address of the VM
+        # port = the SSH port
         # username = vagrant, the default vagrant user
         # private_key_path = get the private key of the VM (default ~/.vagrant.d/insecure_private_key)
 
+        # Return ssh info for connector to connect to the VM
+        # If VM has shared network adapter in UTM, then we can use the IP address of the VM
+        # If we have multiple network adapters, we need to pick the right one, read_guest_ip returns just first IP
+        # Also, since Vagrant by default adds port forwarding for ssh port 22,
+        # we might aswell use the forwarded ports to connect to the VM using the localhost.
         {
-          host: @driver.read_guest_ip,
-          port: "22"
+          host: "127.0.0.1",
+          port: @driver.ssh_port(@machine.config.ssh.guest_port)
         }
       end
 

locales/en.yml

@@ -34,7 +34,7 @@ en:
       snapshot_multiple_vm_files: |-
         Multiple VM files detected. vagrant-utm which uses qemu-img does not support 
         snapshot feature when multiple VM files are present.
-        
+
         Directory checked: %{directory}
         Files found: %{files}
       snapshot_vm_file_not_found: |-
@@ -65,7 +65,8 @@ en:
       setting_id: |-
         Setting the Vagrant machine ID to UTM VM UUID: %{id}
       waiting_for_vm: |-
-        Waiting %{time} secs for the UTM virtual machine to be ready...
+        UTM does not report when the VM is ready, it only reports when the VM is started.
+        So, waiting %{time} secs for the UTM virtual machine to be ready...
         Default wait time is 20 seconds, you can change it by setting `config.vm.provider.utm.wait_time` in Vagrantfile.
     
     commands:

vagrantfile_examples/Vagrantfile

@@ -6,11 +6,12 @@
 Vagrant.configure("2") do |config|
   # hostname inside the VM
   config.vm.hostname = "utm"
+  config.vm.network "forwarded_port", guest: 80, host: 8989
   config.vm.provider :utm do |utm|
     # Name in UTM UI
-    utm.name = "vagrant"
+    utm.name = "debian"
     # UTM VM file
-    utm.utm_file_url = "https://github.com/naveenrajm7/utm-box/releases/download/debian-12.6/debian-12.6.0-arm64-netinst-vagrant.zip"
+    utm.utm_file_url = "http://localhost:8000/vm_utm.zip"
     utm.memory = 512
     utm.cpus = 1
     utm.notes = "Vagrant: For testing plugin development"