sdk/cli/bin/arv

   1 #!/usr/bin/env ruby
   2
   3 # Arvados cli client
   4 #
   5 # Ward Vandewege <ward@clinicalfuture.com>
   6
   7 if RUBY_VERSION < '1.9.3' then
   8   abort <<-EOS
   9 #{$0.gsub(/^\.\//,'')} requires Ruby version 1.9.3 or higher.
  10   EOS
  11 end
  12
  13 # read authentication data from ~/.config/arvados if present
  14 lineno = 0
  15 config_file = File.expand_path('~/.config/arvados')
  16 if File.exist? config_file then
  17   File.open(config_file, 'r').each do |line|
  18     lineno = lineno + 1
  19     # skip comments
  20     if line.match('^\s*#') then
  21       next
  22     end
  23     var, val = line.chomp.split('=', 2)
  24     # allow environment settings to override config files.
  25     if var and val
  26       ENV[var] ||= val
  27     else
  28       warn "#{config_file}: #{lineno}: could not parse `#{line}'"
  29     end
  30   end
  31 end
  32
  33 case ARGV[0]
  34 when 'keep'
  35   ARGV.shift
  36   @sub = ARGV.shift
  37   if ['get', 'put'].index @sub then
  38     # Native Arvados
  39     exec `which arv-#{@sub}`.strip, *ARGV
  40   elsif ['ls', 'less', 'check'].index @sub then
  41     # wh* shims
  42     exec `which wh#{@sub}`.strip, *ARGV
  43   else
  44     puts "Usage: \n" +
  45       "#{$0} keep ls\n" +
  46       "#{$0} keep get\n" +
  47       "#{$0} keep put\n" +
  48       "#{$0} keep less\n" +
  49       "#{$0} keep check\n"
  50   end
  51   abort
  52 when 'pipeline'
  53   ARGV.shift
  54   @sub = ARGV.shift
  55   if ['run'].index @sub then
  56     exec `which arv-run-pipeline-instance`.strip, *ARGV
  57   else
  58     puts "Usage: \n" +
  59       "#{$0} pipeline run [...]\n" +
  60       "(see arv-run-pipeline-instance --help for details)\n"
  61   end
  62   abort
  63 when 'tag'
  64   ARGV.shift
  65   exec `which arv-tag`.strip, *ARGV
  66 end
  67
  68 ENV['ARVADOS_API_VERSION'] ||= 'v1'
  69
  70 if not ENV.include?('ARVADOS_API_HOST') or not ENV.include?('ARVADOS_API_TOKEN') then
  71   abort <<-EOS
  72 ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be defined as environment variables.
  73   EOS
  74 end
  75
  76 begin
  77   require 'curb'
  78   require 'rubygems'
  79   require 'google/api_client'
  80   require 'json'
  81   require 'pp'
  82   require 'trollop'
  83   require 'andand'
  84   require 'oj'
  85   require 'active_support/inflector'
  86   require 'yaml'
  87 rescue LoadError
  88   abort <<-EOS
  89
  90 Please install all required gems:
  91
  92   gem install activesupport andand curb google-api-client json oj trollop
  93
  94   EOS
  95 end
  96
  97 ActiveSupport::Inflector.inflections do |inflect|
  98   inflect.irregular 'specimen', 'specimens'
  99   inflect.irregular 'human', 'humans'
 100 end
 101
 102 module Kernel
 103   def suppress_warnings
 104     original_verbosity = $VERBOSE
 105     $VERBOSE = nil
 106     result = yield
 107     $VERBOSE = original_verbosity
 108     return result
 109   end
 110 end
 111
 112 # do this if you're testing with a dev server and you don't care about SSL certificate checks:
 113 if ENV['ARVADOS_API_HOST_INSECURE']
 114   suppress_warnings { OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE }
 115 end
 116
 117 class Google::APIClient
 118  def discovery_document(api, version)
 119   api = api.to_s
 120   return @discovery_documents["#{api}:#{version}"] ||= (begin
 121     response = self.execute!(
 122       :http_method => :get,
 123       :uri => self.discovery_uri(api, version),
 124       :authenticated => false
 125     )
 126     response.body.class == String ? JSON.parse(response.body) : response.body
 127   end)
 128  end
 129 end
 130
 131 class ArvadosClient < Google::APIClient
 132   def execute(*args)
 133     if args.last.is_a? Hash
 134       args.last[:headers] ||= {}
 135       args.last[:headers]['Accept'] ||= 'application/json'
 136     end
 137     super(*args)
 138   end
 139 end
 140
 141 client = ArvadosClient.new(:host => ENV['ARVADOS_API_HOST'], :application_name => 'arvados-cli', :application_version => '1.0')
 142 arvados = client.discovered_api('arvados', ENV['ARVADOS_API_VERSION'])
 143
 144 def to_boolean(s)
 145   !!(s =~ /^(true|t|yes|y|1)$/i)
 146 end
 147
 148 def help_methods(discovery_document, resource, method=nil)
 149   banner = "\n"
 150   banner += "The #{resource} resource type supports the following methods:"
 151   banner += "\n\n"
 152   discovery_document["resources"][resource.pluralize]["methods"].
 153     each do |k,v|
 154     description = ''
 155     description = '  ' + v["description"] if v.include?("description")
 156     banner += "   #{sprintf("%20s",k)}#{description}\n"
 157   end
 158   banner += "\n"
 159   STDERR.puts banner
 160
 161   if not method.nil? and method != '--help' then
 162     Trollop::die ("Unknown method #{method.inspect} " +
 163                   "for resource #{resource.inspect}")
 164   end
 165   exit 255
 166 end
 167
 168 def help_resources(discovery_document, resource)
 169   banner = "\n"
 170   banner += "This Arvados instance supports the following resource types:"
 171   banner += "\n\n"
 172   discovery_document["resources"].each do |k,v|
 173     description = ''
 174     if discovery_document["schemas"].include?(k.singularize.capitalize) and
 175         discovery_document["schemas"][k.singularize.capitalize].include?('description') then
 176       description = '  ' + discovery_document["schemas"][k.singularize.capitalize]["description"]
 177     end
 178     banner += "   #{sprintf("%30s",k.singularize)}#{description}\n"
 179   end
 180   banner += "\n"
 181   STDERR.puts banner
 182
 183   if not resource.nil? and resource != '--help' then
 184     Trollop::die "Unknown resource type #{resource.inspect}"
 185   end
 186   exit 255
 187 end
 188
 189 def parse_arguments(discovery_document)
 190   resource_types = Array.new()
 191   discovery_document["resources"].each do |k,v|
 192     resource_types << k.singularize
 193   end
 194
 195   global_opts = Trollop::options do
 196     banner "arv: the Arvados CLI tool"
 197     opt :dry_run, "Don't actually do anything", :short => "-n"
 198     opt :verbose, "Print some things on stderr"
 199     opt :format,
 200         "Set the output format. Must be one of json (default), yaml or uuid.",
 201         :type => :string,
 202         :default => 'json'
 203     opt :short, "Return only UUIDs (equivalent to --format=uuid)"
 204     opt :resources, "Display list of resources known to this Arvados instance."
 205     conflicts :short, :format
 206     stop_on resource_types
 207   end
 208
 209   unless %w(json yaml uuid).include?(global_opts[:format])
 210     $stderr.puts "#{$0}: --format must be one of json, yaml or uuid."
 211     $stderr.puts "Use #{$0} --help for more information."
 212     abort
 213   end
 214
 215   if global_opts[:short]
 216     global_opts[:format] = 'uuid'
 217   end
 218
 219   resource = ARGV.shift
 220   if global_opts[:resources] or not resource_types.include?(resource)
 221     help_resources(discovery_document, resource)
 222   end
 223
 224   method = ARGV.shift
 225   if not (discovery_document["resources"][resource.pluralize]["methods"].
 226           include?(method))
 227     help_methods(discovery_document, resource, method)
 228   end
 229
 230   discovered_params = discovery_document\
 231     ["resources"][resource.pluralize]\
 232     ["methods"][method]["parameters"]
 233   method_opts = Trollop::options do
 234     discovered_params.each do |k,v|
 235       opts = Hash.new()
 236       opts[:type] = v["type"].to_sym if v.include?("type")
 237       if [:datetime, :text, :object, :array].index opts[:type]
 238         opts[:type] = :string                       # else trollop bork
 239       end
 240       opts[:default] = v["default"] if v.include?("default")
 241       opts[:default] = v["default"].to_i if opts[:type] == :integer
 242       opts[:default] = to_boolean(v["default"]) if opts[:type] == :boolean
 243       opts[:required] = true if v.include?("required") and v["required"]
 244       description = ''
 245       description = '  ' + v["description"] if v.include?("description")
 246       opt k.to_sym, description, opts
 247     end
 248     body_object = discovery_document["resources"][resource.pluralize]["methods"][method]["request"]
 249     if body_object and discovered_params[resource].nil?
 250       is_required = true
 251       if body_object["required"] == false
 252         is_required = false
 253       end
 254       opt resource.to_sym, "#{resource} (request body)", {
 255         required: is_required,
 256         type: :string
 257       }
 258       discovered_params[resource.to_sym] = body_object
 259     end
 260   end
 261
 262   discovered_params.each do |k,v|
 263     k = k.to_sym
 264     if ['object', 'array'].index(v["type"]) and method_opts.has_key? k
 265       if method_opts[k].andand.match /^\//
 266         method_opts[k] = File.open method_opts[k], 'rb' do |f| f.read end
 267       end
 268     end
 269   end
 270   return resource, method, method_opts, global_opts, ARGV
 271 end
 272
 273 resource_schema, method, method_opts, global_opts, remaining_opts = parse_arguments(arvados.discovery_document)
 274 controller = resource_schema.pluralize
 275
 276 api_method = 'arvados.' + controller + '.' + method
 277
 278 if global_opts[:dry_run]
 279   if global_opts[:verbose]
 280     $stderr.puts "#{api_method} #{method_opts.inspect}"
 281   end
 282   exit
 283 end
 284
 285 request_parameters = {}.merge(method_opts)
 286 resource_body = request_parameters.delete(resource_schema.to_sym)
 287 if resource_body
 288   request_body = {
 289     resource_schema => resource_body
 290   }
 291 else
 292   request_body = {}
 293 end
 294
 295 case api_method
 296 when
 297   'arvados.users.event_stream',
 298   'arvados.jobs.log_stream',
 299   'arvados.jobs.log_tail_follow'
 300
 301   # Special case for methods that respond with data streams rather
 302   # than JSON (TODO: use the discovery document instead of a static
 303   # list of methods)
 304   uri_s = eval(api_method).generate_uri(request_parameters)
 305   Curl::Easy.perform(uri_s) do |curl|
 306     curl.headers['Accept'] = 'text/plain'
 307     curl.headers['Authorization'] = "OAuth2 #{ENV['ARVADOS_API_TOKEN']}"
 308     if ENV['ARVADOS_API_HOST_INSECURE']
 309       curl.ssl_verify_peer = false
 310       curl.ssl_verify_host = false
 311     end
 312     if global_opts[:verbose]
 313       curl.on_header { |data| $stderr.write data }
 314     end
 315     curl.on_body { |data| $stdout.write data }
 316   end
 317   exit 0
 318 else
 319   request_body[:api_token] = ENV['ARVADOS_API_TOKEN']
 320   request_body[:_profile] = true
 321   result = client.execute(:api_method => eval(api_method),
 322                           :parameters => request_parameters,
 323                           :body => request_body,
 324                           :authenticated => false)
 325 end
 326
 327 begin
 328   results = JSON.parse result.body
 329 rescue JSON::ParserError => e
 330   abort "Failed to parse server response:\n" + e.to_s
 331 end
 332
 333 if results["errors"] then
 334   abort "Error: #{results["errors"][0]}"
 335 end
 336
 337 case global_opts[:format]
 338 when 'json'
 339   puts Oj.dump(results, :indent => 1)
 340 when 'yaml'
 341   puts results.to_yaml
 342 else
 343   if results["items"] and results["kind"].match /list$/i
 344     results['items'].each do |i| puts i['uuid'] end
 345   elsif results['uuid'].nil?
 346     abort("Response did not include a uuid:\n" +
 347           Oj.dump(results, :indent => 1) +
 348           "\n")
 349   else
 350     puts results['uuid']
 351   end
 352 end
 353
 354