vagrant-vmware-desktop 0.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53598ea53b7092a15c117fec30ca59e241510adeb17364db0839b7f63d25d2b1
-  data.tar.gz: 6821d0d58b5fb45c3ac1ce1f5d86c269cba46891a3ae749dcca443754fbc1bdb
+  metadata.gz: bdcfbbb304726e177ac071a8842c567ca35ebac76acb944b8b787b4a3c8b95d6
+  data.tar.gz: b871eaf2ccfdf8fb33384feb5c050e8b4e45daf61557158af7c23f7b57b9bf80
 SHA512:
-  metadata.gz: 4953365e900bddd7d3153c0c3b65c9d726d7c2bf217f6f80afa3073942a4a9bf5759bfcd670fbf4c0876f48b7f2d850f5b09db9705ded914b696477d691c2158
-  data.tar.gz: d88889a1e5795ff85510cb0756e5d6c7d0fd3a034dea017045bf2b4a7d9dce80d185dce16b965c391dfb60eb6da41499b8469fbe58c22916bd35e1c9cca88a87
+  metadata.gz: 6efa97edc063503dfa6d858160a23d57e0ff73f66cf4f09b9bc16027b9f2fc1000c41536ab9dd16c24e69b417cc9d17c1fec26d6dec6e3ecb37e94af701c64c7
+  data.tar.gz: ae05d94217266dedfb30bdbc392c05ec67a97f1604c17c51810b2cc8df1ae71af1b2e39246b9dcb41373826147b4ef2b286d8d28c4ad00d111ab7ecff588e6b8

data/lib/vagrant-vmware-desktop.rb

@@ -0,0 +1,190 @@
+require "rbconfig"
+require "pathname"
+require "fileutils"
+
+require "vagrant-vmware-desktop/constants"
+require "vagrant-vmware-desktop/plugin"
+
+module HashiCorp
+  module VagrantVMwareDesktop
+
+    # List of plugins that are incompatible with this plugin. These
+    # are the deprecated versions of the VMware plugin that this
+    # plugin replaces.
+    CONFLICTING_GEMS = [
+      "vagrant-vmware-fusion",
+      "vagrant-vmware-workstation"
+    ].map(&:freeze).freeze
+
+    lib_path = Pathname.new(File.expand_path("../vagrant-vmware-desktop", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Driver, lib_path.join("driver")
+    autoload :Errors, lib_path.join("errors")
+    autoload :SudoHelper, lib_path.join("sudo_helper")
+
+    # This initializes the i18n load path so that the plugin-specific
+    # translations work.
+    def self.init_i18n
+      I18n.load_path << File.expand_path("locales/en.yml", source_root)
+      I18n.reload!
+    end
+
+    # This initializes the logging so that our logs are outputted at
+    # the same level as Vagrant core logs.
+    def self.init_logging
+      # Initialize logging
+      level = nil
+      begin
+        level = Log4r.const_get(ENV["VAGRANT_LOG"].upcase)
+      rescue NameError
+        # This means that the logging constant wasn't found,
+        # which is fine. We just keep `level` as `nil`. But
+        # we tell the user.
+        level = nil
+      end
+
+      # Some constants, such as "true" resolve to booleans, so the
+      # above error checking doesn't catch it. This will check to make
+      # sure that the log level is an integer, as Log4r requires.
+      level = nil if !level.is_a?(Integer)
+
+      # Set the logging level on all "vagrant" namespaced
+      # logs as long as we have a valid level.
+      if level
+        logger = Log4r::Logger.new("hashicorp")
+        logger.outputters = Log4r::Outputter.stderr
+        logger.level = level
+        logger = nil
+      end
+    end
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+
+    # These WSL methods are wrappers so things work
+    # gracefully on different versions of Vagrant that
+    # may have all, some, or none of the methods available
+    # that we need.
+
+
+    # Detect if inside WSL
+    #
+    # @return [Boolean]
+    def self.wsl?
+      Vagrant::Util::Platform.respond_to?(:wsl?) &&
+        Vagrant::Util::Platform.wsl?
+    end
+
+    # Convert WSL path to a Windows path
+    #
+    # @param [String, Pathname] path
+    # @return [String]
+    def self.wsl_to_windows_path(path)
+      if wsl?
+        oval = ENV["VAGRANT_WSL_ENABLE_WINDOWS_ACCESS"]
+        ENV["VAGRANT_WSL_ENABLE_WINDOWS_ACCESS"] = "1"
+        path = Vagrant::Util::Platform.wsl_to_windows_path(path.to_s)
+        ENV["VAGRANT_WSL_ENABLE_WINDOWS_ACCESS"] = oval
+        return "//?/#{path}".tr("/", 92.chr)
+      end
+      if Vagrant::Util::Platform.windows?
+        path.to_s.tr("/", 92.chr)
+      else
+        path.to_s
+      end
+    end
+
+    # Convert Windows path to WSL path
+    #
+    # @param [String, Pathname] path
+    # @return [String]
+    def self.windows_to_wsl_path(path)
+      if wsl?
+        if Vagrant::Util::Platform.respond_to?(:windows_to_wsl_path)
+          return Vagrant::Util::Platform.windows_to_wsl_path(path.to_s)
+        elsif path.match(/^[A-Za-z]:/)
+          return "/mnt/#{path[0, 1].downcase}#{path[2..-1].tr(92.chr, '/')}"
+        end
+      end
+      path.to_s
+    end
+
+    # Check if path is located on DrvFs file system
+    #
+    # @param [String, Pathname]
+    # @return [Boolean]
+    def self.wsl_drvfs_path?(path)
+      path = path.to_s
+      if Vagrant::Util::Platform.respond_to?(:wsl_drvfs_path?)
+        return Vagrant::Util::Platform.wsl_drvfs_path?(path)
+      end
+      if wsl?
+        return Vagrant::Util::Platform.wsl_windows_access_bypass?(path)
+      end
+      false
+    end
+
+    # Check if path is case sensitive
+    #
+    # @param [String, Pathname] path to check (must exist)
+    # @return [Boolean]
+    def self.case_sensitive_fs?(path)
+      !case_sensitive_fs(path)
+    end
+
+    # Check if path is case insensitive
+    #
+    # @param [String, Pathname] path to check (must exist)
+    # @return [Boolean]
+    def self.case_insensitive_fs?(path)
+      begin
+        FileUtils.compare_file(path.to_s, path.to_s.downcase)
+      rescue Errno::ENOENT
+        false
+      end
+    end
+
+    # Checks for a valid installation state. Raises exception if
+    # invalid state detected.
+    #
+    # @return [NilClass]
+    # @raises [StandardError]
+    def self.validate_install!
+      CONFLICTING_GEMS.each do |libname|
+        if !Gem::Specification.find_all_by_name(libname).empty?
+          $stderr.puts <<-EOF
+ERROR: Vagrant has detected an incompatible plugin installed. Please uninstall
+the `#{libname}` plugin and run the command again. To uninstall the plugin,
+run the command shown below:
+
+  vagrant plugin uninstall #{libname}
+
+EOF
+          raise "Plugin conflict"
+        end
+      end
+    end
+
+    # Check for any deprecated suid binaries from previous
+    # vmware plugin installations and remove them
+    def self.orphan_artifact_cleanup!
+      if !Vagrant::Util::Platform.windows?
+        glob_path = Vagrant.user_data_path.join("gems", "**", "**", "vagrant-vmware-{workstation,fusion}*").to_s
+        Dir.glob(glob_path).each do |del_path|
+          FileUtils.rm_rf(del_path) if File.directory?(del_path)
+        end
+      end
+    end
+  end
+end
+
+# Validation the installation
+HashiCorp::VagrantVMwareDesktop.validate_install!
+
+# Remove any artifacts that may exist from
+# previous plugin installations
+HashiCorp::VagrantVMwareDesktop.orphan_artifact_cleanup!

data/lib/vagrant-vmware-desktop/action.rb

@@ -0,0 +1,442 @@
+require "pathname"
+
+require "vagrant/action/builder"
+
+require "vagrant/action/general/package"
+require "vagrant/action/general/package_setup_folders"
+require "vagrant/action/general/package_setup_files"
+
+module HashiCorp
+  module VagrantVMwareDesktop
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+      include Vagrant::Action::General
+
+      autoload :BaseMacToIp, "vagrant-vmware-desktop/action/base_mac_to_ip"
+      autoload :Boot, "vagrant-vmware-desktop/action/boot"
+      autoload :CheckExistingNetwork, "vagrant-vmware-desktop/action/check_existing_network"
+      autoload :CheckVMware, "vagrant-vmware-desktop/action/check_vmware"
+      autoload :ClearSharedFolders, "vagrant-vmware-desktop/action/clear_shared_folders"
+      autoload :Checkpoint, "vagrant-vmware-desktop/action/checkpoint"
+      autoload :Compatibility, "vagrant-vmware-desktop/action/compatibility"
+      autoload :Common, "vagrant-vmware-desktop/action/common"
+      autoload :Created, "vagrant-vmware-desktop/action/created"
+      autoload :Destroy, "vagrant-vmware-desktop/action/destroy"
+      autoload :DiscardSuspendedState, "vagrant-vmware-desktop/action/discard_suspended_state"
+      autoload :Export, "vagrant-vmware-desktop/action/export"
+      autoload :FixOldMachineID, "vagrant-vmware-desktop/action/fix_old_machine_id"
+      autoload :ForwardPorts, "vagrant-vmware-desktop/action/forward_ports"
+      autoload :Halt, "vagrant-vmware-desktop/action/halt"
+      autoload :Import, "vagrant-vmware-desktop/action/import"
+      autoload :MachineLock, "vagrant-vmware-desktop/action/machine_lock"
+      autoload :MessageAlreadyRunning, "vagrant-vmware-desktop/action/message_already_running"
+      autoload :MessageNotCreated, "vagrant-vmware-desktop/action/message_not_created"
+      autoload :MessageNotRunning, "vagrant-vmware-desktop/action/message_not_running"
+      autoload :Network, "vagrant-vmware-desktop/action/network"
+      autoload :PackageVagrantfile, "vagrant-vmware-desktop/action/package_vagrantfile"
+      autoload :PrepareNFSSettings, "vagrant-vmware-desktop/action/prepare_nfs_settings"
+      autoload :PrepareForwardedPortCollisionParams, "vagrant-vmware-desktop/action/prepare_forwarded_port_collision_params"
+      autoload :PrepareSyncedFolderCleanup, "vagrant-vmware-desktop/action/prepare_synced_folder_cleanup"
+      autoload :PruneForwardedPorts, "vagrant-vmware-desktop/action/prune_forwarded_ports"
+      autoload :PruneNFSExports, "vagrant-vmware-desktop/action/prune_nfs_exports"
+      autoload :Running, "vagrant-vmware-desktop/action/running"
+      autoload :SetDisplayName, "vagrant-vmware-desktop/action/set_display_name"
+      autoload :ShareFolders, "vagrant-vmware-desktop/action/share_folders"
+      autoload :SnapshotDelete, "vagrant-vmware-desktop/action/snapshot_delete"
+      autoload :SnapshotRestore, "vagrant-vmware-desktop/action/snapshot_restore"
+      autoload :SnapshotSave, "vagrant-vmware-desktop/action/snapshot_save"
+      autoload :Suspend, "vagrant-vmware-desktop/action/suspend"
+      autoload :Suspended, "vagrant-vmware-desktop/action/suspended"
+      autoload :VMXModify, "vagrant-vmware-desktop/action/vmx_modify"
+      autoload :WaitForAddress, "vagrant-vmware-desktop/action/wait_for_address"
+      autoload :WaitForCommunicator, "vagrant-vmware-desktop/action/wait_for_communicator_compat"
+      autoload :WaitForVMXHalt, "vagrant-vmware-desktop/action/wait_for_vmx_halt"
+
+      # This action is called to destroy a VM.
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+
+          if Vagrant::VERSION < "1.6.0"
+            b.use MachineLock
+          end
+
+          b.use FixOldMachineID
+          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 if defined?(ProvisionerCleanup)
+                b3.use EnvSet, :force_halt => env2.key?(:force_halt) ? env2[:force_halt] : true
+                b3.use action_halt
+                b3.use Destroy
+                b3.use PruneForwardedPorts
+
+                if Vagrant::VERSION < "1.4.0"
+                  b3.use PruneNFSExports
+                else
+                  b3.use PrepareSyncedFolderCleanup
+                  b3.use SyncedFolderCleanup
+                end
+              end
+            end
+          end
+          b.use Checkpoint
+        end
+      end
+
+      # This action is called to stop a running VM.
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use ConfigValidate
+          b.use FixOldMachineID
+          b.use CheckVMware
+
+          if Vagrant::VERSION < "1.6.0"
+            b.use MachineLock
+          end
+
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use DiscardSuspendedState
+            b2.use Call, Running do |env2, b3|
+              if env2[:result]
+                b3.use Call, GracefulHalt, :not_running, :running do |env3, b4|
+                  if !env3[:result]
+                    b4.use DiscardSuspendedState
+                    b4.use Halt
+                  end
+
+                  b4.use WaitForVMXHalt
+                end
+              end
+            end
+          end
+          b.use Checkpoint
+        end
+      end
+
+      # This action is called to package a VM.
+      def self.action_package
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use ConfigValidate
+          b.use FixOldMachineID
+
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use PackageSetupFolders
+            b2.use PackageSetupFiles
+            b2.use action_halt
+            b2.use PruneForwardedPorts
+            b2.use PrepareSyncedFolderCleanup
+            b2.use SyncedFolderCleanup
+            b2.use Package
+            b2.use Export
+            b2.use PackageVagrantfile
+          end
+          b.use Checkpoint
+        end
+      end
+
+      # This action is called to provision a VM.
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use ConfigValidate
+          b.use FixOldMachineID
+
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, Running do |env2, b3|
+              if !env2[:result]
+                raise Vagrant::Errors::VMNotRunningError
+              end
+
+              b3.use Provision
+            end
+          end
+          b.use Checkpoint
+        end
+      end
+
+      # This action is called when the VM is to be stopped then started.
+      def self.action_reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use FixOldMachineID
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use action_halt
+            b2.use action_start
+          end
+          b.use Checkpoint
+        end
+      end
+
+      # This action is called when the VM is to be resumed.
+      def self.action_resume
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use ConfigValidate
+          b.use FixOldMachineID
+          b.use CheckVMware
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use action_start
+          end
+          b.use Checkpoint
+        end
+      end
+
+      # This action is called to delete a snapshot.
+      def self.action_snapshot_delete
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use ConfigValidate
+          b.use FixOldMachineID
+          b.use CheckVMware
+
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use SnapshotDelete
+          end
+          b.use Checkpoint
+        end
+      end
+
+      # This action is called to restore a snapshot.
+      def self.action_snapshot_restore
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use ConfigValidate
+          b.use FixOldMachineID
+          b.use CheckVMware
+
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use SnapshotRestore
+            b2.use action_start
+          end
+          b.use Checkpoint
+        end
+      end
+
+      # This action is called to save a snapshot.
+      def self.action_snapshot_save
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use ConfigValidate
+          b.use FixOldMachineID
+          b.use CheckVMware
+
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use SnapshotSave
+          end
+          b.use Checkpoint
+        end
+      end
+
+      # This action is called to SSH into the machine.
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use ConfigValidate
+          b.use FixOldMachineID
+          b.use CheckVMware
+          b.use SSHExec
+          b.use Checkpoint
+        end
+      end
+
+      # This action is called that will run a single SSH command.
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use ConfigValidate
+          b.use FixOldMachineID
+          b.use CheckVMware
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Call, Running do |env2, b3|
+              if !env2[:result]
+                raise Vagrant::Errors::VMNotRunningError
+              end
+
+              b3.use SSHRun
+            end
+          end
+          b.use Checkpoint
+        end
+      end
+
+      # This action starts the VM, from whatever state it may be.
+      def self.action_start
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use FixOldMachineID
+
+          if Vagrant::VERSION >= "1.5.0"
+            b.use BoxCheckOutdated
+          end
+
+          b.use Call, Running do |env, b2|
+            if env[:result]
+              b2.use MessageAlreadyRunning
+              next
+            end
+
+            b2.use CheckExistingNetwork
+            b2.use PruneForwardedPorts
+            b2.use Call, Suspended do |env2, b3|
+              # If it is suspended then the following have no effect
+              if !env2[:result]
+                if Vagrant::VERSION < "1.6.0"
+                  b3.use MachineLock
+                end
+
+                b3.use Provision
+
+                if Vagrant::VERSION < "1.4.0"
+                  b3.use PruneNFSExports
+                  b3.use NFS
+                  b3.use ClearSharedFolders
+                  b3.use ShareFolders
+                else
+                  b3.use PrepareSyncedFolderCleanup
+                  b3.use SyncedFolderCleanup
+                  b3.use SyncedFolders
+                end
+
+                b3.use PrepareNFSSettings
+                b3.use Network
+                b3.use BaseMacToIp
+                b3.use SetHostname
+              end
+
+              Vagrant::Util::Experimental.guard_with(:disks) do
+                b3.use CleanupDisks
+                b3.use Disk
+              end
+              b3.use VMXModify
+              b3.use PrepareForwardedPortCollisionParams
+              b3.use HandleForwardedPortCollisions
+              b3.use Boot
+              b3.use WaitForAddress
+              b3.use ForwardPorts
+
+              if Vagrant::VERSION < "1.3.0"
+                b3.use WaitForCommunicatorCompat
+              else
+                b3.use WaitForCommunicator
+              end
+            end
+          end
+          b.use Checkpoint
+        end
+      end
+
+      # This action is called to stop a running VM.
+      def self.action_suspend
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use ConfigValidate
+          b.use FixOldMachineID
+          b.use CheckVMware
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Suspend
+          end
+          b.use Checkpoint
+        end
+      end
+
+      # This action is called to bring the box up from nothing.
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Compatibility
+          b.use ConfigValidate
+          b.use FixOldMachineID
+          b.use CheckVMware
+
+          if Vagrant::VERSION < "1.6.0"
+            b.use MachineLock
+          end
+
+
+          b.use Call, Created do |env1, b2|
+            if !env1[:result]
+              # If it is not created, then we need to grab the box,
+              # import it, and so on.
+              if Vagrant::VERSION < "1.5.0"
+                b2.use HandleBoxUrl
+              else
+                b2.use HandleBox
+              end
+
+              # Vagrant 1.8 added config.vm.clone. We do some things
+              # to get ready for it here.
+              if Vagrant::VERSION >= "1.8.0"
+                b2.use PrepareClone
+              end
+
+              b2.use Import
+              b2.use SetDisplayName
+            end
+
+            b2.use action_start
+          end
+          b.use Checkpoint
+        end
+      end
+    end
+  end
+end