vagrant-tart 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7304968aeaf2c309ef4e77a350054f83fb24d6119518e2372639ac27f51b3c73
-  data.tar.gz: 7baed83d857caeb259d10798500493e69bbf6267234dca7789e8654576a6ad8f
+  metadata.gz: 216dc096ac1b18cb20713cb80c5688389f2503fe8d04954a1274406c35274fa1
+  data.tar.gz: 89be7ac98b4980e0b59d6ff64d0b4160abbeb1b445ee2c58b171e771eb4ad208
 SHA512:
-  metadata.gz: 6a9a0510aa5cf86519e744de29182bfd3feccd0545314b170ec955c505414bd16d77046dbbbb085d75d004be4db60cb3377effa3ffb66ddc309f6dffb6b78f97
-  data.tar.gz: cf738b29374eda9c4884c6c03dd58ae6fd96383ba44b9f31d19695397f71497a9fab1a4e94a7d01098f3611a3c2940cdd737326827bad115349f76c917ba74db
+  metadata.gz: 9057828c27f9678e9a67fa684e479cd059fc4c108c71ed3c059762f8637485dde5a177a3fc7cf0507751f5a28c83c0230ed52254a76976a190520874f5ae5ec9
+  data.tar.gz: 6d744163d2bdf101f0e56d6b7d806d78e3c7d7de1fb90fae1ad6e779cec94f15a563e52dd388a27ffe8664cd6c558f4485c506b29da829abe48bb462af6d04d6

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

@@ -11,9 +11,9 @@ module VagrantPlugins
     class Config < Vagrant.plugin("2", :config)
       # @return [String] The image registry
       attr_accessor :registry
-      # @return [String] The image registry username
+      # @return [String] The image registry username (optional)
       attr_accessor :username
-      # @return [String] The image registry password
+      # @return [String] The image registry password (optional)
       attr_accessor :password
 
       # @return [String] The image source
@@ -21,18 +21,22 @@ module VagrantPlugins
       # @return [String] The name
       attr_accessor :name
 
+      # @return [Boolean] Show a GUI window on boot, or run headless
+      attr_accessor :gui
       # @return [Integer] Number of CPUs
       attr_accessor :cpus
       # @return [Integer] Memory size in MB
       attr_accessor :memory
       # @return [Integer] Disk storage size in GB
       attr_accessor :disk
-      # @return [Boolean] Show a GUI window on boot, or run headless
-      attr_accessor :gui
       # @return [String] Display screen resolution
       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 [Array<String>] List of volumes to mount
       attr_accessor :volumes
@@ -48,12 +52,14 @@ module VagrantPlugins
         @image = UNSET_VALUE
         @name = UNSET_VALUE
 
+        @gui = UNSET_VALUE
         @cpus = UNSET_VALUE
         @memory = UNSET_VALUE
         @disk = UNSET_VALUE
-        @gui = UNSET_VALUE
         @display = UNSET_VALUE
         @suspendable = UNSET_VALUE
+        @vnc = UNSET_VALUE
+        @vnc_experimental = UNSET_VALUE
 
         @volumes = []
       end
@@ -67,24 +73,20 @@ module VagrantPlugins
         @image = nil if @image == UNSET_VALUE
         @name = nil if @name == UNSET_VALUE
 
+        @gui = false if @gui == UNSET_VALUE
         @cpus = 1 if @cpus == UNSET_VALUE
         @memory = 1024 if @memory == UNSET_VALUE
         @disk = 10 if @disk == UNSET_VALUE
-        @gui = false if @gui == 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
       end
 
       # Validate the configuration
       def validate(_machine)
         errors = _detected_errors
 
-        # Sanity checks for the registry
-        unless @registry.nil?
-          errors << I18n.t("vagrant_tart.config.username_required") if @username.nil? || @username.empty?
-          errors << I18n.t("vagrant_tart.config.password_required") if @password.nil? || @password.empty?
-        end
-
         # Sanity checks for the image and the name
         errors << I18n.t("vagrant_tart.config.image_required") if @image.nil? || @image.empty?
         errors << I18n.t("vagrant_tart.config.name_required") if @name.nil? || @name.empty?
@@ -110,6 +112,20 @@ module VagrantPlugins
         # Check that the display resolution is a valid string conforming to the format "WIDTHxHEIGHT"
         errors << I18n.t("vagrant_tart.config.display_invalid") unless @display.match?(/^\d+x\d+$/)
 
+        # 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
+
         { "Tart Provider" => errors }
       end
 
@@ -117,8 +133,10 @@ module VagrantPlugins
         @suspendable
       end
 
+      # Check if the configuration uses a registry.
+      # @return [Boolean] True if the configuration uses a registry, false otherwise
       def use_registry?
-        !@registry.nil? && !@username.nil? && !@password.nil?
+        !@registry.nil?
       end
     end
     # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

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/scripts/login.sh

@@ -5,5 +5,10 @@ HOST="$1"
 USERNAME="$2"
 PASSWORD="$3"
 
-# Login to the registry with the provided credentials
-echo "$PASSWORD" | tart login "$HOST" --username "$USERNAME" --password-stdin
+if [[ -z "$USERNAME" ]] || [[ -z "$PASSWORD" ]]; then
+  # Assumes that the credentials are provided in another way (e.g. environment variables)
+  tart login "$HOST"
+else
+  # Login to the registry with the provided credentials
+  echo "$PASSWORD" | tart login "$HOST" --username "$USERNAME" --password-stdin
+fi

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)
@@ -88,13 +109,20 @@ 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 << "--suspendable" if config.suspendable?
+          cmd << "--vnc" if config.vnc
+          cmd << "--vnc-experimental" if config.vnc_experimental
+
+          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.3"
+    VERSION = "0.0.5"
   end
 end

data/locales/en.yml

@@ -1,21 +1,28 @@
 en:
   vagrant_tart:
     config:
-      image_required: |-
-        Configuration must specify an image
-      name_required: |-
-        Configuration must specify a virtual machine name
-
-      gui_invalid: |-
-        Configuration must specify a valid GUI setting (true or false)
       cpus_invalid: |-
         Configuration must specify a valid CPUs count (between 1 and %{max_cpus})
-      memory_invalid: |-
-        Configuration must specify a valid memory size (between 1 and %{max_memory} MB)
       disk_invalid: |-
         Configuration must specify a valid disk size (greater than 1 GB)
       display_invalid: |-
         Configuration must specify a valid display size (WIDTHxHEIGHT pixels)
+      gui_invalid: |-
+        Configuration must specify a valid GUI setting (true or false)
+      image_required: |-
+        Configuration must specify an image
+      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: |-
@@ -38,6 +45,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.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Laurent Etiemble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-08 00:00:00.000000000 Z
+date: 2024-11-09 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