valkyrie-sshfs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 420048c4934d57d9d41eaec3a9187bed6969c693
+  data.tar.gz: 7af7b8d1a456e047805580439dbc73ecbae8cb8b
+SHA512:
+  metadata.gz: e10544ed437af845a03e626ef9f32b122e0142594c30ffaa6d090d85568754f9647ed792777a337076c56da455f03b1186a909ae706bed464c132e8c26fd9b97
+  data.tar.gz: 613036cf94b83af0cd5f6aa19a94f8daf7273872e7e348b35250c4763a0345a488c29479b00c60d693a2c4462ec29454f518f996e33d8d00296b2813898a0d8c

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,51 @@
+## 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

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'vagrant', :git => 'git://github.com/mitchellh/vagrant.git', :tag => 'v1.4.0'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2013 Fabio Kreusch
+https://github.com/fabiokr/vagrant-sshfs
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# valkyrie-sshfs
+
+A Vagrant plugin to mount a folder from the box to the host (or vice-versa) using sshfs.
+
+This is a fork of the vagrant-sshfs plugin, with a couple tweaks for use on
+Valkyrie.
+
+## Why
+
+Common solutions for sharing folders with Vagrant include synced folder, which is pretty slow when dealing with many files, and NFS. NFS didn't work for us since it limits one's ability to change file permissions and ownership. An alternative was to mount a folder in the host machine pointing to a folder in the box with sshfs.
+
+## Installation
+
+`vagrant plugin install valkyrie-sshfs`
+
+## Usage
+
+In the `Vagrantfile`, add a configuration like this:
+
+`config.vsshfs.paths = { "src" => "mountpoint" }`
+
+`src` is the source absolute path to the folder in the box, `mountpoint` is the folder in the host machine. `mountpoint` can be an absolute path, or relative to the `Vagrantfile`.
+
+By default it will use the Vagrant ssh username. You can change that with the following:
+
+`config.vsshfs.username = "theusername"`
+
+The plugin is enabled by default, so it will run everytime the machine starts. In case that is not desired, you can disabled that with the following configuration:
+
+`config.vsshfs.enabled = false`
+
+To manually run it, you can use the `vsshfs` command. Please check `vagrant -h`.
+
+## Issues
+
+### Connection reset by peer
+
+In case you are getting "Connection reset by peer" errors, it might be the case that you already have a host configuration under your `~/.ssh/know_hosts` for the given ip, and you are using the same ip with a different machine. If that is the case, you can set a `StrictHostKeyChecking no` under that ip to skip the check:
+
+```
+Host 127.0.0.1
+StrictHostKeyChecking no
+```
+
+### Mounting on guest (box)
+
+You need to have `sshfs` installed on guest machine and ssh server on host.
+
+To mount a host folder on guest machine add a configuration like this:
+
+    config.vsshfs.mount_on_guest = true
+    config.vsshfs.paths = { "src" => "mountpoint" }
+    config.vsshfs.host_addr = '10.0.2.2'
+
+`src` is the source absolute path to the folder in the host machine, `mountpoint` is the folder in the guest. `src` can be an absolute path, or relative to the `Vagrantfile`.
+`host_addr` is the host machine IP accessible from guest.
+
+## Contributing
+
+If you have issues or ideas, please contribute! You can create an issue throught Github, or send a Pull Request.
+
+## Development
+
+To try this out, you can run `bundle exec vagrant up` from the source code checkout.

data/Vagrantfile

@@ -0,0 +1,8 @@
+Vagrant.require_plugin "valkyrie-sshfs"
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "precise64"
+  config.vm.box_url = "http://files.vagrantup.com/precise64.box"
+
+  config.vsshfs.paths = { "/home/vagrant/src" => "mountpoint" }
+end

data/lib/valkyrie-sshfs.rb

@@ -0,0 +1,22 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Valkyrie SSHFS plugin must be run within Vagrant"
+end
+
+require "valkyrie-sshfs/errors"
+require "valkyrie-sshfs/plugin"
+require "valkyrie-sshfs/actions"
+require "valkyrie-sshfs/command"
+
+module Vagrant
+  module VSshFs
+    # Returns the path to the source of this plugin
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+
+    I18n.load_path << File.expand_path('locales/en.yml', source_root)
+    I18n.reload!
+  end
+end

data/lib/valkyrie-sshfs/actions.rb

@@ -0,0 +1,31 @@
+require 'valkyrie-sshfs/builders/base'
+require 'valkyrie-sshfs/builders/host'
+require 'valkyrie-sshfs/builders/guest'
+
+module Vagrant
+  module VSshFs
+    module Actions
+      class Up
+        def initialize(app, env)
+          @machine = env[:machine]
+        end
+
+        def call(env)
+          get_builder(env).mount! if @machine.config.vsshfs.enabled
+        end
+
+        private
+
+        def get_builder(env)
+          if @machine.config.vsshfs.mount_on_guest
+            Builders::Guest.new(env[:machine], env[:ui])
+          else
+            Builders::Host.new(env[:machine], env[:ui])
+          end
+        end
+      end
+
+      class Reload < Up; end
+    end
+  end
+end

data/lib/valkyrie-sshfs/builders/base.rb

@@ -0,0 +1,47 @@
+module Vagrant
+  module VSshFs
+    module Builders
+      class Base
+        attr_reader :machine, :ui
+
+        def initialize(machine, ui)
+          @machine, @ui = machine, ui
+        end
+
+        def mount!
+          paths.each do |src, target|
+            info("unmounting", src: target)
+            unmount(target)
+            info("mounting", src: src, target: target)
+            mount(src, target)
+          end
+        end
+
+        def mount
+          raise NotImplementedError
+        end
+
+        def paths
+          machine.config.vsshfs.paths
+        end
+
+        def info(key, *args)
+          ui.info(i18n("info.#{key}", *args))
+        end
+
+        def ask(key, *args)
+          ui.ask(i18n("ask.#{key}", *args), :new_line => true)
+        end
+
+        def error(key, *args)
+          ui.error(i18n("error.#{key}", *args))
+          raise Error, :base
+        end
+
+        def i18n(key, *args)
+          I18n.t("vagrant.config.vsshfs.#{key}", *args)
+        end
+      end
+    end
+  end
+end

data/lib/valkyrie-sshfs/builders/guest.rb

@@ -0,0 +1,41 @@
+module Vagrant
+  module VSshFs
+    module Builders
+      class Guest < Base
+        private
+
+        def unmount(target)
+          if machine.communicate.execute("which fusermount", error_check: false) == 0
+            machine.communicate.execute("fusermount -u -q #{target}", error_check: false)
+          else
+            machine.communicate.execute("umount #{target}", error_check: false)
+          end
+        end
+
+        def mount(src, target)
+          source = File.expand_path(src)
+
+          status = machine.communicate.execute(
+            "echo \"#{password}\" | sshfs -o allow_other -o password_stdin #{username}@#{host}:#{source} #{target}",
+            :sudo => true, :error_check => false)
+
+          if status != 0
+            error('not_mounted', src: source, target: target)
+          end
+        end
+
+        def host
+          machine.config.vsshfs.host_addr
+        end
+
+        def username
+          `whoami`.strip
+        end
+
+        def password
+          Shellwords.escape(ui.ask(i18n("ask.pass", :user => "#{username}@#{host}"), :echo => false))
+        end
+      end
+    end
+  end
+end

data/lib/valkyrie-sshfs/builders/host.rb

@@ -0,0 +1,89 @@
+require 'fileutils'
+
+module Vagrant
+  module VSshFs
+    module Builders
+      class Host < Base
+        private
+
+        def unmount(target)
+          if `which fusermount`.empty?
+            `umount #{target}`
+          else
+            `fusermount -u -q #{target}`
+          end
+        end
+
+        def mount(src, target)
+          extra_options = '-o reconnect -o idmap=user'
+          `#{sshfs_bin} #{extra_options} -p #{port} #{username}@#{host}:#{check_src!(src)} #{check_target!(target)} -o IdentityFile=#{private_key} -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null `
+        end
+
+        def ssh_info
+          machine.ssh_info
+        end
+
+        def username
+          machine.config.vsshfs.username ||= ssh_info[:username]
+        end
+
+        def host
+          ssh_info[:host]
+        end
+
+        def port
+          ssh_info[:port]
+        end
+
+        def private_key
+          Array(ssh_info[:private_key_path]).first
+        end
+
+        def sshfs_bin
+          bin = `which sshfs`.chomp
+
+          if bin.empty?
+            error("bin_not_found")
+          else
+            bin
+          end
+        end
+
+        def check_src!(src)
+          unless machine.communicate.test("test -d #{src}")
+            if ask("create_src", src: src) == "y"
+              machine.communicate.execute("mkdir -p #{src}")
+              info("created_src", src: src)
+            else
+              error("not_created_src", src: src)
+            end
+          end
+
+          src
+        end
+
+        def check_target!(target)
+          folder = target_folder(target)
+
+          # entries return . and .. when empty
+          if File.exist?(folder) && Dir.entries(folder).size > 2
+            error("non_empty_target", target: folder)
+          elsif !File.exist?(folder)
+            if ask("create_target", target: folder)[0,1].downcase == "y"
+              FileUtils.mkdir_p(folder)
+              info("created_target", target: folder)
+            else
+              error("not_created_target", target: folder)
+            end
+          end
+
+          folder
+        end
+
+        def target_folder(target)
+          File.expand_path(target)
+        end
+      end
+    end
+  end
+end

data/lib/valkyrie-sshfs/command.rb

@@ -0,0 +1,27 @@
+module Vagrant
+  module VSshFs
+    class Command < Vagrant.plugin(2, :command)
+      def self.synopsis
+        "mounts sshfs shared folders"
+      end
+
+      def execute
+        with_target_vms do |machine|
+          get_builder(machine).mount!
+        end
+
+        0
+      end
+
+      private
+
+      def get_builder(machine)
+        if machine.config.vsshfs.mount_on_guest
+          Builders::Guest.new(machine, @env.ui)
+        else
+          Builders::Host.new(machine, @env.ui)
+        end
+      end
+    end
+  end
+end

data/lib/valkyrie-sshfs/config.rb

@@ -0,0 +1,23 @@
+module Vagrant
+  module VSshFs
+    class Config < Vagrant.plugin(2, :config)
+      attr_accessor :paths
+      attr_accessor :username
+      attr_accessor :enabled
+      attr_accessor :mount_on_guest
+      attr_accessor :host_addr
+
+      def initialize
+        @paths = {}
+        @username = nil
+        @enabled = true
+      end
+
+      def merge(other)
+        super.tap do |result|
+          result.paths = @paths.merge(other.paths)
+        end
+      end
+    end
+  end
+end

data/lib/valkyrie-sshfs/errors.rb

@@ -0,0 +1,7 @@
+module Vagrant
+  module VSshFs
+    class Error < Errors::VagrantError
+      error_namespace("vagrant.config.vsshfs.error")
+    end
+  end
+end

data/lib/valkyrie-sshfs/plugin.rb

@@ -0,0 +1,25 @@
+module Vagrant
+  module VSshFs
+    class Plugin < Vagrant.plugin("2")
+      name "valkyrie-sshfs"
+      description "A Vagrant plugin that mounts sshfs in the host machine."
+
+      config "vsshfs" do
+        require "valkyrie-sshfs/config"
+        Config
+      end
+
+      action_hook(:vsshfs, :machine_action_up) do |hook|
+        hook.append(Vagrant::VSshFs::Actions::Up)
+      end
+
+      action_hook(:vsshfs, :machine_action_reload) do |hook|
+        hook.append(Vagrant::VSshFs::Actions::Reload)
+      end
+
+      command "vsshfs" do
+        Vagrant::VSshFs::Command
+      end
+    end
+  end
+end

data/locales/en.yml

@@ -0,0 +1,21 @@
+en:
+  vagrant:
+    config:
+      vsshfs:
+        info:
+          unmounting: "Unmounting SSHFS for `%{src}`"
+          mounting: "Mounting SSHFS for `%{src}` to `%{target}`"
+          unmounted: "Unmounted SSHFS for `%{target}`"
+          created_src: "Created src `%{src}`"
+          created_target: "Created target `%{target}`"
+        ask:
+          create_src: "Source folder `%{src}` does not exist, create?"
+          create_target: "Target folder `%{target}` does not exist, create? (y/n)"
+          pass: "Password for `%{user}`:"
+        error:
+          base: "valkyrie-sshfs failed and couldn't proceed"
+          non_empty_target: "Non empty target folder `%{target}`"
+          not_created_src: "Source folder `%{src}` was not created"
+          not_created_target: "Target folder `%{target}` was not created"
+          not_mounted: "Error when mounting `%{src}` to `%{target}`"
+          bin_not_found: "Could not find sshfs bin in the host machine. Please make sure it is installed."

data/valkyrie-sshfs.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "valkyrie-sshfs"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Christopher Gervais"]
+  spec.email         = ["chris@poeticsystems.com"]
+  spec.description   = "A Vagrant plugin that mounts folders with sshfs in the host machine. Adapted from vagrant-sshfs for use with Valkyrie."
+  spec.summary       = "A Vagrant plugin that mounts folders with sshfs"
+  spec.homepage      = "https://github.com/GetValkyrie/valkyrie-sshfs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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", '~> 0'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: valkyrie-sshfs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christopher Gervais
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '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.
+  Adapted from vagrant-sshfs for use with Valkyrie.
+email:
+- chris@poeticsystems.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Vagrantfile
+- lib/valkyrie-sshfs.rb
+- lib/valkyrie-sshfs/actions.rb
+- lib/valkyrie-sshfs/builders/base.rb
+- lib/valkyrie-sshfs/builders/guest.rb
+- lib/valkyrie-sshfs/builders/host.rb
+- lib/valkyrie-sshfs/command.rb
+- lib/valkyrie-sshfs/config.rb
+- lib/valkyrie-sshfs/errors.rb
+- lib/valkyrie-sshfs/plugin.rb
+- locales/en.yml
+- valkyrie-sshfs.gemspec
+homepage: https://github.com/GetValkyrie/valkyrie-sshfs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Vagrant plugin that mounts folders with sshfs
+test_files: []