Merge pull request #22 from dustymabe/dusty-add-unmounting

Add ability to unmount guest folders

README.md

@@ -87,13 +87,13 @@ section.
 ## Executing the `vagrant sshfs` Command
 
 The Vagrant SSHFS plugin also supports execution of the `vagrant sshfs`
-command from the command line. Executing this command will
-iterate through the Vagrant file and attempt to mount (via SSHFS) any
-folders that aren't already mounted in the Vagrant guest that is
-associated with the current directory.
+command from the command line. Executing this command with the `--mount`
+option will iterate through the Vagrant file and attempt to mount (via 
+SSHFS) any folders that aren't already mounted in the Vagrant guest.
+Executing with the `--unmount` option will unmount any mounted folders.
 
 ```
-vagrant sshfs
+vagrant sshfs [--mount|--unmount] [vm-name]
 ```
 
 ## Options

lib/vagrant-sshfs/cap/linux/sshfs_mount.rb

@@ -69,6 +69,33 @@ def self.sshfs_mount_folder(machine, opts)
           end
         end
 
+        def self.sshfs_unmount_folder(machine, opts)
+          # opts contains something like:
+          #   { :type=>:sshfs,
+          #     :guestpath=>"/sharedfolder",
+          #     :hostpath=>"/guests/sharedfolder",
+          #     :disabled=>false
+          #     :ssh_host=>"192.168.1.1"
+          #     :ssh_port=>"22"
+          #     :ssh_username=>"username"
+          #     :ssh_password=>"password"
+          #   }
+
+          # expand the guest path so we can handle things like "~/vagrant"
+          expanded_guest_path = machine.guest.capability(
+            :shell_expand_guest_path, opts[:guestpath])
+
+          # Log some information
+          machine.ui.info(I18n.t("vagrant.sshfs.actions.unmounting_folder",
+                                 guestpath: expanded_guest_path))
+
+          # Build up the command and connect
+          error_class = VagrantPlugins::SyncedFolderSSHFS::Errors::SSHFSUnmountFailed
+          cmd = "umount #{expanded_guest_path}"
+          machine.communicate.sudo(
+            cmd, error_class: error_class, error_key: :unmount_failed)
+        end
+
         protected
 
         # Perform a mount by running an sftp-server on the vagrant host 

lib/vagrant-sshfs/command.rb

@@ -10,11 +10,19 @@ def self.synopsis
         end
 
         def execute
+          options = {:unmount => false} # Default to mounting shares
           opts = OptionParser.new do |o|
-            o.banner = "Usage: vagrant sshfs"
+            o.banner = "Usage: vagrant sshfs [--mount|--unmount] [vm-name]"
             o.separator ""
-            o.separator "Mount all sshfs synced folders into the vagrant box"
+            o.separator "Mount or unmount sshfs synced folders into the vagrant box"
             o.separator ""
+
+            o.on("--mount", "Mount folders - the default") do
+              options[:unmount] = false
+            end
+            o.on("--unmount", "Unmount folders") do
+              options[:unmount] = true
+            end
           end
 
           # Parse the options and return if we don't have any target.
@@ -36,8 +44,12 @@ def execute
             folders = synced_folders(machine, cached: false)[:sshfs]
             next if !folders || folders.empty?
 
-            # Sync them!
-            SyncedFolder.new.enable(machine, folders, {})
+            # Mount or Unmount depending on the user's request
+            if options[:unmount]
+              SyncedFolder.new.disable(machine, folders, {})
+            else
+              SyncedFolder.new.enable(machine, folders, {})
+            end
           end
           return error ? 1 : 0
         end

lib/vagrant-sshfs/errors.rb

@@ -14,6 +14,10 @@ class SSHFSSlaveMountFailed < SSHFSError
         error_key(:slave_mount_failed)
       end
 
+      class SSHFSUnmountFailed < SSHFSError
+        error_key(:unmount_failed)
+      end
+
       class SSHFSInstallFailed < SSHFSError
         error_key(:install_failed)
       end

lib/vagrant-sshfs/plugin.rb

@@ -15,7 +15,7 @@ class Plugin < Vagrant.plugin("2")
         SyncedFolder
       end
 
-      command("sshfs", primary: false) do
+      command("sshfs", primary: true) do
         require_relative "command"
         Command::SSHFS
       end
@@ -25,6 +25,11 @@ class Plugin < Vagrant.plugin("2")
         VagrantPlugins::GuestLinux::Cap::MountSSHFS
       end
 
+      guest_capability("linux", "sshfs_unmount_folder") do
+        require_relative "cap/linux/sshfs_mount"
+        VagrantPlugins::GuestLinux::Cap::MountSSHFS
+      end
+
       guest_capability("linux", "sshfs_is_folder_mounted") do
         require_relative "cap/linux/sshfs_mount"
         VagrantPlugins::GuestLinux::Cap::MountSSHFS

lib/vagrant-sshfs/synced_folder.rb

@@ -79,6 +79,35 @@ def enable(machine, folders, pluginopts)
         end
       end
 
+      # This is called to remove the synced folders from a running
+      # machine.
+      #
+      # This is not guaranteed to be called, but this should be implemented
+      # by every synced folder implementation.
+      #
+      # @param [Machine] machine The machine to modify.
+      # @param [Hash] folders The folders to remove. This will not contain
+      #   any folders that should remain.
+      # @param [Hash] opts Any options for the synced folders.
+      def disable(machine, folders, opts)
+
+        # Iterate through the folders and mount if needed
+        folders.each do |id, opts|
+
+          # If not mounted then there is nothing to do
+          if ! machine.guest.capability(:sshfs_is_folder_mounted, opts)
+            machine.ui.info(
+              I18n.t("vagrant.sshfs.info.not_mounted",
+                     folder: opts[:guestpath]))
+            next
+          end
+
+          # Do the Unmount
+          machine.ui.info(I18n.t("vagrant.sshfs.actions.unmounting"))
+          machine.guest.capability(:sshfs_unmount_folder, opts)
+        end
+      end
+
       # This is called after destroying the machine during a
       # `vagrant destroy` and also prior to syncing folders during
       # a `vagrant up`.

locales/synced_folder_sshfs.yml

@@ -3,7 +3,10 @@ en:
     sshfs:
       actions:
         installing: Installing SSHFS client...
-        mounting: Mounting SSHFS shared folders...
+        mounting: Mounting SSHFS shared folder...
+        unmounting: Unmounting SSHFS shared folder...
+        unmounting_folder: |-
+          Unmounting SSHFS shared folder mounted at %{guestpath}
         slave_mounting_folder: |-
           Mounting folder via SSHFS: %{hostpath} => %{guestpath}
         normal_mounting_folder: |-
@@ -16,6 +19,8 @@ en:
           Detected host IP address is '%{ip}'
         already_mounted: |-
           The folder %{folder} in the guest already mounted.
+        not_mounted: |-
+          The folder %{folder} in the guest is not mounted.
       errors:
         communicator_not_ready: |-
           The machine is reporting that it is not ready to communicate via ssh. Verify
@@ -54,3 +59,17 @@ en:
           Mounting SSHFS shared via slave SSHFS mount failed. Please look at your 
           terminal scrollback to look for any error messages from the processes that 
           were run.
+        unmount_failed: |-
+          Unmount the SSHFS mount failed.
+
+          The command and output are:
+
+          %{command}
+
+          Stdout from the command:
+
+          %{stdout}
+
+          Stderr from the command:
+
+          %{stderr}