vagrant-unison2 1.2.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1a063b4601b5928a533c46d120bbf4cb7ba55ec
-  data.tar.gz: 2394dcb6b9be96e96def0eb797961e2c78b5b571
+  metadata.gz: ed6f4a0aff6d665d92570db31cbf86bd6b4a90c8
+  data.tar.gz: 6406f1e1242035d1cd69eb8677da1883edb01e71
 SHA512:
-  metadata.gz: 584554bbfcd84e1f7fa1b2f54536f9635388e4b22cfd8d751d2753c5994445e911a92024e0cc3387e6e08eaa46bbb8181222961005ae3c6cc252fe1b2432a9bf
-  data.tar.gz: 133b1bff2cefb725c5bd1a3600b397b18078576660426abbe50d25e3addd04dfcbcad9a83ffac6176657814c62e913593ef768158d2e8b0784d8f52dca974d89
+  metadata.gz: c6eae3bfd496db045c71d466f784313c5f0c9db7b340c2c6d87733336427004baf12ba6dfd38bc8c2dbbd08feccd82f2fde91e6c215188b0c49560e5fe9d565f
+  data.tar.gz: 2396282604d87889dccee06dace63950a76733e20e86f3f5587c890087d774a2806540d8b3cd8b13c8591629c78a603de91a9e438a30e27708b9945166953b47

data/README.md

@@ -19,10 +19,10 @@ to your Vagrant VM (local or on AWS).  Under the covers it uses [Unison](http://
         * 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`
+            * `sudo apt-get install unison=2.48.3-1ubuntu1.02~eugenesan~trusty2`
      * 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.
+     * On Windows, download [2.48.3](http://www.pps.univ-paris-diderot.fr/~vouillon/unison/unison 2.48.3.zip), unzip, rename `unison-2.48.3 text.exe` to `unison.exe` and copy to somewhere in your path. Alternatively, install [using Chocolatey](https://chocolatey.org/packages/unison).
 
 2. Install using standard Vagrant 1.1+ plugin installation methods.
     * `vagrant plugin install vagrant-unison2`
@@ -44,15 +44,19 @@ to your Vagrant VM (local or on AWS).  Under the covers it uses [Unison](http://
     # 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'
     config.unison.perms = 0 # if you get "properties changed on both sides" error 
+
     # `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
 
+    # Change polling interval (in seconds) at which to sync changes
+    config.unison.repeat = 5 # Default: 1
   end
   ```
 

data/lib/vagrant-unison2/command.rb

@@ -1,7 +1,6 @@
 require "log4r"
 require "vagrant"
 require "thread"
-require 'listen'
 
 require_relative 'unison_paths'
 require_relative 'ssh_command'
@@ -10,76 +9,15 @@ require_relative 'unison_sync'
 
 module VagrantPlugins
   module Unison
-    class Command < Vagrant.plugin("2", :command)
+    class CommandOnce < Vagrant.plugin("2", :command)
       include UnisonSync
 
-      def execute
-        with_target_vms do |machine|
-          paths = UnisonPaths.new(@env, machine)
-          host_path = paths.host
-
-          sync(machine, paths)
-
-          @env.ui.info "Watching #{host_path} for changes..."
-
-          listener = Listen.to(host_path) do |modified, added, removed|
-            @env.ui.info "Detected modifications to #{modified.inspect}" unless modified.empty?
-            @env.ui.info "Detected new files #{added.inspect}" unless added.empty?
-            @env.ui.info "Detected deleted files #{removed.inspect}" unless removed.empty?
-
-            sync(machine, paths)
-          end
-
-          queue = Queue.new
-
-          callback = lambda do
-            # This needs to execute in another thread because Thread
-            # synchronization can't happen in a trap context.
-            Thread.new { queue << true }
-          end
-
-          # Run the listener in a busy block so that we can cleanly
-          # exit once we receive an interrupt.
-          Vagrant::Util::Busy.busy(callback) do
-            listener.start
-            queue.pop
-            listener.stop if listener.paused? || listener.processing?
-          end
-        end
-
-        0
+      def self.synopsis
+        "sync the unison shared folder once"
       end
 
-      def sync(machine, paths)
-        execute_sync_command(machine) do |command|
-          command.batch = true
-
-          @env.ui.info "Running #{command.to_s}"
-
-          r = Vagrant::Util::Subprocess.execute(*command.to_a)
-
-          case r.exit_code
-          when 0
-            @env.ui.info "Unison completed succesfully"
-          when 1
-            @env.ui.info "Unison completed - all file transfers were successful; some files were skipped"
-          when 2
-            @env.ui.info "Unison completed - non-fatal failures during file transfer: #{r.stderr}"
-          else
-            raise Vagrant::Errors::UnisonError,
-              :command => command.to_s,
-              :guestpath => paths.guest,
-              :hostpath => paths.host,
-              :stderr => r.stderr
-          end
-        end
-      end
-    end
-
-    class CommandOnce < Vagrant.plugin("2", :command)
-      include UnisonSync
-
       def execute
+        status = nil
         with_target_vms do |machine|
           execute_sync_command(machine) do |command|
             command.batch = true
@@ -89,11 +27,15 @@ module VagrantPlugins
             @env.ui.info "Running unison once"
             @env.ui.info "    #{command}"
 
-            system(command)
+            status = system(command)
+            @env.ui.info "**** unison exited. success: #{status} ****"
           end
         end
-
-        0
+        if status
+          return 0
+        else
+          return 1
+        end
       end
     end
 
@@ -101,10 +43,14 @@ module VagrantPlugins
       include UnisonSync
       attr_accessor :bg_thread
 
+      def self.synopsis
+        "sync the unison shared folder forever, by polling for changes"
+      end
+
       def execute
+        status = nil
         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
@@ -122,7 +68,8 @@ module VagrantPlugins
               begin
                 sleep 2 if exit_on_next_sigint
                 exit_on_next_sigint = false
-                system(command)
+                status = system(command)
+                @env.ui.info "**** unison exited. success: #{status} ****"
               rescue Interrupt
                 if exit_on_next_sigint
                   Thread.kill(@bg_thread) if @bg_thread
@@ -136,7 +83,11 @@ module VagrantPlugins
             end
           end
         end
-        0
+        if status
+          return 0
+        else
+          return 1
+        end
       end
 
       def watch_vm_for_memory_leak(machine)
@@ -145,7 +96,9 @@ module VagrantPlugins
           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`
+            _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
@@ -164,7 +117,9 @@ module VagrantPlugins
     end
 
     class CommandCleanup < Vagrant.plugin("2", :command)
-      include UnisonSync
+      def self.synopsis
+        "remove all unison supporting state on local and remote system"
+      end
 
       def execute
         with_target_vms do |machine|
@@ -190,6 +145,10 @@ module VagrantPlugins
     class CommandInteract < Vagrant.plugin("2", :command)
       include UnisonSync
 
+      def self.synopsis
+        "run unison in interactive mode, to resolve conflicts"
+      end
+
       def execute
         with_target_vms do |machine|
           execute_sync_command(machine) do |command|

data/lib/vagrant-unison2/config.rb

@@ -15,7 +15,7 @@ module VagrantPlugins
 
       # Pattern of files to ignore.
       #
-      # @return [String]
+      # @return [String, Array<String>]
       attr_accessor :ignore
 
       # Repeat speed.
@@ -49,7 +49,13 @@ module VagrantPlugins
       # @return [int]
       attr_accessor :perms
 
-      def initialize(region_specific=false)
+      # Airlab-specific config option to leave off the Vagrant identity file, so
+      # SSH will just use ssh-agent
+      #
+      # @return [Boolean]
+      attr_accessor :ssh_use_agent
+
+      def initialize(region_specific = false)
         @host_folder   = UNSET_VALUE
         @guest_folder  = UNSET_VALUE
         @ignore        = UNSET_VALUE
@@ -57,6 +63,7 @@ module VagrantPlugins
         @ssh_host      = UNSET_VALUE
         @ssh_port      = UNSET_VALUE
         @ssh_user      = UNSET_VALUE
+        @ssh_use_agent = UNSET_VALUE
         @mem_cap_mb    = UNSET_VALUE
         @perms         = UNSET_VALUE
       end
@@ -72,6 +79,7 @@ module VagrantPlugins
         @ssh_user     = 'vagrant'   if @ssh_user     == UNSET_VALUE
         @mem_cap_mb   = 200         if @mem_cap_mb   == UNSET_VALUE
         @perms        = nil         if @perms        == UNSET_VALUE
+        @ssh_use_agent = false      if @ssh_use_agent == UNSET_VALUE
 
         # Mark that we finalized
         @__finalized = true

data/lib/vagrant-unison2/plugin.rb

@@ -16,7 +16,7 @@ module VagrantPlugins
       name "Unison"
       description <<-DESC
       This plugin syncs files over SSH from a local folder
-      to your Vagrant VM (local or on AWS). 
+      to your Vagrant VM (local or on AWS).
       DESC
 
       config "unison" do
@@ -24,16 +24,6 @@ module VagrantPlugins
         Config
       end
 
-      command "unison-sync" do
-        # Setup logging and i18n
-        setup_logging
-        setup_i18n
-
-        #Return the command
-        require_relative "command"
-        Command
-      end
-
       command "unison-sync-once" do
         setup_logging
         setup_i18n

data/lib/vagrant-unison2/shell_command.rb

@@ -1,13 +1,15 @@
 module VagrantPlugins
   module Unison
     class ShellCommand
-      def initialize machine, unison_paths, ssh_command
+      def initialize(machine, unison_paths, ssh_command)
         @machine = machine
         @unison_paths = unison_paths
         @ssh_command = ssh_command
       end
 
       attr_accessor :batch, :repeat, :terse
+      attr_accessor :force_remote, :force_local
+      attr_accessor :prefer_remote, :prefer_local
 
       def to_a
         args.map do |arg|
@@ -25,24 +27,47 @@ module VagrantPlugins
       def args
         _args = [
           'unison',
-          @unison_paths.host,
-          @ssh_command.uri(@unison_paths),
+          local_root_arg,
+          remote_root_arg,
           batch_arg,
           terse_arg,
           repeat_arg,
           ignore_arg,
           perms_arg,
-          ['-sshargs', %("#{@ssh_command.ssh_args}")],
+          force_arg,
+          prefer_arg,
+          ssh_args,
         ].flatten.compact
         _args
       end
 
+      def local_root_arg
+        @unison_paths.host
+      end
+
+      def remote_root_arg
+        @ssh_command.uri(@unison_paths)
+      end
+
+      def ssh_args
+        ['-sshargs', %("#{@ssh_command.ssh_args}")]
+      end
+
       def batch_arg
         '-batch' if batch
       end
 
       def ignore_arg
-        ['-ignore', %("#{@machine.config.unison.ignore}")] if @machine.config.unison.ignore
+        patterns = []
+        if @machine.config.unison.ignore.is_a? ::Array
+          patterns += @machine.config.unison.ignore
+        elsif @machine.config.unison.ignore
+          patterns << @machine.config.unison.ignore
+        end
+
+        patterns.map do |pattern|
+          ['-ignore', %("#{pattern}")]
+        end
       end
 
       def perms_arg
@@ -56,6 +81,37 @@ module VagrantPlugins
       def terse_arg
         '-terse' if terse
       end
+
+      # from the docs:
+      #
+      # Including the preference  -force root causes Unison to resolve all
+      # differences (even non-conflicting changes) in favor of root. This
+      # effectively changes Unison from a synchronizer into a mirroring
+      # utility. You can also specify -force newer (or  -force older) to force
+      # Unison to choose the file with the later (earlier) modtime. In this
+      # case, the  -times preference must also be enabled. This preference is
+      # overridden by the forcepartial preference. This preference should be
+      # used only if you are sure you know what you are doing!
+      #
+      # soo. I'm not sure if I know what I'm doing. Need to make sure that this
+      # doesn't end up deleting .git or some other ignored but critical
+      # directory.
+      def force_arg
+        return ['-force', local_root_arg] if force_local
+        return ['-force', remote_root_arg] if force_remote
+      end
+
+      # from the docs, via Daniel Low (thx daniel):
+      #
+      # Including the preference -prefer root causes Unison always to resolve
+      # conflicts in favor of root, rather than asking for guidance from the
+      # user.
+      #
+      # This is much safer than -force
+      def prefer_arg
+        return ['-prefer', local_root_arg] if prefer_local
+        return ['-prefer', remote_root_arg] if prefer_remote
+      end
     end
   end
 end

data/lib/vagrant-unison2/ssh_command.rb

@@ -19,8 +19,7 @@ module VagrantPlugins
           #{proxy_command}
           -o StrictHostKeyChecking=no
           -o UserKnownHostsFile=/dev/null
-          -o IdentitiesOnly=yes
-          #{key_paths}
+          #{identity}
         ).compact.join(' ')
       end
 
@@ -39,8 +38,16 @@ module VagrantPlugins
         "-o ProxyCommand='#{command}'"
       end
 
+      def identity
+        if @machine.config.unison.ssh_use_agent
+          ''
+        else
+          (%w(-o IdentitiesOnly=yes) <<  key_paths).join(' ')
+        end
+      end
+
       def key_paths
-        @machine.ssh_info[:private_key_path].map { |p| "-i #{p}" }.join(' ')
+        @machine.ssh_info[:private_key_path].map { |p| "-i #{p.shellescape}" }.join(' ')
       end
     end
   end

data/lib/vagrant-unison2/unison_sync.rb

@@ -1,7 +1,12 @@
+require "optparse"
+
 module VagrantPlugins
   module Unison
+    # mixin providing common functionality for our vagrant commands
     module UnisonSync
       def execute_sync_command(machine)
+        parse_options!
+
         unison_paths = UnisonPaths.new(@env, machine)
         guest_path = unison_paths.guest
         host_path = unison_paths.host
@@ -15,8 +20,78 @@ module VagrantPlugins
         ssh_command = SshCommand.new(machine)
         shell_command = ShellCommand.new(machine, unison_paths, ssh_command)
 
+        shell_command.prefer_local = options[:prefer_local]
+        shell_command.prefer_remote = options[:prefer_remote]
+        shell_command.force_local = options[:force_local]
+        shell_command.force_remote = options[:force_remote]
+
         yield shell_command
       end
+
+      def parse_options!
+        # parse_options(option_parser) is provided by vagrant, but
+        # documentation is scarse. Best way to view the docs (imo) is to put
+        # a binding.pry in here and then type `? parse_options`
+        @parsed_argv ||= parse_options(options_parser)
+
+        if options[:verbose]
+          @env.ui.info "Options: #{options}"
+        end
+
+        # According to the docs:
+        # > If parse_options returns `nil`, then you should assume that
+        # > help was printed and parsing failed.
+        if @parsed_argv == nil
+          exit 1
+        end
+      end
+
+      def options
+        @options ||= {
+          :prefer_local => false,
+          :prefer_remote => false,
+          :force_local => false,
+          :force_remote => false,
+          :verbose => false,
+        }
+      end
+
+      def options_parser
+        @option_parser ||= OptionParser.new do |o|
+          o.banner = "Usage: vagrant #{ARGV[0]} [options]"
+
+          o.on('--push', 'prefer changes on the local machine.') do |flag|
+            options[:prefer_local] = flag
+            check_conflicting_options!
+          end
+
+          o.on('--pull', 'prefer changes on the remote machine.') do |flag|
+            options[:prefer_remote] = flag
+            check_conflicting_options!
+          end
+
+          o.on('--force-push', 'force-push changes to the remote machine. Dangerous!') do |flag|
+            options[:force_local] = flag
+            check_conflicting_options!
+          end
+
+          o.on('--force-pull', 'force-pull changes from the remote machine. Super dangerous!') do |flag|
+            options[:force_remote] = flag
+            check_conflicting_options!
+          end
+
+          o.on('--verbose', 'Print additional debug information') do |flag|
+            options[:verbose] = flag
+          end
+        end
+      end
+
+      def check_conflicting_options!
+        enabled = [:prefer_local, :prefer_remote, :force_local, :force_remote].select do |opt|
+          options[opt]
+        end
+        raise ArgumentError.new("Conflicting options: #{enabled.inspect}") if enabled.length > 1
+      end
     end
   end
 end

data/lib/vagrant-unison2/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Unison
-    VERSION = "1.2.4"
+    VERSION = "2.0.0"
   end
 end

data/vagrant-unison2.gemspec

@@ -13,9 +13,6 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = ">= 1.3.6"
 
-  s.add_runtime_dependency "listen", ">= 2.8.0"
-  s.add_runtime_dependency "rb-fsevent", "~> 0.9"
-
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec-core", "~> 2.12.2"
   s.add_development_dependency "rspec-expectations", "~> 2.12.1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-unison2
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 2.0.0
 platform: ruby
 authors:
 - David Laing
@@ -10,36 +10,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-22 00:00:00.000000000 Z
+date: 2016-09-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: listen
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.8.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.8.0
-- !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement