vagrant-sshfs 0.0.8 → 1.0.0

data/lib/vagrant-sshfs/synced_folder.rb

@@ -0,0 +1,154 @@
+require "vagrant/util/platform"
+
+module VagrantPlugins
+  module SyncedFolderSSHFS
+    class SyncedFolder < Vagrant.plugin("2", :synced_folder)
+      @@vagrant_host_machine_ip
+
+      def initialize(*args)
+        super
+        @@vagrant_host_machine_ip = nil
+      end
+
+      # This is called early when the synced folder is set to determine
+      # if this implementation can be used for this machine. This should
+      # return true or false.
+      #
+      # @param [Machine] machine
+      # @param [Boolean] raise_error If true, should raise an exception
+      #   if it isn't usable.
+      # @return [Boolean]
+      def usable?(machine, raise_error=false)
+        return true #for now
+      end
+
+      # This is called after the machine is booted and after networks
+      # are setup.
+      #
+      # This might be called with new folders while the machine is running.
+      # If so, then this should add only those folders without removing
+      # any existing ones.
+      #
+      # No return value.
+      def enable(machine, folders, sshfsopts)
+       if machine.guest.capability?(:sshfs_installed)
+          if !machine.guest.capability(:sshfs_installed)
+            can_install = machine.guest.capability?(:sshfs_install)
+            if !can_install
+              raise VagrantPlugins::SyncedFolderSSHFS::Errors::SSHFSNotInstalledInGuest
+            end
+            machine.ui.info(I18n.t("vagrant.sshfs.actions.installing"))
+            machine.guest.capability(:sshfs_install)
+          end
+        end
+
+        folders.each do |id, opts|
+
+          # If already mounted then there is nothing to do
+          if machine.guest.capability(:sshfs_is_folder_mounted, opts)
+            machine.ui.info(
+              I18n.t("vagrant.sshfs.info.already_mounted",
+                     folder: opts[:guestpath]))
+            next
+          end
+
+          # Find out the host info and auth info for each folder
+          get_host_info(machine, opts)
+          get_auth_info(machine, opts)
+
+          # Do the mount
+          machine.ui.info(I18n.t("vagrant.sshfs.actions.mounting"))
+          machine.guest.capability(:sshfs_mount_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`.
+      #
+      # No return value.
+      #
+      # @param [Machine] machine
+      # @param [Hash] opts
+      def cleanup(machine, opts)
+      end
+
+      protected
+
+      def get_host_info(machine, opts)
+        # opts - the synced folder options hash
+        # machine - 
+
+        # If the synced folder entry doesn't have host information in it then
+        # detect the vagrant host machine IP and use that
+        if not opts.has_key?(:ssh_host) or not opts[:ssh_host]
+            opts[:ssh_host] = detect_vagrant_host_ip(machine)
+        end
+
+        # If the synced folder doesn't have host port information in it 
+        # default to port 22 for ssh
+        # detect the vagrant host machine IP and use that
+        if not opts.has_key?(:ssh_port) or not opts[:ssh_port]
+            opts[:ssh_port] = '22'
+        end
+      end
+
+      def detect_vagrant_host_ip(machine)
+        # Only run detection if it hasn't been run before
+        if not @@vagrant_host_machine_ip
+          # Attempt to detect host machine IP by connecting over ssh
+          # and then using the $SSH_CONNECTION env variable information to
+          # determine the vagrant host IP address
+          hostip = ''
+          machine.communicate.execute('echo $SSH_CONNECTION') do |type, data|
+            if type == :stdout
+              hostip = data.split()[0]
+            end
+          end
+          # TODO do some error checking here to make sure hostip was detected
+          machine.ui.info(I18n.t("vagrant.sshfs.info.detected_host_ip", ip: hostip))
+          @@vagrant_host_machine_ip = hostip
+        end
+        # Return the detected host IP
+        @@vagrant_host_machine_ip
+      end
+
+      def get_auth_info(machine, opts)
+        # opts - the synced folder options hash
+        # machine - 
+        prompt_for_password = false
+        ssh_info = machine.ssh_info
+
+        # Detect the username of the current user
+        username = `whoami`.strip
+
+        # If no username provided then default to the current
+        # user that is executing vagrant
+          if not opts.has_key?(:ssh_username) or not opts[:ssh_username]
+            opts[:ssh_username] = username
+          end
+
+        # Check to see if we need to prompt the user for a password.
+        # We will prompt if:
+        #  - User asked us to via prompt_for_password option
+        #  - User did not provide a password in options and is not fwding ssh agent
+        #
+        if opts.has_key?(:prompt_for_password) and opts[:prompt_for_password]
+            prompt_for_password = opts[:prompt_for_password]
+        end
+          if not opts.has_key?(:ssh_password) or not opts[:ssh_password]
+            if not ssh_info.has_key?(:forward_agent) or not ssh_info[:forward_agent]
+            prompt_for_password = true
+            end 
+          end
+
+        # Now do the prompt
+        if prompt_for_password
+          opts[:ssh_password] = machine.ui.ask(
+              I18n.t("vagrant.sshfs.ask.prompt_for_password", username: opts[:ssh_username]),
+              echo: false)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-sshfs/version.rb

@@ -1,5 +1,5 @@
-module Vagrant
-  module SshFS
-    VERSION = "0.0.8"
+module VagrantPlugins
+  module SyncedFolderSSHFS
+    VERSION = "1.0.0"
   end
 end

data/locales/synced_folder_sshfs.yml

@@ -0,0 +1,46 @@
+en:
+  vagrant:
+    sshfs:
+      actions:
+        installing: Installing SSHFS client...
+        mounting: Mounting SSHFS shared folders...
+        mounting_folder: |-
+          Mounting folder via SSHFS: %{hostpath} => %{guestpath}
+      ask:
+        prompt_for_password: |-
+          SSHFS password for '%{username}':
+      info:
+        detected_host_ip: |-
+          Detected host IP address is '%{ip}'
+        already_mounted: |-
+          The folder %{folder} in the guest already mounted.
+      errors:
+        communicator_not_ready: |-
+          The machine is reporting that it is not ready to communicate via ssh. Verify
+          this machine is properly running.
+        sshfs_not_in_guest: |-
+          The necessary SSHFS software is not installed in the guest. 
+        install_failed_arch: |-
+          The install of the sshfs client software failed. On Arch this is most likely
+          because the package lists are not up to date [1] and partial upgrades are not
+          supported [2]. Please update your Arch system or install SSHFS manually.
+
+          [1] https://wiki.archlinux.org/index.php/pacman#Packages_cannot_be_retrieved_on_installation
+          [2] https://wiki.archlinux.org/index.php/System_maintenance#Partial_upgrades_are_unsupported
+        mount_failed: |-
+          Mounting SSHFS shared folders failed. This is most often caused by either
+          an SSH Daemon not running on the host or invalid credentials being provided.
+          Please make sure an SSH daemon is running on the host and proper credentials 
+          were provided to be able to authenticate via SSH.
+
+          The command and output are:
+
+          %{command}
+
+          Stdout from the command:
+
+          %{stdout}
+
+          Stderr from the command:
+
+          %{stderr}

data/vagrant-sshfs.gemspec

@@ -5,19 +5,22 @@ require 'vagrant-sshfs/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "vagrant-sshfs"
-  spec.version       = Vagrant::SshFS::VERSION
-  spec.authors       = ["fabiokr"]
-  spec.email         = ["fabiokr@gmail.com"]
-  spec.description   = "A Vagrant plugin that mounts folders with sshfs in the host machine."
+  spec.version       = VagrantPlugins::SyncedFolderSSHFS::VERSION
+  spec.authors       = ["Dusty Mabe"]
+  spec.email         = ["dusty@dustymabe.com"]
+  spec.description   = """
+    A Vagrant synced folder plugin that mounts folders via SSHFS. 
+    This is the successor to Fabio Kreusch's implementation:
+    https://github.com/fabiokr/vagrant-sshfs"""
   spec.summary       = spec.description
-  spec.homepage      = "https://github.com/fabiokr/vagrant-sshfs"
-  spec.license       = "MIT"
+  spec.homepage      = ""
+  spec.license       = "GPL"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-sshfs
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 1.0.0
 platform: ruby
 authors:
-- fabiokr
+- Dusty Mabe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-02 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,57 +16,58 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: A Vagrant plugin that mounts folders with sshfs in the host machine.
+        version: '10.0'
+description: "\n    A Vagrant synced folder plugin that mounts folders via SSHFS.
+  \n    This is the successor to Fabio Kreusch's implementation:\n    https://github.com/fabiokr/vagrant-sshfs"
 email:
-- fabiokr@gmail.com
+- dusty@dustymabe.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
-- LICENSE.txt
+- LICENSE
 - README.md
-- Vagrantfile
+- Rakefile
 - lib/vagrant-sshfs.rb
-- lib/vagrant-sshfs/actions.rb
-- lib/vagrant-sshfs/builders/base.rb
-- lib/vagrant-sshfs/builders/guest.rb
-- lib/vagrant-sshfs/builders/host.rb
+- lib/vagrant-sshfs/cap/arch/sshfs_client.rb
+- lib/vagrant-sshfs/cap/debian/sshfs_client.rb
+- lib/vagrant-sshfs/cap/fedora/sshfs_client.rb
+- lib/vagrant-sshfs/cap/linux/sshfs_client.rb
+- lib/vagrant-sshfs/cap/linux/sshfs_mount.rb
+- lib/vagrant-sshfs/cap/redhat/sshfs_client.rb
+- lib/vagrant-sshfs/cap/suse/sshfs_client.rb
 - lib/vagrant-sshfs/command.rb
-- lib/vagrant-sshfs/config.rb
 - lib/vagrant-sshfs/errors.rb
 - lib/vagrant-sshfs/plugin.rb
+- lib/vagrant-sshfs/synced_folder.rb
 - lib/vagrant-sshfs/version.rb
-- locales/en.yml
+- locales/synced_folder_sshfs.yml
 - vagrant-sshfs.gemspec
-homepage: https://github.com/fabiokr/vagrant-sshfs
+homepage: ''
 licenses:
-- MIT
+- GPL
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -84,9 +85,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: A Vagrant plugin that mounts folders with sshfs in the host machine.
+summary: 'A Vagrant synced folder plugin that mounts folders via SSHFS.  This is the
+  successor to Fabio Kreusch''s implementation: https://github.com/fabiokr/vagrant-sshfs'
 test_files: []
-has_rdoc: 

data/.gitignore

@@ -1,5 +0,0 @@
-.bundle
-mountpoint
-.vagrant
-*.gem
-.idea

data/CHANGELOG.md

@@ -1,65 +0,0 @@
-## vagrant-sshfs 0.0.8 (Jun 2, 2015) ##
-
-* Fixed unicode character issue
-
-    *seasick*
-
-## vagrant-sshfs 0.0.7 (Dec 8, 2014) ##
-
-*   Smooth folders creation.
-*   Unmount on machine Destroy/Halt/Suspend
-*   Remount on machine Resume/Provision/Suspend
-
-    *dmatora*
-
-## vagrant-sshfs 0.0.6 (Oct 14, 2014) ##
-
-*   Avoids StrictHostKeyChecking by default.
-
-    *James O'Doherty*
-
-## vagrant-sshfs 0.0.5 (May 26, 2014) ##
-
-*   Allows to disable the plugin to run on demand.
-
-    *Stéphane Klein*
-
-*   Allows to mount a host folder on the guest machine
-
-    *Adrian Olek*
-
-* Checks if the `sshfs` command is available
-
-    *Fabio Kreusch*
-
-* Unmount/mount on vagrant reload
-
-    *Fabio Kreusch*
-
-* Adds sshfs command
-
-    *Fabio Kreusch*
-
-## vagrant-sshfs 0.0.4 (March 5, 2014) ##
-
-*   Allows to set a custom ssh username.
-
-    *Daichi Nakajima*
-
-## vagrant-sshfs 0.0.3 (December 15, 2013) ##
-
-*   Uses an absolute source for the remote path.
-
-    *Fabio Kreusch*
-
-## vagrant-sshfs 0.0.2 (November 29, 2013) ##
-
-*   Revoked on wrong push.
-
-    *Fabio Kreusch*
-
-## vagrant-sshfs 0.0.1 (September 27, 2013) ##
-
-*   First release.
-
-    *Fabio Kreusch*

data/Gemfile.lock

@@ -1,40 +0,0 @@
-GIT
-  remote: git://github.com/mitchellh/vagrant.git
-  revision: 059de113a705f84ff165a4df049d38a2abcc60a8
-  tag: v1.4.0
-  specs:
-    vagrant (1.4.0)
-      childprocess (~> 0.3.7)
-      erubis (~> 2.7.0)
-      i18n (~> 0.6.0)
-      log4r (~> 1.1.9)
-      net-scp (~> 1.1.0)
-      net-ssh (>= 2.6.6, < 2.8.0)
-
-PATH
-  remote: .
-  specs:
-    vagrant-sshfs (0.0.6)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    childprocess (0.3.9)
-      ffi (~> 1.0, >= 1.0.11)
-    erubis (2.7.0)
-    ffi (1.9.3)
-    i18n (0.6.9)
-    log4r (1.1.10)
-    net-scp (1.1.2)
-      net-ssh (>= 2.6.5)
-    net-ssh (2.7.0)
-    rake (10.1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.3)
-  rake
-  vagrant!
-  vagrant-sshfs!