vagrant-tart 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c396d57625272e20fa44038feb071add4d80fc19de6cf17e8339a46bdaef72ea
+  data.tar.gz: ff2b337cb649360c7d451b721fb8c836e75e1e549fe282ca1a79307f7da36471
+SHA512:
+  metadata.gz: 0bab80c64715d5292521cba50edbcbdae81c7cbe50ed42bb28bcb4a5e4169660688ddf8d4dfb903f0d65eaf861df47f5af91982ca15b4b348654be97cce4b51a
+  data.tar.gz: 0267bb6950b5eb82c7ec11c0d2c7dedfc4d753353f372189033500709a3f3a8841090b09b9998d761718a04ceaa0b4864218316149dad08d4a96782d947b0702

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# VagrantPlugins::Tart
+
+Vagrant-tart is a [Vagrant](http://www.vagrantup.com) plugin that adds a
+[Tart](https://tart.run/) provider to Vagrant, allowing Vagrant to
+control and provision machines via Tart command line tool.
+
+## Installation & Usage
+
+Refer to the [documentation](https://letiemble.github.io/vagrant-tart/) for detailed installation and usage instructions.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bundle exec rake spec` to run the tests.
+
+To install this gem into your local Vagrant installation, run:
+
+```bash
+bundle exec rake build
+bundle exec vagrant plugin install ./pkg/vagrant-tart-$VERSION.gem
+bundle exec vagrant plugin list
+```
+
+Once the plugin is installed, you can use Vagrant with the Tart provider.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/letiemble/vagrant-tart. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/letiemble/vagrant-tart/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the VagrantPlugins::Tart project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/letiemble/vagrant-tart/blob/main/CODE_OF_CONDUCT.md).

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "i18n"
+require "vagrant/util/ansi_escape_code_remover"
+
+module VagrantPlugins
+  module Tart
+    module Action
+      # Action block to create a virtual machine.
+      class CreateInstance
+        include Vagrant::Util::ANSIEscapeCodeRemover
+
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          machine = env[:machine]
+          config = machine.provider_config
+          driver = machine.provider.driver
+          image = config.image
+          name = config.name
+
+          list = driver.list
+          return @app.call(env) if list.any?(name)
+
+          env[:ui].output(I18n.t("vagrant_tart.messages.cloning_instance", image: image, name: name))
+          driver.clone(image, name) do |_type, data|
+            data = remove_ansi_escape_codes(data.chomp).chomp
+            env[:ui].detail(data) if data != ""
+          end
+          env[:ui].output(I18n.t("vagrant_tart.messages.instance_cloned", image: image, name: name))
+
+          # Set the ID and name of the virtual machine
+          machine.id = name
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+module VagrantPlugins
+  module Tart
+    module Action
+      # Action block to delete a virtual machine.
+      class DeleteInstance
+        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)
+          if !instance.nil? && instance.vagrant_state == :stopped
+            env[:ui].output(I18n.t("vagrant_tart.messages.deleting_instance", name: name))
+            driver.delete(name)
+            machine.id = nil
+            env[:ui].output(I18n.t("vagrant_tart.messages.instance_deleted", name: name))
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+module VagrantPlugins
+  module Tart
+    module Action
+      # Action block to setup forwarded ports for a virtual machine.
+      class ForwardPorts
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          machine = env[:machine]
+          config = machine.provider_config
+          machine.provider.driver
+          config.name
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module Tart
+    module Action
+      # Action block to get the state of a virtual machine.
+      class GetState
+        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
+          instance = list.find(name)
+
+          env[:machine_state_id] = if instance.nil?
+                                     :not_created
+                                   else
+                                     instance.vagrant_state
+                                   end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+module VagrantPlugins
+  module Tart
+    module Action
+      # Action to check if Tart is present and can be invoked.
+      class Login
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          machine = env[:machine]
+          config = machine.provider_config
+          driver = machine.provider.driver
+
+          return @app.call(env) unless config.use_registry?
+
+          login(env, config, driver)
+        end
+
+        private
+
+        def login(env, config, driver)
+          # Login to the registry
+          env[:ui].output(I18n.t("vagrant_tart.messages.logging_in"))
+          driver.login(config.registry, config.username, config.password)
+          env[:ui].output(I18n.t("vagrant_tart.messages.logged_in"))
+
+          # Continue with the middleware stack
+          @app.call(env)
+
+          # Logout from the registry
+          env[:ui].output(I18n.t("vagrant_tart.messages.logging_out"))
+          driver.logout(config.registry)
+          env[:ui].output(I18n.t("vagrant_tart.messages.logged_out"))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "i18n"
+require "vagrant/util/ansi_escape_code_remover"
+
+module VagrantPlugins
+  module Tart
+    module Action
+      # Action to pull a virtual machine image.
+      class PullImage
+        include Vagrant::Util::ANSIEscapeCodeRemover
+
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          machine = env[:machine]
+          config = machine.provider_config
+          driver = machine.provider.driver
+          image = config.image
+
+          # Check if the virtual machine image is already present
+          list = driver.list
+          return @app.call(env) if list.any?(image)
+
+          env[:ui].output(I18n.t("vagrant_tart.messages.pulling_image", image: image))
+          driver.pull(image) do |_type, data|
+            data = remove_ansi_escape_codes(data.chomp).chomp
+            data = data.gsub("\r", "")
+            env[:ui].detail(data) if data != ""
+          end
+          env[:ui].output(I18n.t("vagrant_tart.messages.image_pulled", image: image))
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+module VagrantPlugins
+  module Tart
+    module Action
+      # Action block to start a virtual machine.
+      class StartInstance
+        def initialize(app, _env)
+          @app = app
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        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
+
+          env[:ui].output(I18n.t("vagrant_tart.messages.configuring_instance", name: name))
+          driver.set(name, "cpu", config.cpu)
+          driver.set(name, "memory", config.memory)
+          driver.set(name, "disk", config.disk)
+          driver.set(name, "display", config.display)
+          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)
+          env[:ui].output(I18n.t("vagrant_tart.messages.instance_started", name: name))
+
+          @app.call(env)
+        end
+        # rubocop:enable Metrics/AbcSize
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+module VagrantPlugins
+  module Tart
+    module Action
+      # Action block to stop a virtual machine.
+      class StopInstance
+        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
+
+          env[:ui].output(I18n.t("vagrant_tart.messages.stopping_instance", name: name))
+          driver.stop(name)
+          env[:ui].output(I18n.t("vagrant_tart.messages.instance_stopped", name: name))
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+module VagrantPlugins
+  module Tart
+    module Action
+      # Action block to suspend a virtual machine.
+      class SuspendInstance
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          machine = env[:machine]
+          config = machine.provider_config
+          driver = machine.provider.driver
+          name = config.name
+          suspendable = config.suspendable?
+
+          list = driver.list
+          return @app.call(env) unless list.any?(name)
+
+          instance = driver.get(name)
+          return @app.call(env) if instance.nil? || !suspendable
+
+          env[:ui].output(I18n.t("vagrant_tart.messages.suspending_instance", name: name))
+          driver.suspend(name)
+          env[:ui].output(I18n.t("vagrant_tart.messages.instance_suspended", name: name))
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-tart/action.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+require "vagrant"
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module Tart
+    # Contains all the supported actions of the Tart provider.
+    module Action
+      # Include the built-in Vagrant action modules
+      include Vagrant::Action::Builtin
+
+      # Autoloading action blocks
+      action_root = Pathname.new(File.expand_path("action", __dir__))
+      autoload :CreateInstance, action_root.join("create_instance")
+      autoload :DeleteInstance, action_root.join("delete_instance")
+      autoload :GetState, action_root.join("get_state")
+      autoload :Login, action_root.join("login")
+      autoload :PullImage, action_root.join("pull_image")
+      autoload :StartInstance, action_root.join("start_instance")
+      autoload :StopInstance, action_root.join("stop_instance")
+
+      # Vargrant action "destroy".
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+
+          b.use Call, IsState, :not_created do |env1, b1|
+            raise Errors::InstanceNotCreatedError if  env1[:result]
+
+            b1.use Call, DestroyConfirm do |env2, b2|
+              if env2[:result]
+                b2.use ProvisionerCleanup, :before
+                b2.use StopInstance
+                b2.use DeleteInstance
+                b2.use SyncedFolderCleanup
+              else
+                b2.use MessageWillNotDestroy
+              end
+            end
+          end
+        end
+      end
+
+      # Vagrant action "halt".
+      def self.action_halt
+        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 StopInstance
+          end
+        end
+      end
+
+      # Vagrant action "provision".
+      def self.action_provision
+        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 Provision
+          end
+        end
+      end
+
+      # Vagrant action "reload".
+      def self.action_reload
+        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 action_halt
+            b1.use action_start
+          end
+        end
+      end
+
+      # Vagrant action "resume".
+      def self.action_resume
+        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 action_start
+          end
+        end
+      end
+
+      # Vagrant action "ssh".
+      def self.action_ssh
+        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 SSHExec
+            end
+          end
+        end
+      end
+
+      # Vagrant action "ssh_run".
+      def self.action_ssh_run
+        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 SSHRun
+            end
+          end
+        end
+      end
+
+      # Vagrant action "suspend".
+      def self.action_suspend
+        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 SuspendInstance
+            end
+          end
+        end
+      end
+
+      # Vagrant action "up".
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+
+          b.use Login
+          b.use PullImage
+          b.use CreateInstance
+
+          b.use action_start
+        end
+      end
+
+      # Retrieves the state of the virtual machine.
+      def self.action_get_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use GetState
+        end
+      end
+
+      # Starts the virtual machine.
+      def self.action_start
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use SyncedFolderCleanup
+          b.use SyncedFolders
+          b.use StartInstance
+          b.use WaitForCommunicator
+          b.use Provision
+        end
+      end
+    end
+  end
+end