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, "." + global_opts[:format]])
 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     begin
 224       case global_opts[:format]
 225       when 'json'
 226         newobj = Oj.load(newcontent)
 227       when 'yaml'
 228         newobj = YAML.load(newcontent)
 229       end
 230     rescue Exception => e
 231       puts "Parse error! " + e.to_s
 232       n = 1
 233       newcontent.each_line do |line|
 234         puts "#{n.to_s.rjust 4}  #{line}"
 235         n += 1
 236       end
 237       exit 1
 238     end
 239
 240     tmp.close(true)
 241
 242     if newobj != results
 243       api_method = 'arvados.' + rsc + '.update'
 244       result = client.execute(:api_method => eval(api_method),
 245                               :parameters => {"uuid" => n, rsc.singularize => Oj.dump(newobj)},
 246                               :authenticated => false,
 247                               :headers => {
 248                                 authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 249                               })
 250
 251       begin
 252         results = JSON.parse result.body
 253       rescue JSON::ParserError => e
 254         abort "Failed to parse server response:\n" + e.to_s
 255       end
 256
 257       if result.response.status != 200
 258         puts "Update failed.  Server responded #{result.response.status}: #{results['errors']} "
 259       end
 260     else
 261       puts "Object is unchanged, did not update."
 262     end
 263   end
 264
 265   exit 0
 266 end
 267
 268 def to_boolean(s)
 269   !!(s =~ /^(true|t|yes|y|1)$/i)
 270 end
 271
 272 def head_banner
 273   "Arvados command line client\n"
 274 end
 275
 276 def help_methods(discovery_document, resource, method=nil)
 277   banner = head_banner
 278   banner += "Usage: arv #{resource} [method] [--parameters]\n"
 279   banner += "Use 'arv #{resource} [method] --help' to get more information about specific methods.\n\n"
 280   banner += "The #{resource} resource supports the following methods:"
 281   banner += "\n\n"
 282   discovery_document["resources"][resource.pluralize]["methods"].
 283     each do |k,v|
 284     description = ''
 285     if v.include? "description"
 286       # add only the first line of the discovery doc description
 287       description = '  ' + v["description"].split("\n").first.chomp
 288     end
 289     banner += "   #{sprintf("%20s",k)}#{description}\n"
 290   end
 291   banner += "\n"
 292   STDERR.puts banner
 293
 294   if not method.nil? and method != '--help' and method != '-h' then
 295     abort "Unknown method #{method.inspect} " +
 296                   "for resource #{resource.inspect}"
 297   end
 298   exit 255
 299 end
 300
 301 def help_resources(option_parser, discovery_document, resource)
 302   option_parser.educate
 303
 304   if not resource.nil? and resource != '--help' then
 305     Trollop::die "Unknown resource type #{resource.inspect}"
 306   end
 307   exit 255
 308 end
 309
 310 def parse_arguments(discovery_document, subcommands)
 311   resource_types = Array.new()
 312   discovery_document["resources"].each do |k,v|
 313     resource_types << k.singularize
 314   end
 315
 316   resource_types += subcommands
 317
 318   option_parser = Trollop::Parser.new do
 319     version __FILE__
 320     banner head_banner
 321     banner "Usage: arv [--flags] subcommand|resource [method] [--parameters]"
 322     banner ""
 323     banner "Available flags:"
 324
 325     opt :dry_run, "Don't actually do anything", :short => "-n"
 326     opt :verbose, "Print some things on stderr"
 327     opt :format,
 328         "Set the output format. Must be one of json (default), yaml or uuid.",
 329         :type => :string,
 330         :default => 'json'
 331     opt :short, "Return only UUIDs (equivalent to --format=uuid)"
 332
 333     banner ""
 334     banner "Use 'arv subcommand|resource --help' to get more information about a particular command or resource."
 335     banner ""
 336     banner "Available subcommands: #{subcommands.join(', ')}"
 337     banner ""
 338
 339     banner "Available resources: #{discovery_document['resources'].keys.map { |k| k.singularize }.join(', ')}"
 340
 341     banner ""
 342     banner "Additional options:"
 343
 344     conflicts :short, :format
 345     stop_on resource_types
 346   end
 347
 348   global_opts = Trollop::with_standard_exception_handling option_parser do
 349     o = option_parser.parse ARGV
 350   end
 351
 352   unless %w(json yaml uuid).include?(global_opts[:format])
 353     $stderr.puts "#{$0}: --format must be one of json, yaml or uuid."
 354     $stderr.puts "Use #{$0} --help for more information."
 355     abort
 356   end
 357
 358   if global_opts[:short]
 359     global_opts[:format] = 'uuid'
 360   end
 361
 362   resource = ARGV.shift
 363
 364   if not subcommands.include? resource
 365     if global_opts[:resources] or not resource_types.include?(resource)
 366       help_resources(option_parser, discovery_document, resource)
 367     end
 368
 369     method = ARGV.shift
 370     if not (discovery_document["resources"][resource.pluralize]["methods"].
 371             include?(method))
 372       help_methods(discovery_document, resource, method)
 373     end
 374
 375     discovered_params = discovery_document\
 376     ["resources"][resource.pluralize]\
 377     ["methods"][method]["parameters"]
 378     method_opts = Trollop::options do
 379       banner head_banner
 380       banner "Usage: arv #{resource} #{method} [--parameters]"
 381       banner ""
 382       banner "This method supports the following parameters:"
 383       banner ""
 384       discovered_params.each do |k,v|
 385         opts = Hash.new()
 386         opts[:type] = v["type"].to_sym if v.include?("type")
 387         if [:datetime, :text, :object, :array].index opts[:type]
 388           opts[:type] = :string                       # else trollop bork
 389         end
 390         opts[:default] = v["default"] if v.include?("default")
 391         opts[:default] = v["default"].to_i if opts[:type] == :integer
 392         opts[:default] = to_boolean(v["default"]) if opts[:type] == :boolean
 393         opts[:required] = true if v.include?("required") and v["required"]
 394         description = ''
 395         description = '  ' + v["description"] if v.include?("description")
 396         opt k.to_sym, description, opts
 397       end
 398
 399       body_object = discovery_document["resources"][resource.pluralize]["methods"][method]["request"]
 400       if body_object and discovered_params[resource].nil?
 401         is_required = true
 402         if body_object["required"] == false
 403           is_required = false
 404         end
 405         opt resource.to_sym, "#{resource} (request body)", {
 406           required: is_required,
 407           type: :string
 408         }
 409       end
 410     end
 411
 412     discovered_params.each do |k,v|
 413       k = k.to_sym
 414       if ['object', 'array'].index(v["type"]) and method_opts.has_key? k
 415         if method_opts[k].andand.match /^\//
 416           method_opts[k] = File.open method_opts[k], 'rb' do |f| f.read end
 417         end
 418       end
 419     end
 420   end
 421
 422   return resource, method, method_opts, global_opts, ARGV
 423 end
 424
 425 #
 426 # ENTRY POINT
 427 #
 428
 429 init_config
 430
 431 ENV['ARVADOS_API_VERSION'] ||= 'v1'
 432
 433 if not ENV.include?('ARVADOS_API_HOST') or not ENV.include?('ARVADOS_API_TOKEN') then
 434   abort <<-EOS
 435 ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be defined as environment variables.
 436   EOS
 437 end
 438
 439 # do this if you're testing with a dev server and you don't care about SSL certificate checks:
 440 if ENV['ARVADOS_API_HOST_INSECURE']
 441   suppress_warnings { OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE }
 442 end
 443
 444 begin
 445   client = ArvadosClient.new(:host => ENV['ARVADOS_API_HOST'], :application_name => 'arvados-cli', :application_version => '1.0')
 446   arvados = client.discovered_api('arvados', ENV['ARVADOS_API_VERSION'])
 447 rescue Exception => e
 448   puts "Failed to connect to Arvados API server: #{e}"
 449   exit 1
 450 end
 451
 452 # Parse arguments here
 453 resource_schema, method, method_opts, global_opts, remaining_opts = parse_arguments(arvados.discovery_document, subcommands)
 454
 455 check_subcommands client, arvados, resource_schema, global_opts, remaining_opts
 456
 457 controller = resource_schema.pluralize
 458
 459 api_method = 'arvados.' + controller + '.' + method
 460
 461 if global_opts[:dry_run]
 462   if global_opts[:verbose]
 463     $stderr.puts "#{api_method} #{method_opts.inspect}"
 464   end
 465   exit
 466 end
 467
 468 request_parameters = {_profile:true}.merge(method_opts)
 469 resource_body = request_parameters.delete(resource_schema.to_sym)
 470 if resource_body
 471   request_body = {
 472     resource_schema => resource_body
 473   }
 474 else
 475   request_body = nil
 476 end
 477
 478 case api_method
 479 when
 480   'arvados.jobs.log_tail_follow'
 481
 482   # Special case for methods that respond with data streams rather
 483   # than JSON (TODO: use the discovery document instead of a static
 484   # list of methods)
 485   uri_s = eval(api_method).generate_uri(request_parameters)
 486   Curl::Easy.perform(uri_s) do |curl|
 487     curl.headers['Accept'] = 'text/plain'
 488     curl.headers['Authorization'] = "OAuth2 #{ENV['ARVADOS_API_TOKEN']}"
 489     if ENV['ARVADOS_API_HOST_INSECURE']
 490       curl.ssl_verify_peer = false
 491       curl.ssl_verify_host = false
 492     end
 493     if global_opts[:verbose]
 494       curl.on_header { |data| $stderr.write data }
 495     end
 496     curl.on_body { |data| $stdout.write data }
 497   end
 498   exit 0
 499 else
 500   result = client.execute(:api_method => eval(api_method),
 501                           :parameters => request_parameters,
 502                           :body => request_body,
 503                           :authenticated => false,
 504                           :headers => {
 505                             authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
 506                           })
 507 end
 508
 509 begin
 510   results = JSON.parse result.body
 511 rescue JSON::ParserError => e
 512   abort "Failed to parse server response:\n" + e.to_s
 513 end
 514
 515 if results["errors"] then
 516   abort "Error: #{results["errors"][0]}"
 517 end
 518
 519 case global_opts[:format]
 520 when 'json'
 521   puts Oj.dump(results, :indent => 1)
 522 when 'yaml'
 523   puts results.to_yaml
 524 else
 525   if results["items"] and results["kind"].match /list$/i
 526     results['items'].each do |i| puts i['uuid'] end
 527   elsif results['uuid'].nil?
 528     abort("Response did not include a uuid:\n" +
 529           Oj.dump(results, :indent => 1) +
 530           "\n")
 531   else
 532     puts results['uuid']
 533   end
 534 end