sdk/cli/bin/arv

   1 #!/usr/bin/env ruby
   2
   3 # Arvados cli client
   4 #
   5 # Ward Vandewege <ward@curoverse.com>
   6
   7 require 'fileutils'
   8
   9 if RUBY_VERSION < '1.9.3' then
  10   abort <<-EOS
  11 #{$0.gsub(/^\.\//,'')} requires Ruby version 1.9.3 or higher.
  12   EOS
  13 end
  14
  15 begin
  16   require 'curb'
  17   require 'rubygems'
  18   require 'google/api_client'
  19   require 'json'
  20   require 'pp'
  21   require 'trollop'
  22   require 'andand'
  23   require 'oj'
  24   require 'active_support/inflector'
  25   require 'yaml'
  26   require 'tempfile'
  27 rescue LoadError
  28   abort <<-EOS
  29
  30 Please install all required gems:
  31
  32   gem install activesupport andand curb google-api-client json oj trollop yaml
  33
  34   EOS
  35 end
  36
  37 # Search for 'ENTRY POINT' to see where things get going
  38
  39 ActiveSupport::Inflector.inflections do |inflect|
  40   inflect.irregular 'specimen', 'specimens'
  41   inflect.irregular 'human', 'humans'
  42 end
  43
  44 module Kernel
  45   def suppress_warnings
  46     original_verbosity = $VERBOSE
  47     $VERBOSE = nil
  48     result = yield
  49     $VERBOSE = original_verbosity
  50     return result
  51   end
  52 end
  53
  54 class Google::APIClient
  55  def discovery_document(api, version)
  56    api = api.to_s
  57    discovery_uri = self.discovery_uri(api, version)
  58    discovery_uri_hash = Digest::MD5.hexdigest(discovery_uri)
  59    return @discovery_documents[discovery_uri_hash] ||=
  60      begin
  61        # fetch new API discovery doc if stale
  62        cached_doc = File.expand_path "~/.cache/arvados/discovery-#{discovery_uri_hash}.json" rescue nil
  63
  64        if cached_doc.nil? or not File.exist?(cached_doc) or (Time.now - File.mtime(cached_doc)) > 86400
  65          response = self.execute!(:http_method => :get,
  66                                   :uri => discovery_uri,
  67                                   :authenticated => false)
  68
  69          begin
  70            FileUtils.makedirs(File.dirname cached_doc)
  71            File.open(cached_doc, 'w') do |f|
  72              f.puts response.body
  73            end
  74          rescue
  75            return JSON.load response.body
  76          end
  77        end
  78
  79        File.open(cached_doc) { |f| JSON.load f }
  80      end
  81  end
  82 end
  83
  84 class ArvadosClient < Google::APIClient
  85   def execute(*args)
  86     if args.last.is_a? Hash
  87       args.last[:headers] ||= {}
  88       args.last[:headers]['Accept'] ||= 'application/json'
  89     end
  90     super(*args)
  91   end
  92 end
  93
  94 def init_config
  95   # read authentication data from arvados configuration file if present
  96   lineno = 0
  97   config_file = File.expand_path('~/.config/arvados/settings.conf') rescue nil
  98   if not config_file.nil? and File.exist? config_file then
  99     File.open(config_file, 'r').each do |line|
 100       lineno = lineno + 1
 101       # skip comments
 102       if line.match('^\s*#') then
 103         next
 104       end
 105       var, val = line.chomp.split('=', 2)
 106       # allow environment settings to override config files.
 107       if var and val
 108         ENV[var] ||= val
 109       else
 110         warn "#{config_file}: #{lineno}: could not parse `#{line}'"
 111       end
 112     end
 113   end
 114 end
 115
 116 subcommands = %w(create edit keep pipeline run tag ws)
 117
 118 def check_subcommands client, arvados, subcommand, global_opts, remaining_opts
 119   case subcommand
 120   when 'create'
 121     arv_create client, arvados, global_opts, remaining_opts
 122   when 'edit'
 123     arv_edit client, arvados, global_opts, remaining_opts
 124   when 'keep'
 125     @sub = remaining_opts.shift
 126     if ['get', 'put', 'ls', 'normalize'].index @sub then
 127       # Native Arvados
 128       exec `which arv-#{@sub}`.strip, *remaining_opts
 129     elsif ['less', 'check'].index @sub then
 130       # wh* shims
 131       exec `which wh#{@sub}`.strip, *remaining_opts
 132     elsif @sub == 'docker'
 133       exec `which arv-keepdocker`.strip, *remaining_opts
 134     else
 135       puts "Usage: arv keep [method] [--parameters]\n"
 136       puts "Use 'arv keep [method] --help' to get more information about specific methods.\n\n"
 137       puts "Available methods: ls, get, put, less, check, docker"
 138     end
 139     abort
 140   when 'pipeline'
 141     sub = remaining_opts.shift
 142     if sub == 'run'
 143       exec `which arv-run-pipeline-instance`.strip, *remaining_opts
 144     else
 145       puts "Usage: arv pipeline [method] [--parameters]\n"
 146       puts "Use 'arv pipeline [method] --help' to get more information about specific methods.\n\n"
 147       puts "Available methods: run"
 148     end
 149     abort
 150   when 'run'
 151     exec `which arv-run`.strip, *remaining_opts
 152   when 'tag'
 153     exec `which arv-tag`.strip, *remaining_opts
 154   when 'ws'
 155     exec `which arv-ws`.strip, *remaining_opts
 156   end
 157 end
 158
 159 def arv_edit_save_tmp tmp
 160   FileUtils::cp tmp.path, tmp.path + ".saved"
 161   puts "Saved contents to " + tmp.path + ".saved"
 162 end
 163
 164 def command_exists?(command)
 165   ENV['PATH'].split(':').each {|folder| File.executable?(File.join(folder, command))}
 166 end
 167
 168 def run_editor tmp_file, global_opts
 169   need_edit = true
 170   while need_edit
 171     pid = Process::fork
 172     if pid.nil?
 173       editor = nil
 174       [ENV["VISUAL"], ENV["EDITOR"], "nano", "vi"].each do |e|
 175         editor ||= e if e and command_exists? e
 176       end
 177       if editor.nil?
 178         puts "Could not find any editor to use, please set $VISUAL or $EDITOR to your desired editor."
 179         exit 1
 180       end
 181       exec editor, tmp_file.path
 182     else
 183       Process.wait pid
 184     end
 185
 186     if $?.exitstatus == 0
 187       tmp_file.open
 188       newcontent = tmp_file.read()
 189
 190       newobj = {}
 191       begin
 192         case global_opts[:format]
 193         when 'json'
 194           newobj = Oj.load(newcontent)
 195         when 'yaml'
 196           newobj = YAML.load(newcontent)
 197         end
 198         need_edit = false
 199       rescue Exception => e
 200         n = 1
 201         newcontent.each_line do |line|
 202           puts "#{n.to_s.rjust 4}  #{line}"
 203           n += 1
 204         end
 205         puts "Parse error! " + e.to_s
 206         puts "\nTry again (y/n)? "
 207         yn = "X"
 208         while not ["y", "Y", "n", "N"].include?(yn)
 209           yn = $stdin.read 1
 210         end
 211         if yn == 'n' or yn == 'N'
 212           arv_edit_save_tmp tmp_file
 213           abort
 214         end
 215       end
 216     else
 217       puts "Editor exited with status #{$?.exitstatus}"
 218       exit $?.exitstatus
 219     end
 220   end
 221
 222   newobj
 223 end
 224
 225 def arv_edit client, arvados, global_opts, remaining_opts
 226   uuid = remaining_opts.shift
 227   if uuid.nil? or uuid == "-h" or uuid == "--help"
 228     puts head_banner
 229     puts "Usage: arv edit [uuid] [fields...]\n\n"
 230     puts "Fetch the specified Arvados object, select the specified fields, \n"
 231     puts "open an interactive text editor on a text representation (json or\n"
 232     puts "yaml, use --format) and then update the object.  Will use 'nano'\n"
 233     puts "by default, customize with the EDITOR or VISUAL environment variable.\n"
 234     exit 255
 235   end
 236
 237   if not $stdout.tty?
 238     puts "Not connected to a TTY, cannot run interactive editor."
 239     exit 1
 240   end
 241
 242   # determine controller
 243
 244   m = /([a-z0-9]{5})-([a-z0-9]{5})-([a-z0-9]{15})/.match uuid
 245   if !m
 246     if /^[a-f0-9]{32}/.match uuid
 247       abort "Arvados collections are not editable."
 248     else
 249       abort "#{n} does not appear to be an Arvados uuid"
 250     end
 251   end
 252
 253   rsc = nil
 254   arvados.discovery_document["resources"].each do |k,v|
 255     klass = k.singularize.camelize
 256     dig = Digest::MD5.hexdigest(klass).to_i(16).to_s(36)[-5..-1]
 257     if dig == m[2]
 258       rsc = k
 259     end
 260   end
 261
 262   if rsc.nil?
 263     abort "Could not determine resource type #{m[2]}"
 264   end
 265
 266   api_method = 'arvados.' + rsc + '.get'
 267
 268   result = client.execute(:api_method => eval(api_method),
 269                           :parameters => {"uuid" => uuid},
 270                           :authenticated => false,
 271                           :headers => {
 272                             authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 273                           })
 274   begin
 275     results = JSON.parse result.body
 276   rescue JSON::ParserError => e
 277     abort "Failed to parse server response:\n" + e.to_s
 278   end
 279
 280   if remaining_opts.length > 0
 281     results.select! { |k, v| remaining_opts.include? k }
 282   end
 283
 284   content = ""
 285
 286   case global_opts[:format]
 287   when 'json'
 288     content = Oj.dump(results, :indent => 1)
 289   when 'yaml'
 290     content = results.to_yaml
 291   end
 292
 293   tmp_file = Tempfile.new([uuid, "." + global_opts[:format]])
 294   tmp_file.write(content)
 295   tmp_file.close
 296
 297   newobj = run_editor tmp_file, global_opts
 298
 299   begin
 300     if newobj != results
 301       api_method = 'arvados.' + rsc + '.update'
 302       dumped = Oj.dump(newobj)
 303
 304       begin
 305         result = client.execute(:api_method => eval(api_method),
 306                                 :parameters => {"uuid" => uuid},
 307                                 :body => { rsc.singularize => dumped },
 308                                 :authenticated => false,
 309                                 :headers => {
 310                                   authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 311                                 })
 312       rescue Exception => e
 313         puts "Error communicating with server, error was #{e}"
 314         puts "Update body was:"
 315         puts dumped
 316         arv_edit_save_tmp tmp_file
 317         abort
 318       end
 319
 320       begin
 321         results = JSON.parse result.body
 322       rescue JSON::ParserError => e
 323         arv_edit_save_tmp tmp_file
 324         abort "Failed to parse server response:\n" + e.to_s
 325       end
 326
 327       if result.response.status != 200
 328         puts "Update failed.  Server responded #{result.response.status}: #{results['errors']} "
 329         puts "Update body was:"
 330         puts dumped
 331         arv_edit_save_tmp tmp_file
 332         abort
 333       end
 334     else
 335       puts "Object is unchanged, did not update."
 336     end
 337   ensure
 338     tmp_file.close(true)
 339   end
 340
 341   exit 0
 342 end
 343
 344 def arv_create client, arvados, global_opts, remaining_opts
 345   types = resource_types(arvados.discovery_document)
 346   create_opts = Trollop::options do
 347     opt :project_uuid, "Project uuid in which to create the object", :type => :string
 348     stop_on resource_types(arvados.discovery_document)
 349   end
 350
 351   object_type = remaining_opts.shift
 352   if object_type.nil?
 353     abort "Missing resource type, must be one of #{types.join ', '}"
 354   end
 355
 356   rsc = arvados.discovery_document["resources"].keys.select { |k| object_type == k.singularize }
 357   if rsc.empty?
 358     abort "Could not determine resource type #{object_type}"
 359   end
 360   rsc = rsc.first
 361
 362   discovered_params = arvados.discovery_document["resources"][rsc]["methods"]["create"]["parameters"]
 363   method_opts = Trollop::options do
 364     banner head_banner
 365     banner "Usage: arv create [--project-uuid] #{object_type} [create parameters]"
 366     banner ""
 367     banner "This method supports the following parameters:"
 368     banner ""
 369     discovered_params.each do |k,v|
 370       opts = Hash.new()
 371       opts[:type] = v["type"].to_sym if v.include?("type")
 372       if [:datetime, :text, :object, :array].index opts[:type]
 373         opts[:type] = :string                       # else trollop bork
 374       end
 375       opts[:default] = v["default"] if v.include?("default")
 376       opts[:default] = v["default"].to_i if opts[:type] == :integer
 377       opts[:default] = to_boolean(v["default"]) if opts[:type] == :boolean
 378       opts[:required] = true if v.include?("required") and v["required"]
 379       description = ''
 380       description = '  ' + v["description"] if v.include?("description")
 381       opt k.to_sym, description, opts
 382     end
 383   end
 384
 385
 386   newobj = {}
 387   if create_opts[:project_uuid]
 388     newobj["owner_uuid"] = create_opts[:project_uuid]
 389   end
 390
 391   case global_opts[:format]
 392   when 'json'
 393     content = Oj.dump(newobj, :indent => 1)
 394   when 'yaml'
 395     content = newobj.to_yaml
 396   end
 397
 398   tmp_file = Tempfile.new(["", ".#{global_opts[:format]}"])
 399   tmp_file.write(content)
 400   tmp_file.close
 401
 402   newobj = run_editor tmp_file, global_opts
 403
 404   begin
 405     api_method = 'arvados.' + rsc + '.create'
 406     dumped = Oj.dump(newobj)
 407
 408     result = client.execute(:api_method => eval(api_method),
 409                             :parameters => method_opts,
 410                             :body_object => {object_type => newobj},
 411                             :authenticated => false,
 412                             :headers => {
 413                               authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 414                             })
 415
 416     begin
 417       results = JSON.parse result.body
 418     rescue JSON::ParserError => e
 419       arv_edit_save_tmp tmp_file
 420       abort "Failed to parse server response:\n" + e.to_s
 421     end
 422
 423     if result.response.status != 200
 424       puts "Create failed.  Server responded #{result.response.status}: #{results['errors']} "
 425       puts "Create body was:"
 426       puts dumped
 427       arv_edit_save_tmp tmp_file
 428       abort
 429     end
 430
 431     begin
 432       puts "Created object #{results['uuid']}"
 433     rescue
 434       arv_edit_save_tmp tmp_file
 435       abort "Unexpected response:\n#{results}"
 436     end
 437   ensure
 438     tmp_file.close(true)
 439   end
 440
 441   exit 0
 442 end
 443
 444 def to_boolean(s)
 445   !!(s =~ /^(true|t|yes|y|1)$/i)
 446 end
 447
 448 def head_banner
 449   "Arvados command line client\n"
 450 end
 451
 452 def help_methods(discovery_document, resource, method=nil)
 453   banner = head_banner
 454   banner += "Usage: arv #{resource} [method] [--parameters]\n"
 455   banner += "Use 'arv #{resource} [method] --help' to get more information about specific methods.\n\n"
 456   banner += "The #{resource} resource supports the following methods:"
 457   banner += "\n\n"
 458   discovery_document["resources"][resource.pluralize]["methods"].
 459     each do |k,v|
 460     description = ''
 461     if v.include? "description"
 462       # add only the first line of the discovery doc description
 463       description = '  ' + v["description"].split("\n").first.chomp
 464     end
 465     banner += "   #{sprintf("%20s",k)}#{description}\n"
 466   end
 467   banner += "\n"
 468   STDERR.puts banner
 469
 470   if not method.nil? and method != '--help' and method != '-h' then
 471     abort "Unknown method #{method.inspect} " +
 472                   "for resource #{resource.inspect}"
 473   end
 474   exit 255
 475 end
 476
 477 def help_resources(option_parser, discovery_document, resource)
 478   option_parser.educate
 479   exit 255
 480 end
 481
 482 def resource_types discovery_document
 483   resource_types = Array.new()
 484   discovery_document["resources"].each do |k,v|
 485     resource_types << k.singularize
 486   end
 487   resource_types
 488 end
 489
 490 def parse_arguments(discovery_document, subcommands)
 491   resources_and_subcommands = resource_types(discovery_document) + subcommands
 492
 493   option_parser = Trollop::Parser.new do
 494     version __FILE__
 495     banner head_banner
 496     banner "Usage: arv [--flags] subcommand|resource [method] [--parameters]"
 497     banner ""
 498     banner "Available flags:"
 499
 500     opt :dry_run, "Don't actually do anything", :short => "-n"
 501     opt :verbose, "Print some things on stderr"
 502     opt :format,
 503         "Set the output format. Must be one of json (default), yaml or uuid.",
 504         :type => :string,
 505         :default => 'json'
 506     opt :short, "Return only UUIDs (equivalent to --format=uuid)"
 507
 508     banner ""
 509     banner "Use 'arv subcommand|resource --help' to get more information about a particular command or resource."
 510     banner ""
 511     banner "Available subcommands: #{subcommands.join(', ')}"
 512     banner ""
 513
 514     banner "Available resources: #{discovery_document['resources'].keys.map { |k| k.singularize }.join(', ')}"
 515
 516     banner ""
 517     banner "Additional options:"
 518
 519     conflicts :short, :format
 520     stop_on resources_and_subcommands
 521   end
 522
 523   global_opts = Trollop::with_standard_exception_handling option_parser do
 524     o = option_parser.parse ARGV
 525   end
 526
 527   unless %w(json yaml uuid).include?(global_opts[:format])
 528     $stderr.puts "#{$0}: --format must be one of json, yaml or uuid."
 529     $stderr.puts "Use #{$0} --help for more information."
 530     abort
 531   end
 532
 533   if global_opts[:short]
 534     global_opts[:format] = 'uuid'
 535   end
 536
 537   resource = ARGV.shift
 538
 539   if not subcommands.include? resource
 540     if not resources_and_subcommands.include?(resource)
 541       puts "Resource or subcommand '#{resource}' is not recognized.\n\n" if !resource.nil?
 542       help_resources(option_parser, discovery_document, resource)
 543     end
 544
 545     method = ARGV.shift
 546     if not (discovery_document["resources"][resource.pluralize]["methods"].
 547             include?(method))
 548       help_methods(discovery_document, resource, method)
 549     end
 550
 551     discovered_params = discovery_document\
 552     ["resources"][resource.pluralize]\
 553     ["methods"][method]["parameters"]
 554     method_opts = Trollop::options do
 555       banner head_banner
 556       banner "Usage: arv #{resource} #{method} [--parameters]"
 557       banner ""
 558       banner "This method supports the following parameters:"
 559       banner ""
 560       discovered_params.each do |k,v|
 561         opts = Hash.new()
 562         opts[:type] = v["type"].to_sym if v.include?("type")
 563         if [:datetime, :text, :object, :array].index opts[:type]
 564           opts[:type] = :string                       # else trollop bork
 565         end
 566         opts[:default] = v["default"] if v.include?("default")
 567         opts[:default] = v["default"].to_i if opts[:type] == :integer
 568         opts[:default] = to_boolean(v["default"]) if opts[:type] == :boolean
 569         opts[:required] = true if v.include?("required") and v["required"]
 570         description = ''
 571         description = '  ' + v["description"] if v.include?("description")
 572         opt k.to_sym, description, opts
 573       end
 574
 575       body_object = discovery_document["resources"][resource.pluralize]["methods"][method]["request"]
 576       if body_object and discovered_params[resource].nil?
 577         is_required = true
 578         if body_object["required"] == false
 579           is_required = false
 580         end
 581         opt resource.to_sym, "#{resource} (request body)", {
 582           required: is_required,
 583           type: :string
 584         }
 585       end
 586     end
 587
 588     discovered_params.each do |k,v|
 589       k = k.to_sym
 590       if ['object', 'array'].index(v["type"]) and method_opts.has_key? k
 591         if method_opts[k].andand.match /^\//
 592           method_opts[k] = File.open method_opts[k], 'rb' do |f| f.read end
 593         end
 594       end
 595     end
 596   end
 597
 598   return resource, method, method_opts, global_opts, ARGV
 599 end
 600
 601 #
 602 # ENTRY POINT
 603 #
 604
 605 init_config
 606
 607 ENV['ARVADOS_API_VERSION'] ||= 'v1'
 608
 609 if not ENV.include?('ARVADOS_API_HOST') or not ENV.include?('ARVADOS_API_TOKEN') then
 610   abort <<-EOS
 611 ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be defined as environment variables.
 612   EOS
 613 end
 614
 615 # do this if you're testing with a dev server and you don't care about SSL certificate checks:
 616 if ENV['ARVADOS_API_HOST_INSECURE']
 617   suppress_warnings { OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE }
 618 end
 619
 620 begin
 621   client = ArvadosClient.new(:host => ENV['ARVADOS_API_HOST'], :application_name => 'arvados-cli', :application_version => '1.0')
 622   arvados = client.discovered_api('arvados', ENV['ARVADOS_API_VERSION'])
 623 rescue Exception => e
 624   puts "Failed to connect to Arvados API server: #{e}"
 625   exit 1
 626 end
 627
 628 # Parse arguments here
 629 resource_schema, method, method_opts, global_opts, remaining_opts = parse_arguments(arvados.discovery_document, subcommands)
 630
 631 check_subcommands client, arvados, resource_schema, global_opts, remaining_opts
 632
 633 controller = resource_schema.pluralize
 634
 635 api_method = 'arvados.' + controller + '.' + method
 636
 637 if global_opts[:dry_run]
 638   if global_opts[:verbose]
 639     $stderr.puts "#{api_method} #{method_opts.inspect}"
 640   end
 641   exit
 642 end
 643
 644 request_parameters = {_profile:true}.merge(method_opts)
 645 resource_body = request_parameters.delete(resource_schema.to_sym)
 646 if resource_body
 647   request_body = {
 648     resource_schema => resource_body
 649   }
 650 else
 651   request_body = nil
 652 end
 653
 654 case api_method
 655 when
 656   'arvados.jobs.log_tail_follow'
 657
 658   # Special case for methods that respond with data streams rather
 659   # than JSON (TODO: use the discovery document instead of a static
 660   # list of methods)
 661   uri_s = eval(api_method).generate_uri(request_parameters)
 662   Curl::Easy.perform(uri_s) do |curl|
 663     curl.headers['Accept'] = 'text/plain'
 664     curl.headers['Authorization'] = "OAuth2 #{ENV['ARVADOS_API_TOKEN']}"
 665     if ENV['ARVADOS_API_HOST_INSECURE']
 666       curl.ssl_verify_peer = false
 667       curl.ssl_verify_host = false
 668     end
 669     if global_opts[:verbose]
 670       curl.on_header { |data| $stderr.write data }
 671     end
 672     curl.on_body { |data| $stdout.write data }
 673   end
 674   exit 0
 675 else
 676   result = client.execute(:api_method => eval(api_method),
 677                           :parameters => request_parameters,
 678                           :body => request_body,
 679                           :authenticated => false,
 680                           :headers => {
 681                             authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 682                           })
 683 end
 684
 685 begin
 686   results = JSON.parse result.body
 687 rescue JSON::ParserError => e
 688   abort "Failed to parse server response:\n" + e.to_s
 689 end
 690
 691 if results["errors"] then
 692   abort "Error: #{results["errors"][0]}"
 693 end
 694
 695 case global_opts[:format]
 696 when 'json'
 697   puts Oj.dump(results, :indent => 1)
 698 when 'yaml'
 699   puts results.to_yaml
 700 else
 701   if results["items"] and results["kind"].match /list$/i
 702     results['items'].each do |i| puts i['uuid'] end
 703   elsif results['uuid'].nil?
 704     abort("Response did not include a uuid:\n" +
 705           Oj.dump(results, :indent => 1) +
 706           "\n")
 707   else
 708     puts results['uuid']
 709   end
 710 end