Class: WorkflowRemoteClient::RemoteStep

Inherits:
Step
  • Object
show all
Defined in:
lib/rbbt/workflow/remote/remote_step.rb

Constant Summary

Constants inherited from Step

Step::INFO_SERIALIAZER, Step::STREAM_CACHE, Step::STREAM_CACHE_MUTEX

Instance Attribute Summary collapse

Attributes inherited from Step

#bindings, #dependencies, #dupped, #mutex, #overriden, #pid, #relocated, #result, #saved_stream, #seen, #stream, #workflow

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Step

#_abort, #_clean_finished, #_exec, #abort, #abort_pid, #abort_stream, #aborted?, #access, archive, #archive, #archived_info, #archived_inputs, #canfail_paths, #checks, #child, #clean, clean, #cmd, #config, #dependency_checks, #dirty?, #dirty_files, dup_stream, #error?, #exception, #execute_and_dup, #execute_dependency, #files_dir, files_dir, #get_exception, #info_file, info_file, #info_lock, #init_info, #input_dependencies, job_files_for_archive, job_name_for_info_file, #join_stream, #kill_children, #knowledge_base, link_job, #load, #load_dependencies_from_info, #load_file, #load_inputs_from_info, #log, log, log_block, #log_dependency_exec, log_progress, #log_progress, log_string, md5_file, #merge_info, #message, #messages, migrate, #missing?, #monitor_stream, #noinfo?, #out_of_date, #persist_checks, pid_file, #pid_file, prepare_dependencies, prepare_for_execution, #prepare_result, #produce, #progress_bar, prov_report, prov_report_msg, prov_status_msg, #provenance, #provenance_paths, purge, purge_stream_cache, #rec_access, #rec_dependencies, #recoverable_error?, #recursive_clean, #recursive_inputs, #relay_log, #relocated?, #resolve_input_steps, #rewind_inputs, #run_compute_dependencies, #run_dependencies, #save_file, save_inputs, save_job_inputs, #set_info, #short_path, #soft_grace, #stalled?, #status=, status_color, #status_lock, #step, step_info, #stop_dependencies, #streaming?, tmp_path, #tmp_path, #updatable?, #update, #updated?, wait_for_jobs, #waiting?, #writable?

Constructor Details

#initialize(base_url, task = nil, base_name = nil, inputs = nil, result_type = nil, result_description = nil, is_exec = false, is_stream = false, stream_input = nil) ⇒ RemoteStep

Returns a new instance of RemoteStep.



6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 6

def initialize(base_url, task = nil, base_name = nil, inputs = nil, result_type = nil, result_description = nil, is_exec = false, is_stream = false, stream_input = nil)
  @base_url, @task, @base_name, @inputs, @result_type, @result_description, @is_exec, @is_stream, @stream_input = base_url, task, base_name, inputs, result_type, result_description, is_exec, is_stream, stream_input
  @base_url = "http://" << @base_url unless @base_url =~ /^[a-z]+:\/\//
  @mutex = Mutex.new
  rest = base_url.include?('ssh:') ? false : true

  if rest
    @adaptor = WorkflowRESTClient
  else
    @adaptor = WorkflowSSHClient
  end

  self.extend @adaptor
end

Instance Attribute Details

#base_name ⇒ Object

Returns the value of attribute base_name.



4
5
6
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 4

def base_name
  @base_name
end

#base_url ⇒ Object

Returns the value of attribute base_url.



4
5
6
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 4

def base_url
  @base_url
end

#inputs ⇒ Object

Returns the value of attribute inputs.



4
5
6
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 4

def inputs
  @inputs
end

#is_exec ⇒ Object

Returns the value of attribute is_exec.



4
5
6
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 4

def is_exec
  @is_exec
end

#is_stream ⇒ Object

Returns the value of attribute is_stream.



4
5
6
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 4

def is_stream
  @is_stream
end

#result_description ⇒ Object

Returns the value of attribute result_description.



4
5
6
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 4

def result_description
  @result_description
end

#result_type ⇒ Object

Returns the value of attribute result_type.



4
5
6
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 4

def result_type
  @result_type
end

#stream_input ⇒ Object

Returns the value of attribute stream_input.



4
5
6
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 4

def stream_input
  @stream_input
end

#task ⇒ Object

Returns the value of attribute task.



4
5
6
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 4

def task
  @task
end

#url ⇒ Object

Returns the value of attribute url.



4
5
6
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 4

def url
  @url
end

Class Method Details

.get_streams(inputs, stream_input = nil) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 52

def self.get_streams(inputs, stream_input = nil)
  new_inputs = {}
  inputs.each do |k,v|
    stream = stream_input.to_s == k.to_s
    if Step === v 
      unless (v.done? or v.streaming?) # or RestClient::Step === v)
        v.run(true) and v.grace 
      end

      begin
        if stream
          new_inputs[k] = TSV.get_stream(v)
        else
          new_inputs[k] = v.load
        end
      rescue Exception
        raise $!
      end
    else
      new_inputs[k] = v
    end
  end
  new_inputs
end

Instance Method Details

#_restart ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 286

def _restart
  @done = nil
  @name = nil
  @started = nil
  @aborted = nil
  new_inputs = {}
  inputs.each do |k,i| 
    if File === i 
      new_inputs[k] = File.open(i.path)
    else
      new_inputs[k] = i
    end
  end
  @inputs = new_inputs
  @info = nil
end

#clean_name ⇒ Object 



21
22
23
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 21

def clean_name
  @base_name
end

#done? ⇒ Boolean

Returns:

  • (Boolean) 


154
155
156
157
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 154

def done?
  init_job unless @url
  @done || status.to_s == 'done' || status.to_s == 'noinfo'
end

#dup_inputs ⇒ Object 



84
85
86
87
88
89
90
91
92
93
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 84

def dup_inputs
  return if @dupped or ENV["RBBT_NO_STREAM"] == 'true'
  Log.low "Dupping inputs for #{path}"
  dupped_inputs = {}
  @inputs.collect do |k,input|
    dupped_inputs[k] = Step.dup_stream input
  end
  @inputs = dupped_inputs
  @dupped = true
end

#exec(noload = false) ⇒ Object 



207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 207

def exec(noload = false)
  @result ||= begin
                if noload == :stream
                  _run_job(:exec)
                else
                  exec_job 
                end
              ensure
                @started = true
              end
end

#file(file) ⇒ Object 



163
164
165
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 163

def file(file)
  @adaptor.get_raw(File.join(url, 'file', file))
end

#files ⇒ Object 



159
160
161
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 159

def files
  @adaptor.get_json(File.join(url, 'files'))
end

#fork(noload = false, semaphore = nil) ⇒ Object 



199
200
201
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 199

def fork(noload=false, semaphore=nil)
  init_job(:asynchronous)
end

#get_stream ⇒ Object 



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 167

def get_stream
  case @result
  when IO 
    @result
  when String
    StringIO.new @result
  else
    nil
  end
end

#get_streams ⇒ Object 



77
78
79
80
81
82
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 77

def get_streams
  return if @inputs_done
  @inputs = RemoteStep.get_streams @inputs, @stream_input
  @inputs_done = true
  @inputs
end

#grace ⇒ Object 



178
179
180
181
182
183
184
185
186
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 178

def grace
  produce unless @started
  sleep 0.1 unless started?
  sleep 0.5 unless started?
  sleep 1 unless started?
  while not (done? or started?)
    sleep 1 
  end
end

#info(check_lock = false) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 115

def info(check_lock=false)
  @done = @info && @info[:status] && (@info[:status].to_sym == :done || @info[:status].to_sym == :error)

  if !@done && (@last_info_time.nil? || (Time.now - @last_info_time) > 0.5)
    update = true 
  else
    update = false
  end

  @info = Persist.memory("RemoteSteps Info", :url => @url, :persist => true, :update => update) do
    @last_info_time = Time.now
    init_job unless @url
    info = @adaptor.get_json(File.join(@url, 'info'))
    info = @adaptor.fix_hash(info)
    info[:status] = info[:status].to_sym if String === info[:status]
    info
  end
  @info
end

#input_checks ⇒ Object 



303
304
305
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 303

def input_checks
  []
end

#join ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 219

def join
  init_job unless @url
  Log.debug{ "Joining RestClient: #{path}" }
  if IO === @result
    res = @result
    @result = nil
    Misc.consume_stream(res, true) 
  end

  if not (self.done? || self.aborted? || self.error?)
    self.info 
    return self if self.done? || self.aborted? || self.error?
    sleep 0.2 unless self.done? || self.aborted? || self.error?
    sleep 1 unless self.done? || self.aborted? || self.error?
    while not (self.done? || self.aborted? || self.error?)
      sleep 3
    end
  end

  self
end

#load_res(res, result_type = nil) ⇒ Object 



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
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 241

def load_res(res, result_type = nil)
  stream = true if res.respond_to? :read
  join unless stream
  result_type ||= self.result_type
  case result_type
  when :string
    stream ? res.read : res
  when :boolean
    (stream ? res.read : res) == 'true'
  when :tsv
    if stream
      TSV.open(res, :monitor => true)
    else
      TSV.open(StringIO.new(res))
    end
  when :annotations
    if stream
      Annotated.load_tsv(TSV.open(res))
    else
      Annotated.load_tsv(TSV.open(StringIO.new(res)))
    end
  when :array
    (stream ? res.read : res).split("\n")
    res.split("\n")
  else
    json_text = if IO === res
                  res.read
                else
                  res
                end
    begin
      JSON.parse json_text
    rescue
      case
      when json_text =~ /^\d+$/
        json_text.to_i
      when json_text =~ /^\d+\.\d/
        json_text.to_f
      else
        raise $!
      end
    end
  end
end

#name ⇒ Object 



95
96
97
98
99
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 95

def name
  return nil if @is_exec
  return @path if @url.nil?
  (Array === @url ? @url.first : @url).split("/").last
end

#name=(name) ⇒ Object 



101
102
103
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 101

def name=(name)
  @url = [base_url,task, name] * "/"
end

#nopid? ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 111

def nopid?
  false
end

#path ⇒ Object 



191
192
193
194
195
196
197
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 191

def path
  if @url
    Misc.add_GET_param(@url, "_format", "raw")
  else
    [base_url, task, @base_name + '-' +  Misc.fingerprint(inputs)] * "/"
  end
end

#run(no_load = false) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 25

def run(no_load = false)
  no_load = @is_stream ? :stream : true if no_load

  @mutex.synchronize do
    @result ||= begin
                  if @is_exec
                    exec(no_load)
                  elsif no_load == :stream
                    _run_job(:stream)
                  elsif no_load
                    init_job 
                    nil
                  else
                    init_job 
                    join
                    self.load
                  end
                ensure
                  @started = true
                end
  end

  return @result if no_load == :stream
  no_load ? Misc.add_GET_param(path, "_format", "raw") : @result
end

#running? ⇒ Boolean

Returns:

  • (Boolean) 


203
204
205
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 203

def running?
  ! %w(done error aborted noinfo).include? status.to_s
end

#started? ⇒ Boolean

Returns:

  • (Boolean) 


150
151
152
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 150

def started?
  @result != nil || @started || @streaming
end

#status ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 135

def status
  return :done if @done
  return nil unless url or started?
  #return :streaming if @streaming 
  begin
    status = info[:status]
    @done = true if status and status.to_sym == :done
    status
  rescue
    nil
  ensure
    @info = nil
  end
end

#task_name ⇒ Object 



105
106
107
108
109
 
# File 'lib/rbbt/workflow/remote/remote_step.rb', line 105

def task_name
  return task if task
  init_job
  (Array === @url ? @url.first : @url).split("/")[-2]
end