vagrant-bindfs 0.1.9 → 0.2.0

data/README.md

@@ -6,7 +6,8 @@ This allow you to change owner, group and permissions on files and, for example,
 
 ## Installation
 
-Vagrant-bindfs is distributed as a Ruby gem. You can install it as any other gem with `gem install vagrant-bindfs`
+Vagrant-bindfs is distributed as a Ruby gem.
+You can install it as any other Vagrant plugin with `vagrant plugin install vagrant-bindfs`.
 
 
 ## Configure your VM
@@ -16,18 +17,18 @@ In your VagrantFile, you can use `config.bindfs.bind_folder` to configure folder
     # In your Vagrantfile
     Vagrant::Config.run do |config|
     
-        [...] # Your VM configuration
-    
-        # Basic usage
-        config.bindfs.bind_folder "source/dir", "mount/point"
-        
-        # Advanced options
-        config.bindfs.bind_folder "source/dir", "mount/point", :perms => "u=rw:g=r:o=r", :create_as_user => true
+      [...] # Your VM configuration
+
+      # Basic usage
+      config.bindfs.bind_folder "source/dir", "mount/point"
+      
+      # Advanced options
+      config.bindfs.bind_folder "source/dir", "mount/point", :perms => "u=rw:g=r:o=r", :create_as_user => true
         
-        # Complete example for a NFS shared folder
-        config.vm.network :hostonly, "33.33.33.10" # (required to use NFS shared folder)
-        config.vm.share_folder "nfs-share", "/vagrant-nfs", "host/source/dir", :nfs => true 
-        config.bindfs.bind_folder "/vagrant-nfs", "guest/mount/point"
+      # Complete example for a NFS shared folder
+      config.vm.network :hostonly, "33.33.33.10" # (required to use NFS shared folder)
+      config.vm.share_folder "nfs-share", "/vagrant-nfs", "host/source/dir", :nfs => true 
+      config.bindfs.bind_folder "/vagrant-nfs", "guest/mount/point"
         
     end
 
@@ -68,4 +69,5 @@ 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.
+vagrant-bindfs does not check compatibility between given arguments but warn you when a binding command fail or if bindfs is not installed on your virtual machine.
+On Debian systems, it will try to install bindfs automatically.

data/lib/vagrant-bindfs.rb

@@ -1,13 +1,23 @@
-require 'vagrant'
-require 'vagrant-bindfs/error'
-require 'vagrant-bindfs/config'
-require 'vagrant-bindfs/middleware'
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant bindfs plugin must be run within Vagrant"
+end
 
-# Register Bindfs config
-Vagrant.config_keys.register(:bindfs) { VagrantBindfs::Config }
+require 'vagrant-bindfs/plugin'
+require 'vagrant-bindfs/version'
+require 'vagrant-bindfs/errors'
 
-# Insert Bindfs before the Provisions middleware in the ":start" and ":up" Action stack
-Vagrant.actions[:start].insert Vagrant::Action::VM::Provision, VagrantBindfs::Middleware
+require "pathname"
 
-# Add custom translations to the load path
-I18n.load_path << File.expand_path("../../locales/en.yml", __FILE__)
+module VagrantPlugins
+  module Bindfs
+    # 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/vagrant-bindfs/bind.rb

@@ -0,0 +1,112 @@
+module VagrantPlugins
+  module Bindfs
+    module Action
+      class Bind
+        # Options
+        @@options = {
+          :owner                => 'vagrant',
+          :group                => 'vagrant',
+          :perms                => 'u=rwX:g=rD:o=rD',
+          :mirror               => nil,
+          :'mirror-only'        => nil,
+          :'create-for-user'    => nil,
+          :'create-for-group'   => nil,
+          :'create-with-perms'  => nil,
+        }
+          
+        # Flags
+        @@flags = {
+          :'no-allow-other'     => false,
+          :'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)
+          @app.call(env)
+          @env = env
+          
+          @machine = env[:machine]
+
+          handle_bindfs_installation
+          bind_folders if !binded_folders.empty?
+        end
+
+        def binded_folders
+          @machine.config.bindfs.bind_folders
+        end
+
+        def default_options
+          @@options.merge(@@flags).merge(@machine.config.bindfs.default_options)
+        end
+        
+        def normalize_options opts
+          source  = opts.delete(:source_path)
+          dest    = opts.delete(:dest_path)
+          opts    = default_options.merge(opts)
+
+          args = []
+          opts.each do |key, value|
+            args << "--#{key.to_s}" if @@flags.key?(key) and !!value 
+            args << "--#{key.to_s}=#{value}" if @@options.key?(key) and !value.nil?
+          end
+          
+          [ source, dest, " #{args.join(" ")}" ]
+        end
+
+        def bind_folders
+          @env[:ui].info I18n.t("vagrant.config.bindfs.status.binding_all")
+
+          binded_folders.each do |id, opts|
+            source, dest, args = normalize_options opts
+            bind_command = "sudo bindfs#{args} #{source} #{dest}"
+          
+            unless @machine.communicate.test("test -d #{source}")
+              @env[:ui].error(I18n.t('vagrant.config.bindfs.errors.source_path_not_exist', :path => source))
+              next
+            end
+
+            if @machine.communicate.test("mount | grep bindfs | grep ' #{dest} '")
+              @env[:ui].info(I18n.t('vagrant.config.bindfs.already_mounted', :dest => dest))
+              next
+            end
+
+            @env[:ui].info I18n.t("vagrant.config.bindfs.status.binding_entry", :source => source, :dest => dest)
+
+            @machine.communicate.sudo("mkdir -p #{dest}")
+            @machine.communicate.sudo(bind_command, :error_class => Error, :error_key => :binding_failed)
+          end
+        end
+
+        def handle_bindfs_installation
+          if !@machine.guest.capability(:bindfs_installed)
+            @env[:ui].warn(I18n.t('vagrant.config.bindfs.not_installed'))
+
+            if !@machine.guest.capability(:bindfs_install)
+              raise Vagrant::Bindfs::Error, :cannot_install
+            end
+          end
+        end
+        
+      end #Bind
+    end #Action
+  end #Bindfs
+end #VagrantPlugins

data/lib/vagrant-bindfs/cap/debian/bindfs_install.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module Bindfs
+    module Cap
+      module Debian
+        module BindfsInstall
+
+          def self.bindfs_install(machine)
+            machine.communicate.tap do |comm|
+              comm.sudo('apt-get update')
+              comm.sudo('apt-get install -y bindfs')
+            end
+          end
+
+        end # BindfsInstall
+      end # Debian
+    end # Cap
+  end # Bindfs
+end # VagrantPlugins

data/lib/vagrant-bindfs/cap/linux/bindfs_installed.rb

@@ -0,0 +1,15 @@
+module VagrantPlugins
+  module Bindfs
+    module Cap
+      module Linux
+        module BindfsInstalled
+
+          def self.bindfs_installed(machine)
+            machine.communicate.test('bindfs --help')
+          end
+
+        end # BindfsInstalled
+      end # Linux
+    end # Cap
+  end # Bindfs
+end # module VagrantPlugins

data/lib/vagrant-bindfs/config.rb

@@ -1,26 +1,66 @@
-module VagrantBindfs
-  # A configuration class to configure defaults which are used for
-  # the `vagrant-bindfs` plugin.
-  class Config < Vagrant::Config::Base
-
-    attr_writer :default_options,
-                :binded_folders
-    
-    def default_options
-      @default_options || {}
-    end
-    
-    def binded_folders
-      @binded_folders || []
-    end
+module VagrantPlugins
+  module Bindfs
+    class Config < Vagrant.plugin('2', :config)
+
+      def initialize
+        @__default_options = {}
+        @__bind_folders = {}
+      end
+
+      def bind_folders
+        @__bind_folders
+      end
+
+      def default_options(new_options = {})
+        @__default_options.merge! new_options
+      end
+
+      def bind_folder(source_path, dest_path, opts = nil)
+        options ||= {}
+        options[:source_path] = source_path
+        options[:dest_path] = dest_path
+
+        @__bind_folders[options[:dest_path]] = options
+      end
+
+      def merge(other)
+        super.tap do |result|
+          # merge the changes to default options
+          result.instance_variable_set(
+            :@__default_options, default_options(other.default_options))
+
+          # merge the folders to be bound
+          new_folders = @__bind_folders.dup
+          other_folders = other.instance_variable_get(:@__bind_folders)
+
+          other_folders.each do |id, options|
+            new_folders[id] ||= {}
+            new_folders[id].merge!(options)
+          end
+
+          result.instance_variable_set(:@__bind_folders, new_folders)
+        end
+      end
+
+      def validate(machine)
+        errors = []
+
+        @__bind_folders.each do |id, options|
+          next if options[:disabled]
+
+          if Pathname.new(options[:dest_path]).relative?
+            errors << I18n.t('vagrant.config.bindfs.errors.destination_path_relative',
+              :path => options[:dest_path])
+          end
+
+          if Pathname.new(options[:source_path]).relative?
+            errors << I18n.t('vagrant.config.bindfs.errors.source_path_relative',
+              :path => options[:source_path])
+          end
+        end
 
-    def bind_folder(path, bindpath, opts = {})
-      @binded_folders = [] unless instance_variable_defined?(:@binded_folders)
-      @binded_folders << {
-        :path     => path,
-        :bindpath => bindpath
-      }.merge(opts)
+        errors.empty? && {} || { 'bindfs' => errors }
+      end
     end
-    
   end
-end
+end

data/lib/vagrant-bindfs/errors.rb

@@ -0,0 +1,9 @@
+require "vagrant"
+
+module VagrantPlugins
+  module Bindfs
+    class Error < Vagrant::Errors::VagrantError
+      error_namespace("vagrant.config.bindfs.errors")
+    end
+  end
+end

data/lib/vagrant-bindfs/plugin.rb

@@ -0,0 +1,31 @@
+module VagrantPlugins
+  module Bindfs
+    class Plugin < Vagrant.plugin("2")
+      name "Bindfs"
+      description <<-DESC
+      This plugin allows you to mount -o bind filesystems inside the guest. This is 
+      useful to change their ownership and permissions.
+      DESC
+
+      config(:bindfs) do
+        require 'vagrant-bindfs/config'
+        Config
+      end
+
+      guest_capability("debian", "bindfs_install") do
+        require 'vagrant-bindfs/cap/debian/bindfs_install'
+        Cap::Debian::BindfsInstall
+      end
+
+      guest_capability("linux", "bindfs_installed") do
+        require 'vagrant-bindfs/cap/linux/bindfs_installed'
+        Cap::Linux::BindfsInstalled
+      end
+
+      action_hook(:bindfs, :machine_action_up) do |hook|
+        require 'vagrant-bindfs/bind'
+        hook.prepend(Action::Bind)
+      end
+    end
+  end
+end

data/lib/vagrant-bindfs/version.rb

@@ -1,3 +1,3 @@
 module VagrantBindfs
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

data/locales/en.yml

@@ -1,13 +1,19 @@
 en:
   vagrant:
-    guest:
-      linux:
-        bindfs:
-          errors:
-            not_installed: bindfs seems to not being installed on the virtual machine
-            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
-          status:
-            binding: Binding folders...
-            binding_entry: "-- %{path} bind to %{bindpath}"
+    config:
+      bindfs:
+        not_installed: bindfs seems to not be installed on the virtual machine
+        already_mounted: "there's already a bindfs mount to destination %{dest}"
+        status:
+          binding_all: creating bind mounts for selected devices
+          binding_entry: creating bind mount from %{source} to %{dest}
+        errors:
+          destination_path_relative: "destination path is relative for bind whatever"
+          source_path_relative: "source path is relative for bind whatever"
+          source_path_not_exist: "cannot bind source path %{path} because it doesn't exist"
+          binding_failed: |-
+            bind command %{command} failed to run!
+
+            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

@@ -2,30 +2,22 @@
 name: vagrant-bindfs
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Folken La\xC3\xABneck"
+- Igor Serebryany
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2012-12-18 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: vagrant
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.0.5
-  type: :runtime
-  version_requirements: *id001
+date: 2013-06-03 00:00:00 Z
+dependencies: []
+
 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
+- igor.serebryany@airbnb.com
 executables: []
 
 extensions: []
@@ -33,12 +25,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/vagrant-bindfs/error.rb
-- lib/vagrant-bindfs/middleware.rb
+- lib/vagrant-bindfs/cap/linux/bindfs_installed.rb
+- lib/vagrant-bindfs/cap/debian/bindfs_install.rb
+- lib/vagrant-bindfs/bind.rb
+- lib/vagrant-bindfs/errors.rb
 - lib/vagrant-bindfs/version.rb
+- lib/vagrant-bindfs/plugin.rb
 - lib/vagrant-bindfs/config.rb
 - lib/vagrant-bindfs.rb
-- lib/vagrant_init.rb
 - locales/en.yml
 - README.md
 - LICENSE.txt

data/lib/vagrant-bindfs/error.rb

@@ -1,5 +0,0 @@
-module VagrantBindfs
-  class Error < Vagrant::Errors::VagrantError
-    error_namespace("vagrant.guest.linux.bindfs.errors")
-  end
-end

data/lib/vagrant-bindfs/middleware.rb

@@ -1,91 +0,0 @@
-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=rwX:g=rD:o=rD',
-      :mirror               => nil,
-      :'mirror-only'        => nil,
-      :'create-for-user'    => nil,
-      :'create-for-group'   => nil,
-      :'create-with-perms'  => nil,
-    }
-      
-    # Flags
-    @@flags = {
-      :'no-allow-other'     => false,
-      :'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)
-      @app.call(env)
-      @env = env
-      
-      bind_folders if !binded_folders.empty? and bindfs_supported?
-    end
-
-    def binded_folders
-      @env[:vm].config.bindfs.binded_folders
-    end
-
-    def default_options
-      @@options.merge(@@flags).merge(@env[:vm].config.bindfs.default_options)
-    end
-    
-    def bindfs_supported?
-      @env[:vm].channel.execute("bindfs --help", :error_class => Error, :error_key => :not_installed)
-    end
-    
-    def normalize_options opts
-      
-      path     = opts.delete(:path)
-      bindpath = opts.delete(:bindpath)
-      opts     = default_options.merge(opts)
-
-      args = []
-      opts.each do |key, value|
-        args << "--#{key.to_s}" if @@flags.key?(key) and !!value 
-        args << "--#{key.to_s}=#{value}" if @@options.key?(key) and !value.nil?
-      end
-      
-      [ path, bindpath, " #{args.join(" ")}" ]
-    end
-
-    def bind_folders
-      @env[:ui].info I18n.t("vagrant.guest.linux.bindfs.status.binding")
-      binded_folders.each do |opts|
-        path, bindpath, args = normalize_options opts
-        
-        @env[:vm].channel.sudo("mkdir -p #{bindpath}")
-        @env[:vm].channel.sudo("sudo bindfs#{args} #{path} #{bindpath}", :error_class => Error, :error_key => :bindfs_command_fail)
-        @env[:ui].info I18n.t("vagrant.guest.linux.bindfs.status.binding_entry", :path => path, :bindpath => bindpath)
-        
-      end
-    end
-    
-  end
-end

data/lib/vagrant_init.rb

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