Class: Docker_Sync::SyncStrategy::Unison_DualSide

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

Constant Summary collapse

UNISON_CONTAINER_PORT = 
'5000'

Instance Method Summary collapse

Constructor Details

#initialize(sync_name, options) ⇒ Unison_DualSide

Returns a new instance of Unison_DualSide.



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

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:dualside'
  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

Instance Method Details

#clean ⇒ Object 



187
188
189
 
# File 'lib/docker-sync/sync_strategy/unison-dualside.rb', line 187

def clean
  reset_container
end

#get_container_name ⇒ Object 



169
170
171
 
# File 'lib/docker-sync/sync_strategy/unison-dualside.rb', line 169

def get_container_name
  return "#{@sync_name}"
end

#get_host_ip ⇒ Object

Try to guess the IP of the host to call the unison server from the container Or use the value specified in the config option



154
155
156
157
158
159
160
161
 
# File 'lib/docker-sync/sync_strategy/unison-dualside.rb', line 154

def get_host_ip
  if @options['unison-dualside_host_ip'] != 'auto' && @options.key?('unison-dualside_host_ip')
    host_ip = @options['host_ip']
  elsif @options['unison-dualside_host_ip'] == 'auto' || (not @options.key?('unison-dualside_host_ip'))
    host_ip = Socket.ip_address_list.find { |ai| ai.ipv4? && !ai.ipv4_loopback? }.ip_address
  end
  return host_ip
end

#get_volume_name ⇒ Object 



173
174
175
 
# File 'lib/docker-sync/sync_strategy/unison-dualside.rb', line 173

def get_volume_name
  return @sync_name
end

#reset_container ⇒ Object 



181
182
183
184
185
 
# File 'lib/docker-sync/sync_strategy/unison-dualside.rb', line 181

def reset_container
  stop_container
  `docker rm #{get_container_name}`
  `docker volume rm #{get_volume_name}`
end

#run ⇒ Object 



35
36
37
38
39
 
# File 'lib/docker-sync/sync_strategy/unison-dualside.rb', line 35

def run
  start_container
  start_local_server
  sync
end

#start_container ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/docker-sync/sync_strategy/unison-dualside.rb', line 85

def start_container
  say_status 'ok', 'Starting unison', :white
  container_name = get_container_name
  volume_name = get_volume_name
  env = {}

  env['ENABLE_WATCH'] = 'true'
  # Excludes for fswatch and unison uses the same value both in the host and in the container
  env['FSWATCH_EXCLUDES'] = @options['watch_excludes'].map { |pattern| "--exclude='#{pattern}'" }.join(' ') if @options.key?('watch_excludes')
  env['UNISON_EXCLUDES'] = @options['sync_excludes'].map { |pattern| "-ignore='Path #{pattern}'" }.join(' ') if @options.key?('sync_excludes')
  # Specify the IP of the host to call the host unison server from the container
  env['HOST_IP'] = get_host_ip
  env['UNISON_HOST_PORT'] = @options['unison-dualside_host_server_port']

  if @options['sync_userid'] == 'from_host'
    env['UNISON_DIR_OWNER'] = Process.uid
  end

  additional_docker_env = env.map{ |key,value| "-e #{key}=\"#{value}\"" }.join(' ')
  running = `docker ps --filter 'status=running' --filter 'name=#{container_name}' | 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}" | 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']} \
                        #{additional_docker_env} \
                        --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 5 # TODO: replace with unison -testserver
  sync
  say_status 'success', 'Unison server started', :green
end

#start_local_server ⇒ Object

Start an unison server on the host



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/docker-sync/sync_strategy/unison-dualside.rb', line 133

def start_local_server
  say_status 'ok', 'Starting local unison server', :white

  if not @options.key?('unison-dualside_host_server_port')
    raise('Missing unison-dualside_host_server_port option. In order to get files synced back automatically from the
    container, you must specify the port of the local unison server.')
  end
  cmd = "unison -socket #{@options['unison-dualside_host_server_port']}"
  say_status 'command', cmd, :white if @options['verbose']

  # Store the pid of the local unison server, to kill it when docker-sync stops
  @local_server_pid = Process.fork do
    # Run the local unison server in the source folder
    Dir.chdir(@options['src']){
      `#{cmd}` || raise('Start of local unison server failed')
    }
  end
end

#stop ⇒ Object 



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/docker-sync/sync_strategy/unison-dualside.rb', line 191

def stop
  say_status 'ok', "Stopping sync container #{get_container_name}"
  begin
    stop_container
    stop_local_server
  rescue Exception => e
    say_status 'error', "Stopping failed of #{get_container_name}:", :red
    puts e.message
  end
end

#stop_container ⇒ Object 



177
178
179
 
# File 'lib/docker-sync/sync_strategy/unison-dualside.rb', line 177

def stop_container
  `docker stop #{get_container_name}`
end

#stop_local_server ⇒ Object

Kill the local unison server



164
165
166
167
 
# File 'lib/docker-sync/sync_strategy/unison-dualside.rb', line 164

def stop_local_server
  Process.kill "TERM", @local_server_pid
  Process.wait @local_server_pid
end

#sync ⇒ Object 



41
42
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-dualside.rb', line 41

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

#sync_options ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/docker-sync/sync_strategy/unison-dualside.rb', line 62

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('-owner') if @options['sync_userid'] == 'from_host'
  args.push('-numericids') if @options['sync_userid'] == 'from_host'
  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')
    raise('Unison does not support sync_user, sync_group, sync_groupid - please use rsync if you need that')
  end
  if  @options.key?('sync_userid') && @options['sync_userid'] != 'from_host'
    raise('Unison does not support sync_userid with a parameter different than \'from_host\'')
  end
  return args
end