vagrant-bindfs 0.1.3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Folken Laëneck
+
+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,54 @@
+# vagrant-bindfs
+
+A Vagrant plugin to automate [bindfs](http://code.google.com/p/bindfs/) mount in the VM.
+This allow you to change owner, group and permissions on files and, for example, work around NFS share permissions issues.
+
+
+## Installation
+
+Vagrant-bindfs is distributed as a Ruby gem. You can install it as any other gem with `gem install vagrant-bindfs`
+
+
+## Configure your VM
+
+In your VagrantFile, you can use `config.bindfs.bind_folder` to configure folders that will be binded on VM startup.  
+Its basic syntax is `config.bindfs.bind_folder "source/dir", "mount/point"`.
+
+bind_folder support following arguments...
+
+- `:user` (defaults to 'vagrant')
+- `:group` (defaults to 'vagrant')
+- `:perms` (defaults to 'u=rwD:g=rD:o=rD')
+- `:mirror`
+- `:'mirror-only'`
+- `:'no-allow-other'`
+- `:'create-for-user'`
+- `:'create-for-group'`
+- `:'create-with-perms'`
+
+... and following flags (all disabled by default, vagrant-bindfs rely on bindfs own defaults) :
+
+- `:'create-as-user'`
+- `:'create-as-mounter'`
+- `:'chown-normal'`
+- `:'chown-ignore'`
+- `:'chown-deny'`
+- `:'chgrp-normal'`
+- `:'chgrp-ignore'`
+- `:'chgrp-deny'`
+- `:'chmod-normal'`
+- `:'chmod-ignore'`
+- `:'chmod-deny'`
+- `:'chmod-allow-x'`
+- `:'xattr-none'`
+- `:'xattr-ro'`
+- `:'xattr-rw'`
+- `:'ctime-from-mtime'`
+    
+Ex: `config.bindfs.bind_folder "source/dir", "mount/point", :perms => "u=rw:g=r:o=r", :create_as_user => true`.
+
+You can overwrite default options _via_ `config.bindfs.default_options`.
+
+See [bindfs man page](http://www.cs.helsinki.fi/u/partel/bindfs_docs/bindfs.1.html) for details.
+
+vagrant-bindfs does not check compatibility between given arguments but warn you when a binding command fail or when bindfs is not installed on your virtual machine.

data/lib/vagrant-bindfs/config.rb

@@ -0,0 +1,25 @@
+module VagrantBindfs
+  # A configuration class to configure defaults which are used for
+  # the `vagrant-bindfs` plugin.
+  class Config < Vagrant::Config::Base
+    configures :bindfs
+
+    attr_accessor :default_options
+    attr_reader :binded_folders
+
+    def initialize
+      @binded_folders = []
+      @default_options = nil
+    end
+
+    def bind_folder(path, bindpath, opts=nil)
+      @binded_folders << {
+        :path => path,
+        :bindpath => bindpath
+      }.merge(opts || {})
+    end
+
+    def validate(errors)
+    end
+  end
+end

data/lib/vagrant-bindfs/middleware.rb

@@ -0,0 +1,103 @@
+module VagrantBindfs
+  # A Vagrant middleware which use bindfs to relocate directories inside a VM
+  # and change their owner, group and permission.
+  class Middleware
+    
+    # Options
+    @@options = {
+      :owner                => 'vagrant',
+      :group                => 'vagrant',
+      :perms                => 'u=rwD:g=rD:o=rD',
+      :mirror               => nil,
+      :'mirror-only'        => nil,
+      :'no-allow-other'     => nil,
+      :'create-for-user'    => nil,
+      :'create-for-group'   => nil,
+      :'create-with-perms'  => nil,
+    }
+      
+    # Flags
+    @@flags = {
+      :'create-as-user'     => false,
+      :'create-as-mounter'  => false,
+      :'chown-normal'       => false,
+      :'chown-ignore'       => false,
+      :'chown-deny'         => false,
+      :'chgrp-normal'       => false,
+      :'chgrp-ignore'       => false,
+      :'chgrp-deny'         => false,
+      :'chmod-normal'       => false,
+      :'chmod-ignore'       => false,
+      :'chmod-deny'         => false,
+      :'chmod-allow-x'      => false,
+      :'xattr-none'         => false,
+      :'xattr-ro'           => false,
+      :'xattr-rw'           => false,
+      :'ctime-from-mtime'   => false,
+    }
+    
+    def initialize(app, env)
+      @app = app
+      @env = env
+    end
+
+    def call(env)
+      @env = env
+      @app.call(env)
+      bind_folders unless binded_folders.empty?
+    end
+
+    def binded_folders
+      @env.env.config.bindfs.binded_folders
+    end
+
+    def default_options
+      @@options.merge(@@flags).merge(@env.env.config.bindfs.default_options || {})
+    end
+
+    def bind_folders
+      @env["vm"].ssh.execute do |ssh|
+        
+        # Check if bindfs is installed on VM
+        begin
+          ssh.exec!("sudo bindfs --help")
+        rescue Vagrant::Errors::VagrantError => e
+          @env.ui.error e
+          @env.ui.error I18n.t("vagrant.actions.vm.bind_folders.bindfs_not_installed")
+          return
+        end
+        
+        @env.ui.info I18n.t("vagrant.actions.vm.bind_folders.binding")
+        binded_folders.each do |opts|
+
+          path     = opts.delete(:path)
+          bindpath = opts.delete(:bindpath)
+          opts     = default_options.merge(opts)
+
+          args = []
+          opts.each do |key, value|
+            if @@flags.key?(key)
+              args << "--#{key.to_s}" if !!value 
+            else
+              args << "--#{key.to_s}=#{value}" if !value.nil?
+            end
+          end
+          args = " #{args.join(" ")}"
+          
+          begin
+            ssh.exec!("sudo mkdir -p #{bindpath}")
+            ssh.exec!("sudo bindfs#{args} #{path} #{bindpath}")
+            @env.ui.info I18n.t("vagrant.actions.vm.bind_folders.binding_entry",
+              :path     => path,
+              :bindpath => bindpath
+              )
+          rescue Vagrant::Errors::VagrantError => e
+            @env.ui.error e
+            @env.ui.error I18n.t("vagrant.actions.vm.bind_folders.bindfs_command_fail")
+          end
+          
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-bindfs/version.rb

@@ -0,0 +1,3 @@
+module VagrantBindfs
+  VERSION = "0.1.3"
+end

data/lib/vagrant-bindfs.rb

@@ -0,0 +1,9 @@
+require 'vagrant'
+require 'vagrant-bindfs/config'
+require 'vagrant-bindfs/middleware'
+
+# Insert Bindfs before the NFS middleware in the ":start" Action stack
+Vagrant::Action[:start].insert Vagrant::Action::VM::NFS, VagrantBindfs::Middleware
+
+# Add custom translations to the load path
+I18n.load_path << File.expand_path("../../locales/en.yml", __FILE__)

data/lib/vagrant_init.rb

@@ -0,0 +1,2 @@
+# This file is automatically loaded by Vagrant to load any plugins.
+require 'vagrant-bindfs'

data/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  vagrant:
+    actions:
+      vm:
+        bind_folders:
+          bindfs_not_installed: bindfs seems to not being installed on the virtual machine
+          binding: Binding folders...
+          binding_entry: "-- %{path} bind to %{bindpath}"
+          bindfs_command_fail: |-
+            Please check options values and compatibility.
+            For a complete documentation, run `sudo bindfs --help` on the VM or see bindfs man page at http://www.cs.helsinki.fi/u/partel/bindfs_docs/bindfs.1.html

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: vagrant-bindfs
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
+platform: ruby
+authors: 
+- "Folken La\xC3\xABneck"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-02 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: vagrant
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id001
+description: A Vagrant plugin to automate bindfs mount in the VM. This allow you to change owner, group and permissions on files and, for example, work around NFS share permissions issues.
+email: 
+- folken.laeneck@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/vagrant-bindfs.rb
+- lib/vagrant_init.rb
+- lib/vagrant-bindfs/config.rb
+- lib/vagrant-bindfs/middleware.rb
+- lib/vagrant-bindfs/version.rb
+- locales/en.yml
+- README.md
+- LICENSE.txt
+has_rdoc: true
+homepage: https://github.com/folken-laeneck/vagrant-bindfs
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Vagrant plugin to automate bindfs mount in the VM
+test_files: []
+