Added support for cygwin guest

Author: zzambers

lib/vagrant-sshfs/cap/guest/cygwin/sshfs_client.rb

@@ -0,0 +1,11 @@
+module VagrantPlugins
+  module GuestCygwin
+    module Cap
+      class SSHFSClient
+        def self.sshfs_installed(machine)
+          machine.communicate.test("type sshfs")
+        end
+      end
+    end
+  end
+end

lib/vagrant-sshfs/cap/guest/cygwin/sshfs_forward_mount.rb

@@ -0,0 +1,45 @@
+require_relative "../linux/sshfs_forward_mount"
+
+module VagrantPlugins
+  module GuestCygwin
+    module Cap
+      class MountSSHFS < VagrantPlugins::GuestLinux::Cap::MountSSHFS
+
+        def self.is_cygwin(machine, opts)
+          return true
+        end
+
+        def self.sshfs_forward_get_umount_cmd(expanded_guest_path)
+          # sshfs-win mount is not seen as mount by cygwin,
+          # so we cannot unmount it using umount,
+          # we need to kill sshfs process ( which causes umount )
+
+          cmd = 'sh -c "'
+          # iterate over cmdlines of all cygwin processes
+          cmd += 'for cmdline in /proc/*/cmdline ; do'
+          # if command starts with sshfs
+          cmd += ' if strings -n 1 \\"\\${cmdline}\\" | head -n 1 | grep -q \'^sshfs\\$\''
+          # and contains #{expanded_guest_path}
+          cmd += " && strings -n 1 \\\"\\${cmdline}\\\" | grep -q '^#{expanded_guest_path}\\$' ;"
+          cmd += ' then'
+          # get pid from proc path
+          cmd += ' pid=\\"\\$( basename \\"\\$( dirname \\"\\${cmdline}\\" )\\" )\\" ;'
+          cmd += ' printf \'Syncing cached writes ...\\\\n\' ;'
+          # synchronize casched writes to filesystems (just in case)
+          cmd += ' sync ;'
+          cmd += ' printf \'Killing sshfs process: %s ...\\\\n\' \\"\\${pid}\\" ;'
+          # kill sshfs process
+          cmd += ' kill \\"\\${pid}\\" ;'
+          # break the loop
+          cmd += ' break ;'
+          cmd += ' fi'
+          cmd += ' done'
+          cmd += '"'
+
+          return cmd
+        end
+
+      end
+    end
+  end
+end

lib/vagrant-sshfs/cap/guest/linux/sshfs_forward_mount.rb

@@ -21,6 +21,10 @@ def self.list_mounts_command
           "cat /proc/mounts"
         end
 
+        def self.is_cygwin(machine, opts)
+          return false
+        end
+
         def self.sshfs_forward_is_folder_mounted(machine, opts)
           mounted = false
           guest_path = opts[:guestpath]
@@ -29,6 +33,11 @@ def self.sshfs_forward_is_folder_mounted(machine, opts)
           # can safely say it is not mounted
           exists = machine.communicate.test("test -e #{guest_path}", sudo: true)
           return false unless exists
+          # If path exists in cygwin it is considered mounted
+          # ( see comments for creating mountpoint lower )
+          if self.is_cygwin(machine, opts)
+             return true
+          end
 
           # find the absolute path so that we can properly check if it is mounted
           # https://github.com/dustymabe/vagrant-sshfs/issues/44
@@ -66,9 +75,13 @@ def self.sshfs_forward_mount_folder(machine, opts)
             :shell_expand_guest_path, opts[:guestpath])
 
           # Create the mountpoint inside the guest
-          machine.communicate.tap do |comm|
-            comm.sudo("mkdir -p #{expanded_guest_path}")
-            comm.sudo("chmod 777 #{expanded_guest_path}")
+          # for sshfs-win/cygwin to work, directory must NOT exist in place
+          # of future mount (unlike for sshfs/linux)
+          unless self.is_cygwin(machine, opts)
+            machine.communicate.tap do |comm|
+              comm.sudo("mkdir -p #{expanded_guest_path}")
+              comm.sudo("chmod 777 #{expanded_guest_path}")
+            end
           end
 
           # Mount path information: if arbitrary host mounting then
@@ -98,6 +111,10 @@ def self.sshfs_forward_mount_folder(machine, opts)
           end
         end
 
+        def self.sshfs_forward_get_umount_cmd(expanded_guest_path)
+          return "umount #{expanded_guest_path}"
+        end
+
         def self.sshfs_forward_unmount_folder(machine, opts)
           # opts contains something like:
           #   { :type=>:sshfs,
@@ -120,7 +137,7 @@ def self.sshfs_forward_unmount_folder(machine, opts)
 
           # Build up the command and connect
           error_class = VagrantPlugins::SyncedFolderSSHFS::Errors::SSHFSUnmountFailed
-          cmd = "umount #{expanded_guest_path}"
+          cmd = self.sshfs_forward_get_umount_cmd(expanded_guest_path)
           machine.communicate.sudo(
             cmd, error_class: error_class, error_key: :unmount_failed)
         end
@@ -210,7 +227,12 @@ def self.sshfs_slave_mount(machine, opts, hostpath, expanded_guest_path)
 
           # The remote sshfs command that will run (in slave mode)
           sshfs_opts+= ' -o slave '
-          sshfs_cmd = "sudo -E sshfs :#{hostpath} #{expanded_guest_path}"
+          if self.is_cygwin(machine, opts)
+            # cygwin does not support -E option
+            sshfs_cmd = "sudo sshfs :#{hostpath} #{expanded_guest_path}"
+          else
+            sshfs_cmd = "sudo -E sshfs :#{hostpath} #{expanded_guest_path}"
+          end
           sshfs_cmd+= sshfs_opts + ' ' + sshfs_opts_append + ' '
 
           # The ssh command to connect to guest and then launch sshfs

lib/vagrant-sshfs/plugin.rb

@@ -186,6 +186,32 @@ class Plugin < Vagrant.plugin("2")
         require_relative "cap/guest/freebsd/sshfs_client"
         VagrantPlugins::GuestFreeBSD::Cap::SSHFSClient
       end
+
+      guest_capability("cygwin", "sshfs_forward_mount_folder") do
+        require_relative "cap/guest/cygwin/sshfs_forward_mount"
+        VagrantPlugins::GuestCygwin::Cap::MountSSHFS
+      end
+
+      guest_capability("cygwin", "sshfs_forward_unmount_folder") do
+        require_relative "cap/guest/cygwin/sshfs_forward_mount"
+        VagrantPlugins::GuestCygwin::Cap::MountSSHFS
+      end
+
+      guest_capability("cygwin", "sshfs_forward_is_folder_mounted") do
+        require_relative "cap/guest/cygwin/sshfs_forward_mount"
+        VagrantPlugins::GuestCygwin::Cap::MountSSHFS
+      end
+
+      guest_capability("cygwin", "sshfs_get_absolute_path") do
+        require_relative "cap/guest/linux/sshfs_get_absolute_path"
+        VagrantPlugins::GuestLinux::Cap::SSHFSGetAbsolutePath
+      end
+
+      guest_capability("cygwin", "sshfs_installed") do
+        require_relative "cap/guest/cygwin/sshfs_client"
+        VagrantPlugins::GuestCygwin::Cap::SSHFSClient
+      end
+
     end
   end
 end