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