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