vagrant-tart 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e9661a2803897b09b1601b13b608e24ea19a5f95db89c760f3c04e6a1b18c41
-  data.tar.gz: fd5723f36984a597846413d9fe14438dd8386116357faff32d212ba6ca265c8e
+  metadata.gz: e0f4e5c9e706e7f97e6abfb4a14b15477e34f8519f90940e93918bbc9f766485
+  data.tar.gz: 61048e9ab2d365476cae641b2d5757bf61ee90d665871a86cd0dc17ce34ec12e
 SHA512:
-  metadata.gz: 942cb301b228455fac8369be172bd5c9be38cf4b4ed91fe7eac0b0af46a15ff9235ecb3e9601de039aafb0836ec493b4e417c46748da4b79058fb8957f762d53
-  data.tar.gz: 53d7dba4e76a42d9ea51f76cfacb5306db38397e13102ab18123c2b1bc129d65775f09cafa030981d21f2fb16b21c42ef445e5eb8f07feddb433a81605938f75
+  metadata.gz: 92a51146a0d799256bef1adea44b0d018d77ca6f7e0d343922f0537a4eef6c32540dc942237aede874289b6d0df447de499397d890adccfd25fbfec6fbc59616
+  data.tar.gz: 106b2e9c056910a45d290cf977dfa3395cfd766f249f7b1054b4000b297bf275d88860fddb81d68121410dd1e01ec4fdb197816a697def4e9063addb65a1abdf

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Laurent Etiemble
+Copyright (c) 2024-2025 Laurent Etiemble
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/vagrant-tart/action/start_instance.rb

@@ -32,7 +32,7 @@ module VagrantPlugins
           env[:ui].output(I18n.t("vagrant_tart.messages.instance_configured", name: name))
 
           env[:ui].output(I18n.t("vagrant_tart.messages.starting_instance", name: name))
-          driver.run(name, config.gui, config.suspendable?, config.volumes)
+          driver.run(name, config)
           env[:ui].output(I18n.t("vagrant_tart.messages.instance_started", name: name))
 
           @app.call(env)

data/lib/vagrant-tart/action/vnc_connect.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+module VagrantPlugins
+  module Tart
+    module Action
+      # Action block to connect to the VNC server exposed by the VM.
+      class VNCConnect
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          machine = env[:machine]
+          config = machine.provider_config
+          driver = machine.provider.driver
+          name = config.name
+
+          list = driver.list
+          return @app.call(env) unless list.any?(name)
+
+          instance = driver.get(name)
+          return @app.call(env) if instance.nil? || instance.vagrant_state != :running
+
+          # Grab the VNC info from the machine or the environment
+          info = env[:vnc_info]
+          info ||= env[:machine].ssh_info
+
+          env[:ui].output(I18n.t("vagrant_tart.messages.connecting_to_vnc", name: name))
+          driver.vnc_connect(info)
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-tart/action.rb

@@ -21,6 +21,7 @@ module VagrantPlugins
       autoload :StartInstance, action_root.join("start_instance")
       autoload :StopInstance, action_root.join("stop_instance")
       autoload :SuspendInstance, action_root.join("suspend_instance")
+      autoload :VNCConnect, action_root.join("vnc_connect")
 
       # Vargrant action "destroy".
       def self.action_destroy
@@ -161,6 +162,23 @@ module VagrantPlugins
         end
       end
 
+      # Vagrant action "vnc_connect".
+      def self.action_vnc_connect
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+
+          b.use Call, IsState, :not_created do |env, b1|
+            raise Errors::InstanceNotCreatedError if env[:result]
+
+            b1.use Call, IsState, :running do |env2, b2|
+              raise Errors::InstanceNotRunningError unless env2[:result]
+
+              b2.use VNCConnect
+            end
+          end
+        end
+      end
+
       # Retrieves the state of the virtual machine.
       def self.action_get_state
         Vagrant::Action::Builder.new.tap do |b|

data/lib/vagrant-tart/command/vnc.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "i18n"
+require "vagrant/util/ansi_escape_code_remover"
+
+module VagrantPlugins
+  module Tart
+    module Command
+      # Command block to open a VNC connection to a virtual machine.
+      class VNC < Vagrant.plugin("2", :command)
+        def self.synopsis
+          "connects to machine via VNC"
+        end
+
+        def execute
+          options = {}
+
+          opts = OptionParser.new do |o|
+            o.banner = "Usage: vagrant vnc [options] [name|id] [-- extra args]"
+            o.separator ""
+            o.separator "Options:"
+            o.separator ""
+
+            o.on("-u", "--username USERNAME", "The username to use for the VNC connection.") do |u|
+              options[:username] = u
+            end
+
+            o.on("-p", "--password PASSWORD", "The password to use for the VNC connection.") do |p|
+              options[:password] = p
+            end
+          end
+
+          # Parse out the extra args to send to the RDP client, which
+          # is everything after the "--"
+          split_index = @argv.index("--")
+          if split_index
+            options[:extra_args] = @argv.drop(split_index + 1)
+            @argv                = @argv.take(split_index)
+          end
+
+          # Parse the options and return if we don't have any target.
+          argv = parse_options(opts)
+          return unless argv
+
+          with_target_vms(argv, single_target: true) do |machine|
+            vnc_info = get_vnc_info(machine, options)
+
+            machine.ui.detail("Address: #{vnc_info[:host]}") if vnc_info[:host]
+            machine.ui.detail("Username: #{vnc_info[:username]}") if vnc_info[:username]
+
+            machine.action(:vnc_connect, vnc_info: vnc_info)
+          end
+
+          0
+        end
+
+        def get_vnc_info(machine, options = {})
+          vnc_info = {}
+
+          ssh_info = machine.ssh_info
+          unless ssh_info.nil?
+            vnc_info[:host] = ssh_info[:host]
+            if options[:username]
+              vnc_info[:username] = options[:username]
+              vnc_info[:password] = options[:password] || nil
+            else
+              vnc_info[:username] = ssh_info[:username]
+              vnc_info[:password] = ssh_info[:password]
+            end
+          end
+          vnc_info[:extra_args] ||= options[:extra_args]
+
+          vnc_info
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-tart/config.rb

@@ -23,6 +23,10 @@ module VagrantPlugins
 
       # @return [Boolean] Show a GUI window on boot, or run headless
       attr_accessor :gui
+      # @return [Boolean] Whether the audio of the machine passes through the host
+      attr_accessor :audio
+      # @return [Boolean] Whether the machine and the host share the clipboard
+      attr_accessor :clipboard
       # @return [Integer] Number of CPUs
       attr_accessor :cpus
       # @return [Integer] Memory size in MB
@@ -33,6 +37,14 @@ module VagrantPlugins
       attr_accessor :display
       # @return [Boolean] Whether the machine is suspendable
       attr_accessor :suspendable
+      # @return [Boolean] Whether the machine expose a VNC server (screen sharing)
+      attr_accessor :vnc
+      # @return [Boolean] Whether the machine expose a VNC server (virtualization framework)
+      attr_accessor :vnc_experimental
+      # @return [String] The IP resolver to use (default to 'dhcp')
+      attr_accessor :ip_resolver
+      # @return [Array<String>] Extra arguments to pass to the tart run command
+      attr_accessor :extra_run_args
 
       # @return [Array<String>] List of volumes to mount
       attr_accessor :volumes
@@ -49,11 +61,17 @@ module VagrantPlugins
         @name = UNSET_VALUE
 
         @gui = UNSET_VALUE
+        @audio = UNSET_VALUE
+        @clipboard = UNSET_VALUE
         @cpus = UNSET_VALUE
         @memory = UNSET_VALUE
         @disk = UNSET_VALUE
         @display = UNSET_VALUE
         @suspendable = UNSET_VALUE
+        @vnc = UNSET_VALUE
+        @vnc_experimental = UNSET_VALUE
+        @ip_resolver = UNSET_VALUE
+        @extra_run_args = UNSET_VALUE
 
         @volumes = []
       end
@@ -68,11 +86,17 @@ module VagrantPlugins
         @name = nil if @name == UNSET_VALUE
 
         @gui = false if @gui == UNSET_VALUE
+        @audio = false if @audio == UNSET_VALUE
+        @clipboard = false if @clipboard == UNSET_VALUE
         @cpus = 1 if @cpus == UNSET_VALUE
         @memory = 1024 if @memory == UNSET_VALUE
         @disk = 10 if @disk == UNSET_VALUE
         @display = "1024x768" if @display == UNSET_VALUE
         @suspendable = false if @suspendable == UNSET_VALUE
+        @vnc = false if @vnc == UNSET_VALUE
+        @vnc_experimental = false if @vnc_experimental == UNSET_VALUE
+        @ip_resolver = "dhcp" if @ip_resolver == UNSET_VALUE
+        @extra_run_args = [] if @extra_run_args == UNSET_VALUE
       end
 
       # Validate the configuration
@@ -86,6 +110,12 @@ module VagrantPlugins
         # Check that the GUI flag is a valid boolean
         errors << I18n.t("vagrant_tart.config.gui_invalid") unless @gui == true || @gui == false
 
+        # Check that the audio flag is a valid boolean
+        errors << I18n.t("vagrant_tart.config.audio_invalid") unless @audio == true || @audio == false
+
+        # Check that the clipboard flag is a valid boolean
+        errors << I18n.t("vagrant_tart.config.clipboard_invalid") unless @clipboard == true || @clipboard == false
+
         # Check that CPUs is a valid number and between 1 and the maximum available CPUs
         max_cpus = Etc.nprocessors
         unless (@cpus.is_a? Integer) && @cpus >= 1 && @cpus <= max_cpus
@@ -107,6 +137,23 @@ module VagrantPlugins
         # Check that the suspendable flag is a valid boolean
         errors << I18n.t("vagrant_tart.config.suspendable_invalid") unless @suspendable == true || @suspendable == false
 
+        # Check that the VNC flag is a valid boolean
+        errors << I18n.t("vagrant_tart.config.vnc_invalid") unless @vnc == true || @vnc == false
+
+        # Check that the VNC experimental flag is a valid boolean
+        unless @vnc_experimental == true || @vnc_experimental == false
+          errors << I18n.t("vagrant_tart.config.vnc_experimental_invalid")
+        end
+
+        # Check that the VNC and VNC experimental flags are not both true
+        errors << I18n.t("vagrant_tart.config.vnc_exclusive") if @vnc == true && @vnc_experimental == true
+
+        # Check that the IP resolver is a valid string (either 'dhcp' or 'arp')
+        errors << I18n.t("vagrant_tart.config.ip_resolver_invalid") unless %w[dhcp arp].include? @ip_resolver
+
+        # Check that the extra run arguments is an array of strings
+        errors << I18n.t("vagrant_tart.config.extra_run_args_invalid") unless @extra_run_args.is_a? Array
+
         { "Tart Provider" => errors }
       end
 

data/lib/vagrant-tart/plugin.rb

@@ -36,6 +36,12 @@ module VagrantPlugins
         SyncedFolder
       end
 
+      # Register the custom VNC command.
+      command("vnc", primary: false) do
+        require_relative "command/vnc"
+        Command::VNC
+      end
+
       # Load the translation files
       def self.setup_i18n
         I18n.load_path << File.expand_path("locales/en.yml", Tart.source_root)

data/lib/vagrant-tart/provider.rb

@@ -72,7 +72,7 @@ module VagrantPlugins
         # Retrieve the IP address
         instance_ip = nil
         begin
-          instance_ip = @driver.ip(@machine.provider_config.name)
+          instance_ip = @driver.ip(@machine.provider_config.name, @machine.provider_config.ip_resolver)
         rescue Errors::CommandError
           @logger.warn("Failed to read guest IP #{$ERROR_INFO}")
         end

data/lib/vagrant-tart/scripts/open.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env zsh
+set -eo pipefail
+
+# Open a VNC connection to the virtual machine
+nohup open $1 &

data/lib/vagrant-tart/util/driver.rb

@@ -26,6 +26,27 @@ module VagrantPlugins
           execute(*cmd, &block)
         end
 
+        # Trigger a VNC connection to the machine.
+        # @param info [Hash] The information to connect to the machine
+        def vnc_connect(info)
+          machine_ip = info[:host]
+          username = info[:username]
+          password = info[:password]
+
+          auth = if username && password
+                   "#{username}:#{password}@"
+                 elsif username
+                   "#{username}@"
+                 else
+                   ""
+                 end
+          target = "vnc://#{auth}#{machine_ip}"
+
+          script_path = @script_path.join("open.sh")
+          cmd = [script_path.to_s, target]
+          execute(*cmd)
+        end
+
         # Execute the 'create' command.
         # @param name [String] The name of the machine
         def delete(name)
@@ -46,8 +67,8 @@ module VagrantPlugins
         # Execute the 'ip' commanda and returns the IP address of the machine.
         # @param name [String] The name of the machine
         # @return [String] The IP address of the machine
-        def ip(name)
-          cmd = ["tart", "ip", name]
+        def ip(name, ip_resolver)
+          cmd = ["tart", "ip", "--resolver", ip_resolver, name]
           result = execute(*cmd)
           result.strip
         end
@@ -88,13 +109,23 @@ module VagrantPlugins
 
         # Execute the 'run' command by calling an accessory script.
         # @param name [String] The name of the machine
-        def run(name, use_gui, suspend, volumes)
+        # @param options [Hash] The options to pass to the command
+        # @param options.use_gui [Boolean] Whether to use the GUI
+        # @param options.suspend [Boolean] Whether the machine is suspendable
+        # @param options.volumes [Array<String>] The volumes to mount
+        def run(name, config)
           script_path = @script_path.join("run.sh")
 
           cmd = [script_path.to_s, name]
-          cmd << "--no-graphics" unless use_gui
-          cmd << "--suspendable" if suspend
-          volumes.each do |volume|
+          cmd << "--no-graphics" unless config.gui
+          cmd << "--no-audio" unless config.audio
+          cmd << "--no-clipboard" unless config.clipboard
+          cmd << "--suspendable" if config.suspendable?
+          cmd << "--vnc" if config.vnc
+          cmd << "--vnc-experimental" if config.vnc_experimental
+          cmd.concat(config.extra_run_args)
+
+          config.volumes.each do |volume|
             cmd << "--dir=#{volume}"
           end
 

data/lib/vagrant-tart/version.rb

@@ -4,6 +4,6 @@ module VagrantPlugins
   # Top level module for the Tart provider plugin.
   module Tart
     # Current version of the Tart provider plugin.
-    VERSION = "0.0.4"
+    VERSION = "0.0.6"
   end
 end

data/locales/en.yml

@@ -1,22 +1,36 @@
 en:
   vagrant_tart:
     config:
+      audio_invalid: |-
+        Configuration must specify a valid audio setting (true or false)
+      clipboard_invalid: |-
+        Configuration must specify a valid clipboard setting (true or false)
       cpus_invalid: |-
         Configuration must specify a valid CPUs count (between 1 and %{max_cpus})
       disk_invalid: |-
         Configuration must specify a valid disk size (greater than 1 GB)
       display_invalid: |-
         Configuration must specify a valid display size (WIDTHxHEIGHT pixels)
+      extra_run_args_invalid: |-
+        Configuration must specify a valid extra run arguments (array of strings)
       gui_invalid: |-
         Configuration must specify a valid GUI setting (true or false)
       image_required: |-
         Configuration must specify an image
+      ip_resolver_arp_invalid: |-
+        Configuration must specify a valid IP resolver ARP setting (true or false)
       memory_invalid: |-
         Configuration must specify a valid memory size (between 1 and %{max_memory} MB)
       name_required: |-
         Configuration must specify a virtual machine name
       suspendable_invalid: |-
         Configuration must specify a valid suspendable setting (true or false)
+      vnc_invalid: |-
+        Configuration must specify a valid VNC setting (true or false)
+      vnc_exclusive: |-
+        Configuration must specify either vnc or vnc_experimental setting
+      vnc_experimental_invalid: |-
+        Configuration must specify a valid VNC experimental setting (true or false)
 
     errors:
       command_error: |-
@@ -39,6 +53,8 @@ en:
         Cloning instance %{name}...
       configuring_instance: |-
         Configuring instance %{name}...
+      connecting_to_vnc: |-
+        Opening VNC connection to %{name}...
       deleting_instance: |-
         Deleting instance %{name}...
       image_pulled: |-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-tart
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Laurent Etiemble
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-22 00:00:00.000000000 Z
+date: 2025-02-16 00:00:00.000000000 Z
 dependencies: []
 description: Allows Vagrant to manage Tart virtual machines.
 email:
@@ -30,6 +30,8 @@ files:
 - lib/vagrant-tart/action/start_instance.rb
 - lib/vagrant-tart/action/stop_instance.rb
 - lib/vagrant-tart/action/suspend_instance.rb
+- lib/vagrant-tart/action/vnc_connect.rb
+- lib/vagrant-tart/command/vnc.rb
 - lib/vagrant-tart/config.rb
 - lib/vagrant-tart/errors.rb
 - lib/vagrant-tart/model/get_result.rb
@@ -38,6 +40,7 @@ files:
 - lib/vagrant-tart/plugin.rb
 - lib/vagrant-tart/provider.rb
 - lib/vagrant-tart/scripts/login.sh
+- lib/vagrant-tart/scripts/open.sh
 - lib/vagrant-tart/scripts/run.sh
 - lib/vagrant-tart/synced_folder.rb
 - lib/vagrant-tart/util/driver.rb
@@ -52,7 +55,7 @@ metadata:
   source_code_uri: https://github.com/letiemble/vagrant-tart
   changelog_uri: https://github.com/letiemble/vagrant-tart/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -67,8 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Vagrant Tart provider
 test_files: []