vagrant 1.5.0 → 2.4.4

data/plugins/providers/virtualbox/action/set_name.rb

@@ -0,0 +1,58 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "log4r"
+
+module VagrantPlugins
+  module ProviderVirtualBox
+    module Action
+      class SetName
+        def initialize(app, env)
+          @logger = Log4r::Logger.new("vagrant::action::vm::setname")
+          @app = app
+        end
+
+        def call(env)
+          name = env[:machine].provider_config.name
+
+          # If we already set the name before, then don't do anything
+          sentinel = env[:machine].data_dir.join("action_set_name")
+          if !name && sentinel.file?
+            @logger.info("Default name was already set before, not doing it again.")
+            return @app.call(env)
+          end
+
+          # If no name was manually set, then use a default
+          if !name
+            prefix = "#{env[:root_path].basename.to_s}_#{env[:machine].name}"
+            prefix.gsub!(/[^-a-z0-9_]/i, "")
+
+            # milliseconds + random number suffix to allow for simultaneous
+            # `vagrant up` of the same box in different dirs
+            name = prefix + "_#{(Time.now.to_f * 1000.0).to_i}_#{rand(100000)}"
+          end
+
+          # Verify the name is not taken
+          vms = env[:machine].provider.driver.read_vms
+          raise Vagrant::Errors::VMNameExists, name: name if \
+            vms.key?(name) && vms[name] != env[:machine].id
+
+          if vms.key?(name)
+            @logger.info("Not setting the name because our name is already set.")
+          else
+            env[:ui].info(I18n.t(
+              "vagrant.actions.vm.set_name.setting_name", name: name))
+            env[:machine].provider.driver.set_name(name)
+          end
+
+          # Create the sentinel
+          sentinel.open("w") do |f|
+            f.write(Time.now.to_i.to_s)
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/plugins/providers/virtualbox/action/setup_package_files.rb

@@ -0,0 +1,20 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "log4r"
+
+require_relative "package_setup_files"
+
+module VagrantPlugins
+  module ProviderVirtualBox
+    module Action
+      class SetupPackageFiles < PackageSetupFiles
+        def initialize(*)
+          @logger = Log4r::Logger.new("vagrant::plugins::virtualbox::setup_package_files")
+          @logger.warn { "SetupPackageFiles has been renamed to PackageSetupFiles" }
+          super
+        end
+      end
+    end
+  end
+end

data/plugins/providers/virtualbox/action/snapshot_delete.rb

@@ -0,0 +1,37 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+module VagrantPlugins
+  module ProviderVirtualBox
+    module Action
+      class SnapshotDelete
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t(
+            "vagrant.actions.vm.snapshot.deleting",
+            name: env[:snapshot_name]))
+          env[:machine].provider.driver.delete_snapshot(
+            env[:machine].id, env[:snapshot_name]) do |progress|
+            env[:ui].rewriting do |ui|
+              ui.clear_line
+              ui.report_progress(progress, 100, false)
+            end
+          end
+
+          # Clear the line one last time since the progress meter doesn't disappear
+          # immediately.
+          env[:ui].clear_line
+
+          env[:ui].success(I18n.t(
+            "vagrant.actions.vm.snapshot.deleted",
+            name: env[:snapshot_name]))
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/plugins/providers/virtualbox/action/snapshot_restore.rb

@@ -0,0 +1,33 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+module VagrantPlugins
+  module ProviderVirtualBox
+    module Action
+      class SnapshotRestore
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t(
+            "vagrant.actions.vm.snapshot.restoring",
+            name: env[:snapshot_name]))
+          env[:machine].provider.driver.restore_snapshot(
+            env[:machine].id, env[:snapshot_name]) do |progress|
+            env[:ui].rewriting do |ui|
+              ui.clear_line
+              ui.report_progress(progress, 100, false)
+            end
+          end
+
+          # Clear the line one last time since the progress meter doesn't disappear
+          # immediately.
+          env[:ui].clear_line
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/plugins/providers/virtualbox/action/snapshot_save.rb

@@ -0,0 +1,28 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+module VagrantPlugins
+  module ProviderVirtualBox
+    module Action
+      class SnapshotSave
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t(
+            "vagrant.actions.vm.snapshot.saving",
+            name: env[:snapshot_name]))
+          env[:machine].provider.driver.create_snapshot(
+            env[:machine].id, env[:snapshot_name])
+
+          env[:ui].success(I18n.t(
+            "vagrant.actions.vm.snapshot.saved",
+            name: env[:snapshot_name]))
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/plugins/providers/virtualbox/action/suspend.rb

@@ -0,0 +1,23 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+module VagrantPlugins
+  module ProviderVirtualBox
+    module Action
+      class Suspend
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          if env[:machine].state.id == :running
+            env[:ui].info I18n.t("vagrant.actions.vm.suspend.suspending")
+            env[:machine].provider.driver.suspend
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/plugins/providers/virtualbox/action.rb

@@ -0,0 +1,433 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module ProviderVirtualBox
+    module Action
+      autoload :Boot, File.expand_path("../action/boot", __FILE__)
+      autoload :CheckAccessible, File.expand_path("../action/check_accessible", __FILE__)
+      autoload :CheckCreated, File.expand_path("../action/check_created", __FILE__)
+      autoload :CheckGuestAdditions, File.expand_path("../action/check_guest_additions", __FILE__)
+      autoload :CheckRunning, File.expand_path("../action/check_running", __FILE__)
+      autoload :CheckVirtualbox, File.expand_path("../action/check_virtualbox", __FILE__)
+      autoload :CleanMachineFolder, File.expand_path("../action/clean_machine_folder", __FILE__)
+      autoload :ClearForwardedPorts, File.expand_path("../action/clear_forwarded_ports", __FILE__)
+      autoload :ClearNetworkInterfaces, File.expand_path("../action/clear_network_interfaces", __FILE__)
+      autoload :Created, File.expand_path("../action/created", __FILE__)
+      autoload :Customize, File.expand_path("../action/customize", __FILE__)
+      autoload :Destroy, File.expand_path("../action/destroy", __FILE__)
+      autoload :DestroyUnusedNetworkInterfaces, File.expand_path("../action/destroy_unused_network_interfaces", __FILE__)
+      autoload :DiscardState, File.expand_path("../action/discard_state", __FILE__)
+      autoload :Export, File.expand_path("../action/export", __FILE__)
+      autoload :ForcedHalt, File.expand_path("../action/forced_halt", __FILE__)
+      autoload :ForwardPorts, File.expand_path("../action/forward_ports", __FILE__)
+      autoload :Import, File.expand_path("../action/import", __FILE__)
+      autoload :ImportMaster, File.expand_path("../action/import_master", __FILE__)
+      autoload :IsPaused, File.expand_path("../action/is_paused", __FILE__)
+      autoload :IsRunning, File.expand_path("../action/is_running", __FILE__)
+      autoload :IsSaved, File.expand_path("../action/is_saved", __FILE__)
+      autoload :MatchMACAddress, File.expand_path("../action/match_mac_address", __FILE__)
+      autoload :MessageAlreadyRunning, File.expand_path("../action/message_already_running", __FILE__)
+      autoload :MessageNotCreated, File.expand_path("../action/message_not_created", __FILE__)
+      autoload :MessageNotRunning, File.expand_path("../action/message_not_running", __FILE__)
+      autoload :MessageWillNotDestroy, File.expand_path("../action/message_will_not_destroy", __FILE__)
+      autoload :Network, File.expand_path("../action/network", __FILE__)
+      autoload :NetworkFixIPv6, File.expand_path("../action/network_fix_ipv6", __FILE__)
+      autoload :Package, File.expand_path("../action/package", __FILE__)
+      autoload :PackageSetupFiles, File.expand_path("../action/package_setup_files", __FILE__)
+      autoload :PackageSetupFolders, File.expand_path("../action/package_setup_folders", __FILE__)
+      autoload :PackageVagrantfile, File.expand_path("../action/package_vagrantfile", __FILE__)
+      autoload :PrepareCloneSnapshot, File.expand_path("../action/prepare_clone_snapshot", __FILE__)
+      autoload :PrepareNFSSettings, File.expand_path("../action/prepare_nfs_settings", __FILE__)
+      autoload :PrepareNFSValidIds, File.expand_path("../action/prepare_nfs_valid_ids", __FILE__)
+      autoload :PrepareForwardedPortCollisionParams, File.expand_path("../action/prepare_forwarded_port_collision_params", __FILE__)
+      autoload :Resume, File.expand_path("../action/resume", __FILE__)
+      autoload :SaneDefaults, File.expand_path("../action/sane_defaults", __FILE__)
+      autoload :SetDefaultNICType, File.expand_path("../action/set_default_nic_type", __FILE__)
+      autoload :SetName, File.expand_path("../action/set_name", __FILE__)
+      autoload :SnapshotDelete, File.expand_path("../action/snapshot_delete", __FILE__)
+      autoload :SnapshotRestore, File.expand_path("../action/snapshot_restore", __FILE__)
+      autoload :SnapshotSave, File.expand_path("../action/snapshot_save", __FILE__)
+      autoload :Suspend, File.expand_path("../action/suspend", __FILE__)
+
+      # @deprecated use {PackageSetupFiles} instead
+      autoload :SetupPackageFiles, File.expand_path("../action/setup_package_files", __FILE__)
+
+      # Include the built-in modules so that we can use them as top-level
+      # things.
+      include Vagrant::Action::Builtin
+
+      # This action boots the VM, assuming the VM is in a state that requires
+      # a bootup (i.e. not saved).
+      def self.action_boot
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckAccessible
+          b.use CleanMachineFolder
+          b.use SetName
+          b.use ClearForwardedPorts
+          b.use Provision
+          b.use EnvSet, port_collision_repair: true
+          b.use PrepareForwardedPortCollisionParams
+          b.use HandleForwardedPortCollisions
+          b.use PrepareNFSValidIds
+          b.use SyncedFolderCleanup
+          b.use SyncedFolders
+          b.use PrepareNFSSettings
+          b.use SetDefaultNICType
+          b.use ClearNetworkInterfaces
+          b.use Network
+          b.use NetworkFixIPv6
+          b.use ForwardPorts
+          b.use SetHostname
+          b.use SaneDefaults
+          b.use Call, IsEnvSet, :cloud_init do |env, b2|
+            if env[:result]
+              b2.use CloudInitSetup
+            end
+          end
+          b.use CleanupDisks
+          b.use Disk
+          b.use Customize, "pre-boot"
+          b.use Boot
+          b.use Customize, "post-boot"
+          b.use WaitForCommunicator, [:starting, :running, :paused]
+          b.use Call, IsEnvSet, :cloud_init do |env, b2|
+            if env[:result]
+              b2.use CloudInitWait
+            end
+          end
+          b.use Customize, "post-comm"
+          b.use CheckGuestAdditions
+        end
+      end
+
+      # This is the action that is primarily responsible for completely
+      # freeing the resources of the underlying virtual machine.
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, DestroyConfirm do |env2, b3|
+              if env2[:result]
+                b3.use ConfigValidate
+                b3.use ProvisionerCleanup, :before
+                b3.use CheckAccessible
+                b3.use EnvSet, force_halt: env2[:force_halt]
+                b3.use action_halt
+                b3.use Destroy
+                b3.use CleanMachineFolder
+                b3.use DestroyUnusedNetworkInterfaces
+                b3.use PrepareNFSValidIds
+                b3.use SyncedFolderCleanup
+              else
+                b3.use MessageWillNotDestroy
+              end
+            end
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for halting
+      # the virtual machine, gracefully or by force.
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use Call, Created do |env, b2|
+            if env[:result]
+              b2.use CheckAccessible
+              b2.use DiscardState
+
+              b2.use Call, IsPaused do |env2, b3|
+                next if !env2[:result]
+                b3.use Resume
+              end
+
+              b2.use Call, GracefulHalt, :poweroff, :running do |env2, b3|
+                if !env2[:result]
+                  b3.use ForcedHalt
+                end
+              end
+            else
+              b2.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      # This action packages the virtual machine into a single box file.
+      def self.action_package
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use PackageSetupFolders
+            b2.use PackageSetupFiles
+            b2.use CheckAccessible
+            b2.use action_halt
+            b2.use ClearForwardedPorts
+            b2.use PrepareNFSValidIds
+            b2.use SyncedFolderCleanup
+            b2.use Package
+            b2.use Export
+            b2.use PackageVagrantfile
+          end
+        end
+      end
+
+      # This action just runs the provisioners on the machine.
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use ConfigValidate
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, IsRunning do |env2, b3|
+              if !env2[:result]
+                b3.use MessageNotRunning
+                next
+              end
+
+              b3.use CheckAccessible
+              b3.use Provision
+            end
+          end
+        end
+      end
+
+      # This action is responsible for reloading the machine, which
+      # brings it down, sucks in new configuration, and brings the
+      # machine back up with the new configuration.
+      def self.action_reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use ConfigValidate
+            b2.use action_halt
+            b2.use action_start
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for resuming
+      # suspended machines.
+      def self.action_resume
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use Call, Created do |env, b2|
+            if env[:result]
+              b2.use CheckAccessible
+              b2.use EnvSet, port_collision_repair: false
+              b2.use PrepareForwardedPortCollisionParams
+              b2.use HandleForwardedPortCollisions
+              b2.use Resume
+              b2.use Provision
+              b2.use WaitForCommunicator, [:restoring, :running]
+            else
+              b2.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      def self.action_snapshot_delete
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use Call, Created do |env, b2|
+            if env[:result]
+              b2.use SnapshotDelete
+            else
+              b2.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for restoring a snapshot
+      def self.action_snapshot_restore
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use Call, Created do |env, b2|
+            if !env[:result]
+              raise Vagrant::Errors::VMNotCreatedError
+            end
+
+            b2.use CheckAccessible
+            b2.use EnvSet, force_halt: true
+            b2.use action_halt
+            b2.use SnapshotRestore
+
+            b2.use Call, IsEnvSet, :snapshot_delete do |env2, b3|
+              if env2[:result]
+                b3.use action_snapshot_delete
+              end
+            end
+
+            b2.use Call, IsEnvSet, :snapshot_start do |env2, b3|
+              if env2[:result]
+                b3.use action_start
+              end
+            end
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for saving a snapshot
+      def self.action_snapshot_save
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use Call, Created do |env, b2|
+            if env[:result]
+              b2.use SnapshotSave
+            else
+              b2.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      # This is the action that will exec into an SSH shell.
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use CheckCreated
+          b.use CheckAccessible
+          b.use CheckRunning
+          b.use SSHExec
+        end
+      end
+
+      # This is the action that will run a single SSH command.
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use CheckCreated
+          b.use CheckAccessible
+          b.use CheckRunning
+          b.use SSHRun
+        end
+      end
+
+      # This action starts a VM, assuming it is already imported and exists.
+      # A precondition of this action is that the VM exists.
+      def self.action_start
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use ConfigValidate
+          b.use BoxCheckOutdated
+          b.use Call, IsRunning do |env, b2|
+            # If the VM is running, run the necessary provisioners
+            if env[:result]
+              b2.use action_provision
+              next
+            end
+
+            b2.use Call, IsSaved do |env2, b3|
+              if env2[:result]
+                # The VM is saved, so just resume it
+                b3.use action_resume
+                next
+              end
+
+              b3.use Call, IsPaused do |env3, b4|
+                if env3[:result]
+                  b4.use Resume
+                  next
+                end
+
+                # The VM is not saved, so we must have to boot it up
+                # like normal. Boot!
+                b4.use action_boot
+              end
+            end
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for suspending
+      # the virtual machine.
+      def self.action_suspend
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+          b.use Call, Created do |env, b2|
+            if env[:result]
+              b2.use CheckAccessible
+              b2.use Suspend
+            else
+              b2.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      # This is the action that is called to sync folders to a running
+      # machine without a reboot.
+      def self.action_sync_folders
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use PrepareNFSValidIds
+          b.use SyncedFolders
+          b.use PrepareNFSSettings
+        end
+      end
+
+      # This action brings the machine up from nothing, including importing
+      # the box, configuring metadata, and booting.
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckVirtualbox
+
+          # Handle box_url downloading early so that if the Vagrantfile
+          # references any files in the box or something it all just
+          # works fine.
+          b.use Call, Created do |env, b2|
+            if !env[:result]
+              b2.use HandleBox
+            end
+          end
+
+          b.use ConfigValidate
+          b.use Call, Created do |env, b2|
+            # If the VM is NOT created yet, then do the setup steps
+            if !env[:result]
+              b2.use CheckAccessible
+              b2.use Customize, "pre-import"
+
+              if env[:machine].provider_config.linked_clone
+                # We are cloning from the box
+                b2.use ImportMaster
+              end
+
+              b2.use PrepareClone
+              b2.use PrepareCloneSnapshot
+              b2.use Import
+              b2.use DiscardState
+              b2.use MatchMACAddress
+            end
+          end
+
+          b.use EnvSet, cloud_init: true
+          b.use action_start
+        end
+      end
+    end
+  end
+end