vagrant-unbundled 2.2.6.0 → 2.2.9.0

data/plugins/communicators/winrm/config.rb

@@ -56,7 +56,7 @@ module VagrantPlugins
         errors << "winrm.port cannot be nil."        if @port.nil?
         errors << "winrm.guest_port cannot be nil."  if @guest_port.nil?
         errors << "winrm.max_tries cannot be nil."   if @max_tries.nil?
-        errors << "winrm.retry_delay cannot be nil." if @max_tries.nil?
+        errors << "winrm.retry_delay cannot be nil." if @retry_delay.nil?
         errors << "winrm.timeout cannot be nil."     if @timeout.nil?
         errors << "winrm.execution_time_limit cannot be nil."     if @execution_time_limit.nil?
         unless @ssl_peer_verification == true || @ssl_peer_verification == false

data/plugins/communicators/winrm/shell.rb

@@ -19,7 +19,7 @@ module VagrantPlugins
 
       # Exit code generated when user is invalid. Can occur
       # after a hostname update
-      INVALID_USERID_EXITCODE = -196608
+      INVALID_USERID_EXITCODE = -2147024809
 
       # These are the exceptions that we retry because they represent
       # errors that are generally fixed from a retry and don't

data/plugins/communicators/winssh/communicator.rb

@@ -1,27 +1,39 @@
 require File.expand_path("../../ssh/communicator", __FILE__)
 
+require 'net/sftp'
+
 module VagrantPlugins
   module CommunicatorWinSSH
     # This class provides communication with a Windows VM running
     # the Windows native port of OpenSSH
     class Communicator < VagrantPlugins::CommunicatorSSH::Communicator
+      # Command to run when checking if connection is ready and working
+      READY_COMMAND="dir"
 
       def initialize(machine)
         super
         @logger = Log4r::Logger.new("vagrant::communication::winssh")
       end
 
+      # Wrap the shell if required. By default we are using powershell
+      # which requires no modification. If cmd is defined as shell, add
+      # prefix to start within cmd.exe
+      def shell_cmd(opts)
+        case opts[:shell].to_s
+        when "cmd"
+          "cmd.exe /c '#{opts[:command]}'"
+        else
+          opts[:command]
+        end
+      end
+
       # Executes the command on an SSH connection within a login shell.
       def shell_execute(connection, command, **opts)
-        opts = {
-          sudo: false,
-          shell: nil
-        }.merge(opts)
+        opts[:shell] ||= machine_config_ssh.shell
 
-        sudo  = opts[:sudo]
-        shell = (opts[:shell] || machine_config_ssh.shell).to_s
+        command = shell_cmd(opts.merge(command: command))
 
-        @logger.info("Execute: #{command} (sudo=#{sudo.inspect})")
+        @logger.info("Execute: #{command} - opts: #{opts}")
         exit_status = nil
 
         # Open the channel so we can execute or command
@@ -31,36 +43,10 @@ module VagrantPlugins
           stderr_marker_found = false
           stderr_data_buffer = ''
 
-          tfile = Tempfile.new('vagrant-ssh')
-          remote_ext = shell == "powershell" ? "ps1" : "bat"
-          remote_name = "#{machine_config_ssh.upload_directory}\\#{File.basename(tfile.path)}.#{remote_ext}"
-
-          if shell == "powershell"
-            base_cmd = "powershell -File #{remote_name}"
-            tfile.puts <<-SCRIPT.force_encoding('ASCII-8BIT')
-Remove-Item #{remote_name}
-Write-Host #{CMD_GARBAGE_MARKER}
-[Console]::Error.WriteLine("#{CMD_GARBAGE_MARKER}")
-#{command}
-SCRIPT
-          else
-            base_cmd = remote_name
-            tfile.puts <<-SCRIPT.force_encoding('ASCII-8BIT')
-ECHO OFF
-ECHO #{CMD_GARBAGE_MARKER}
-ECHO #{CMD_GARBAGE_MARKER} 1>&2
-#{command}
-SCRIPT
-          end
-
-          tfile.close
-          upload(tfile.path, remote_name)
-          tfile.delete
-
-          base_cmd = shell_cmd(opts.merge(shell: base_cmd))
-          @logger.debug("Base SSH exec command: #{base_cmd}")
+          @logger.debug("Base SSH exec command: #{command}")
+          command = "$ProgressPreference = 'SilentlyContinue';Write-Output #{CMD_GARBAGE_MARKER};[Console]::Error.WriteLine('#{CMD_GARBAGE_MARKER}');#{command}"
 
-          ch.exec(base_cmd) do |ch2, _|
+          ch.exec(command) do |ch2, _|
             # Setup the channel callbacks so we can get data and exit status
             ch2.on_data do |ch3, data|
               # Filter out the clear screen command
@@ -90,14 +76,14 @@ SCRIPT
                 stderr_data_buffer << data
                 marker_index = stderr_data_buffer.index(CMD_GARBAGE_MARKER)
                 if marker_index
-                  marker_found = true
+                  stderr_marker_found = true
                   stderr_data_buffer.slice!(0, marker_index + CMD_GARBAGE_MARKER.size)
                   data.replace(stderr_data_buffer.lstrip)
                   data_buffer = nil
                 end
               end
 
-              if block_given? && marker_found
+              if block_given? && stderr_marker_found && !data.empty?
                 yield :stderr, data
               end
             end
@@ -156,6 +142,108 @@ SCRIPT
         @machine.config.winssh
       end
 
+      def download(from, to=nil)
+        @logger.debug("Downloading: #{from} to #{to}")
+
+        sftp_connect do |sftp|
+          sftp.download!(from, to)
+        end
+      end
+
+      # Note: I could not get Net::SFTP to throw a permissions denied error,
+      # even when uploading to a directory where I did not have write
+      # privileges. I believe this is because Windows SSH sessions are started
+      # in an elevated process.
+      def upload(from, to)
+        to = Vagrant::Util::Platform.unix_windows_path(to)
+        @logger.debug("Uploading: #{from} to #{to}")
+
+        if File.directory?(from)
+          if from.end_with?(".")
+            @logger.debug("Uploading directory contents of: #{from}")
+            from = from.sub(/\.$/, "")
+          else
+            @logger.debug("Uploading full directory container of: #{from}")
+            to = File.join(to, File.basename(File.expand_path(from)))
+          end
+        end
+
+        sftp_connect do |sftp|
+          uploader = lambda do |path, remote_dest=nil|
+            if File.directory?(path)
+              Dir.new(path).each do |entry|
+                next if entry == "." || entry == ".."
+                full_path = File.join(path, entry)
+                dest = File.join(to, path.sub(/^#{Regexp.escape(from)}/, ""))
+                sftp.mkdir(dest)
+                uploader.call(full_path, dest)
+              end
+            else
+              if remote_dest
+                dest = File.join(remote_dest, File.basename(path))
+              else
+                dest = to
+                if to.end_with?(File::SEPARATOR)
+                  dest = File.join(to, File.basename(path))
+                end
+              end
+              @logger.debug("Ensuring remote directory exists for destination upload")
+              sftp.mkdir(File.dirname(dest))
+              @logger.debug("Uploading file #{path} to remote #{dest}")
+              upload_file = File.open(path, "rb")
+              begin
+                sftp.upload!(upload_file, dest)
+              ensure
+                upload_file.close
+              end
+            end
+          end
+          uploader.call(from)
+        end
+      end
+
+      # Opens an SFTP connection and yields it so that you can download and
+      # upload files. SFTP works more reliably than SCP on Windows due to
+      # issues with shell quoting and escaping.
+      def sftp_connect
+        # Connect to SFTP and yield the SFTP object
+        connect do |connection|
+          return yield connection.sftp
+        end
+      end
+
+      protected
+
+      # The WinSSH communicator connection provides isolated modification
+      # to the generated connection instances. This modification forces
+      # all provided commands to run within powershell
+      def connect(*args)
+        connection = nil
+        super { |c| connection = c }
+
+        if !connection.instance_variable_get(:@winssh_patched)
+          open_chan = connection.method(:open_channel)
+          connection.define_singleton_method(:open_channel) do |*args, &chan_block|
+            open_chan.call(*args) do |ch|
+              exec = ch.method(:exec)
+              ch.define_singleton_method(:exec) do |command, &block|
+                command = Base64.strict_encode64(command.encode("UTF-16LE", "UTF-8"))
+                command = "powershell -NoLogo -NonInteractive -ExecutionPolicy Bypass " \
+                  "-NoProfile -EncodedCommand #{command}"
+                exec.call(command, &block)
+              end
+              chan_block.call(ch)
+            end
+          end
+          connection.instance_variable_set(:@winssh_patched, true)
+        end
+
+        if block_given?
+          yield connection
+        else
+          connection
+        end
+      end
     end
   end
 end

data/plugins/communicators/winssh/config.rb

@@ -12,15 +12,11 @@ module VagrantPlugins
       end
 
       def finalize!
-        @shell = "cmd" if @shell == UNSET_VALUE
+        @shell = "powershell" if @shell == UNSET_VALUE
         @sudo_command = "%c" if @sudo_command == UNSET_VALUE
-        @upload_directory = "C:\\Windows\\Temp" if @upload_directory == UNSET_VALUE
+        @upload_directory = "C:/Windows/Temp" if @upload_directory == UNSET_VALUE
         if @export_command_template == UNSET_VALUE
-          if @shell == "cmd"
-            @export_command_template = 'set %ENV_KEY%="%ENV_VALUE%"'
-          else
-            @export_command_template = '$env:%ENV_KEY%="%ENV_VALUE%"'
-          end
+          @export_command_template = '$env:%ENV_KEY%="%ENV_VALUE%"'
         end
         super
       end

data/plugins/guests/alpine/cap/rsync.rb

@@ -8,7 +8,7 @@ module VagrantPlugins
 
         def self.rsync_install(machine)
           machine.communicate.tap do |comm|
-            comm.sudo('apk add rsync')
+            comm.sudo('apk add --update-cache rsync')
           end
         end
       end

data/plugins/guests/alpine/plugin.rb

@@ -45,6 +45,22 @@ module VagrantPlugins
         require_relative 'cap/smb'
         Cap::SMB
       end
+
+      def self.check_community_plugin
+        plugins = Vagrant::Plugin::Manager.instance.installed_plugins
+        if plugins.keys.include?("vagrant-alpine")
+          $stderr.puts <<-EOF
+WARNING: Vagrant has detected the `vagrant-alpine` plugin. This plugin's
+functionality has been merged into the main Vagrant project and should be
+considered deprecated. To uninstall the plugin, run the command shown below:
+
+  vagrant plugin uninstall vagrant-alpine
+
+EOF
+        end
+      end
+
+      self.check_community_plugin
     end
   end
 end

data/plugins/guests/centos/cap/flavor.rb

@@ -0,0 +1,24 @@
+module VagrantPlugins
+  module GuestCentos
+    module Cap
+      class Flavor
+        def self.flavor(machine)
+          # Read the version file
+          output = ""
+          machine.communicate.sudo("cat /etc/centos-release") do |_, data|
+            output = data
+          end
+
+          # Detect various flavors we care about
+          if output =~ /(CentOS)( .+)? 7/i
+            return :centos_7
+          elsif output =~ /(CentOS)( .+)? 8/i
+            return :centos_8
+          else
+            return :centos
+          end
+        end
+      end
+    end
+  end
+end

data/plugins/guests/centos/guest.rb

@@ -0,0 +1,9 @@
+module VagrantPlugins
+  module GuestCentos
+    class Guest < Vagrant.plugin("2", :guest)
+      def detect?(machine)
+        machine.communicate.test("cat /etc/centos-release")
+      end
+    end
+  end
+end

data/plugins/guests/centos/plugin.rb

@@ -0,0 +1,20 @@
+require "vagrant"
+
+module VagrantPlugins
+  module GuestCentos
+    class Plugin < Vagrant.plugin("2")
+      name "CentOS guest"
+      description "CentOS guest support."
+
+      guest(:centos, :redhat) do
+        require_relative "guest"
+        Guest
+      end
+
+      guest_capability(:centos, :flavor) do
+        require_relative "cap/flavor"
+        Cap::Flavor
+      end
+    end
+  end
+end

data/plugins/guests/darwin/cap/mount_vmware_shared_folder.rb

@@ -1,34 +1,120 @@
+require "securerandom"
+
 module VagrantPlugins
   module GuestDarwin
     module Cap
       class MountVmwareSharedFolder
+        # Entry point for hook to called delayed actions
+        # which finalizing the synced folders setup on
+        # the guest
+        def self.write_apfs_firmlinks(env)
+          if env && env[:machine] && delayed = apfs_firmlinks_delayed.delete(env[:machine].id)
+            delayed.call
+          end
+        end
+
+        # @return [Hash] storage location for delayed actions
+        def self.apfs_firmlinks_delayed
+          if !@_apfs_firmlinks
+            @_apfs_firmlinks = {}
+          end
+          @_apfs_firmlinks
+        end
 
         # we seem to be unable to ask 'mount -t vmhgfs' to mount the roots
         # of specific shares, so instead we symlink from what is already
-        # mounted by the guest tools 
+        # mounted by the guest tools
         # (ie. the behaviour of the VMware_fusion provider prior to 0.8.x)
 
         def self.mount_vmware_shared_folder(machine, name, guestpath, options)
+          # Use this variable to determine which machines
+          # have been registered with after hook
+          @apply_firmlinks ||= Hash.new{ |h, k| h[k] = {bootstrap: false, content: []} }
+
           machine.communicate.tap do |comm|
-            # clear prior symlink
-            if comm.test("test -L \"#{guestpath}\"", sudo: true)
-              comm.sudo("rm -f \"#{guestpath}\"")
+            # check if we are dealing with an APFS root container
+            if comm.test("test -d /System/Volumes/Data")
+              parts = Pathname.new(guestpath).descend.to_a
+              firmlink = parts[1].to_s
+              firmlink.slice!(0, 1) if firmlink.start_with?("/")
+              if parts.size > 2
+                guestpath = File.join("/System/Volumes/Data", guestpath)
+              else
+                guestpath = nil
+              end
             end
 
-            # clear prior directory if exists
-            if comm.test("test -d \"#{guestpath}\"", sudo: true)
-              comm.sudo("rm -Rf \"#{guestpath}\"")
+            # Remove existing symlink or directory if defined
+            if guestpath
+              if comm.test("test -L \"#{guestpath}\"")
+                comm.sudo("rm -f \"#{guestpath}\"")
+              elsif comm.test("test -d \"#{guestpath}\"")
+                comm.sudo("rm -Rf \"#{guestpath}\"")
+              end
+
+              # create intermediate directories if needed
+              intermediate_dir = File.dirname(guestpath)
+              if intermediate_dir != "/"
+                comm.sudo("mkdir -p \"#{intermediate_dir}\"")
+              end
+
+              comm.sudo("ln -s \"/Volumes/VMware Shared Folders/#{name}\" \"#{guestpath}\"")
             end
 
-            # create intermediate directories if needed
-            intermediate_dir = File.dirname(guestpath)
-            if !comm.test("test -d \"#{intermediate_dir}\"", sudo: true)
-              comm.sudo("mkdir -p \"#{intermediate_dir}\"")
+            if firmlink && !system_firmlink?(firmlink)
+              if guestpath.nil?
+                guestpath = "/Volumes/VMware Shared Folders/#{name}"
+              else
+                guestpath = File.join("/System/Volumes/Data", firmlink)
+              end
+
+              share_line = "#{firmlink}\t#{guestpath}"
+
+              # Check if the line is already defined. If so, bail since we are done
+              if !comm.test("[[ \"$(</etc/synthetic.conf)\" = *\"#{share_line}\"* ]]")
+                @apply_firmlinks[machine.id][:bootstrap] = true
+              end
+
+              # If we haven't already added our hook to apply firmlinks, do it now
+              if @apply_firmlinks[machine.id][:content].empty?
+                apfs_firmlinks_delayed[machine.id] = proc do
+                  content = @apply_firmlinks[machine.id][:content].join("\n")
+                  # Write out the synthetic file
+                  comm.sudo("echo -e #{content.inspect} > /etc/synthetic.conf")
+                  if @apply_firmlinks[:bootstrap]
+                    # Re-bootstrap the root container to pick up firmlink updates
+                    comm.sudo("/System/Library/Filesystems/apfs.fs/Contents/Resources/apfs.util -B")
+                  end
+                end
+              end
+              @apply_firmlinks[machine.id][:content] << share_line
             end
+          end
+        end
 
-            # finally make the symlink
-            comm.sudo("ln -s \"/Volumes/VMware Shared Folders/#{name}\" \"#{guestpath}\"")
+        # Check if firmlink is provided by the system
+        #
+        # @param [String] firmlink Firmlink path
+        # @return [Boolean]
+        def self.system_firmlink?(firmlink)
+          if !@_firmlinks
+            if File.exist?("/usr/share/firmlinks")
+              @_firmlinks = File.readlines("/usr/share/firmlinks").map do |line|
+                line.split.first
+              end
+            else
+              @_firmlinks = []
+            end
           end
+          firmlink = "/#{firmlink}" if !firmlink.start_with?("/")
+          @_firmlinks.include?(firmlink)
+        end
+
+        # @private
+        # Reset the cached values for capability. This is not considered a public
+        # API and should only be used for testing.
+        def self.reset!
+          instance_variables.each(&method(:remove_instance_variable))
         end
       end
     end