vagrant_utm 0.1.1 → 0.1.2.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e58e1f0313976a35281a3233fe67d4150f84c8ec51ed41c2ca55256ba9cae05e
-  data.tar.gz: b5b234e460ef8517720492d3b5695cf771cd52efdd0a60c172ec3d644931b535
+  metadata.gz: 4afb59e8282747e3cca61c9ed2b297b7084606c268cc4e6231856f12fb2510b0
+  data.tar.gz: 1a4ba9a73219106a661fdddad221d14128d203fc8c273dc22fa3018d72b25e0b
 SHA512:
-  metadata.gz: fb95231d43a7f9731d7b36823ff7e991b5e11c9113a60590120b21fcd0d6b420116fe7d39e3465e579e5c1548071d562b50b94142c5f4bb689d13c24a671271b
-  data.tar.gz: b3a7b1655c81f270c6aa8399668fcfd5862201f9d00e9532ba00b7e9609e2d6dc7b5a986b502fd447b39dd303bb92ce1b9f513b7c09e2fa2ccf4a801de5878c4
+  metadata.gz: 01e79bc38a232a68a08eb43e7cddfcc2ed0866acd54a559b797e8c26f84fce16c5d8ec171492758fc514080c8b98be32dd2505554f9e04a8c2897a1d05fb3d2a
+  data.tar.gz: '07951106f1403e2bb7811f699ed914c12eb701e15cb4142f6f2318a2ffc4fd9065e49bfdc098b544d547f3129005b4cf8370bad9d513a356d0b9c9b77b8b2719'

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## [Unreleased]
+
+
+## [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`
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.synced_folder ".", "/vagrant", type: "rsync"
+  config.vm.box = "utm/ubuntu-24.04"
+end
+```
+
+### Added
+
+- Initial Synced Folder support with sync
+- Warning: By default vagrant brings other sync methods eg: SMB, NFS but they are not ready to use.
+
 ## [0.1.1] - 2024-12-03 
 
 IMPORTANT: This version of the plugin only works with UTM version 4.5.1 and above, and is incompatible with 0.0.1 version of the plugin.

data/lib/vagrant_utm/action/prepare_nfs_settings.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module Utm
+    module Action
+      # This action prepares the NFS settings for the machine.
+      class PrepareNFSSettings
+        include Vagrant::Action::Builtin::MixinSyncedFolders
+        include Vagrant::Util::Retryable
+
+        def initialize(app, _env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant::action::vm::nfs")
+        end
+
+        def call(env)
+          @machine = env[:machine]
+
+          @app.call(env)
+
+          opts = {
+            cached: !env[:synced_folders_cached].nil?,
+            config: env[:synced_folders_config],
+            disable_usable_check: !env[:test].nil?
+          }
+          folders = synced_folders(env[:machine], **opts)
+
+          return unless folders.key?(:nfs)
+
+          @logger.info("Using NFS, preparing NFS settings by reading host IP and machine IP")
+          add_ips_to_env!(env)
+        end
+
+        # Extracts the proper host and guest IPs for NFS mounts and stores them
+        # in the environment for the SyncedFolder action to use them in
+        # mounting.
+        #
+        # The ! indicates that this method modifies its argument.
+        def add_ips_to_env!(env)
+          # Hardcoded IP for the host IP
+          host_ip = "10.0.2.2"
+          machine_ip = read_dynamic_machine_ip
+
+          raise Vagrant::Errors::NFSNoHostonlyNetwork if !host_ip || !machine_ip
+
+          env[:nfs_host_ip]    = host_ip
+          env[:nfs_machine_ip] = machine_ip
+        end
+
+        # Returns the IP address of the guest by looking at utm guest additions
+        # for the appropriate guest adapter.
+        #
+        # For DHCP interfaces, the guest property will not be present until the
+        # guest completes
+        #
+        # @param [Integer] adapter number to read IP for
+        # @return [String] ip address of adapter
+        def read_dynamic_machine_ip
+          # we need to wait for the guest's IP to show up as a guest property.
+          # retry thresholds are relatively high since we might need to wait
+          # for DHCP, but even static IPs can take a second or two to appear.
+          retryable(retry_options.merge(on: Vagrant::Errors::VirtualBoxGuestPropertyNotFound)) do
+            # Read the IP address from the list given by qemu-guest-agent
+            @machine.provider.driver.read_guest_ip[0]
+          end
+        rescue Vagrant::Errors::VirtualBoxGuestPropertyNotFound
+          # this error is more specific with a better error message directing
+          # the user towards the fact that it's probably a reportable bug
+          raise Vagrant::Errors::NFSNoGuestIP
+        end
+
+        # Separating these out so we can stub out the sleep in tests
+        def retry_options
+          { tries: 15, sleep: 1 }
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/action/prepare_nfs_valid_ids.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+module VagrantPlugins
+  module Utm
+    module Action
+      # This action prepares the NFS valid IDs for the VMs.
+      # The ids that are valid and should not be pruned by NFS
+      class PrepareNFSValidIds
+        def initialize(app, _env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant::action::vm::nfs")
+        end
+
+        def call(env)
+          env[:nfs_valid_ids] = env[:machine].provider.driver.read_vms.keys
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/action.rb

@@ -40,6 +40,8 @@ module VagrantPlugins
       autoload :PackageSetupFiles, action_root.join("package_setup_files")
       autoload :PackageSetupFolders, action_root.join("package_setup_folders")
       autoload :PackageVagrantfile, action_root.join("package_vagrantfile")
+      autoload :PrepareNFSSettings, action_root.join("prepare_nfs_settings")
+      autoload :PrepareNFSValidIds, action_root.join("prepare_nfs_valid_ids")
       autoload :PrepareForwardedPortCollisionParams, action_root.join("prepare_forwarded_port_collision_params")
       autoload :Resume, action_root.join("resume")
       autoload :SetId, action_root.join("set_id")
@@ -66,6 +68,10 @@ module VagrantPlugins
           b.use EnvSet, port_collision_repair: true
           b.use PrepareForwardedPortCollisionParams
           b.use HandleForwardedPortCollisions
+          b.use PrepareNFSValidIds
+          b.use SyncedFolderCleanup
+          b.use SyncedFolders
+          b.use PrepareNFSSettings
           b.use ForwardPorts
           b.use SetHostname
           b.use Customize, "pre-boot"
@@ -90,7 +96,7 @@ module VagrantPlugins
       # This is the action that is primarily responsible for completely
       # freeing the resources of the underlying virtual machine.
       # UTM equivalent of `utmctl delete <uuid>`
-      def self.action_destroy
+      def self.action_destroy # rubocop:disable Metrics/AbcSize
         Vagrant::Action::Builder.new.tap do |b|
           b.use CheckUtm
           b.use Call, Created do |env1, b2|
@@ -106,6 +112,8 @@ module VagrantPlugins
                 b3.use CheckAccessible
                 b3.use action_halt
                 b3.use Destroy
+                b3.use PrepareNFSValidIds
+                b3.use SyncedFolderCleanup
               else
                 b3.use MessageWillNotDestroy
               end
@@ -160,7 +168,7 @@ module VagrantPlugins
       end
 
       # This action packages the virtual machine into a single box file.
-      def self.action_package
+      def self.action_package # rubocop:disable Metrics/AbcSize
         Vagrant::Action::Builder.new.tap do |b|
           b.use CheckUtm
           b.use Call, Created do |env, b2|
@@ -174,6 +182,8 @@ module VagrantPlugins
             b2.use CheckAccessible
             b2.use action_halt
             b2.use ClearForwardedPorts
+            b2.use PrepareNFSValidIds
+            b2.use SyncedFolderCleanup
             b2.use Package
             b2.use Export
             b2.use PackageVagrantfile
@@ -405,6 +415,16 @@ module VagrantPlugins
         end
       end
 
+      # This is the action that is called to sync folders to a running
+      # machine without a reboot.
+      def self.action_sync_folders
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use PrepareNFSValidIds
+          b.use SyncedFolders
+          b.use PrepareNFSSettings
+        end
+      end
+
       # This action brings the machine up from nothing, including importing
       # the box, configuring metadata, and booting.
       def self.action_up

data/lib/vagrant_utm/driver/base.rb

@@ -86,6 +86,12 @@ module VagrantPlugins
         # @return [Array]
         def read_used_ports(active_only: true); end
 
+        # Returns a list of all UUIDs of virtual machines currently
+        # known by UTM.
+        #
+        # @return [Array<String>]
+        def read_vms; end
+
         # Returns the  IP addresses of the guest machine.
         # Only supported for VMs with qemu-guest-agent installed.
         #

data/lib/vagrant_utm/driver/meta.rb

@@ -104,6 +104,7 @@ module VagrantPlugins
                        :read_network_interfaces,
                        :read_state,
                        :read_used_ports,
+                       :read_vms,
                        :restore_snapshot,
                        :set_mac_address,
                        :set_name,

data/lib/vagrant_utm/driver/version_4_5.rb

@@ -239,6 +239,16 @@ module VagrantPlugins
           ports
         end
 
+        def read_vms
+          results = {}
+          list.machines.each do |machine|
+            # Store UUID (Unique) as key and name as value
+            results[machine.uuid] = machine.name
+          end
+
+          results
+        end
+
         def set_name(name) # rubocop:disable Naming/AccessorMethodName
           command = ["customize_vm.applescript", @uuid, "--name", name.to_s]
           execute_osa_script(command)

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.1"
+    VERSION = "0.1.2.beta"
   end
 end

data/notes/README.md

@@ -21,10 +21,17 @@ To release
 To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`
 GitHub action upon tag push with "v*" will publish gem to GHR and rubygems
 
-1. Update the version number in `version.rb`
-2. Run `bundle exec rake release`
-3. Commit version and Gemlock file
-4. Run `bundle exec rake release` again
-5. Cancel push to rubygems.org 
+1. Update 
+  CHANGELOG.md
+  version number in `version.rb`
+  version number Gemlock file
+2. Commit 
+3. Run `bundle exec rake release` (Commit and tags are pushed)
+4. Cancel push to rubygems.org 
 
-GHA will publish gems to GHR and rubygems
+GHA will publish gems to GHR and rubygems
+
+
+To update specific gems in the project
+
+`bundle update rubocop`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant_utm
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2.beta
 platform: ruby
 authors:
 - Naveenraj M
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-12-03 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies: []
 description: Vagrant UTM provider that allows you to manage UTM virtual machines.
 email:
@@ -84,6 +84,8 @@ files:
 - lib/vagrant_utm/action/package_setup_folders.rb
 - lib/vagrant_utm/action/package_vagrantfile.rb
 - lib/vagrant_utm/action/prepare_forwarded_port_collision_params.rb
+- lib/vagrant_utm/action/prepare_nfs_settings.rb
+- lib/vagrant_utm/action/prepare_nfs_valid_ids.rb
 - lib/vagrant_utm/action/resume.rb
 - lib/vagrant_utm/action/set_id.rb
 - lib/vagrant_utm/action/set_name.rb