Class: Aspera::Fasp::AgentDirect

Inherits:
AgentBase show all
Defined in:
lib/aspera/fasp/agent_direct.rb

Overview

executes a local “ascp”, connects mgt port, equivalent of “Fasp Manager”

Constant Summary

Constants inherited from AgentBase

Aspera::Fasp::AgentBase::LISTENER_SESSION_ID_B, Aspera::Fasp::AgentBase::LISTENER_SESSION_ID_S

Instance Method Summary collapse

Methods inherited from AgentBase

#add_listener, validate_status_list

Instance Method Details

#send_command(job_id, session_index, data) ⇒ Object

send command of management port to ascp session ‘type’=>‘START’,‘source’=><em>path</em>,‘destination’=><em>path</em> ‘type’=>‘DONE’

Parameters:

  • identified transfer process

  • index of session (for multi session)

  • command on mgt port, examples:



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/aspera/fasp/agent_direct.rb', line 316

def send_command(job_id, session_index, data)
  job = @jobs[job_id]
  raise 'no such job' if job.nil?
  session = job[:sessions][session_index]
  raise 'no such session' if session.nil?
  Log.log.debug{"command: #{data}"}
  # build command
  command = data
    .keys
    .map{|k|"#{k.capitalize}: #{data[k]}"}
    .unshift('FASPMGR 2')
    .push('', '')
    .join("\n")
  session[:io].puts(command)
end

#shutdown ⇒ Object

used by asession (to be removed ?)



161
162
163
 
# File 'lib/aspera/fasp/agent_direct.rb', line 161

def shutdown
  Log.log.debug('fasp local shutdown')
end

#start_transfer(transfer_spec, token_regenerator: nil) ⇒ Object

start ascp transfer (non blocking), single or multi-session job information added to @jobs

Parameters:

  • aspera transfer specification



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
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
131
132
133
134
135
136
137
138
139
 
# File 'lib/aspera/fasp/agent_direct.rb', line 35

def start_transfer(transfer_spec, token_regenerator: nil)
  the_job_id = SecureRandom.uuid
  # clone transfer spec because we modify it (first level keys)
  transfer_spec = transfer_spec.clone
  # if there is aspera tags
  if transfer_spec['tags'].is_a?(Hash) && transfer_spec['tags'][Fasp::TransferSpec::TAG_RESERVED].is_a?(Hash)
    # TODO: what is this for ? only on local ascp ?
    # NOTE: important: transfer id must be unique: generate random id
    # using a non unique id results in discard of tags in AoC, and a package is never finalized
    # all sessions in a multi-session transfer must have the same xfer_id (see admin manual)
    transfer_spec['tags'][Fasp::TransferSpec::TAG_RESERVED]['xfer_id'] ||= SecureRandom.uuid
    Log.log.debug{"xfer id=#{transfer_spec['xfer_id']}"}
    # TODO: useful ? node only ?
    transfer_spec['tags'][Fasp::TransferSpec::TAG_RESERVED]['xfer_retry'] ||= 3600
  end
  Log.dump('ts', transfer_spec)

  # add bypass keys when authentication is token and no auth is provided
  if transfer_spec.key?('token') &&
      !transfer_spec.key?('remote_password') &&
      !transfer_spec.key?('EX_ssh_key_paths')
    # transfer_spec['remote_password'] = Installation.instance.bypass_pass # not used: no passphrase
    transfer_spec['EX_ssh_key_paths'] = Installation.instance.bypass_keys
  end

  # Compute this before using transfer spec because it potentially modifies the transfer spec
  # (even if the var is not used in single session)
  multi_session_info = nil
  if transfer_spec.key?('multi_session')
    multi_session_info = {
      count: transfer_spec['multi_session'].to_i
    }
    # Managed by multi-session, so delete from transfer spec
    transfer_spec.delete('multi_session')
    if multi_session_info[:count].negative?
      Log.log.error{"multi_session(#{transfer_spec['multi_session']}) shall be integer >= 0"}
      multi_session_info = nil
    elsif multi_session_info[:count].eql?(0)
      Log.log.debug('multi_session count is zero: no multi session')
      multi_session_info = nil
    elsif @options[:multi_incr_udp] # multi_session_info[:count] > 0
      # if option not true: keep default udp port for all sessions
      multi_session_info[:udp_base] = transfer_spec.key?('fasp_port') ? transfer_spec['fasp_port'] : TransferSpec::UDP_PORT
      # delete from original transfer spec, as we will increment values
      transfer_spec.delete('fasp_port')
      # override if specified, else use default value
    end
  end

  # compute known args
  env_args =  Parameters.new(transfer_spec, @options).ascp_args

  # add fallback cert and key as arguments if needed
  if ['1', 1, true, 'force'].include?(transfer_spec['http_fallback'])
    env_args[:args].unshift('-Y', Installation.instance.path(:fallback_cert_privkey))
    env_args[:args].unshift('-I', Installation.instance.path(:fallback_certificate))
  end

  env_args[:args].unshift('-q') if @options[:quiet]

  # transfer job can be multi session
  xfer_job = {
    id:       the_job_id,
    sessions: [] # all sessions as below
  }

  # generic session information
  session = {
    thread:            nil,               # Thread object monitoring management port, not nil when pushed to :sessions
    error:             nil,               # exception if failed
    io:                nil,               # management port server socket
    id:                nil,               # SessionId from INIT message in mgt port
    token_regenerator: token_regenerator, # regenerate bearer token with oauth
    env_args:          env_args           # env vars and args to ascp (from transfer spec)
  }

  if multi_session_info.nil?
    Log.log.debug('Starting single session thread')
    # single session for transfer : simple
    session[:thread] = Thread.new(session) {|s|transfer_thread_entry(s)}
    xfer_job[:sessions].push(session)
  else
    Log.log.debug('Starting multi session threads')
    1.upto(multi_session_info[:count]) do |i|
      # do not delay the first session
      sleep(@options[:spawn_delay_sec]) unless i.eql?(1)
      # do deep copy (each thread has its own copy because it is modified here below and in thread)
      this_session = session.clone
      this_session[:env_args] = this_session[:env_args].clone
      this_session[:env_args][:args] = this_session[:env_args][:args].clone
      this_session[:env_args][:args].unshift("-C#{i}:#{multi_session_info[:count]}")
      # option: increment (default as per ascp manual) or not (cluster on other side ?)
      this_session[:env_args][:args].unshift('-O', (multi_session_info[:udp_base] + i - 1).to_s) if @options[:multi_incr_udp]
      this_session[:thread] = Thread.new(this_session) {|s|transfer_thread_entry(s)}
      xfer_job[:sessions].push(this_session)
    end
  end
  Log.log.debug('started session thread(s)')

  # add job to list of jobs
  @jobs[the_job_id] = xfer_job
  Log.log.debug{"jobs: #{@jobs.keys.count}"}

  return the_job_id
end

#start_transfer_with_args_env(env_args, session) ⇒ Object

This is the low level method to start the “ascp” process currently, relies on command line arguments start ascp with management port. raises FaspError on error if there is a thread info: set and broadcast session id could be private method

Parameters:

  • a hash containing :args :env :ascp_version

  • this session information



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/aspera/fasp/agent_direct.rb', line 173

def start_transfer_with_args_env(env_args, session)
  raise 'env_args must be Hash' unless env_args.is_a?(Hash)
  raise 'session must be Hash' unless session.is_a?(Hash)
  # by default we assume an exception will be raised (for ensure block)
  exception_raised = true
  begin
    Log.log.debug{"env_args=#{env_args.inspect}"}
    # get location of ascp executable
    ascp_path = @mutex.synchronize do
      Fasp::Installation.instance.path(env_args[:ascp_version])
    end
    # (optional) check it exists
    raise Fasp::Error, "no such file: #{ascp_path}" unless File.exist?(ascp_path)
    # open an available (0) local TCP port as ascp management
    mgt_sock = TCPServer.new('127.0.0.1', 0)
    # clone arguments as we eed to modify with mgt port
    ascp_arguments = env_args[:args].clone
    # add management port on the selected local port
    ascp_arguments.unshift('-M', mgt_sock.addr[1].to_s)
    # start ascp in sub process
    Log.log.debug do
      [
        'execute:',
        env_args[:env].map{|k, v| "#{k}=#{Shellwords.shellescape(v)}"},
        Shellwords.shellescape(ascp_path),
        ascp_arguments.map{|a|Shellwords.shellescape(a)}
      ].flatten.join(' ')
    end
    # start process
    ascp_pid = Process.spawn(env_args[:env], [ascp_path, ascp_path], *ascp_arguments)
    # in parent, wait for connection to socket max 3 seconds
    Log.log.debug{"before accept for pid (#{ascp_pid})"}
    # init management socket
    ascp_mgt_io = nil
    Timeout.timeout(@options[:spawn_timeout_sec]) do
      ascp_mgt_io = mgt_sock.accept
      # management messages include file names which may be utf8
      # by default socket is US-ASCII
      # TODO: use same value as Encoding.default_external
      ascp_mgt_io.set_encoding(Encoding::UTF_8)
    end
    Log.log.debug{"after accept (#{ascp_mgt_io})"}
    session[:io] = ascp_mgt_io
    # exact text for event, with \n
    current_event_text = ''
    # parsed event (hash)
    current_event_data = nil
    # this is the last full status
    last_status_event = nil
    # read management port
    loop do
      # TODO: timeout here ?
      line = ascp_mgt_io.gets
      # nil when ascp process exits
      break if line.nil?
      current_event_text += line
      line.chomp!
      Log.log.debug{"line=[#{line}]"}
      case line
      when 'FASPMGR 2'
        # begin event
        current_event_data = {}
        current_event_text = ''
      when /^([^:]+): (.*)$/
        # event field
        current_event_data[Regexp.last_match(1)] = Regexp.last_match(2)
      when ''
        # empty line is separator to end event information
        raise 'unexpected empty line' if current_event_data.nil?
        current_event_data[AgentBase::LISTENER_SESSION_ID_B] = ascp_pid
        notify_listeners(current_event_text, current_event_data)
        case current_event_data['Type']
        when 'INIT'
          session[:id] = current_event_data['SessionId']
          Log.log.debug{"session id: #{session[:id]}"}
        when 'DONE', 'ERROR'
          # TODO: check if this is always the last event
          last_status_event = current_event_data
        end # event type
      else
        raise "unexpected line:[#{line}]"
      end # case
    end # loop (process mgt port lines)
    # check that last status was received before process exit
    if last_status_event.is_a?(Hash)
      case last_status_event['Type']
      when 'DONE'
        # all went well
        exception_raised = false
      when 'ERROR'
        Log.log.error{"code: #{last_status_event['Code']}"}
        if /bearer token/i.match?(last_status_event['Description'])
          Log.log.error('need to regenerate token'.red)
          if session[:token_regenerator].respond_to?(:refreshed_transfer_token)
            # regenerate token here, expired, or error on it
            # Note: in multi-session, each session will have a different one.
            env_args[:env]['ASPERA_SCP_TOKEN'] = session[:token_regenerator].refreshed_transfer_token
          end
        end
        # cannot resolve address
        # if last_status_event['Code'].to_i.eql?(14)
        #  Log.log.warn{"host: #{}"}
        # end
        raise Fasp::Error.new(last_status_event['Description'], last_status_event['Code'].to_i)
      else # case
        raise "unexpected last event type: #{last_status_event['Type']}"
      end
    else
      exception_raised = false
      Log.log.debug('no status read from ascp mgt port')
    end
  rescue SystemCallError => e
    # Process.spawn
    raise Fasp::Error, e.message
  rescue Timeout::Error
    raise Fasp::Error, 'timeout waiting mgt port connect'
  rescue Interrupt
    raise Fasp::Error, 'transfer interrupted by user'
  ensure
    # if ascp was successfully started
    unless ascp_pid.nil?
      # "wait" for process to avoid zombie
      Process.wait(ascp_pid)
      status = $CHILD_STATUS
      ascp_pid = nil
      session.delete(:io)
      if !status.success?
        message = "ascp failed with code #{status.exitstatus}"
        # raise error only if there was not already an exception
        raise Fasp::Error, message unless exception_raised
        # else just debug, as main exception is already here
        Log.log.debug(message)
      end
    end
  end # begin-ensure
end

#wait_for_transfers_completion ⇒ Object

wait for completion of all jobs started

Returns:

  • list of :success or error message



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/aspera/fasp/agent_direct.rb', line 143

def wait_for_transfers_completion
  Log.log.debug('wait_for_transfers_completion')
  # set to non-nil to exit loop
  result = []
  @jobs.each do |_id, job|
    job[:sessions].each do |session|
      Log.log.debug{"join #{session[:thread]}"}
      session[:thread].join
      result.push(session[:error] || :success)
    end
  end
  Log.log.debug('all transfers joined')
  # since all are finished and we return the result, clear statuses
  @jobs.clear
  return result
end