RubyGems - vagrant-local - Versions diffs - 0.0.1 - Mend

vagrant-local 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (62) hide show

checksums.yaml +7 -0
data/.github/ISSUE_TEMPLATE/bug_report.md +27 -0
data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
data/.github/dependabot.yml +6 -0
data/.github/workflows/codeql-analysis.yml +72 -0
data/.github/workflows/lint-release-and-publish-nightly.yml +73 -0
data/.github/workflows/lint-release-and-publish.yml +71 -0
data/.github/workflows/ruby-lint.yml +35 -0
data/.gitignore +35 -0
data/.rspec +2 -0
data/.rubocop.yml +143 -0
data/CHANGELOG.md +32 -0
data/CODE_OF_CONDUCT.md +128 -0
data/CONTRIBUTING.md +97 -0
data/Gemfile +26 -0
data/LICENSE +651 -0
data/PULL_REQUEST_TEMPLATE.md +39 -0
data/README.md +92 -0
data/RELEASE.md +22 -0
data/Rakefile +32 -0
data/SECURITY.md +19 -0
data/ansible.cfg +5 -0
data/docs/CNAME +1 -0
data/docs/_config.yml +1 -0
data/docs/css/main.css +55 -0
data/docs/css/styles.css +8678 -0
data/docs/index.html +125 -0
data/lib/vagrant-local/action/create.rb +27 -0
data/lib/vagrant-local/action/destroy.rb +25 -0
data/lib/vagrant-local/action/halt.rb +24 -0
data/lib/vagrant-local/action/import.rb +27 -0
data/lib/vagrant-local/action/is_created.rb +22 -0
data/lib/vagrant-local/action/network.rb +24 -0
data/lib/vagrant-local/action/network_cleanup.rb +26 -0
data/lib/vagrant-local/action/not_created.rb +20 -0
data/lib/vagrant-local/action/package.rb +135 -0
data/lib/vagrant-local/action/restart.rb +27 -0
data/lib/vagrant-local/action/setup.rb +24 -0
data/lib/vagrant-local/action/shutdown.rb +47 -0
data/lib/vagrant-local/action/start.rb +25 -0
data/lib/vagrant-local/action/wait_till_boot.rb +47 -0
data/lib/vagrant-local/action/wait_till_up.rb +65 -0
data/lib/vagrant-local/action.rb +187 -0
data/lib/vagrant-local/command/guest_power_controls.rb +58 -0
data/lib/vagrant-local/command/local.rb +69 -0
data/lib/vagrant-local/command/restart_guest.rb +29 -0
data/lib/vagrant-local/command/shutdown_guest.rb +29 -0
data/lib/vagrant-local/command/vnc_console.rb +48 -0
data/lib/vagrant-local/command/webvnc_console.rb +49 -0
data/lib/vagrant-local/config.rb +55 -0
data/lib/vagrant-local/driver.rb +208 -0
data/lib/vagrant-local/errors.rb +84 -0
data/lib/vagrant-local/executor.rb +38 -0
data/lib/vagrant-local/plugin.rb +76 -0
data/lib/vagrant-local/provider.rb +83 -0
data/lib/vagrant-local/util/subprocess.rb +31 -0
data/lib/vagrant-local/util/timer.rb +19 -0
data/lib/vagrant-local/version.rb +8 -0
data/lib/vagrant-local.rb +29 -0
data/locales/en.yml +187 -0
data/vagrant-zones.gemspec +37 -0
metadata +191 -0

data/docs/index.html ADDED Viewed

@@ -0,0 +1,125 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8" />
+        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <title>Vagrant Local</title>
+        <link rel="stylesheet" href="css/styles.css" />
+        <link rel="stylesheet" href="css/main.css" />
+    </head>
+    <body>
+        <div class="header">
+            <div class="container">
+                <div class="row d-flex">
+                    <img
+                        src="assets/logo-big.jpg"
+                        class="logo-big img-fluid mx-auto mt-4"
+                        alt="..."
+                    />
+                </div>
+                <div class="row justify-content-md-center">
+                    <div class="menu-link col-md-auto fs-3 p-3 text-center">
+                        <a href="https://github.com/STARTcloud/vagrant-local">Home</a>
+                    </div>
+                    <div class="menu-link col-md-auto fs-3 p-3 text-center">
+                        <a href="http://rubydoc.info/gems/vagrant-local">Ruby Docs</a>
+                    </div>
+                    <div class="menu-link col-md-auto fs-3 p-3 text-center">
+                        <a href="https://github.com/STARTcloud/vagrant-local/issues">Issue Tracking</a>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="container">
+            <div class="row my-4">
+                <div class="col">
+                    <div class="card shadow">
+                        <div class="card-body">
+                            <p class="card-text fs-3 text-center">
+                                vagrant-local is a provider plugin for
+                                Vagrant which will allow you to manage as
+                                host as vm you would a VirtualBox vagrant machine.
+                            </p>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="container">
+            <div class="row">
+                <!-- Card 1 -->
+                <div class="col-md-6 col-lg-3 my-4">
+                    <div class="card shadow">
+                        <div class="card-body">
+                            <h5 class="card-title mb-4">Manage with Confidence</h5>
+                            <p class="card-text">
+                                Versioning, and automated deployment controls
+                                allow you to build your Virtual Machines
+                                with confidence the process will be transparent.
+                            </p>
+                        </div>
+                    </div>
+                </div>
+                <!-- Card 2 -->
+                <div class="col-md-6 col-lg-3 my-4">
+                    <div class="card shadow">
+                        <div class="card-body">
+                            <h5 class="card-title mb-4">Create your Automation</h5>
+                            <p class="card-text">
+                                vagrant-local is a provider plugin for
+                                Vagrant which will allow you to manage as
+                                host as vm you would a VirtualBox vagrant machine.
+                            </p>
+                        </div>
+                    </div>
+                </div>
+                <!-- Card 3 -->
+                <div class="col-md-6 col-lg-3 my-4">
+                    <div class="card shadow">
+                        <div class="card-body">
+                            <h5 class="card-title mb-4">Share with Others</h5>
+                            <p class="card-text">
+                                This tool will allow you to package and share boxes
+                                with other users, helping you develope on a wide
+                                array of Hypervisors and Operating Systems.
+                            </p>
+                        </div>
+                    </div>
+                </div>
+                <!-- Card 4 -->
+                <div class="col-md-6 col-lg-3 my-4">
+                    <div class="card shadow">
+                        <div class="card-body">
+                            <h5 class="card-title mb-4">Feature Requests</h5>
+                            <p class="card-text">
+                                Reach out to use in a GitHub issue and let us know what
+                                your projects goals are. If you can commit to testing
+                                we can work on getting your feature commited.
+                            </p>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="container">
+            <div class="card shadow footer mt-5">
+                <img
+                    src="assets/logo-small.png"
+                    class="logo-small mx-auto my-4"
+                    alt="..."
+                />
+                <p class="copyright text-center pb-4 mb-0">
+                    ©2022 STARTcloud, Inc.
+                </p>
+            </div>
+        </div>
+    </body>
+</html>

data/lib/vagrant-local/action/create.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'log4r'
+require 'securerandom'
+require 'digest/md5'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This will create the Instance
+      class Create
+        def initialize(app, _env)
+          @logger = Log4r::Logger.new('vagrant_local::action::import')
+          @app = app
+        end
+        def call(env)
+          @machine = env[:machine]
+          @driver  = @machine.provider.driver
+          @machine.id = SecureRandom.uuid
+          @driver.install(env[:ui])
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/destroy.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'log4r'
+require 'securerandom'
+require 'digest/md5'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This will destroy the instance
+      class Destroy
+        def initialize(app, _env)
+          @logger = Log4r::Logger.new('vagrant_local::action::import')
+          @app = app
+        end
+        def call(env)
+          @machine = env[:machine]
+          @driver = @machine.provider.driver
+          @driver.destroy(env[:ui])
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/halt.rb ADDED Viewed

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'log4r'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This will halt the instance
+      class Halt
+        def initialize(app, _env)
+          @logger = Log4r::Logger.new('vagrant_local::action::import')
+          @app = app
+        end
+        def call(env)
+          @machine = env[:machine]
+          @driver  = @machine.provider.driver
+          @driver.halt(env[:ui])
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/import.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'net/http'
+require 'vagrant-local/util/subprocess'
+require 'vagrant/box_metadata'
+require 'vagrant/util/downloader'
+require 'vagrant/util/platform'
+require 'vagrant/util/safe_chdir'
+require 'vagrant/util/subprocess'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This will import the instance boot image from the cloud, cache or file
+      class Import
+        def initialize(app, _env)
+          @logger = Log4r::Logger.new('vagrant_local::action::import')
+          @app = app
+        end
+        def call(env)
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/is_created.rb ADDED Viewed

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'log4r'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This can be used with 'Call' built-in to check if the machine
+      # is created and branch in the middleware.
+      class IsCreated
+        def initialize(app, _env)
+          @app = app
+          @logger = Log4r::Logger.new('vagrant_local::action')
+        end
+        def call(env)
+          env[:result] = env[:machine].state.id != :not_created
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/network.rb ADDED Viewed

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'log4r'
+require 'securerandom'
+require 'digest/md5'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This is use to define the network
+      class Network
+        def initialize(app, _env)
+          @logger = Log4r::Logger.new('vagrant_local::action::import')
+          @app = app
+        end
+        def call(env)
+          @machine = env[:machine]
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/network_cleanup.rb ADDED Viewed

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'log4r'
+require 'securerandom'
+require 'digest/md5'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This is use to define the network
+      class NetworkingCleanup
+        def initialize(app, _env)
+          @logger = Log4r::Logger.new('vagrant_local::action::import')
+          @app = app
+        end
+        def call(env)
+          @machine = env[:machine]
+          @driver  = @machine.provider.driver
+          @driver.network(env[:ui], 'delete_provisional')
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/not_created.rb ADDED Viewed

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'log4r'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This is used to determine if the VM is created
+      class NotCreated
+        def initialize(app, _env)
+          @app = app
+        end
+        def call(env)
+          env[:ui].info(I18n.t('vagrant_local.states.not_created'))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/package.rb ADDED Viewed

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+require 'fileutils'
+require 'pathname'
+require 'log4r'
+require 'json'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This is used to package the VM into a box
+      class Package
+        def initialize(app, env)
+          @logger = Log4r::Logger.new('vagrant_local::action::import')
+          @app = app
+          @executor = Executor::Exec.new
+          @pfexec = if Process.uid.zero?
+                      ''
+                    elsif system('sudo -v')
+                      'sudo'
+                    else
+                      'pfexec'
+                    end
+          env['package.output'] ||= 'package.box'
+        end
+        def execute(...)
+          @executor.execute(...)
+        end
+        def call(env)
+          boxname = env['package.output']
+          mpc = env[:machine].provider_config
+          files = {}
+          raise "#{boxname}: Already exists" if File.exist?(boxname)
+          ## Create Snapshot
+          FileUtils.mkdir_p("#{Dir.pwd}/_tmp_package")
+          datasetpath = "#{mpc.boot['array']}/#{mpc.boot['dataset']}/#{env[:machine].name}"
+          datetime = Time.new.strftime('%Y-%m-%d-%H:%M:%S')
+          snapshot_create(datasetpath, datetime, env[:ui], mpc)
+          snapshot_send(datasetpath, "#{Dir.pwd}/_tmp_package/box.zss", datetime, env[:ui], mpc)
+          ## Include User Extra Files
+          env['package.include'].each do |file|
+            source = Pathname.new(file)
+            dest = if source.relative?
+                     source
+                   else
+                     source.basename
+                   end
+            files[file] = dest
+          end
+          # Verify the mapping
+          files.each_key do |from|
+            raise Vagrant::Errors::PackageIncludeMissing, file: from unless File.exist?(from)
+          end
+          files.each do |from, dest|
+            include_directory = Pathname.new("#{Dir.pwd}/_tmp_package/")
+            to = include_directory.join(dest)
+            FileUtils.mkdir_p(to.parent)
+            if File.directory?(from)
+              FileUtils.cp_r(Dir.glob(from), to.parent, preserve: true)
+            else
+              FileUtils.cp(from, to, preserve: true)
+            end
+          end
+          ## Create a Vagrantfile or load from Users Defined File
+          vagrantfile_content = <<~'CODE'
+            require 'yaml'
+            require_relative 'Hosts'
+            settings = YAML::load(File.read("#{File.dirname(__FILE__)}/Hosts.yml"))
+            Vagrant.configure("2") do |config|
+              Hosts.configure(config, settings)
+            end
+          CODE
+          File.write("#{Dir.pwd}/_tmp_package/Vagrantfile", vagrantfile_content)
+          files[env['package.vagrantfile']] = '_Vagrantfile' if env['package.vagrantfile']
+          info_content_hash = {
+            'boxname' => boxname,
+            'Author' => mpc.vagrant_cloud_creator,
+            'vagrant-local' => 'This box was built with vagrant-local: https://github.com/STARTcloud/vagrant-local'
+          }
+          File.write("#{Dir.pwd}/_tmp_package/info.json", info_content_hash.to_json)
+          metadata_content_hash = {
+            'provider' => 'local',
+            'architecture' => 'amd64',
+            'brand' => mpc.brand,
+            'format' => 'zss',
+            'url' => "https://app.vagrantup.com/#{mpc.vagrant_cloud_creator}/boxes/#{mpc.boxshortname}"
+          }
+          metadata_content_hash['kernel'] = mpc.kernel if !mpc.kernel.nil? && mpc.kernel != false
+          File.write("#{Dir.pwd}/_tmp_package/metadata.json", metadata_content_hash.to_json)
+          ## Create the Box file
+          assemble_box(boxname, "#{Dir.pwd}/_tmp_package")
+          FileUtils.rm_rf("#{Dir.pwd}/_tmp_package")
+          env[:ui].info("Box created, You can now add the box: 'vagrant box add #{boxname} --name newbox'")
+          @app.call(env)
+        end
+        def snapshot_create(datasetpath, datetime, uii, config)
+          uii.info('Creating a Snapshot of the box.')
+          result = execute(true, "#{@pfexec} zfs snapshot -r #{datasetpath}/boot@vagrant_box#{datetime}")
+          uii.info("#{@pfexec} zfs snapshot -r #{datasetpath}/boot@vagrant_box#{datetime}") if result.zero? && config.debug
+        end
+        def snapshot_delete(datasetpath, uii, datetime)
+          result = execute(true, "#{@pfexec} zfs destroy -r -f #{datasetpath}/boot@vagrant_box#{datetime}")
+          uii.info("#{@pfexec} zfs destroy -r -f #{datasetpath}/boot@vagrant_box#{datetime}") if result.zero? && config.debug
+        end
+        def snapshot_send(datasetpath, destination, datetime, uii, config)
+          uii.info('Sending Snapshot to ZFS Send Stream image.')
+          result = execute(true, "#{@pfexec} zfs send #{datasetpath}/boot@vagrant_box#{datetime} > #{destination}")
+          uii.info("#{@pfexec} zfs send -r #{datasetpath}/boot@vagrant_box#{datetime} > #{destination}") if result.zero? && config.debug
+        end
+        def assemble_box(boxname, tmp_dir)
+          is_linux = `bash -c '[[ "$(uname -a)" =~ "Linux" ]]'`
+          Dir.chdir(tmp_dir) do
+            files = Dir.glob(File.join('.', '*'))
+            tar_command = is_linux ? 'tar -cvzf' : 'tar -cvzEf'
+            `#{tar_command} ../#{boxname} #{files.join(' ')}`
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/restart.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'log4r'
+require 'vagrant-local/util/timer'
+require 'vagrant/util/retryable'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This is used to restart the instance
+      class Restart
+        include Vagrant::Util::Retryable
+        def initialize(app, _env)
+          @logger = Log4r::Logger.new('vagrant_local::action::restart')
+          @app = app
+        end
+        def call(env)
+          @machine = env[:machine]
+          @driver = @machine.provider.driver
+          @driver.control(env[:ui], 'restart')
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/setup.rb ADDED Viewed

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'log4r'
+require 'securerandom'
+require 'digest/md5'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This is used to setup the instance
+      class Setup
+        def initialize(app, _env)
+          @logger = Log4r::Logger.new('vagrant_local::action::import')
+          @app = app
+        end
+        def call(env)
+          @machine = env[:machine]
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/shutdown.rb ADDED Viewed

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require 'log4r'
+require 'vagrant-local/util/timer'
+require 'vagrant/util/retryable'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This is used to shutdown the instance
+      class Shutdown
+        include Vagrant::Util::Retryable
+        def initialize(app, _env)
+          @logger = Log4r::Logger.new('vagrant_local::action::shutdown')
+          @app = app
+        end
+        def call(env)
+          @machine = env[:machine]
+          @driver  = @machine.provider.driver
+          ui = env[:ui]
+          ui.info(I18n.t('vagrant_local.graceful_shutdown_started'))
+          @driver.control(ui, 'shutdown')
+          env[:metrics] ||= {}
+          env[:metrics]['instance_ssh_time'] = Util::Timer.time do
+            retryable(on: Errors::TimeoutError, tries: 300) do
+              # If we're interrupted don't worry about waiting
+              break if env[:interrupted]
+              break unless env[:machine].communicate.ready?
+            end
+          end
+          env[:metrics]['instance_ssh_time'] = Util::Timer.time do
+            300.times do
+              state_id = @driver.state(@machine)
+              ui.info(I18n.t('vagrant_local.graceful_shutdown_complete')) unless state_id == :running
+              sleep 1 if state_id == :running
+              break unless state_id == :running
+              break if env[:interrupted]
+            end
+          end
+          @driver.halt(env[:ui])
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/start.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'log4r'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This is used to start the instance
+      class Start
+        def initialize(app, _env)
+          @logger = Log4r::Logger.new('vagrant_local::action::start')
+          @app = app
+        end
+        def call(env)
+          @machine = env[:machine]
+          @driver  = @machine.provider.driver
+          @driver.check_support(env[:ui])
+          @driver.boot(env[:ui])
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-local/action/wait_till_boot.rb ADDED Viewed

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require 'log4r'
+require 'vagrant-local/util/timer'
+require 'vagrant/util/retryable'
+module VagrantPlugins
+  module ProviderLocal
+    module Action
+      # This is used wait till the instance is booted
+      class WaitTillBoot
+        include Vagrant::Util::Retryable
+        def initialize(app, _env)
+          @logger = Log4r::Logger.new('vagrant_local::action::import')
+          @app = app
+        end
+        def terminate(env)
+          return unless env[:machine].state.id != :not_created
+          # If we're not supposed to destroy on error then just return
+          return unless env[:destroy_on_error]
+          if env[:halt_on_error]
+            halt_env = env.dup
+            halt_env.delete(:interrupted)
+            halt_env[:config_validate] = false
+            env[:action_runner].run(Action.action_halt, halt_env)
+          else
+            destroy_env = env.dup
+            destroy_env.delete(:interrupted)
+            destroy_env[:config_validate] = false
+            destroy_env[:force_confirm_destroy] = true
+            env[:action_runner].run(Action.action_destroy, destroy_env)
+          end
+        end
+        def call(env)
+          @machine = env[:machine]
+          @driver  = @machine.provider.driver
+          @app.call(env)
+        end
+      end
+    end
+  end
+end