vagrant-tart 0.0.2

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

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "vagrant/util/busy"
+require "vagrant/util/subprocess"
+require_relative "../model/get_result"
+require_relative "../model/list_result"
+
+module VagrantPlugins
+  module Tart
+    module Util
+      # Executes commands on the host machine through the Tart command line interface.
+      # rubocop:disable Metrics/ClassLength
+      class Driver
+        # Initialize the driver with the path to the scripts directory.
+        def initialize
+          @script_path = Pathname.new(File.expand_path("../scripts", __dir__))
+        end
+
+        # Execute the 'clone' command.
+        # @param source [String] The source image
+        # @param name [String] The name of the machine
+        # @yield [(String, String)] The output of the command
+        def clone(source, name, &block)
+          cmd = ["tart", "clone", source, name]
+          execute(*cmd, &block)
+        end
+
+        # Execute the 'create' command.
+        # @param name [String] The name of the machine
+        def delete(name)
+          cmd = ["tart", "delete", name]
+          execute(*cmd)
+        end
+
+        # Execute the 'get' command and returns the machine detailed information.
+        # @param name [String] The name of the machine
+        # @return [VagrantPlugins::Tart::Model::GetResult] The result of the command
+        def get(name)
+          cmd = ["tart", "get", name, "--format", "json"]
+          result = execute(*cmd)
+          data = JSON.parse(result)
+          Model::GetResult.new(data)
+        end
+
+        # 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]
+          result = execute(*cmd)
+          result.strip
+        end
+
+        # Execute the 'list' command and returns the list of machines.
+        # @return [VagrantPlugins::Tart::Model::ListResult] The result of the command
+        def list
+          cmd = ["tart", "list", "--format", "json"]
+          result = execute(*cmd)
+          data = JSON.parse(result)
+          Model::ListResult.new(data)
+        end
+
+        # Execute the 'login' command by calling an accessory script.
+        # @param host [String] The registry host name
+        # @param username [String] The username
+        # @param password [String] The password
+        def login(host, username, password)
+          script_path = @script_path.join("login.sh")
+          cmd = [script_path.to_s, host, username, password]
+          execute(*cmd)
+        end
+
+        # Execute the 'logout' command.
+        # @param host [String] The registry host name
+        def logout(host)
+          cmd = ["tart", "logout", host]
+          execute(*cmd)
+        end
+
+        # Execute the 'pull' command.
+        # @param image [String] The image to pull
+        # @yield [(String, String)] The output of the command
+        def pull(image, &block)
+          cmd = ["tart", "pull", image]
+          execute(*cmd, &block)
+        end
+
+        # Execute the 'run' command by calling an accessory script.
+        # @param name [String] The name of the machine
+        def run(name, use_gui, suspend, volumes)
+          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 << "--dir=#{volume}"
+          end
+
+          execute(*cmd)
+        end
+
+        # Execute the 'stop' command.
+        # @param name [String] The name of the machine
+        # @param timeout [Integer] The timeout in seconds
+        def stop(name, timeout = nil)
+          cmd = ["tart", "stop", name]
+          cmd << ["--timeout", timeout.to_s] if timeout&.positive?
+          execute(*cmd)
+        end
+
+        # Execute the 'suspend' command.
+        # @param name [String] The name of the machine
+        def suspend(name)
+          cmd = ["tart", "suspend", name]
+          execute(*cmd)
+        end
+
+        # Execute the 'set' command.
+        # @param name [String] The name of the machine
+        # @param key [String] The key to set
+        # @param value [String] The value to set
+        def set(name, key, value)
+          return if value == Config::UNSET_VALUE
+
+          # Map the key to the correct switch
+          switch = nil
+          case key
+          when "cpu"
+            switch = "--cpu"
+          when "memory"
+            switch = "--memory"
+          when "display"
+            switch = "--display"
+          when "disk"
+            switch = "--disk-size"
+          end
+          return unless switch
+
+          cmd = ["tart", "set", name, switch, value.to_s]
+          execute(*cmd)
+        end
+
+        # Execute the 'version' command and returns the version of Tart.
+        # @return [String] The version of Tart
+        def version
+          cmd = ["tart", "--version"]
+          result = execute(*cmd)
+          result.strip
+        end
+
+        private
+
+        # Execute a command on the host machine.
+        # Heavily inspired from https://github.com/hashicorp/vagrant/blob/main/plugins/providers/docker/executor/local.rb.
+        def execute(*cmd, &block)
+          # Append in the options for subprocess
+          cmd << { notify: %i[stdout stderr] }
+
+          interrupted  = false
+          int_callback = -> { interrupted = true }
+          result = ::Vagrant::Util::Busy.busy(int_callback) do
+            ::Vagrant::Util::Subprocess.execute(*cmd, &block)
+          end
+
+          # Trim the outputs
+          result.stderr.gsub!("\r\n", "\n")
+          result.stdout.gsub!("\r\n", "\n")
+
+          if result.exit_code != 0 && !interrupted
+            raise VagrantPlugins::Tart::Errors::CommandError,
+                  command: cmd.inspect,
+                  stderr: result.stderr,
+                  stdout: result.stdout
+          end
+
+          # Return the outputs of the command
+          "#{result.stdout} #{result.stderr}"
+        end
+      end
+      # rubocop:enable Metrics/ClassLength
+    end
+  end
+end

data/lib/vagrant-tart/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  # Top level module for the Tart provider plugin.
+  module Tart
+    # Current version of the Tart provider plugin.
+    VERSION = "0.0.2"
+  end
+end

data/lib/vagrant-tart.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "vagrant-tart/plugin"
+
+module VagrantPlugins
+  # Top level module for the Tart provider plugin.
+  module Tart
+    lib_path = Pathname.new(File.expand_path("vagrant-tart", __dir__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("..", __dir__))
+    end
+  end
+end

data/locales/en.yml

@@ -0,0 +1,74 @@
+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)
+      cpu_invalid: |-
+        Configuration must specify a valid CPU 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)
+
+    errors:
+      command_error: |-
+        Command failed with error: %{stderr}
+      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
+      synced_folder_not_tart: |-
+        The "tart" synced folder type can't be used because the provider
+        in use is not Tart. This synced folder type only works with the
+        Tart provider. The provider this machine is using is: %{provider}
+      tart_required: |-
+        tart CLI is required to run this provider
+
+    messages:
+      cloning_instance: |-
+        Cloning instance %{name}...
+      configuring_instance: |-
+        Configuring instance %{name}...
+      deleting_instance: |-
+        Deleting instance %{name}...
+      image_pulled: |-
+        Image %{image} pulled
+      instance_cloned: |-
+        Instance %{name} cloned
+      instance_configured: |-
+        Instance %{name} configured
+      instance_deleted: |-
+        Instance %{name} deleted
+      instance_started: |-
+        Instance %{name} started
+      instance_stopped: |-
+        Instance %{name} stopped
+      instance_suspended: |-
+        Instance %{name} suspended
+      logged_in: |-
+        Logged in to registry
+      logged_out: |-
+        Logged out of registry
+      logging_in: |-
+        Logging in to registry...
+      logging_out: |-
+        Logging out of registry...
+      not_created: |-
+        Virtual machine not created. Moving on...
+      pulling_image: |-
+        Pulling image %{image}...
+      starting_instance: |-
+        Starting instance %{name}...
+      stopping_instance: |-
+        Stopping instance %{name}...
+      suspending_instance: |-
+        Suspending instance %{name}...

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-tart
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Laurent Etiemble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-06-05 00:00:00.000000000 Z
+dependencies: []
+description: Allows Vagrant to manage Tart virtual machines.
+email:
+- laurent.etiemble@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/vagrant-tart.rb
+- lib/vagrant-tart/action.rb
+- lib/vagrant-tart/action/create_instance.rb
+- lib/vagrant-tart/action/delete_instance.rb
+- lib/vagrant-tart/action/forward_ports.rb
+- lib/vagrant-tart/action/get_state.rb
+- lib/vagrant-tart/action/login.rb
+- lib/vagrant-tart/action/pull_image.rb
+- lib/vagrant-tart/action/start_instance.rb
+- lib/vagrant-tart/action/stop_instance.rb
+- lib/vagrant-tart/action/suspend_instance.rb
+- lib/vagrant-tart/config.rb
+- lib/vagrant-tart/errors.rb
+- lib/vagrant-tart/model/get_result.rb
+- lib/vagrant-tart/model/list_result.rb
+- lib/vagrant-tart/model/tart_disk.rb
+- lib/vagrant-tart/plugin.rb
+- lib/vagrant-tart/provider.rb
+- lib/vagrant-tart/scripts/login.sh
+- lib/vagrant-tart/scripts/run.sh
+- lib/vagrant-tart/synced_folder.rb
+- lib/vagrant-tart/util/driver.rb
+- lib/vagrant-tart/version.rb
+- locales/en.yml
+homepage: https://github.com/letiemble/vagrant-tart
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://letiemble.github.io/vagrant-tart
+  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: 
+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.3.27
+signing_key: 
+specification_version: 4
+summary: Vagrant Tart provider
+test_files: []