vagrant_utm 0.1.2.beta → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4afb59e8282747e3cca61c9ed2b297b7084606c268cc4e6231856f12fb2510b0
-  data.tar.gz: 1a4ba9a73219106a661fdddad221d14128d203fc8c273dc22fa3018d72b25e0b
+  metadata.gz: bc0499e6b39496b2bd9590d3683631bcc213f7b0f4f1a5fc259b9373e160da33
+  data.tar.gz: 36b2a3029c3d8ddb9d4e84865f657a989732495f59adf90e4f2eb19731780ae0
 SHA512:
-  metadata.gz: 01e79bc38a232a68a08eb43e7cddfcc2ed0866acd54a559b797e8c26f84fce16c5d8ec171492758fc514080c8b98be32dd2505554f9e04a8c2897a1d05fb3d2a
-  data.tar.gz: '07951106f1403e2bb7811f699ed914c12eb701e15cb4142f6f2318a2ffc4fd9065e49bfdc098b544d547f3129005b4cf8370bad9d513a356d0b9c9b77b8b2719'
+  metadata.gz: adf69f5cc2fbb3d73e5453b761d374dfd29aded42d1581927a1bbfea2405a93817c11e4a79de57d1c144b6acd120e4d21dceb9140c38083436605f2f2f4a2889
+  data.tar.gz: c305e4949e66c6643646025c649dba12093e228dbbe298b0aada54be0974fa526bfdded85afbcf2b0c062d1982100f601bb77d290784b9d4b57e8fc4173644cf

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 ## [Unreleased]
 
 
+## [0.1.3] - 2025-04-20
+
+### Added 
+
+- Implements VirtFS synced folder in UTM using qemu additional args and vm registry (for permission)
+
+### Changed
+
+- Config: Makes `virtFS` as default directory_share_mode in UTM
+
+### Removed
+
+- Driver: Removed support for UTM versions < 4.6.5 
+
 ## [0.1.2.beta] - 2024-12-05
 
 WARNING: This version of the plugin adds initial synced folder support. By default, Vagrant will pick the directory share method which it supports and prefers. e.g., SMB. However, SMB is not fully tested, so you need to force the plugin to pick the one that is simple and tested `rsync`

data/README.md

@@ -15,7 +15,7 @@ vagrant plugin install vagrant_utm
 
 ```ruby
 Vagrant.configure("2") do |config|
-  config.vm.box = "utm/debian11"
+  config.vm.box = "utm/bookworm"
 end
 ```
 

data/docs/Gemfile.lock

@@ -261,8 +261,8 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.8.0)
-    uri (0.13.0)
-    webrick (1.8.1)
+    uri (0.13.2)
+    webrick (1.8.2)
 
 PLATFORMS
   arm64-darwin

data/docs/_config.yml

@@ -28,8 +28,8 @@ nav_external_links:
     url: https://mac.getutm.app
   - title: Packer plugin for UTM
     url: https://github.com/naveenrajm7/packer-plugin-utm
-  # - title: GitHub
-  #   url: https://github.com/naveenrajm7/vagrant_utm
+  - title: UTM Gallery
+    url: https://naveenrajm7.github.io/utm-gallery/
 
 
 # Aux links for the upper right navigation

data/docs/boxes/creating_utm_box.md

@@ -60,17 +60,18 @@ Check the [UTM Guide on Guest Support](https://docs.getutm.app/guest-support/gue
 
 By satisfying the [general guidance on creating vagrant boxes](https://developer.hashicorp.com/vagrant/docs/boxes/base) and the above [Virtual Machine](#virtual-machine) requirements you can use your VM with Vagrant UTM plugin.
 
-Apart from manually building the boxes, you can also use the semi-automated way of building these boxes using [packer plugin for UTM](https://github.com/naveenrajm7/packer-plugin-utm).
+Apart from manually building the boxes, you can also use the automated (almost) way of building these boxes using [packer plugin for UTM](https://github.com/naveenrajm7/packer-plugin-utm).
 The packer plugin has the following components:
 1. Builder
-  1. UTM - Use existing utm file 
-  2. ISO - Start from scratch using ISO files
+    1. UTM - Use existing utm file 
+    2. ISO - Start from scratch using ISO files  
+    3. CLOUD - Use existing qcow2 cloud images
 2. Post-processor
-  1. ZIP - Package UTM VM into zip file
-  2. Vagrant - Package UTM VM into vagrant box.
+    1. ZIP - Package UTM VM into zip file
+    2. Vagrant - Package UTM VM into vagrant box.
 
 
-Checkout [UTM Box Guide](https://github.com/naveenrajm7/utm-box/blob/main/HowToBuild/DebianUTM.md) to know how to build Box using packer.
+Checkout [UTM Box Packer recipe](https://github.com/naveenrajm7/utm-box?tab=readme-ov-file#building-boxes) to know how to build Box using packer.
 
 ## Using your own UTM VMs
 

data/docs/boxes/utm_box_gallery.md

@@ -10,22 +10,27 @@ nav_order: 1
 To work with Vagrant, a base VM (box) must have 
 [certain features](https://developer.hashicorp.com/vagrant/docs/boxes/base), like an ssh user for vagrant to connect.
 
-To help you get started with Vagrant UTM provider, a couple of pre-built VMs that work with Vagrant and are published in [HCP Vagrant registry](https://portal.cloud.hashicorp.com/vagrant/discover/utm).
+To help you get started with Vagrant UTM provider, some pre-built VMs that work with Vagrant are published in [HCP Vagrant registry](https://portal.cloud.hashicorp.com/vagrant/discover/utm).
 
 {: .important}
-All the VMs provided are built from [UTM Gallery VMs](https://mac.getutm.app/gallery/) or ISO in an (semi) automated way using [packer plugin for UTM][packer plugin for UTM]. Please see the [UTM Box Guide][UTM Box Guide] on how these UTM Vagrant boxes were built using packer.
+All the VMs provided are built from Cloud Images or ISO files in an (semi) automated way using [packer plugin for UTM][packer plugin for UTM]. Please see the [UTM Box Guide][UTM Box Guide] on how these UTM Vagrant boxes were built using packer.
 
-* Debian 11 (Xfce):   
+* Debian 12 - Built from cloud image:   
+```ruby
+config.vm.box = "utm/bookworm"
+```
+
+* Debian 11 (Xfce) - Built from UTM file of UTM gallery:   
 ```ruby
 config.vm.box = "utm/debian11"
 ```
 
-* Ubuntu 24.04 :
+* Ubuntu 24.04 - Built from ISO:
 ```ruby
 config.vm.box = "utm/ubuntu-24.04"
 ```
 
-* Help build more boxes using [packer plugin for UTM][packer plugin for UTM]
+* Build your own boxes using [packer plugin for UTM][packer plugin for UTM]
 <!-- * ArchLinux ARM -->
 
 

data/docs/features/synced_folders.md

@@ -7,22 +7,22 @@ nav_order: 1
 
 # Synced Folders
 
-UTM Vagrant plugin currently gives rudimentary support for syncing folders between host and guest machine.
-The plugin provides option to configure the Qemu directory share mode. 
-After which the the host directory can be selected from UTM UI, and the guest directory can be mounted in guest OS. Both of these steps are now manual until UTM exposes API to configure Host/Guest directory.
+UTM Vagrant plugin has support for syncing multiple folders between host and guest machine.
+The plugin implements [UTM QEMU VirtFS](https://docs.getutm.app/guest-support/linux/#virtfs) as the default synced folder implementation for UTM provider.
 
 ```ruby
 Vagrant.configure("2") do |config|
-  config.vm.box = "utm/debian11"
-  config.vm.provider :utm do |u|
-    # QEMU Directoy Share mode for the VM. 
-    # Takes none, webDAV or virtFS
-    u.directory_share_mode = "webDAV"
-  end
+  config.vm.box = "utm/bookworm"
+  config.vm.synced_folder "../test", "/vagrant-test"
 end
 ```
 
-## Other Vagrant options
+Vagrant by default syncs the current folder where that Vagrantfile is, and you can access them at `/vagrant` in the guest.
 
 {: .important}
-Apart from the provider specific Sync options, Vagrant has components to provide sync folders feature using NFS and RSync. These features are not yet supported in UTM plugin.
+
+
+## Other Vagrant options
+
+Apart from the provider specific Sync options, Vagrant has components to provide sync folders feature using NFS and RSync. These features are also supported in UTM plugin.
+Check all Vagrant provided sync options at [Vagrant synced folders](https://developer.hashicorp.com/vagrant/docs/synced-folders).

data/docs/index.md

@@ -19,8 +19,8 @@ allowing Vagrant to control and provision machines via UTM's API.
 ---
 
 {: .new}
-> UTM Vagrant plugin now supports [Vagrant boxes](https://developer.hashicorp.com/vagrant/docs/boxes)!   
-> Find UTM boxes at [HCP Vagrant registry](https://portal.cloud.hashicorp.com/vagrant/discover/utm). 
+> Plugin now supports [Vagrant boxes](https://developer.hashicorp.com/vagrant/docs/boxes)!, find UTM boxes at [HCP Vagrant registry](https://portal.cloud.hashicorp.com/vagrant/discover/utm)  
+> Plugin now supports multiple synced folders, check out [Synced Folder](features/synced_folders.md)
 
 [UTM] is a free, full-featured system emulator and virtual machine host for iOS and macOS.  
 The UTM provider currently supports UTM versions 
@@ -59,14 +59,14 @@ vagrant plugin install vagrant_utm
 Option 1: Create a Vagrantfile and initiate the box (OR)
 
 ```
-vagrant init utm/debian11
+vagrant init utm/bookworm
 ```
 
 Option 2: Open the Vagrantfile and replace the contents with the following
 
 ```ruby
 Vagrant.configure("2") do |config|
-  config.vm.box = "utm/debian11"
+  config.vm.box = "utm/bookworm"
 end
 ```
 
@@ -81,9 +81,9 @@ Now start using your machine!
 
 `vagrant ssh` to log into machine or forward ports to check your website or share folders and start developing.
 
-Check [Commands](commands.md) for all supported Vagrant commands.
-Check [Configuration](configuration.md) for more UTM provider config options.
-
+Check [Commands](commands.md) for all supported Vagrant commands.  
+Check [Configuration](configuration.md) for more UTM provider config options.  
+Discover UTM Vagrant boxes at [HCP Vagrant UTM Registry](https://portal.cloud.hashicorp.com/vagrant/discover/utm), which as boxes of popular OS including OpenBSD!  
 
 ## About the project
 

data/docs/internals/actions.md

@@ -17,4 +17,5 @@ The Table below maps the vagrant commands to the corresponding UTM commands that
 | `vagrant destroy`     | `utmctl delete` | 
 | `vagrant status`      | `utmctl status` | 
 | `vagrant disposable`  | `utmctl start --disposable` | 
-| `vagrant snapshot`    | `qemu-img snapshot`         |
+| `vagrant snapshot`    | `qemu-img snapshot`         |
+| `vagrant ip-address`  | `utmctl ip-address`         |

data/docs/known_issues.md

@@ -5,7 +5,7 @@ nav_order: 7
 
 # Known Issues
 
-This plugin was built built around the existing UTM API.
+This plugin is built around the existing UTM API.
 Hence there are things which are not ideal.
 
 1. ~~vagrant up : Loads new VM by downloading zip file every time, and manually asks the user to confirm the download completion.~~   
@@ -21,4 +21,4 @@ Draw back -  UTM does not expose export API. (UTM already has 'Share')~~
 
 5. vagrant snapshot: Even though UTM does not have snapshot feature, this plugin has a experimental support for offline VM snapshots using qemu-img. 
 The VM must be stopped, for any snapshot commands to work.
-The snapshot only works for **single** qcow2 based VM images
+The snapshot only works for **single** qcow2 based VM images

data/lib/vagrant_utm/cap/mount_options.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require_relative "../util/unix_mount_helpers"
+
+module VagrantPlugins
+  module Utm
+    module Cap
+      # Capability for mount options
+      module MountOptions
+        extend VagrantPlugins::SyncedFolder::UnixMountHelpers
+
+        # Mount type for VirtFS
+        UTM_MOUNT_TYPE = "9p"
+
+        # Returns mount options for a utm synced folder
+        #
+        # @param [Machine] machine
+        # @param [String] name of mount
+        # @param [String] path of mount on guest
+        # @param [Hash] hash of mount options
+        def self.mount_options(machine, _name, guest_path, options)
+          mount_options = options.fetch(:mount_options, [])
+          detected_ids = detect_owner_group_ids(machine, guest_path, mount_options, options)
+          mount_uid = detected_ids[:uid]
+          mount_gid = detected_ids[:gid]
+
+          # VirtFS mount options
+          mount_options << "trans=virtio"
+          mount_options << "version=9p2000.L"
+          mount_options << if mount_options.include?("ro")
+                             "ro"
+                           else
+                             "rw"
+                           end
+          mount_options << "_netdev"
+          mount_options << "nofail"
+
+          mount_options = mount_options.join(",")
+          [mount_options, mount_uid, mount_gid]
+        end
+
+        def self.mount_type(_machine)
+          UTM_MOUNT_TYPE
+        end
+
+        def self.mount_name(_machine, name, _data)
+          name.gsub(%r{[\s/\\]}, "_").sub(/^_/, "")
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/config.rb

@@ -7,11 +7,6 @@ module VagrantPlugins
   module Utm
     # This is the configuration class for the UTM provider.
     class Config < Vagrant.plugin("2", :config)
-      # This should be set to the name of the machine in the UTM GUI.
-      #
-      # @return [String]
-      attr_accessor :name
-
       # If true, will check if guest additions are installed and up to
       # date. By default, this is true.
       #
@@ -23,6 +18,19 @@ module VagrantPlugins
       # @return [Array]
       attr_reader :customizations
 
+      # Whether or not this VM has a functional VirtFS 9P filesystem module
+      # for VirtFS directory sharing to work.
+      # This defaults to true. If you set this to false, then the "utm"
+      # synced folder type won't be valid.
+      #
+      # @return [Boolean]
+      attr_accessor :functional_9pfs
+
+      # This should be set to the name of the machine in the UTM GUI.
+      #
+      # @return [String]
+      attr_accessor :name
+
       # The time to wait for the VM to be 'running' after 'started'.
       #
       # @return [Integer]
@@ -33,6 +41,7 @@ module VagrantPlugins
         super
         @check_guest_additions = UNSET_VALUE
         @customizations = []
+        @functional_9pfs = UNSET_VALUE
         @name = UNSET_VALUE
         @wait_time = UNSET_VALUE
       end
@@ -76,6 +85,8 @@ module VagrantPlugins
         customize("pre-boot", ["customize_vm.applescript", :id, "--notes", notes])
       end
 
+      # TODO: All warning if user sets directory_share_mode,
+      # because default implementation is 'virtFS'
       # Shortcut for setting the directory share mode of the virtual machine.
       # Calls #customize internally.
       #
@@ -101,8 +112,13 @@ module VagrantPlugins
       # This is the hook that is called to finalize the object before it
       # is put into use.
       def finalize!
+        # By default, we check for guest additions (qemu-ga)
         @check_guest_additions = true if @check_guest_additions == UNSET_VALUE
-
+        # Always set the directory share mode to 'virtFS'
+        # default share folder implementation in utm plugin
+        self.directory_share_mode = "virtFS"
+        # By default, we assume the VM supports virtio 9p filesystems
+        @functional_9pfs = true if @functional_9pfs == UNSET_VALUE
         # The default name is just nothing, and we default it
         @name = nil if @name == UNSET_VALUE
 
@@ -127,6 +143,10 @@ module VagrantPlugins
 
         { "UTM Provider" => errors }
       end
+
+      def to_s
+        "UTM"
+      end
     end
   end
 end

data/lib/vagrant_utm/driver/meta.rb

@@ -58,9 +58,14 @@ module VagrantPlugins
             "4.6" => Version_4_6
           }
 
-          # 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.6.0")
+          # UTM version < 4.6.5  doesn't have
+          # import support to work with Vagrant box (< 4.6.1)
+          # registry support to work with synced folders (< 4.6.5)
+          # Restrict to UTM versions >= 4.6.5
+          unless Gem::Version.new(@version) >= Gem::Version.new("4.6.5")
+            raise Errors::UtmInvalidVersion,
+                  supported_versions: "4.6.5 or earlier"
+          end
 
           driver_klass = nil
           driver_map.each do |key, klass|
@@ -88,6 +93,7 @@ module VagrantPlugins
         def_delegators :@driver,
                        :check_qemu_guest_agent,
                        :clear_forwarded_ports,
+                       :clear_shared_folders,
                        :create_snapshot,
                        :delete,
                        :delete_snapshot,
@@ -108,6 +114,7 @@ module VagrantPlugins
                        :restore_snapshot,
                        :set_mac_address,
                        :set_name,
+                       :share_folders,
                        :ssh_port,
                        :start,
                        :start_disposable,

data/lib/vagrant_utm/driver/version_4_6.rb

@@ -13,6 +13,25 @@ module VagrantPlugins
           @logger = Log4r::Logger.new("vagrant::provider::utm::version_4_6")
         end
 
+        # Implement clear_shared_folders
+        def clear_shared_folders
+          # Get the list of shared folders
+          shared_folders = read_shared_folders
+          # Get the args to remove the shared folders
+          script_path = @script_path.join("read_shared_folders_args.js")
+          cmd = ["osascript", script_path.to_s, @uuid, "--ids", shared_folders.join(",")]
+          output = execute_shell(*cmd)
+          result = JSON.parse(output)
+          return unless result["status"]
+
+          # Flatten the list of args and build the command
+          sf_args = result["result"].flatten
+          return unless sf_args.any?
+
+          command = ["remove_qemu_additional_args.applescript", @uuid, "--args", *sf_args]
+          execute_osa_script(command)
+        end
+
         def import(utm)
           utm = Vagrant::Util::Platform.windows_path(utm)
 
@@ -36,6 +55,54 @@ module VagrantPlugins
           command = ["export_vm.applescript", @uuid, path]
           execute_osa_script(command)
         end
+
+        def read_shared_folders
+          @logger.debug("Reading shared folders")
+          script_path = @script_path.join("read_shared_folders.js")
+          cmd = ["osascript", script_path.to_s, @uuid]
+          output = execute_shell(*cmd)
+          result = JSON.parse(output)
+          return unless result["status"]
+
+          # Return the list of shared folders names(id)
+          result["result"]
+        end
+
+        def share_folders(folders)
+          # sync folder cleanup will call clear_shared_folders
+          # This is just a precaution, to make sure we don't
+          # have duplicate shared folders
+          shared_folders = read_shared_folders
+          @logger.debug("Shared folders: #{shared_folders}")
+          @logger.debug("Sharing folders: #{folders}")
+
+          folders.each do |folder|
+            # Skip if the folder is already shared
+            next if shared_folders.include?(folder[:name])
+
+            args = ["--id", folder[:name],
+                    "--dir", folder[:hostpath]]
+            command = ["add_folder_share.applescript", @uuid, *args]
+            execute_osa_script(command)
+          end
+        end
+
+        def unshare_folders(folders)
+          @logger.debug("Unsharing folder: #{folder[:name]}")
+          # Get the args to remove the shared folders
+          script_path = @script_path.join("read_shared_folders_args.js")
+          cmd = ["osascript", script_path.to_s, @uuid, "--ids", folders.join(",")]
+          output = execute_shell(*cmd)
+          result = JSON.parse(output)
+          return unless result["status"]
+
+          # Flatten the list of args and build the command
+          sf_args = result["result"].flatten
+          return unless sf_args.any?
+
+          command = ["remove_qemu_additional_args.applescript", @uuid, "--args", *sf_args]
+          execute_osa_script(command)
+        end
       end
     end
   end

data/lib/vagrant_utm/plugin.rb

@@ -33,6 +33,12 @@ module VagrantPlugins
         Config
       end
 
+      # Register the synced folder implementation
+      synced_folder(:utm) do
+        require_relative "synced_folder"
+        SyncedFolder
+      end
+
       # Register capabilities
       provider_capability(:utm, :forwarded_ports) do
         require_relative "cap"
@@ -44,6 +50,21 @@ module VagrantPlugins
         Cap
       end
 
+      synced_folder_capability(:utm, "mount_options") do
+        require_relative "cap/mount_options"
+        Cap::MountOptions
+      end
+
+      synced_folder_capability(:utm, "mount_type") do
+        require_relative "cap/mount_options"
+        Cap::MountOptions
+      end
+
+      synced_folder_capability(:utm, "mount_name") do
+        require_relative "cap/mount_options"
+        Cap::MountOptions
+      end
+
       # Register the command
       ## Start machine as a snapshot and do not save changes to disk
       command "disposable" do

data/lib/vagrant_utm/scripts/add_folder_share.applescript

@@ -0,0 +1,96 @@
+---
+-- add_directory_share.applescript
+-- This script adds QEMU arguments for directory sharing in UTM (QEMU) for given id and directory pairs.
+-- Usage: osascript add_directory_share.applescript UUID --id <ID1> --dir <DIR1> --id <ID2> --dir <DIR2> ...
+-- Example: osascript add_directory_share.applescript UUID --id no1 --dir "/path/to/dir1" --id no2 --dir "/path/to/dir2"
+
+-- Function to create QEMU arguments for directory sharing
+on createQemuArgsForDir(dirId, dirPath)
+
+    -- Prepare the QEMU argument strings
+    set fsdevArgStr to "-fsdev local,id=" & dirId & ",path=" & dirPath & ",security_model=mapped-xattr" 
+    set deviceArgStr to "-device virtio-9p-pci,fsdev=" & dirId & ",mount_tag=" & dirId
+
+    return {fsdevArgStr, deviceArgStr}
+end createQemuArgsForDir
+
+-- Main script
+on run argv
+    -- VM id is assumed to be the first argument
+    set vmId to item 1 of argv 
+
+    -- Initialize variables
+    set idList to {} -- 
+    set dirList to {}
+    set idFlag to false
+    set dirFlag to false
+
+    -- Parse arguments
+    repeat with i from 2 to (count of argv)
+        set currentArg to item i of argv
+        if currentArg is "--id" then
+            set idFlag to true
+            set dirFlag to false
+        else if currentArg is "--dir" then
+            set dirFlag to true
+            set idFlag to false
+        else if idFlag then
+            set end of idList to currentArg
+            set idFlag to false
+        else if dirFlag then
+            set end of dirList to currentArg
+            set dirFlag to false
+        end if
+    end repeat
+
+    -- Ensure the lists are of the same length
+    if (count of idList) is not (count of dirList) then
+        error "The number of IDs and directories must be the same."
+    end if
+
+    -- Initialize the list of QEMU arguments
+    set qemuNewArgs to {}
+
+    -- Initialize the directory list
+    set directoryList to {}
+
+    -- Create QEMU arguments for each directory
+    repeat with i from 1 to (count of dirList)
+        set dirPath to item i of dirList
+        set dirId to item i of idList
+        set dirURL to POSIX file dirPath
+        set {fsdevArgStr, deviceArgStr} to createQemuArgsForDir(dirId, dirPath)
+
+        -- add the directory file obj to the list
+        set end of directoryList to dirURL
+        -- append the arguments to the list
+        set end of qemuNewArgs to {fsdevArg:fsdevArgStr, deviceArg:deviceArgStr, dirURL:dirURL}
+    end repeat
+
+    -- Example usage in UTM
+    tell application  "UTM"
+        set vm to virtual machine id vmId
+        set config to configuration of vm
+
+        -- Get the current QEMU additional arguments
+        set qemuAddArgs to qemu additional arguments of config
+
+        -- Add the new arguments to the existing ones
+        repeat with arg in qemuNewArgs
+        -- SKIP: adding file urls to qemu args file urls , since it is not necessary. UTM#6977
+            set end of qemuAddArgs to {argument string:fsdevArg of arg}
+            set end of qemuAddArgs to {argument string:deviceArg of arg}
+        end repeat
+
+        -- Update the configuration with the new arguments list
+        set qemu additional arguments of config to qemuAddArgs
+        update configuration of vm with config
+
+        -- Get the current directory shares in registry
+        set reg to registry of vm
+        -- Add new directory shares to the registry
+        set reg to reg & directoryList
+        -- Update registry of vm with new directory shares
+        update registry of vm with reg
+    end tell
+end run

data/lib/vagrant_utm/scripts/add_qemu_additional_args.applescript

@@ -0,0 +1,43 @@
+---
+-- add_qemu_additional_args.applescript
+-- This script adds qemu arguments to a specified UTM virtual machine.
+-- Usage: osascript add_qemu_additional_args.applescript <VM_UUID> --args <arg1> <arg2> ...
+-- Example: osascript add_qemu_additional_args.applescript A123 --args "-vnc 127.0.0.1:13" "-vnc..."
+
+on run argv
+  set vmId to item 1 of argv # UUID of the VM
+
+  -- Initialize variables
+  set argsList to {}
+  set argsFlag to false
+
+  -- Parse the --args arguments
+  repeat with i from 2 to (count of argv)
+    set currentArg to item i of argv
+    if currentArg is "--args" then
+      set argsFlag to true
+    else if argsFlag then
+      set end of argsList to currentArg
+    end if
+  end repeat
+
+  tell application "UTM"
+    -- Get the VM and its configuration
+    set vm to virtual machine id vmId -- Id is assumed to be valid
+    set config to configuration of vm
+
+    -- Existing arguments
+    set qemuAddArgs to qemu additional arguments of config
+
+    -- Create new arguments from argsList and add them to the existing arguments
+    repeat with arg in argsList
+      set end of qemuAddArgs to {argument string:arg}
+    end repeat
+
+    --- set qemu args with new args list
+    set qemu additional arguments of config to qemuAddArgs
+
+    --- save the configuration (VM must be stopped)
+    update configuration of vm with config
+  end tell
+end run

data/lib/vagrant_utm/scripts/read_shared_folders.js

@@ -0,0 +1,47 @@
+/**
+ * Reads the shared directory IDs from the QEMU additional arguments of a specified VM in UTM.
+ * 
+ * This function uses the UTM application to read the QEMU additional arguments
+ * of a VM identified by the given VM ID and extracts the IDs of shared directories.
+ * 
+ * @param {string} vmIdentifier - The ID of the VM.
+ * @returns {string} A JSON string containing the shared directory IDs or an error message.
+ */
+function run(argv) {
+  // Check if a VM ID is provided
+  if (argv.length === 0) {
+      console.log("Usage: osascript -l JavaScript read_shared_directories.js <vm_id>");
+      return JSON.stringify({ status: false, result: "No VM ID provided." });
+  }
+
+  const vmIdentifier = argv[0];
+  const utm = Application('UTM');
+  utm.includeStandardAdditions = true;
+
+  try {
+      // Attempt to get the VM by ID
+      const vm = utm.virtualMachines.byId(vmIdentifier);
+      // Get the config of the VM
+      const config = vm.configuration();
+      // Get the QEMU additional arguments
+      const qemuArgs = config.qemuAdditionalArguments;
+      
+      // Extract shared directory IDs
+      const sharedDirIds = [];
+      qemuArgs.forEach(arg => {
+          const argStr = arg.argumentString;
+          if (argStr.startsWith("-fsdev")) {
+              const match = argStr.match(/id=([^,]+)/);
+              if (match) {
+                  sharedDirIds.push(match[1]);
+              }
+          }
+      });
+
+      // Return the shared directory IDs
+      return JSON.stringify({ status: true, result: sharedDirIds });
+  } catch (error) {
+      // Return an error message
+      return JSON.stringify({ status: false, result: error.message });
+  }
+}

data/lib/vagrant_utm/scripts/read_shared_folders_args.js

@@ -0,0 +1,53 @@
+/**
+ * Reads the shared folder QEMU arguments for specified IDs from the QEMU additional arguments of a VM in UTM.
+ * 
+ * This function uses the UTM application to read the QEMU additional arguments
+ * of a VM identified by the given VM ID and extracts the arguments for the specified IDs.
+ * 
+ * @param {string} vmIdentifier - The ID of the VM.
+ * @param {string} ids - Comma-separated list of directory IDs.
+ * @returns {string} A JSON string containing the QEMU arguments for the specified IDs or an error message.
+ */
+function run(argv) {
+  // Check if a VM ID and IDs are provided
+  if (argv.length < 2) {
+      console.log("Usage: osascript -l JavaScript read_shared_folders_args.js <vm_id> --ids <dirID>,<dirID>");
+      return JSON.stringify({ status: false, result: "No VM ID or IDs provided." });
+  }
+
+  const vmIdentifier = argv[0];
+  const idsArgIndex = argv.indexOf("--ids");
+  if (idsArgIndex === -1 || idsArgIndex + 1 >= argv.length) {
+      return JSON.stringify({ status: false, result: "No IDs provided." });
+  }
+  const ids = argv[idsArgIndex + 1].split(",");
+
+  const utm = Application('UTM');
+  utm.includeStandardAdditions = true;
+
+  try {
+      // Attempt to get the VM by ID
+      const vm = utm.virtualMachines.byId(vmIdentifier);
+      // Get the config of the VM
+      const config = vm.configuration();
+      // Get the QEMU additional arguments
+      const qemuArgs = config.qemuAdditionalArguments;
+
+      // Extract QEMU arguments for the specified IDs
+      const sharedDirArgs = [];
+      qemuArgs.forEach(arg => {
+          const argStr = arg.argumentString;
+          ids.forEach(id => {
+              if (argStr.includes(`id=${id}`) || argStr.includes(`fsdev=${id}`)) {
+                  sharedDirArgs.push(argStr);
+              }
+          });
+      });
+
+      // Return the QEMU arguments for the specified IDs
+      return JSON.stringify({ status: true, result: sharedDirArgs });
+  } catch (error) {
+      // Return an error message
+      return JSON.stringify({ status: false, result: error.message });
+  }
+}

data/lib/vagrant_utm/scripts/remove_qemu_additional_args.applescript

@@ -0,0 +1,46 @@
+---
+-- remove_qemu_additional_args.applescript
+-- This script removes specified qemu arguments from a specified UTM virtual machine.
+-- Usage: osascript remove_qemu_additional_args.applescript <VM_UUID> --args <arg1> <arg2> ...
+-- Example: osascript remove_qemu_additional_args.applescript A123 --args "-vnc 127.0.0.1:13" "-vnc..."
+
+on run argv
+  set vmId to item 1 of argv -- UUID of the VM
+
+  -- Initialize variables
+  set argsToRemove to {}
+  set argsFlag to false
+
+  -- Parse the --args arguments
+  repeat with i from 2 to (count of argv)
+    set currentArg to item i of argv
+    if currentArg is "--args" then
+      set argsFlag to true
+    else if argsFlag then
+      set end of argsToRemove to currentArg
+    end if
+  end repeat
+
+  tell application "UTM"
+    -- Get the VM and its configuration
+    set vm to virtual machine id vmId -- Id is assumed to be valid
+    set config to configuration of vm
+
+    -- Get the current QEMU additional arguments
+    set qemuAddArgs to qemu additional arguments of config
+
+    -- Initialize a new list for the updated arguments
+    set updatedArgs to {}
+
+    -- Iterate through the current arguments and add all except the ones to remove
+    repeat with arg in qemuAddArgs
+      if arg is not in argsToRemove then
+        set end of updatedArgs to arg
+      end if
+    end repeat
+
+    -- Update the configuration with the new arguments list
+    set qemu additional arguments of config to updatedArgs
+    update configuration of vm with config
+  end tell
+end run

data/lib/vagrant_utm/synced_folder.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module Utm
+    # Default Synced folder implementation for UTM
+    class SyncedFolder < Vagrant.plugin("2", :synced_folder)
+      def usable?(machine, _raise_errors = false) # rubocop:disable Style/OptionalBooleanParameter
+        # These synced folders only work if the provider is UTM
+        return false if machine.provider_name != :utm
+
+        # This only happens with `vagrant package --base`. Sigh.
+        return true unless machine.provider_config
+
+        machine.provider_config.functional_9pfs
+      end
+
+      # This is called before VM Boot to prepare the synced folders.
+      # Add required configs to the VM.
+      def prepare(machine, folders, _opts)
+        share_folders(machine, folders)
+      end
+
+      # This is called after VM Boot to mount the synced folders.
+      # Mount the shared folders inside the VM.
+      def enable(machine, folders, _opts) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/PerceivedComplexity
+        share_folders(machine, folders)
+
+        # sort guestpaths first, so we don't step on ourselves
+        folders = folders.sort_by do |_id, data|
+          if data[:guestpath]
+            data[:guestpath].length
+          else
+            # A long enough path to just do this at the end.
+            10_000
+          end
+        end
+
+        # Go through each folder and mount
+        machine.ui.output(I18n.t("vagrant.actions.vm.share_folders.mounting"))
+        # refresh fstab
+        fstab_folders = [] # rubocop:disable Lint/UselessAssignment
+        folders.each do |id, data|
+          if data[:guestpath]
+            # Guest path specified, so mount the folder to specified point
+            machine.ui.detail(I18n.t("vagrant.actions.vm.share_folders.mounting_entry",
+                                     guestpath: data[:guestpath],
+                                     hostpath: data[:hostpath]))
+
+            # Dup the data so we can pass it to the guest API
+            data = data.dup
+
+            # Calculate the owner and group
+            ssh_info = machine.ssh_info
+            data[:owner] ||= ssh_info[:username]
+            data[:group] ||= ssh_info[:username]
+
+            # Unmount the folder before we mount it
+            machine.guest.capability(
+              :unmount_virtualbox_shared_folder,
+              data[:guestpath], data
+            )
+
+            # Mount the actual folder
+            machine.guest.capability(
+              :mount_virtualbox_shared_folder,
+              os_friendly_id(id), data[:guestpath], data
+            )
+          else
+            # If no guest path is specified, then automounting is disabled
+            machine.ui.detail(I18n.t("vagrant.actions.vm.share_folders.nomount_entry",
+                                     hostpath: data[:hostpath]))
+          end
+        end
+      end
+
+      def disable(machine, folders, _opts)
+        if machine.guest.capability?(:unmount_virtualbox_shared_folder)
+          folders.each_value do |data|
+            machine.guest.capability(
+              :unmount_virtualbox_shared_folder,
+              data[:guestpath], data
+            )
+          end
+        end
+
+        # Remove the shared folders from the VM metadata
+        names = folders.map { |id, _data| os_friendly_id(id) }
+        driver(machine).unshare_folders(names)
+      end
+
+      def cleanup(machine, _opts)
+        driver(machine).clear_shared_folders if machine.id && machine.id != ""
+      end
+
+      protected
+
+      # This is here so that we can stub it for tests
+      def driver(machine)
+        machine.provider.driver
+      end
+
+      def os_friendly_id(id)
+        id.gsub(%r{[\s/\\]}, "_").sub(/^_/, "")
+      end
+
+      # share_folders sets up the shared folder definitions on the
+      # UTM VM.
+      #
+      def share_folders(machine, folders)
+        defs = []
+
+        folders.each do |id, data|
+          hostpath = data[:hostpath]
+          hostpath = Vagrant::Util::Platform.cygwin_windows_path(hostpath) unless data[:hostpath_exact]
+
+          defs << {
+            name: os_friendly_id(id),
+            hostpath: hostpath.to_s,
+            automount: !data[:automount].nil?
+          }
+        end
+
+        driver(machine).share_folders(defs)
+      end
+    end
+  end
+end

data/lib/vagrant_utm/util/unix_mount_helpers.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+# Copied from vagrant/plugins/synced_folder/unix_mount_helpers.rb
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "shellwords"
+require "vagrant/util/retryable"
+
+module VagrantPlugins
+  module SyncedFolder
+    # Contains helper methods for mounting folders on Unix-based systems.
+    module UnixMountHelpers # rubocop:disable Metrics/ModuleLength
+      def self.extended(klass)
+        unless klass.class_variable_defined?(:@@logger)
+          klass.class_variable_set(:@@logger, Log4r::Logger.new(klass.name.downcase)) # rubocop:disable Style/ClassVars
+        end
+        klass.extend Vagrant::Util::Retryable
+      end
+
+      def detect_owner_group_ids(machine, guest_path, mount_options, options) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+        mount_uid = find_mount_options_id("uid", mount_options)
+        mount_gid = find_mount_options_id("gid", mount_options)
+
+        if mount_uid.nil?
+          if options[:owner].to_i.to_s == options[:owner].to_s
+            mount_uid = options[:owner]
+            class_variable_get(:@@logger).debug("Owner user ID (provided): #{mount_uid}")
+          else
+            output = { stdout: String.new, stderr: String.new } # Ensure strings are not frozen
+            uid_command = "id -u #{options[:owner]}"
+            machine.communicate.execute(uid_command,
+                                        error_class: Vagrant::Errors::VirtualBoxMountFailed,
+                                        error_key: :virtualbox_mount_failed,
+                                        command: uid_command,
+                                        output: output[:stderr]) { |type, data| output[type] << data if output[type] }
+            mount_uid = output[:stdout].chomp
+            class_variable_get(:@@logger).debug("Owner user ID (lookup): #{options[:owner]} -> #{mount_uid}")
+          end
+        else
+          machine.ui.warn "Detected mount owner ID within mount options. (uid: #{mount_uid} guestpath: #{guest_path})"
+        end
+
+        if mount_gid.nil?
+          if options[:group].to_i.to_s == options[:group].to_s
+            mount_gid = options[:group]
+            class_variable_get(:@@logger).debug("Owner group ID (provided): #{mount_gid}")
+          else
+            begin
+              { stdout: String.new, stderr: String.new } # Ensure strings are not frozen
+              gid_command = "getent group #{options[:group]}"
+              machine.communicate.execute(gid_command,
+                                          error_class: Vagrant::Errors::VirtualBoxMountFailed,
+                                          error_key: :virtualbox_mount_failed,
+                                          command: gid_command,
+                                          output: output[:stderr]) { |type, data| output[type] << data if output[type] }
+              mount_gid = output[:stdout].split(":").at(2).to_s.chomp
+              class_variable_get(:@@logger).debug("Owner group ID (lookup): #{options[:group]} -> #{mount_gid}")
+            rescue Vagrant::Errors::VirtualBoxMountFailed
+              if options[:owner] == options[:group] # rubocop:disable Metrics/BlockNesting
+                class_variable_get(:@@logger).debug("Failed to locate group `#{options[:group]}`. Group name matches owner. Fetching effective group ID.") # rubocop:disable Layout/LineLength
+                output = { stdout: String.new }
+                result = machine.communicate.execute("id -g #{options[:owner]}",
+                                                     error_check: false) do |type, data|
+                  output[type] << data if output[type] # rubocop:disable Metrics/BlockNesting
+                end
+                mount_gid = output[:stdout].chomp if result.zero? # rubocop:disable Metrics/BlockNesting
+                class_variable_get(:@@logger).debug("Owner group ID (effective): #{mount_gid}")
+              end
+              raise unless mount_gid
+            end
+          end
+        else
+          machine.ui.warn "Detected mount group ID within mount options. (gid: #{mount_gid} guestpath: #{guest_path})"
+        end
+        { gid: mount_gid, uid: mount_uid }
+      end
+
+      def find_mount_options_id(id_name, mount_options) # rubocop:disable Metrics/AbcSize
+        id_line = mount_options.detect { |line| line.include?("#{id_name}=") }
+        if id_line
+          match = id_line.match(/,?#{Regexp.escape(id_name)}=(?<option_id>\d+),?/)
+          found_id = match["option_id"]
+          updated_id_line = [
+            match.pre_match,
+            match.post_match
+          ].find_all { |string| !string.empty? }.join(",")
+          if updated_id_line.empty?
+            mount_options.delete(id_line)
+          else
+            idx = mount_options.index(id_line)
+            mount_options.delete(idx)
+            mount_options.insert(idx, updated_id_line)
+          end
+        end
+        found_id
+      end
+
+      def emit_upstart_notification(machine, guest_path)
+        # Emit an upstart event if we can
+        machine.communicate.sudo <<-NOTIFICATION.gsub(/^ {12}/, "")
+            if test -x /sbin/initctl && command -v /sbin/init && /sbin/init 2>/dev/null --version | grep upstart; then
+              /sbin/initctl emit --no-wait vagrant-mounted MOUNTPOINT=#{guest_path}
+            fi
+        NOTIFICATION
+      end
+
+      def merge_mount_options(base, overrides) # rubocop:disable Metrics/AbcSize
+        base = base.join(",").split(",")
+        overrides = overrides.join(",").split(",")
+        b_kv = Hash[base.map { |item| item.split("=", 2) }]
+        o_kv = Hash[overrides.map { |item| item.split("=", 2) }]
+        merged = {}.tap do |opts|
+          (b_kv.keys + o_kv.keys).uniq.each do |key|
+            opts[key] = o_kv.fetch(key, b_kv[key])
+          end
+        end
+        merged.map do |key, value|
+          [key, value].compact.join("=")
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/version.rb

@@ -4,6 +4,6 @@ module VagrantPlugins
   # Top level module for the Utm provider plugin.
   module Utm
     # Current version of the Utm provider plugin.
-    VERSION = "0.1.2.beta"
+    VERSION = "0.1.3"
   end
 end

data/notes/README.md

@@ -34,4 +34,17 @@ GHA will publish gems to GHR and rubygems
 
 To update specific gems in the project
 
-`bundle update rubocop`
+`bundle update rubocop`
+
+To update all gems
+
+`bundle update`
+
+To update project after a version bump 
+
+```
+Unable to resolve dependency: user requested 'vagrant_utm (= 0.1.1)'
+```
+
+Due to mismatch versions between global installed version and plugin version in the development setup, since they are same name.
+Fix: Uninstall the global version, while using different version of development setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant_utm
 version: !ruby/object:Gem::Version
-  version: 0.1.2.beta
+  version: 0.1.3
 platform: ruby
 authors:
 - Naveenraj M
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2025-04-21 00:00:00.000000000 Z
 dependencies: []
 description: Vagrant UTM provider that allows you to manage UTM virtual machines.
 email:
@@ -95,6 +95,7 @@ files:
 - lib/vagrant_utm/action/suspend.rb
 - lib/vagrant_utm/action/wait_for_running.rb
 - lib/vagrant_utm/cap.rb
+- lib/vagrant_utm/cap/mount_options.rb
 - lib/vagrant_utm/commands/disposable.rb
 - lib/vagrant_utm/commands/ip_address.rb
 - lib/vagrant_utm/config.rb
@@ -107,7 +108,9 @@ files:
 - lib/vagrant_utm/model/list_result.rb
 - lib/vagrant_utm/plugin.rb
 - lib/vagrant_utm/provider.rb
+- lib/vagrant_utm/scripts/add_folder_share.applescript
 - lib/vagrant_utm/scripts/add_port_forwards.applescript
+- lib/vagrant_utm/scripts/add_qemu_additional_args.applescript
 - lib/vagrant_utm/scripts/clear_port_forwards.applescript
 - lib/vagrant_utm/scripts/customize_vm.applescript
 - lib/vagrant_utm/scripts/downloadVM.sh
@@ -117,8 +120,13 @@ files:
 - lib/vagrant_utm/scripts/open_with_utm.js
 - lib/vagrant_utm/scripts/read_forwarded_ports.applescript
 - lib/vagrant_utm/scripts/read_network_interfaces.applescript
+- lib/vagrant_utm/scripts/read_shared_folders.js
+- lib/vagrant_utm/scripts/read_shared_folders_args.js
+- lib/vagrant_utm/scripts/remove_qemu_additional_args.applescript
 - lib/vagrant_utm/scripts/set_mac_address.applescript
+- lib/vagrant_utm/synced_folder.rb
 - lib/vagrant_utm/util/compile_forwarded_ports.rb
+- lib/vagrant_utm/util/unix_mount_helpers.rb
 - lib/vagrant_utm/version.rb
 - locales/en.yml
 - notes/README.md
@@ -131,7 +139,7 @@ metadata:
   homepage_uri: https://naveenrajm7.github.io/vagrant_utm/
   source_code_uri: https://github.com/naveenrajm7/vagrant_utm
   changelog_uri: https://github.com/naveenrajm7/vagrant_utm/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.11
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Vagrant UTM provider
 test_files: []