vagrant-sshfs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9649700d1265ecdc898d9024e70bb09f8a305a3f
+  data.tar.gz: 247f6c8331af219fcb9851276a59f06ec5a8cf28
+SHA512:
+  metadata.gz: 550760e3094176dc379e85daef499d8086b32a054324733190f4bdc86d2bcf88698d363c86cf2814964eeec92515ef74c6f377742f3c883d959453155d031294
+  data.tar.gz: b067dbda53d44fafc86cf23f47f368c7d2b3773130015f8e1c7f3e4c7dea731d627ef45ceba766d3a5cc5297b863ea20cf52207e762d3d8c8120590f30552dcb

data/.gitignore

@@ -0,0 +1,2 @@
+mountpoint
+.vagrant

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-dnsmasq.gemspec
+
+group :development do
+  gem 'vagrant', :git => 'git://github.com/mitchellh/vagrant.git', :tag => 'v1.2.2'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+GIT
+  remote: git://github.com/mitchellh/vagrant.git
+  revision: 7e400d00a3c5a0fdf2809c8b5001a035415a607b
+  tag: v1.2.2
+  specs:
+    vagrant (1.2.2)
+      childprocess (~> 0.3.7)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6.0)
+      json (>= 1.5.1, < 1.8.0)
+      log4r (~> 1.1.9)
+      net-scp (~> 1.1.0)
+      net-ssh (~> 2.6.6)
+
+PATH
+  remote: .
+  specs:
+    vagrant-sshfs (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    ffi (1.9.0)
+    i18n (0.6.5)
+    json (1.7.7)
+    log4r (1.1.10)
+    net-scp (1.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.6.8)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  rspec
+  vagrant!
+  vagrant-sshfs!

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,27 @@
+# vagrant-sshfs
+
+A Vagrant plugin to mount a folder from the box to the host using sshfs.
+
+## 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 me because of encrypted disk restrictions. An alternative was to mount a folder in the host machine pointing the a folder in the box with sshfs.
+
+## Installation
+
+`vagrant plugin install vagrant-sshfs`
+
+## Usage
+
+In the `Vagrantfile`, add a configuration like this:
+
+`config.sshfs.paths = { "src" => "mountpoint" }`
+
+`src` is the source folder in the box, `mountpoint` is the folder in the host machine. `src` is relative to the vagrant use home folder, usually `/home/vagrant`. `mountpoint` is relative to the `Vagrantfile`.
+
+## 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,7 @@
+Vagrant.require_plugin "vagrant-sshfs"
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "precise64"
+
+  config.sshfs.paths = { "src" => "mountpoint" }
+end

data/lib/vagrant-sshfs/actions.rb

@@ -0,0 +1,119 @@
+require 'fileutils'
+
+module Vagrant
+  module SshFS
+    module Actions
+      class Builder
+        def initialize(env)
+          @env = env
+        end
+
+        def mount!
+          paths.each do |src, target|
+            info("mounting", src: src, target: target)
+            `sshfs -p #{port} #{username}@#{host}:#{check_src!(src)} #{check_target!(target)} -o IdentityFile=#{private_key}`
+          end
+        end
+
+        private
+
+        def paths
+          machine.config.sshfs.paths
+        end
+
+        def ssh_info
+          machine.ssh_info
+        end
+
+        def username
+          ssh_info[:username]
+        end
+
+        def host
+          ssh_info[:host]
+        end
+
+        def port
+          ssh_info[:port]
+        end
+
+        def private_key
+          ssh_info[:private_key_path]
+        end
+
+        def check_src!(src)
+          folder = src_folder(src)
+
+          unless machine.communicate.test("test -d #{folder}")
+            if ask("create_src", src: folder) == "y"
+              machine.communicate.execute("mkdir -p #{folder}")
+              info("created_src", src: folder)
+            else
+              error("not_created_src", src: folder)
+            end
+          end
+
+          folder
+        end
+
+        def src_folder(src)
+          "/home/#{username}/#{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) == "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
+
+        def machine
+          @env[:machine]
+        end
+
+        def info(key, *args)
+          @env[:ui].info(i18n("info.#{key}", *args))
+        end
+
+        def ask(key, *args)
+          @env[:ui].ask(i18n("ask.#{key}", *args), :new_line => true)
+        end
+
+        def error(key, *args)
+          @env[:ui].error(i18n("error.#{key}", *args))
+          raise Error, :base
+        end
+
+        def i18n(key, *args)
+          I18n.t("vagrant.config.sshfs.#{key}", *args)
+        end
+      end
+
+      class Up
+        def initialize(app, env)
+          @app     = app
+          @machine = env[:machine]
+        end
+
+        def call(env)
+          Builder.new(env).mount!
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-sshfs/config.rb

@@ -0,0 +1,17 @@
+module Vagrant
+  module SshFS
+    class Config < Vagrant.plugin(2, :config)
+      attr_accessor :paths
+
+      def initialize
+        @paths = {}
+      end
+
+      def merge(other)
+        super.tap do |result|
+          result.paths = @paths.merge(other.paths)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-sshfs/errors.rb

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

data/lib/vagrant-sshfs/plugin.rb

@@ -0,0 +1,17 @@
+module Vagrant
+  module SshFS
+    class Plugin < Vagrant.plugin("2")
+      name "vagrant-sshfs"
+      description "A Vagrant plugin that mounts sshfs in the host machine."
+
+      config "sshfs" do
+        require "vagrant-sshfs/config"
+        Config
+      end
+
+      action_hook(:sshfs, :machine_action_up) do |hook|
+        hook.append(Vagrant::SshFS::Actions::Up)
+      end
+    end
+  end
+end

data/lib/vagrant-sshfs/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module SshFS
+    VERSION = "0.0.1"
+  end
+end

data/lib/vagrant-sshfs.rb

@@ -0,0 +1,22 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant bindfs plugin must be run within Vagrant"
+end
+
+require "vagrant-sshfs/version"
+require "vagrant-sshfs/errors"
+require "vagrant-sshfs/plugin"
+require "vagrant-sshfs/actions"
+
+module Vagrant
+  module SshFS
+    # 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/locales/en.yml

@@ -0,0 +1,17 @@
+en:
+  vagrant:
+    config:
+      sshfs:
+        info:
+          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?"
+        error:
+          base: "vagrant-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"

data/vagrant-sshfs.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.summary       = spec.description
+  spec.homepage      = "https://github.com/fabiokr/vagrant-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"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-sshfs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- fabiokr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 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.
+email:
+- fabiokr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Vagrantfile
+- lib/vagrant-sshfs.rb
+- lib/vagrant-sshfs/actions.rb
+- lib/vagrant-sshfs/config.rb
+- lib/vagrant-sshfs/errors.rb
+- lib/vagrant-sshfs/plugin.rb
+- lib/vagrant-sshfs/version.rb
+- locales/en.yml
+- vagrant-sshfs.gemspec
+homepage: https://github.com/fabiokr/vagrant-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.1.3
+signing_key: 
+specification_version: 4
+summary: A Vagrant plugin that mounts folders with sshfs in the host machine.
+test_files: []
+has_rdoc: