Class: Docker_Sync::SyncStrategy::Unison

Inherits:
Object
  • Object
show all
Includes:
Execution, Thor::Shell
Defined in:
lib/docker-sync/sync_strategy/unison.rb

Constant Summary collapse

UNISON_CONTAINER_PORT = 
'5000'

Instance Method Summary collapse

Methods included from Execution

#forkexec, #threadexec

Constructor Details

#initialize(sync_name, options) ⇒ Unison

Returns a new instance of Unison.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 19

def initialize(sync_name, options)
  @options = options
  @sync_name = sync_name
  # if a custom image is set, apply it
  if @options.key?('image')
    @docker_image = @options['image']
  else
    @docker_image = 'eugenmayer/unison'
  end
  begin
    DockerSync::Preconditions::Strategy.instance.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

Instance Method Details

#clean ⇒ Object 



229
230
231
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 229

def clean
  reset_container
end

#expand_ignore_strings ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 95

def expand_ignore_strings
  expanded_ignore_strings = []

  exclude_type = 'Name'
  unless @options['sync_excludes_type'].nil?
    exclude_type = @options['sync_excludes_type']
  end

  unless @options['sync_excludes'].nil?
    expanded_ignore_strings = @options['sync_excludes'].map do |pattern|
      if exclude_type == 'none'
        # the ignore type like Name / Path are part of the pattern
        ignore_string = "#{pattern}"
      else
        ignore_string = "#{exclude_type} #{pattern}"
      end
      "-ignore='#{ignore_string}'"
    end
  end
  expanded_ignore_strings
end

#get_container_name ⇒ Object 



211
212
213
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 211

def get_container_name
  return "#{@sync_name}"
end

#get_host_port(container_name, container_port) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 198

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?
    say_status 'command', cmd
    say_status 'error', "Error getting mapped port, exit code #{$?.exitstatus}", :red
    say_status 'message', stderr
  end
  return stdout.gsub("\n",'')
end

#get_volume_name ⇒ Object 



215
216
217
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 215

def get_volume_name
  return @sync_name
end

#increase_watcher_limit ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 43

def increase_watcher_limit
  current_max_files_per_proc = `sysctl kern.maxfilesperproc | awk '{print $2}'`
  if current_max_files_per_proc.to_f < @options['max_inotify_watches']
    cmd = 'sudo sysctl -w kern.maxfilesperproc=' + @options['max_inotify_watches'].to_s
    say_status 'command', cmd, :white
    `#{cmd}` || raise('Unable to increase maxfilesperproc')
  else
    say_status 'command', 'Current maxfilesperproc set to ' + current_max_files_per_proc.to_s, :white
  end
  current_max_files = `sysctl kern.maxfiles | awk '{print $2}'`
  if current_max_files.to_f < @options['max_inotify_watches']
    cmd = 'sudo sysctl -w kern.maxfiles=' + @options['max_inotify_watches'].to_s
    say_status 'command', cmd, :white
    `#{cmd}` || raise('Unable to increase maxfiles')
  else
    say_status 'command', 'Current maxfiles set to ' + current_max_files.to_s, :white
  end
end

#reset_container ⇒ Object 



223
224
225
226
227
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 223

def reset_container
  stop_container
  `docker ps -a | grep #{get_container_name} && docker rm #{get_container_name}`
  `docker volume ls -q | grep #{get_volume_name} && docker volume rm #{get_volume_name}`
end

#run ⇒ Object 



37
38
39
40
41
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 37

def run
  increase_watcher_limit if @options.key?('max_inotify_watches')
  start_container
  sync
end

#start_container ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 144

def start_container
  say_status 'ok', "Starting unison for sync #{@sync_name}", :white

  container_name = get_container_name
  volume_name = get_volume_name
  env = {}
  say_status 'ok', 'sync_user is no longer supported, since it ise no needed, use sync_userid only please', :yellow if @options.key?('sync_user')

  ignore_strings = expand_ignore_strings
  env['UNISON_EXCLUDES'] = ignore_strings.join(' ')
  env['MAX_INOTIFY_WATCHES'] = @options['max_inotify_watches'] if @options.key?('max_inotify_watches')
  if @options['sync_userid'] == 'from_host'
    env['OWNER_UID'] = Process.uid
  else
    env['OWNER_UID'] = @options['sync_userid'] if @options.key?('sync_userid')
  end

  additional_docker_env = env.map{ |key,value| "-e #{key}=\"#{value}\"" }.join(' ')
  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']
      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
      say_status 'ok', "starting #{container_name} container", :white if @options['verbose']
      cmd = "docker start #{container_name} && docker exec #{container_name} supervisorctl restart unison"
    end
  else
    say_status 'ok', "#{container_name} container still running, restarting unison in container", :blue
    cmd = "docker exec #{container_name} supervisorctl restart unison"
  end
  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']
  # 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
  max_attempt = @options['max_attempt'] || 5
  loop do
    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
    sleep 1
  end
  sync
  say_status 'success', 'Unison server started', :green
end

#stop ⇒ Object 



233
234
235
236
237
238
239
240
241
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 233

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

#stop_container ⇒ Object 



219
220
221
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 219

def stop_container
  `docker ps | grep #{get_container_name} && docker stop #{get_container_name} && docker wait #{get_container_name}`
end

#sync ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 73

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', stdout
    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

#sync_options ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 117

def sync_options
  args = []
  args = expand_ignore_strings + args
  args.push("'#{@options['src']}'")
  args.push('-auto')
  args.push('-batch')
  args.push(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_group, sync_groupid - please use rsync if you need that')
  end
  return args
end

#sync_prefer ⇒ Object

cares about conflict resolution



135
136
137
138
139
140
141
142
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 135

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']}"
  end
end

#watch ⇒ Object 



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/docker-sync/sync_strategy/unison.rb', line 62

def watch
  args = sync_options
  args.push("-repeat watch")
  cmd = ''
  cmd = cmd + 'ulimit -n ' + @options['max_inotify_watches'].to_s + ' && ' if @options.key?('max_inotify_watches')
  cmd = cmd + 'unison ' + args.join(' ')

  say_status 'command', cmd, :white if @options['verbose']
  forkexec(cmd, "Sync #{@sync_name}", :blue)
end