sdk/cli/bin/arv

   1 #!/usr/bin/env ruby
   2
   3 # Arvados cli client
   4 #
   5 # Ward Vandewege <ward@clinicalfuture.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 rescue LoadError
  27   abort <<-EOS
  28
  29 Please install all required gems:
  30
  31   gem install activesupport andand curb google-api-client json oj trollop yaml
  32
  33   EOS
  34 end
  35
  36 # Search for 'ENTRY POINT' to see where things get going
  37
  38 ActiveSupport::Inflector.inflections do |inflect|
  39   inflect.irregular 'specimen', 'specimens'
  40   inflect.irregular 'human', 'humans'
  41 end
  42
  43 module Kernel
  44   def suppress_warnings
  45     original_verbosity = $VERBOSE
  46     $VERBOSE = nil
  47     result = yield
  48     $VERBOSE = original_verbosity
  49     return result
  50   end
  51 end
  52
  53 class Google::APIClient
  54  def discovery_document(api, version)
  55    api = api.to_s
  56    return @discovery_documents["#{api}:#{version}"] ||=
  57      begin
  58        # fetch new API discovery doc if stale
  59        cached_doc = File.expand_path '~/.cache/arvados/discovery_uri.json'
  60        if not File.exist?(cached_doc) or (Time.now - File.mtime(cached_doc)) > 86400
  61          response = self.execute!(:http_method => :get,
  62                                   :uri => self.discovery_uri(api, version),
  63                                   :authenticated => false)
  64          FileUtils.makedirs(File.dirname cached_doc)
  65          File.open(cached_doc, 'w') do |f|
  66            f.puts response.body
  67          end
  68        end
  69
  70        File.open(cached_doc) { |f| JSON.load f }
  71      end
  72  end
  73 end
  74
  75 class ArvadosClient < Google::APIClient
  76   def execute(*args)
  77     if args.last.is_a? Hash
  78       args.last[:headers] ||= {}
  79       args.last[:headers]['Accept'] ||= 'application/json'
  80     end
  81     super(*args)
  82   end
  83 end
  84
  85 def init_config
  86   # read authentication data from arvados configuration file if present
  87   lineno = 0
  88   config_file = File.expand_path('~/.config/arvados/settings.conf')
  89   if File.exist? config_file then
  90     File.open(config_file, 'r').each do |line|
  91       lineno = lineno + 1
  92       # skip comments
  93       if line.match('^\s*#') then
  94         next
  95       end
  96       var, val = line.chomp.split('=', 2)
  97       # allow environment settings to override config files.
  98       if var and val
  99         ENV[var] ||= val
 100       else
 101         warn "#{config_file}: #{lineno}: could not parse `#{line}'"
 102       end
 103     end
 104   end
 105 end
 106
 107 subcommands = %w(keep pipeline tag ws edit)
 108
 109 def check_subcommands client, arvados, subcommand, global_opts, remaining_opts
 110   case subcommand
 111   when 'keep'
 112     @sub = remaining_opts.shift
 113     if ['get', 'put', 'ls', 'normalize'].index @sub then
 114       # Native Arvados
 115       exec `which arv-#{@sub}`.strip, *remaining_opts
 116     elsif ['less', 'check'].index @sub then
 117       # wh* shims
 118       exec `which wh#{@sub}`.strip, *remaining_opts
 119     elsif @sub == 'docker'
 120       exec `which arv-keepdocker`.strip, *remaining_opts
 121     else
 122       puts "Usage: arv keep [method] [--parameters]\n"
 123       puts "Use 'arv keep [method] --help' to get more information about specific methods.\n\n"
 124       puts "Available methods: ls, get, put, less, check, docker"
 125     end
 126     abort
 127   when 'pipeline'
 128     exec `which arv-run-pipeline-instance`.strip, *remaining_opts
 129   when 'tag'
 130     exec `which arv-tag`.strip, *remaining_opts
 131   when 'ws'
 132     exec `which arv-ws`.strip, *remaining_opts
 133   when 'edit'
 134     arv_edit client, arvados, global_opts, remaining_opts
 135   end
 136 end
 137
 138 def arv_edit client, arvados, global_opts, remaining_opts
 139   n = remaining_opts.shift
 140   if n.nil? or n == "-h" or n == "--help"
 141     puts head_banner
 142     puts "Usage: arv edit [uuid] [fields...]\n\n"
 143     puts "Fetchs the specified Arvados object, select the specified fields, and\n"
 144     puts "open an interactive text editor on a text representation (json or\n"
 145     puts "yaml, use --format) and then updates the object.  Will use 'nano'\n"
 146     puts "by default, customize with the EDITOR or VISUAL environment variable.\n"
 147     exit 255
 148   end
 149
 150   if not $stdout.tty?
 151     puts "Not connected to a TTY, cannot run interactive editor."
 152     exit 1
 153   end
 154
 155   # determine controller
 156
 157   m = /([a-z0-9]{5})-([a-z0-9]{5})-([a-z0-9]{15})/.match n
 158   if !m
 159     abort puts "#{n} does not appear to be an arvados uuid"
 160   end
 161
 162   rsc = nil
 163   arvados.discovery_document["resources"].each do |k,v|
 164     klass = k.singularize.camelize
 165     dig = Digest::MD5.hexdigest(klass).to_i(16).to_s(36)[-5..-1]
 166     if dig == m[2]
 167       rsc = k
 168     end
 169   end
 170
 171   if rsc.nil?
 172     abort "Could not determine resource type #{m[2]}"
 173   end
 174
 175   api_method = 'arvados.' + rsc + '.get'
 176
 177   result = client.execute(:api_method => eval(api_method),
 178                           :parameters => {"uuid" => n},
 179                           :authenticated => false,
 180                           :headers => {
 181                             authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 182                           })
 183   begin
 184     results = JSON.parse result.body
 185   rescue JSON::ParserError => e
 186     abort "Failed to parse server response:\n" + e.to_s
 187   end
 188
 189   if remaining_opts.length > 0
 190     results.select! { |k, v| remaining_opts.include? k }
 191   end
 192
 193   content = ""
 194
 195   case global_opts[:format]
 196   when 'json'
 197     content = Oj.dump(results, :indent => 1)
 198   when 'yaml'
 199     content = results.to_yaml
 200   end
 201
 202   require 'tempfile'
 203
 204   tmp = Tempfile.new(n)
 205   tmp.write(content)
 206   tmp.close
 207
 208   pid = Process::fork
 209   if pid.nil?
 210     editor ||= ENV["VISUAL"]
 211     editor ||= ENV["EDITOR"]
 212     editor ||= "nano"
 213     exec editor, tmp.path
 214   else
 215     Process.wait pid
 216   end
 217
 218   if $?.exitstatus == 0
 219     tmp.open
 220     newcontent = tmp.read()
 221
 222     newobj = {}
 223     case global_opts[:format]
 224     when 'json'
 225       newobj = Oj.load(newcontent)
 226     when 'yaml'
 227       newobj = YAML.load(newcontent)
 228     end
 229     tmp.close
 230     tmp.unlink
 231
 232     if newobj != results
 233       api_method = 'arvados.' + rsc + '.update'
 234       result = client.execute(:api_method => eval(api_method),
 235                               :parameters => {"uuid" => n, rsc.singularize => Oj.dump(newobj)},
 236                               :authenticated => false,
 237                               :headers => {
 238                                 authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 239                               })
 240
 241       begin
 242         results = JSON.parse result.body
 243       rescue JSON::ParserError => e
 244         abort "Failed to parse server response:\n" + e.to_s
 245       end
 246
 247       if result.response.status != 200
 248         puts "Update failed.  Server responded #{result.response.status}: #{results['errors']} "
 249       end
 250     else
 251       puts "Object is unchanged, did not update."
 252     end
 253   end
 254
 255   exit 0
 256 end
 257
 258 def to_boolean(s)
 259   !!(s =~ /^(true|t|yes|y|1)$/i)
 260 end
 261
 262 def head_banner
 263   "Arvados command line client\n"
 264 end
 265
 266 def help_methods(discovery_document, resource, method=nil)
 267   banner = head_banner
 268   banner += "Usage: arv #{resource} [method] [--parameters]\n"
 269   banner += "Use 'arv #{resource} [method] --help' to get more information about specific methods.\n\n"
 270   banner += "The #{resource} resource supports the following methods:"
 271   banner += "\n\n"
 272   discovery_document["resources"][resource.pluralize]["methods"].
 273     each do |k,v|
 274     description = ''
 275     if v.include? "description"
 276       # add only the first line of the discovery doc description
 277       description = '  ' + v["description"].split("\n").first.chomp
 278     end
 279     banner += "   #{sprintf("%20s",k)}#{description}\n"
 280   end
 281   banner += "\n"
 282   STDERR.puts banner
 283
 284   if not method.nil? and method != '--help' and method != '-h' then
 285     abort "Unknown method #{method.inspect} " +
 286                   "for resource #{resource.inspect}"
 287   end
 288   exit 255
 289 end
 290
 291 def help_resources(option_parser, discovery_document, resource)
 292   option_parser.educate
 293
 294   if not resource.nil? and resource != '--help' then
 295     Trollop::die "Unknown resource type #{resource.inspect}"
 296   end
 297   exit 255
 298 end
 299
 300 def parse_arguments(discovery_document, subcommands)
 301   resource_types = Array.new()
 302   discovery_document["resources"].each do |k,v|
 303     resource_types << k.singularize
 304   end
 305
 306   resource_types += subcommands
 307
 308   option_parser = Trollop::Parser.new do
 309     version __FILE__
 310     banner head_banner
 311     banner "Usage: arv [--flags] subcommand|resource [method] [--parameters]"
 312     banner ""
 313     banner "Available flags:"
 314
 315     opt :dry_run, "Don't actually do anything", :short => "-n"
 316     opt :verbose, "Print some things on stderr"
 317     opt :format,
 318         "Set the output format. Must be one of json (default), yaml or uuid.",
 319         :type => :string,
 320         :default => 'json'
 321     opt :short, "Return only UUIDs (equivalent to --format=uuid)"
 322
 323     banner ""
 324     banner "Use 'arv subcommand|resource --help' to get more information about a particular command or resource."
 325     banner ""
 326     banner "Available subcommands: #{subcommands.join(', ')}"
 327     banner ""
 328
 329     banner "Available resources: #{discovery_document['resources'].keys.map { |k| k.singularize }.join(', ')}"
 330
 331     banner ""
 332     banner "Additional options:"
 333
 334     conflicts :short, :format
 335     stop_on resource_types
 336   end
 337
 338   global_opts = Trollop::with_standard_exception_handling option_parser do
 339     o = option_parser.parse ARGV
 340   end
 341
 342   unless %w(json yaml uuid).include?(global_opts[:format])
 343     $stderr.puts "#{$0}: --format must be one of json, yaml or uuid."
 344     $stderr.puts "Use #{$0} --help for more information."
 345     abort
 346   end
 347
 348   if global_opts[:short]
 349     global_opts[:format] = 'uuid'
 350   end
 351
 352   resource = ARGV.shift
 353
 354   if not subcommands.include? resource
 355     if global_opts[:resources] or not resource_types.include?(resource)
 356       help_resources(option_parser, discovery_document, resource)
 357     end
 358
 359     method = ARGV.shift
 360     if not (discovery_document["resources"][resource.pluralize]["methods"].
 361             include?(method))
 362       help_methods(discovery_document, resource, method)
 363     end
 364
 365     discovered_params = discovery_document\
 366     ["resources"][resource.pluralize]\
 367     ["methods"][method]["parameters"]
 368     method_opts = Trollop::options do
 369       banner head_banner
 370       banner "Usage: arv #{resource} #{method} [--parameters]"
 371       banner ""
 372       banner "This method supports the following parameters:"
 373       banner ""
 374       discovered_params.each do |k,v|
 375         opts = Hash.new()
 376         opts[:type] = v["type"].to_sym if v.include?("type")
 377         if [:datetime, :text, :object, :array].index opts[:type]
 378           opts[:type] = :string                       # else trollop bork
 379         end
 380         opts[:default] = v["default"] if v.include?("default")
 381         opts[:default] = v["default"].to_i if opts[:type] == :integer
 382         opts[:default] = to_boolean(v["default"]) if opts[:type] == :boolean
 383         opts[:required] = true if v.include?("required") and v["required"]
 384         description = ''
 385         description = '  ' + v["description"] if v.include?("description")
 386         opt k.to_sym, description, opts
 387       end
 388
 389       body_object = discovery_document["resources"][resource.pluralize]["methods"][method]["request"]
 390       if body_object and discovered_params[resource].nil?
 391         is_required = true
 392         if body_object["required"] == false
 393           is_required = false
 394         end
 395         opt resource.to_sym, "#{resource} (request body)", {
 396           required: is_required,
 397           type: :string
 398         }
 399       end
 400     end
 401
 402     discovered_params.each do |k,v|
 403       k = k.to_sym
 404       if ['object', 'array'].index(v["type"]) and method_opts.has_key? k
 405         if method_opts[k].andand.match /^\//
 406           method_opts[k] = File.open method_opts[k], 'rb' do |f| f.read end
 407         end
 408       end
 409     end
 410   end
 411
 412   return resource, method, method_opts, global_opts, ARGV
 413 end
 414
 415 #
 416 # ENTRY POINT
 417 #
 418
 419 init_config
 420
 421 ENV['ARVADOS_API_VERSION'] ||= 'v1'
 422
 423 if not ENV.include?('ARVADOS_API_HOST') or not ENV.include?('ARVADOS_API_TOKEN') then
 424   abort <<-EOS
 425 ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be defined as environment variables.
 426   EOS
 427 end
 428
 429 # do this if you're testing with a dev server and you don't care about SSL certificate checks:
 430 if ENV['ARVADOS_API_HOST_INSECURE']
 431   suppress_warnings { OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE }
 432 end
 433
 434 begin
 435   client = ArvadosClient.new(:host => ENV['ARVADOS_API_HOST'], :application_name => 'arvados-cli', :application_version => '1.0')
 436   arvados = client.discovered_api('arvados', ENV['ARVADOS_API_VERSION'])
 437 rescue Exception => e
 438   puts "Failed to connect to Arvados API server: #{e}"
 439   exit 1
 440 end
 441
 442 # Parse arguments here
 443 resource_schema, method, method_opts, global_opts, remaining_opts = parse_arguments(arvados.discovery_document, subcommands)
 444
 445 check_subcommands client, arvados, resource_schema, global_opts, remaining_opts
 446
 447 controller = resource_schema.pluralize
 448
 449 api_method = 'arvados.' + controller + '.' + method
 450
 451 if global_opts[:dry_run]
 452   if global_opts[:verbose]
 453     $stderr.puts "#{api_method} #{method_opts.inspect}"
 454   end
 455   exit
 456 end
 457
 458 request_parameters = {_profile:true}.merge(method_opts)
 459 resource_body = request_parameters.delete(resource_schema.to_sym)
 460 if resource_body
 461   request_body = {
 462     resource_schema => resource_body
 463   }
 464 else
 465   request_body = nil
 466 end
 467
 468 case api_method
 469 when
 470   'arvados.jobs.log_tail_follow'
 471
 472   # Special case for methods that respond with data streams rather
 473   # than JSON (TODO: use the discovery document instead of a static
 474   # list of methods)
 475   uri_s = eval(api_method).generate_uri(request_parameters)
 476   Curl::Easy.perform(uri_s) do |curl|
 477     curl.headers['Accept'] = 'text/plain'
 478     curl.headers['Authorization'] = "OAuth2 #{ENV['ARVADOS_API_TOKEN']}"
 479     if ENV['ARVADOS_API_HOST_INSECURE']
 480       curl.ssl_verify_peer = false
 481       curl.ssl_verify_host = false
 482     end
 483     if global_opts[:verbose]
 484       curl.on_header { |data| $stderr.write data }
 485     end
 486     curl.on_body { |data| $stdout.write data }
 487   end
 488   exit 0
 489 else
 490   result = client.execute(:api_method => eval(api_method),
 491                           :parameters => request_parameters,
 492                           :body => request_body,
 493                           :authenticated => false,
 494                           :headers => {
 495                             authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 496                           })
 497 end
 498
 499 begin
 500   results = JSON.parse result.body
 501 rescue JSON::ParserError => e
 502   abort "Failed to parse server response:\n" + e.to_s
 503 end
 504
 505 if results["errors"] then
 506   abort "Error: #{results["errors"][0]}"
 507 end
 508
 509 case global_opts[:format]
 510 when 'json'
 511   puts Oj.dump(results, :indent => 1)
 512 when 'yaml'
 513   puts results.to_yaml
 514 else
 515   if results["items"] and results["kind"].match /list$/i
 516     results['items'].each do |i| puts i['uuid'] end
 517   elsif results['uuid'].nil?
 518     abort("Response did not include a uuid:\n" +
 519           Oj.dump(results, :indent => 1) +
 520           "\n")
 521   else
 522     puts results['uuid']
 523   end
 524 end