vagrant-bindfs 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e5ede475244f757129e5549bd4efa08da086515
-  data.tar.gz: f1fc218651127f7ade08604adaac9ebb4200e762
+  metadata.gz: 1019eb9a428aedf0d85c9d6298008cfae8b22b7d
+  data.tar.gz: 114ec7c1d5200eb16beeac32f06df2e23a976bb4
 SHA512:
-  metadata.gz: 53435c06bc292ad42a6d8803ee0d576b376f5141a41e570c74b644ce2e8bd8fad95be68bfb0fe761582fd8a9474fee97f6b4bd5a37f1befbbf87d5b301e96c01
-  data.tar.gz: 122c7a0fb83f8a088b84eb24a1af6a8d394c130b84a5f08b7e8890fe1d1877652ab0cd273056441b453b5e86d0309d514564b6de1efc0dad23f7b635bcc83c3a
+  metadata.gz: f840aae90268594fe341b7e05e320234bd178aae9c7102e6c23d1efde6413040afc075060038ec07d5e7c3c9eb6282e02cd0ab7f72e63dc23f904965da4c2a07
+  data.tar.gz: 59daf2c4aa63b1e91b5dbb57ad6adcc3e66423dac1631f68e353e28ee5dbde7566fe52865e350fd379f5e510873585047037d341a2fdf51560ffcfcf18855f8a

data/README.md

@@ -28,14 +28,14 @@ _Note that `map_uid` and `map_gid` NFS options can be used to set the identity u
 
 ## Installation
 
-Vagrant-bindfs is distributed as a Ruby gem. You can install it as any other Vagrant plugin
-with `vagrant plugin 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`.
 
 
 ## Usage
 
-In your `Vagrantfile`, use `config.bindfs.bind_folder` to configure folders that will be binded on VM
-startup. The format is:
+In your `Vagrantfile`, use `config.bindfs.bind_folder` to configure folders that will be binded on VM startup.
+The format is:
 
 ```ruby
 config.bindfs.bind_folder "/path/to/source", "/path/to/destination", options
@@ -45,25 +45,35 @@ config.bindfs.bind_folder "/path/to/source", "/path/to/destination", options
 ### Example
 
 ```ruby
-Vagrant::Config.run do |config|
-
+Vagrant.configure("2") 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
-
+    perms: "u=rw:g=r:o=r",
+    create_as_user: true
+  
+  
   ## Complete example for a NFS shared folder
-
+  
+  # Static IP is required to use NFS shared folder
+  config.vm.network "private_network", ip: "192.168.50.4"
+  
   # Declare shared folder with Vagrant syntax
-  config.vm.synced_folder ".", "/vagrant-nfs", type: :nfs
-
+  config.vm.synced_folder "host/source/dir", "/vagrant-nfs", :type => :nfs
+  
   # Use vagrant-bindfs to re-mount folder
-  config.bindfs.bind_folder "/vagrant-nfs", "/vagrant"
+  config.bindfs.bind_folder "/vagrant-nfs", "guest/mount/point"
+  
+  
+  ## Share the default `vagrant` folder via NFS with your own options
+  config.vm.synced_folder ".", "/vagrant", type: :nfs
+  config.bindfs.bind_folder "/vagrant", "/vagrant"
 
 end
 ```
@@ -71,83 +81,39 @@ end
 
 ### Supported options
 
-The `bind_folder` config supports the following long arguments, some of them are overwritable
-with short options:
-
-- `:force_user` (defaults to 'vagrant')
-- `:force_group` (defaults to 'vagrant')
-- `:perms` (defaults to 'u=rwX:g=rD:o=rD')
-- `:mirror`
-- `:mirror_only`
-- `:map`
-- `:create_for_user`
-- `:create_for_group`
-- `:create_with_perms`
-- `:chmod_filter`
-- `:read_rate`
-- `:write_rate`
-
-There are also options available for backward compatibility, if one of these options is defined
-the newer counterpart will be unset:
-
-- `:owner`
-- `:group`
-
-The following shortcuts are also available:
-
-- `:o`
-- `:u` (Overwrites the value of force_user)
-- `:g` (Overwrites the value of force_group)
-- `:m` (Overwrites the value of mirror)
-- `:M` (Overwrites the value of mirror_only)
-- `:p` (Overwrites the value of perms)
-
-… and the 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`
-- `:no_allow_other`
-- `:realistic_permissions`
-- `:ctime_from_mtime`
-- `:hide_hard_links`
-- `:multithreaded`
-
-You can overwrite default options _via_ `config.bindfs.default_options`. See
-[bindfs man page](http://bindfs.org/docs/bindfs.1.html) for details.
-
-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 and SUSE systems, it
-will try to install bindfs automatically.
+The `bind_folder` config accept any option you can pass to bindfs.
+vagrant-bindfs is compatible with bindfs from version 1.9 to 1.12.6.
+Check [lib/vagrant-bindfs/command.rb](https://github.com/gael-ian/vagrant-bindfs/blob/master/lib/vagrant-bindfs/command.rb#L66) for a complete list of supported options and default values.
+
+Both long arguments and shorthand are supported.
+If you set both, shorthand will prevail.
+Long arguments can be written indifferently with underscore ('force_user') or dash ('force-user') and as strings (:'force-user') or symbols (:force_user).
+
+You can overwrite default options _via_ `config.bindfs.default_options`.
+See [bindfs man page](http://bindfs.org/docs/bindfs.1.html) for details.
+
+vagrant-bindfs detects installed version of bindfs, translate option names when needed and ignore an option if it is not supported.
+As we may have missed something, it will warn you when a binding command fail.
+
+On Debian and SUSE guest systems, vagrant-bindfs will try to install bindfs automatically if it is not installed.
+On other system, you'll get warned.
 
 
 ## Contributing
 
-If you find this plugin useful, we could use a few enhancements! In particular, capabilities files
-for installing vagrant-bindfs on systems other than Debian or SUSE would be useful. We could also
-use some specs…
+If you find this plugin useful, we could use a few enhancements!
+In particular, capabilities files for installing vagrant-bindfs on systems other than Debian or SUSE would be useful.
+We could also use some specs…
 
 
 ### How to Test Changes
 
-If you've made changes to this plugin, you can easily test it locally in vagrant. From the root of
-the repo, do:
+If you've made changes to this plugin, you can easily test it locally in vagrant.
+From the root of the repo, do:
 
 - `bundle install`
 - `rake build`
 - `bundle exec vagrant up`
 
-This will spin up a default Debian VM and try to bindfs-mount some shares in it. Feel free to modify
-the included `Vagrantfile` to add additional test cases.
+This will spin up a default Debian VM and try to bindfs-mount some shares in it.
+Feel free to modify the included `Vagrantfile` to add additional test cases.

data/lib/vagrant-bindfs/bind.rb

@@ -1,3 +1,5 @@
+require "vagrant-bindfs/command"
+
 module VagrantPlugins
   module Bindfs
     module Action
@@ -23,118 +25,39 @@ module VagrantPlugins
           @machine.config.bindfs.bind_folders
         end
 
-        def default_options
-          current_defaults = @machine.config.bindfs.default_options
-
-          new_defaults = {}.tap do |new_default|
-            current_defaults.each do |key, value|
-              new_default[key.to_s.gsub("_", "-")] = value
-            end
-          end
-
-          available_options.merge(
-            available_shortcuts
-          ).merge(
-            available_flags
-          ).merge(
-            new_defaults
-          )
-        end
-
-        def normalize_options(current_options)
-          new_options = {}.tap do |new_option|
-            current_options.each do |key, value|
-              new_option[key.to_s.gsub("_", "-")] = value
-            end
-          end
-
-          source = new_options.delete("source-path")
-          dest = new_options.delete("dest-path")
-          options = default_options.merge(new_options)
-
-          args = [].tap do |arg|
-            options.each do |key, value|
-              next if key == "force-user" and options.keys.include? "owner"
-              next if key == "force-user" and options.keys.include? "u"
-
-              next if key == "force-group" and options.keys.include? "group"
-              next if key == "force-group" and options.keys.include? "g"
-
-              next if key == "mirror" and options.keys.include? "m"
-              next if key == "mirror-only" and options.keys.include? "M"
-              next if key == "perms" and options.keys.include? "p"
-
-              if available_flags.keys.include? key
-                arg.push "--#{key}" if value
-                next
-              end
-
-              next if value.nil?
-
-              if available_shortcuts.keys.include?(key) or additional_shortcuts.keys.include?(key)
-                arg.push "-#{key} '#{value}'"
-                next
-              end
-
-              if available_options.keys.include?(key) or additional_options.keys.include?(key)
-                arg.push "--#{key}='#{value}'"
-                next
-              end
-            end
-          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, options|
-            source, dest, args = normalize_options(options)
 
-            bind_command = [
-              "bindfs",
-              args,
-              source,
-              dest
-            ].compact
+            command = VagrantPlugins::Bindfs::Command.new(@machine, options)
 
-            unless @machine.communicate.test("test -d #{source}")
+            unless @machine.communicate.test("test -d #{command.source}")
               @env[:ui].error I18n.t(
                 "vagrant.config.bindfs.errors.source_path_not_exist",
-                path: source
+                path: command.source
               )
-
               next
             end
 
-            if @machine.communicate.test("mount | grep bindfs | grep #{dest}")
+            if @machine.communicate.test("mount | grep bindfs | grep #{command.destination}")
               @env[:ui].info I18n.t(
                 "vagrant.config.bindfs.already_mounted",
-                dest: dest
+                dest: command.destination
               )
-
               next
             end
 
             @env[:ui].info I18n.t(
               "vagrant.config.bindfs.status.binding_entry",
-              dest: dest,
-              source: source
+              dest: command.destination,
+              source: command.source
             )
 
             @machine.communicate.tap do |comm|
-              comm.sudo("mkdir -p #{dest}")
-
-              comm.sudo(
-                bind_command.join(" "),
-                error_class: Error,
-                error_key: :binding_failed
-              )
+              comm.sudo("mkdir -p #{command.destination}")
+              comm.sudo(command.build, error_class: Error, error_key: :binding_failed)
+              @env[:ui].info(command.build) if @machine.config.bindfs.debug
             end
           end
         end
@@ -149,72 +72,6 @@ module VagrantPlugins
           end
         end
 
-        def available_options
-          @available_options ||= {
-            "force-user" => "vagrant",
-            "force-group" => "vagrant",
-            "perms" => "u=rwX:g=rD:o=rD",
-            "mirror" => nil,
-            "mirror-only" => nil,
-            "map" => nil,
-            "create-for-user" => nil,
-            "create-for-group" => nil,
-            "create-with-perms" => nil,
-            "chmod-filter" => nil,
-            "read-rate" => nil,
-            "write-rate" => nil
-          }.freeze
-        end
-
-        def additional_options
-          @additional_options ||= {
-            # only for old versions, this will result in an error
-            # if you try that within current bindfs versions!
-            "owner" => "vagrant",
-            "group" => "vagrant"
-          }.freeze
-        end
-
-        def available_shortcuts
-          @available_shortcuts ||= {
-            "o" => nil
-          }.freeze
-        end
-
-        def additional_shortcuts
-          @additional_shortcuts ||= {
-            "u" => nil, # overwrites the value of force-user
-            "g" => nil, # overwrites the value of force-group
-            "m" => nil, # overwrites the value of mirror
-            "M" => nil, # overwrites the value of mirror-only
-            "p" => nil  # overwrites the value of perms
-          }.freeze
-        end
-
-        def available_flags
-          @available_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,
-            "no-allow-other" => false,
-            "realistic-permissions" => false,
-            "ctime-from-mtime" => false,
-            "hide-hard-links" => false,
-            "multithreaded" => false
-          }.freeze
-        end
       end
     end
   end

data/lib/vagrant-bindfs/command.rb

@@ -0,0 +1,161 @@
+module VagrantPlugins
+  module Bindfs
+    class Command
+
+      attr_reader :source
+      attr_reader :destination
+      attr_reader :arguments
+
+      def initialize(machine, options)
+        @machine = machine
+        options  = normalize_keys(options)
+
+        @source       = options.delete("source-path")
+        @destination  = options.delete("dest-path")
+        @arguments    = arguments_for(default_options.merge(options))
+      end
+
+      def build
+        [ "bindfs", arguments.join(" "), source, destination ].compact.join(" ")
+      end
+
+      protected
+
+      def arguments_for(options)
+        available_options.reduce([]) do |args, (name, definition)|
+
+          short = definition[:short].detect{ |k| options.key?(k) }
+          long  = definition[:long].detect{ |k| options.key?(k) }
+          value = case true
+                    when !short.nil? then options[short]
+                    when !long.nil?  then options[long]
+                    else definition[:default]
+                  end
+
+          args << format_argument(name, definition, value) unless value.nil?
+          args
+        end.compact
+      end
+
+      def format_argument(name, definition, value)
+        if definition[:type] == :flag && !!value
+          return "-#{name}" if 0 == definition[:long].size # Shorthand only options
+          return "--#{name}"
+        end
+        if definition[:type] == :option
+          return "-#{name} #{value}" if 0 == definition[:long].size # Shorthand only options
+          return "--#{name}=#{value}"
+        end
+      end
+
+      def normalize_keys(opts)
+        {}.tap do |hash|
+          opts.each do |key, value|
+            hash[key.to_s.gsub("_", "-")] = value
+          end
+        end
+      end
+
+      def default_options
+        @default_options ||= normalize_keys(@machine.config.bindfs.default_options)
+      end
+
+      # TODO: Update after each bindfs release
+      def available_options
+        @available_options || begin
+          options = {
+            # File ownership
+            "force-user"            => { long: ["force-user", "user", "owner"], short: ["u"], type: :option,  default: "vagrant" },
+            "force-group"           => { long: ["force-group", "group"],        short: ["g"], type: :option,  default: "vagrant" },
+            "mirror"                => { long: ["mirror"],                      short: ["m"], type: :option,  default: nil },
+            "mirror-only"           => { long: ["mirror-only"],                 short: ["M"], type: :option,  default: nil },
+            "map"                   => { long: ["map"],                         short: [],    type: :option,  default: nil },
+
+            # Permission bits
+            "perms"                 => { long: ["perms"],                       short: ["p"], type: :option,  default: "u=rwX:g=rD:o=rD" },
+
+            # File creation policy
+            "create-as-user"        => { long: ["create-as-user"],              short: [],    type: :flag,    default: false },
+            "create-as-mounter"     => { long: ["create-as-mounter"],           short: [],    type: :flag,    default: false },
+            "create-for-user"       => { long: ["create-for-user"],             short: [],    type: :option,  default: nil },
+            "create-for-group"      => { long: ["create-for-group"],            short: [],    type: :option,  default: nil },
+            "create-with-perms"     => { long: ["create-with-perms"],           short: [],    type: :option,  default: nil },
+
+            # Chown policy
+            "chown-normal"          => { long: ["chown-normal"],                short: [],    type: :flag,    default: false },
+            "chown-ignore"          => { long: ["chown-ignore"],                short: [],    type: :flag,    default: false },
+            "chown-deny"            => { long: ["chown-deny"],                  short: [],    type: :flag,    default: false },
+
+            # Chgrp policy
+            "chgrp-normal"          => { long: ["chgrp-normal"],                short: [],    type: :flag,    default: false },
+            "chgrp-ignore"          => { long: ["chgrp-ignore"],                short: [],    type: :flag,    default: false },
+            "chgrp-deny"            => { long: ["chgrp-deny"],                  short: [],    type: :flag,    default: false },
+
+            # Chmod policy
+            "chmod-normal"          => { long: ["chmod-normal"],                short: [],    type: :flag,    default: false },
+            "chmod-ignore"          => { long: ["chmod-ignore"],                short: [],    type: :flag,    default: false },
+            "chmod-deny"            => { long: ["chmod-deny"],                  short: [],    type: :flag,    default: false },
+            "chmod-filter"          => { long: ["chmod-filter"],                short: [],    type: :option,  default: nil },
+            "chmod-allow-x"         => { long: ["chmod-allow-x"],               short: [],    type: :flag,    default: false },
+
+            # Extended attribute policy
+            "xattr-none"            => { long: ["xattr-none"],                  short: [],    type: :flag,    default: false },
+            "xattr-ro"              => { long: ["xattr-ro"],                    short: [],    type: :flag,    default: false },
+            "xattr-rw"              => { long: ["xattr-rw"],                    short: [],    type: :flag,    default: false },
+
+            # Rate limits
+            "read-rate"             => { long: ["read-rate"],                   short: [],    type: :option,  default: false },
+            "write-rate"            => { long: ["write-rate"],                  short: [],    type: :option,  default: false },
+
+            # Miscellaneous
+            "no-allow-other"        => { long: ["no-allow-other"],              short: ["n"], type: :flag,    default: false },
+            "realistic-permissions" => { long: ["realistic-permissions"],       short: [],    type: :flag,    default: false },
+            "ctime-from-mtime"      => { long: ["ctime-from-mtime"],            short: [],    type: :flag,    default: false },
+            "hide-hard-links"       => { long: ["hide-hard-links"],             short: [],    type: :flag,    default: false },
+            "multithreaded"         => { long: ["multithreaded"],               short: [],    type: :flag,    default: false },
+
+            # FUSE options
+            "o"                     => { long: [],                              short: ["o"], type: :option,  default: nil },
+            "r"                     => { long: [],                              short: ["r"], type: :flag,    default: false },
+            "d"                     => { long: [],                              short: ["d"], type: :flag,    default: false },
+            "f"                     => { long: [],                              short: ["f"], type: :flag,    default: false },
+          }
+
+          if bindfs_version_lower_than("1.12.6")
+            options.delete("read-rate")
+            options.delete("write-rate")
+          end
+
+          if bindfs_version_lower_than("1.12.2")
+            options.delete("chmod-filter")
+          end
+
+          if bindfs_version_lower_than("1.12")
+            options["user"]  = options.delete("force-user")
+            options["group"] = options.delete("force-group")
+          end
+
+          if bindfs_version_lower_than("1.11")
+            options.delete("multithreaded")
+          end
+
+          if bindfs_version_lower_than("1.10")
+            options.delete("map")
+            options.delete("realistic-permissions")
+            options.delete("hide-hard-links")
+          end
+
+          # Can't track changes deeper as SVN repository was removed from https://code.google.com/p/bindfs/
+
+          options
+        end
+      end
+
+      def bindfs_version_lower_than(version)
+        test_command = %{test "$(echo "%{v} $(sudo bindfs --version | cut -d" " -f2)" | tr " " "\n" | sort -V | tail -n 1)" == "%{v}"}
+        @machine.communicate.test(test_command % { v: version})
+      end
+
+    end
+  end
+end

data/lib/vagrant-bindfs/config.rb

@@ -5,12 +5,12 @@ require 'vagrant/util/template_renderer'
 module VagrantPlugins
   module Bindfs
     class Config < Vagrant.plugin("2", :config)
-      attr_accessor :default_options, :bind_folders
+      attr_accessor :default_options, :debug, :bind_folders
 
       def initialize
         @default_options = UNSET_VALUE
+        @debug = UNSET_VALUE
         @bind_folders = {}
-
         @logger = Log4r::Logger.new('vagrantplugins::bindfs::config')
       end
 
@@ -44,6 +44,7 @@ module VagrantPlugins
 
       def finalize!
         @default_options = {} if @default_options == UNSET_VALUE
+        @debug = false if @debug == UNSET_VALUE
       end
 
       def validate!(machine)

data/lib/vagrant-bindfs/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Bindfs
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-bindfs
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Gaël-Ian Havard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 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
@@ -22,18 +22,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
-- README.md
-- lib/vagrant-bindfs.rb
 - lib/vagrant-bindfs/bind.rb
 - lib/vagrant-bindfs/cap/debian/bindfs_install.rb
 - lib/vagrant-bindfs/cap/linux/bindfs_installed.rb
 - lib/vagrant-bindfs/cap/suse/bindfs_install.rb
+- lib/vagrant-bindfs/command.rb
 - lib/vagrant-bindfs/config.rb
 - lib/vagrant-bindfs/errors.rb
 - lib/vagrant-bindfs/plugin.rb
 - lib/vagrant-bindfs/version.rb
+- lib/vagrant-bindfs.rb
 - locales/en.yml
+- README.md
+- MIT-LICENSE
 homepage: https://github.com/gael-ian/vagrant-bindfs
 licenses:
 - MIT
@@ -44,17 +45,17 @@ 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
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A Vagrant plugin to automate bindfs mount in the VM