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 => {
 247                                :pipeline_instance => attributes
 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 "Failed 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 => {
 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(job, create_params)
 326     @cache ||= {}
 327     result = $client.execute(:api_method => $arvados.jobs.create,
 328                              :body => {
 329                                :job => job.to_json
 330                              }.merge(create_params),
 331                              :authenticated => false,
 332                              :headers => {
 333                                authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 334                              })
 335     j = JSON.parse result.body, :symbolize_names => true
 336     if j.is_a? Hash and j[:uuid]
 337       @cache[j[:uuid]] = j
 338     else
 339       debuglog "create job: #{j[:errors] rescue nil} with attributes #{job}", 0
 340       nil
 341     end
 342   end
 343 end
 344
 345 class WhRunPipelineInstance
 346   attr_reader :instance
 347
 348   def initialize(_options)
 349     @options = _options
 350   end
 351
 352   def fetch_template(template)
 353     if template.match /[^-0-9a-z]/
 354       # Doesn't look like a uuid -- use it as a filename.
 355       @template = JSON.parse File.read(template), :symbolize_names => true
 356       if !@template[:components]
 357         abort ("#{$0}: Template loaded from #{template} " +
 358                "does not have a \"components\" key")
 359       end
 360     else
 361       result = $client.execute(:api_method => $arvados.pipeline_templates.get,
 362                                :parameters => {
 363                                  :uuid => template
 364                                },
 365                                :authenticated => false,
 366                                :headers => {
 367                                  authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 368                                })
 369       @template = JSON.parse result.body, :symbolize_names => true
 370       if !@template[:uuid]
 371         abort "#{$0}: fatal: failed to retrieve pipeline template #{template} #{@template[:errors].inspect rescue nil}"
 372       end
 373     end
 374     self
 375   end
 376
 377   def fetch_instance(instance_uuid)
 378     @instance = PipelineInstance.find(instance_uuid)
 379     @template = @instance
 380     self
 381   end
 382
 383   def apply_parameters(params_args)
 384     params_args.shift if params_args[0] == '--'
 385     params = {}
 386     while !params_args.empty?
 387       if (re = params_args[0].match /^(--)?([^-].*?)=(.+)/)
 388         params[re[2]] = re[3]
 389         params_args.shift
 390       elsif params_args.size > 1
 391         param = params_args.shift.sub /^--/, ''
 392         params[param] = params_args.shift
 393       else
 394         abort "Syntax error: I do not know what to do with arg \"#{params_args[0]}\""
 395       end
 396     end
 397
 398     @components = @template[:components].dup
 399
 400     errors = []
 401     @components.each do |componentname, component|
 402       component[:script_parameters].each do |parametername, parameter|
 403         parameter = { :value => parameter } unless parameter.is_a? Hash
 404         value =
 405           (params["#{componentname}::#{parametername}"] ||
 406            parameter[:value] ||
 407            (parameter[:output_of].nil? &&
 408             (params[parametername.to_s] ||
 409              parameter[:default])) ||
 410            nil)
 411         if value.nil? and
 412             ![false,'false',0,'0'].index parameter[:required]
 413           if parameter[:output_of]
 414             next
 415           end
 416           errors << [componentname, parametername, "required parameter is missing"]
 417         end
 418         debuglog "parameter #{componentname}::#{parametername} == #{value}"
 419         component[:script_parameters][parametername] = value
 420       end
 421     end
 422     if !errors.empty?
 423       abort "Errors:\n#{errors.collect { |c,p,e| "#{c}::#{p} - #{e}\n" }.join ""}"
 424     end
 425     debuglog "options=" + @options.pretty_inspect
 426     self
 427   end
 428
 429   def setup_instance
 430     if $options[:submit]
 431       @instance ||= PipelineInstance.
 432         create(:components => @components,
 433               :pipeline_template_uuid => @template[:uuid],
 434               :state => 'New')
 435     else
 436       @instance ||= PipelineInstance.
 437         create(:components => @components,
 438              :pipeline_template_uuid => @template[:uuid],
 439              :state => 'RunningOnClient')
 440     end
 441     self
 442   end
 443
 444   def run
 445     moretodo = true
 446     interrupted = false
 447
 448     job_creation_failed = 0
 449     while moretodo
 450       moretodo = false
 451       @components.each do |cname, c|
 452         job = nil
 453         owner_uuid = @instance[:owner_uuid]
 454         # Is the job satisfying this component already known to be
 455         # finished? (Already meaning "before we query API server about
 456         # the job's current state")
 457         c_already_finished = (c[:job] &&
 458                               c[:job][:uuid] &&
 459                               !c[:job][:success].nil?)
 460         if !c[:job] and
 461             c[:script_parameters].select { |pname, p| p.is_a? Hash and p[:output_of]}.empty?
 462           # No job yet associated with this component and is component inputs
 463           # are fully specified (any output_of script_parameters are resolved
 464           # to real value)
 465           job = JobCache.create({
 466             :script => c[:script],
 467             :script_parameters => c[:script_parameters],
 468             :script_version => c[:script_version],
 469             :repository => c[:repository],
 470             :nondeterministic => c[:nondeterministic],
 471             :output_is_persistent => c[:output_is_persistent] || false,
 472             :runtime_constraints => c[:runtime_constraints],
 473             :owner_uuid => owner_uuid,
 474             # TODO: Delete the following three attributes when
 475             # supporting pre-20140418 API servers is no longer
 476             # important. New API servers take these as flags that
 477             # control behavior of create, rather than job attributes.
 478             :minimum_script_version => c[:minimum_script_version],
 479             :exclude_script_versions => c[:exclude_minimum_script_versions],
 480             :no_reuse => @options[:no_reuse] || c[:nondeterministic],
 481           }, {
 482             # This is the right place to put these attributes when
 483             # dealing with new API servers.
 484             :minimum_script_version => c[:minimum_script_version],
 485             :exclude_script_versions => c[:exclude_minimum_script_versions],
 486             :find_or_create => !(@options[:no_reuse] || c[:nondeterministic]),
 487           })
 488           if job
 489             debuglog "component #{cname} new job #{job[:uuid]}"
 490             c[:job] = job
 491           else
 492             debuglog "component #{cname} new job failed", 0
 493             job_creation_failed += 1
 494           end
 495         end
 496
 497         if c[:job] and c[:job][:uuid]
 498           if (c[:job][:running] or
 499               not (c[:job][:finished_at] or c[:job][:cancelled_at]))
 500             # Job is running so update copy of job record
 501             c[:job] = JobCache.get(c[:job][:uuid])
 502           end
 503
 504           if c[:job][:success]
 505             # Populate script_parameters of other components waiting for
 506             # this job
 507             @components.each do |c2name, c2|
 508               c2[:script_parameters].each do |pname, p|
 509                 if p.is_a? Hash and p[:output_of] == cname.to_s
 510                   debuglog "parameter #{c2name}::#{pname} == #{c[:job][:output]}"
 511                   c2[:script_parameters][pname] = c[:job][:output]
 512                   moretodo = true
 513                 end
 514               end
 515             end
 516             unless c_already_finished
 517               # This is my first time discovering that the job
 518               # succeeded. (At the top of this loop, I was still
 519               # waiting for it to finish.)
 520               if c[:output_is_persistent]
 521                 # I need to make sure a resources/wants link is in
 522                 # place to protect the output from garbage
 523                 # collection. (Normally Crunch does this for me, but
 524                 # here I might be reusing the output of someone else's
 525                 # job and I need to make sure it's understood that the
 526                 # output is valuable to me, too.)
 527                 wanted = c[:job][:output]
 528                 debuglog "checking for existing persistence link for #{wanted}"
 529                 @my_user_uuid ||= $arv.user.current[:uuid]
 530                 links = $arv.link.list(limit: 1,
 531                                        filters:
 532                                        [%w(link_class = resources),
 533                                         %w(name = wants),
 534                                         %w(tail_uuid =) + [@my_user_uuid],
 535                                         %w(head_uuid =) + [wanted]
 536                                        ])[:items]
 537                 if links.any?
 538                   debuglog "link already exists, uuid #{links.first[:uuid]}"
 539                 else
 540                   newlink = $arv.link.create link: \
 541                   {
 542                     link_class: 'resources',
 543                     name: 'wants',
 544                     tail_kind: 'arvados#user',
 545                     tail_uuid: @my_user_uuid,
 546                     head_kind: 'arvados#collection',
 547                     head_uuid: wanted,
 548                     owner_uuid: owner_uuid
 549                   }
 550                   debuglog "added link, uuid #{newlink[:uuid]}"
 551                 end
 552               end
 553             end
 554           elsif c[:job][:running] ||
 555               (!c[:job][:started_at] && !c[:job][:cancelled_at])
 556             # Job is still running
 557             moretodo = true
 558           elsif c[:job][:cancelled_at]
 559             debuglog "component #{cname} job #{c[:job][:uuid]} cancelled."
 560           end
 561         end
 562       end
 563       @instance[:components] = @components
 564       report_status
 565
 566       if @options[:no_wait]
 567         moretodo = false
 568       end
 569
 570       # If job creation fails, just give up on this pipeline instance.
 571       if job_creation_failed > 0
 572         moretodo = false
 573       end
 574
 575       if moretodo
 576         begin
 577           sleep 10
 578         rescue Interrupt
 579           debuglog "interrupt", 0
 580           interrupted = true
 581           break
 582         end
 583       end
 584     end
 585
 586     ended = 0
 587     succeeded = 0
 588     failed = 0
 589     @components.each do |cname, c|
 590       if c[:job]
 591         if c[:job][:finished_at] or c[:job][:cancelled_at] or (c[:job][:running] == false and c[:job][:success] == false)
 592           ended += 1
 593           if c[:job][:success] == true
 594             succeeded += 1
 595           elsif c[:job][:success] == false or c[:job][:cancelled_at]
 596             failed += 1
 597           end
 598         end
 599       end
 600     end
 601
 602     success = (succeeded == @components.length)
 603
 604     # A job create call failed. Just give up.
 605     if job_creation_failed > 0
 606       debuglog "job creation failed - giving up on this pipeline instance", 0
 607       success = false
 608       failed += 1
 609     end
 610
 611     if interrupted
 612      if success
 613         @instance[:state] = 'Complete'
 614      else
 615         @instance[:state] = 'Paused'
 616       end
 617     else
 618       if ended == @components.length or failed > 0
 619         @instance[:state] = success ? 'Complete' : 'Failed'
 620       end
 621     end
 622
 623     debuglog "pipeline instance state is #{@instance[:state]}"
 624
 625     # set components_summary
 626     components_summary = {"todo" => @components.length - ended, "done" => succeeded, "failed" => failed}
 627     @instance[:components_summary] = components_summary
 628
 629     @instance.save
 630   end
 631
 632   def cleanup
 633     if @instance and @instance[:state] == 'RunningOnClient'
 634       @instance[:state] = 'Paused'
 635       @instance.save
 636     end
 637   end
 638
 639   def uuid
 640     @instance[:uuid]
 641   end
 642
 643   protected
 644
 645   def report_status
 646     @instance.save
 647
 648     if @options[:status_json] != '/dev/null'
 649       File.open(@options[:status_json], 'w') do |f|
 650         f.puts @components.pretty_inspect
 651       end
 652     end
 653
 654     if @options[:status_text] != '/dev/null'
 655       File.open(@options[:status_text], 'w') do |f|
 656         f.puts ""
 657         f.puts "#{Time.now} -- pipeline_instance #{@instance[:uuid]}"
 658         namewidth = @components.collect { |cname, c| cname.size }.max
 659         @components.each do |cname, c|
 660           jstatus = if !c[:job]
 661                       "-"
 662                     elsif c[:job][:running]
 663                       "#{c[:job][:tasks_summary].inspect}"
 664                     elsif c[:job][:success]
 665                       c[:job][:output]
 666                     elsif c[:job][:cancelled_at]
 667                       "cancelled #{c[:job][:cancelled_at]}"
 668                     elsif c[:job][:finished_at]
 669                       "failed #{c[:job][:finished_at]}"
 670                     elsif c[:job][:started_at]
 671                       "started #{c[:job][:started_at]}"
 672                     else
 673                       "queued #{c[:job][:created_at]}"
 674                     end
 675           f.puts "#{cname.to_s.ljust namewidth} #{c[:job] ? c[:job][:uuid] : '-'.ljust(27)} #{jstatus}"
 676         end
 677       end
 678     end
 679   end
 680 end
 681
 682 runner = WhRunPipelineInstance.new($options)
 683 begin
 684   if $options[:template]
 685     runner.fetch_template($options[:template])
 686   else
 687     runner.fetch_instance($options[:instance])
 688   end
 689   runner.apply_parameters(p.leftovers)
 690   runner.setup_instance
 691   if $options[:submit]
 692     runner.instance.save
 693     puts runner.instance[:uuid]
 694   else
 695     runner.run
 696   end
 697 rescue Exception => e
 698   runner.cleanup
 699   raise e
 700 end