vagrant_utm 0.0.1 → 0.1.1

data/lib/vagrant_utm/scripts/export_vm.applescript

@@ -0,0 +1,13 @@
+# Usage: osascript export_vm.applescript <vmUUID> <filePath>
+# vmID is the uuid of the virtual machine
+# filePath is the path where the exported file will be saved
+on run argv
+  set vmID to item 1 of argv
+  set exportPath to item 2 of argv
+  set exportFile to POSIX file exportPath
+
+  tell application "UTM"
+    set vm to virtual machine id vmID
+    export vm to exportFile
+  end tell
+end run

data/lib/vagrant_utm/scripts/import_vm.applescript

@@ -0,0 +1,14 @@
+# Usage: osascript import_vm.applescript <filePath>
+# filePath is the path of the file to import
+# Returns the imported virtual machine
+on run argv
+  set importFile to item 1 of argv
+  -- Convert the file path to a POSIX file
+  -- This should be done outside the tell block
+  set vmFile to POSIX file importFile
+
+  tell application "UTM"
+    set vm to import new virtual machine from vmFile
+    return vm
+  end tell
+end run

data/lib/vagrant_utm/scripts/read_forwarded_ports.applescript

@@ -1,4 +1,4 @@
-# Usage: osascript read_port_forwards.applescript <vmID>
+# Usage: osascript read_forwarded_ports.applescript <vmID>
 # vmID is the id of the virtual machine
 # This script reads the port forwards of the 'emulated' network interface
 # 'Forwarding(nicIndex)(ruleIndex)="protocol,guestAddress,guestPort,hostAddress,hostPort"'

data/lib/vagrant_utm/scripts/read_network_interfaces.applescript

@@ -5,7 +5,8 @@ on run argv
         set config to configuration of vm
         set networkInterfaces to network interfaces of config
         repeat with anInterface in networkInterfaces
-            # if you start log with variable you'll get "," at the end of the log if '&' is used to concatenate
+            # if you start log with variable you'll get "," at the end of the log so '&' is used to concatenate
+            # Example output: nic0,shared
             log "nic" & index of anInterface & "," & mode of anInterface 
         end repeat
     end tell

data/lib/vagrant_utm/scripts/set_mac_address.applescript

@@ -0,0 +1,25 @@
+# This script sets the MAC address of a network interface in a specified UTM virtual machine.
+# Usage: osascript set_mac_address.applescript <VM_UUID> <NIC_INDEX> <MAC_ADDRESS>
+# Example: osascript set_mac_address.applescript A123 1 XX:XX:XX:XX:XX:XX
+on run argv
+  set vmID to item 1 of argv
+  set nicIndex to item 2 of argv
+  set macAddress to item 3 of argv
+
+  tell application "UTM"
+    set vm to virtual machine id vmID
+    set config to configuration of vm
+    set networkInterfaces to network interfaces of config
+
+    repeat with anInterface in networkInterfaces
+      if nicIndex as integer is index of anInterface then
+        -- Set the provided MAC address
+        set address of anInterface to macAddress
+      end if
+    end repeat
+
+    -- Update the VM configuration
+    update configuration of vm with config
+  end tell
+  
+end run

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.0.1"
+    VERSION = "0.1.1"
   end
 end

data/lib/vagrant_utm.rb

@@ -16,6 +16,7 @@ module VagrantPlugins
       lib_path = Pathname.new(File.expand_path("vagrant_utm/driver", __dir__))
       autoload :Meta, lib_path.join("meta")
       autoload :Version_4_5, lib_path.join("version_4_5") # rubocop:disable Naming/VariableNumber
+      autoload :Version_4_6, lib_path.join("version_4_6") # rubocop:disable Naming/VariableNumber
     end
 
     # Drop some autoloads for the model classes

data/locales/en.yml

@@ -1,6 +1,7 @@
 en:
   vagrant_utm:
     config:
+      # Deprecated Configuration field
       utm_file_url_required: |-
         Configuration must specify utm.file_url.
         UTM file URL is required to import the UTM virtual machine. 
@@ -148,7 +149,15 @@ en:
             WARNING: The UTM virtual machine is booting in disposable mode. 
             Changes made to the VM will be lost when the VM is powered off.
             Learn more at https://docs.getutm.app/advanced/disposable/
+        ip_address:
+          reading: |-
+            Getting IP address of UTM virtual machine...
+          show: |-
+            Guest IP address(es):
+          not_found: |-
+            IP address not found. The VM may not have guest tools or may not have an IP address.
         snapshot:
           list: |-
             Listing snapshots for UTM virtual machine...
+        
             

data/notes/README.md

@@ -0,0 +1,30 @@
+# Notes
+
+This directory will hold documentation about the project.
+
+
+# Development
+
+To invoke vagrant with the plugin in development
+```bash
+bundle exec vagrant <command> --debug
+```
+
+To locally launch docs site
+```bash
+cd docs
+bundle exec jekyll serve
+```
+
+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 
+
+GHA will publish gems to GHR and rubygems

data/vagrantfile_examples/Vagrantfile

@@ -4,18 +4,19 @@
 # vi: set ft=ruby :
 
 Vagrant.configure("2") do |config|
+  config.vm.box = "utm/debian11"
+  config.vm.box_version = "0.0.1"
   # 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 = "debian"
-    # UTM VM file
-    utm.utm_file_url = "http://localhost:8000/debian_vagrant_utm.zip"
     utm.memory = 512
     utm.cpus = 1
     utm.notes = "Vagrant: For testing plugin development"
     # Wait time in secs for VM to be running after 'started'
+    # Currently, not used and we rely on the built-in wait for communicator(ssh) to be ready
     utm.wait_time = 22
     # QEMU Directoy Share mode for the VM
     utm.directory_share_mode = "webDAV"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant_utm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Naveenraj M
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2024-12-03 00:00:00.000000000 Z
 dependencies: []
 description: Vagrant UTM provider that allows you to manage UTM virtual machines.
 email:
@@ -35,6 +35,7 @@ files:
 - docs/assets/images/favicon.ico
 - docs/assets/images/logo.png
 - docs/assets/images/screens/archlinux-logo.png
+- docs/assets/images/screens/debian-10.4-i3-arm64.png
 - docs/assets/images/screens/debian-11-xfce-arm64.png
 - docs/boxes/creating_utm_box.md
 - docs/boxes/index.md
@@ -63,20 +64,25 @@ files:
 - lib/vagrant_utm/action/created.rb
 - lib/vagrant_utm/action/customize.rb
 - lib/vagrant_utm/action/destroy.rb
-- lib/vagrant_utm/action/download_confirm.rb
 - lib/vagrant_utm/action/export.rb
 - lib/vagrant_utm/action/forced_halt.rb
 - lib/vagrant_utm/action/forward_ports.rb
 - lib/vagrant_utm/action/import.rb
+- lib/vagrant_utm/action/ip_address.rb
 - lib/vagrant_utm/action/is_paused.rb
 - lib/vagrant_utm/action/is_running.rb
 - lib/vagrant_utm/action/is_stopped.rb
+- lib/vagrant_utm/action/match_mac_address.rb
 - lib/vagrant_utm/action/message_already_running.rb
 - lib/vagrant_utm/action/message_not_created.rb
 - lib/vagrant_utm/action/message_not_running.rb
 - lib/vagrant_utm/action/message_not_stopped.rb
 - lib/vagrant_utm/action/message_will_not_create.rb
 - lib/vagrant_utm/action/message_will_not_destroy.rb
+- lib/vagrant_utm/action/package.rb
+- lib/vagrant_utm/action/package_setup_files.rb
+- 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/resume.rb
 - lib/vagrant_utm/action/set_id.rb
@@ -87,11 +93,13 @@ files:
 - lib/vagrant_utm/action/suspend.rb
 - lib/vagrant_utm/action/wait_for_running.rb
 - lib/vagrant_utm/cap.rb
+- lib/vagrant_utm/commands/disposable.rb
+- lib/vagrant_utm/commands/ip_address.rb
 - lib/vagrant_utm/config.rb
-- lib/vagrant_utm/disposable.rb
 - lib/vagrant_utm/driver/base.rb
 - lib/vagrant_utm/driver/meta.rb
 - lib/vagrant_utm/driver/version_4_5.rb
+- lib/vagrant_utm/driver/version_4_6.rb
 - lib/vagrant_utm/errors.rb
 - lib/vagrant_utm/model/forwarded_port.rb
 - lib/vagrant_utm/model/list_result.rb
@@ -101,14 +109,17 @@ files:
 - lib/vagrant_utm/scripts/clear_port_forwards.applescript
 - lib/vagrant_utm/scripts/customize_vm.applescript
 - lib/vagrant_utm/scripts/downloadVM.sh
+- lib/vagrant_utm/scripts/export_vm.applescript
+- lib/vagrant_utm/scripts/import_vm.applescript
 - lib/vagrant_utm/scripts/list_vm.js
 - lib/vagrant_utm/scripts/open_with_utm.js
 - lib/vagrant_utm/scripts/read_forwarded_ports.applescript
-- lib/vagrant_utm/scripts/read_guest_ip.applescript
 - lib/vagrant_utm/scripts/read_network_interfaces.applescript
+- lib/vagrant_utm/scripts/set_mac_address.applescript
 - lib/vagrant_utm/util/compile_forwarded_ports.rb
 - lib/vagrant_utm/version.rb
 - locales/en.yml
+- notes/README.md
 - sig/vagrant_utm.rbs
 - vagrantfile_examples/Vagrantfile
 homepage: https://naveenrajm7.github.io/vagrant_utm/

data/lib/vagrant_utm/action/download_confirm.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require "vagrant/action/builtin/confirm"
-
-module VagrantPlugins
-  module Utm
-    module Action
-      # Action to confirm download of UTM.
-      class DownloadConfirm < Vagrant::Action::Builtin::Confirm
-        def initialize(app, env)
-          force_key = nil # No force key, user must confirm the download
-          message = I18n.t("vagrant_utm.messages.download_confirmation",
-                           name: env[:machine].provider_config.utm_file_url)
-          super(app, env, message, force_key, allowed: %w[y n Y N])
-        end
-      end
-    end
-  end
-end

data/lib/vagrant_utm/disposable.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module VagrantPlugins
-  module Utm
-    # Run VM as a snapshot and do not save changes to disk.
-    class Disposable < Vagrant.plugin(2, :command)
-      def execute
-        with_target_vms do |machine|
-          machine.action(:start_disposable)
-        end
-
-        0
-      end
-    end
-  end
-end

data/lib/vagrant_utm/scripts/read_guest_ip.applescript

@@ -1,9 +0,0 @@
-on run argv
-  set vmID to item 1 of argv
-  tell application "UTM"
-      set vm to virtual machine id vmID
-      --- get IP address (QEMU Guest Agent must be installed) of first interface
-      get item 1 of (query ip of vm) -- Result: "192.168.64.9"
-  end tell
-end run
-