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