vagrant-mirror 0.1.0.alpha → 0.1.1.alpha

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vagrant-mirror (0.0.1)
+    vagrant-mirror (0.1.1.alpha)
       listen
       vagrant (~> 1.0.5)
 

data/README.md

@@ -1,6 +1,7 @@
 # Vagrant::Mirror
 
 [![Build Status](https://travis-ci.org/ingenerator/vagrant-mirror.png)](https://travis-ci.org/ingenerator/vagrant-mirror)
+[![Code Climate](https://codeclimate.com/github/ingenerator/vagrant-mirror.png)](https://codeclimate.com/github/ingenerator/vagrant-mirror)
 
 **This plugin is for the 1.0.x series of Vagrant and has not been updated to work with 1.1 and
 above. We plan to update it eventually, if you want it faster than that then contributions are
@@ -18,29 +19,50 @@ number of dependencies.
 
 ## Installation
 
-The best option is to install the gem (note you will need to run `vagrant gem vagrant-mirror` if
-using the bundled Vagrant package as this runs in isolation from your global ruby installation).
+You need to install the plugin as a gem within Vagrant's embedded Ruby environment. You will
+also require the appropriate listen filesystem driver to watch for changes. The plugin
+currently only has an alpha release available, so you need to specify --pre on the install
+command.
 
-You also need to install the correct filesystem driver for your host operating system:
+### On Windows
 
-* For Windows - [WDM](https://github.com/Maher4Ever/wdm)
-* For Linux - [rb-inotify](https://github.com/nex3/rb-inotify)
-* For OS X - [rb-fsevent](https://github.com/thibaudgg/rb-fsevent)
+On Windows, the [WDM](https://github.com/Maher4Ever/wdm) driver is recommended. Install like
+this:
 
-Unfortunately there is currently no way to specify these as platform-specific dependencies in the
-gemfile.
+```bash
+# Add the Ruby devkit to the Vagrant environment so that native extensions can build
+# If your vagrant install path is different you will need to edit this command
+c:\vagrant\vagrant\embedded\devkitvars.bat
 
-You can then add to your Vagrantfile like so:
+# Install the latest alpha release of the vagrant-mirror gem
+vagrant gem install vagrant-mirror --pre
 
-```ruby
-    require 'vagrant-mirror'
+# Install the wdm gem
+vagrant gem install wdm
+```
+
+### On Linux
 
-    Vagrant::Config.run do | config |
-      #.....
-    end
+Vagrant-mirror is not tested on a linux host - though in theory it should work (the
+specs run on Travis and all pass, and listen is tested cross-platform). The 
+[rb-inotify](https://github.com/nex3/rb-inotify) driver is recommended.
+
+```bash
+vagrant gem install vagrant-mirror --pre
+vagrant gem install rb-inotify
 ```
 
-Alternatively, add this repository alongside the Vagrantfile and require the library manually.
+If you have problems getting it working on linux, contributions are welcome.
+
+### On OS X
+
+Vagrant-mirror is not tested on OS X - though in theory it should work. The 
+[rb-fsevent](https://github.com/thibaudgg/rb-fsevent) driver is recommended.
+
+```bash
+vagrant gem install vagrant-mirror --pre
+vagrant gem install rb-inotify
+```
 
 ## Basic usage
 
@@ -55,10 +77,10 @@ Include paths to mirror in your Vagrantfile like so:
     config.mirror.folder "foo", "/guest/mirror/path"
 ```
 
-When you run `vagrant up` or `vagrant resume`, vagrant-mirror will:
+When you run `vagrant up` or `vagrant reload`, vagrant-mirror will:
 
 * Ensure that your guest has any shared folders required for the pair
-* Create any local symlinks required
+* Create any local symlinks required (see below)
 * Run rsync on the guest to copy from the virtualbox shared folder to the local guest path
 * Register with the local host filesystem for updates using using [listen](https://rubygems.org/gems/listen)
 
@@ -66,9 +88,9 @@ When changes are detected on the host, they will be notified by the listen gem.
 detected, the host will trigger the guest to run rsync on the changed path to update the locally
 stored file.
 
-If you want to force a full resync, you can run `vagrant mirror-sync`.
+If you want to force a full resync, you can run `vagrant mirror sync`.
 
-If for some reason the mirror crashes you can just run `vagrant-mirror monitor` on the host to bring
+If for some reason the mirror crashes you can just run `vagrant mirror monitor` on the host to bring
 it back up.
 
 ## Advanced usage
@@ -89,6 +111,11 @@ the virtualbox shared folder?
 
 This will exclude the "/log" folder from rsync and symlink it directly to the shared folder.
 
+Under the hood, vagrant-mirror just uses rsync so if for some reason you want to update your
+host with a bigger set of changed files from the guest (perhaps you ran a script that modified
+your source code somehow) you can just SSH to the guest and run rsync to copy files from the 
+mirror folder back to the virtualbox share.
+
 ### Excluding paths
 
 Perhaps there are paths you don't require on your virtual machine. For example, syncing your docs
@@ -106,9 +133,9 @@ to the directory being mirrored.
 
 ### Propogating deletes
 
-By default, vagrant mirror transfers new files and folders but does not propogate deletes. This can
-lead to unwanted behaviour, in particular if your application on the guest indexes or autoloads all
-the files it finds. You can enable deletions with the following:
+By default, vagrant mirror sync transfers new files and folders but does not propogate deletes. 
+This can lead to unwanted behaviour, in particular if your application on the guest indexes or 
+autoloads all the files it finds. You can enable deletions with the following:
 
 ```ruby
     # To mirror the vagrant root path - the options hash is also available when sharing any folder
@@ -120,12 +147,18 @@ the files it finds. You can enable deletions with the following:
 You should ensure that your "exclude" configuration includes all the paths that may be present on
 the guest (build directories, cache, assets) as otherwise they will be deleted.
 
+**Note that the :delete option only controls whether rsync will delete unexpected files during 
+vagrant mirror sync. During active mirroring, if you delete a file on the host this will be
+detected by listen and the file will be deleted on the guest.**
+
 ### Notifications
 
 The time between updates is generally pretty fast, but it is nonzero. If you're working in fast
 cycles it can be that you rerun a command on the guest before your updated files have been
 transferred, which may be confusing. Avoid this by having vagrant-mirror issue a system beep whenever
-transfers complete.
+transfers complete. Note that every so often vagrant will drop the SSH connection and the first
+command on a new connection can take at least 4 seconds, subsequent commands should be significantly
+faster.
 
 ```ruby
     # To mirror the vagrant root path - the options hash is also available when sharing any folder
@@ -138,14 +171,16 @@ transfers complete.
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`) with specs
+3. Commit your changes (`git commit -am 'Add some feature'`) with specs. Changes without specs will 
+   not be merged.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
 ## Acknowledgements
 
 The [vagrant-notify](https://github.com/fgrehm/vagrant-notify/) plugin was very useful in working
-out how to structure this plugin.
+out how to structure this plugin. And of course, none of this would be possible without the great
+work on vagrant itself, thanks to Mitchell for that.
 
 ## Copyright
 

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

@@ -42,7 +42,9 @@ module Vagrant
               ui.info("Synchronising for #{host_path}")
 
               # Create any required symlinks
-              mirror_config[:symlinks].each do | relpath |
+              mirror_config[:symlinks].each do | origpath |
+                # Copy the path so that it is not altered elsewhere, then strip any leading /
+                relpath = origpath.dup
                 relpath.sub!(/^\//, '')
                 source = "#{guest_sf_path}/#{relpath}"
                 target = "#{mirror_config[:guest_path]}/#{relpath}"

data/lib/vagrant-mirror/version.rb

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

data/spec/vagrant-mirror/command_spec.rb

@@ -10,9 +10,10 @@ describe Vagrant::Mirror::Command do
     env.stub(:ui).and_return ui
   end
 
-  subject { Vagrant::Mirror::Command.new(argv, env) }
-
   describe "#execute" do
+
+    subject { Vagrant::Mirror::Command.new(argv, env) }
+
     shared_examples "cannot run in multivm" do
       before (:each) do
         env.stub(:multivm?).and_return(true)

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

@@ -2,13 +2,14 @@ describe Vagrant::Mirror::Listener::Host do
 
   let (:queue) { double("Queue").as_null_object }
 
-  subject { Vagrant::Mirror::Listener::Host.new('c:/host', queue) }
-
   before (:each) do
     Listen.stub(:to).as_null_object
   end
 
   describe "#listen!" do
+
+    subject { Vagrant::Mirror::Listener::Host.new('c:/host', queue) }
+
     it "listens to the host directory" do
       Listen.should_receive(:to).with('c:/host', anything())
 
@@ -71,6 +72,9 @@ describe Vagrant::Mirror::Listener::Host do
   end
 
   describe "#listen" do
+
+    subject { Vagrant::Mirror::Listener::Host.new('c:/host', queue) }
+
     let (:thread) { double("Thread") }
 
     before (:each) do

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

@@ -33,9 +33,10 @@ describe Vagrant::Mirror::Middleware::Mirror do
     queue.stub(:pop).and_return({ :quit => true})
   end
 
-  subject { Vagrant::Mirror::Middleware::Mirror.new(app, env) }
-
   describe "#call" do
+
+    subject { Vagrant::Mirror::Middleware::Mirror.new(app, env) }
+
     shared_examples "chained mirror middleware" do
       it "calls the next middleware" do
         app.should_receive(:call).with(env)

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

@@ -28,10 +28,10 @@ describe Vagrant::Mirror::Middleware::Sync do
 
   end
 
-  subject { Vagrant::Mirror::Middleware::Sync.new(app, env) }
-
   describe "#call" do
 
+    subject { Vagrant::Mirror::Middleware::Sync.new(app, env) }
+
     shared_examples "chained middleware" do
       it "calls the next middleware" do
         app.should_receive(:call).with(env)
@@ -114,7 +114,7 @@ describe Vagrant::Mirror::Middleware::Sync do
       let (:host_path) { File.join(Dir.pwd, 'logs') }
 
       before (:each) do
-        config.mirror.vagrant_root "/var/vagrant", { :symlinks => ['logs'] }
+        config.mirror.vagrant_root "/var/vagrant", { :symlinks => ['/logs'] }
         config.vm.share_folder("v-root", "/vagrant", ".")
 
         File.stub(:exists?).with(host_path).and_return true
@@ -137,6 +137,15 @@ describe Vagrant::Mirror::Middleware::Sync do
 
         subject.call(env)
       end
+
+      it "does not modify the excludes config passed to rsync" do
+        Vagrant::Mirror::Rsync.should_receive(:new)
+          .with(anything, anything, anything, hash_including({ :exclude => [ '/logs' ]}))
+          .and_return(rsync)
+
+        subject.call(env)
+      end
+
     end
 
     context "when the mirrored config includes invalid shared folders" do

data/spec/vagrant-mirror/rsync_spec.rb

@@ -19,10 +19,10 @@ describe Vagrant::Mirror::Rsync do
     File.stub(:directory?).with('c:/vagrant/dir').and_return(true)
   end
 
-  subject { Vagrant::Mirror::Rsync.new(vm, guest_sf_path, host_path, mirror_config) }
-
   describe "#run" do
 
+    subject { Vagrant::Mirror::Rsync.new(vm, guest_sf_path, host_path, mirror_config) }
+
     shared_examples "running rsync to update the path" do | path, expect_source, expect_dest |
       context "with no exclude paths" do
         it "runs the expected rsync command" do
@@ -34,10 +34,10 @@ describe Vagrant::Mirror::Rsync do
 
       context "with exclude paths" do
         let (:mirror_config) { { :name => 'v-root', :guest_path => '/var/vagrant', :delete => false,
-                           :exclude => ['.git', 'cache'], :beep => false, :symlinks => [] } }
+                           :exclude => ['/.git', 'cache'], :beep => false, :symlinks => [] } }
 
         it "runs the expected rsync command"  do
-          channel.should_receive(:sudo).with("rsync -av --exclude '.git' --exclude 'cache' #{expect_source} #{expect_dest}")
+          channel.should_receive(:sudo).with("rsync -av --exclude '/.git' --exclude 'cache' #{expect_source} #{expect_dest}")
 
           subject.run(path)
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-mirror
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha
+  version: 0.1.1.alpha
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000Z
+date: 2013-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vagrant
-  requirement: &9922692 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 1.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *9922692
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: listen
-  requirement: &9922440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *9922440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &9922164 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9922164
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &9921912 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9921912
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &9921660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9921660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &9921408 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +101,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9921408
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Vagrant plugin that mirrors folders from host to guest by monitoring
   filesystem
 email:
@@ -104,9 +134,6 @@ files:
 - lib/vagrant-mirror/middleware/mirror.rb
 - lib/vagrant-mirror/middleware/sync.rb
 - lib/vagrant-mirror/rsync.rb
-- lib/vagrant-mirror/sync/all.rb
-- lib/vagrant-mirror/sync/base.rb
-- lib/vagrant-mirror/sync/changes.rb
 - lib/vagrant-mirror/version.rb
 - lib/vagrant_init.rb
 - spec/spec_helper.rb
@@ -138,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Vagrant plugin that mirrors folders from host to guest by monitoring filesystem

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

@@ -1,60 +0,0 @@
-# Compares the contents of the host and guest paths and transfers any
-# missing or modified paths to the other side of the mirror. If a whole
-# directory is missing, uses recursive upload/download from the SFTP class,
-# otherwise it iterates over and compares the directory contents.
-#
-# This class does not detect deletions - if a file is missing on one side
-# of the mirror it will simply be replaced.
-#
-# @author Andrew Coulton < andrew@ingenerator.com >
-module Vagrant
-  module Mirror
-    module Sync
-      class All < Base
-
-        # Compares a folder between guest and host, transferring any new or
-        # modified files in the right direction.
-        #
-        # @param [string] The base path to compare
-        def execute(path)
-          path = path.chomp('/')
-          host_dir = host_path(path).chomp('/')
-          guest_dir = guest_path(path).chomp('/')
-
-          if !@connection.exists?(guest_dir)
-            # Create the guest directory
-            @connection.mkdir(guest_dir)
-          end
-
-          if !File.exists?(host_dir)
-            # Create the host directory
-            FileUtils.mkdir_p(host_dir)
-          end
-
-          # If the guest path already exists, have to sync manually
-          # First get a combined listing of the two paths
-          all_files = @connection.dir_entries(guest_dir) | Dir.entries(host_dir)
-          all_files.each do | file |
-            # Ignore . and ..
-            if (file == '.') or (file == '..')
-              next
-            end
-
-            # Get local paths
-            host_file = File.join(host_dir, file)
-            guest_file = File.join(guest_dir, file)
-            # Recurse for directories
-            if File.directory?(host_file) \
-               or ( !File.exists?(host_file) and @connection.directory?(guest_file))
-              execute("#{path}/#{file}")
-            else
-              # Transfer new/modified files between host and guest
-              compare_and_transfer(host_file, guest_file)
-            end
-          end
-
-        end
-      end
-    end
-  end
-end

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

@@ -1,98 +0,0 @@
-# Base class for file sync actions, providing common required functionality
-#
-# @author Andrew Coulton < andrew@ingerator.com >
-module Vagrant
-  module Mirror
-    module Sync
-      class Base
-
-        # Initialises the synchroniser
-        #
-        # @param [Vagrant::Mirror::Connection::SFTP] The sftp connection instance
-        # @param [String] The root path on the host to mirror
-        # @param [String] The root path on the guest to mirror
-        # @param [Vagrant::UI::Interface] The Vagrant UI class
-        def initialize(connection, host_path, guest_path, ui)
-          @connection = connection
-          @host_root = host_path
-          @guest_root = guest_path
-          @ui = ui
-        end
-
-        # ==================================================================
-        # Begin protected internal methods
-        # ==================================================================
-        protected
-
-        # Gets the absolute host path for a file
-        #
-        # @param [String] Relative path to the file
-        # @return [String] Absolute path to the file on the host
-        def host_path(relative_path)
-          File.join(@host_root, relative_path)
-        end
-
-        # Gets the absolute guest path for a file
-        #
-        # @param [String] Relative path to the file
-        # @return [String] Absolute path to the file on the guest
-        def guest_path(relative_path)
-          File.join(@guest_root, relative_path)
-        end
-
-        # Gets the mtime of a file on the host from an absolute path
-        #
-        # @param [String] Absolute host path
-        # @return [Time] mtime, or nil if the file does not exist
-        def host_mtime(path)
-          if !File.exists?(path)
-            return nil
-          end
-          return File.mtime(path)
-        end
-
-        # Gets the mtime of a file on the guest from an absolute path
-        #
-        # @param [String] Absolute guest path
-        # @return [Time] mtime, or nil if the file does not exist
-        def guest_mtime(path)
-          @connection.mtime(path)
-        end
-
-        # Compares files on the host and the guest and transfers the newest
-        # to the other side.
-        #
-        # @param [String] Absolute host path
-        # @param [String] Absolute guest path
-        def compare_and_transfer(host_file, guest_file)
-
-          # Get the mtimes
-          host_time = host_mtime(host_file)
-          guest_time = guest_mtime(guest_file)
-
-          # Check what to do
-          if (host_time.nil? and guest_time.nil?) then
-            # Report an error
-            @ui.error("#{host_file} was not found on either the host or guest filesystem - cannot sync")
-          elsif (host_time == guest_time)
-            # Do nothing
-            return
-          elsif (guest_time.nil?)
-            # Transfer to guest
-            @connection.upload(host_file, guest_file, host_time)
-          elsif (host_time.nil?)
-            # Transfer to host
-            @connection.download(guest_file, host_file, guest_time)
-          elsif (host_time > guest_time)
-            # Transfer to guest
-            @connection.upload(host_file, guest_file, host_time)
-          elsif (host_time < guest_time)
-            # Transfer to guest
-            @connection.download(guest_file, host_file, guest_time)
-          end
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,61 +0,0 @@
-# Processes notified file additions, modifications and deletions notified by
-# guard/listen, and replays them on the other side of the mirror.
-# The execute method will be called for each changeset notified whether
-# by guard or over the TCP socket (from guard on the guest). This could
-# cause a race condition as changes on the guest trigger changes on the host
-# and vice versa.
-#
-# Therefore, on notification of added or modified file, the class just
-# syncs whichever is the newest file between the two machines. On deletion
-# it will quietly fail if the file it is notified of has already been
-# deleted.
-#
-# @author Andrew Coulton < andrew@ingenerator.com >
-module Vagrant
-  module Mirror
-    module Sync
-      class Changes < Base
-
-        # Compares a single notified changeset and transfers any changed,
-        # modified or removed files in the right direction.
-        #
-        # @param [Symbol] Which side of the mirror the change was detected
-        # @param [Array] Array of added paths
-        # @param [Array] Array of changed paths
-        # @param [Array] Array of removed paths
-        def execute(source, added, modified, removed)
-
-          # Combine added and modified, they're the same for our purposes
-          changed = added + modified
-          changed.each do |file|
-            # Transfer the newest file to the other side, or do nothing
-            compare_and_transfer(host_path(file), guest_path(file))
-          end
-
-          # Process deleted files
-          removed.each do |file|
-            # Expect a cascade - only delete on opposite side if exists
-            if source == :host
-              guest_file = guest_path(file)
-              if !guest_mtime(guest_file).nil?
-                @connection.delete(guest_file)
-              else
-                @ui.info("#{file} was not found on guest - nothing to delete")
-              end
-            elsif source == :guest
-              host_file = host_path(file)
-              if File.exists?(host_file)
-                File.delete(host_file)
-              else
-                @ui.info("#{file} was not found on host - nothing to delete")
-              end
-            end
-          end
-
-          # Complete all transfers
-          @connection.finish_transfers
-        end
-      end
-    end
-  end
-end