docker-sync 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc40aa79fbd367b388ee77e59de18a559b859ec0
-  data.tar.gz: 5277727751ab18be0546e84105b40f9f81d80e89
+  metadata.gz: 4c038d1707563cd3431430008536b86b51d54967
+  data.tar.gz: cca9a557c34d66c70a80fdf503722f8f5e5533e1
 SHA512:
-  metadata.gz: 2d65defb8a672fa3c1a548c8340e486aacb9fb9772096578bdea854f11614e9e790737acc7def7b8a7d198cb652d4b24a48978357c8e2f5242303a789f7b5faf
-  data.tar.gz: f1779efc2e0a4c3e397a377584f3e6afa2fea49daf53b28e740a5889f5b5bb02c0b8bde2d2c2dc5b5ce7551929cf77c1bc4a9c2cd314d5df3c41b012b820f7b0
+  metadata.gz: 902d178c8baf27b21ffef9b943123e642b2acf3f3260af96f0b75453806c5605d010a1a15720786a0186a7d3ab6db6398fb4d5e9c05bca5288e96dbf94252202
+  data.tar.gz: d8e7ba089970977e9ce4fd6232eabaed4503bfd180d0deb910965cb9c69540caacf02129d26caddc5c41db0715606f91571446e1fbf10df4c24f78b9ca3d03f7

data/lib/docker_sync/sync_manager.rb

@@ -42,7 +42,10 @@ module Docker_Rsync
         @config_syncs[name]['config_path'] = @config_path
         @config_syncs[name]['src'] = File.expand_path(@config_syncs[name]['src'])
         unless config.key?('verbose')
-          @config_syncs[name]['verbose'] = @config_options['verbose'] || false
+          @config_syncs[name]['verbose'] = false
+          if @config_options.key?('verbose')
+            @config_syncs[name]['verbose'] = @config_options['verbose']
+          end
         end
       end
     end

data/lib/docker_sync/sync_strategy/rsync.rb

@@ -1,9 +1,12 @@
 require 'thor/shell'
+require 'preconditions'
 
 module Docker_Sync
   module SyncStrategy
     class Rsync
       include Thor::Shell
+      include Preconditions
+
       @options
       @sync_name
       @watch_thread
@@ -11,6 +14,14 @@ module Docker_Sync
       def initialize(sync_name, options)
         @sync_name = sync_name
         @options = options
+
+        begin
+          rsync_available
+        rescue Exception => e
+          say_status 'error', "#{@sync_name} has been configured to sync with rsync, but no rsync binary available", :red
+          say_status 'error', e.message, :red
+          exit 1
+        end
       end
 
       def run
@@ -29,7 +40,7 @@ module Docker_Sync
           say_status 'error', "Error starting sync, exit code #{$?.exitstatus}", :red
           say_status 'message', out
         else
-          say_status 'success', "Synced #{@options['src']}", :green
+          say_status 'ok', "Synced #{@options['src']}", :white
           if @options['verbose']
             say_status 'output', out
           end
@@ -43,33 +54,61 @@ module Docker_Sync
         end
         args.push('-ap')
         args.push(@options['sync_args']) if @options.key?('sync_args')
+        # we do not need to user usermap/groupmap since we started our container the way that it also maps user/group like we defined
+        # 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("rsync://#{@options['sync_host_ip']}:#{@options['sync_host_port']}/volume")
       end
 
-
+      # starts a rsync docker container listening on the specific port
+      # this container exposes a named volume and is on one side used as the rsync-endpoint for the
+      # local rsync command, on the other side the volume is mounted into the app-container to share the code / content
       def start_container
         say_status 'ok', 'Starting rsync', :white
         running = `docker ps --filter 'status=running' --filter 'name=#{@sync_name}' | grep #{@sync_name}`
-        if running == ''
-          say_status 'ok', "#{@sync_name} container not running", :white
-          exists = `docker ps --filter "status=exited" --filter "name=filesync_dw" | grep filesync_dw`
-          if exists == ''
-            say_status 'ok', "creating #{@sync_name} container", :white
-            cmd = "docker run -p '#{@options['sync_host_port']}:873' -v #{@sync_name}:#{@options['dest']} -e VOLUME=#{@options['dest']} --name #{@sync_name} -d eugenmayer/rsync"
-          else
-            say_status 'success', "starting #{@sync_name} container", :green
+        if running == '' # container is yet not running
+          say_status 'ok', "#{@sync_name} container not running", :white if @options['verbose']
+          exists = `docker ps --filter "status=exited" --filter "name=#{@sync_name}" | grep #{@sync_name}`
+          if exists == '' # container has yet not been created
+            say_status 'ok', "creating #{@sync_name} container", :white if @options['verbose']
+
+            user_mapping = ''
+            if @options.key?('sync_user')
+              user_mapping = "-e OWNER=#{@options['sync_user']}"
+              if @options.key?('sync_userid')
+                user_mapping = "#{user_mapping} -e OWNERID=#{@options['sync_userid']}"
+              end
+            elsif @options.key?('sync_userid')
+              raise("#{@sync_name}: You have set a sync_userid but no sync_user - you need to set both")
+            end
+
+            group_mapping = ''
+            if @options.key?('sync_group')
+              group_mapping = "-e GROUP=#{@options['sync_group']}"
+              if @options.key?('sync_groupid')
+                group_mapping = "#{group_mapping} -e GROUPID=#{@options['sync_groupid']}"
+              end
+            elsif @options.key?('sync_groupid')
+              raise("#{@sync_name}: You have set a sync_groupid but no sync_group - you need to set both")
+            end
+
+            cmd = "docker run -p '#{@options['sync_host_port']}:873' -v #{@sync_name}:#{@options['dest']} #{user_mapping} #{group_mapping} -e VOLUME=#{@options['dest']} --name #{@sync_name} -d eugenmayer/rsync"
+          else # container already created, just start / reuse it
+            say_status 'ok', "starting #{@sync_name} container", :white if @options['verbose']
             cmd = "docker start #{@sync_name}"
           end
-          say_status 'command', cmd, :white
+          say_status 'command', cmd, :white if @options['verbose']
           `#{cmd}` || raise('Start failed')
         else
-          say_status 'ok', "#{@sync_name} container still running", :blue
+          say_status 'ok', "#{@sync_name} container still running", :blue if @options['verbose']
         end
-        say_status 'success', "starting initial #{@sync_name} of src", :green
+        say_status 'ok', "starting initial #{@sync_name} of src", :white if @options['verbose']
         # this sleep is needed since the container could be not started
         sleep 1
         sync
+        say_status 'success', 'Rsync server started', :green
       end
 
       def stop_container

data/lib/docker_sync/sync_strategy/unison.rb

@@ -1,9 +1,14 @@
 require 'thor/shell'
+require 'preconditions'
+require 'open3'
 
 module Docker_Sync
   module SyncStrategy
     class Unison
       include Thor::Shell
+      include Preconditions
+
+
       @options
       @sync_name
       @watch_thread
@@ -13,6 +18,14 @@ module Docker_Sync
       def initialize(sync_name, options)
         @sync_name = sync_name
         @options = options
+
+        begin
+          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
@@ -26,12 +39,12 @@ module Docker_Sync
 
         say_status 'command', cmd, :white if @options['verbose']
 
-        out = `#{cmd}`
+        Open3.popen3(cmd)
         if $?.exitstatus > 0
           say_status 'error', "Error starting sync, exit code #{$?.exitstatus}", :red
           say_status 'message', out
         else
-          say_status 'success', "Synced #{@options['src']}", :green
+          say_status 'ok', "Synced #{@options['src']}", :white
           if @options['verbose']
             say_status 'output', out
           end
@@ -42,8 +55,8 @@ module Docker_Sync
         args = []
 
         unless @options['sync_excludes'].nil?
-          # TODO: does unison support excludes as a command paramter? seems to be a config-value only
-          say_status 'warning','Excludes are yet not implemented for unison!', :orange
+          # TODO: does unison support excludes as a command parameter? seems to be a config-value only
+          say_status 'warning','Excludes are yet not implemented for unison!', :yellow
           #  args = @options['sync_excludes'].map { |pattern| "--exclude='#{pattern}'" } + args
         end
         args.push(@options['src'])
@@ -51,30 +64,34 @@ module Docker_Sync
         args.push('-batch')
         args.push(@options['sync_args']) if @options.key?('sync_args')
         args.push("socket://#{@options['sync_host_ip']}:#{@options['sync_host_port']}/")
+        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
       end
 
       def start_container
-        say_status 'ok', 'Starting rsync', :white
+        say_status 'ok', 'Starting unison', :white
         running = `docker ps --filter 'status=running' --filter 'name=#{@sync_name}' | grep #{@sync_name}`
         if running == ''
-          say_status 'ok', "#{@sync_name} container not running", :white
-          exists = `docker ps --filter "status=exited" --filter "name=filesync_dw" | grep filesync_dw`
+          say_status 'ok', "#{@sync_name} container not running", :white if @options['verbose']
+          exists = `docker ps --filter "status=exited" --filter "name=#{@sync_name}" | grep #{@sync_name}`
           if exists == ''
-            say_status 'ok', "creating #{@sync_name} container", :white
+            say_status 'ok', "creating #{@sync_name} container", :white if @options['verbose']
             cmd = "docker run -p '#{@options['sync_host_port']}:#{UNISON_CONTAINER_PORT}' -v #{@sync_name}:#{@options['dest']} -e UNISON_VERSION=#{UNISON_VERSION} -e UNISON_WORKING_DIR=#{@options['dest']} --name #{@sync_name} -d #{UNISON_IMAGE}"
           else
-            say_status 'success', "starting #{@sync_name} container", :green
+            say_status 'ok', "starting #{@sync_name} container", :ok if @options['verbose']
             cmd = "docker start #{@sync_name}"
           end
-          say_status 'command', cmd, :white
+          say_status 'command', cmd, :white if @options['verbose']
           `#{cmd}` || raise('Start failed')
         else
           say_status 'ok', "#{@sync_name} container still running", :blue
         end
-        say_status 'success', "starting initial #{@sync_name} of src", :green
+        say_status 'ok', "starting initial #{@sync_name} of src", :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 stop_container

data/lib/docker_sync/watch_strategy/fswatch.rb

@@ -1,10 +1,14 @@
 require 'thor/shell'
 require 'execution'
+require 'preconditions'
+
 module Docker_Sync
   module WatchStrategy
     class Fswatch
       include Thor::Shell
       include Execution
+      include Preconditions
+
       @options
       @sync_name
       @watch_thread
@@ -12,6 +16,13 @@ module Docker_Sync
       def initialize(sync_name, options)
         @sync_name = sync_name
         @options = options
+
+        begin
+          fswatch_available
+        rescue Exception => e
+          say_status 'error', e.message, :red
+          exit 1
+        end
       end
 
       def run
@@ -26,10 +37,11 @@ module Docker_Sync
 
       def watch
         args = watch_options
-        say_status 'ok', "Starting to watch #{@options['src']} - Press CTRL-C to stop", :green
+        say_status 'success', "Starting to watch #{@options['src']} - Press CTRL-C to stop", :green
         cmd = 'fswatch ' + args.join(' ')
         say_status 'command', cmd, :white if @options['verbose']
 
+        # run a thread here, since it is blocking
         @watch_thread = threadexec(cmd, "Sync #{@sync_name}", :blue)
       end
 
@@ -41,7 +53,17 @@ module Docker_Sync
         args.push('-orIE')
         args.push(@options['watch_args']) if @options.key?('watch_args')
         args.push(@options['src'])
-        args.push(" | xargs -I -n1 docker-sync sync -n #{@sync_name} --config='#{@options['config_path']}'")
+
+        sync_command = 'thor sync:sync'
+        begin
+          docker_sync_available
+          sync_command = 'docker-sync sync'
+        rescue Exception => e
+          say_status 'warning', 'docker-sync not available, assuming dev mode, using thor', :yellow
+          puts e.message
+          sync_command = 'thor sync:sync'
+        end
+        args.push(" | xargs -I -n1 #{sync_command} -n #{@sync_name} --config='#{@options['config_path']}'")
       end
 
       def watch_thread

data/lib/execution.rb

@@ -1,5 +1,5 @@
 require 'open3'
-require 'colorize'
+require 'thor/shell'
 
 module Execution
 
@@ -7,8 +7,9 @@ module Execution
 
   def threadexec(command, prefix = nil, color = nil)
 
-    unless prefix.nil?
-      prefix = "#{prefix}    | "
+    if prefix.nil?
+      # TODO: probably pick the command name without args
+      prefix = 'unknown'
     end
 
     if color.nil?
@@ -19,11 +20,11 @@ module Execution
       Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
 
         while lineOut = stdout.gets
-          puts prefix.nil? ? lineOut : prefix.colorize(color) + lineOut
+          say_status prefix, lineOut, color
         end
 
         while lineErr = stderr.gets
-          puts prefix.nil? ? lineErr : prefix.colorize(color) + lineErr
+          say_status prefix, lineErr, :red
         end
 
       end

data/lib/preconditions.rb

@@ -0,0 +1,46 @@
+require 'mkmf'
+
+module Preconditions
+  def check_all_preconditions
+    docker_available
+    docker_running
+    fswatch_available
+  end
+
+  def 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 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 fswatch_available
+    if (find_executable0 'fswatch').nil?
+      raise('No fswatch available. Install it by "brew install fswatch"')
+    end
+  end
+
+  def docker_sync_available
+    if (find_executable0 'docker-sync').nil?
+      raise('No docker-sync available. Install it by "gem install docker-sync"')
+    end
+  end
+
+  def 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 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
+end

data/tasks/sync.thor

@@ -1,13 +1,23 @@
 require 'docker_sync/sync_manager'
 require 'config'
+require 'preconditions'
 
 class Sync < Thor
   include DockerSyncConfig
+  include Preconditions
+
   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'
 
   desc 'start', 'Start all sync configurations in this project'
   def start
+    begin
+      check_all_preconditions
+    rescue Exception => e
+      say_status 'error', e.message, :red
+      exit 1
+    end
+
     if options[:config]
       config_path = options[:config]
     else
@@ -24,6 +34,13 @@ class Sync < Thor
 
   desc 'sync_only', 'sync - do not start a watcher'
   def sync
+    begin
+      check_all_preconditions
+    rescue Exception => e
+      say_status 'error', e.message, :red
+      exit 1
+    end
+
     if options[:config]
       config_path = options[:config]
     else
@@ -40,6 +57,13 @@ class Sync < Thor
 
   desc 'clean', 'Stop and clean up all sync endpoints'
   def clean
+    begin
+      check_all_preconditions
+    rescue Exception => e
+      say_status 'error', e.message, :red
+      exit 1
+    end
+
     if options[:config]
       config_path = options[:config]
     else
@@ -58,6 +82,13 @@ class Sync < Thor
   desc 'list', 'List all sync-points of the project configuration path'
   method_option :verbose, :default => false, :type => :boolean, :desc => 'Verbose output'
   def list
+    begin
+      check_all_preconditions
+    rescue Exception => e
+      say_status 'error', e.message, :red
+      exit 1
+    end
+
     if options[:config]
       config_path = options[:config]
     else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-sync
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Eugen Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-08 00:00:00.000000000 Z
+date: 2016-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: colorize
-  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
@@ -55,6 +41,7 @@ files:
 - lib/docker_sync/sync_strategy/unison.rb
 - lib/docker_sync/watch_strategy/fswatch.rb
 - lib/execution.rb
+- lib/preconditions.rb
 - tasks/sync.thor
 homepage: https://github.com/EugenMayer/docker_sync
 licenses: