vagrant_utm 0.0.1 → 0.1.1

data/lib/vagrant_utm/action/ip_address.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module Utm
+    module Action
+      # Action to get IP address of machine.
+      class IpAddress
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env) # rubocop:disable Metrics/AbcSize
+          # Get IP address of the machine.
+          env[:ui].warn I18n.t("vagrant_utm.actions.vm.ip_address.reading")
+          guest_ips = env[:machine].provider.driver.read_guest_ip
+
+          if guest_ips.empty?
+            # Inform user that no IP address was found.
+            env[:ui].warn I18n.t("vagrant_utm.actions.vm.ip_address.not_found")
+          else
+            # Show IP address of the machine.
+            env[:ui].info I18n.t("vagrant_utm.actions.vm.ip_address.show")
+            guest_ips.each do |ip|
+              env[:ui].info "  #{ip}"
+            end
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/action/match_mac_address.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+module VagrantPlugins
+  module Utm
+    module Action
+      # This action matches the MAC address of the virtual machine to the
+      # configured MAC address in the Vagrantfile.
+      # OR generates a new MAC address if none is set.
+      # This is useful to make sure that different virtual machines
+      # have different MAC addresses.
+      class MatchMACAddress
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env) # rubocop:disable Metrics/AbcSize
+          base_mac = env[:machine].config.vm.base_mac
+          # If we have a base MAC address and not is empty (empty in some default Vagranfile)
+          # then we use that to match
+          if base_mac && !base_mac.empty?
+            # Create the proc which we want to use to modify the virtual machine
+            env[:ui].info I18n.t("vagrant.actions.vm.match_mac.matching")
+            env[:machine].provider.driver.set_mac_address(env[:machine].config.vm.base_mac)
+          else
+            env[:ui].info I18n.t("vagrant.actions.vm.match_mac.generating")
+            env[:machine].provider.driver.set_mac_address(nil)
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/action/package.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "vagrant/action/general/package"
+
+module VagrantPlugins
+  module Utm
+    module Action
+      # This action packages the virtual machine into a box
+      class Package < Vagrant::Action::General::Package
+        # Doing this so that we can test that the parent is properly
+        # called in the unit tests.
+        alias general_call call
+        def call(env)
+          general_call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/action/package_setup_files.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "vagrant/action/general/package_setup_files"
+
+module VagrantPlugins
+  module Utm
+    module Action
+      # This action sets up the files that are used in the package process.
+      class PackageSetupFiles < Vagrant::Action::General::PackageSetupFiles
+        # Doing this so that we can test that the parent is properly
+        # called in the unit tests.
+        alias general_call call
+        def call(env)
+          general_call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/action/package_setup_folders.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "fileutils"
+
+require "vagrant/action/general/package_setup_folders"
+
+module VagrantPlugins
+  module Utm
+    module Action
+      # This action sets up the folders that are used in the package process.
+      class PackageSetupFolders < Vagrant::Action::General::PackageSetupFolders
+        # Doing this so that we can test that the parent is properly
+        # called in the unit tests.
+        alias general_call call
+        def call(env)
+          general_call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/action/package_vagrantfile.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "vagrant/util/template_renderer"
+
+module VagrantPlugins
+  module Utm
+    module Action
+      # This middleware class sets up the Vagrantfile that will be placed
+      # into the root of the exported box.
+      class PackageVagrantfile
+        # For TemplateRenderer
+        include Vagrant::Util
+
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          @env = env
+          create_vagrantfile
+          @app.call(env)
+        end
+
+        # This method creates the auto-generated Vagrantfile at the root of the
+        # box. This Vagrantfile can contain anything that might be essential for user.
+        # Ex: Mac Address (for VirtualBox), etc.
+        # Currently nothing is added to the Vagrantfile.
+        def create_vagrantfile
+          File.open(File.join(@env["export.temp_dir"], "Vagrantfile"), "w") do |f|
+            f.write(TemplateRenderer.render("package_Vagrantfile"))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/action/set_id.rb

@@ -3,7 +3,7 @@
 module VagrantPlugins
   module Utm
     module Action
-      # This action destroys the running machine.
+      # This action sets the machine id to the UUID of the VM in UTM.
       class SetId
         def initialize(app, _env)
           @app = app

data/lib/vagrant_utm/action.rb

@@ -21,20 +21,25 @@ module VagrantPlugins
       autoload :Created, action_root.join("created")
       autoload :Customize, action_root.join("customize")
       autoload :Destroy, action_root.join("destroy")
-      autoload :DownloadConfirm, action_root.join("download_confirm")
       autoload :Export, action_root.join("export")
       autoload :ForcedHalt, action_root.join("forced_halt")
       autoload :ForwardPorts, action_root.join("forward_ports")
       autoload :Import, action_root.join("import")
+      autoload :IpAddress, action_root.join("ip_address")
       autoload :IsPaused, action_root.join("is_paused")
       autoload :IsRunning, action_root.join("is_running")
       autoload :IsStopped, action_root.join("is_stopped")
+      autoload :MatchMACAddress, action_root.join("match_mac_address")
       autoload :MessageAlreadyRunning, action_root.join("message_already_running")
       autoload :MessageNotCreated, action_root.join("message_not_created")
       autoload :MessageNotRunning, action_root.join("message_not_running")
       autoload :MessageNotStopped, action_root.join("message_not_stopped")
       autoload :MessageWillNotCreate, action_root.join("message_will_not_create")
       autoload :MessageWillNotDestroy, action_root.join("message_will_not_destroy")
+      autoload :Package, action_root.join("package")
+      autoload :PackageSetupFiles, action_root.join("package_setup_files")
+      autoload :PackageSetupFolders, action_root.join("package_setup_folders")
+      autoload :PackageVagrantfile, action_root.join("package_vagrantfile")
       autoload :PrepareForwardedPortCollisionParams, action_root.join("prepare_forwarded_port_collision_params")
       autoload :Resume, action_root.join("resume")
       autoload :SetId, action_root.join("set_id")
@@ -137,6 +142,23 @@ module VagrantPlugins
         end
       end
 
+      # This action returns ip address of the machine.
+      # UTM equivalent of `utmctl ip-address <uuid>`
+      def self.action_ip_address
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckUtm
+          b.use ConfigValidate
+          b.use Call, IsRunning do |env1, b2|
+            unless env1[:result]
+              b2.use MessageNotRunning
+              next
+            end
+            # If the VM is running, then get the IP address.
+            b2.use IpAddress
+          end
+        end
+      end
+
       # This action packages the virtual machine into a single box file.
       def self.action_package
         Vagrant::Action::Builder.new.tap do |b|
@@ -146,10 +168,15 @@ module VagrantPlugins
               b2.use MessageNotCreated
               next
             end
+
+            b2.use PackageSetupFolders
+            b2.use PackageSetupFiles
             b2.use CheckAccessible
             b2.use action_halt
             b2.use ClearForwardedPorts
+            b2.use Package
             b2.use Export
+            b2.use PackageVagrantfile
           end
         end
       end
@@ -321,6 +348,7 @@ module VagrantPlugins
         Vagrant::Action::Builder.new.tap do |b|
           b.use CheckUtm
           b.use ConfigValidate
+          b.use BoxCheckOutdated
           b.use Call, IsRunning do |env, b2|
             # If the VM is running, run the necessary provisioners
             if env[:result]
@@ -342,12 +370,14 @@ module VagrantPlugins
         end
       end
 
-      # This action start VM in disposable mode.
+      # This action starts VM in disposable mode.
       # UTM equivalent of `utmctl start <uuid> --disposable`
       def self.action_start_disposable
         Vagrant::Action::Builder.new.tap do |b|
           b.use CheckUtm
           b.use ConfigValidate
+          b.use CheckCreated
+
           b.use Call, IsRunning do |env1, b2|
             if env1[:result]
               b2.use MessageAlreadyRunning
@@ -376,35 +406,31 @@ module VagrantPlugins
       end
 
       # This action brings the machine up from nothing, including importing
-      # the UTM file, configuring metadata, and booting.
-      def self.action_up # rubocop:disable Metrics/AbcSize
+      # the box, configuring metadata, and booting.
+      def self.action_up
         Vagrant::Action::Builder.new.tap do |b|
           b.use CheckUtm
+
+          # Handle box_url downloading early so that if the Vagrantfile
+          # references any files in the box or something it all just
+          # works fine.
+          b.use Call, Created do |env, b2|
+            b2.use HandleBox unless env[:result]
+          end
+
           b.use ConfigValidate
           b.use Call, Created do |env, b2|
             # If the VM is NOT created yet, then do the setup steps
             unless env[:result]
               b2.use CheckAccessible
               b2.use Customize, "pre-import"
-              # load UTM file to UTM app, through 'utm://downloadVM?url='
-              b2.use Import
 
-              b2.use Call, DownloadConfirm do |env1, b3|
-                if env1[:result]
-                  # SetID
-                  b3.use SetId
-                  b3.use SetName
-                  # Customize
-                  b3.use Customize, "pre-boot"
-                else
-                  b3.use MessageWillNotCreate
-                  raise Errors::UtmImportFailed
-                end
-              end
+              b2.use Import
+              b2.use MatchMACAddress
             end
           end
 
-          # Start the VM
+          b.use EnvSet, cloud_init: true
           b.use action_start
         end
       end

data/lib/vagrant_utm/commands/disposable.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module Utm
+    # Run VM as a snapshot and do not save changes to disk.
+    class CommandDisposable < Vagrant.plugin(2, :command)
+      def self.synopsis
+        "UTM: boots machine in UTM disposable mode"
+      end
+
+      def execute
+        opts = OptionParser.new do |o|
+          o.banner = "Usage: vagrant disposable [name|id]"
+        end
+
+        # Parse the options
+        argv = parse_options(opts)
+        return unless argv
+
+        with_target_vms do |machine|
+          machine.action(:start_disposable)
+        end
+
+        # Success, exit status 0
+        0
+      end
+    end
+  end
+end

data/lib/vagrant_utm/commands/ip_address.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module Utm
+    # Get All IP Adress of a machine.
+    class CommandIpAddress < Vagrant.plugin(2, :command)
+      def self.synopsis
+        "UTM: outputs ip address of the vagrant machine"
+      end
+
+      def execute
+        opts = OptionParser.new do |o|
+          o.banner = "Usage: vagrant ip-address [name|id]"
+        end
+
+        # Parse the options
+        argv = parse_options(opts)
+        return unless argv
+
+        with_target_vms do |machine|
+          machine.action(:ip_address)
+        end
+
+        0
+      end
+    end
+  end
+end

data/lib/vagrant_utm/config.rb

@@ -12,11 +12,6 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :name
 
-      # The path to the UTM VM file.
-      #
-      # @return [String]
-      attr_accessor :utm_file_url
-
       # If true, will check if guest additions are installed and up to
       # date. By default, this is true.
       #
@@ -39,7 +34,6 @@ module VagrantPlugins
         @check_guest_additions = UNSET_VALUE
         @customizations = []
         @name = UNSET_VALUE
-        @utm_file_url = UNSET_VALUE
         @wait_time = UNSET_VALUE
       end
 
@@ -112,16 +106,13 @@ module VagrantPlugins
         # The default name is just nothing, and we default it
         @name = nil if @name == UNSET_VALUE
 
-        @utm_file_url = nil if @utm_file_url == UNSET_VALUE
-
         @wait_time = 20 if @wait_time == UNSET_VALUE
       end
 
       def validate(_machine)
         errors = _detected_errors
 
-        # Checks for the UTM file URL
-        errors << I18n.t("vagrant_utm.config.utm_file_url_required") if @utm_file_url.nil? || @utm_file_url.empty?
+        # Add errors if config is invalid Ex: required fields are not set
 
         valid_events = %w[pre-import pre-boot post-boot post-comm]
         @customizations.each do |event, _| # rubocop:disable Style/HashEachMethods

data/lib/vagrant_utm/driver/base.rb

@@ -86,9 +86,10 @@ module VagrantPlugins
         # @return [Array]
         def read_used_ports(active_only: true); end
 
-        # Returns the IP address of the guest machine.
+        # Returns the  IP addresses of the guest machine.
+        # Only supported for VMs with qemu-guest-agent installed.
         #
-        # @return [String] The IP address of the guest machine.
+        # @return [Array<String>] The IP addresses of the guest machine.
         def read_guest_ip; end
 
         # Returns a list of network interfaces of the VM.
@@ -96,15 +97,19 @@ module VagrantPlugins
         # @return [Hash]
         def read_network_interfaces; end
 
+        # Sets the MAC address of the first network adapter.
+        #
+        # @param [String] mac MAC address without any spaces/hyphens.
+        def set_mac_address(mac); end # rubocop:disable Naming/AccessorMethodName
+
         # Execute the 'list' command and returns the list of machines.
         # @return [ListResult] The list of machines.
         def list; end
 
-        # Execute the 'utm://downloadVM?url='
-        # See https://docs.getutm.app/advanced/remote-control/
-        # @param utm_file_url [String] The url to the UTM file.
+        # Import a virtual machine from a UTM file.
+        # @param utm_file [String] The url to the UTM file.
         # @return [uuid] The UUID of the imported machine.
-        def import(utm_file_url); end
+        def import(utm_file); end
 
         # Sets the name of the virtual machine.
         # @param name [String] The new name of the machine.
@@ -143,6 +148,21 @@ module VagrantPlugins
         # This should raise a VagrantError if things are not ready.
         def verify!; end
 
+        # Generate a random MAC address.
+        #
+        # This method generates a random MAC address because it is difficult
+        # to get UTM to generate one through scripting.
+        #
+        # @return [String] The MAC address.
+        def random_mac_address
+          # Generate 6 random bytes
+          bytes = Array.new(6) { rand(256) }
+          # Ensure the first byte is local
+          bytes[0] = (bytes[0] & 0xFC) | 0x02
+          # Convert bytes to MAC address string
+          bytes.map { |byte| format("%02X", byte) }.join(":")
+        end
+
         # Execute a script using the OSA interface.
         def execute_osa_script(command); end
 

data/lib/vagrant_utm/driver/meta.rb

@@ -55,12 +55,12 @@ module VagrantPlugins
           # Instantiate the proper version driver for UTM
           @logger.debug("Finding driver for UTM version: #{@version}")
           driver_map = {
-            "4.5" => Version_4_5
+            "4.6" => Version_4_6
           }
 
-          # UTM 4.5.0 just doesn't work with Vagrant (https://github.com/utmapp/UTM/issues/5963),
+          # UTM 4.6.0  doesn't have import support to work with Vagrant box,
           # so show error
-          raise Errors::UtmInvalidVersion if @version.start_with?("4.5.0")
+          raise Errors::UtmInvalidVersion if @version.start_with?("4.6.0")
 
           driver_klass = nil
           driver_map.each do |key, klass|
@@ -92,6 +92,7 @@ module VagrantPlugins
                        :delete,
                        :delete_snapshot,
                        :execute_osa_script,
+                       :export,
                        :forward_ports,
                        :halt,
                        :import,
@@ -104,6 +105,7 @@ module VagrantPlugins
                        :read_state,
                        :read_used_ports,
                        :restore_snapshot,
+                       :set_mac_address,
                        :set_name,
                        :ssh_port,
                        :start,

data/lib/vagrant_utm/driver/version_4_5.rb

@@ -14,7 +14,7 @@ module VagrantPlugins
         def initialize(uuid)
           super()
 
-          @logger = Log4r::Logger.new("vagrant::provider::utm_4_5")
+          @logger = Log4r::Logger.new("vagrant::provider::utm::version_4_5")
           @uuid = uuid
         end
 
@@ -52,6 +52,11 @@ module VagrantPlugins
           execute_shell("qemu-img", "snapshot", "-d", snapshot_name, machine_file)
         end
 
+        def export(_path)
+          @logger.info("This version of UTM does not support exporting VMs
+            Please upgrade to the latest version of UTM or UTM 'Share' feature in UI to export the virtual machine")
+        end
+
         def list_snapshots(machine_id) # rubocop:disable Metrics/AbcSize
           list_result = list
           machine_name = list_result.find(uuid: machine_id).name
@@ -169,9 +174,8 @@ module VagrantPlugins
         end
 
         def read_guest_ip
-          command = ["read_guest_ip.applescript", @uuid]
-          output = execute_osa_script(command)
-          output.strip
+          output = execute("ip-address", @uuid)
+          output.strip.split("\n")
         end
 
         def read_network_interfaces
@@ -190,6 +194,14 @@ module VagrantPlugins
           nics
         end
 
+        def set_mac_address(mac) # rubocop:disable Naming/AccessorMethodName
+          # Set the MAC address of the first NIC (index 0)
+          # Set MAC address to given value or randomize it if nil
+          mac = random_mac_address if mac.nil?
+          command = ["set_mac_address.applescript", @uuid, "0", mac]
+          execute_osa_script(command)
+        end
+
         def ssh_port(expected_port)
           @logger.debug("Searching for SSH port: #{expected_port.inspect}")
 

data/lib/vagrant_utm/driver/version_4_6.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require File.expand_path("version_4_5", __dir__)
+
+module VagrantPlugins
+  module Utm
+    module Driver
+      # Driver for UTM 4.6.x
+      class Version_4_6 < Version_4_5 # rubocop:disable Naming/ClassAndModuleCamelCase
+        def initialize(uuid)
+          super
+
+          @logger = Log4r::Logger.new("vagrant::provider::utm::version_4_6")
+        end
+
+        def import(utm)
+          utm = Vagrant::Util::Platform.windows_path(utm)
+
+          vm_id = nil
+
+          command = ["import_vm.applescript", utm]
+          output = execute_osa_script(command)
+
+          @logger.debug("Import output: #{output}")
+
+          # Check if we got the VM ID
+          if output =~ /virtual machine id ([A-F0-9-]+)/
+            vm_id = ::Regexp.last_match(1) # Capture the VM ID
+          end
+
+          vm_id
+        end
+
+        def export(path)
+          @logger.debug("Exporting UTM file to: #{path}")
+          command = ["export_vm.applescript", @uuid, path]
+          execute_osa_script(command)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/model/forwarded_port.rb

@@ -57,7 +57,9 @@ module VagrantPlugins
           options ||= {}
           @auto_correct = false
           @auto_correct = options[:auto_correct] if options.key?(:auto_correct)
-          @adapter  = (options[:adapter] || 1).to_i # if adapter is not set, use 1. index 0 is the default adapter
+          # if adapter is not set, use index 1 (Emulated VLAN).
+          # index 0 is the default adapter (Shared Network)
+          @adapter  = (options[:adapter] || 1).to_i
           @guest_ip = options[:guest_ip] || nil
           @host_ip = options[:host_ip] || nil
           @protocol = options[:protocol] || "tcp" # default to TCP

data/lib/vagrant_utm/plugin.rb

@@ -21,12 +21,7 @@ module VagrantPlugins
       DESCRIPTION
 
       # Register the provider
-      # TODO: Define box format for UTM
-      # IDEA: UTM file comes as a zip file containing
-      # directory with Data/qcow2, Data/efi_vars.fd and config.plist
-      # Box format will only require additional metadata.json file
-      # Till then use UTM file directly and so box_optional: true
-      provider(:utm, box_optional: true, parallel: false) do
+      provider(:utm, box_optional: false, parallel: false) do
         setup_i18n
         require_relative "provider"
         Provider
@@ -50,9 +45,17 @@ module VagrantPlugins
       end
 
       # Register the command
+      ## Start machine as a snapshot and do not save changes to disk
       command "disposable" do
-        require_relative "disposable"
-        Disposable
+        require_relative "commands/disposable"
+        CommandDisposable
+      end
+
+      ## Get the IP address of the machine
+      ## Only supported if machine as qemu-guest-additions
+      command "ip-address" do
+        require_relative "commands/ip_address"
+        CommandIpAddress
       end
 
       # Load the translation files

data/lib/vagrant_utm/provider.rb

@@ -94,6 +94,8 @@ module VagrantPlugins
         # 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.
+        # and the forwarded port.
+        # So we use 127.0.0.1 and the forwarded port to connect to the VM.
         {
           host: "127.0.0.1",
           port: @driver.ssh_port(@machine.config.ssh.guest_port)
@@ -124,7 +126,6 @@ module VagrantPlugins
         Vagrant::MachineState.new(state_id, short, long)
       end
 
-      # TODO: Get UUID of the VM from UTM
       # Returns a human-friendly string version of this provider which
       # includes the machine's ID that this provider represents, if it
       # has one.