docker-sync 0.1.5 → 0.2.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25a78699ee82484750b206b8a01c8dc9d6321a3c
-  data.tar.gz: a03a06fd88f5b1f396e5cdd51423a3608b4761c2
+  metadata.gz: 94abd2200815b1114719e58149b90ecf713ff5ee
+  data.tar.gz: f3e8d3f36eaf2046aa0f664670659aba57265e19
 SHA512:
-  metadata.gz: b83b63b54356843e661d5f29aa819d53a0fbf2661f6e51bd5513530ed5c3a01683afd8f4abac2f332d3685bebcce93cda2817feddcc9c7a019370162fa26af19
-  data.tar.gz: bfd090b4b29ce2be0b875ba66ab31764c92e9a6e70fd104d7282e40b6b4c0c806bba17cc66df4994f869127a96f8ed70afe0f73e486b69b4c83100387aa87efe
+  metadata.gz: dc26e58c0a5641cd7aadb5fd6af54a07cfb7b6e3760d0f71782aae7d83273ceadfd4cbc6b8f58e396aaeda64d53f8d951c30c02a172d610fb1a9178425b3aabc
+  data.tar.gz: bad573788249515c63475299b2058b38240589ae27fce69e1ce9396729d22a6db5ea4da957dbee6932a08aae2c22b2572af088e464fb09538be8b479a7f1ec51

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.2.0.beta5

data/bin/docker-sync-daemon

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+file = File.expand_path(File.dirname(file))
+$LOAD_PATH.unshift File.expand_path('../lib', file)
+
+require 'thor'
+require 'docker-sync/update_check'
+
+thor = File.expand_path('../tasks/daemon', file)
+Dir.glob(File.join(thor, '/**/*.thor')).each { |taskfile|
+  load taskfile
+}
+thor = File.expand_path('../tasks/sync', file)
+Dir.glob(File.join(thor, '/**/*.thor')).each { |taskfile|
+  load taskfile
+}
+
+Daemon.start

data/bin/docker-sync-stack

@@ -3,20 +3,9 @@ file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
 file = File.expand_path(File.dirname(file))
 $LOAD_PATH.unshift File.expand_path('../lib', file)
 
-
 require 'thor'
 require 'docker-sync/update_check'
 
-# TODO: remove this later, not longer needed
-#begin
-#  gem 'docker-compose'
-#rescue Gem::LoadError
-#  puts "docker-compose gem is missing, installing 'gem install docker-compose'"
-#  system('gem install docker-compose')
-#  puts 'docker-compose ruby gem installed, please start docker-sync-stack again'
-#  exit 0
-#end
-
 thor = File.expand_path('../tasks/stack', file)
 Dir.glob(File.join(thor, '/**/*.thor')).each { |taskfile|
   # noinspection RubyResolve

data/lib/docker-sync/compose.rb

@@ -10,22 +10,15 @@ class ComposeManager
     ### production docker-compose.yml
     compose_files = [File.expand_path('docker-compose.yml')]
     if @global_options.key?('compose-file-path')
-      path = File.expand_path(@global_options['compose-file-path'])
-      unless File.exist?(path)
-        raise("Your referenced docker-compose file in docker-sync.yml was not found at #{@global_options['compose-file-path']}")
-      end
-      compose_files = [path]  # replace
+      compose_files = [] # replace
+      apply_path_settings(compose_files, @global_options['compose-file-path'], 'compose-file-path')
     end
 
     ### development docker-compose-dev.yml
     if @global_options.key?('compose-dev-file-path')
       # explicit path given
-      path = File.expand_path(@global_options['compose-dev-file-path'])
-      unless File.exist?(path)
-        raise("Your referenced docker-compose-dev file in docker-sync.yml was not found at #{@global_options['compose-dev-file-path']}")
-      end
+      apply_path_settings(compose_files, @global_options['compose-dev-file-path'], 'compose-dev-file-path')
       say_status 'ok',"Found explicit docker-compose-dev.yml and using it from #{@global_options['compose-dev-file-path']}", :green
-      compose_files.push path  # add
     else
       # try to find docker-compose-dev.yml
       e = compose_files.to_enum
@@ -44,9 +37,9 @@ class ComposeManager
     say_status 'ok','starting compose',:green
     options = Hash.new
     if @global_options['compose-force-build']
-      options['build'] = true
+      options[:build] = true
     end
-    @compose_session.up(options)
+    @compose_session.up(**options)
   end
 
   def stop
@@ -56,4 +49,28 @@ class ComposeManager
   def clean
     @compose_session.down
   end
+
+  protected
+    def apply_path_settings(compose_files, settings, error_key)
+      if settings.kind_of?(Array)
+        apply_filepaths(compose_files, settings, error_key)
+      else
+        apply_filepath(compose_files, settings, error_key)
+      end
+    end
+
+  private
+    def apply_filepath(array, filepath, error_key)
+      path = File.expand_path(filepath)
+      unless File.exist?(path)
+        raise("Your referenced docker-compose file in docker-sync.yml was not found at #{error_key}")
+      end
+      array.push path
+    end
+
+    def apply_filepaths(array, filepath_array, error_key)
+      filepath_array.each do |filepath|
+        apply_filepath(array, filepath, error_key)
+      end
+    end
 end

data/lib/docker-sync/config.rb

@@ -1,9 +1,16 @@
 require 'pp'
 require 'pathname'
 require 'yaml'
-# this has basically completely reused from Thor::runner.rb - thank you!
+require 'dotenv'
+require 'docker-sync/config_template'
 
+# this has basically completely reused from Thor::runner.rb - thank you!
 module DockerSyncConfig
+
+  def initialize(options)
+    Dotenv.load
+  end
+
   def self.global_config_location
     return File.expand_path('~/.docker-sync-global.yml')
   end
@@ -19,7 +26,7 @@ module DockerSyncConfig
     # noinspection RubyStringKeysInHashInspection
     defaults = {'update_check'=>true, 'update_last_check' => date.iso8601(9), 'update_enforce' => true}
     if File.exist?(global_config_path)
-      config =  YAML.load_file(global_config_path)
+      config = ConfigTemplate::interpolate_config_file(global_config_path)
       config = defaults.merge(config)
       return config
     else
@@ -32,13 +39,32 @@ module DockerSyncConfig
     File.open(global_config_path, 'w') {|f| f.write config.to_yaml }
   end
 
+
+  def self.project_required_config_version
+    return '2'
+  end
+
+  def self.project_ensure_configuration_version_compatibility(config)
+    return false unless config.key?('version')
+    return false if config['version'].to_s != project_required_config_version.to_s
+    return true
+  end
+
   def self.project_config_path
     files = project_config_find
     if files.length > 0
-      return files.pop
+      path =  files.pop
     else
       raise('No docker-sync.yml configuration found in your path ( traversing up ) Did you define it for your project?')
     end
+
+    begin
+      config = YAML.load_file(path)
+      raise "Version of docker-sync.yml does not match the reqiured one" unless project_ensure_configuration_version_compatibility(config)
+    rescue Exception => e
+      raise "You docker-sync.yml file does either not include a version: \"#{project_required_config_version}\" setting or your setting (#{config['version']}) does not match the required version (#{project_required_config_version}). (Add this if you migrated from docker-sync 0.1.x)"
+    end
+    return path
   end
 
   # this has been ruthlessly stolen from Thor/runner.rb - please do not hunt me for that :)

data/lib/docker-sync/config_template.rb

@@ -0,0 +1,14 @@
+require "yaml"
+require 'dotenv'
+
+module ConfigTemplate
+  def self.interpolate_config_file(config_path)
+      env_hash = {}
+      ENV.each {|k,v| env_hash[k.to_sym] = v }
+      # assuming the checks that file exist have already been performed
+      config_string = File.read(config_path)
+      config_string.gsub!('${', '%{')
+      config_string = config_string % env_hash
+      return YAML.load(config_string)
+  end
+end

data/lib/docker-sync/preconditions.rb

@@ -4,7 +4,9 @@ module Preconditions
   def self.check_all_preconditions
     docker_available
     docker_running
-    fswatch_available
+    unison_available
+    unox_available
+    macfsevents_available
   end
 
   def self.docker_available
@@ -48,21 +50,52 @@ module Preconditions
     if (find_executable0 'unison-fsmonitor').nil?
       cmd1 = 'curl "https://raw.githubusercontent.com/hnsl/unox/master/unox.py" -o "/usr/local/bin/unison-fsmonitor" \
       && chmod +x /usr/local/bin/unison-fsmonitor'
-      cmd2 = 'sudo easy_install pip && sudo pip install macfsevents'
-      Thor::Shell::Basic.new.say_status 'warning', 'Could not find unison-fsmonitor (for file watching) binary in $PATH. Please install unox before you continue, see https://github.com/hnsl/unox.', :yellow
-      if Thor::Shell::Basic.new.yes?('Shall I install unison-fsmonitor for you? ')
+
+      Thor::Shell::Basic.new.say_status 'warning', 'Could not find unison-fsmonitor (for file watching) binary in $PATH. We try to install unox now (for manual instracutions see https://github.com/hnsl/unox.)', :red
+      if Thor::Shell::Basic.new.yes?('Shall I install unison-fsmonitor for you? (y/N)')
         system cmd1
-        if $?.exitstatus > 0
-          raise('Failed to install unison-fsmonitor, please file an issue with the output of the error')
-        end
-        Thor::Shell::Basic.new.say_status 'ok','install macfsevents using pip (This will ask for sudo, since we use the system python)', :yellow
+      else
+        raise("Please install it, see https://github.com/hnsl/unox, or simply run :\n #{cmd1} && #{cmd2}")
+      end
+    end
+
+  end
+
+  def self.macfsevents_available
+    `python -c 'import fsevents'`
+    unless $?.success?
+      Thor::Shell::Basic.new.say_status 'warning','Could not find macfsevents. Will try to install it using pip', :red
+      sudo = false
+      if find_executable0('python') == '/usr/bin/python'
+        Thor::Shell::Basic.new.say_status 'ok','You seem to use the system python, we will need sudo below'
+        sudo = true
+        cmd2 = 'sudo easy_install pip && sudo pip install macfsevents'
+      else
+        Thor::Shell::Basic.new.say_status 'ok','You seem to have a custom python, using non-sudo commands'
+        sudo = false
+        cmd2 = 'easy_install pip && pip install macfsevents'
+      end
+      if sudo
+        question = 'I will ask you for you root password to install macfsevent by running (This will ask for sudo, since we use the system python)'
+      else
+        question = 'I will now install macfsevents for you by running'
+      end
+
+      Thor::Shell::Basic.new.say_status 'info', "#{question}: `#{cmd2}\n\n"
+      if Thor::Shell::Basic.new.yes?('Shall i continue? (y/N)')
         system cmd2
         if $?.exitstatus > 0
           raise('Failed to install macfsevents, please file an issue with the output of the error')
         end
+        `python -c 'import fsevents'`
+        unless $?.success?
+          raise('Somehow could not successfully install macfsevents even though i treed. Please report this issue')
+        end
       else
-        raise("Please install it, see https://github.com/hnsl/unox, or simply run :\n #{cmd1} && #{cmd2}")
+        raise('Please install macfsevents manually, see https://github.com/EugenMayer/docker-sync/wiki/1.-Installation')
       end
     end
+
+
   end
 end

data/lib/docker-sync/sync_manager.rb

@@ -4,6 +4,8 @@ require 'docker-sync/sync_process'
 # noinspection RubyResolve
 require 'docker-sync/execution'
 require 'yaml'
+require 'dotenv'
+require 'docker-sync/config_template'
 
 module Docker_sync
   class SyncManager
@@ -14,6 +16,8 @@ module Docker_sync
     @config_path
 
     def initialize(options)
+      Dotenv.load
+
       @sync_processes = []
       @config_syncs = []
       @config_global = []
@@ -26,7 +30,8 @@ module Docker_sync
         raise "Config could not be loaded from #{@config_path} - it does not exist"
       end
 
-      config = YAML.load_file(@config_path)
+      config = ConfigTemplate::interpolate_config_file(@config_path)
+
       validate_config(config)
       @config_global = config['options'] || {}
       @config_syncs = config['syncs']
@@ -44,9 +49,14 @@ module Docker_sync
     def upgrade_syncs_config
       @config_syncs.each do |name, config|
         @config_syncs[name]['config_path'] = @config_path
-        # expand the sync source to remove ~ and similar expressions in the path
-        @config_syncs[name]['src'] = File.expand_path(@config_syncs[name]['src'], File.dirname(@config_path))
-        @config_syncs[name]['cli_mode'] = @config_global['cli_mode'] || 'auto'
+
+	# [nbr] convert the sync src from relative to absolute path
+	#	preserve '/' as it may be significant to the sync cmd
+        absolute_path = File.expand_path(@config_syncs[name]['src'])
+	absolute_path << "/" if @config_syncs[name]['src'].end_with?("/")
+	@config_syncs[name]['src'] = absolute_path
+
+	@config_syncs[name]['cli_mode'] = @config_global['cli_mode'] || 'auto'
 
         # set the global verbose setting, if the sync-endpoint does not define a own one
         unless config.key?('verbose')
@@ -80,13 +90,14 @@ module Docker_sync
 
     def validate_sync_config(name, sync_config)
       config_mandatory = %w[src dest]
-      config_mandatory.push('sync_host_port') unless sync_config['sync_strategy'] == 'unison' #TODO: Implement autodisovery for other strategies
+      config_mandatory.push('sync_host_port') if sync_config['sync_strategy'] == 'rsync' #TODO: Implement autodisovery for other strategies
       config_mandatory.each do |key|
-        raise ("#{name} does not have #{key} condiguration value set - this is mandatory") unless sync_config.key?(key)
+        raise ("#{name} does not have #{key} configuration value set - this is mandatory") unless sync_config.key?(key)
       end
     end
 
     def init_sync_processes(sync_name = nil)
+      return if @sync_processes.size != 0
       if sync_name.nil?
         @config_syncs.each { |name, sync_configuration|
           @sync_processes.push(create_sync(name, sync_configuration))
@@ -114,6 +125,13 @@ module Docker_sync
       }
     end
 
+    def start_container(sync_name = nil)
+      init_sync_processes(sync_name)
+      @sync_processes.each { |sync_process|
+        sync_process.start_container
+      }
+    end
+
     def run(sync_name = nil)
       init_sync_processes(sync_name)
 

data/lib/docker-sync/sync_process.rb

@@ -1,7 +1,6 @@
 require 'thor/shell'
 # noinspection RubyResolve
 require 'docker-sync/sync_strategy/rsync'
-require 'docker-sync/sync_strategy/unison-onesided'
 require 'docker-sync/sync_strategy/unison'
 # noinspection RubyResolve
 require 'docker-sync/watch_strategy/fswatch'
@@ -36,15 +35,11 @@ module Docker_Sync
         case @options['sync_strategy']
           when 'rsync'
             @sync_strategy = Docker_Sync::SyncStrategy::Rsync.new(@sync_name, @options)
-          when 'unison-onesided'
-            @sync_strategy = Docker_Sync::SyncStrategy::Unison_Onesided.new(@sync_name, @options)
-          when 'unison'
-            @sync_strategy = Docker_Sync::SyncStrategy::Unison.new(@sync_name, @options)
           else
-            @sync_strategy = Docker_Sync::SyncStrategy::Rsync.new(@sync_name, @options)
+            @sync_strategy = Docker_Sync::SyncStrategy::Unison.new(@sync_name, @options)
         end
       else
-        @sync_strategy = Docker_Sync::SyncStrategy::Rsync.new(@sync_name, @options)
+        @sync_strategy = Docker_Sync::SyncStrategy::Unison.new(@sync_name, @options)
       end
     end
 
@@ -55,16 +50,14 @@ module Docker_Sync
             @watch_strategy = Docker_Sync::WatchStrategy::Fswatch.new(@sync_name, @options)
           when 'disable','dummy'
             @watch_strategy = Docker_Sync::WatchStrategy::Dummy.new(@sync_name, @options)
-          when 'unison'
-            @watch_strategy = Docker_Sync::WatchStrategy::Unison.new(@sync_name, @options)
           else
-            @watch_strategy = Docker_Sync::WatchStrategy::Fswatch.new(@sync_name, @options)
+            @watch_strategy = Docker_Sync::WatchStrategy::Unison.new(@sync_name, @options)
         end
       else
-        if @options['sync_strategy'] == 'unison'
-          @watch_strategy = Docker_Sync::WatchStrategy::Unison.new(@sync_name, @options)
-        else
+        if @options['sync_strategy'] == 'rsync'
           @watch_strategy = Docker_Sync::WatchStrategy::Fswatch.new(@sync_name, @options)
+        else
+          @watch_strategy = Docker_Sync::WatchStrategy::Unison.new(@sync_name, @options)
         end
       end
     end
@@ -93,6 +86,10 @@ module Docker_Sync
       @sync_strategy.sync
     end
 
+    def start_container
+      @sync_strategy.start_container
+    end
+
     def watch
       @watch_strategy.run
     end

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

@@ -67,7 +67,7 @@ module Docker_Sync
         # in the config - see start_container
         #args.push("--usermap='*:#{@options['sync_user']}'") if @options.key?('sync_user')
         #args.push("--groupmap='*:#{@options['sync_group']}'") if @options.key?('sync_group')
-        args.push("#{@options['src']}/") # add a trailing slash
+        args.push("'#{@options['src']}'")
         args.push("rsync://#{@options['sync_host_ip']}:#{@options['sync_host_port']}/volume")
         return args
       end

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

@@ -96,7 +96,7 @@ module Docker_Sync
       def expand_ignore_strings
         expanded_ignore_strings = []
 
-        exclude_type = 'Path'
+        exclude_type = 'Name'
         unless @options['sync_excludes_type'].nil?
           exclude_type = @options['sync_excludes_type']
         end
@@ -121,16 +121,25 @@ module Docker_Sync
         args.push(@options['src'])
         args.push('-auto')
         args.push('-batch')
+        args.push(sync_prefer) if @options.key?('sync_prefer')
         args.push(@options['sync_args']) if @options.key?('sync_args')
         sync_host_port = get_host_port(get_container_name, UNISON_CONTAINER_PORT)
         args.push("socket://#{@options['sync_host_ip']}:#{sync_host_port}")
 
         if @options.key?('sync_group') || @options.key?('sync_groupid')
-          raise('Unison does not support sync_user, sync_group, sync_groupid - please use rsync if you need that')
+          raise('Unison does not support sync_group, sync_groupid - please use rsync if you need that')
         end
         return args
       end
 
+      def sync_prefer
+        case @options['sync_prefer']
+        when 'src' then "-prefer #{@options['src']}"
+        when 'dest' then "-prefer #{@options['dest']}"
+        else "-prefer #{@options['sync_prefer']}"
+        end
+      end
+
       def start_container
         say_status 'ok', 'Starting unison', :white
         container_name = get_container_name
@@ -173,14 +182,25 @@ module Docker_Sync
         say_status 'command', cmd, :white if @options['verbose']
         `#{cmd}` || raise('Start failed')
         say_status 'ok', "starting initial sync of #{container_name}", :white if @options['verbose']
-        # this sleep is needed since the container could be not started
-        sleep 5 # TODO: replace with unison -testserver
+        # wait until container is started, then sync:
+        sync_host_port = get_host_port(get_container_name, UNISON_CONTAINER_PORT)
+        cmd = "unison -testserver #{@options['dest']} \"socket://#{@options['sync_host_ip']}:#{sync_host_port}\""
+        say_status 'command', cmd, :white if @options['verbose']
+        attempt = 0
+        loop do
+          stdout, stderr, exit_status = Open3.capture3(cmd)
+          break if exit_status == 0
+          attempt += 1
+          break if attempt > 5
+          sleep 1
+        end
         sync
         say_status 'success', 'Unison server started', :green
       end
 
       def get_host_port(container_name, container_port)
-        cmd = 'docker inspect --format=" {{ .NetworkSettings.Ports }} " ' + container_name + ' | /usr/bin/sed  -E "s/.*map\[' + container_port + '[^ ]+ ([0-9]*)[^0-9].*/\1/"'
+        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=" {{ .NetworkSettings.Ports }} " ' + container_name + " | #{sed} " + '-E "s/.*map\[' + container_port + '[^ ]+ ([0-9]*)[^0-9].*/\1/"'
         say_status 'command', cmd, :white if @options['verbose']
         stdout, stderr, exit_status = Open3.capture3(cmd)
         if not exit_status.success?

data/lib/docker-sync/update_check.rb

@@ -24,7 +24,6 @@ class UpdateChecker
     # do not check the image if its the first run - since this it will be downloaded anyway
     unless DockerSyncConfig::is_first_run
       check_rsync_image
-      check_unison_onesided_image
       check_unison_image
 
       # stop if there was an update
@@ -73,18 +72,6 @@ class UpdateChecker
 
   end
 
-  def check_unison_onesided_image
-    say_status 'ok','Checking if a newer unison:onesided image is available'
-
-    if system("docker pull eugenmayer/unison:onesided | grep 'Downloaded newer image for'")
-      say_status 'ok', 'Downloaded newer image for unison:onesided', :green
-      @newer_image_found = true
-    else
-      say_status 'ok', 'No newer image found - current image is up to date.'
-    end
-
-  end
-
   def get_current_version
     path = File.expand_path('../../../', __FILE__)
     return File.read("#{path}/VERSION")
@@ -101,12 +88,13 @@ class UpdateChecker
     # update the timestamp
     now = DateTime.now
     @config['update_last_check'] = now.iso8601(9)
+
     DockerSyncConfig::global_config_save(@config)
 
     check = docker_sync_update_check
     if check.update_available
       say_status 'warning',"There is an update (#{check.latest_version}) available (current version #{check.current_version}). Please update before you continue",:yellow
-      if yes?("Shall i update docker-sync to #{check.latest_version} for you?")
+      if yes?("Shall I update docker-sync to #{check.latest_version} for you?")
         system('gem update docker-sync')
         say_status 'success','Successfully updated, please restart docker-sync and check the changelog at https://github.com/EugenMayer/docker-sync/wiki/5.-Changelog',:green
         exit 0

data/lib/docker-sync/upgrade_check.rb

@@ -23,7 +23,7 @@ class UpgradeChecker
   def should_run
     # get the update_status which is the version of the update hook which has been run already
     upgrade_status = last_upgraded_version
-    if upgrade_status == '' || Gem::Version.new(upgrade_status) < Gem::Version.new(get_current_version) # thats how we compare the version
+    if upgrade_status == '' || Gem::Version.new(upgrade_status) < Gem::Version.new(UpgradeChecker.get_current_version) # thats how we compare the version
       return true
     end
 
@@ -31,14 +31,14 @@ class UpgradeChecker
   end
 
 
-  def get_current_version
+  def self.get_current_version
     path = File.expand_path('../../../', __FILE__)
     return File.read("#{path}/VERSION")
   end
 
   def docker_sync_update_check
     gem_name = 'docker-sync'
-    current_version = get_current_version
+    current_version = UpgradeChecker.get_current_version
     checker = GemUpdateChecker::Client.new(gem_name, current_version)
     return checker
   end
@@ -47,13 +47,21 @@ class UpgradeChecker
     # this is the upgrade hook for the unison-unox introduction / rename of unison
     if Gem::Version.new(last_upgraded_version) <  Gem::Version.new('0.1.0')
       Thor::Shell::Basic.new.say_status 'warning', 'Please be aware that with the strategy "unison" is now called unison-onesided and you might need to migrate. See https://github.com/EugenMayer/docker-sync/wiki/Migration-Guide for more informations', :red
-      unless Thor::Shell::Basic.new.yes?('Shall we continue?')
+      unless Thor::Shell::Basic.new.yes?('Shall we continue? (y/N)')
         exit 1
       end
     end
 
+    if Gem::Version.new(last_upgraded_version) <  Gem::Version.new('0.2.0')
+      Thor::Shell::Basic.new.say_status 'warning', "A lot changed with 0.2.x! Unison is the default sync, unison-onesided has been REMOVED. If you have been using rsync, have been using unison excludes or you are not sure, please read the upgrade guide or your setup will go lala! : \n\n_Please_ read :): https://github.com/EugenMayer/docker-sync/wiki/1.2-Upgrade-Guide\n\n", :red
+      unless Thor::Shell::Basic.new.yes?('Shall we continue - DID you read it? (y/N)')
+        exit 1
+      end
+    end
+
+
     # update the upgrade_status
-    @config['upgrade_status'] = "#{get_current_version}"
+    @config['upgrade_status'] = "#{UpgradeChecker.get_current_version}"
     DockerSyncConfig::global_config_save(@config)
   end
 end

data/lib/docker-sync/watch_strategy/fswatch.rb

@@ -54,7 +54,7 @@ module Docker_Sync
         args.push('-orIE')
         args.push(@events_to_watch.map { |pattern| "--event #{pattern}" })
         args.push(@options['watch_args']) if @options.key?('watch_args')
-        args.push(@options['src'])
+        args.push("'#{@options['src']}'")
         sync_command = get_sync_cli_call
         args.push(" | xargs -I -n1 #{sync_command} -n #{@sync_name} --config='#{@options['config_path']}'")
       end

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

@@ -28,7 +28,7 @@ module Docker_Sync
       end
 
       def stop
-        Process.kill "TERM", @watch_fork
+        Process.kill 'TERM', @watch_fork
         Process.wait @watch_fork
       end
 

data/tasks/daemon/daemon.thor

@@ -0,0 +1,50 @@
+require 'docker-sync/sync_manager'
+require 'docker-sync/config'
+require 'docker-sync/preconditions'
+require 'docker-sync/update_check'
+require 'docker-sync/upgrade_check'
+require 'daemons'
+require 'fileutils'
+
+class Daemon < Thor
+  class_option :dir, :aliases => '--dir', :default => './.docker-sync', :type => :string, :desc => 'Path to PID and OUTPUT file Directory'
+  class_option :logd, :aliases => '--logd', :default => true, :type => :boolean, :desc => 'To log OUPUT to file on Daemon or not'
+  class_option :app_name, :aliases => '--name', :default => 'daemon', :type => :string, :desc => 'App name used in PID and OUTPUT file name for Daemon'
+  class_option :logd, :aliases => '--logd', :default => true, :type => :boolean, :desc => 'To log OUPUT to file on Daemon or not'
+  class_option :config, :aliases => '-c',:default => nil, :type => :string, :desc => 'Path of the docker_sync config'
+  class_option :sync_name, :aliases => '-n',:type => :string, :desc => 'If given, only this sync configuration will be references/started/synced'
+  class_option :version, :aliases => '-v',:type => :boolean, :default => false, :desc => 'prints out the version of docker-sync and exits'
+
+  desc 'start', 'Start docker-sync daemon'
+  def start
+    opt = options.dup
+    opt.merge!(:daemon => true)
+    sync = Sync.new([], opt)
+    sync.start
+  end
+
+  desc 'stop', 'Stop docker-sync daemon'
+  def stop
+    opt = options.dup
+    opt.merge!(:daemon => true)
+    sync = Sync.new([], opt)
+    sync.stop
+  end
+
+  desc 'clean', 'Clean docker-sync daemon'
+  def clean
+    opt = options.dup
+    opt.merge!(:daemon => true)
+    sync = Sync.new([], opt)
+    sync.clean
+  end
+
+  desc 'log', 'Prints last 100 lines of daemon log. Only for use with docker-sync started in background.'
+  method_option :lines, :aliases => '--lines', :default => 100, :type => :numeric, :desc => 'Specify number of lines to tail'
+  method_option :follow, :aliases => '-f', :default => false, :type => :boolean, :desc => 'Specify if the logs should be streamed'
+  def log
+    opt = options.dup
+    sync = Sync.new([], opt)
+    sync.log
+  end
+end

data/tasks/stack/stack.thor

@@ -8,10 +8,16 @@ require 'docker-sync/compose'
 class Stack < Thor
   class_option :config, :aliases => '-c', :default => nil, :type => :string, :desc => 'Path of the docker_sync config'
   class_option :sync_name, :aliases => '-n', :type => :string, :desc => 'If given, only this sync configuration will be references/started/synced'
+  class_option :version, :aliases => '-v',:type => :boolean, :default => false, :desc => 'prints out the version of docker-sync and exits'
 
   desc 'start', 'Start sync services, watcher and then your docker-compose defined stack'
 
   def start
+    if options[:version]
+      puts UpgradeChecker.get_current_version
+      exit(0)
+    end
+
     # do run update check in the start command only
     updates = UpdateChecker.new
     updates.run
@@ -37,6 +43,8 @@ class Stack < Thor
       end
     end
 
+    say_status 'note:', 'You can also run docker-sync in the background with docker-sync --daemon'
+
     @sync_manager = Docker_sync::SyncManager.new(:config_path => config_path)
     @sync_manager.run(options[:sync_name])
     global_options = @sync_manager.global_options
@@ -63,6 +71,11 @@ class Stack < Thor
   desc 'clean', 'compose down your app stack, stop and clean up all sync endpoints'
 
   def clean
+    if options[:version]
+      puts UpgradeChecker.get_current_version
+      exit(0)
+    end
+
     begin
       Preconditions::check_all_preconditions
     rescue Exception => e

data/tasks/sync/sync.thor

@@ -3,108 +3,128 @@ require 'docker-sync/config'
 require 'docker-sync/preconditions'
 require 'docker-sync/update_check'
 require 'docker-sync/upgrade_check'
+require 'daemons'
+require 'fileutils'
 
 class Sync < Thor
 
   class_option :config, :aliases => '-c',:default => nil, :type => :string, :desc => 'Path of the docker_sync config'
   class_option :sync_name, :aliases => '-n',:type => :string, :desc => 'If given, only this sync configuration will be references/started/synced'
+  class_option :version, :aliases => '-v',:type => :boolean, :default => false, :desc => 'prints out the version of docker-sync and exits'
 
   desc 'start', 'Start all sync configurations in this project'
+  method_option :daemon, :aliases => '-d', :default => false, :type => :boolean, :desc => 'Run in the background'
+  method_option :app_name, :aliases => '--name', :default => 'daemon', :type => :string, :desc => 'App name used in PID and OUTPUT file name for Daemon'
+  method_option :dir, :aliases => '--dir', :default => './.docker-sync', :type => :string, :desc => 'Path to PID and OUTPUT file Directory'
+  method_option :logd, :aliases => '--logd', :default => true, :type => :boolean, :desc => 'To log OUPUT to file on Daemon or not'
   def start
-    # do run update check in the start command only
-    updates = UpdateChecker.new
-    updates.run
-    upgrades = UpgradeChecker.new
-    upgrades.run
-    begin
-      Preconditions::check_all_preconditions
-    rescue Exception => e
-      say_status 'error', e.message, :red
-      exit 1
+    if options[:version]
+      puts UpgradeChecker.get_current_version
+      exit(0)
     end
+    # do run update check in the start command only
+    UpdateChecker.new().run
+    UpgradeChecker.new().run
+
+    config_path = config_preconditions # Preconditions and Define config_path from shared method
+    @sync_manager = Docker_sync::SyncManager.new(:config_path => config_path)
 
-    if options[:config]
-      config_path = options[:config]
+    start_dir = Dir.pwd # Set start_dir variable to be equal to pre-daemonized folder, since daemonizing will change dir to '/'
+    if options['daemon']
+      daemonize
     else
-      begin
-        config_path = DockerSyncConfig::project_config_path
-      rescue Exception => e
-        say_status 'error', e.message, :red
-        return
-      end
+      say_status 'note:', 'You can also run docker-sync in the background with --daemon', :white
+    end
+
+    Dir.chdir(start_dir) do # We want run these in pre-daemonized folder/directory since provided config_path might not be full_path
+      @sync_manager.run(options[:sync_name])
+      @sync_manager.join_threads
     end
-    @sync_manager = Docker_sync::SyncManager.new(:config_path => config_path)
-    @sync_manager.run(options[:sync_name])
-    @sync_manager.join_threads
   end
 
-  desc 'sync', 'sync - do not start a watcher'
-  def sync
+  desc 'stop', 'Stop docker-sync daemon'
+  method_option :app_name, :aliases => '--name', :default => 'daemon', :type => :string, :desc => 'App name used in PID and OUTPUT file name for Daemon'
+  method_option :dir, :aliases => '--dir', :default => './.docker-sync', :type => :string, :desc => 'Path to PID and OUTPUT file Directory'
+  def stop
+    if options[:version]
+      puts UpgradeChecker.get_current_version
+      exit(0)
+    end
+
+    config_path = config_preconditions
+    sync_manager = Docker_sync::SyncManager.new(:config_path => config_path)
+
     begin
-      Preconditions::check_all_preconditions
-    rescue Exception => e
-      say_status 'error', e.message, :red
-      exit 1
+      pid = File.read("#{options['dir']}/#{options['app_name']}.pid") # Read PID from PIDFILE created by Daemons
+      Process.kill(:INT, -(Process.getpgid(pid.to_i))) # Send INT signal to group PID, which means INT will be sent to all sub-processes and Threads spawned by docker-sync
+      say_status 'shutdown', 'Background dsync has been stopped'
+    rescue Errno::ESRCH, Errno::ENOENT => e
+      say_status 'error', e.message, :red # Rescue incase PIDFILE does not exist or there is no process with such PID
+      say_status(
+        'error', 'Check if your PIDFILE and process with such PID exists', :red
+      )
     end
+  end
 
-    if options[:config]
-      config_path = options[:config]
-    else
-      begin
-        config_path = DockerSyncConfig::project_config_path
-      rescue Exception => e
-        say_status 'error', e.message, :red
-        return
-      end
+  desc 'sync', 'just sync - do not start a watcher though'
+  def sync
+    if options[:version]
+      puts UpgradeChecker.get_current_version
+      exit(0)
     end
+
+    config_path = config_preconditions # Preconditions and Define config_path from shared method
+
     @sync_manager = Docker_sync::SyncManager.new(:config_path => config_path)
     @sync_manager.sync(options[:sync_name])
   end
 
   desc 'clean', 'Stop and clean up all sync endpoints'
   def clean
-    begin
-      Preconditions::check_all_preconditions
-    rescue Exception => e
-      say_status 'error', e.message, :red
-      exit 1
+    if options[:version]
+      puts UpgradeChecker.get_current_version
+      exit(0)
     end
 
-    if options[:config]
-      config_path = options[:config]
-    else
-      begin
-        config_path = DockerSyncConfig::project_config_path
-      rescue Exception => e
-        say_status 'error', e.message, :red
-        return
-      end
+    config_path = config_preconditions # Preconditions and Define config_path from shared method
+
+    # Look for any background syncs and stop them if we see them
+    dir = './.docker-sync'
+    files = Dir[File.join(dir, '*.pid')]
+    files.each do |pid_file|
+      pid = File.read(pid_file).to_i
+      Process.kill(:INT, -(Process.getpgid(pid)))
+      say_status 'shutdown', 'Background dsync has been stopped'
     end
+    # Remove the .docker-sync directory
+    FileUtils.rm_r dir if File.directory?(dir)
+
     @sync_manager = Docker_sync::SyncManager.new(:config_path => config_path)
     @sync_manager.clean(options[:sync_name])
     say_status 'success', 'Finished cleanup. Removed stopped, removed sync container and removed their volumes', :green
   end
 
+  desc 'log', 'Prints last 100 lines of daemon log. Only for use with docker-sync started in background.'
+  method_option :lines, :aliases => '--lines', :default => 100, :type => :numeric, :desc => 'Specify number of lines to tail'
+  method_option :follow, :aliases => '-f', :default => false, :type => :boolean, :desc => 'Specify if the logs should be streamed'
+  def log
+    if options[:version]
+      puts UpgradeChecker.get_current_version
+      exit(0)
+    end
+
+    print_daemon_logs
+  end
+
   desc 'list', 'List all sync-points of the project configuration path'
   method_option :verbose, :default => false, :type => :boolean, :desc => 'Verbose output'
   def list
-    begin
-      Preconditions::check_all_preconditions
-    rescue Exception => e
-      say_status 'error', e.message, :red
-      exit 1
+    if options[:version]
+      puts UpgradeChecker.get_current_version
+      exit(0)
     end
 
-    if options[:config]
-      config_path = options[:config]
-    else
-      begin
-        config_path = DockerSyncConfig::project_config_path
-      rescue Exception => e
-        say_status 'error', e.message, :red
-        return
-      end
-    end
+    config_path = config_preconditions # Preconditions and Define config_path from shared method
 
     say_status 'ok',"Found configuration at #{config_path}"
     @sync_manager = Docker_sync::SyncManager.new(:config_path => config_path)
@@ -114,4 +134,71 @@ class Sync < Thor
       print_table(config) if options['verbose']
     end
   end
+
+  no_tasks do
+    def config_preconditions # Moved shared preconditions block into separate method to have less/cleaner code
+      begin
+        Preconditions::check_all_preconditions
+      rescue Exception => e
+        say_status 'error', e.message, :red
+        exit 1
+      end
+
+      return options[:config] if options[:config]
+
+      begin
+        DockerSyncConfig::project_config_path
+      rescue Exception => e
+        say_status 'error', e.message, :red
+        exit 1
+      end
+    end
+
+    def daemonize
+      # Create the directory for the logs/pid if it doesn't already exist:
+      FileUtils.mkpath(options['dir'])
+
+      # Check to see if we're already running:
+      if daemon_running?
+        say_status 'error', "docker-sync already started for this configuration", :red
+        exit 1
+      end
+
+      # If we're daemonizing, run a sync first to ensure the containers exist so that a docker-compose up won't fail:
+      @sync_manager.start_container(options[:sync_name])
+      # the existing strategies' start_container will also sync, but just in case a strategy doesn't, sync now:
+      @sync_manager.sync(options[:sync_name])
+
+      dopts = {
+        app_name: options['app_name'],
+        dir_mode: :normal,
+        dir: options['dir'],
+        log_output: options['logd'],
+        output_logfilename: "#{options['app_name']}.log"
+      } # List of options accepted by Daemonize, can be customized pretty nicely with provided CLI options
+
+      say_status 'success', 'Starting Docker-Sync in the background', :green
+      Daemons.daemonize(dopts)
+    end
+
+    def print_daemon_logs
+      unless daemon_running?
+        say_status 'error', "docker-sync is not running in daemon mode for this configuration", :red
+        exit 1
+      end
+
+      log_file = File.join(options['dir'], "#{options['app_name']}.log")
+      begin
+        system("tail #{options['follow'] ? '-f ' : ''}-n #{options['lines']} #{log_file}")
+      rescue Interrupt
+        nil
+      end
+    end
+
+    def daemon_running?
+      pid_file = Daemons::PidFile.find_files(options['dir'], options['app_name']).first || ''
+
+      File.file?(pid_file) && Daemons::Pid.running?(File.read(pid_file).to_i)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-sync
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0.beta5
 platform: ruby
 authors:
 - Eugen Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -84,33 +84,76 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.6.3
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
 description: Sync your code live to docker-containers without losing any performance
   on OSX
 email: eugen.mayer@kontextwork.de
 executables:
 - docker-sync
 - docker-sync-stack
+- docker-sync-daemon
 extensions: []
 extra_rdoc_files: []
 files:
 - Thorfile
 - VERSION
 - bin/docker-sync
+- bin/docker-sync-daemon
 - bin/docker-sync-stack
 - lib/docker-sync/compose.rb
 - lib/docker-sync/config.rb
+- lib/docker-sync/config_template.rb
 - lib/docker-sync/execution.rb
 - lib/docker-sync/preconditions.rb
 - lib/docker-sync/sync_manager.rb
 - lib/docker-sync/sync_process.rb
 - lib/docker-sync/sync_strategy/rsync.rb
-- lib/docker-sync/sync_strategy/unison-onesided.rb
 - lib/docker-sync/sync_strategy/unison.rb
 - lib/docker-sync/update_check.rb
 - lib/docker-sync/upgrade_check.rb
 - lib/docker-sync/watch_strategy/dummy.rb
 - lib/docker-sync/watch_strategy/fswatch.rb
 - lib/docker-sync/watch_strategy/unison.rb
+- tasks/daemon/daemon.thor
 - tasks/stack/stack.thor
 - tasks/sync/sync.thor
 homepage: https://github.com/EugenMayer/docker_sync
@@ -128,9 +171,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1

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

@@ -1,137 +0,0 @@
-require 'thor/shell'
-require 'docker-sync/preconditions'
-require 'open3'
-require 'terminal-notifier'
-
-module Docker_Sync
-  module SyncStrategy
-    class Unison_Onesided
-      include Thor::Shell
-
-      @options
-      @sync_name
-      @watch_thread
-      UNISON_CONTAINER_PORT = '5000'
-      def initialize(sync_name, options)
-        @sync_name = sync_name
-        @options = options
-        # if a custom image is set, apply it
-        if @options.key?('image')
-          @docker_image = @options['image']
-        else
-          @docker_image = 'eugenmayer/unison:onesided'
-        end
-        begin
-          Preconditions::unison_available
-        rescue Exception => 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
-        end
-      end
-
-      def run
-        start_container
-        sync
-      end
-
-      def sync
-        args = sync_options
-        cmd = 'unison ' + args.join(' ')
-
-        say_status 'command', cmd, :white if @options['verbose']
-
-        stdout, stderr, exit_status = Open3.capture3(cmd)
-        if not exit_status.success?
-          say_status 'error', "Error starting sync, exit code #{$?.exitstatus}", :red
-          say_status 'message', stderr
-        else
-          TerminalNotifier.notify(
-            "Synced #{@options['src']}", :title => @sync_name
-          ) if @options['notify_terminal']
-          say_status 'ok', "Synced #{@options['src']}", :white
-          if @options['verbose']
-            say_status 'output', stdout
-          end
-        end
-      end
-
-      def sync_options
-        args = []
-
-        unless @options['sync_excludes'].nil?
-          args = @options['sync_excludes'].map { |pattern| "-ignore='Path #{pattern}'" } + args
-        end
-        args.push(@options['src'])
-        args.push('-auto')
-        args.push('-batch')
-        args.push(@options['sync_args']) if @options.key?('sync_args')
-        args.push("socket://#{@options['sync_host_ip']}:#{@options['sync_host_port']}/")
-        args.push('-debug all') if @options['verbose']
-        if @options.key?('sync_user') || @options.key?('sync_group') || @options.key?('sync_groupid') || @options.key?('sync_userid')
-          raise('Unison does not support sync_user, sync_group, sync_groupid or sync_userid - please use rsync if you need that')
-        end
-        return args
-      end
-
-      def start_container
-        say_status 'ok', 'Starting unison', :white
-        container_name = get_container_name
-        volume_name = get_volume_name
-        running = `docker ps --filter 'status=running' --filter 'name=#{container_name}' --format "{{.Names}}" | grep '^#{container_name}$'`
-        if running == ''
-          say_status 'ok', "#{container_name} container not running", :white if @options['verbose']
-          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']
-            cmd = "docker run -p '#{@options['sync_host_port']}:#{UNISON_CONTAINER_PORT}' -v #{volume_name}:#{@options['dest']} -e UNISON_DIR=#{@options['dest']} -e TZ=${TZ-`readlink /etc/localtime | sed -e 's,/usr/share/zoneinfo/,,'`} --name #{container_name} -d #{@docker_image}"
-          else
-            say_status 'ok', "starting #{container_name} container", :white if @options['verbose']
-            cmd = "docker start #{container_name}"
-          end
-          say_status 'command', cmd, :white if @options['verbose']
-          `#{cmd}` || raise('Start failed')
-        else
-          say_status 'ok', "#{container_name} container still running", :blue
-        end
-        say_status 'ok', "starting initial sync of #{container_name}", :white if @options['verbose']
-        # this sleep is needed since the container could be not started
-        sleep 1
-        sync
-        say_status 'success', 'Unison server started', :green
-      end
-
-      def get_container_name
-        return "#{@sync_name}"
-      end
-
-      def get_volume_name
-        return @sync_name
-      end
-
-      def stop_container
-        `docker stop #{get_container_name}`
-      end
-
-      def reset_container
-        stop_container
-        `docker rm #{get_container_name}`
-        `docker volume rm #{get_volume_name}`
-      end
-
-      def clean
-        reset_container
-      end
-
-      def stop
-        say_status 'ok', "Stopping sync container #{get_container_name}"
-        begin
-          stop_container
-        rescue Exception => e
-          say_status 'error', "Stopping failed of #{get_container_name}:", :red
-          puts e.message
-        end
-      end
-    end
-  end
-end