vagrant_utm 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3fb5b4444402858a94f7d14c05bcc536749f405e5fa7c4ea8c84656a9f2dbee
-  data.tar.gz: 8e2c1b654f105d996504cc8c5f03276c421389fe414ff3c81c020bd0e4525179
+  metadata.gz: c22d83ed499aea91dd64bc9cdfa9f161a690e510e1e8c28fa9d912a2a0478606
+  data.tar.gz: c4f0be1c3eefa6d8412e60d7f193e00426462a34b90e34016539a75b34195da1
 SHA512:
-  metadata.gz: 30371d09843505b8a0bf16f1e2c454470e9459b454b0dcd94b52a525a64a95f1d0bb61fb3ec7434c4cf9e37e3889b15542ba7aaa2d2ac6cc6b26a95ab4c4f8fe
-  data.tar.gz: b6c93091338e29b4a41ad83c2e112e3c554384da447243ed3a4a45849e4779d7de9281cfd5b5a5b75958821db6c570ddb705c0c0162e98766100029bbc86ec9f
+  metadata.gz: 4539bf98ad765bb41946fc1b825e24161ad05e1e56b0b63416521c17c60ec182a78b6a5b6115fc8eea75879ba863c04468fe9881bd7996e928902fe7150198f1
+  data.tar.gz: 430329351ee74c943093194d6d64ce3e230bc8677153337e0f342a3f5c448f4b76bb390d51c6fe817f7cd09d1197185421bd7a97027b9f2869efff04cdada695

data/README.md

@@ -15,9 +15,7 @@ vagrant plugin install vagrant_utm
 
 ```ruby
 Vagrant.configure("2") do |config|
-  config.vm.provider :utm do |utm|
-    utm.utm_file_url = "https://github.com/naveenrajm7/utm-box/releases/download/debian-11/debian_vagrant_utm.zip"
-  end
+  config.vm.box = "utm/debian11"
 end
 ```
 

data/docs/_config.yml

@@ -2,12 +2,11 @@ title: Vagrant UTM
 description: >-
   vagrant_utm is a Vagrant plugin which adds UTM provider to Vagrant, 
   allowing Vagrant to control and provision machines via UTM's API
-baseurl: "/docs" # the subpath of your site, e.g. /blog
-# theme: just-the-docs
-
-url: "https://naveenrajm7.github.io/vagrant_utm"
+baseurl: "/vagrant_utm" # the subpath of your site, e.g. /blog
+url: "https://naveenrajm7.github.io" # the base hostname & protocol for your site, e.g. http://example.com
+repository: naveenrajm7/vagrant_utm # for github-metadata  
 github_username:  naveenrajm7
-repository: naveenrajm7/vagrant_utm
+
 
 # Build settings
 remote_theme: just-the-docs/just-the-docs@v0.8.2
@@ -73,4 +72,4 @@ back_to_top: true
 back_to_top_text: "Back to top"
 
 # Footer
-footer_content: "Copyright &copy; 2024 Naveenraj Muthuraj. Distributed by an <a href=\"https://github.com/naveenrajm7/vagrant_utm/tree/main/LICENSE.txt\">MIT license.</a>"
+footer_content: "Copyright &copy; 2024 Naveenraj Muthuraj. Distributed by an <a href=\"https://github.com/naveenrajm7/vagrant_utm/tree/main/LICENSE.txt\">MIT license.</a>"

data/docs/boxes/creating_utm_box.md

@@ -8,15 +8,6 @@ nav_order: 2
 
 As with [every Vagrant Provider](https://developer.hashicorp.com/vagrant/docs/providers/basic_usage), the Vagrant UTM provider has a custom box format that is required to work with Vagrant and the UTM plugin.
 
-{: .important }
-The UTM bundle (.utm file) is the box format for Vagrant UTM provider. 
-Because the current UTM API does not support importing utm file, we do not use vagrant box format (.box file).
-We currently use `utm://downloadVM?url=` to import VM to UTM.
-
-
-{: .note }
-However, once UTM supports import, we should be able to package UTM files into box format and use the benefits of Vagrant boxes . For example, downloading the box once to spin up multiple VMs and using vagrant cloud to publish custom UTM boxes.
-
 
 {: .warning } 
 This is a reasonably advanced topic that a beginning user of Vagrant does not need to understand. If you are just getting started with Vagrant, skip this and use an [available box](/utm_box_gallery.md). If you are an experienced user of Vagrant and want to create your own custom boxes, this is for you.
@@ -46,25 +37,37 @@ 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).
-The packer plugin has a builder and a post processor, which uses an existing UTM file, adds Vagrant specific stuff and packs the UTM file as a zip so it can be used by UTM Vagrant plugin.
+The packer plugin has the following components:
+1. Builder
+  1. UTM - Use existing utm file 
+  2. ISO - Start from scratch using ISO files
+2. Post-processor
+  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.
 
-## Using your own UTM boxes
+## Using your own UTM VMs
 
-Due to the limitation of UTM API, the plugin can only take a url pointing to the zip file.
-So, you can use a local python server to host your UTM bundle in zip file
+Do you have your own UTM VM that you would like to use with Vagrant 
 
+1. Convert your utm file to box format
+
+    a. Make a directory  
+    b. Put utm vm file in it  
+    c. Tar the folder with .box extension
+
+2. Import the vagrant box 
 ```bash
-python3 -m http.server                                                                            
-Serving HTTP on :: port 8000 (http://[::]:8000/) ...
+vagrant box add --name custom/debian debian.box  
 ```
 
-Use in Vagrantfile
+3. Use in Vagrantfile
 ```ruby
 Vagrant.configure("2") do |config|
-  config.vm.provider :utm do |utm|
-    utm.utm_file_url = "http://localhost:8000/debian_vagrant_utm.zip"
-  end
+  config.vm.box = "custom/debian11"
 end
-```
+```
+
+You can also use [packer plugin for UTM](https://github.com/naveenrajm7/packer-plugin-utm) to build, package and publish your UTM VMs to HCP Vagrant registry and share it your teams or with the world.

data/docs/boxes/utm_box_gallery.md

@@ -1,117 +1,41 @@
 ---
-title: UTM box gallery
+title: UTM Vagrant box gallery
 # layout: default
 parent: UTM Box
 nav_order: 1
 ---
 
-# UTM Box Gallery
+# UTM Vagrant Box Gallery
 
 To work with Vagrant, a base VM (box) must have 
-[certain features](https://developer.hashicorp.com/vagrant/docs/boxes/base), like a ssh user for vagrant to connect.
+[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, couple of pre-built VMs from the [UTM Gallery](https://mac.getutm.app/gallery/) are modified to work with Vagrant and are made available to use.
+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).
 
+{: .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.
 
 * Debian 11 (Xfce):   
 ```ruby
-u.utm_file_url = https://github.com/naveenrajm7/utm-box/releases/download/debian-11/debian_vagrant_utm.zip 
+config.vm.box = "utm/debian11"
 ```
 
+* Ubuntu 24.04 :
+```ruby
+config.vm.box = "utm/ubuntu-24.04"
+```
+
+* Help build more boxes using [packer plugin for UTM][packer plugin for UTM]
 <!-- * ArchLinux ARM -->
 
 
 {: .new}
-To enable building reproducible and easily sharable UTM VM bundle a [packer plugin for UTM](https://github.com/naveenrajm7/packer-plugin-utm) has been developed.
-Please see the [UTM Box Guide](https://github.com/naveenrajm7/utm-box/blob/main/HowToBuild/DebianUTM.md) on how these UTM Vagrant boxes were built using packer.
-
-
-Check out [Creating UTM Box](/boxes/creating_utm_box.md) to build your own Vagrant compatible UTM box.
-
-## Corresponding VMs from UTM Gallery
-
-<div class="content">
-  <section class="gallery">
-      <!-- <div class="gallery-item">
-          <a href="{{ vm.url }}">
-              <h3>ArchLinux ARM</h3>
-              <h4><i class="fas fa-microchip"></i> ARM64 </h4>
-              <img src="{{ site.baseurl }}/assets/images/screens/archlinux-logo.png" alt="Screenshot" class="screenshot" />
-          </a>
-      </div> -->
-      <div class="gallery-item">
-        <a href="">
-            <h3>Debian 11 (Xfce)</h3>
-            <h4><i class="fas fa-microchip"></i> ARM64 </h4>
-            <img src="{{ site.baseurl }}/assets/images/screens/debian-11-xfce-arm64.png" alt="Screenshot" class="screenshot" />
-        </a>
-      </div>
-  </section>
-</div>
-
-<style>
-.gallery {
-  display: flex;
-  flex-flow: row wrap;
-  justify-content: center;
-  align-items: center;
-}
-
-.gallery .gallery-item {
-  padding: 5px;
-  width: 20em;
-}
-
-.gallery-item a {
-  text-decoration: none;
-  color: black;
-}
-
-.gallery h3, .gallery h4 {
-  text-align: center;
-  overflow: hidden;
-  text-overflow: ellipsis;
-  white-space: nowrap;
-}
-
-.gallery h3 {
-  font-size: 1.2em;
-}
-
-.gallery h4 {
-  margin: 10px 0 10px 0;
-  font-size: 0.8em;
-  font-weight: normal;
-}
+To enable building reproducible and easily sharable UTM VM bundle a [packer plugin for UTM][packer plugin for UTM] has been developed and open-sourced. 
 
-.gallery .image {
-  width: 20em;
-}
 
-.gallery .screenshot {
-  max-width: 100%;
-  height: auto;
-  display: block;
-  box-shadow: 0 1px 0 #ccc, 0 1px 0 1px #eee;
-  border-radius: 2px;
-  margin-left: auto;
-  margin-right: auto;
-  background: #DDD url('data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%2244%22%20height%3D%2212%22%20viewBox%3D%220%200%2044%2012%22%3E%3Ccircle%20cx%3D%226%22%20cy%3D%226%22%20r%3D%224%22%20fill%3D%22%23eee%22%20%2F%3E%3Ccircle%20cx%3D%2222%22%20cy%3D%226%22%20r%3D%224%22%20fill%3D%22%23eee%22%20%2F%3E%3Ccircle%20cx%3D%2238%22%20cy%3D%226%22%20r%3D%224%22%20fill%3D%22%23eee%22%20%2F%3E%3C%2Fsvg%3E') 4px 4px no-repeat;
-  padding: 20px 0 0 0;
-  position: relative;
-}
 
-.gallery .placeholder {
-  padding-top: 75%;
-}
+Check out [Creating UTM Box](/creating_utm_box.md) to build your own compatible UTM Vagrant box.
 
-.gallery li {
-  padding: 5px 0 5px 0;
-}
 
-.gallery .button {
-  padding-bottom: 5px;
-  margin: 20px 0 20px 0;
-  font-size: 1.5em;
-}
-</style>
+[packer plugin for UTM]: https://github.com/naveenrajm7/packer-plugin-utm
+[UTM Box Guide]: https://github.com/naveenrajm7/utm-box/blob/main/HowToBuild/DebianUTM.md

data/docs/commands.md

@@ -9,7 +9,7 @@ nav_order: 2
 
 This page lists all the supported Vagrant commands which depend on the  UTM provider. Eg. `up`, `suspend`, `resume`, `halt`.
 
-Adds note to the command which are not yet available. Eg. `package`.
+Adds note to the command which are have some limitations. Eg. `snapshot`.
 
 The Vagrant commands that do not depend on provider are not listed and will continue to work. Eg. `global-status`
 
@@ -26,9 +26,7 @@ The Vagrant commands that do not depend on provider are not listed and will cont
 
 **Command: `vagrant box`**
 
-UTM provider uses .utm file as VM bundle .
-
-Box support is not yet available.
+UTM provider uses .utm file as VM bundle and supports box operations. 
 
 ## **Destroy**
 
@@ -46,9 +44,7 @@ Box support is not yet available.
 
 **Command: `vagrant package [name|id]`**
 
-Currently prompts to manually export (Share) the VM
-
-
+UTM 'Share' / export
 
 ## **Port**
 
@@ -70,7 +66,7 @@ Runs any configured [provisioners](https://developer.hashicorp.com/vagrant/docs
 
 **Command: `vagrant reload [name|id]`**
 
-The equivalent of running a [halt](https://developer.hashicorp.com/vagrant/docs/cli/halt) followed by an[up](https://developer.hashicorp.com/vagrant/docs/cli/up).
+The equivalent of running a [halt](https://developer.hashicorp.com/vagrant/docs/cli/halt) followed by an [up](https://developer.hashicorp.com/vagrant/docs/cli/up).
 
 
 

data/docs/configuration.md

@@ -17,10 +17,22 @@ config.vm.provider "utm" do |u|
 end
 ```
 
+## Checking for Guest Additions
+
+By default UTM plugin will check for the `qemu-guest-agent` when starting a machine, and will output a warning if the guest additions are not detected. You can skip the guest additions check by setting the check_guest_additions option:
+
+```ruby
+config.vm.provider "utm" do |u|
+  u.check_guest_additions = false
+end
+```
+
 ## Other customization
 
 ```ruby
 Vagrant.configure("2") do |config|
+  # Vagrant box 
+  config.vm.box = "utm/debian11"
   # Hostname inside the VM
   config.vm.hostname = "debian"
   # Ports to forward
@@ -29,13 +41,11 @@ Vagrant.configure("2") do |config|
   config.vm.provider "utm" do |u|
     # Name in UTM UI
     u.name = "debian"
-    # UTM VM file to import
-    u.utm_file_url = "http://localhost:8000/debian_vagrant_utm.zip"
     # CPU in cores
     u.cpus = 1
     # Memory in MB
     u.memory = 1024
-    # Notes for UTM VM (Appears in UI)
+    # Notes for UTM VM (Appears in UTM UI)
     u.notes = "Vagrant: For testing plugin development"
     # QEMU Directoy Share mode for the VM. 
     # Takes none, webDAV or virtFS

data/docs/features/synced_folders.md

@@ -13,8 +13,8 @@ After which the the host directory can be selected from UTM UI, and the guest di
 
 ```ruby
 Vagrant.configure("2") do |config|
+  config.vm.box = "utm/debian11"
   config.vm.provider :utm do |u|
-    u.utm_file_url = "http://localhost:8000/vm_utm.zip"
     # QEMU Directoy Share mode for the VM. 
     # Takes none, webDAV or virtFS
     u.directory_share_mode = "webDAV"

data/docs/index.md

@@ -18,10 +18,16 @@ allowing Vagrant to control and provision machines via UTM's API.
 
 ---
 
-[UTM] is a free, full featured system emulator and virtual machine host for iOS and macOS.
-The UTM provider currently supports UTM versions 4.5.x (except 4.5.0).
+{: .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). 
 
-[Vagrant] enables the creation and configuration of lightweight, reproducible, and portable development environments using Vagrantfile. The UTM provider plugin works with Vagrant version 2.4.1 .
+[UTM] is a free, full-featured system emulator and virtual machine host for iOS and macOS.  
+The UTM provider currently supports UTM versions 
+* 4.6.x   
+* 4.5.x (Obsolete, use plugin version 0.0.1)  
+
+[Vagrant] enables the creation and configuration of lightweight, reproducible, and portable development environments using Vagrantfile. The UTM provider plugin works with Vagrant version 2.4.1.
 
 
 Both UTM and Vagrant must be installed prior to using this plugin.
@@ -33,11 +39,11 @@ Browse the docs to learn more about how to use this plugin.
 
 ## Getting started
 
-Get started with Vagrant UTM plugin in 3 simple steps.  
+Get started with Vagrant UTM plugin in 2 simple steps.  
 Make sure both [Vagrant] and [UTM] are installed before your proceed.
 
-{: .warning}
-UTM Vagrant plugin is built around the existing UTM API. Some steps like Import, Snapshot are not straightforward. Please check [Known Issues](/known_issues.md) before using this plugin.
+{: .note}
+UTM Vagrant plugin is built around the existing UTM API. Some action like Snapshot are not straightforward. Please check [Known Issues](/known_issues.md) before using this plugin.
 
 
 ### Install
@@ -49,26 +55,34 @@ vagrant plugin install vagrant_utm
 
 ### Use
 
-Save the below config in your Vagrantfile. 
+#### Step 1
+Option 1: Create a Vagrantfile and initiate the box (OR)
+
+```
+vagrant init utm/debian11
+```
+
+Option 2: Open the Vagrantfile and replace the contents with the following
+
 ```ruby
 Vagrant.configure("2") do |config|
-  config.vm.provider :utm do |u|
-    u.utm_file_url = "https://github.com/naveenrajm7/utm-box/releases/download/debian-11/debian_vagrant_utm.zip"
-  end
+  config.vm.box = "utm/debian11"
 end
 ```
 
-### Run
+#### Step 2
+Bring up your virtual machine
 
-Bring up vagrant environment.
-```bash
+```
 vagrant up
 ```
 
+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 provider config options.
+Check [Configuration](configuration.md) for more UTM provider config options.
 
 
 ## About the project

data/docs/internals/utm_api.md

@@ -27,5 +27,4 @@ But, if we need to exchange complex data like json from UTM to plugin we use Jav
 All interactions with UTM should be possible with `utmctl` or `osascript`. But, due to the unavailablity of certain commands or features, we work around the issue by using direct shell command.  
 For Example:
 
-* Import `open -g utm://downloadVM?url=...` 
 * Snapshot `qemu-img snapshot ...`

data/docs/known_issues.md

@@ -8,14 +8,14 @@ nav_order: 7
 This plugin was built 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.   
-Draw back -  UTM does not support import API.
+1. ~~vagrant up : Loads new VM by downloading zip file every time, and manually asks the user to confirm the download completion.~~   
+~~Draw back -  UTM does not support import API.~~
 
-2. UUID : After importing VM , considers last VM in the list as the VM that was imported . So, if the intended VM is not last in the list , the plugin might customize other VM according to the Vagrantfile. 
-Draw back -  UTM import API should return UUID when imported.
+2. ~~UUID : After importing VM , considers last VM in the list as the VM that was imported . So, if the intended VM is not last in the list , the plugin might customize other VM according to the Vagrantfile.~~
+~~Draw back -  UTM import API should return UUID when imported.~~
 
-3. vagrant package: plugin just prints message to manually export the VM.
-Draw back -  UTM does not expose export API. (UTM already has 'Share')
+3. ~~vagrant package: plugin just prints message to manually export the VM.
+Draw back -  UTM does not expose export API. (UTM already has 'Share')~~
 
 4. Hide: Any plugin action will bring up the main UTM window. However, a properly built UTM box with no display will run headless.
 

data/lib/vagrant_utm/action/export.rb

@@ -3,19 +3,40 @@
 module VagrantPlugins
   module Utm
     module Action
-      # This action destroys the running machine.
+      # This action exports the virtual machine.
       class Export
         def initialize(app, _env)
           @app = app
         end
 
         def call(env)
-          # UTM 'Share' feature in UI will Export the virtual machine and all its data.
-          # Till 'Share' is exposed via API, show a message to manually export.
-          env[:ui].info I18n.t("vagrant_utm.actions.vm.export.manual_exporting",
-                               name: env[:machine].provider_config.name)
+          @env = env
+
+          raise Vagrant::Errors::VMPowerOffToPackage if \
+            @env[:machine].state.id != :stopped
+
+          export
+
           @app.call(env)
         end
+
+        def export
+          @env[:ui].info I18n.t("vagrant.actions.vm.export.exporting")
+          @env[:machine].provider.driver.export(utm_path) do |progress|
+            @env[:ui].rewriting do |ui|
+              ui.clear_line
+              ui.report_progress(progress.percent, 100, false)
+            end
+          end
+
+          # Clear the line a final time so the next data can appear
+          # alone on the line.
+          @env[:ui].clear_line
+        end
+
+        def utm_path
+          File.join(@env["export.temp_dir"], "box.utm")
+        end
       end
     end
   end

data/lib/vagrant_utm/action/import.rb

@@ -13,25 +13,35 @@ module VagrantPlugins
           import(env)
         end
 
-        def import(env)
-          machine = env[:machine]
-          config = machine.provider_config
-          driver = machine.provider.driver
-          utm_file_url = config.utm_file_url
+        def import(env) # rubocop:disable Metrics/AbcSize
+          env[:ui].info I18n.t("vagrant.actions.vm.import.importing",
+                               name: env[:machine].box.name)
 
-          env[:ui].info I18n.t("vagrant_utm.messages.importing_utm_file", name: utm_file_url)
+          # Import the virtual machine
+          utm_file = env[:machine].box.directory.join("box.utm").to_s
+          id = env[:machine].provider.driver.import(utm_file) do |progress|
+            env[:ui].rewriting do |ui|
+              ui.clear_line
+              ui.report_progress(progress, 100, false)
+            end
+          end
 
-          # Import the UTM VM file
-          driver.import(utm_file_url)
+          # Set the machine ID
+          env[:machine_id] = id
+          env[:machine].id = id unless env[:skip_machine]
 
-          # Set the UID of Vagrant machine to the UUID of the VM in UTM.
-          # UTM maintains UUID as primary key for VMs, but even the name works for all commands
-          # However, name is not unique.
+          # Clear the line one last time since the progress meter doesn't disappear
+          # immediately.
+          env[:ui].clear_line
 
-          # So we set the machine.id to UUID in next step after import.
-          # TODO: Set the machine.id to UUID after import returns the UUID (yet to be supported by UTM).
-          # machine.id = return value of import
+          # If we got interrupted, then the import could have been
+          # interrupted and its not a big deal. Just return out.
+          return if env[:interrupted]
 
+          # Flag as erroneous and return if import failed
+          raise Vagrant::Errors::VMImportFailure unless id
+
+          # Import completed successfully. Continue the chain
           @app.call(env)
         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,7 +21,6 @@ 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")
@@ -35,6 +34,10 @@ module VagrantPlugins
       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")
@@ -146,10 +149,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 +329,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]
@@ -376,35 +385,30 @@ 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
             end
           end
 
-          # Start the VM
+          b.use EnvSet, cloud_init: true
           b.use action_start
         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

@@ -100,11 +100,10 @@ module VagrantPlugins
         # @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.

data/lib/vagrant_utm/driver/meta.rb

@@ -55,7 +55,8 @@ 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.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),
@@ -92,6 +93,7 @@ module VagrantPlugins
                        :delete,
                        :delete_snapshot,
                        :execute_osa_script,
+                       :export,
                        :forward_ports,
                        :halt,
                        :import,

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

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/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/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.0"
   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. 

data/notes/README.md

@@ -0,0 +1,22 @@
+# 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

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.0
 platform: ruby
 authors:
 - Naveenraj M
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2024-11-30 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,7 +64,6 @@ 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
@@ -77,6 +77,10 @@ files:
 - 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
@@ -92,6 +96,7 @@ files:
 - 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,6 +106,8 @@ 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
@@ -109,6 +116,7 @@ files:
 - 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