vagrant-mirror 0.1.1.alpha → 0.1.2.alpha

data/Gemfile.lock

@@ -14,7 +14,6 @@ GEM
     coderay (1.0.8)
     diff-lcs (1.1.3)
     erubis (2.7.0)
-    ffi (1.2.0)
     ffi (1.2.0-x86-mingw32)
     guard (1.6.1)
       listen (>= 0.6.0)
@@ -33,10 +32,6 @@ GEM
     net-scp (1.0.4)
       net-ssh (>= 1.99.1)
     net-ssh (2.2.2)
-    pry (0.9.10)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.3.1)
     pry (0.9.10-x86-mingw32)
       coderay (~> 1.0.5)
       method_source (~> 0.8)

data/lib/vagrant-mirror/listener/host.rb

@@ -18,12 +18,20 @@ module Vagrant
         # Makes a blocking call to Guard to listen on the configured path
         def listen!
           Listen.to(@path, :relative_paths => true) do | modified, added, removed |
-            @queue << {
-              :source   => :host,
-              :added    => added,
-              :modified => modified,
-              :removed  => removed
-            }
+
+            # Add each reported file to the queue
+            modified.each do | path |
+              @queue << { :event => :modified, :path => path }
+            end
+
+            added.each do | path |
+              @queue << { :event => :added, :path => path }
+            end
+
+            removed.each do | path |
+              @queue << { :event => :removed, :path => path }
+            end
+
           end
         end
 

data/lib/vagrant-mirror/middleware/base.rb

@@ -15,18 +15,21 @@ module Vagrant
           @env = env
         end
 
-        # Executes the middleware and then continues to the next middleware in the
-        # stack
+        # Loads the rest of the middlewares first, then finishes up by running
+        # our middleware. This is required because the core share_folders and
+        # provision middlewares don not mount the shares until the very end of
+        # the process and we need to run after that
         #
         # @param [Vagrant::Action::Environment] The environment
         def call(env)
+          @app.call(env)
+
           mirrors = env[:vm].config.mirror.folders
           if !mirrors.empty?
             execute(mirrors, env)
           else
             env[:ui].info("No vagrant-mirror mirrored folders configured for this box")
           end
-          @app.call(env)
         end
 
         protected

data/lib/vagrant-mirror/middleware/mirror.rb

@@ -8,22 +8,6 @@ module Vagrant
     module Middleware
       class Mirror < Base
 
-        # Loads the rest of the middlewares first, then finishes up by running
-        # the mirror middleware. This allows the listener to start after the
-        # instance has been provisioned.
-        #
-        # @param [Vagrant::Action::Environment] The environment
-        def call(env)
-          @app.call(env)
-
-          mirrors = env[:vm].config.mirror.folders
-          if !mirrors.empty?
-            execute(mirrors, env)
-          else
-            env[:ui].info("No vagrant-mirror mirrored folders configured for this box")
-          end
-        end
-
         protected
 
         # Mirrors the folder pairs configured in the vagrantfile
@@ -31,6 +15,7 @@ module Vagrant
         # @param [Array] The folder pairs to synchronise
         # @param [Vagrant::Action::Environment] The environment
         def execute(mirrors, env)
+
           ui = env[:ui]
           ui.info("Beginning directory mirroring")
 
@@ -55,26 +40,34 @@ module Vagrant
                   if (change[:quit])
                     quit = true
                   else
+                    # Ignore files that match the configured exclude paths
+                    if exclude?(change[:path], mirror_config)
+                      next
+                    end
+
                     # Handle removed files first - guard sometimes flagged as deleted when they aren't
                     # So we first check if the file has been deleted on the host. If so, we delete on
                     # the guest, otherwise we add to the list to rsync in case there are changes
-                    changes = []
-                    change[:removed].each do | relpath |
-                      if (File.exists?(File.join(host_path, relpath)))
-                        changes << relpath
-                      else
-                        target = "#{mirror_config[:guest_path]}/#{relpath}"
+                    if (change[:event] == :removed)
+                      unless File.exists?(File.join(host_path, change[:path]))
+                        # Delete the file on the guest
+                        target = "#{mirror_config[:guest_path]}/#{change[:path]}"
                         ui.warn("XX Deleting #{target}")
                         env[:vm].channel.sudo("rm #{target}")
+
+                        # Beep if configured
+                        if (mirror_config[:beep])
+                          print "\a"
+                        end
+
+                        # Move to the next file
+                        next
                       end
                     end
 
-                    # Add to the list of deletions with each of the modified and added files
-                    changes = changes + change[:added] + change[:modified]
-                    changes.each do | relpath |
-                      ui.info(">> #{relpath}")
-                      rsync.run(relpath)
-                    end
+                    # Otherwise, run rsync on the file
+                    ui.info(">> #{change[:path]}")
+                    rsync.run(change[:path])
 
                     # Beep if configured
                     if (mirror_config[:beep])
@@ -102,6 +95,71 @@ module Vagrant
           ui.success("Completed directory synchronisation")
         end
 
+        # Checks whether a given path should be excluded based on the :exclude config for this mirror
+        #
+        # @param [String] The file path being processed
+        # @param [Hash]   The mirror config options
+        #
+        # @return [Bool]  Whether to exclude this file
+        def exclude?(path, mirror_config)
+          compiled_excludes = mirror_config.fetch(:compiled_excludes, {})
+          excluded = false
+
+          mirror_config[:exclude].each do | exclude |
+            # Check if it has been compiled
+            unless compiled_excludes.has_key? exclude
+              compiled_excludes[exclude] = compile_exclude(exclude)
+            end
+            exclude = compiled_excludes[exclude]
+
+            # Test for a match against the path
+            if exclude.match(path)
+              excluded = true
+              break
+            end
+          end
+
+          # Return the result
+          excluded
+        end
+
+        # Mirrors the folder pairs configured in the vagrantfile
+        #
+        # @param [String] A glob-style exclude format
+        #
+        # @return [Regexp] The exclude path as a regex
+        def compile_exclude(exclude)
+          exclude = exclude.dup
+
+          # Absolute path is tied to start of string, relative to any directory separator
+          if exclude.chars.first == '/'
+            regex = "^"
+            exclude[0] = ''
+          else
+            regex = "(^|/)"
+          end
+
+          # Temporarily convert wildcards to placeholders
+          exclude.sub!('**','<<globwild2>>')
+          exclude.sub!('*','<<globwild>>')
+
+          # Escape the string for regexp characters
+          exclude = Regexp.escape(exclude)
+
+
+          # one star matches anything except directories
+          exclude.sub!('<<globwild>>', '[^/]*?')
+
+          # two stars match anything including directories
+          exclude.sub!('<<globwild2>>','.*?')
+
+          regex << exclude
+
+          # pattern should always end on a directory separator or end of string
+          regex << '($|/)'
+
+          Regexp.new(regex)
+        end
       end
     end
   end

data/lib/vagrant-mirror/middleware/sync.rb

@@ -10,23 +10,6 @@ module Vagrant
     module Middleware
       class Sync < Base
 
-        # Loads the rest of the middlewares first, then finishes up by running
-        # the sync middleware. This is required because the core share_folders
-        # middleware does not mount the shares until the very end of the process
-        # and we need to run after that
-        #
-        # @param [Vagrant::Action::Environment] The environment
-        def call(env)
-          @app.call(env)
-
-          mirrors = env[:vm].config.mirror.folders
-          if !mirrors.empty?
-            execute(mirrors, env)
-          else
-            env[:ui].info("No vagrant-mirror mirrored folders configured for this box")
-          end
-        end
-
         protected
 
         # Synchronizes the folder pairs configured in the vagrantfile
@@ -75,6 +58,7 @@ module Vagrant
               rsync.run('/')
             end
 
+
           rescue RuntimeError => e
             # Pass through Vagrant errors
             if e.is_a? Vagrant::Errors::VagrantError

data/lib/vagrant-mirror/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Mirror
-    VERSION = "0.1.1.alpha"
+    VERSION = "0.1.2.alpha"
   end
 end

data/spec/vagrant-mirror/listener/host_spec.rb

@@ -26,40 +26,46 @@ describe Vagrant::Mirror::Listener::Host do
     context "when changes received" do
       before(:each) do
         Listen.stub(:to)
-          .and_yield(['modified'],[],[])
-          .and_yield([],['added'],[])
-          .and_yield([],[],['removed'])
-          .and_yield(['modified1'],['added1'],['removed1'])
+          .and_yield(['modified1','modified2'],[],[])
+          .and_yield([],['added1','added2'],[])
+          .and_yield([],[],['removed1','removed2'])
+          .and_yield(['modified3'],['added3'],['removed3'])
       end
 
-      it "pushes added files onto the queue" do
+      it "pushes added files onto the queue one by one" do
         queue.should_receive(:"<<")
-          .with(hash_including(:added => ['added']))
+          .with(hash_including({:event => :added, :path => 'added1'}))
+        queue.should_receive(:"<<")
+          .with(hash_including({:event => :added, :path => 'added2'}))
 
         subject.listen!
       end
 
-      it "pushes modified files onto the queue" do
+      it "pushes modified files onto the queue one by one" do
+        queue.should_receive(:"<<")
+          .with(hash_including({:event => :modified, :path => 'modified1'}))
         queue.should_receive(:"<<")
-          .with(hash_including(:modified => ['modified']))
+          .with(hash_including({:event => :modified, :path => 'modified2'}))
 
         subject.listen!
       end
 
-      it "pushes removed files onto the queue" do
+      it "pushes removed files onto the queue one by one" do
+        queue.should_receive(:"<<")
+          .with(hash_including({:event => :removed, :path => 'removed1'}))
         queue.should_receive(:"<<")
-          .with(hash_including(:removed => ['removed']))
+          .with(hash_including({:event => :removed, :path => 'removed2'}))
 
         subject.listen!
       end
 
       it "handles simultaneous changes" do
         queue.should_receive(:"<<")
-          .with(hash_including({
-            :added => ['added1'],
-            :modified => ['modified1'],
-            :removed => ['removed1']
-            }))
+          .with(hash_including({:event => :added, :path => 'added3'}))
+        queue.should_receive(:"<<")
+          .with(hash_including({:event => :modified, :path => 'modified3'}))
+        queue.should_receive(:"<<")
+          .with(hash_including({:event => :removed, :path => 'removed3'}))
 
         subject.listen!
       end

data/spec/vagrant-mirror/middleware/mirror_spec.rb

@@ -54,9 +54,10 @@ describe Vagrant::Mirror::Middleware::Mirror do
     end
 
     context "with a mirrored folder" do
+      let ( :mirror_options ) { {} }
 
       before (:each) do
-        config.mirror.vagrant_root '/var/guest'
+        config.mirror.vagrant_root '/var/guest', mirror_options
         config.vm.share_folder("v-root", "/vagrant", ".")
       end
 
@@ -122,50 +123,115 @@ describe Vagrant::Mirror::Middleware::Mirror do
 
       context "with notifications in the queue" do
 
-        let (:added)     { ['added'] }
-        let (:modified)  { ['modified','modified2'] }
-        let (:removed)   { ['removed'] }
-        let (:rm_exists) { true }
+        let (:added)            { { :event => :added, :path => 'added' } }
+        let (:modified)         { { :event => :modified, :path => 'modified'} }
+        let (:removed_exists)   { { :event => :removed, :path => 'removed_exists'}}
+        let (:removed_remvd)    { { :event => :removed, :path => 'removed_remvd'}}
 
         before (:each) do
           queue.stub(:pop).and_return(
-            { :added => added, :modified => modified, :removed => removed },
-            { :added => added, :modified => modified, :removed => removed },
-            { :quit => true })
-          File.stub(:exists?).with("#{env[:root_path]}/removed").and_return(rm_exists)
+            added,
+            modified,
+            removed_exists,
+            removed_remvd,
+            { :quit => true }
+          )
+
+          File.stub(:exists?).with("#{env[:root_path]}/removed_exists").and_return(true)
+          File.stub(:exists?).with("#{env[:root_path]}/removed_remvd").and_return(false)
         end
 
         it "runs rsync one by one for each added and modified file" do
           rsync.should_receive(:run).with("added")
           rsync.should_receive(:run).with("modified")
-          rsync.should_receive(:run).with("modified2")
 
           subject.call(env)
           sleep 0.2
         end
 
-        # Sometimes Guard flags a file as deleted that still exists - during certain types of
-        # atomic file writes, we think. So we should delete the file remotely if so, or sync if not.
-        context "if deleted files have been deleted" do
-          let (:rm_exists) { false }
+        it "deletes files by SSH if they have been deleted on the host" do
+          channel.should_receive(:sudo).with('rm /var/guest/removed_remvd')
+
+          subject.call(env)
+          sleep 0.2
+        end
+
+        it "runs rsync to update deleted files if they still exist on the host" do
+          rsync.should_receive(:run).with('removed_exists')
+
+          subject.call(env)
+          sleep 0.2
+        end
+      end
+
+      context "with notifications in the queue when exclude paths are configured" do
+        let (:mirror_options) { { :exclude => [ "/docs", "cache", "*.png", "dir*", "/vendor/**/test"] } }
+
+        # For these tests we want to know about unexpected calls
+        let (:rsync)          { double("Vagrant::Mirror::Rsync") }
+
+        it "correctly filters absolute paths within the sync folder" do
+          queue.stub(:pop).and_return(
+            { :event => :added, :path => "docs/should/ignore.fl" },
+            { :event => :added, :path => "should/not/ignore/docs.txt" },
+            { :quit => true })
+
+          rsync.should_receive(:run).with('should/not/ignore/docs.txt')
+
+          subject.call(env)
+          sleep 0.2
+        end
+
+        it "correctly filters named directories within the sync folder" do
+          queue.stub(:pop).and_return(
+            { :event => :added, :path => "cache/should/ignore.fl" },
+            { :event => :added, :path => "should/cache/ignore.fl" },
+            { :event => :added, :path => "cacheit/should/not/ignore.fl" },
+            { :quit => true })
+
+          rsync.should_receive(:run).with('cacheit/should/not/ignore.fl')
+
+          subject.call(env)
+          sleep 0.2
+        end
+
+        it "correctly filters filename wildcards" do
+          queue.stub(:pop).and_return(
+            { :event => :added, :path => "ignore.png" },
+            { :event => :added, :path => "should/ignore.png" },
+            { :event => :added, :path => "should/not/png/ignore.txt" },
+            { :quit => true })
 
-          it "deletes them by SSH" do
-            channel.should_receive(:sudo).with('rm /var/guest/removed')
+          rsync.should_receive(:run).with('should/not/png/ignore.txt')
 
-            subject.call(env)
-            sleep 0.2
-          end
+          subject.call(env)
+          sleep 0.2
         end
 
-        context "if deleted files have not been deleted" do
-          let (:rm_exists) { true }
+        it "correctly filters glob patterns with *" do
+          queue.stub(:pop).and_return(
+            { :event => :added, :path => "dir1/should/ignore.fl" },
+            { :event => :added, :path => "should/dirignore/this.tst" },
+            { :event => :added, :path => "should/notdir/ignore.tst" },
+            { :quit => true })
+
+          rsync.should_receive(:run).with('should/notdir/ignore.tst')
 
-          it "runs rsync on the file" do
-            rsync.should_receive(:run).with('removed')
+          subject.call(env)
+          sleep 0.2
+        end
 
-            subject.call(env)
-            sleep 0.2
-          end
+        it "correctly filters glob patterns with **" do
+          queue.stub(:pop).and_return(
+            { :event => :added, :path => "vendor/my/test/file.tst" },
+            { :event => :added, :path => "vendor/my/deep/test/file.tst" },
+            { :event => :added, :path => "vendor/test/file.tst" },
+            { :quit => true })
+
+          rsync.should_receive(:run).with('vendor/test/file.tst')
+
+          subject.call(env)
+          sleep 0.2
         end
 
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-mirror
 version: !ruby/object:Gem::Version
-  version: 0.1.1.alpha
+  version: 0.1.2.alpha
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vagrant