vagrant-gatling-rsync 0.0.3 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 874e00d6caf6487664c49d27f97208fcea7f015c
-  data.tar.gz: 26c34bedc9e1936f71a22dcd9950c175e5d3ac54
+SHA256:
+  metadata.gz: 5368b19e16b2b8df288dc7642548fe58edb2fc87e1a2271dc18cfeaec73d8c87
+  data.tar.gz: b127ae31cc1008cc08d7dd4a0b11389eb6868eadd9698b0b042cb7fdc4be9168
 SHA512:
-  metadata.gz: 9f57f6c8a0c5d559302a44afa669995e821212f1842dd2d550531bd34d92eb670f35e4c3c5828a19ee3c3cfbcd5f2fc3aeeeb44c64e862e36edcc34b585c7249
-  data.tar.gz: cf8b9867b09ef3de6eb8b0b32be938a56e2b59b2fa6f6e36e81b45de12885fe23ca48cfe44275108a9105282d9b28c1f9a69a5654216095ae5fa87369e75de12
+  metadata.gz: 45078bf2419e1a16b43a36e8ca3390a783d3883ce59d24c014d9a04b5b30447bf3ae5b06a8c9c0f7ae509346da555b6ace9319bb174c3d21a8e72be4148bb047
+  data.tar.gz: 9fa69af2debff371a39a7eca2a9c47925ea42b1cf09349548cdb828ca99eff6f23d043e08cccfcb358411be74074e1a404d6a3dcd4faba09e30631931d00f6ec

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p353
+2.6.2

data/CHANGELOG.md

@@ -1,3 +1,53 @@
+## 1.0 (June 02, 2020)
+
+This release adds compatibility with Vagrant 2.2.5+.
+
+Small parts of the example Vagrantfile and the Gemfile and Gemspec have also been cleaned up.
+
+FEATURES:
+
+- Add compatibility with Vagrant 2.2.5+. Thanks to @leejo for the PR. [GH-37]
+
+## 0.9.0 (June 28, 2015)
+
+This release adds two big features: Windows support and automatic sync on startup.
+
+It also adds the `config.gatling.rsync_on_startup` configuration option to turn automatic rsync on startup off if you
+do not want it.
+
+It also updates the Gemfile to use Vagrant 1.7.2 for development. The gem should still work with Vagrant 1.5.1+.
+
+FEATURES:
+
+- Add support for Windows. Thanks to @mfradcourt for wiring it up. [GH-21]
+- Add automatic sync startup on `vagrant up` or `vagrant reload` if rsync folders are present. [GH-14]
+
+## 0.1.0 (January 04, 2015)
+
+This release adds feature parity with Vagrant core rsync-auto by doing a sync when gatling-rsync is started.
+
+FEATURES:
+
+- Perform an initial rsync when the watcher starts. [GH-13]
+
+## 0.0.4 (August 24, 2014)
+
+This release adds notification of time and duration of rsyncs.
+
+It also adds the `config.gatling.time_format` configuration option to allow customization of the time format string when
+time information is printed to the console.
+
+It also updates the Gemfile to use Vagrant 1.6.4 so that I can test on Linux using the Docker provider. This should not
+have any impact on using the gem with 1.5.1+ versions of Vagrant, however.
+
+FEATURES:
+
+- Add output to note when an rsync finishes and how long it took. [GH-7, GH-10]
+
+BUG FIXES:
+
+- The plugin now correctly outputs an error instead of failing to load on Vagrant versions < 1.5.1. [GH-11]
+
 ## 0.0.3 (May 02, 2014)
 
 Bugfix release.

data/Gemfile

@@ -4,10 +4,10 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem "vagrant", :git => "https://github.com/mitchellh/vagrant.git", :tag => 'v1.5.1'
+  gem "vagrant", :git => "https://github.com/mitchellh/vagrant.git", :tag => 'v2.2.9'
 end
 
 group :plugins do
-  gem "vagrant-gatling-rsync", path: "."
+  gemspec
 end
 

data/README.md

@@ -5,8 +5,8 @@ potential cost of more rsync actions.
 
 ## Getting started
 
-To get started, you need to have Vagrant 1.5.1 installed on your Linux or
-Mac OS X host machine. To install the plugin, use the following command.
+To get started, you need to have Vagrant 1.5.1 installed on your Linux, Mac, or
+Windows host machine. To install the plugin, use the following command.
 
 ```bash
 vagrant plugin install vagrant-gatling-rsync
@@ -17,6 +17,11 @@ vagrant plugin install vagrant-gatling-rsync
 Add the following information to the Vagrantfile to set the coalescing
 threshold in seconds. If you do not set it, it will default to 1.5.
 
+You may also specify what
+[Time.strftime](http://www.ruby-doc.org/core-2.0.0/Time.html#method-i-strftime)
+options the plugin will use when it reports on completed rsyncs. The default is
+"%I:%M:%S %p".
+
 You will also need to have at least one synced folder set to type "rsync"
 to use the plugin.
 
@@ -32,7 +37,11 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   # Configure the window for gatling to coalesce writes.
   if Vagrant.has_plugin?("vagrant-gatling-rsync")
     config.gatling.latency = 2.5
+    config.gatling.time_format = "%H:%M:%S"
   end
+
+  # Automatically sync when machines with rsync folders come up.
+  config.gatling.rsync_on_startup = true
 end
 ```
 
@@ -43,6 +52,11 @@ command to sync files.
 vagrant gatling-rsync-auto
 ```
 
+As of version 0.9.0, vagrant-gatling-rsync will automatically start the sync
+engine on `vagrant up` or `vagrant reload` when the machines that you bring up
+have one or more rsync folders defined.  You can disable this behavior by
+setting `config.gatling.rsync_on_startup` to false.
+
 ## Why "gatling"?
 
 The gatling gun was the first gun capable of firing continuously.

data/example/vagrant/Vagrantfile

@@ -5,17 +5,42 @@
 VAGRANTFILE_API_VERSION = "2"
 
 Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-  config.vm.box = "hashicorp/precise64"
+  config.vm.box = "centos/7"
 
-  # Share an additional folder to the guest VM. The first argument is
-  # the path on the host to the actual folder. The second argument is
-  # the path on the guest to mount the folder. And the optional third
-  # argument is a set of non-required options.
-  config.vm.synced_folder "../files", "/opt/vagrant/rsynced_folder", type: "rsync",
-    rsync__exclude: [".git/", ".idea/"]
+  config.vm.provider "docker" do |d, override|
+    d.image = "smerrill/vagrant-centos"
+    d.has_ssh = true
+
+    # This is needed if you have non-Docker provisioners in the Vagrantfile.
+    override.vm.box = nil
+  end
+
+  config.vm.provider "lxc" do |d, override|
+    override.vm.box = "smerrill/centos-7"
+  end
+
+  # When using gatling rsync in your projects, you should wrap these configs in
+  # an 'if Vagrant.has_plugin?("vagrant-gatling-rsync")' test.
 
   # Configure the window for gatling to coalesce writes.
-  if Vagrant.has_plugin?("vagrant-gatling-rsync")
-    config.gatling.latency = 2.5
+  config.gatling.latency = 0.4
+  config.gatling.time_format = "%H:%M:%S"
+
+  # Gatling rsync will run `vagrant gatling-rsync-auto` after the machines in
+  # your Vagrant environment start unles you set this to false.
+  config.gatling.rsync_on_startup = true
+
+  # Add a multi-box setup.
+  config.vm.define "rsync", primary: true do |m|
+    m.vm.synced_folder "../files", "/opt/vagrant/rsynced_folder", type: "rsync",
+      rsync__exclude: [".git/", ".idea/"]
+  end
+
+  config.vm.define "rsync2", primary: true do |m|
+    m.vm.synced_folder "../files", "/opt/vagrant/rsynced_folder", type: "rsync",
+      rsync__exclude: [".git/", ".idea/"]
+  end
+
+  config.vm.define "norsync" do |m|
   end
 end

data/lib/vagrant-gatling-rsync.rb

@@ -1,5 +1,5 @@
 # This file is required because Vagrant's plugin system expects
-# a eponymous ruby file matching the rubygem.
+# an eponymous ruby file matching the rubygem.
 #
 # So this gem is called 'vagrant-gatling-rsync' and thus vagrant tries
 # to require "vagrant-gatling-rsync"
@@ -14,6 +14,7 @@ module VagrantPlugins
     autoload :Errors, lib_path.join("errors")
     autoload :ListenOSX, lib_path.join("listen/listenosx")
     autoload :ListenLinux, lib_path.join("listen/listenlinux")
+    autoload :ListenWindows, lib_path.join("listen/listenwindows")
 
     # This returns the path to the source of this plugin.
     #

data/lib/vagrant-gatling-rsync/action/startup_rsync.rb

@@ -0,0 +1,48 @@
+require "vagrant"
+
+module VagrantPlugins
+  module GatlingRsync
+    class StartupRsync
+      include Vagrant::Action::Builtin::MixinSyncedFolders
+
+      def initialize(app, env)
+        @app = app
+        @gatling_startup_registered = false
+        @rsync_folder_count = 0
+      end
+
+      def call(env)
+        folders = synced_folders(env[:machine])
+        @rsync_folder_count += folders[:rsync].size if folders.key?(:rsync)
+
+        @app.call(env)
+
+        # Ensure only one at_exit block is registered.
+        return unless @gatling_startup_registered == false
+
+        return unless env[:machine].config.gatling.rsync_on_startup == true
+
+        at_exit do
+          unless $!.is_a?(SystemExit)
+            env[:ui].warn "Vagrant's startup was interrupted by an exception."
+            exit 1
+          end
+
+          exit_status = $!.status
+          if exit_status != 0
+            env[:ui].warn "The previous process exited with exit code #{exit_status}."
+            exit exit_status
+          end
+
+          # Don't run if there are no rsynced folders.
+          unless @rsync_folder_count == 0 then
+            env[:ui].info I18n.t("vagrant_gatling_rsync.startup_sync")
+            env[:machine].env.cli("gatling-rsync-auto")
+          end
+        end
+
+        @gatling_startup_registered = true
+      end
+    end
+  end
+end

data/lib/vagrant-gatling-rsync/command/rsync_auto.rb

@@ -6,6 +6,12 @@ require "vagrant"
 module VagrantPlugins
   module GatlingRsync
     class GatlingRsyncAuto < Vagrant.plugin(2, :command)
+      # This is a sanity check to make sure no one is attempting to install
+      # this into an early Vagrant version.
+      if Vagrant::VERSION < "1.5.1"
+        raise Errors::Vagrant15RequiredError
+      end
+
       include Vagrant::Action::Builtin::MixinSyncedFolders
 
       def self.synopsis
@@ -35,6 +41,16 @@ module VagrantPlugins
           folders = synced_folders(machine)[:rsync]
           next if !folders || folders.empty?
 
+          # Get the SSH info for this machine so we can do an initial
+          # sync to the VM, just as core `vagrant rsync-auto` does.
+          ssh_info = machine.ssh_info
+          if ssh_info
+            machine.ui.info(I18n.t("vagrant.rsync_auto_initial"))
+            folders.each do |id, folder_opts|
+              VagrantPlugins::SyncedFolderRSync::RsyncHelper.rsync_single(machine, ssh_info, folder_opts)
+            end
+          end
+
           folders.each do |id, folder_opts|
             # If we marked this folder to not auto sync, then
             # don't do it.
@@ -51,7 +67,11 @@ module VagrantPlugins
 
             if folder_opts[:exclude]
               Array(folder_opts[:exclude]).each do |pattern|
-                ignores << VagrantPlugins::SyncedFolderRSync::RsyncHelper.exclude_to_regexp(hostpath, pattern.to_s)
+               if Vagrant::VERSION < "2.2.5"
+                 ignores << VagrantPlugins::SyncedFolderRSync::RsyncHelper.exclude_to_regexp(hostpath, pattern.to_s)
+               else
+                 ignores << VagrantPlugins::SyncedFolderRSync::RsyncHelper.exclude_to_regexp(pattern.to_s)
+                end
               end
             end
           end
@@ -78,9 +98,11 @@ module VagrantPlugins
           ListenOSX.new(paths, ignores, latency, @logger, self.method(:callback)).run
         when /linux/
           ListenLinux.new(paths, ignores, latency, @logger, self.method(:callback)).run
+        when /cygwin|mswin|mingw|bccwin|wince|emx/
+          ListenWindows.new(paths, ignores, latency, @logger, self.method(:callback)).run
         else
           # @TODO: Raise this earlier?
-          raise Errors::OnlyOSXLinuxSupportError
+          raise Errors::OSNotSupportedError
         end
 
         0
@@ -121,12 +143,20 @@ module VagrantPlugins
         tosync.each do |folders|
           folders.each do |opts|
             ssh_info = opts[:machine].ssh_info
-            if ssh_info
-              VagrantPlugins::SyncedFolderRSync::RsyncHelper.rsync_single(opts[:machine], ssh_info, opts[:opts])
-            end
+            do_rsync(opts[:machine], ssh_info, opts[:opts]) if ssh_info
           end
         end
       end
+
+      def do_rsync(machine, ssh_info, opts)
+        start_time = Time.new
+        VagrantPlugins::SyncedFolderRSync::RsyncHelper.rsync_single(machine, ssh_info, opts)
+        end_time = Time.new
+        machine.ui.info(I18n.t(
+          "vagrant_gatling_rsync.gatling_ran",
+          date: end_time.strftime(machine.config.gatling.time_format),
+          milliseconds: (end_time - start_time) * 1000))
+      end
     end
   end
 end

data/lib/vagrant-gatling-rsync/config.rb

@@ -2,15 +2,25 @@ require "vagrant"
 
 module VagrantPlugins
   module GatlingRsync
-    class Config < Vagrant.plugin("2", :config)
+    class Config < Vagrant.plugin(2, :config)
       attr_accessor :latency
+      attr_accessor :time_format
+      attr_accessor :rsync_on_startup
 
       def initialize
         @latency = UNSET_VALUE
+        @time_format = UNSET_VALUE
+        @rsync_on_startup = UNSET_VALUE
       end
 
       def finalize!
         @latency = 1.5 if @latency == UNSET_VALUE
+        @time_format = "%I:%M:%S %p" if @time_format == UNSET_VALUE
+        if @rsync_on_startup == UNSET_VALUE
+          @rsync_on_startup = true
+        else
+          @rsync_on_startup = !!@rsync_on_startup
+        end
       end
 
       # @TODO: This does not appear to be called.

data/lib/vagrant-gatling-rsync/errors.rb

@@ -7,8 +7,8 @@ module VagrantPlugins
         error_namespace("vagrant_gatling_rsync.errors")
       end
 
-      class OnlyOSXLinuxSupportError < VagrantGatlingRsyncError
-        error_key(:only_osx_linux_support)
+      class OSNotSupportedError < VagrantGatlingRsyncError
+        error_key(:os_not_supported)
       end
 
       class Vagrant15RequiredError < VagrantGatlingRsyncError

data/lib/vagrant-gatling-rsync/listen/listenwindows.rb

@@ -18,7 +18,7 @@ module VagrantPlugins
         monitor = WDM::Monitor.new
         changes = Queue.new
         @paths.keys.each do |path|
-          monitor.watch_recursively(path) { |change| changes << change }
+          monitor.watch_recursively(path.dup) { |change| changes << change }
         end
         Thread.new { monitor.run! }
 

data/lib/vagrant-gatling-rsync/plugin.rb

@@ -4,15 +4,9 @@ rescue LoadError
   raise "The Vagrant gatling rsync plugin must be run within Vagrant."
 end
 
-# This is a sanity check to make sure no one is attempting to install
-# this into an early Vagrant version.
-if Vagrant::VERSION < "1.5.1"
-  raise Errors::Vagrant15RequiredError
-end
-
 module VagrantPlugins
   module GatlingRsync
-    class Plugin < Vagrant.plugin("2")
+    class Plugin < Vagrant.plugin(2)
       name "Gatling Rsync"
       description <<-DESC
       Rsync large project directories to your Vagrant VM without using many resources on the host.
@@ -24,6 +18,12 @@ module VagrantPlugins
         I18n.reload!
       end
 
+      action_hook "startup-rsync" do |hook|
+        setup_i18n
+        require_relative "action/startup_rsync"
+        hook.after Vagrant::Action::Builtin::SyncedFolders, StartupRsync
+      end
+
       command "gatling-rsync-auto" do
         setup_i18n
 

data/lib/vagrant-gatling-rsync/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module GatlingRsync
-    VERSION = "0.0.3"
+    VERSION = "1.0"
   end
 end

data/locales/en.yml

@@ -1,8 +1,12 @@
 en:
   vagrant_gatling_rsync:
+    gatling_ran: |-
+      %{date}: The rsync operation completed in %{milliseconds} milliseconds.
+    startup_sync: |-
+      vagrant-gatling-rsync is starting the sync engine because you have at least one rsync folder. To disable this behavior, set `config.gatling.rsync_on_startup = false` in your Vagrantfile.
     errors:
-      only_osx_linux_support: |-
-        This plugin currently only supports Max OS X and Linux hosts.
+      os_not_supported: |-
+        The vagrant-gatling-rsync plugin does not support your OS.
       vagrant_15_required: |-
-        This plugin requires Vagrant 1.5.1 or newer to function.
+        The vagrant-gatling-rsync plugin requires Vagrant 1.5.1 or newer to function.
 

data/vagrant-gatling-rsync.gemspec

@@ -13,13 +13,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = ""
   spec.license       = "MIT"
 
-  # @TODO: Remove example files from the built gem.
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.start_with?('example/files')}
   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.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
 end

metadata

@@ -1,55 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-gatling-rsync
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: '1.0'
 platform: ruby
 authors:
 - Steven Merrill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
 - !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'
 - !ruby/object:Gem::Dependency
   name: pry
   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: The gatling-rsync plugin runs on Mac and Linux and is far less CPU-intensive
@@ -60,16 +46,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
+- ".gitignore"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- example/files/.gitkeep
 - example/vagrant/Vagrantfile
 - lib/vagrant-gatling-rsync.rb
+- lib/vagrant-gatling-rsync/action/startup_rsync.rb
 - lib/vagrant-gatling-rsync/command/rsync_auto.rb
 - lib/vagrant-gatling-rsync/config.rb
 - lib/vagrant-gatling-rsync/errors.rb
@@ -90,17 +76,16 @@ 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.0.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A lighter-weight Vagrant plugin for watching and rsyncing directories.