Merge branch 'master' into 3373-improve-gatk3-snv-pipeline
[arvados.git] / sdk / cli / bin / arv-run-pipeline-instance
1 #!/usr/bin/env ruby
2
3 # == Synopsis
4 #
5 #  arv-run-pipeline-instance --template pipeline-template-uuid [options] [--] [parameters]
6 #  arv-run-pipeline-instance --instance pipeline-instance-uuid [options]
7 #
8 # Satisfy a pipeline template by finding or submitting a mapreduce job
9 # for each pipeline component.
10 #
11 # == Options
12 #
13 # [--template uuid] Use the specified pipeline template.
14 #
15 # [--template path] Load the pipeline template from the specified
16 #                   local file.
17 #
18 # [--instance uuid] Use the specified pipeline instance.
19 #
20 # [-n, --dry-run] Do not start any new jobs or wait for existing jobs
21 #                 to finish. Just find out whether jobs are finished,
22 #                 queued, or running for each component
23 #
24 # [--submit] Do not try to satisfy any components. Just
25 #                          create an instance, print its UUID to
26 #                          stdout, and exit.
27 #
28 # [--no-wait] Make only as much progress as possible without entering
29 #             a sleep/poll loop.
30 #
31 # [--no-reuse] Do not reuse existing jobs to satisfy pipeline
32 #              components. Submit a new job for every component.
33 #
34 # [--debug] Print extra debugging information on stderr.
35 #
36 # [--debug-level N] Increase amount of debugging information. Default
37 #                   1, possible range 0..3.
38 #
39 # [--status-text path] Print plain text status report to a file or
40 #                      fifo. Default: /dev/stdout
41 #
42 # [--status-json path] Print JSON status report to a file or
43 #                      fifo. Default: /dev/null
44 #
45 # == Parameters
46 #
47 # [param_name=param_value]
48 #
49 # [param_name param_value] Set (or override) the default value for
50 #                          every parameter with the given name.
51 #
52 # [component_name::param_name=param_value]
53 # [component_name::param_name param_value]
54 # [--component_name::param_name=param_value]
55 # [--component_name::param_name param_value] Set the value of a
56 #                                            parameter for a single
57 #                                            component.
58 #
59 class WhRunPipelineInstance
60 end
61
62 $application_version = 1.0
63
64 if RUBY_VERSION < '1.9.3' then
65   abort <<-EOS
66 #{$0.gsub(/^\.\//,'')} requires Ruby version 1.9.3 or higher.
67   EOS
68 end
69
70 $arvados_api_version = ENV['ARVADOS_API_VERSION'] || 'v1'
71 $arvados_api_host = ENV['ARVADOS_API_HOST'] or
72   abort "#{$0}: fatal: ARVADOS_API_HOST environment variable not set."
73 $arvados_api_token = ENV['ARVADOS_API_TOKEN'] or
74   abort "#{$0}: fatal: ARVADOS_API_TOKEN environment variable not set."
75
76 begin
77   require 'arvados'
78   require 'rubygems'
79   require 'json'
80   require 'pp'
81   require 'trollop'
82   require 'google/api_client'
83 rescue LoadError => l
84   puts $:
85   abort <<-EOS
86 #{$0}: fatal: #{l.message}
87 Some runtime dependencies may be missing.
88 Try: gem install arvados pp google-api-client json trollop
89   EOS
90 end
91
92 def debuglog(message, verbosity=1)
93   $stderr.puts "#{File.split($0).last} #{$$}: #{message}" if $debuglevel >= verbosity
94 end
95
96 module Kernel
97   def suppress_warnings
98     original_verbosity = $VERBOSE
99     $VERBOSE = nil
100     result = yield
101     $VERBOSE = original_verbosity
102     return result
103   end
104 end
105
106 if $arvados_api_host.match /local/
107   # You probably don't care about SSL certificate checks if you're
108   # testing with a dev server.
109   suppress_warnings { OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE }
110 end
111
112 class Google::APIClient
113   def discovery_document(api, version)
114     api = api.to_s
115     return @discovery_documents["#{api}:#{version}"] ||=
116       begin
117         response = self.execute!(
118                                  :http_method => :get,
119                                  :uri => self.discovery_uri(api, version),
120                                  :authenticated => false
121                                  )
122         response.body.class == String ? JSON.parse(response.body) : response.body
123       end
124   end
125 end
126
127
128 # Parse command line options (the kind that control the behavior of
129 # this program, that is, not the pipeline component parameters).
130
131 p = Trollop::Parser.new do
132   version __FILE__
133   opt(:dry_run,
134       "Do not start any new jobs or wait for existing jobs to finish. Just find out whether jobs are finished, queued, or running for each component.",
135       :type => :boolean,
136       :short => :n)
137   opt(:status_text,
138       "Store plain text status in given file.",
139       :short => :none,
140       :type => :string,
141       :default => '/dev/stdout')
142   opt(:status_json,
143       "Store json-formatted pipeline in given file.",
144       :short => :none,
145       :type => :string,
146       :default => '/dev/null')
147   opt(:no_wait,
148       "Do not wait for jobs to finish. Just look up status, submit new jobs if needed, and exit.",
149       :short => :none,
150       :type => :boolean)
151   opt(:no_reuse,
152       "Do not reuse existing jobs to satisfy pipeline components. Submit a new job for every component.",
153       :short => :none,
154       :type => :boolean)
155   opt(:debug,
156       "Print extra debugging information on stderr.",
157       :type => :boolean)
158   opt(:debug_level,
159       "Set debug verbosity level.",
160       :short => :none,
161       :type => :integer)
162   opt(:template,
163       "UUID of pipeline template, or path to local pipeline template file.",
164       :short => :none,
165       :type => :string)
166   opt(:instance,
167       "UUID of pipeline instance.",
168       :short => :none,
169       :type => :string)
170   opt(:submit,
171       "Do not try to satisfy any components. Just create a pipeline instance and output its UUID.",
172       :short => :none,
173       :type => :boolean)
174   opt(:run_here,
175       "Manage the pipeline in process.",
176       :short => :none,
177       :type => :boolean)
178   stop_on [:'--']
179 end
180 $options = Trollop::with_standard_exception_handling p do
181   p.parse ARGV
182 end
183 $debuglevel = $options[:debug_level] || ($options[:debug] && 1) || 0
184
185 if $options[:instance]
186   if $options[:template] or $options[:submit]
187     abort "#{$0}: syntax error: --instance cannot be combined with --template or --submit."
188   end
189 elsif not $options[:template]
190   puts "error: you must supply a --template or --instance."
191   p.educate
192   abort
193 end
194
195 if $options[:run_here] == $options[:submit]
196   abort "#{$0}: syntax error: you must supply either --run-here or --submit."
197 end
198
199 # Suppress SSL certificate checks if ARVADOS_API_HOST_INSECURE
200
201 module Kernel
202   def suppress_warnings
203     original_verbosity = $VERBOSE
204     $VERBOSE = nil
205     result = yield
206     $VERBOSE = original_verbosity
207     return result
208   end
209 end
210
211 if ENV['ARVADOS_API_HOST_INSECURE']
212   suppress_warnings { OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE }
213 end
214
215 # Set up the API client.
216
217 $client ||= Google::APIClient.
218   new(:host => $arvados_api_host,
219       :application_name => File.split($0).last,
220       :application_version => $application_version.to_s)
221 $arvados = $client.discovered_api('arvados', $arvados_api_version)
222 $arv = Arvados.new api_version: 'v1'
223
224
225 class PipelineInstance
226   def self.find(uuid)
227     result = $client.execute(:api_method => $arvados.pipeline_instances.get,
228                              :parameters => {
229                                :uuid => uuid
230                              },
231                              :authenticated => false,
232                              :headers => {
233                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
234                              })
235     j = JSON.parse result.body, :symbolize_names => true
236     unless j.is_a? Hash and j[:uuid]
237       debuglog "Failed to get pipeline_instance: #{j[:errors] rescue nil}", 0
238       nil
239     else
240       debuglog "Retrieved pipeline_instance #{j[:uuid]}"
241       self.new(j)
242     end
243   end
244   def self.create(attributes)
245     result = $client.execute(:api_method => $arvados.pipeline_instances.create,
246                              :body_object => {
247                                :pipeline_instance => attributes.to_json
248                              },
249                              :authenticated => false,
250                              :headers => {
251                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
252                              })
253     j = JSON.parse result.body, :symbolize_names => true
254     unless j.is_a? Hash and j[:uuid]
255       abort "\n#{Time.now} -- pipeline_template #{@template[:uuid]}\nFailed to create pipeline_instance: #{j[:errors] rescue nil} #{j.inspect}"
256     end
257     debuglog "Created pipeline instance: #{j[:uuid]}"
258     self.new(j)
259   end
260   def save
261     result = $client.execute(:api_method => $arvados.pipeline_instances.update,
262                              :parameters => {
263                                :uuid => @pi[:uuid]
264                              },
265                              :body_object => {
266                                :pipeline_instance => @attributes_to_update.to_json
267                              },
268                              :authenticated => false,
269                              :headers => {
270                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
271                              })
272     j = JSON.parse result.body, :symbolize_names => true
273     unless j.is_a? Hash and j[:uuid]
274       debuglog "Failed to save pipeline_instance: #{j[:errors] rescue nil}", 0
275       nil
276     else
277       @attributes_to_update = {}
278       @pi = j
279     end
280   end
281   def []=(x,y)
282     @attributes_to_update[x] = y
283     @pi[x] = y
284   end
285   def [](x)
286     @pi[x]
287   end
288   protected
289   def initialize(j)
290     @attributes_to_update = {}
291     @pi = j
292   end
293 end
294
295 class JobCache
296   def self.get(uuid)
297     @cache ||= {}
298     result = $client.execute(:api_method => $arvados.jobs.get,
299                              :parameters => {
300                                :uuid => uuid
301                              },
302                              :authenticated => false,
303                              :headers => {
304                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
305                              })
306     @cache[uuid] = JSON.parse result.body, :symbolize_names => true
307   end
308   def self.where(conditions)
309     result = $client.execute(:api_method => $arvados.jobs.list,
310                              :parameters => {
311                                :limit => 10000,
312                                :where => conditions.to_json
313                              },
314                              :authenticated => false,
315                              :headers => {
316                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
317                              })
318     list = JSON.parse result.body, :symbolize_names => true
319     if list and list[:items].is_a? Array
320       list[:items]
321     else
322       []
323     end
324   end
325   def self.create(pipeline, component, job, create_params)
326     @cache ||= {}
327
328     body = {job: no_nil_values(job)}.merge(no_nil_values(create_params))
329
330     result = $client.execute(:api_method => $arvados.jobs.create,
331                              :body_object => body,
332                              :authenticated => false,
333                              :headers => {
334                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
335                              })
336     j = JSON.parse result.body, :symbolize_names => true
337     if j.is_a? Hash and j[:uuid]
338       @cache[j[:uuid]] = j
339     else
340       debuglog "create job: #{j[:errors] rescue nil} with attributes #{body}", 0
341
342       msg = ""
343       j[:errors].each do |err|
344         msg += "Error creating job for component #{component}: #{err}\n"
345       end
346       msg += "Job submission was: #{body.to_json}"
347
348       $client.execute(:api_method => $arvados.logs.create,
349                       :body_object => {
350                         :log => {
351                           :object_uuid => pipeline[:uuid],
352                           :event_type => 'stderr',
353                           :owner_uuid => pipeline[:owner_uuid],
354                           :properties => {"text" => msg}
355                         }
356                       },
357                       :authenticated => false,
358                       :headers => {
359                         authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
360                       })
361       nil
362     end
363   end
364
365   protected
366
367   def self.no_nil_values(hash)
368     hash.reject { |key, value| value.nil? }
369   end
370 end
371
372 class WhRunPipelineInstance
373   attr_reader :instance
374
375   def initialize(_options)
376     @options = _options
377   end
378
379   def fetch_template(template)
380     if template.match /[^-0-9a-z]/
381       # Doesn't look like a uuid -- use it as a filename.
382       @template = JSON.parse File.read(template), :symbolize_names => true
383       if !@template[:components]
384         abort ("#{$0}: Template loaded from #{template} " +
385                "does not have a \"components\" key")
386       end
387     else
388       result = $client.execute(:api_method => $arvados.pipeline_templates.get,
389                                :parameters => {
390                                  :uuid => template
391                                },
392                                :authenticated => false,
393                                :headers => {
394                                  authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
395                                })
396       @template = JSON.parse result.body, :symbolize_names => true
397       if !@template[:uuid]
398         abort "#{$0}: fatal: failed to retrieve pipeline template #{template} #{@template[:errors].inspect rescue nil}"
399       end
400     end
401     self
402   end
403
404   def fetch_instance(instance_uuid)
405     @instance = PipelineInstance.find(instance_uuid)
406     @template = @instance
407     self
408   end
409
410   def apply_parameters(params_args)
411     params_args.shift if params_args[0] == '--'
412     params = {}
413     while !params_args.empty?
414       if (re = params_args[0].match /^(--)?([^-].*?)=(.+)/)
415         params[re[2]] = re[3]
416         params_args.shift
417       elsif params_args.size > 1
418         param = params_args.shift.sub /^--/, ''
419         params[param] = params_args.shift
420       else
421         abort "\n#{Time.now} -- pipeline_template #{@template[:uuid]}\nSyntax error: I do not know what to do with arg \"#{params_args[0]}\""
422       end
423     end
424
425     @components = @template[:components].dup
426
427     errors = []
428     @components.each do |componentname, component|
429       component[:script_parameters].each do |parametername, parameter|
430         parameter = { :value => parameter } unless parameter.is_a? Hash
431         value =
432           (params["#{componentname}::#{parametername}"] ||
433            parameter[:value] ||
434            (parameter[:output_of].nil? &&
435             (params[parametername.to_s] ||
436              parameter[:default])) ||
437            nil)
438         if value.nil? and
439             ![false,'false',0,'0'].index parameter[:required]
440           if parameter[:output_of]
441             next
442           end
443           errors << [componentname, parametername, "required parameter is missing"]
444         end
445         debuglog "parameter #{componentname}::#{parametername} == #{value}"
446         component[:script_parameters][parametername] = value
447       end
448     end
449     if !errors.empty?
450       abort "\n#{Time.now} -- pipeline_template #{@template[:uuid]}\nErrors:\n#{errors.collect { |c,p,e| "#{c}::#{p} - #{e}\n" }.join ""}"
451     end
452     debuglog "options=" + @options.pretty_inspect
453     self
454   end
455
456   def setup_instance
457     if $options[:submit]
458       @instance ||= PipelineInstance.
459         create(:components => @components,
460               :pipeline_template_uuid => @template[:uuid],
461               :state => 'New')
462     else
463       @instance ||= PipelineInstance.
464         create(:components => @components,
465              :pipeline_template_uuid => @template[:uuid],
466              :state => 'RunningOnClient')
467     end
468     self
469   end
470
471   def run
472     moretodo = true
473     interrupted = false
474
475     job_creation_failed = 0
476     while moretodo
477       moretodo = false
478       @components.each do |cname, c|
479         job = nil
480         owner_uuid = @instance[:owner_uuid]
481         # Is the job satisfying this component already known to be
482         # finished? (Already meaning "before we query API server about
483         # the job's current state")
484         c_already_finished = (c[:job] &&
485                               c[:job][:uuid] &&
486                               !c[:job][:success].nil?)
487         if !c[:job] and
488             c[:script_parameters].select { |pname, p| p.is_a? Hash and p[:output_of]}.empty?
489           # No job yet associated with this component and is component inputs
490           # are fully specified (any output_of script_parameters are resolved
491           # to real value)
492           job = JobCache.create(@instance, cname, {
493             :script => c[:script],
494             :script_parameters => c[:script_parameters],
495             :script_version => c[:script_version],
496             :repository => c[:repository],
497             :nondeterministic => c[:nondeterministic],
498             :output_is_persistent => c[:output_is_persistent] || false,
499             :runtime_constraints => c[:runtime_constraints],
500             :owner_uuid => owner_uuid,
501           }, {
502             # This is the right place to put these attributes when
503             # dealing with new API servers.
504             :minimum_script_version => c[:minimum_script_version],
505             :exclude_script_versions => c[:exclude_minimum_script_versions],
506             :find_or_create => !(@options[:no_reuse] || c[:nondeterministic]),
507             :filters => c[:filters]
508           })
509           if job
510             debuglog "component #{cname} new job #{job[:uuid]}"
511             c[:job] = job
512           else
513             debuglog "component #{cname} new job failed", 0
514             job_creation_failed += 1
515           end
516         end
517
518         if c[:job] and c[:job][:uuid]
519           if (c[:job][:running] or
520               not (c[:job][:finished_at] or c[:job][:cancelled_at]))
521             # Job is running so update copy of job record
522             c[:job] = JobCache.get(c[:job][:uuid])
523           end
524
525           if c[:job][:success]
526             # Populate script_parameters of other components waiting for
527             # this job
528             @components.each do |c2name, c2|
529               c2[:script_parameters].each do |pname, p|
530                 if p.is_a? Hash and p[:output_of] == cname.to_s
531                   debuglog "parameter #{c2name}::#{pname} == #{c[:job][:output]}"
532                   c2[:script_parameters][pname] = c[:job][:output]
533                   moretodo = true
534                 end
535               end
536             end
537             unless c_already_finished
538               # This is my first time discovering that the job
539               # succeeded. (At the top of this loop, I was still
540               # waiting for it to finish.)
541               if c[:output_is_persistent]
542                 # I need to make sure a resources/wants link is in
543                 # place to protect the output from garbage
544                 # collection. (Normally Crunch does this for me, but
545                 # here I might be reusing the output of someone else's
546                 # job and I need to make sure it's understood that the
547                 # output is valuable to me, too.)
548                 wanted = c[:job][:output]
549                 debuglog "checking for existing persistence link for #{wanted}"
550                 @my_user_uuid ||= $arv.user.current[:uuid]
551                 links = $arv.link.list(limit: 1,
552                                        filters:
553                                        [%w(link_class = resources),
554                                         %w(name = wants),
555                                         %w(tail_uuid =) + [@my_user_uuid],
556                                         %w(head_uuid =) + [wanted]
557                                        ])[:items]
558                 if links.any?
559                   debuglog "link already exists, uuid #{links.first[:uuid]}"
560                 else
561                   newlink = $arv.link.create link: \
562                   {
563                     link_class: 'resources',
564                     name: 'wants',
565                     tail_kind: 'arvados#user',
566                     tail_uuid: @my_user_uuid,
567                     head_kind: 'arvados#collection',
568                     head_uuid: wanted,
569                     owner_uuid: owner_uuid
570                   }
571                   debuglog "added link, uuid #{newlink[:uuid]}"
572                 end
573               end
574             end
575           elsif c[:job][:running] ||
576               (!c[:job][:started_at] && !c[:job][:cancelled_at])
577             # Job is still running
578             moretodo = true
579           elsif c[:job][:cancelled_at]
580             debuglog "component #{cname} job #{c[:job][:uuid]} cancelled."
581           end
582         end
583       end
584       @instance[:components] = @components
585       report_status
586
587       if @options[:no_wait]
588         moretodo = false
589       end
590
591       # If job creation fails, just give up on this pipeline instance.
592       if job_creation_failed > 0
593         moretodo = false
594       end
595
596       if moretodo
597         begin
598           sleep 10
599         rescue Interrupt
600           debuglog "interrupt", 0
601           interrupted = true
602           break
603         end
604       end
605     end
606
607     ended = 0
608     succeeded = 0
609     failed = 0
610     @components.each do |cname, c|
611       if c[:job]
612         if c[:job][:finished_at] or c[:job][:cancelled_at] or (c[:job][:running] == false and c[:job][:success] == false)
613           ended += 1
614           if c[:job][:success] == true
615             succeeded += 1
616           elsif c[:job][:success] == false or c[:job][:cancelled_at]
617             failed += 1
618           end
619         end
620       end
621     end
622
623     success = (succeeded == @components.length)
624
625     # A job create call failed. Just give up.
626     if job_creation_failed > 0
627       debuglog "job creation failed - giving up on this pipeline instance", 0
628       success = false
629       failed += 1
630     end
631
632     if interrupted
633      if success
634         @instance[:state] = 'Complete'
635      else
636         @instance[:state] = 'Paused'
637       end
638     else
639       if ended == @components.length or failed > 0
640         @instance[:state] = success ? 'Complete' : 'Failed'
641       end
642     end
643
644     debuglog "pipeline instance state is #{@instance[:state]}"
645
646     # set components_summary
647     components_summary = {"todo" => @components.length - ended, "done" => succeeded, "failed" => failed}
648     @instance[:components_summary] = components_summary
649
650     @instance.save
651   end
652
653   def cleanup
654     if @instance and @instance[:state] == 'RunningOnClient'
655       @instance[:state] = 'Paused'
656       @instance.save
657     end
658   end
659
660   def uuid
661     @instance[:uuid]
662   end
663
664   protected
665
666   def report_status
667     @instance.save
668
669     if @options[:status_json] != '/dev/null'
670       File.open(@options[:status_json], 'w') do |f|
671         f.puts @components.pretty_inspect
672       end
673     end
674
675     if @options[:status_text] != '/dev/null'
676       File.open(@options[:status_text], 'w') do |f|
677         f.puts ""
678         f.puts "#{Time.now} -- pipeline_instance #{@instance[:uuid]}"
679         namewidth = @components.collect { |cname, c| cname.size }.max
680         @components.each do |cname, c|
681           jstatus = if !c[:job]
682                       "-"
683                     elsif c[:job][:running]
684                       "#{c[:job][:tasks_summary].inspect}"
685                     elsif c[:job][:success]
686                       c[:job][:output]
687                     elsif c[:job][:cancelled_at]
688                       "cancelled #{c[:job][:cancelled_at]}"
689                     elsif c[:job][:finished_at]
690                       "failed #{c[:job][:finished_at]}"
691                     elsif c[:job][:started_at]
692                       "started #{c[:job][:started_at]}"
693                     else
694                       "queued #{c[:job][:created_at]}"
695                     end
696           f.puts "#{cname.to_s.ljust namewidth} #{c[:job] ? c[:job][:uuid] : '-'.ljust(27)} #{jstatus}"
697         end
698       end
699     end
700   end
701 end
702
703 runner = WhRunPipelineInstance.new($options)
704 begin
705   if $options[:template]
706     runner.fetch_template($options[:template])
707   else
708     runner.fetch_instance($options[:instance])
709   end
710   runner.apply_parameters(p.leftovers)
711   runner.setup_instance
712   if $options[:submit]
713     runner.instance.save
714     puts runner.instance[:uuid]
715   else
716     runner.run
717   end
718 rescue Exception => e
719   runner.cleanup
720   raise e
721 end