vagrant-unison2 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a56396d3b841677ba05e588a000d1720dc2a8bad
-  data.tar.gz: 23822e18be0e28ad858c2fa2ff516279b3c6857b
+  metadata.gz: 2d1bd32bfb734ac2d670b0c1262302721eb6040f
+  data.tar.gz: c7b2aabc864f537bb8c2d037eff5a5906674840d
 SHA512:
-  metadata.gz: edbcc038df62a9793359da3842eedfdee9f2d498f926e7100742ac0592c7e527f2c2ee6f74f8c71384d768203ae76b2a8ac7f38b153ea2de522380baa1a1fb0c
-  data.tar.gz: 0d6e5322228b67d435706f55bdf3e3b92c18a9e18586983d2212f9d5e937bdd9677a5d870fe35fa5e2a20855238c63feac5f83f4a78c336b92b88102c5077673
+  metadata.gz: 13573bf09a741d47532d3c2bea0a453f1f99ae27abb254b26c85f11bad22719409d71e57a3a52e4bb9c570a82ce358e32f4adc33b4abca829da5fb85a1a77751
+  data.tar.gz: e348c59bad88fd9394e8c9b5076bed0ce63010d3e1d98e1bfa1457ae331bda2bf74f1e479f106794c6d9d59d0004b24b58bb14b714af855fbfe7f04bde02cb59

data/README.md

@@ -1,4 +1,4 @@
-# Vagrant Unison Plugin
+# Vagrant Unison 2 Plugin
 
 This is a [Vagrant](http://www.vagrantup.com) 1.1+ plugin that syncs files over SSH from a local folder
 to your Vagrant VM (local or on AWS).  Under the covers it uses [Unison](http://www.cis.upenn.edu/~bcpierce/unison/)
@@ -7,12 +7,12 @@ to your Vagrant VM (local or on AWS).  Under the covers it uses [Unison](http://
 
 ## Features
 
-* Unisoned folder support via `unison` over `ssh` -> will work with any vagrant provider, eg Virtualbox or AWS.
+* Unisoned folder support via `unison` over `ssh` -> will work with any vagrant provider, eg Virtualbox or AWS, though it's most tested on a local VM via Virtualbox.
 
 ## Usage
 
 1. You must already have [Unison](http://www.cis.upenn.edu/~bcpierce/unison/) installed and in your path.
-     * On Mac you can install this with Homebrew:  `brew install unison` (on Yosemite you will have to use https://rudix-mountainlion.googlecode.com/files/unison-2.40.102-0.pkg)
+     * On Mac you can install this with Homebrew:  `brew install unison`
      * On Unix (Ubuntu) install using `sudo apt-get install unison`
      * On Windows, download [2.40.102](http://alan.petitepomme.net/unison/assets/Unison-2.40.102.zip), unzip, rename `Unison-2.40.102 Text.exe` to `unison.exe` and copy to somewhere in your path.
 1. Install using standard Vagrant 1.1+ plugin installation methods. 
@@ -32,18 +32,20 @@ end
 ```
 1. Start up your starting your vagrant box as normal (eg: `vagrant up`)
 
+
 ## Start syncing Folders
 
 Run `vagrant unison-sync-once` to run a single, non-interactive sync and then exit.
 
-Run `vagrant unison-sync` to sync then start watching the local_folder for changes, and syncing these to your vagrang VM.
+Run `vagrant unison-sync-polling` to start in bidirect monitor (repeat) mode - every second unison checks for changes on either side and syncs them.
+
+## (Legacy) Sync using OSX inotify events
 
-Under the covers this uses your system installation of [Unison](http://www.cis.upenn.edu/~bcpierce/unison/), 
-which must be installed in your path.
+Run `vagrant unison-sync` to sync then start watching the local_folder for changes, and syncing these to your vagrang VM.
 
-## Start syncing Folders with polling (unison repeat mode)
+This uses the `watch` ruby gem and runs a one-off unison sync when it gets change events.
 
-Run `vagrant unison-sync-polling` to start in bidirect monitor (repeat) mode - every second unison checks for changes on either side and syncs them.
+For some reason, this does not always get all the events immediately which can be frustrating. Since the polling mode (unison repeat mode) is not too resource intensive, I recommend that instead.
 
 ## Sync in interactive mode
 
@@ -56,6 +58,12 @@ This is a useful tool when the automatic sync sees a change in a file on both
 sides and skips it.
 
 ## Cleanup unison database
+Run `vagrant unison-cleanup` to clear the unison metadata from `~/Library/Application Support/Unison/` as well as all files.
+
+## Error states
+
+### Inconsistent state with unison metadata
+
 When you get
 ```
 Fatal error: Warning: inconsistent state.  
@@ -67,9 +75,23 @@ Please delete archive files as appropriate and try again
 or invoke Unison with -ignorearchives flag.
 ```
 
-Run `vagrant unison-cleanup` to clear Archive from ~/Library/Application Support/Unison/ and files from host folder.
+You should run a unison-cleanup
+
 Running Unison with -ignorearchives flag is a bad idea, since it will produce conflicts.
 
+### Skipping files changed on both sides
+
+This is most often caused in my experience by files that get changed by different users with different permissions.
+
+For instance, if you're running an Ubuntu VM then the unison process is running
+as the vagrant user. If you have the unison synced folder loaded as a volume in
+a docker container and a new file gets created in the container, the vagrant
+user in the VM won't own that file and this can keep unison from being able to
+sync the file. (I'm looking for a way to fix this particular error case).
+
+Running a unison-cleanup should fix this state.
+
+
 ## Development
 
 To work on the `vagrant-unison` plugin, clone this repository out, and use

data/lib/vagrant-unison2/command.rb

@@ -99,9 +99,12 @@ module VagrantPlugins
 
     class CommandPolling < Vagrant.plugin("2", :command)
       include UnisonSync
+      attr_accessor :bg_thread
 
       def execute
         with_target_vms do |machine|
+          @bg_thread = watch_vm_for_memory_leak(machine)
+
           execute_sync_command(machine) do |command|
             command.repeat = true
             command.terse = true
@@ -121,7 +124,10 @@ module VagrantPlugins
                 exit_on_next_sigint = false
                 system(command)
               rescue Interrupt
-                exit 1 if exit_on_next_sigint
+                if exit_on_next_sigint
+                  Thread.kill(@bg_thread) if @bg_thread
+                  exit 1
+                end
                 @env.ui.info '** Hit Ctrl + C again to kill. **'
                 exit_on_next_sigint = true
               rescue Exception
@@ -130,9 +136,32 @@ module VagrantPlugins
             end
           end
         end
-
         0
       end
+
+      def watch_vm_for_memory_leak(machine)
+        ssh_command = SshCommand.new(machine)
+        unison_mem_cap_mb = 100
+        Thread.new(ssh_command.ssh, unison_mem_cap_mb) do |ssh_command_text, mem_cap_mb|
+          while true
+            sleep 15
+            total_mem = `#{ssh_command_text} 'free -m | egrep "^Mem:" | awk "{print \\$2}"' 2>/dev/null`
+            _unison_proc_returnval = `#{ssh_command_text} 'ps aux | grep "[u]nison -server" | awk "{print \\$2, \\$4}"' 2>/dev/null`
+            if _unison_proc_returnval == ''
+              puts "Unison not running in VM"
+              next
+            end
+            pid, mem_pct_unison = _unison_proc_returnval.strip.split(' ')
+            mem_unison = (total_mem.to_f * mem_pct_unison.to_f/100).round(1)
+            # Debugging: uncomment to log every loop tick
+            # puts "Unison running as #{pid} using #{mem_unison} mb"
+            if mem_unison > mem_cap_mb
+              puts "Unison using #{mem_unison} mb memory is over limit of #{mem_cap_mb}, restarting"
+              `#{ssh_command_text} kill -HUP #{pid} 2>/dev/null`
+            end
+          end
+        end
+      end
     end
 
     class CommandCleanup < Vagrant.plugin("2", :command)

data/lib/vagrant-unison2/shell_command.rb

@@ -1,9 +1,9 @@
 module VagrantPlugins
   module Unison
     class ShellCommand
-      def initialize machine, paths, ssh_command
+      def initialize machine, unison_paths, ssh_command
         @machine = machine
-        @paths = paths
+        @unison_paths = unison_paths
         @ssh_command = ssh_command
       end
 
@@ -25,13 +25,13 @@ module VagrantPlugins
       def args
         _args = [
           'unison',
-          @paths.host,
-          @ssh_command.uri,
+          @unison_paths.host,
+          @ssh_command.uri(@unison_paths),
           batch_arg,
           terse_arg,
           repeat_arg,
           ignore_arg,
-          ['-sshargs', %("#{@ssh_command.command}")],
+          ['-sshargs', %("#{@ssh_command.ssh_args}")],
         ].flatten.compact
         _args
       end

data/lib/vagrant-unison2/ssh_command.rb

@@ -1,14 +1,21 @@
 module VagrantPlugins
   module Unison
     class SshCommand
-      def initialize(machine, unison_paths)
+      def initialize(machine)
         @machine = machine
-        @unison_paths = unison_paths
       end
 
-      def command
+      def ssh
         %W(
-          -p #{ssh_info[:port]}
+          ssh
+          vagrant@127.0.0.1
+          #{ssh_args}
+        ).compact.join(' ')
+      end
+
+      def ssh_args
+        %W(
+          -p #{@machine.ssh_info[:port]}
           #{proxy_command}
           -o StrictHostKeyChecking=no
           -o UserKnownHostsFile=/dev/null
@@ -16,27 +23,23 @@ module VagrantPlugins
         ).compact.join(' ')
       end
 
-      def uri
-        username = ssh_info[:username]
-        host = ssh_info[:host]
+      def uri(unison_paths)
+        username = @machine.ssh_info[:username]
+        host = @machine.ssh_info[:host]
 
-        "ssh://#{username}@#{host}/#{@unison_paths.guest}"
+        "ssh://#{username}@#{host}/#{unison_paths.guest}"
       end
 
       private
 
       def proxy_command
-        command = ssh_info[:proxy_command]
+        command = @machine.ssh_info[:proxy_command]
         return nil unless command
         "-o ProxyCommand='#{command}'"
       end
 
-      def ssh_info
-        @machine.ssh_info
-      end
-
       def key_paths
-        ssh_info[:private_key_path].map { |p| "-i #{p}" }.join(' ')
+        @machine.ssh_info[:private_key_path].map { |p| "-i #{p}" }.join(' ')
       end
     end
   end

data/lib/vagrant-unison2/unison_sync.rb

@@ -12,7 +12,7 @@ module VagrantPlugins
         machine.communicate.sudo("mkdir -p '#{guest_path}'")
         machine.communicate.sudo("chown #{machine.ssh_info[:username]} '#{guest_path}'")
 
-        ssh_command = SshCommand.new(machine, unison_paths)
+        ssh_command = SshCommand.new(machine)
         shell_command = ShellCommand.new(machine, unison_paths, ssh_command)
 
         yield shell_command

data/lib/vagrant-unison2/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Unison
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-unison2
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - David Laing
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen