docker-sync 0.2.3 → 0.3.0

data/tasks/sync/sync.thor

@@ -1,10 +1,12 @@
+require 'docker-sync'
 require 'docker-sync/sync_manager'
-require 'docker-sync/config'
-require 'docker-sync/preconditions'
+require 'docker-sync/preconditions/strategy'
 require 'docker-sync/update_check'
 require 'docker-sync/upgrade_check'
 require 'daemons'
 require 'fileutils'
+require 'docker-sync/config/project_config'
+require 'timeout'
 
 class Sync < Thor
 
@@ -27,11 +29,11 @@ class Sync < Thor
   def start
     print_version if options[:version]
     # do run update check in the start command only
-    UpdateChecker.new().run
-    UpgradeChecker.new().run
+    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)
+    config = config_preconditions
+    @sync_manager = Docker_sync::SyncManager.new(config: 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']
@@ -52,18 +54,17 @@ class Sync < Thor
   def stop
     print_version if options[:version]
 
-    config_path = config_preconditions
-    sync_manager = Docker_sync::SyncManager.new(:config_path => config_path)
+    config = config_preconditions
+    sync_manager = Docker_sync::SyncManager.new(config: config)
 
     begin
       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'
+      wait_for_process_termination(pid.to_i)
     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
-      )
+      say_status 'error', 'Check if your PIDFILE and process with such PID exists', :red
+      exit(69) # EX_UNAVAILABLE (see `man sysexits` or `/usr/include/sysexits.h`)
     end
   end
 
@@ -71,9 +72,9 @@ class Sync < Thor
   def sync
     print_version if options[:version]
 
-    config_path = config_preconditions # Preconditions and Define config_path from shared method
+    config = config_preconditions
 
-    @sync_manager = Docker_sync::SyncManager.new(:config_path => config_path)
+    @sync_manager = Docker_sync::SyncManager.new(config: config)
     @sync_manager.sync(options[:sync_name])
   end
 
@@ -81,7 +82,7 @@ class Sync < Thor
   def clean
     print_version if options[:version]
 
-    config_path = config_preconditions # Preconditions and Define config_path from shared method
+    config = config_preconditions
 
     # Look for any background syncs and stop them if we see them
     dir = './.docker-sync'
@@ -94,7 +95,7 @@ class Sync < Thor
     # 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 = Docker_sync::SyncManager.new(config: config)
     @sync_manager.clean(options[:sync_name])
     say_status 'success', 'Finished cleanup. Removed stopped, removed sync container and removed their volumes', :green
   end
@@ -116,10 +117,10 @@ class Sync < Thor
   def list
     print_version if options[:version]
 
-    config_path = config_preconditions # Preconditions and Define config_path from shared method
+    config = config_preconditions
 
     say_status 'ok',"Found configuration at #{config_path}"
-    @sync_manager = Docker_sync::SyncManager.new(:config_path => config_path)
+    @sync_manager = Docker_sync::SyncManager.new(config: config)
     @sync_manager.get_sync_points.each do |name, config|
       say_status name, "On address #{config['sync_host_ip']}:#{config['sync_host_port']}",:white unless options['verbose']
       puts "\n---------------[#{name}] #{config['sync_host_ip']}:#{config['sync_host_port']} ---------------\n" if options['verbose']
@@ -130,16 +131,9 @@ class Sync < Thor
   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
+        DockerSync::ProjectConfig.new(config_path: options[:config]).tap do |config|
+          DockerSync::Preconditions::Strategy.instance.check_all_preconditions(config)
+        end
       rescue Exception => e
         say_status 'error', e.message, :red
         exit 1
@@ -191,5 +185,29 @@ class Sync < Thor
       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
+
+    def wait_for_process_termination(pid)
+      print 'Waiting for background docker-sync to terminate'
+      Timeout::timeout(30) do
+        loop do
+          if process_dead?(pid)
+            puts
+            say_status 'shutdown', 'Background docker-sync has been stopped'
+            return
+          else
+            sleep 1
+            print '.'
+          end
+        end
+      end
+    rescue Timeout::Error
+      puts
+      say_status 'error', 'Background docker-sync daemon failed to stop within 30 seconds', :red
+      exit 70 # EX_SOFTWARE (according to `man sysexits`)
+    end
+
+    def process_dead?(pid)
+      !system("ps -p #{pid} > /dev/null")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-sync
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Eugen Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -124,6 +124,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Sync your code live to docker-containers without losing any performance
   on OSX
 email: eugen.mayer@kontextwork.de
@@ -139,11 +153,16 @@ files:
 - bin/docker-sync
 - bin/docker-sync-daemon
 - bin/docker-sync-stack
+- lib/docker-sync.rb
 - lib/docker-sync/compose.rb
-- lib/docker-sync/config.rb
-- lib/docker-sync/config_template.rb
+- lib/docker-sync/config/config_locator.rb
+- lib/docker-sync/config/config_serializer.rb
+- lib/docker-sync/config/global_config.rb
+- lib/docker-sync/config/project_config.rb
 - lib/docker-sync/execution.rb
-- lib/docker-sync/preconditions.rb
+- lib/docker-sync/preconditions/preconditions_linux.rb
+- lib/docker-sync/preconditions/preconditions_osx.rb
+- lib/docker-sync/preconditions/strategy.rb
 - lib/docker-sync/sync_manager.rb
 - lib/docker-sync/sync_process.rb
 - lib/docker-sync/sync_strategy/rsync.rb

data/lib/docker-sync/config.rb

@@ -1,120 +0,0 @@
-require 'pp'
-require 'pathname'
-require 'yaml'
-require 'dotenv'
-require 'docker-sync/config_template'
-
-# this has basically completely reused from Thor::runner.rb - thank you!
-module DockerSyncConfig
-
-  def initialize(options)
-    load_dotenv
-  end
-
-  def self.load_dotenv
-    env_file = ENV.fetch('DOCKER_SYNC_ENV_FILE', '.env')
-    Dotenv.load(env_file)
-  end
-
-  def self.global_config_location
-    return File.expand_path('~/.docker-sync-global.yml')
-  end
-
-  def self.is_first_run
-    global_config_path = global_config_location
-    return !File.exist?(global_config_path)
-  end
-
-  def self.global_config
-    global_config_path = global_config_location
-    date = DateTime.new(2001, 1, 1) #paste
-    # noinspection RubyStringKeysInHashInspection
-    defaults = {'update_check'=>true, 'update_last_check' => date.iso8601(9), 'update_enforce' => true}
-    if File.exist?(global_config_path)
-      config = ConfigTemplate::interpolate_config_file(global_config_path)
-      config = defaults.merge(config)
-      return config
-    else
-      return defaults
-    end
-  end
-
-  def self.global_config_save(config)
-    global_config_path = global_config_location
-    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
-      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 :)
-  def self.project_config_find(skip_lookup = false)
-    # Finds docker-sync.yml by traversing from your current directory down to the root
-    # directory of your system. If at any time we find a docker-sync.yml file, we stop.
-    #
-    #
-    # ==== Example
-    #
-    # If we start at /Users/wycats/dev/thor ...
-    #
-    # 1. /Users/wycats/dev/thor
-    # 2. /Users/wycats/dev
-    # 3. /Users/wycats <-- we find a docker-sync.yml here, so we stop
-    #
-    # Suppose we start at c:\Documents and Settings\james\dev\docker-sync ...
-    #
-    # 1. c:\Documents and Settings\james\dev\docker-sync.yml
-    # 2. c:\Documents and Settings\james\dev
-    # 3. c:\Documents and Settings\james
-    # 4. c:\Documents and Settings
-    # 5. c:\ <-- no docker-sync.yml found!
-    #
-    docker_sync_files = []
-
-    unless skip_lookup
-      Pathname.pwd.ascend do |path|
-        docker_sync_files = globs_for_project_config(path).map { |g| Dir[g] }.flatten
-        break unless docker_sync_files.empty?
-      end
-    end
-
-    files = []
-    files += docker_sync_files
-  end
-
-  # Where to look for docker-sync.yml files.
-  #
-  def self.globs_for_project_config(path)
-    path = escape_globs(path)
-    ["#{path}/docker-sync.yml"]
-  end
-
-  def self.escape_globs(path)
-    path.to_s.gsub(/[*?{}\[\]]/, '\\\\\\&')
-  end
-end

data/lib/docker-sync/config_template.rb

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

data/lib/docker-sync/preconditions.rb

@@ -1,100 +0,0 @@
-require 'mkmf'
-
-module Preconditions
-  def self.check_all_preconditions
-    docker_available
-    docker_running
-    unison_available
-    unox_available
-    macfsevents_available
-  end
-
-  def self.docker_available
-    if (find_executable0 'docker').nil?
-      raise('Could not find docker binary in path. Please install it, e.g. using "brew install docker" or install docker-for-mac')
-    end
-  end
-
-  def self.docker_running
-    `docker ps`
-    if $?.exitstatus > 0
-      raise('No docker daemon seems to be running. Did you start your docker-for-mac / docker-machine?')
-    end
-  end
-
-  def self.fswatch_available
-    if (find_executable0 'fswatch').nil?
-      raise('No fswatch available. Install it by "brew install fswatch"')
-    end
-  end
-
-  def self.docker_sync_available
-    if (find_executable0 'docker-sync').nil?
-      raise('No docker-sync available. Install it by "gem install docker-sync"')
-    end
-  end
-
-  def self.rsync_available
-    if (find_executable0 'rsync').nil?
-      raise('Could not find rsync binary in path. Please install it, e.g. using "brew install rsync"')
-    end
-  end
-
-  def self.unison_available
-    if (find_executable0 'unison').nil?
-      raise('Could not find unison binary in path. Please install it, e.g. using "brew install unison"')
-    end
-  end
-
-  def self.unox_available
-    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'
-
-      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
-      else
-        raise("Please install it, see https://github.com/hnsl/unox, or simply run :\n #{cmd1}")
-      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
-      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 macfsevents manually, see https://github.com/EugenMayer/docker-sync/wiki/1.-Installation')
-      end
-    end
-
-
-  end
-end