docker-sync 0.4.6 → 0.5.0.pre.beta1

data/lib/docker-sync/environment.rb

@@ -0,0 +1,19 @@
+require 'os'
+
+module DockerSync
+  module Environment
+    def self.linux?
+      return @linux if defined? @linux
+      @linux = OS.linux?
+    end
+
+    def self.mac?
+      return @mac if defined? @mac
+      @mac = OS.mac?
+    end
+
+    def self.freebsd?
+      @freebsd ||= OS.freebsd?
+    end
+  end
+end

data/lib/docker-sync/execution.rb

@@ -2,55 +2,31 @@ require 'open3'
 require 'thor/shell'
 
 module Execution
-
   Thread.abort_on_exception = true
 
-  def threadexec(command, prefix = nil, color = nil)
-
-    if prefix.nil?
-      # TODO: probably pick the command name without args
-      prefix = 'unknown'
-    end
-
-    if color.nil?
-      color = :cyan
-    end
-
-    Thread.new {
+  def thread_exec(command, prefix = 'unknown', color = :cyan)
+    Thread.new do
       Open3.popen3(command) do |_, stdout, stderr, _|
-
         # noinspection RubyAssignmentExpressionInConditionalInspection
         while line_out = stdout.gets
-          say_status prefix, line_out, color
+          say_status with_time(prefix), line_out, color
         end
 
         # noinspection RubyAssignmentExpressionInConditionalInspection
         while line_err = stderr.gets
-          say_status prefix, line_err, :red
+          say_status with_time(prefix), line_err, :red
         end
-
       end
-    }
-
+    end
   end
 
   # unison doesn't work when ran in a new thread
   # this functions creates a full new process instead
-  def forkexec(command, prefix = nil, color = nil)
-
-    if prefix.nil?
-      # TODO: probably pick the command name without args
-      prefix = 'unknown'
-    end
-
-    if color.nil?
-      color = :cyan
-    end
-
-    Process.fork  {
-      `#{command}` || raise(command + ' failed')
-    }
-
+  def fork_exec(command, _prefix = 'unknown', _color = :cyan)
+    Process.fork  { `#{command}` || raise(command + ' failed') }
   end
 
-end
+  def with_time(prefix)
+    "[#{Time.now}] #{prefix}"
+  end
+end

data/lib/docker-sync/sync_manager.rb

@@ -4,7 +4,7 @@ require 'docker-sync/sync_process'
 # noinspection RubyResolve
 require 'docker-sync/execution'
 
-module Docker_sync
+module DockerSync
   class SyncManager
     include Thor::Shell
 
@@ -40,6 +40,13 @@ module Docker_sync
           end
         end
 
+        # set the global max_attempt setting, if the sync-endpoint does not define a own one
+        unless config.key?('max_attempt')
+          if @config_global.key?('max_attempt')
+            @config_syncs[name]['max_attempt'] = @config_global['max_attempt']
+          end
+        end
+
         if @config_syncs[name].key?('dest')
           puts 'Please do no longer use "dest" in your docker-sync.yml configuration - also see https://github.com/EugenMayer/docker-sync/wiki/1.2-Upgrade-Guide#dest-has-been-removed!'
           exit 1
@@ -118,14 +125,14 @@ module Docker_sync
           sync_process.stop
         end
 
-      rescue Exception => e
+      rescue StandardError => e
         puts "EXCEPTION: #{e.inspect}"
         puts "MESSAGE: #{e.message}"
       end
     end
 
     def create_sync(sync_name, sync_configuration)
-      sync_process = Docker_Sync::SyncProcess.new(sync_name, sync_configuration)
+      sync_process = DockerSync::SyncProcess.new(sync_name, sync_configuration)
       return sync_process
     end
 

data/lib/docker-sync/sync_process.rb

@@ -11,7 +11,7 @@ require 'docker-sync/watch_strategy/dummy'
 require 'docker-sync/watch_strategy/unison'
 require 'docker-sync/watch_strategy/remotelogs'
 
-module Docker_Sync
+module DockerSync
   class SyncProcess
     include Thor::Shell
     @options
@@ -43,13 +43,13 @@ module Docker_Sync
     def set_sync_strategy
       case @options['sync_strategy']
       when 'rsync'
-        @sync_strategy = Docker_Sync::SyncStrategy::Rsync.new(@sync_name, @options)
+        @sync_strategy = DockerSync::SyncStrategy::Rsync.new(@sync_name, @options)
       when 'unison'
-        @sync_strategy = Docker_Sync::SyncStrategy::Unison.new(@sync_name, @options)
+        @sync_strategy = DockerSync::SyncStrategy::Unison.new(@sync_name, @options)
       when 'native'
-        @sync_strategy = Docker_Sync::SyncStrategy::Native.new(@sync_name, @options)
+        @sync_strategy = DockerSync::SyncStrategy::Native.new(@sync_name, @options)
       when 'native_osx'
-        @sync_strategy = Docker_Sync::SyncStrategy::NativeOsx.new(@sync_name, @options)
+        @sync_strategy = DockerSync::SyncStrategy::NativeOsx.new(@sync_name, @options)
       else
         raise "Unknown sync_strategy #{@options['sync_strategy']}"
       end
@@ -58,29 +58,27 @@ module Docker_Sync
     def set_watch_strategy
       case @options['watch_strategy']
       when 'fswatch'
-        @watch_strategy = Docker_Sync::WatchStrategy::Fswatch.new(@sync_name, @options)
+        @watch_strategy = DockerSync::WatchStrategy::Fswatch.new(@sync_name, @options)
       when 'dummy'
-        @watch_strategy = Docker_Sync::WatchStrategy::Dummy.new(@sync_name, @options)
+        @watch_strategy = DockerSync::WatchStrategy::Dummy.new(@sync_name, @options)
       when 'unison'
-        @watch_strategy = Docker_Sync::WatchStrategy::Unison.new(@sync_name, @options)
+        @watch_strategy = DockerSync::WatchStrategy::Unison.new(@sync_name, @options)
       when 'remotelogs'
-        @watch_strategy = Docker_Sync::WatchStrategy::Remote_logs.new(@sync_name, @options)
+        @watch_strategy = DockerSync::WatchStrategy::Remote_logs.new(@sync_name, @options)
       else
         raise "Unknown watch_strategy #{@options['watch_strategy']}"
       end
     end
 
     def get_host_ip_default
-      return '127.0.0.1' if DockerSync::Preconditions::Strategy.instance.is_driver_docker_for_mac?
-
-      if DockerSync::Preconditions::Strategy.instance.is_driver_docker_toolbox?
-        cmd = 'docker-machine ip $(docker-machine active)'
-        stdout, stderr, exit_status = Open3.capture3(cmd)
-        unless exit_status.success?
-          raise "Error getting sync_host_ip automatically, exit code #{$?.exitstatus} ... #{stderr}"
-        end
-        return stdout.gsub("\n",'')
+      return '127.0.0.1' unless Dependencies::Docker::Driver.docker_toolbox?
+
+      cmd = 'docker-machine ip $(docker-machine active)'
+      stdout, stderr, exit_status = Open3.capture3(cmd)
+      unless exit_status.success?
+        raise "Error getting sync_host_ip automatically, exit code #{$?.exitstatus} ... #{stderr}"
       end
+      stdout.gsub("\n",'')
     end
 
     def run

data/lib/docker-sync/sync_strategy/native.rb

@@ -1,7 +1,6 @@
 require 'thor/shell'
-require 'docker-sync/preconditions/strategy'
 
-module Docker_Sync
+module DockerSync
   module SyncStrategy
     class Native
       include Thor::Shell
@@ -14,8 +13,8 @@ module Docker_Sync
         @options = options
 
         begin
-          DockerSync::Preconditions::Strategy.instance.docker_available
-        rescue Exception => e
+          Dependencies::Docker.ensure!
+        rescue StandardError => e
           say_status 'error', "#{@sync_name} has been configured to sync with native docker volume, but docker is not found", :red
           say_status 'error', e.message, :red
           exit 1

data/lib/docker-sync/sync_strategy/native_osx.rb

@@ -1,12 +1,11 @@
 require 'thor/shell'
-require 'docker-sync/preconditions/strategy'
 require 'docker-sync/execution'
 require 'docker-sync/update_check'
 require 'open3'
 require 'socket'
 require 'terminal-notifier'
 
-module Docker_Sync
+module DockerSync
   module SyncStrategy
     class NativeOsx
       include Thor::Shell
@@ -32,8 +31,8 @@ module Docker_Sync
         uc.check_unison_hostsync_image(true)
 
         begin
-          DockerSync::Preconditions::Strategy.instance.docker_available
-        rescue Exception => e
+          Dependencies::Docker.ensure!
+        rescue StandardError => e
           say_status 'error', "#{@sync_name} has been configured to sync with native docker volume, but docker is not found", :red
           say_status 'error', e.message, :red
           exit 1
@@ -43,10 +42,10 @@ module Docker_Sync
       def start_container
         say_status 'ok', "Starting native_osx for sync #{@sync_name}", :white
         container_name = get_container_name
-        host_sync_src = @options['src']
+        host_sync_src = File.realpath(@options['src'])
         volume_app_sync_name = @sync_name
         env = {}
-        raise 'sync_user is no longer supported, since it ise no needed, use sync_userid only please', :yellow if @options.key?('sync_user')
+        raise 'sync_user is no longer supported, since it is not needed. Use sync_userid only please' if @options.key?('sync_user')
 
         ignore_strings = expand_ignore_strings
         env['UNISON_EXCLUDES'] = ignore_strings.join(' ')
@@ -80,11 +79,12 @@ module Docker_Sync
             run_privileged = '--privileged' if @options.key?('max_inotify_watches') #TODO: replace by the minimum capabilities required
             say_status 'ok', 'Starting precopy', :white if @options['verbose']
             # we just run the precopy script and remove the container
-            cmd = "docker run --rm -v #{volume_app_sync_name}:/app_sync -v #{host_sync_src}:/host_sync#{host_disk_mount_mode} -e HOST_VOLUME=/host_sync -e APP_VOLUME=/app_sync -e TZ=${TZ-`readlink /etc/localtime | sed -e 's,/usr/share/zoneinfo/,,'`} #{additional_docker_env} #{run_privileged} --name #{container_name} #{@docker_image} /usr/local/bin/precopy_appsync"
-            `#{cmd}` || raise('Precopy failed')
+            cmd = "docker run --rm -v \"#{volume_app_sync_name}:/app_sync\" -v \"#{host_sync_src}:/host_sync#{host_disk_mount_mode}\" -e HOST_VOLUME=/host_sync -e APP_VOLUME=/app_sync -e TZ=${TZ-`readlink /etc/localtime | sed -e 's,/usr/share/zoneinfo/,,'`} #{additional_docker_env} #{run_privileged} --name #{container_name} #{@docker_image} /usr/local/bin/precopy_appsync"
+            say_status 'precopy', cmd, :white if @options['verbose']
+            system(cmd) || raise('Precopy failed')
             say_status 'ok', 'Starting container', :white if @options['verbose']
             # this will be run below and start unison, since we did not manipulate CMD
-            cmd = "docker run -d -v #{volume_app_sync_name}:/app_sync -v #{host_sync_src}:/host_sync -e HOST_VOLUME=/host_sync -e APP_VOLUME=/app_sync -e TZ=${TZ-`readlink /etc/localtime | sed -e 's,/usr/share/zoneinfo/,,'`} #{additional_docker_env} #{run_privileged} --name #{container_name} #{@docker_image}"
+            cmd = "docker run -d -v \"#{volume_app_sync_name}:/app_sync\" -v \"#{host_sync_src}:/host_sync#{host_disk_mount_mode}\" -e HOST_VOLUME=/host_sync -e APP_VOLUME=/app_sync -e TZ=${TZ-`readlink /etc/localtime | sed -e 's,/usr/share/zoneinfo/,,'`} #{additional_docker_env} #{run_privileged} --name #{container_name} #{@docker_image}"
           else
             say_status 'ok', "starting #{container_name} container", :white if @options['verbose']
             cmd = "docker start #{container_name} && docker exec #{container_name} supervisorctl restart unison"
@@ -94,7 +94,7 @@ module Docker_Sync
           cmd = "docker exec #{container_name} supervisorctl restart unison"
         end
         say_status 'command', cmd, :white if @options['verbose']
-        `#{cmd}` || raise('Start failed')
+        system(cmd) || raise('Start failed')
         say_status 'ok', "starting initial sync of #{container_name}", :white if @options['verbose']
         # wait until container is started, then sync:
         say_status 'success', 'Sync container started', :green
@@ -122,7 +122,7 @@ module Docker_Sync
         say_status 'ok', "Stopping sync container #{get_container_name}"
         begin
           stop_container
-        rescue Exception => e
+        rescue StandardError => e
           say_status 'error', "Stopping failed of #{get_container_name}:", :red
           puts e.message
         end

data/lib/docker-sync/sync_strategy/rsync.rb

@@ -1,8 +1,7 @@
 require 'thor/shell'
-require 'docker-sync/preconditions/strategy'
 require 'terminal-notifier'
 
-module Docker_Sync
+module DockerSync
   module SyncStrategy
     class Rsync
       include Thor::Shell
@@ -22,8 +21,8 @@ module Docker_Sync
         end
 
         begin
-          DockerSync::Preconditions::Strategy.instance.rsync_available
-        rescue Exception => e
+          Dependencies::Rsync.ensure!
+        rescue StandardError => e
           say_status 'error', "#{@sync_name} has been configured to sync with rsync, but no rsync or fswatch binary available", :red
           say_status 'error', e.message, :red
           exit 1
@@ -97,8 +96,9 @@ module Docker_Sync
 
             user_mapping = get_user_mapping
             group_mapping = get_group_mapping
+            docker_env = get_docker_env
 
-            cmd = "docker run -p '#{@options['sync_host_port']}:873' -v #{volume_name}:#{@options['dest']} #{user_mapping} #{group_mapping} -e VOLUME=#{@options['dest']} -e TZ=${TZ-`readlink /etc/localtime | sed -e 's,/usr/share/zoneinfo/,,'`} --name #{container_name} -d #{@docker_image}"
+            cmd = "docker run -p '#{@options['sync_host_port']}:873' -v #{volume_name}:#{@options['dest']} #{user_mapping} #{group_mapping} #{docker_env} --name #{container_name} -d #{@docker_image}"
           else # container already created, just start / reuse it
             say_status 'ok', "starting #{container_name} container", :white if @options['verbose']
             cmd = "docker start #{container_name}"
@@ -126,12 +126,20 @@ module Docker_Sync
       def get_group_mapping
         group_mapping = ''
         if @options.key?('sync_groupid')
-          raise 'for now, rsync does no longer support groupid, but for nearly all cases sync_userid should be enaugh'
+          raise 'for now, rsync does no longer support groupid, but for nearly all cases sync_userid should be enough'
           #group_mapping = "#{group_mapping} -e GROUP_ID=#{@options['sync_groupid']}"
         end
         return group_mapping
       end
 
+      def get_docker_env
+        env_mapping = []
+        env_mapping << "-e VOLUME=#{@options['dest']}"
+        env_mapping << "-e TZ=${TZ-`readlink /etc/localtime | sed -e 's,/usr/share/zoneinfo/,,'`}"
+        env_mapping << "-e ALLOW=#{@options['sync_host_allow']}" if @options['sync_host_allow']
+        env_mapping.join(' ')
+      end
+
       def stop_container
         `docker ps | grep #{get_container_name} && docker stop #{get_container_name}`
       end
@@ -150,7 +158,7 @@ module Docker_Sync
         say_status 'ok', "Stopping sync container #{get_container_name}"
         begin
           stop_container
-        rescue Exception => e
+        rescue StandardError => e
           say_status 'error', "Stopping failed of #{get_container_name}:", :red
           puts e.message
         end

data/lib/docker-sync/sync_strategy/unison.rb

@@ -1,11 +1,10 @@
 require 'thor/shell'
-require 'docker-sync/preconditions/strategy'
 require 'docker-sync/execution'
 require 'open3'
 require 'socket'
 require 'terminal-notifier'
 
-module Docker_Sync
+module DockerSync
   module SyncStrategy
     class Unison
       include Thor::Shell
@@ -26,8 +25,8 @@ module Docker_Sync
           @docker_image = 'eugenmayer/unison'
         end
         begin
-          DockerSync::Preconditions::Strategy.instance.unison_available
-        rescue Exception => e
+          Dependencies::Unison.ensure!
+        rescue StandardError => e
           say_status 'error', "#{@sync_name} has been configured to sync with unison, but no unison available", :red
           say_status 'error', e.message, :red
           exit 1
@@ -67,7 +66,7 @@ module Docker_Sync
         cmd = cmd + 'unison ' + args.join(' ')
 
         say_status 'command', cmd, :white if @options['verbose']
-        forkexec(cmd, "Sync #{@sync_name}", :blue)
+        fork_exec(cmd, "Sync #{@sync_name}", :blue)
       end
 
       def sync
@@ -135,9 +134,9 @@ module Docker_Sync
       def sync_prefer
         case @options.fetch('sync_prefer', 'default')
           when 'default' then "-prefer '#{@options['src']}' -copyonconflict" # thats our default, if nothing is set
-          when 'src' then "-prefer #{@options['src']}"
-          when 'dest' then "-prefer #{@options['dest']}"
-          else "-prefer #{@options['sync_prefer']}"
+          when 'src' then "-prefer '#{@options['src']}'"
+          when 'dest' then "-prefer '#{@options['dest']}'"
+          else "-prefer '#{@options['sync_prefer']}'"
         end
       end
 
@@ -165,6 +164,7 @@ module Docker_Sync
           exists = `docker ps --filter "status=exited" --filter "name=#{container_name}" --format "{{.Names}}" | grep '^#{container_name}$'`
           if exists == ''
             say_status 'ok', "creating #{container_name} container", :white if @options['verbose']
+            run_privileged = ''
             run_privileged = '--privileged' if @options.key?('max_inotify_watches') #TODO: replace by the minimum capabilities required
             cmd = "docker run -p '#{@options['sync_host_ip']}::#{UNISON_CONTAINER_PORT}' -v #{volume_name}:#{@options['dest']} -e VOLUME=#{@options['dest']} -e TZ=${TZ-`readlink /etc/localtime | sed -e 's,/usr/share/zoneinfo/,,'`} #{additional_docker_env} #{run_privileged} --name #{container_name} -d #{@docker_image}"
           else
@@ -185,22 +185,23 @@ module Docker_Sync
         attempt = 0
         max_attempt = @options['max_attempt'] || 5
         loop do
+          # noinspection RubyUnusedLocalVariable
           stdout, stderr, exit_status = Open3.capture3(cmd)
           break if exit_status == 0
           attempt += 1
-          raise 'Failed to start unison container in time, try to increase max_attempt in your configuration. See https://github.com/EugenMayer/docker-sync/wiki/2.-Configuration for more informations' if attempt > max_attempt
+          raise "Failed to start unison container in time, try to increase max_attempt (currently #{max_attempt}) in your configuration. See https://github.com/EugenMayer/docker-sync/wiki/2.-Configuration for more informations" if attempt > max_attempt
           sleep 1
         end
         sync
         say_status 'success', 'Unison server started', :green
       end
 
+      # noinspection RubyUnusedLocalVariable
       def get_host_port(container_name, container_port)
-        File.exist?('/usr/bin/sed') ? sed = '/usr/bin/sed' : sed = `which sed`.chomp # use macOS native sed in /usr/bin/sed first, fallback to sed in $PATH if it's not there
         cmd = 'docker inspect --format=\'{{(index (index .NetworkSettings.Ports "5000/tcp") 0).HostPort}}\' ' + container_name
         say_status 'command', cmd, :white if @options['verbose']
         stdout, stderr, exit_status = Open3.capture3(cmd)
-        if not exit_status.success?
+        unless exit_status.success?
           say_status 'command', cmd
           say_status 'error', "Error getting mapped port, exit code #{$?.exitstatus}", :red
           say_status 'message', stderr
@@ -234,7 +235,7 @@ module Docker_Sync
         say_status 'ok', "Stopping sync container #{get_container_name}"
         begin
           stop_container
-        rescue Exception => e
+        rescue StandardError => e
           say_status 'error', "Stopping failed of #{get_container_name}:", :red
           puts e.message
         end

data/lib/docker-sync/update_check.rb

@@ -13,6 +13,7 @@ class UpdateChecker
   end
 
   def run
+    return if ENV['DOCKER_SYNC_SKIP_UPDATE']
     unless @config['update_check']
       say_status 'hint','Skipping up-to-date check since it has been disabled in your ~/.docker-sync-global.yml configuration',:yellow
       return
@@ -56,6 +57,7 @@ class UpdateChecker
   end
 
   def check_rsync_image
+    return if ENV['DOCKER_SYNC_SKIP_UPDATE']
     say_status 'ok','Checking if a newer rsync image is available'
 
     if system("docker pull eugenmayer/rsync | grep 'Downloaded newer image for'")
@@ -68,6 +70,7 @@ class UpdateChecker
   end
 
   def check_unison_hostsync_image(silent = false)
+    return if ENV['DOCKER_SYNC_SKIP_UPDATE']
     say_status 'ok','Checking if a newer native_osx (unison:hostsync_0.2) image is available' unless silent
 
     if system("docker pull eugenmayer/unison:hostsync_0.2 | grep 'Downloaded newer image for'")
@@ -80,6 +83,7 @@ class UpdateChecker
   end
 
   def check_unison_image
+    return if ENV['DOCKER_SYNC_SKIP_UPDATE']
     say_status 'ok','Checking if a newer unison image is available'
 
     if system("docker pull eugenmayer/unison | grep 'Downloaded newer image for'")
@@ -104,6 +108,7 @@ class UpdateChecker
   end
 
   def check_and_warn(update_enforced = true)
+    return if ENV['DOCKER_SYNC_SKIP_UPDATE']
     # update the timestamp
     @config.update! 'update_last_check' => DateTime.now.iso8601(9)