vagrant_utm 0.0.1

data/locales/en.yml

@@ -0,0 +1,154 @@
+en:
+  vagrant_utm:
+    config:
+      utm_file_url_required: |-
+        Configuration must specify utm.file_url.
+        UTM file URL is required to import the UTM virtual machine. 
+    errors:
+      utm_not_detected: |-
+        UTM Application not detected. Please install UTM from https://mac.getutm.app/
+      utm_invalid_version: |-
+        utm_vagrant has detected that you have a version of UTM installed
+        that is not supported by this version of utm_vagrant. Please install one of
+        the supported versions listed below to use utm_vagrant plugin:
+
+        %{supported_versions}
+
+        A plugin update may also be available that adds support for the version
+        you specified. Please check github page of the plugin to download
+        the latest version.
+      command_error: |-
+        There was an error while executing a command. 
+        The command and stderr is shown below.
+
+        Command: %{command}
+
+        Stderr: %{stderr} 
+        Stdout: %{stdout} 
+      instance_not_created: |-
+        The virtual machine has not been created yet.
+      instance_not_running: |-
+        The virtual machine is not running.
+      macos_required: |-
+        MacOS is required to run this provider
+      qemu_img_required: |-
+        qemu-img is required to use snapshot feature.
+        You can install qemu-img using `brew install qemu`.
+      snapshot_command_failed: |-
+        There was an error while executing `qemu-img`, a CLI used by vagrant-utm
+        for managing UTM snapshots. qemu-img only supports offline operations, so
+        the VM must be stopped before any snapshot operation.
+        The error is shown below.
+
+        Error: %{stderr} 
+      snapshot_multiple_vm_files: |-
+        Multiple VM files detected. vagrant-utm which uses qemu-img does not support 
+        snapshot feature when multiple VM files are present.
+
+        Directory checked: %{directory}
+        Files found: %{files}
+      snapshot_vm_file_not_found: |-
+        VM file not detected. vagrant-utm checks for single qcow2 file named in 
+        UUID format in VM's data directory.
+
+        Directory checked: %{directory}
+      utm_import_failed: |-
+        UTM virtual machine import failed.
+      utmctl_error: |-
+        There was an error while executing `utmctl`, a CLI used by vagrant-utm
+        for controlling UTM. The command and stderr is shown below.
+
+        Command: %{command}
+
+        Stderr: %{stderr} 
+      utm_launch_error: |-
+        There was an error running UTM or OSA. This is usually a permissions
+        problem or installation problem with UTM itself, and not Vagrant.
+        Please note the error message below (if any), resolve the issue, and
+        try Vagrant again.
+
+        %{message}
+
+    messages:
+      importing_utm_file: |-
+        Importing UTM virtual machine file %{name}...
+      download_confirmation: |-
+        IMPORTANT: Due to limited UTM API support, this plugin does not know when the download is finished.
+        1. Headover to UTM and confirm to download UTM file.
+        2. Make sure the file is loaded and exists as last VM in UTM list (UI).
+        3. If the downloaded VM file name is same as existing VM, UTM will cause unexpected behavior.
+        Change VM, make sure the VM is last in the list and then continue.
+        "Are you sure the file '%{name}' is loaded in UTM and exists as last VM? [y/N] 
+      setting_id: |-
+        Setting the Vagrant machine ID to UTM VM UUID: %{id}
+      waiting_for_vm: |-
+        UTM does not report when the VM is ready, it only reports when the VM is started.
+        So, waiting %{time} secs for the UTM virtual machine to be ready...
+        Default wait time is 20 seconds, you can change it by setting `config.vm.provider.utm.wait_time` in Vagrantfile.
+    
+    commands:
+      common:
+        vm_already_running: |-
+          The UTM VM is already running.
+      # VM Commands 
+      up:
+        will_not_create: |-
+          The UTM virtual machine will not be created.
+      # UTM VM Status
+      status:
+        stopped: |-
+          The VM is stopped. To restart the VM, simply run `vagrant up`
+        starting: |-
+          The VM is starting.
+        started: |-
+          The VM is started. To stop this VM, you can run `vagrant halt` to
+          shut it down forcefully, or you can run `vagrant suspend` to simply
+          suspend the virtual machine. In either case, to restart it again,
+          simply run `vagrant up`.
+        pausing: |-
+          The VM is pausing.
+        paused: |-
+          The VM is paused. To resume this VM, simply run `vagrant resume`.
+        resuming: |-
+          The VM is resuming.   
+        stopping: |-
+          The VM is stopping.
+        not_created: |-
+          The environment has not yet been created. Run `vagrant up` to
+          create the environment. If a machine is not created, only the
+          default provider will be shown. So if a provider is not listed,
+          then the machine is not created for that environment.
+      common:
+        vm_not_stopped: |-
+          The VM is not in a stopped state, but the command requires the VM to be 
+          stopped. To stop this VM, you can run `vagrant halt` to shut it down forcefully.
+    utm:
+      checking_guest_additions: |-
+        Checking for guest additions in VM...
+
+    actions:
+      vm:
+        check_guest_additions:
+          detected: |-
+            Guest additions detected
+          not_detected: |-
+            No guest additions were detected for this VM! Guest
+            additions are required for forwarded ports, shared folders, host only
+            networking, and more. If SSH fails on this machine, please install
+            the guest additions and retry
+        export:
+          manual_exporting: |-
+            UTM 'Share' feature in UI will Export the virtual machine and all its data.
+            Till 'Share' is exposed via API, this plugin shows manual steps to export VM.
+            1. Headover to UTM.
+            2. Open the action menu of VM by a secondary click on a virtual machine %{name} in the list.
+            3. Select 'Share' and save the file to a location.
+        boot:
+          disposable: |-
+            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/
+        snapshot:
+          list: |-
+            Listing snapshots for UTM virtual machine...
+            

data/sig/vagrant_utm.rbs

@@ -0,0 +1,4 @@
+module VagrantUtm
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/vagrantfile_examples/Vagrantfile

@@ -0,0 +1,27 @@
+# -*- mode: ruby -*-
+# frozen_string_literal: true
+
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  # 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'
+    utm.wait_time = 22
+    # QEMU Directoy Share mode for the VM
+    utm.directory_share_mode = "webDAV"
+  end
+  config.vm.provision "shell", inline: <<-SHELL
+  apt-get update
+  apt-get install -y apache2
+  SHELL
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: vagrant_utm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naveenraj M
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-09 00:00:00.000000000 Z
+dependencies: []
+description: Vagrant UTM provider that allows you to manage UTM virtual machines.
+email:
+- naveenrajm97@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/.gitignore
+- docs/Gemfile
+- docs/Gemfile.lock
+- docs/README.md
+- docs/_config.yml
+- docs/_includes/footer_custom.html
+- docs/_sass/gallery.scss
+- docs/_virtual_machines/archlinux-arm.md
+- docs/assets/images/favicon.ico
+- docs/assets/images/logo.png
+- docs/assets/images/screens/archlinux-logo.png
+- docs/assets/images/screens/debian-11-xfce-arm64.png
+- docs/boxes/creating_utm_box.md
+- docs/boxes/index.md
+- docs/boxes/utm_box_gallery.md
+- docs/commands.md
+- docs/configuration.md
+- docs/features/index.md
+- docs/features/synced_folders.md
+- docs/index.md
+- docs/internals/actions.md
+- docs/internals/index.md
+- docs/internals/status.md
+- docs/internals/utm_api.md
+- docs/known_issues.md
+- lib/vagrant_utm.rb
+- lib/vagrant_utm/action.rb
+- lib/vagrant_utm/action/boot.rb
+- lib/vagrant_utm/action/boot_disposable.rb
+- lib/vagrant_utm/action/check_accessible.rb
+- lib/vagrant_utm/action/check_created.rb
+- lib/vagrant_utm/action/check_guest_additions.rb
+- lib/vagrant_utm/action/check_qemu_img.rb
+- lib/vagrant_utm/action/check_running.rb
+- lib/vagrant_utm/action/check_utm.rb
+- lib/vagrant_utm/action/clear_forwarded_ports.rb
+- 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/is_paused.rb
+- lib/vagrant_utm/action/is_running.rb
+- lib/vagrant_utm/action/is_stopped.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/prepare_forwarded_port_collision_params.rb
+- lib/vagrant_utm/action/resume.rb
+- lib/vagrant_utm/action/set_id.rb
+- lib/vagrant_utm/action/set_name.rb
+- lib/vagrant_utm/action/snapshot_delete.rb
+- lib/vagrant_utm/action/snapshot_restore.rb
+- lib/vagrant_utm/action/snapshot_save.rb
+- lib/vagrant_utm/action/suspend.rb
+- lib/vagrant_utm/action/wait_for_running.rb
+- lib/vagrant_utm/cap.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/errors.rb
+- lib/vagrant_utm/model/forwarded_port.rb
+- lib/vagrant_utm/model/list_result.rb
+- lib/vagrant_utm/plugin.rb
+- lib/vagrant_utm/provider.rb
+- lib/vagrant_utm/scripts/add_port_forwards.applescript
+- 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/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/util/compile_forwarded_ports.rb
+- lib/vagrant_utm/version.rb
+- locales/en.yml
+- sig/vagrant_utm.rbs
+- vagrantfile_examples/Vagrantfile
+homepage: https://naveenrajm7.github.io/vagrant_utm/
+licenses:
+- MIT
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: Vagrant UTM provider
+test_files: []