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