vagrant-syncer 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cd47298b3567673c6995d30964b20fa04a75ec5
-  data.tar.gz: 8e90c5516f9fae57e14075c575026207861fc3da
+  metadata.gz: 4606a84f0d691da9082851967ad17811c7cf46f8
+  data.tar.gz: 36204705489f9ebf80e7e61926a6d1a15b0ec964
 SHA512:
-  metadata.gz: f9751e15a8daa2674c6c2a52332fafcd59aa1241d6291ffe76536aba6def684a01a7ae763dbfb270a64ff5f0140223c3459028cef0b93a5bda4f7f831ad700fd
-  data.tar.gz: 4778d39d2bbb111510d3470ee6f76619223a4a40dc5d26035f07e245e9cbe7ad9dbbe550d5290ead1817f1f81cb36e247a219413b7c6e27a992e774657cc3573
+  metadata.gz: 2e8a4c2988e646cac0f1ad234874dd8114db70e739cd0ed27b4e304bdb4ebf3f24ab079a5074538bd551e44375838908df862c3774b2d3b8351526567fcba14d
+  data.tar.gz: 355ecbaa298e57d31c0654a08e6448c436d817af15c657d9c7b48c6ce121a183a8c70d4b89ea62e780c1950111b8c0c59c29666139935a3eb11efa97286781b2

data/README.md

@@ -5,8 +5,8 @@ A Vagrant synced folder plugin that is an optimized implementation of [Vagrant r
 Vagrant syncer forks [Vagrant's RsyncHelper](https://github.com/mitchellh/vagrant/blob/b721eb62cfbfa93895d0d4cf019436ab6b1df05d/plugins/synced_folders/rsync/helper.rb)
 to make it (c)leaner, instead of using the class like [vagrant-gatling-rsync](https://github.com/smerrill/vagrant-gatling-rsync) does.
 
-If the optimizations seem to work in heavy use, I'll see if (some of) them
-can be merged to Vagrant core and be submitted as pull requests to
+If the optimizations seem to work in heavy use, I'll see if (some of) them can
+be merged to Vagrant core and be submitted as pull requests to
 [the official Vagrant repo](https://github.com/mitchellh/vagrant).
 
 
@@ -21,17 +21,22 @@ All the [rsync synced folder settings](https://docs.vagrantup.com/v2/synced-fold
 are supported. They also have the same default values.
 
 See [the example Vagrantfile](https://github.com/asyrjasalo/vagrant-syncer/blob/master/example/Vagrantfile)
-for additional plugin specific ```config.syncer``` settings and their default values.
+for additional plugin specific ```config.syncer``` settings and their default
+values.
 
 
 ## Usage
 
-    vagrant syncer
+  The plugin replaces the following stock commands:
 
-## Improvements over rsync(-auto)
+    vagrant rsync
+    vagrant rsync-auto
+
+## Improvements over the stock commands
 
 - The plugin has leaner rsync implementation with most of the rsync command
-  argument constructing already handled in the class initializer and not sync-time
+  argument constructing already handled in the class initializer and not
+  sync-time
 - Uses [rb-fsevent](https://github.com/thibaudgg/rb-fsevent) and
   [rb-inotify](https://github.com/nex3/rb-inotify) gems underneath for
   performance on OS X and GNU/Linux respectively, instead of using Listen.
@@ -39,8 +44,8 @@ for additional plugin specific ```config.syncer``` settings and their default va
 - Allow defining additional SSH arguments to rsync in Vagrantfile using
   ```config.syncer.ssh_args```. This can be used for e.g. disabling SSH
   compression to lower CPU overhead.
-- Runs ```vagrant syncer``` to start watching changes after vagrant up, reload
-  and resume, if ```config.syncer.run_on_startup``` set to ```true```
+- Runs ```vagrant rsync-auto``` to start watching changes after vagrant up,
+  reload and resume, if ```config.syncer.run_on_startup``` set to ```true```
   in Vagrantfile
 - Vagrant's implementation assumes that the primary group of the SSH user
   has the same name as the user, if rsync option ```group``` is not explicitly
@@ -60,12 +65,12 @@ Fork this repository, clone it and install Ruby 2.2.3, using e.g. [rbenv](https:
 
 Then use it with:
 
-    bundle exec vagrant syncer
+    bundle exec vagrant rsync-auto
 
 Or outside the bundle:
 
     ./build_and_install.sh
-    vagrant syncer
+    vagrant rsync-auto
 
 I'll kindly take pull requests as well.
 

data/lib/syncer/actions.rb

@@ -12,9 +12,9 @@ module Vagrant
 
           return  unless env[:machine].config.syncer.run_on_startup
 
-          # If Vagrant up/reload/resume exited successfully, run this syncer
+          # If Vagrant up/reload/resume exited successfully, run this rsync-auto
           at_exit do
-            env[:machine].env.cli("syncer")  if $!.status == 0
+            env[:machine].env.cli("rsync-auto")  if $!.status == 0
           end
         end
       end

data/lib/syncer/command/rsync.rb

@@ -0,0 +1,61 @@
+require 'optparse'
+
+require "vagrant/action/builtin/mixin_synced_folders"
+
+
+module Vagrant
+  module Syncer
+    module Command
+      class Rsync < Vagrant.plugin(2, :command)
+
+        include Vagrant::Action::Builtin::MixinSyncedFolders
+
+        def self.synopsis
+          "syncs rsync synced folders to remote machine"
+        end
+
+        def execute
+          opts = OptionParser.new do |o|
+            o.banner = "Usage: vagrant rsync [vm-name]"
+            o.separator ""
+            o.separator "This command forces any synced folders with type 'rsync' to sync."
+            o.separator "RSync is not an automatic sync so a manual command is used."
+            o.separator ""
+            o.separator "Options:"
+            o.separator ""
+          end
+
+          # Parse the options and return if we don't have any target.
+          argv = parse_options(opts)
+          return if !argv
+
+          # Go through each machine and perform the rsync
+          error = false
+          with_target_vms(argv) do |machine|
+            if machine.provider.capability?(:proxy_machine)
+              proxy = machine.provider.capability(:proxy_machine)
+              if proxy
+                machine.ui.warn(I18n.t(
+                  "vagrant.rsync_proxy_machine",
+                  name: machine.name.to_s,
+                  provider: machine.provider_name.to_s))
+
+                machine = proxy
+              end
+            end
+
+            if !machine.communicate.ready?
+              machine.ui.error(I18n.t("vagrant.rsync_communicator_not_ready"))
+              error = true
+              next
+            end
+
+            Machine.new(machine).full_sync
+          end
+
+          return error ? 1 : 0
+        end
+      end
+    end
+  end
+end

data/lib/syncer/command/rsync_auto.rb

@@ -0,0 +1,62 @@
+require "log4r"
+require 'optparse'
+
+require "vagrant/action/builtin/mixin_synced_folders"
+require "vagrant/util/platform"
+
+
+# This is to avoid a bug in nio 1.0.0. Remove around nio 1.0.1
+ENV["NIO4R_PURE"] = "1"  if Vagrant::Util::Platform.windows?
+
+module Vagrant
+  module Syncer
+    module Command
+      class RsyncAuto < Vagrant.plugin("2", :command)
+        include Vagrant::Action::Builtin::MixinSyncedFolders
+
+        def self.synopsis
+          "syncs rsync synced folders automatically when files change"
+        end
+
+        def execute
+          @logger = Log4r::Logger.new("vagrant::commands::rsync-auto")
+
+          options = {}
+          opts = OptionParser.new do |o|
+            o.banner = "Usage: vagrant rsync-auto [vm-name]"
+            o.separator ""
+            o.separator "Options:"
+            o.separator ""
+
+            o.on("--[no-]poll", "Force polling filesystem (slow)") do |poll|
+              options[:poll] = poll
+            end
+          end
+
+          # Parse the options and return if we don't have any target.
+          argv = parse_options(opts)
+          return if !argv
+
+          # Build up the paths that we need to listen to.
+          with_target_vms(argv) do |machine|
+            if machine.provider.capability?(:proxy_machine)
+              proxy = machine.provider.capability(:proxy_machine)
+              if proxy
+                machine.ui.warn(I18n.t(
+                  "vagrant.rsync_proxy_machine",
+                  name: machine.name.to_s,
+                  provider: machine.provider_name.to_s))
+
+                machine = proxy
+              end
+            end
+
+            machine = Machine.new(machine, options[:poll])
+            machine.full_sync
+            machine.listen
+          end
+        end
+      end
+    end
+  end
+end

data/lib/syncer/machine.rb

@@ -6,14 +6,19 @@ module Vagrant
 
       include Vagrant::Action::Builtin::MixinSyncedFolders
 
-      def initialize(machine)
+      def initialize(machine, polling=false)
         @paths = []
 
-        synced_folders = synced_folders(machine)[:rsync]
-        return  unless synced_folders
+        cached = synced_folders(machine, cached: true)
+        fresh  = synced_folders(machine)
+        diff   = synced_folders_diff(cached, fresh)
+        if !diff[:added].empty?
+          machine.ui.warn(I18n.t("vagrant.rsync_auto_new_folders"))
+        end
 
-        synced_folders.each do |id, folder_opts|
-          @paths << Path.new(folder_opts, machine)
+        folders = cached[:rsync]
+        folders.each do |id, folder_opts|
+          @paths << Path.new(folder_opts, machine, polling)
         end
       end
 
@@ -27,4 +32,4 @@ module Vagrant
 
     end
   end
-end
+end

data/lib/syncer/path.rb

@@ -6,33 +6,40 @@ module Vagrant
   module Syncer
     class Path
 
-      def initialize(path_opts, machine)
+      def initialize(path_opts, machine, listener_polling=false)
         @logger = machine.ui
         @source_path = path_opts[:hostpath]
         @syncer = Syncers::Rsync.new(path_opts, machine)
         @absolute_path = File.expand_path(@source_path, machine.env.root_path)
 
+        @listener_polling = listener_polling
         @listener_verbose = machine.config.syncer.show_events
         @listener_interval = machine.config.syncer.interval
 
-        case Vagrant::Util::Platform.platform
-        when /darwin/
-          require_relative 'listeners/fsevents'
-          @listener_class = Vagrant::Syncer::Listeners::FSEvents
-        when /linux/
-          require_relative 'listeners/inotify'
-          @listener_class = Vagrant::Syncer::Listeners::INotify
-        else
+        listener_settings = {
+          latency: @listener_interval
+        }
+
+        if @listener_polling
           require_relative 'listeners/listen'
           @listener_class = Vagrant::Syncer::Listeners::Listen
+          listener_settings[:force_polling] = @listener_polling
+        else
+          case Vagrant::Util::Platform.platform
+          when /darwin/
+            require_relative 'listeners/fsevents'
+            @listener_class = Vagrant::Syncer::Listeners::FSEvents
+          when /linux/
+            require_relative 'listeners/inotify'
+            @listener_class = Vagrant::Syncer::Listeners::INotify
+          else
+            require_relative 'listeners/listen'
+            @listener_class = Vagrant::Syncer::Listeners::Listen
+          end
         end
 
         @listener_name = @listener_class.to_s.gsub(/^.*::/, '')
 
-        listener_settings = {
-          latency: @listener_interval
-        }
-
         @listener = @listener_class.new(
           @absolute_path,
           path_opts[:rsync__excludes],
@@ -47,7 +54,8 @@ module Vagrant
       end
 
       def listen
-        @logger.info(I18n.t('syncer.states.watching', {
+        text = @listener_polling ? 'syncer.states.polling' : 'syncer.states.watching'
+        @logger.info(I18n.t(text, {
           path: @absolute_path,
           listener: @listener_name,
           interval: @listener_interval
@@ -68,4 +76,4 @@ module Vagrant
 
     end
   end
-end
+end

data/lib/syncer/plugin.rb

@@ -13,9 +13,19 @@ module Vagrant
         Vagrant::Syncer::Config
       end
 
-      command "syncer" do
-        require 'syncer/commands/syncer'
-        Vagrant::Syncer::Commands::Syncer
+      command("rsync", primary: false) do
+        require_relative "command/rsync"
+        Vagrant::Syncer::Command::Rsync
+      end
+
+      command("rsync-auto", primary: false) do
+        require_relative "command/rsync_auto"
+        Vagrant::Syncer::Command::RsyncAuto
+      end
+
+      synced_folder("rsync", 5) do
+        require_relative "synced_folder"
+        SyncedFolder
       end
 
       ["machine_action_up", "machine_action_reload", "machine_action_resume"].each do |action|

data/lib/syncer/synced_folder.rb

@@ -0,0 +1,48 @@
+require "log4r"
+
+require "vagrant/util/which"
+
+module Vagrant
+  module Syncer
+    class SyncedFolder < Vagrant.plugin("2", :synced_folder)
+      include Vagrant::Util
+
+      def initialize(*args)
+        super
+
+        @logger = Log4r::Logger.new("vagrant::synced_folders::rsync")
+      end
+
+      def usable?(machine, raise_error=false)
+        rsync_path = Which.which("rsync")
+        return true if rsync_path
+        return false if !raise_error
+        raise Vagrant::Errors::RSyncNotFound
+      end
+
+      def prepare(machine, folders, opts)
+        # Nothing is necessary to do before VM boot.
+      end
+
+      def enable(machine, folders, opts)
+        if machine.guest.capability?(:rsync_installed)
+          installed = machine.guest.capability(:rsync_installed)
+          if !installed
+            can_install = machine.guest.capability?(:rsync_install)
+            raise Vagrant::Errors::RSyncNotInstalledInGuest if !can_install
+            machine.ui.info I18n.t("vagrant.rsync_installing")
+            machine.guest.capability(:rsync_install)
+          end
+        end
+
+        ssh_info = machine.ssh_info
+
+        if ssh_info[:private_key_path].empty? && ssh_info[:password]
+          machine.ui.warn(I18n.t("vagrant.rsync_ssh_password"))
+        end
+
+        Machine.new(machine).full_sync
+      end
+    end
+  end
+end

data/lib/syncer/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Syncer
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

data/locales/en.yml

@@ -1,8 +1,9 @@
 en:
   syncer:
     states:
-      initial: "Syncing %{path} to get the target up to date."
-      watching: "Watching %{path} for changes (via %{listener}) every %{interval} seconds."
+      initial: "Rsyncing %{path}"
+      watching: "Watching %{path} (using %{listener}) every %{interval} seconds."
+      polling: "Polling %{path} (using %{listener}) every %{interval} seconds."
     rsync:
       failed: "Rsync failed: %{error}"
       failed_command: "The failed command was: %{command}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-syncer
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Anssi Syrjäsalo
@@ -73,7 +73,8 @@ files:
 - example/files/file.not
 - example/files/yes.txt
 - lib/syncer/actions.rb
-- lib/syncer/commands/syncer.rb
+- lib/syncer/command/rsync.rb
+- lib/syncer/command/rsync_auto.rb
 - lib/syncer/config.rb
 - lib/syncer/listeners/fsevents.rb
 - lib/syncer/listeners/inotify.rb
@@ -81,6 +82,7 @@ files:
 - lib/syncer/machine.rb
 - lib/syncer/path.rb
 - lib/syncer/plugin.rb
+- lib/syncer/synced_folder.rb
 - lib/syncer/syncers/rsync.rb
 - lib/syncer/version.rb
 - lib/vagrant-syncer.rb

data/lib/syncer/commands/syncer.rb

@@ -1,22 +0,0 @@
-module Vagrant
-  module Syncer
-    module Commands
-      class Syncer < Vagrant.plugin(2, :command)
-
-        def self.synopsis
-          "start auto-rsyncing"
-        end
-
-        def execute
-          with_target_vms do |machine|
-            machine = Machine.new(machine)
-            machine.full_sync
-            machine.listen
-          end
-          0
-        end
-
-      end
-    end
-  end
-end