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 # [--description] Description for the pipeline instance.
  46 #
  47 # == Parameters
  48 #
  49 # [param_name=param_value]
  50 #
  51 # [param_name param_value] Set (or override) the default value for
  52 #                          every parameter with the given name.
  53 #
  54 # [component_name::param_name=param_value]
  55 # [component_name::param_name param_value]
  56 # [--component_name::param_name=param_value]
  57 # [--component_name::param_name param_value] Set the value of a
  58 #                                            parameter for a single
  59 #                                            component.
  60 #
  61 class WhRunPipelineInstance
  62 end
  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
 113 # Parse command line options (the kind that control the behavior of
 114 # this program, that is, not the pipeline component parameters).
 115
 116 p = Trollop::Parser.new do
 117   version __FILE__
 118   opt(:dry_run,
 119       "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.",
 120       :type => :boolean,
 121       :short => :n)
 122   opt(:status_text,
 123       "Store plain text status in given file.",
 124       :short => :none,
 125       :type => :string,
 126       :default => '/dev/stdout')
 127   opt(:status_json,
 128       "Store json-formatted pipeline in given file.",
 129       :short => :none,
 130       :type => :string,
 131       :default => '/dev/null')
 132   opt(:no_wait,
 133       "Do not wait for jobs to finish. Just look up status, submit new jobs if needed, and exit.",
 134       :short => :none,
 135       :type => :boolean)
 136   opt(:no_reuse,
 137       "Do not reuse existing jobs to satisfy pipeline components. Submit a new job for every component.",
 138       :short => :none,
 139       :type => :boolean)
 140   opt(:debug,
 141       "Print extra debugging information on stderr.",
 142       :type => :boolean)
 143   opt(:debug_level,
 144       "Set debug verbosity level.",
 145       :short => :none,
 146       :type => :integer)
 147   opt(:template,
 148       "UUID of pipeline template, or path to local pipeline template file.",
 149       :short => :none,
 150       :type => :string)
 151   opt(:instance,
 152       "UUID of pipeline instance.",
 153       :short => :none,
 154       :type => :string)
 155   opt(:submit,
 156       "Submit the pipeline instance to the server, and exit. Let the Crunch dispatch service satisfy the components by finding/running jobs.",
 157       :short => :none,
 158       :type => :boolean)
 159   opt(:run_pipeline_here,
 160       "Manage the pipeline instance in-process. Submit jobs to Crunch as needed. Do not exit until the pipeline finishes (or fails).",
 161       :short => :none,
 162       :type => :boolean)
 163   opt(:run_jobs_here,
 164       "Run jobs in the local terminal session instead of submitting them to Crunch. Implies --run-pipeline-here. Note: this results in a significantly different job execution environment, and some Crunch features are not supported. It can be necessary to modify a pipeline in order to make it run this way.",
 165       :short => :none,
 166       :type => :boolean)
 167   opt(:run_here,
 168       "Synonym for --run-jobs-here.",
 169       :short => :none,
 170       :type => :boolean)
 171   opt(:description,
 172       "Description for the pipeline instance.",
 173       :short => :none,
 174       :type => :string)
 175   stop_on [:'--']
 176 end
 177 $options = Trollop::with_standard_exception_handling p do
 178   p.parse ARGV
 179 end
 180 $debuglevel = $options[:debug_level] || ($options[:debug] && 1) || 0
 181
 182 $options[:run_jobs_here] ||= $options[:run_here] # old flag name
 183 $options[:run_pipeline_here] ||= $options[:run_jobs_here] # B requires A
 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_pipeline_here] == $options[:submit]
 196   abort "#{$0}: error: you must supply --run-pipeline-here, --run-jobs-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 $arv = Arvados.new api_version: 'v1'
 218 $client = $arv.client
 219 $arvados = $arv.arvados_api
 220
 221 class PipelineInstance
 222   def self.find(uuid)
 223     result = $client.execute(:api_method => $arvados.pipeline_instances.get,
 224                              :parameters => {
 225                                :uuid => uuid
 226                              },
 227                              :authenticated => false,
 228                              :headers => {
 229                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 230                              })
 231     j = JSON.parse result.body, :symbolize_names => true
 232     unless j.is_a? Hash and j[:uuid]
 233       debuglog "Failed to get pipeline_instance: #{j[:errors] rescue nil}", 0
 234       nil
 235     else
 236       debuglog "Retrieved pipeline_instance #{j[:uuid]}"
 237       self.new(j)
 238     end
 239   end
 240   def self.create(attributes)
 241     result = $client.execute(:api_method => $arvados.pipeline_instances.create,
 242                              :body_object => {
 243                                :pipeline_instance => attributes
 244                              },
 245                              :authenticated => false,
 246                              :headers => {
 247                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 248                              })
 249     j = JSON.parse result.body, :symbolize_names => true
 250     unless j.is_a? Hash and j[:uuid]
 251       abort "\n#{Time.now} -- pipeline_template #{@template[:uuid]}\nFailed to create pipeline_instance: #{j[:errors] rescue nil} #{j.inspect}"
 252     end
 253     debuglog "Created pipeline instance: #{j[:uuid]}"
 254     self.new(j)
 255   end
 256   def save
 257     result = $client.execute(:api_method => $arvados.pipeline_instances.update,
 258                              :parameters => {
 259                                :uuid => @pi[:uuid]
 260                              },
 261                              :body_object => {
 262                                :pipeline_instance => @attributes_to_update
 263                              },
 264                              :authenticated => false,
 265                              :headers => {
 266                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 267                              })
 268     j = JSON.parse result.body, :symbolize_names => true
 269     unless j.is_a? Hash and j[:uuid]
 270       debuglog "Failed to save pipeline_instance: #{j[:errors] rescue nil}", 0
 271       nil
 272     else
 273       @attributes_to_update = {}
 274       @pi = j
 275     end
 276   end
 277   def []=(x,y)
 278     @attributes_to_update[x] = y
 279     @pi[x] = y
 280   end
 281   def [](x)
 282     @pi[x]
 283   end
 284
 285   def log_stderr(msg)
 286     $arv.log.create log: {
 287       event_type: 'stderr',
 288       object_uuid: self[:uuid],
 289       owner_uuid: self[:owner_uuid],
 290       properties: {"text" => msg},
 291     }
 292   end
 293
 294   protected
 295   def initialize(j)
 296     @attributes_to_update = {}
 297     @pi = j
 298   end
 299 end
 300
 301 class JobCache
 302   def self.get(uuid)
 303     @cache ||= {}
 304     result = $client.execute(:api_method => $arvados.jobs.get,
 305                              :parameters => {
 306                                :uuid => uuid
 307                              },
 308                              :authenticated => false,
 309                              :headers => {
 310                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 311                              })
 312     @cache[uuid] = JSON.parse result.body, :symbolize_names => true
 313   end
 314   def self.where(conditions)
 315     result = $client.execute(:api_method => $arvados.jobs.list,
 316                              :parameters => {
 317                                :limit => 10000,
 318                                :where => conditions.to_json
 319                              },
 320                              :authenticated => false,
 321                              :headers => {
 322                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 323                              })
 324     list = JSON.parse result.body, :symbolize_names => true
 325     if list and list[:items].is_a? Array
 326       list[:items]
 327     else
 328       []
 329     end
 330   end
 331   def self.create(pipeline, component, job, create_params)
 332     @cache ||= {}
 333
 334     body = {job: no_nil_values(job)}.merge(no_nil_values(create_params))
 335
 336     result = $client.execute(:api_method => $arvados.jobs.create,
 337                              :body_object => body,
 338                              :authenticated => false,
 339                              :headers => {
 340                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 341                              })
 342     j = JSON.parse result.body, :symbolize_names => true
 343     if j.is_a? Hash and j[:uuid]
 344       @cache[j[:uuid]] = j
 345     else
 346       debuglog "create job: #{j[:errors] rescue nil} with attributes #{body}", 0
 347
 348       msg = ""
 349       j[:errors].each do |err|
 350         msg += "Error creating job for component #{component}: #{err}\n"
 351       end
 352       msg += "Job submission was: #{body.to_json}"
 353
 354       pipeline.log_stderr(msg)
 355       nil
 356     end
 357   end
 358
 359   protected
 360
 361   def self.no_nil_values(hash)
 362     hash.reject { |key, value| value.nil? }
 363   end
 364 end
 365
 366 class WhRunPipelineInstance
 367   attr_reader :instance
 368
 369   def initialize(_options)
 370     @options = _options
 371   end
 372
 373   def fetch_template(template)
 374     if template.match /[^-0-9a-z]/
 375       # Doesn't look like a uuid -- use it as a filename.
 376       @template = JSON.parse File.read(template), :symbolize_names => true
 377     else
 378       result = $client.execute(:api_method => $arvados.pipeline_templates.get,
 379                                :parameters => {
 380                                  :uuid => template
 381                                },
 382                                :authenticated => false,
 383                                :headers => {
 384                                  authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 385                                })
 386       @template = JSON.parse result.body, :symbolize_names => true
 387       if !@template[:uuid]
 388         abort "#{$0}: fatal: failed to retrieve pipeline template #{template} #{@template[:errors].inspect rescue nil}"
 389       end
 390     end
 391     self
 392   end
 393
 394   def fetch_instance(instance_uuid)
 395     @instance = PipelineInstance.find(instance_uuid)
 396     @template = @instance
 397     self
 398   end
 399
 400   def apply_parameters(params_args)
 401     params_args.shift if params_args[0] == '--'
 402     params = {}
 403     while !params_args.empty?
 404       if (re = params_args[0].match /^(--)?([^-].*?)=(.+)/)
 405         params[re[2]] = re[3]
 406         params_args.shift
 407       elsif params_args.size > 1
 408         param = params_args.shift.sub /^--/, ''
 409         params[param] = params_args.shift
 410       else
 411         abort "\n#{Time.now} -- pipeline_template #{@template[:uuid]}\nSyntax error: I do not know what to do with arg \"#{params_args[0]}\""
 412       end
 413     end
 414
 415     if not @template[:components].is_a?(Hash)
 416       abort "\n#{Time.now} -- pipeline_template #{@template[:uuid]}\nSyntax error: Template missing \"components\" hash"
 417     end
 418     @components = @template[:components].dup
 419
 420     bad_components = @components.each_pair.select do |cname, cspec|
 421       not cspec.is_a?(Hash)
 422     end
 423     if bad_components.any?
 424       abort "\n#{Time.now} -- pipeline_template #{@template[:uuid]}\nSyntax error: Components not specified with hashes: #{bad_components.map(&:first).join(', ')}"
 425     end
 426
 427     bad_components = @components.each_pair.select do |cname, cspec|
 428       not cspec[:script_parameters].is_a?(Hash)
 429     end
 430     if bad_components.any?
 431       abort "\n#{Time.now} -- pipeline_template #{@template[:uuid]}\nSyntax error: Components missing \"script_parameters\" hashes: #{bad_components.map(&:first).join(', ')}"
 432     end
 433
 434     errors = []
 435     @components.each do |componentname, component|
 436       component[:script_parameters].each do |parametername, parameter|
 437         parameter = { :value => parameter } unless parameter.is_a? Hash
 438         value =
 439           (params["#{componentname}::#{parametername}"] ||
 440            parameter[:value] ||
 441            (parameter[:output_of].nil? &&
 442             (params[parametername.to_s] ||
 443              parameter[:default])) ||
 444            nil)
 445         if value.nil? and
 446             ![false,'false',0,'0'].index parameter[:required]
 447           if parameter[:output_of]
 448             next
 449           end
 450           errors << [componentname, parametername, "required parameter is missing"]
 451         end
 452         debuglog "parameter #{componentname}::#{parametername} == #{value}"
 453
 454         component[:script_parameters][parametername] =
 455           parameter.dup.merge(value: value)
 456       end
 457     end
 458     if !errors.empty?
 459       abort "\n#{Time.now} -- pipeline_template #{@template[:uuid]}\nErrors:\n#{errors.collect { |c,p,e| "#{c}::#{p} - #{e}\n" }.join ""}"
 460     end
 461     debuglog "options=" + @options.pretty_inspect
 462     self
 463   end
 464
 465   def setup_instance
 466     if @instance
 467       @instance[:properties][:run_options] ||= {}
 468       if @options[:no_reuse]
 469         # override properties of existing instance
 470         @instance[:properties][:run_options][:enable_job_reuse] = false
 471       else
 472         # Default to "enable reuse" if not specified. (This code path
 473         # can go away when old clients go away.)
 474         if @instance[:properties][:run_options][:enable_job_reuse].nil?
 475           @instance[:properties][:run_options][:enable_job_reuse] = true
 476         end
 477       end
 478     else
 479       description = $options[:description]
 480       description = ("Created at #{Time.now.localtime}" + (@template[:name].andand.size.andand>0 ? " using the pipeline template *#{@template[:name]}*" : "")) if !description
 481       @instance = PipelineInstance.
 482         create(components: @components,
 483                properties: {
 484                  run_options: {
 485                    enable_job_reuse: !@options[:no_reuse]
 486                  }
 487                },
 488                pipeline_template_uuid: @template[:uuid],
 489                description: description,
 490                state: ($options[:submit] ? 'RunningOnServer' : 'RunningOnClient'))
 491     end
 492     self
 493   end
 494
 495   def run
 496     moretodo = true
 497     interrupted = false
 498
 499     if @instance[:started_at].nil?
 500       @instance[:started_at] = Time.now
 501     end
 502
 503     job_creation_failed = 0
 504     while moretodo
 505       moretodo = false
 506       @components.each do |cname, c|
 507         job = nil
 508         owner_uuid = @instance[:owner_uuid]
 509         # Is the job satisfying this component already known to be
 510         # finished? (Already meaning "before we query API server about
 511         # the job's current state")
 512         c_already_finished = (c[:job] &&
 513                               c[:job][:uuid] &&
 514                               ["Complete", "Failed", "Cancelled"].include?(c[:job][:state]))
 515         if !c[:job] and
 516             c[:script_parameters].select { |pname, p| p.is_a? Hash and p[:output_of]}.empty?
 517           # No job yet associated with this component and is component inputs
 518           # are fully specified (any output_of script_parameters are resolved
 519           # to real value)
 520           my_submit_id = "instance #{@instance[:uuid]} rand #{rand(2**64).to_s(36)}"
 521           job = JobCache.create(@instance, cname, {
 522             :script => c[:script],
 523             :script_parameters => c[:script_parameters],
 524             :script_version => c[:script_version],
 525             :repository => c[:repository],
 526             :nondeterministic => c[:nondeterministic],
 527             :runtime_constraints => c[:runtime_constraints],
 528             :owner_uuid => owner_uuid,
 529             :is_locked_by_uuid => (@options[:run_jobs_here] ? owner_uuid : nil),
 530             :submit_id => my_submit_id,
 531             :state => (if @options[:run_jobs_here] then "Running" else "Queued" end)
 532           }, {
 533             # This is the right place to put these attributes when
 534             # dealing with new API servers.
 535             :minimum_script_version => c[:minimum_script_version],
 536             :exclude_script_versions => c[:exclude_minimum_script_versions],
 537             :find_or_create => (@instance[:properties][:run_options].andand[:enable_job_reuse] &&
 538                                 !c[:nondeterministic]),
 539             :filters => c[:filters]
 540           })
 541           if job
 542             debuglog "component #{cname} new job #{job[:uuid]}"
 543             c[:job] = job
 544             c[:run_in_process] = (@options[:run_jobs_here] and
 545                                   job[:submit_id] == my_submit_id)
 546           else
 547             debuglog "component #{cname} new job failed", 0
 548             job_creation_failed += 1
 549           end
 550         end
 551
 552         if c[:job] and c[:run_in_process] and not ["Complete", "Failed", "Cancelled"].include? c[:job][:state]
 553           report_status
 554           begin
 555             require 'open3'
 556             Open3.popen3("arv-crunch-job", "--force-unlock",
 557                          "--job", c[:job][:uuid]) do |stdin, stdout, stderr, wait_thr|
 558               debuglog "arv-crunch-job pid #{wait_thr.pid} started", 0
 559               stdin.close
 560               while true
 561                 rready, wready, = IO.select([stdout, stderr], [])
 562                 break if !rready[0]
 563                 begin
 564                   buf = rready[0].read_nonblock(2**20)
 565                 rescue EOFError
 566                   break
 567                 end
 568                 (rready[0] == stdout ? $stdout : $stderr).write(buf)
 569               end
 570               stdout.close
 571               stderr.close
 572               debuglog "arv-crunch-job pid #{wait_thr.pid} exit #{wait_thr.value.to_i}", 0
 573             end
 574             if not $arv.job.get(uuid: c[:job][:uuid])[:finished_at]
 575               raise Exception.new("arv-crunch-job did not set finished_at.")
 576             end
 577           rescue Exception => e
 578             debuglog "Interrupted (#{e}). Failing job.", 0
 579             $arv.job.update(uuid: c[:job][:uuid],
 580                             job: {
 581                               state: "Failed"
 582                             })
 583           end
 584         end
 585
 586         if c[:job] and c[:job][:uuid]
 587           if ["Running", "Queued"].include?(c[:job][:state])
 588             # Job is running (or may be soon) so update copy of job record
 589             c[:job] = JobCache.get(c[:job][:uuid])
 590           end
 591
 592           if c[:job][:state] == "Complete"
 593             # Populate script_parameters of other components waiting for
 594             # this job
 595             @components.each do |c2name, c2|
 596               c2[:script_parameters].each do |pname, p|
 597                 if p.is_a? Hash and p[:output_of] == cname.to_s
 598                   debuglog "parameter #{c2name}::#{pname} == #{c[:job][:output]}"
 599                   c2[:script_parameters][pname] = c[:job][:output]
 600                   moretodo = true
 601                 end
 602               end
 603             end
 604             unless c_already_finished
 605               # This is my first time discovering that the job
 606               # succeeded. (At the top of this loop, I was still
 607               # waiting for it to finish.)
 608
 609               if @instance[:name].andand.length.andand > 0
 610                 pipeline_name = @instance[:name]
 611               elsif @template.andand[:name].andand.length.andand > 0
 612                 pipeline_name = @template[:name]
 613               else
 614                 pipeline_name = @instance[:uuid]
 615               end
 616               if c[:output_name] != false
 617                 # Create a collection located in the same project as the pipeline with the contents of the output.
 618                 portable_data_hash = c[:job][:output]
 619                 collections = $arv.collection.list(limit: 1,
 620                                                    filters: [['portable_data_hash', '=', portable_data_hash]],
 621                                                    select: ["portable_data_hash", "manifest_text"]
 622                                                    )[:items]
 623                 if collections.any?
 624                   name = c[:output_name] || "Output #{portable_data_hash[0..7]} of #{cname} of #{pipeline_name}"
 625
 626                   # check if there is a name collision.
 627                   name_collisions = $arv.collection.list(filters: [["owner_uuid", "=", owner_uuid],
 628                                                                    ["name", "=", name]])[:items]
 629
 630                   newcollection_actual = nil
 631                   if name_collisions.any? and name_collisions.first[:portable_data_hash] == portable_data_hash
 632                     # There is already a collection with the same name and the
 633                     # same contents, so just point to that.
 634                     newcollection_actual = name_collisions.first
 635                   end
 636
 637                   if newcollection_actual.nil?
 638                     # Did not find a collection with the same name (or the
 639                     # collection has a different portable data hash) so create
 640                     # a new collection with ensure_unique_name: true.
 641                     newcollection = {
 642                       owner_uuid: owner_uuid,
 643                       name: name,
 644                       portable_data_hash: collections.first[:portable_data_hash],
 645                       manifest_text: collections.first[:manifest_text]
 646                     }
 647                     debuglog "Creating collection #{newcollection}", 0
 648                     newcollection_actual = $arv.collection.create collection: newcollection, ensure_unique_name: true
 649                   end
 650
 651                   c[:output_uuid] = newcollection_actual[:uuid]
 652                 else
 653                   debuglog "Could not find a collection with portable data hash #{portable_data_hash}", 0
 654                 end
 655               end
 656             end
 657           elsif ["Queued", "Running"].include? c[:job][:state]
 658             # Job is running or queued to run, so indicate that pipeline
 659             # should continue to run
 660             moretodo = true
 661           elsif c[:job][:state] == "Cancelled"
 662             debuglog "component #{cname} job #{c[:job][:uuid]} cancelled."
 663             moretodo = false
 664           elsif c[:job][:state] == "Failed"
 665             moretodo = false
 666           end
 667         end
 668       end
 669       @instance[:components] = @components
 670       report_status
 671
 672       if @options[:no_wait]
 673         moretodo = false
 674       end
 675
 676       # If job creation fails, just give up on this pipeline instance.
 677       if job_creation_failed > 0
 678         moretodo = false
 679       end
 680
 681       if moretodo
 682         begin
 683           sleep 10
 684         rescue Interrupt
 685           debuglog "interrupt", 0
 686           interrupted = true
 687           break
 688         end
 689       end
 690     end
 691
 692     c_in_state = @components.values.group_by { |c|
 693       c[:job] and c[:job][:state]
 694     }
 695     succeeded = c_in_state["Complete"].andand.count || 0
 696     failed = (c_in_state["Failed"].andand.count || 0) + (c_in_state["Cancelled"].andand.count || 0)
 697     ended = succeeded + failed
 698
 699     success = (succeeded == @components.length)
 700
 701     # A job create call failed. Just give up.
 702     if job_creation_failed > 0
 703       debuglog "job creation failed - giving up on this pipeline instance", 0
 704       success = false
 705       failed += 1
 706     end
 707
 708     if interrupted
 709      if success
 710         @instance[:state] = 'Complete'
 711      else
 712         @instance[:state] = 'Paused'
 713       end
 714     else
 715       if ended == @components.length or failed > 0
 716         @instance[:state] = success ? 'Complete' : 'Failed'
 717       end
 718     end
 719
 720     if @instance[:finished_at].nil? and ['Complete', 'Failed'].include? @instance[:state]
 721       @instance[:finished_at] = Time.now
 722     end
 723
 724     debuglog "pipeline instance state is #{@instance[:state]}"
 725
 726     # set components_summary
 727     components_summary = {"todo" => @components.length - ended, "done" => succeeded, "failed" => failed}
 728     @instance[:components_summary] = components_summary
 729
 730     @instance.save
 731   end
 732
 733   def cleanup
 734     if @instance and @instance[:state] == 'RunningOnClient'
 735       @instance[:state] = 'Paused'
 736       @instance.save
 737     end
 738   end
 739
 740   def uuid
 741     @instance[:uuid]
 742   end
 743
 744   protected
 745
 746   def report_status
 747     @instance.save
 748
 749     if @options[:status_json] != '/dev/null'
 750       File.open(@options[:status_json], 'w') do |f|
 751         f.puts @components.pretty_inspect
 752       end
 753     end
 754
 755     if @options[:status_text] != '/dev/null'
 756       File.open(@options[:status_text], 'w') do |f|
 757         f.puts ""
 758         f.puts "#{Time.now} -- pipeline_instance #{@instance[:uuid]}"
 759         namewidth = @components.collect { |cname, c| cname.size }.max
 760         @components.each do |cname, c|
 761           jstatus = if !c[:job]
 762                       "-"
 763                     else case c[:job][:state]
 764                          when "Running"
 765                            "#{c[:job][:tasks_summary].inspect}"
 766                          when "Complete"
 767                            c[:job][:output]
 768                          when "Cancelled"
 769                            "cancelled #{c[:job][:cancelled_at]}"
 770                          when "Failed"
 771                            "failed #{c[:job][:finished_at]}"
 772                          when "Queued"
 773                            "queued #{c[:job][:created_at]}"
 774                          end
 775                     end
 776           f.puts "#{cname.to_s.ljust namewidth} #{c[:job] ? c[:job][:uuid] : '-'.ljust(27)} #{jstatus}"
 777         end
 778       end
 779     end
 780   end
 781
 782   def abort(msg)
 783     if @instance
 784       if ["New", "Ready", "RunningOnClient",
 785           "RunningOnServer"].include?(@instance[:state])
 786         @instance[:state] = "Failed"
 787         @instance[:finished_at] = Time.now
 788         @instance.save
 789       end
 790       @instance.log_stderr(msg)
 791     end
 792     Kernel::abort(msg)
 793   end
 794 end
 795
 796 runner = WhRunPipelineInstance.new($options)
 797 begin
 798   if $options[:template]
 799     runner.fetch_template($options[:template])
 800   else
 801     runner.fetch_instance($options[:instance])
 802   end
 803   runner.apply_parameters(p.leftovers)
 804   runner.setup_instance
 805   if $options[:submit]
 806     runner.instance.save
 807     puts runner.instance[:uuid]
 808   else
 809     runner.run
 810   end
 811 rescue Exception => e
 812   runner.cleanup
 813   raise e
 814 end