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-finished] Do not reuse existing outputs to satisfy
  32 #                       pipeline components. Always submit a new job
  33 #                       or use an existing job which has not yet
  34 #                       finished.
  35 #
  36 # [--no-reuse] Do not reuse existing jobs to satisfy pipeline
  37 #              components. Submit a new job for every component.
  38 #
  39 # [--debug] Print extra debugging information on stderr.
  40 #
  41 # [--debug-level N] Increase amount of debugging information. Default
  42 #                   1, possible range 0..3.
  43 #
  44 # [--status-text path] Print plain text status report to a file or
  45 #                      fifo. Default: /dev/stdout
  46 #
  47 # [--status-json path] Print JSON status report to a file or
  48 #                      fifo. Default: /dev/null
  49 #
  50 # == Parameters
  51 #
  52 # [param_name=param_value]
  53 #
  54 # [param_name param_value] Set (or override) the default value for
  55 #                          every parameter with the given name.
  56 #
  57 # [component_name::param_name=param_value]
  58 # [component_name::param_name param_value]
  59 # [--component_name::param_name=param_value]
  60 # [--component_name::param_name param_value] Set the value of a
  61 #                                            parameter for a single
  62 #                                            component.
  63 #
  64 class WhRunPipelineInstance
  65 end
  66
  67 $application_version = 1.0
  68
  69 if RUBY_VERSION < '1.9.3' then
  70   abort <<-EOS
  71 #{$0.gsub(/^\.\//,'')} requires Ruby version 1.9.3 or higher.
  72   EOS
  73 end
  74
  75 $arvados_api_version = ENV['ARVADOS_API_VERSION'] || 'v1'
  76 $arvados_api_host = ENV['ARVADOS_API_HOST'] or
  77   abort "#{$0}: fatal: ARVADOS_API_HOST environment variable not set."
  78 $arvados_api_token = ENV['ARVADOS_API_TOKEN'] or
  79   abort "#{$0}: fatal: ARVADOS_API_TOKEN environment variable not set."
  80
  81 begin
  82   require 'rubygems'
  83   require 'json'
  84   require 'pp'
  85   require 'trollop'
  86   require 'google/api_client'
  87 rescue LoadError => l
  88   puts $:
  89   abort <<-EOS
  90 #{$0}: fatal: #{l.message}
  91 Some runtime dependencies may be missing.
  92 Try: gem install pp google-api-client json trollop
  93   EOS
  94 end
  95
  96 def debuglog(message, verbosity=1)
  97   $stderr.puts "#{File.split($0).last} #{$$}: #{message}" if $debuglevel >= verbosity
  98 end
  99
 100 module Kernel
 101   def suppress_warnings
 102     original_verbosity = $VERBOSE
 103     $VERBOSE = nil
 104     result = yield
 105     $VERBOSE = original_verbosity
 106     return result
 107   end
 108 end
 109
 110 if $arvados_api_host.match /local/
 111   # You probably don't care about SSL certificate checks if you're
 112   # testing with a dev server.
 113   suppress_warnings { OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE }
 114 end
 115
 116 class Google::APIClient
 117   def discovery_document(api, version)
 118     api = api.to_s
 119     return @discovery_documents["#{api}:#{version}"] ||=
 120       begin
 121         response = self.execute!(
 122                                  :http_method => :get,
 123                                  :uri => self.discovery_uri(api, version),
 124                                  :authenticated => false
 125                                  )
 126         response.body.class == String ? JSON.parse(response.body) : response.body
 127       end
 128   end
 129 end
 130
 131
 132 # Parse command line options (the kind that control the behavior of
 133 # this program, that is, not the pipeline component parameters).
 134
 135 p = Trollop::Parser.new do
 136   version __FILE__
 137   opt(:dry_run,
 138       "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.",
 139       :type => :boolean,
 140       :short => :n)
 141   opt(:status_text,
 142       "Store plain text status in given file.",
 143       :short => :none,
 144       :type => :string,
 145       :default => '/dev/stdout')
 146   opt(:status_json,
 147       "Store json-formatted pipeline in given file.",
 148       :short => :none,
 149       :type => :string,
 150       :default => '/dev/null')
 151   opt(:no_wait,
 152       "Do not wait for jobs to finish. Just look up status, submit new jobs if needed, and exit.",
 153       :short => :none,
 154       :type => :boolean)
 155   opt(:no_reuse_finished,
 156       "Do not reuse existing outputs to satisfy pipeline components. Always submit a new job or use an existing job which has not yet finished.",
 157       :short => :none,
 158       :type => :boolean)
 159   opt(:no_reuse,
 160       "Do not reuse existing jobs to satisfy pipeline components. Submit a new job for every component.",
 161       :short => :none,
 162       :type => :boolean)
 163   opt(:debug,
 164       "Print extra debugging information on stderr.",
 165       :type => :boolean)
 166   opt(:debug_level,
 167       "Set debug verbosity level.",
 168       :short => :none,
 169       :type => :integer)
 170   opt(:template,
 171       "UUID of pipeline template, or path to local pipeline template file.",
 172       :short => :none,
 173       :type => :string)
 174   opt(:instance,
 175       "UUID of pipeline instance.",
 176       :short => :none,
 177       :type => :string)
 178   opt(:submit,
 179       "Do not try to satisfy any components. Just create a pipeline instance and output its UUID.",
 180       :short => :none,
 181       :type => :boolean)
 182   opt(:run_here,
 183       "Manage the pipeline in process.",
 184       :short => :none,
 185       :type => :boolean)
 186   stop_on [:'--']
 187 end
 188 $options = Trollop::with_standard_exception_handling p do
 189   p.parse ARGV
 190 end
 191 $debuglevel = $options[:debug_level] || ($options[:debug] && 1) || 0
 192
 193 if $options[:instance]
 194   if $options[:template] or $options[:submit]
 195     abort "#{$0}: syntax error: --instance cannot be combined with --template or --submit."
 196   end
 197 elsif not $options[:template]
 198   abort "#{$0}: syntax error: you must supply a --template or --instance."
 199 end
 200
 201 if $options[:run_here] == $options[:submit]
 202   abort "#{$0}: syntax error: you must supply either --run-here or --submit."
 203 end
 204
 205 # Set up the API client.
 206
 207 $client ||= Google::APIClient.
 208   new(:host => $arvados_api_host,
 209       :application_name => File.split($0).last,
 210       :application_version => $application_version.to_s)
 211 $arvados = $client.discovered_api('arvados', $arvados_api_version)
 212
 213
 214 class PipelineInstance
 215   def self.find(uuid)
 216     result = $client.execute(:api_method => $arvados.pipeline_instances.get,
 217                              :parameters => {
 218                                :uuid => uuid
 219                              },
 220                              :body => {
 221                                :api_token => ENV['ARVADOS_API_TOKEN']
 222                              },
 223                              :authenticated => false)
 224     j = JSON.parse result.body, :symbolize_names => true
 225     unless j.is_a? Hash and j[:uuid]
 226       debuglog "Failed to get pipeline_instance: #{j[:errors] rescue nil}", 0
 227       nil
 228     else
 229       debuglog "Retrieved pipeline_instance #{j[:uuid]}"
 230       self.new(j)
 231     end
 232   end
 233   def self.create(attributes)
 234     result = $client.execute(:api_method => $arvados.pipeline_instances.create,
 235                              :body => {
 236                                :api_token => ENV['ARVADOS_API_TOKEN'],
 237                                :pipeline_instance => attributes
 238                              },
 239                              :authenticated => false)
 240     j = JSON.parse result.body, :symbolize_names => true
 241     unless j.is_a? Hash and j[:uuid]
 242       abort "Failed to create pipeline_instance: #{j[:errors] rescue nil} #{j.inspect}"
 243     end
 244     debuglog "Created pipeline instance: #{j[:uuid]}"
 245     self.new(j)
 246   end
 247   def save
 248     result = $client.execute(:api_method => $arvados.pipeline_instances.update,
 249                              :parameters => {
 250                                :uuid => @pi[:uuid]
 251                              },
 252                              :body => {
 253                                :api_token => ENV['ARVADOS_API_TOKEN'],
 254                                :pipeline_instance => @attributes_to_update.to_json
 255                              },
 256                              :authenticated => false)
 257     j = JSON.parse result.body, :symbolize_names => true
 258     unless j.is_a? Hash and j[:uuid]
 259       debuglog "Failed to save pipeline_instance: #{j[:errors] rescue nil}", 0
 260       nil
 261     else
 262       @attributes_to_update = {}
 263       @pi = j
 264     end
 265   end
 266   def []=(x,y)
 267     @attributes_to_update[x] = y
 268     @pi[x] = y
 269   end
 270   def [](x)
 271     @pi[x]
 272   end
 273   protected
 274   def initialize(j)
 275     @attributes_to_update = {}
 276     @pi = j
 277   end
 278 end
 279
 280 class JobCache
 281   def self.get(uuid)
 282     @cache ||= {}
 283     result = $client.execute(:api_method => $arvados.jobs.get,
 284                              :parameters => {
 285                                :api_token => ENV['ARVADOS_API_TOKEN'],
 286                                :uuid => uuid
 287                              },
 288                              :authenticated => false)
 289     @cache[uuid] = JSON.parse result.body, :symbolize_names => true
 290   end
 291   def self.where(conditions)
 292     result = $client.execute(:api_method => $arvados.jobs.list,
 293                              :parameters => {
 294                                :api_token => ENV['ARVADOS_API_TOKEN'],
 295                                :limit => 10000,
 296                                :where => conditions.to_json
 297                              },
 298                              :authenticated => false)
 299     list = JSON.parse result.body, :symbolize_names => true
 300     if list and list[:items].is_a? Array
 301       list[:items]
 302     else
 303       []
 304     end
 305   end
 306   def self.create(attributes)
 307     @cache ||= {}
 308     result = $client.execute(:api_method => $arvados.jobs.create,
 309                              :parameters => {
 310                                :api_token => ENV['ARVADOS_API_TOKEN'],
 311                                :job => attributes.to_json
 312                              },
 313                              :authenticated => false)
 314     j = JSON.parse result.body, :symbolize_names => true
 315     if j.is_a? Hash and j[:uuid]
 316       @cache[j[:uuid]] = j
 317     else
 318       debuglog "create job: #{j[:errors] rescue nil}", 0
 319       nil
 320     end
 321   end
 322 end
 323
 324 class WhRunPipelineInstance
 325   attr_reader :instance
 326
 327   def initialize(_options)
 328     @options = _options
 329   end
 330
 331   def fetch_template(template)
 332     if template.match /[^-0-9a-z]/
 333       # Doesn't look like a uuid -- use it as a filename.
 334       @template = JSON.parse File.read(template), :symbolize_names => true
 335       if !@template[:components]
 336         abort ("#{$0}: Template loaded from #{template} " +
 337                "does not have a \"components\" key")
 338       end
 339     else
 340       result = $client.execute(:api_method => $arvados.pipeline_templates.get,
 341                                :parameters => {
 342                                  :api_token => ENV['ARVADOS_API_TOKEN'],
 343                                  :uuid => template
 344                                },
 345                                :authenticated => false)
 346       @template = JSON.parse result.body, :symbolize_names => true
 347       if !@template[:uuid]
 348         abort "#{$0}: fatal: failed to retrieve pipeline template #{template} #{@template[:errors].inspect rescue nil}"
 349       end
 350     end
 351     self
 352   end
 353
 354   def fetch_instance(instance_uuid)
 355     @instance = PipelineInstance.find(instance_uuid)
 356     @template = @instance
 357     self
 358   end
 359
 360   def apply_parameters(params_args)
 361     params_args.shift if params_args[0] == '--'
 362     params = {}
 363     while !params_args.empty?
 364       if (re = params_args[0].match /^(--)?([^-].*?)=(.+)/)
 365         params[re[2]] = re[3]
 366         params_args.shift
 367       elsif params_args.size > 1
 368         param = params_args.shift.sub /^--/, ''
 369         params[param] = params_args.shift
 370       else
 371         abort "Syntax error: I do not know what to do with arg \"#{params_args[0]}\""
 372       end
 373     end
 374
 375     @components = @template[:components].dup
 376
 377     errors = []
 378     @components.each do |componentname, component|
 379       component[:script_parameters].each do |parametername, parameter|
 380         parameter = { :value => parameter } unless parameter.is_a? Hash
 381         value =
 382           (params["#{componentname}::#{parametername}"] ||
 383            parameter[:value] ||
 384            (parameter[:output_of].nil? &&
 385             (params[parametername.to_s] ||
 386              parameter[:default])) ||
 387            nil)
 388         if value.nil? and
 389             ![false,'false',0,'0'].index parameter[:required]
 390           if parameter[:output_of]
 391             next
 392           end
 393           errors << [componentname, parametername, "required parameter is missing"]
 394         end
 395         debuglog "parameter #{componentname}::#{parametername} == #{value}"
 396         component[:script_parameters][parametername] = value
 397       end
 398     end
 399     if !errors.empty?
 400       abort "Errors:\n#{errors.collect { |c,p,e| "#{c}::#{p} - #{e}\n" }.join ""}"
 401     end
 402     debuglog "options=" + @options.pretty_inspect
 403     self
 404   end
 405
 406   def setup_instance
 407     @instance ||= PipelineInstance.
 408       create(:components => @components,
 409              :pipeline_template_uuid => @template[:uuid],
 410              :active => true)
 411     self
 412   end
 413
 414   def run
 415     moretodo = true
 416     while moretodo
 417       moretodo = false
 418       @components.each do |cname, c|
 419         job = nil
 420         if !c[:job] and
 421             c[:script_parameters].select { |pname, p| p.is_a? Hash }.empty?
 422           # Job is fully specified (all parameter values are present) but
 423           # no particular job has been found.
 424
 425           debuglog "component #{cname} ready to satisfy."
 426
 427           c.delete :wait
 428           second_place_job = nil # satisfies component, but not finished yet
 429
 430           (@options[:no_reuse] ? [] : JobCache.
 431            where(script: c[:script],
 432                  script_parameters: c[:script_parameters],
 433                  script_version_descends_from: c[:script_version])
 434            ).each do |candidate_job|
 435             candidate_params_downcase = Hash[candidate_job[:script_parameters].
 436                                              map { |k,v| [k.downcase,v] }]
 437             c_params_downcase = Hash[c[:script_parameters].
 438                                      map { |k,v| [k.downcase,v] }]
 439
 440             debuglog "component #{cname} considering job #{candidate_job[:uuid]} version #{candidate_job[:script_version]} parameters #{candidate_params_downcase.inspect}", 3
 441
 442             unless candidate_params_downcase == c_params_downcase
 443               next
 444             end
 445
 446             if c[:script_version] !=
 447                 candidate_job[:script_version][0,c[:script_version].length]
 448               debuglog "component #{cname} would be satisfied by job #{candidate_job[:uuid]} if script_version matched.", 2
 449               next
 450             end
 451
 452             unless candidate_job[:success] || candidate_job[:running] ||
 453                 (!candidate_job[:started_at] && !candidate_job[:cancelled_at])
 454               debuglog "component #{cname} would be satisfied by job #{candidate_job[:uuid]} if it were running or successful.", 2
 455               next
 456             end
 457
 458             if candidate_job[:success]
 459               unless @options[:no_reuse_finished]
 460                 job = candidate_job
 461                 $stderr.puts "using #{job[:uuid]} (finished at #{job[:finished_at]}) for component #{cname}"
 462                 c[:job] = job
 463               end
 464             else
 465               second_place_job ||= candidate_job
 466             end
 467             break
 468           end
 469           if not c[:job] and second_place_job
 470             job = second_place_job
 471             $stderr.puts "using #{job[:uuid]} (running since #{job[:started_at]}) for component #{cname}"
 472             c[:job] = job
 473           end
 474           if not c[:job]
 475             debuglog "component #{cname} not satisfied by any existing job."
 476             if !@options[:dry_run]
 477               debuglog "component #{cname} new job."
 478               job = JobCache.create(:script => c[:script],
 479                                     :script_parameters => c[:script_parameters],
 480                                     :runtime_constraints => c[:runtime_constraints] || {},
 481                                     :script_version => c[:script_version] || 'master')
 482               if job
 483                 debuglog "component #{cname} new job #{job[:uuid]}"
 484                 c[:job] = job
 485               else
 486                 debuglog "component #{cname} new job failed"
 487               end
 488             end
 489           end
 490         else
 491           c[:wait] = true
 492         end
 493         if c[:job] and c[:job][:uuid]
 494           if (c[:job][:running] or
 495               not (c[:job][:finished_at] or c[:job][:cancelled_at]))
 496             c[:job] = JobCache.get(c[:job][:uuid])
 497           end
 498           if c[:job][:success]
 499             # Populate script_parameters of other components waiting for
 500             # this job
 501             @components.each do |c2name, c2|
 502               c2[:script_parameters].each do |pname, p|
 503                 if p.is_a? Hash and p[:output_of] == cname.to_s
 504                   debuglog "parameter #{c2name}::#{pname} == #{c[:job][:output]}"
 505                   c2[:script_parameters][pname] = c[:job][:output]
 506                 end
 507               end
 508             end
 509           elsif c[:job][:running] ||
 510               (!c[:job][:started_at] && !c[:job][:cancelled_at])
 511             moretodo ||= true
 512           elsif c[:job][:cancelled_at]
 513             debuglog "component #{cname} job #{c[:job][:uuid]} cancelled."
 514           end
 515         end
 516       end
 517       @instance[:components] = @components
 518       @instance[:active] = moretodo
 519       report_status
 520
 521       if @options[:no_wait]
 522         moretodo = false
 523       end
 524
 525       if moretodo
 526         begin
 527           sleep 10
 528         rescue Interrupt
 529           debuglog "interrupt", 0
 530           abort
 531         end
 532       end
 533     end
 534
 535     ended = 0
 536     succeeded = 0
 537     failed = 0
 538     @components.each do |cname, c|
 539       if c[:job]
 540         if c[:job][:finished_at]
 541           ended += 1
 542           if c[:job][:success] == true
 543             succeeded += 1
 544           end
 545         end
 546       end
 547     end
 548
 549     if ended == @components.length
 550       @instance[:active] = false
 551       @instance[:success] = (succeeded == @components.length)
 552     end
 553
 554     @instance.save
 555   end
 556
 557   def cleanup
 558     if @instance
 559       @instance[:active] = false
 560       @instance.save
 561     end
 562   end
 563
 564   def uuid
 565     @instance[:uuid]
 566   end
 567
 568   protected
 569
 570   def report_status
 571     @instance.save
 572
 573     if @options[:status_json] != '/dev/null'
 574       File.open(@options[:status_json], 'w') do |f|
 575         f.puts @components.pretty_inspect
 576       end
 577     end
 578
 579     if @options[:status_text] != '/dev/null'
 580       File.open(@options[:status_text], 'w') do |f|
 581         f.puts ""
 582         f.puts "#{Time.now} -- pipeline_instance #{@instance[:uuid]}"
 583         namewidth = @components.collect { |cname, c| cname.size }.max
 584         @components.each do |cname, c|
 585           jstatus = if !c[:job]
 586                       "-"
 587                     elsif c[:job][:running]
 588                       "#{c[:job][:tasks_summary].inspect}"
 589                     elsif c[:job][:success]
 590                       c[:job][:output]
 591                     elsif c[:job][:cancelled_at]
 592                       "cancelled #{c[:job][:cancelled_at]}"
 593                     elsif c[:job][:finished_at]
 594                       "failed #{c[:job][:finished_at]}"
 595                     elsif c[:job][:started_at]
 596                       "started #{c[:job][:started_at]}"
 597                     else
 598                       "queued #{c[:job][:created_at]}"
 599                     end
 600           f.puts "#{cname.to_s.ljust namewidth} #{c[:job] ? c[:job][:uuid] : '-'.ljust(27)} #{jstatus}"
 601         end
 602       end
 603     end
 604   end
 605 end
 606
 607 runner = WhRunPipelineInstance.new($options)
 608 begin
 609   if $options[:template]
 610     runner.fetch_template($options[:template])
 611   else
 612     runner.fetch_instance($options[:instance])
 613   end
 614   runner.apply_parameters(p.leftovers)
 615   runner.setup_instance
 616   if $options[:submit]
 617     runner.instance.save
 618     puts runner.instance[:uuid]
 619   else
 620     runner.run
 621   end
 622 rescue Exception => e
 623   runner.cleanup
 624   raise e
 625 end