vagrant-unison2 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d1bd32bfb734ac2d670b0c1262302721eb6040f
-  data.tar.gz: c7b2aabc864f537bb8c2d037eff5a5906674840d
+  metadata.gz: 3f9c0f38337bb5960bb29c8da31e978a23695887
+  data.tar.gz: 966b97b53ea314c8461d8690bcaa507dad9b6bc9
 SHA512:
-  metadata.gz: 13573bf09a741d47532d3c2bea0a453f1f99ae27abb254b26c85f11bad22719409d71e57a3a52e4bb9c570a82ce358e32f4adc33b4abca829da5fb85a1a77751
-  data.tar.gz: e348c59bad88fd9394e8c9b5076bed0ce63010d3e1d98e1bfa1457ae331bda2bf74f1e479f106794c6d9d59d0004b24b58bb14b714af855fbfe7f04bde02cb59
+  metadata.gz: 3abcb7f645f70a8b3f006b79f10d106ef9365ebdf15c84279c787db7567d8b461293a4f37bc6305293960a62c4fc24cd064102395c039a4ebd430c5117ab86ee
+  data.tar.gz: e4e96ea90142df5d27c9d67a07d7b435a02f55d22e7e74937150d134a8c0b565c1cae94423636645dbc8a7649d78b3e0cfdeae33964e077c5d40823f9beb04b5

data/README.md

@@ -1,9 +1,9 @@
 # Vagrant Unison 2 Plugin
 
-This is a [Vagrant](http://www.vagrantup.com) 1.1+ plugin that syncs files over SSH from a local folder
+This is a [Vagrant](http://www.vagrantup.com) 1.7+ 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/)
 
-**NOTE:** This plugin requires Vagrant 1.1+,
+**NOTE:** This plugin requires Vagrant 1.7+,
 
 ## Features
 
@@ -11,22 +11,40 @@ to your Vagrant VM (local or on AWS).  Under the covers it uses [Unison](http://
 
 ## Usage
 
-1. You must already have [Unison](http://www.cis.upenn.edu/~bcpierce/unison/) installed and in your path.
+1. You must already have [Unison](http://www.cis.upenn.edu/~bcpierce/unison/) installed on your path on your host and guest machines, and it must be the same version of Unison on both.
      * On Mac you can install this with Homebrew:  `brew install unison`
-     * On Unix (Ubuntu) install using `sudo apt-get install unison`
+        * This will install unison 2.48.3
+     * On Ubuntu:
+        * [Xenial (16.04)](https://launchpad.net/ubuntu/xenial/+source/unison): `sudo apt-get install unison`
+        * Ubuntu Trusty (14.04):
+            * `sudo add-apt-repository ppa:eugenesan/ppa`
+            * `sudo apt-get update`
+            * `sudo apt-get install unison=2.48.3-1~eugenesan~trusty1`
+     * Other 64-bit Linux:
+        * Install package from `http://ftp5.gwdg.de/pub/linux/archlinux/extra/os/x86_64/unison-2.48.3-2-x86_64.pkg.tar.xz`. (Install at your own risk, this is a plain http link. If someone knows of a signed version, checksum, or https host let me know so I can update it).
      * 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. 
+1. Install using standard Vagrant 1.1+ plugin installation methods.
 ```
-$ vagrant plugin install vagrant-unison
+$ vagrant plugin install vagrant-unison2
 ```
 1. After installing, edit your Vagrantfile and add a configuration directive similar to the below:
-```
+```ruby
 Vagrant.configure("2") do |config|
   config.vm.box = "dummy"
 
+  # Required configs
   config.unison.host_folder = "src/"  #relative to the folder your Vagrantfile is in
   config.unison.guest_folder = "src/" #relative to the vagrant home folder -> /home/vagrant
-  config.unison.ignore = "Name {.DS_Store,.git,node_modules}"
+
+  # Optional configs
+  # File patterns to ignore when syncing. Ensure you don't have spaces between the commas!
+  config.unison.ignore = "Name {.DS_Store,.git,node_modules}" # Default: none
+  # SSH connection details for Vagrant to communicate with VM.
+  config.unison.ssh_host = "10.0.0.1" # Default: '127.0.0.1'
+  config.unison.ssh_port = 22 # Default: 2222
+  config.unison.ssh_user = "deploy" # Default: 'vagrant'
+  # `vagrant unison-sync-polling` command will restart unison in VM if memory usage gets above this threshold (in MB).
+  config.unison.mem_cap_mb = 500 # Default: 200
 
 end
 ```
@@ -79,6 +97,16 @@ You should run a unison-cleanup
 
 Running Unison with -ignorearchives flag is a bad idea, since it will produce conflicts.
 
+### Uncaught exception `bad bigarray kind`
+
+The error is:
+```
+Unison failed: Uncaught exception Failure("input_value: bad bigarray kind")
+```
+
+This is caused when the unison on your host and guest were compiled with different versions of ocaml. To fix ensure that
+both are compiled with the same ocaml version. [More Info Here](https://gist.github.com/pch/aa1c9c4ec8522a11193b) 
+
 ### 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.
@@ -113,7 +141,7 @@ creating a `Vagrantfile` in the top level of this directory (it is gitignored)
 that uses it, and uses bundler to execute Vagrant:
 
 ```
-$ bundle exec vagrant up 
+$ bundle exec vagrant up
 $ bundle exec vagrant unison-sync
 ```
 

data/lib/vagrant-unison2/command.rb

@@ -141,8 +141,7 @@ module VagrantPlugins
 
       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|
+        Thread.new(ssh_command.ssh, machine.config.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`
@@ -156,7 +155,7 @@ module VagrantPlugins
             # 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"
+              puts "Unison using #{mem_unison}MB memory is over limit of #{mem_cap_mb}MB, restarting"
               `#{ssh_command_text} kill -HUP #{pid} 2>/dev/null`
             end
           end

data/lib/vagrant-unison2/config.rb

@@ -23,31 +23,48 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :repeat
 
-      def initialize(region_specific=false)
-        @host_folder = UNSET_VALUE
-        @remote_folder      = UNSET_VALUE
-        @ignore      = UNSET_VALUE
-        @repeat      = UNSET_VALUE
-      end
+      # SSH host.
+      #
+      # @return [String]
+      attr_accessor :ssh_host
+
+      # SSH port.
+      #
+      # @return [String]
+      attr_accessor :ssh_port
+
+      # SSH user.
+      #
+      # @return [String]
+      attr_accessor :ssh_user
 
-      #-------------------------------------------------------------------
-      # Internal methods.
-      #-------------------------------------------------------------------
+      # Memory usage cap in MB
+      # Restart Unison in the VM when it's consuming more than this
+      # amount of memory (in MB)
+      # @return [int]
+      attr_accessor :mem_cap_mb
 
-      # def merge(other)
-      #   super.tap do |result|
-      #     # TODO - do something sensible; current last config wins
-      #     result.local_folder = other.local_folder
-      #     result.remote_folder = other.remote_folder
-      #   end
-      # end
+      def initialize(region_specific=false)
+        @host_folder   = UNSET_VALUE
+        @guest_folder  = UNSET_VALUE
+        @ignore        = UNSET_VALUE
+        @repeat        = UNSET_VALUE
+        @ssh_host      = UNSET_VALUE
+        @ssh_port      = UNSET_VALUE
+        @ssh_user      = UNSET_VALUE
+        @mem_cap_mb    = UNSET_VALUE
+      end
 
       def finalize!
         # The access keys default to nil
-        @host_folder  = nil if @host_folder  == UNSET_VALUE
-        @guest_folder = nil if @guest_folder == UNSET_VALUE
-        @ignore       = nil if @ignore       == UNSET_VALUE
-        @repeat       = 1   if @repeat       == UNSET_VALUE
+        @host_folder  = nil         if @host_folder  == UNSET_VALUE
+        @guest_folder = nil         if @guest_folder == UNSET_VALUE
+        @ignore       = nil         if @ignore       == UNSET_VALUE
+        @repeat       = 1           if @repeat       == UNSET_VALUE
+        @ssh_host     = '127.0.0.1' if @ssh_host     == UNSET_VALUE
+        @ssh_port     = 2222        if @ssh_port     == UNSET_VALUE
+        @ssh_user     = 'vagrant'   if @ssh_user     == UNSET_VALUE
+        @mem_cap_mb   = 200         if @mem_cap_mb   == UNSET_VALUE
 
         # Mark that we finalized
         @__finalized = true

data/lib/vagrant-unison2/ssh_command.rb

@@ -8,14 +8,14 @@ module VagrantPlugins
       def ssh
         %W(
           ssh
-          vagrant@127.0.0.1
+          #{@machine.config.unison.ssh_user}@#{@machine.config.unison.ssh_host}
           #{ssh_args}
         ).compact.join(' ')
       end
 
       def ssh_args
         %W(
-          -p #{@machine.ssh_info[:port]}
+          -p #{@machine.config.unison.ssh_port}
           #{proxy_command}
           -o StrictHostKeyChecking=no
           -o UserKnownHostsFile=/dev/null
@@ -24,8 +24,8 @@ module VagrantPlugins
       end
 
       def uri(unison_paths)
-        username = @machine.ssh_info[:username]
-        host = @machine.ssh_info[:host]
+        username = @machine.config.unison.ssh_user
+        host = @machine.config.unison.ssh_host
 
         "ssh://#{username}@#{host}/#{unison_paths.guest}"
       end

data/lib/vagrant-unison2/unison_sync.rb

@@ -10,7 +10,7 @@ module VagrantPlugins
 
         # Create the guest path
         machine.communicate.sudo("mkdir -p '#{guest_path}'")
-        machine.communicate.sudo("chown #{machine.ssh_info[:username]} '#{guest_path}'")
+        machine.communicate.sudo("chown #{machine.config.unison.ssh_user} '#{guest_path}'")
 
         ssh_command = SshCommand.new(machine)
         shell_command = ShellCommand.new(machine, unison_paths, ssh_command)

data/lib/vagrant-unison2/version.rb

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

metadata

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