2 # Copyright (C) The Arvados Authors. All rights reserved.
4 # SPDX-License-Identifier: Apache-2.0
8 # Ward Vandewege <ward@curoverse.com>
13 if RUBY_VERSION < '1.9.3' then
15 #{$0.gsub(/^\.\//,'')} requires Ruby version 1.9.3 or higher.
25 rescue LoadError => error
26 abort "Error loading libraries: #{error}\n"
31 # Load the gems with more requirements first, so we respect any version
32 # constraints they put on gems loaded later.
33 require 'arvados/google_api_client'
34 require 'active_support/inflector'
39 rescue LoadError => error
42 Error loading gems: #{error}
44 Please install all required gems:
46 gem install arvados activesupport andand curb json oj optimist
51 # Search for 'ENTRY POINT' to see where things get going
53 ActiveSupport::Inflector.inflections do |inflect|
54 inflect.irregular 'specimen', 'specimens'
55 inflect.irregular 'human', 'humans'
60 original_verbosity = $VERBOSE
63 $VERBOSE = original_verbosity
68 class ArvadosClient < Google::APIClient
70 if args.last.is_a? Hash
71 args.last[:headers] ||= {}
72 args.last[:headers]['Accept'] ||= 'application/json'
79 # read authentication data from arvados configuration file if present
81 config_file = File.expand_path('~/.config/arvados/settings.conf') rescue nil
82 if not config_file.nil? and File.exist? config_file then
83 File.open(config_file, 'r').each do |line|
86 if line.match('^\s*#') then
89 var, val = line.chomp.split('=', 2)
90 # allow environment settings to override config files.
94 warn "#{config_file}: #{lineno}: could not parse `#{line}'"
101 subcommands = %w(copy create edit get keep pipeline run tag ws)
103 def exec_bin bin, opts
104 bin_path = `which #{bin.shellescape}`.strip
106 raise "#{bin}: command not found"
111 def check_subcommands client, arvados, subcommand, global_opts, remaining_opts
114 arv_create client, arvados, global_opts, remaining_opts
116 arv_edit client, arvados, global_opts, remaining_opts
118 arv_get client, arvados, global_opts, remaining_opts
119 when 'copy', 'tag', 'ws', 'run'
120 exec_bin "arv-#{subcommand}", remaining_opts
122 @sub = remaining_opts.shift
123 if ['get', 'put', 'ls', 'normalize'].index @sub then
125 exec_bin "arv-#{@sub}", remaining_opts
126 elsif @sub == 'docker'
127 exec_bin "arv-keepdocker", remaining_opts
129 puts "Usage: arv keep [method] [--parameters]\n"
130 puts "Use 'arv keep [method] --help' to get more information about specific methods.\n\n"
131 puts "Available methods: ls, get, put, docker"
137 def command_exists?(command)
138 File.executable?(command) || ENV['PATH'].split(':').any? {|folder| File.executable?(File.join(folder, command))}
145 [ENV["VISUAL"], ENV["EDITOR"], "nano", "vi"].each do |e|
146 editor ||= e if e and command_exists? e
149 abort "Could not find any editor to use, please set $VISUAL or $EDITOR to your desired editor."
156 if $?.exitstatus != 0
157 raise "Editor exited with status #{$?.exitstatus}"
161 def edit_and_commit_object initial_obj, tmp_stem, global_opts, &block
163 content = get_obj_content initial_obj, global_opts
165 tmp_file = Tempfile.new([tmp_stem, ".#{global_opts[:format]}"])
166 tmp_file.write(content)
173 run_editor tmp_file.path
176 newcontent = tmp_file.read()
179 # Strip lines starting with '#'
180 newcontent = newcontent.lines.select {|l| !l.start_with? '#'}.join
182 # Load the new object
183 newobj = case global_opts[:format]
187 YAML.load(newcontent)
189 abort "Unrecognized format #{global_opts[:format]}"
197 if e.is_a? Psych::SyntaxError
198 this_error = "YAML error parsing your input: #{e}"
199 elsif e.is_a? JSON::ParserError or e.is_a? Oj::ParseError
200 this_error = "JSON error parsing your input: #{e}"
201 elsif e.is_a? ArvadosAPIError
202 this_error = "API responded with error #{e}"
204 this_error = "#{e.class}: #{e}"
210 newcontent = tmp_file.read()
213 if newcontent == error_text or not can_retry
214 FileUtils::cp tmp_file.path, tmp_file.path + ".saved"
215 puts "File is unchanged, edit aborted." if can_retry
216 abort "Saved contents to " + tmp_file.path + ".saved"
220 error_text = this_error.to_s.lines.map {|l| '# ' + l}.join + "\n"
221 error_text += "# Please fix the error and try again.\n"
222 error_text += newcontent.lines.select {|l| !l.start_with? '#'}.join
223 tmp_file.write error_text
235 class ArvadosAPIError < RuntimeError
238 def check_response result
240 results = JSON.parse result.body
241 rescue JSON::ParserError, Oj::ParseError => e
242 raise "Failed to parse server response:\n" + e.to_s
245 if result.response.status != 200
246 raise ArvadosAPIError.new("#{result.response.status}: #{
247 ((results['errors'] && results['errors'].join('\n')) ||
248 Net::HTTPResponse::CODE_TO_OBJ[status.to_s].to_s.sub(/^Net::HTTP/, '').titleize)}")
254 def lookup_uuid_rsc arvados, uuid
255 m = /([a-z0-9]{5})-([a-z0-9]{5})-([a-z0-9]{15})/.match uuid
257 if /^[a-f0-9]{32}/.match uuid
258 abort "Arvados collections are not editable."
260 abort "'#{uuid}' does not appear to be an Arvados uuid"
265 arvados.discovery_document["resources"].each do |k,v|
266 klass = k.singularize.camelize
267 dig = Digest::MD5.hexdigest(klass).to_i(16).to_s(36)[-5..-1]
274 abort "Could not determine resource type #{m[2]}"
280 def fetch_rsc_obj client, arvados, rsc, uuid, remaining_opts
283 result = client.execute(:api_method => eval('arvados.' + rsc + '.get'),
284 :parameters => {"uuid" => uuid},
285 :authenticated => false,
287 authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
289 obj = check_response result
291 abort "Server error: #{e}"
294 if remaining_opts.length > 0
295 obj.select! { |k, v| remaining_opts.include? k }
301 def get_obj_content obj, global_opts
302 content = case global_opts[:format]
304 Oj.dump(obj, :indent => 1)
308 abort "Unrecognized format #{global_opts[:format]}"
313 def arv_edit client, arvados, global_opts, remaining_opts
314 uuid = remaining_opts.shift
315 if uuid.nil? or uuid == "-h" or uuid == "--help"
317 puts "Usage: arv edit [uuid] [fields...]\n\n"
318 puts "Fetch the specified Arvados object, select the specified fields, \n"
319 puts "open an interactive text editor on a text representation (json or\n"
320 puts "yaml, use --format) and then update the object. Will use 'nano'\n"
321 puts "by default, customize with the EDITOR or VISUAL environment variable.\n"
325 rsc = lookup_uuid_rsc arvados, uuid
326 oldobj = fetch_rsc_obj client, arvados, rsc, uuid, remaining_opts
328 edit_and_commit_object oldobj, uuid, global_opts do |newobj|
329 newobj.select! {|k| newobj[k] != oldobj[k]}
331 result = client.execute(:api_method => eval('arvados.' + rsc + '.update'),
332 :parameters => {"uuid" => uuid},
333 :body_object => { rsc.singularize => newobj },
334 :authenticated => false,
336 authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
338 results = check_response result
339 STDERR.puts "Updated object #{results['uuid']}"
341 STDERR.puts "Object is unchanged, did not update."
348 def arv_get client, arvados, global_opts, remaining_opts
349 uuid = remaining_opts.shift
350 if uuid.nil? or uuid == "-h" or uuid == "--help"
352 puts "Usage: arv [--format json|yaml] get [uuid] [fields...]\n\n"
353 puts "Fetch the specified Arvados object, select the specified fields,\n"
354 puts "and print a text representation.\n"
358 rsc = lookup_uuid_rsc arvados, uuid
359 obj = fetch_rsc_obj client, arvados, rsc, uuid, remaining_opts
360 content = get_obj_content obj, global_opts
366 def arv_create client, arvados, global_opts, remaining_opts
367 types = resource_types(arvados.discovery_document)
368 create_opts = Optimist::options do
369 opt :project_uuid, "Project uuid in which to create the object", :type => :string
370 stop_on resource_types(arvados.discovery_document)
373 object_type = remaining_opts.shift
375 abort "Missing resource type, must be one of #{types.join ', '}"
378 rsc = arvados.discovery_document["resources"].keys.select { |k| object_type == k.singularize }
380 abort "Could not determine resource type #{object_type}"
384 discovered_params = arvados.discovery_document["resources"][rsc]["methods"]["create"]["parameters"]
385 method_opts = Optimist::options do
387 banner "Usage: arv create [--project-uuid] #{object_type} [create parameters]"
389 banner "This method supports the following parameters:"
391 discovered_params.each do |k,v|
393 opts[:type] = v["type"].to_sym if v.include?("type")
394 if [:datetime, :text, :object, :array].index opts[:type]
395 opts[:type] = :string # else optimist bork
397 opts[:default] = v["default"] if v.include?("default")
398 opts[:default] = v["default"].to_i if opts[:type] == :integer
399 opts[:default] = to_boolean(v["default"]) if opts[:type] == :boolean
400 opts[:required] = true if v.include?("required") and v["required"]
402 description = ' ' + v["description"] if v.include?("description")
403 opt k.to_sym, description, opts
408 if create_opts[:project_uuid]
409 initial_obj["owner_uuid"] = create_opts[:project_uuid]
412 edit_and_commit_object initial_obj, "", global_opts do |newobj|
413 result = client.execute(:api_method => eval('arvados.' + rsc + '.create'),
414 :parameters => method_opts,
415 :body_object => {object_type => newobj},
416 :authenticated => false,
418 authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
420 results = check_response result
421 puts "Created object #{results['uuid']}"
428 !!(s =~ /^(true|t|yes|y|1)$/i)
432 "Arvados command line client\n"
435 def help_methods(discovery_document, resource, method=nil)
437 banner += "Usage: arv #{resource} [method] [--parameters]\n"
438 banner += "Use 'arv #{resource} [method] --help' to get more information about specific methods.\n\n"
439 banner += "The #{resource} resource supports the following methods:"
441 discovery_document["resources"][resource.pluralize]["methods"].
444 if v.include? "description"
445 # add only the first line of the discovery doc description
446 description = ' ' + v["description"].split("\n").first.chomp
448 banner += " #{sprintf("%20s",k)}#{description}\n"
453 if not method.nil? and method != '--help' and method != '-h' then
454 abort "Unknown method #{method.inspect} " +
455 "for resource #{resource.inspect}"
460 def help_resources(option_parser, discovery_document, resource)
461 option_parser.educate
465 def resource_types discovery_document
466 resource_types = Array.new()
467 discovery_document["resources"].each do |k,v|
468 resource_types << k.singularize
473 def parse_arguments(discovery_document, subcommands)
474 resources_and_subcommands = resource_types(discovery_document) + subcommands
476 option_parser = Optimist::Parser.new do
479 banner "Usage: arv [--flags] subcommand|resource [method] [--parameters]"
481 banner "Available flags:"
483 opt :dry_run, "Don't actually do anything", :short => "-n"
484 opt :verbose, "Print some things on stderr"
486 "Set the output format. Must be one of json (default), yaml or uuid.",
489 opt :short, "Return only UUIDs (equivalent to --format=uuid)"
492 banner "Use 'arv subcommand|resource --help' to get more information about a particular command or resource."
494 banner "Available subcommands: #{subcommands.join(', ')}"
497 banner "Available resources: #{discovery_document['resources'].keys.map { |k| k.singularize }.join(', ')}"
500 banner "Additional options:"
502 conflicts :short, :format
503 stop_on resources_and_subcommands
506 global_opts = Optimist::with_standard_exception_handling option_parser do
507 o = option_parser.parse ARGV
510 unless %w(json yaml uuid).include?(global_opts[:format])
511 $stderr.puts "#{$0}: --format must be one of json, yaml or uuid."
512 $stderr.puts "Use #{$0} --help for more information."
516 if global_opts[:short]
517 global_opts[:format] = 'uuid'
520 resource = ARGV.shift
522 if not subcommands.include? resource
523 if not resources_and_subcommands.include?(resource)
524 puts "Resource or subcommand '#{resource}' is not recognized.\n\n" if !resource.nil?
525 help_resources(option_parser, discovery_document, resource)
529 if not (discovery_document["resources"][resource.pluralize]["methods"].
531 help_methods(discovery_document, resource, method)
534 discovered_params = discovery_document\
535 ["resources"][resource.pluralize]\
536 ["methods"][method]["parameters"]
537 method_opts = Optimist::options do
539 banner "Usage: arv #{resource} #{method} [--parameters]"
541 banner "This method supports the following parameters:"
543 discovered_params.each do |k,v|
545 opts[:type] = v["type"].to_sym if v.include?("type")
546 if [:datetime, :text, :object, :array].index opts[:type]
547 opts[:type] = :string # else optimist bork
549 opts[:default] = v["default"] if v.include?("default")
550 opts[:default] = v["default"].to_i if opts[:type] == :integer
551 opts[:default] = to_boolean(v["default"]) if opts[:type] == :boolean
552 opts[:required] = true if v.include?("required") and v["required"]
554 description = ' ' + v["description"] if v.include?("description")
555 opt k.to_sym, description, opts
558 body_object = discovery_document["resources"][resource.pluralize]["methods"][method]["request"]
559 if body_object and discovered_params[resource].nil?
561 if body_object["required"] == false
564 resource_opt_desc = "Either a string representing #{resource} as JSON or a filename from which to read #{resource} JSON (use '-' to read from stdin)."
566 resource_opt_desc += " This option must be specified."
568 opt resource.to_sym, resource_opt_desc, {
569 required: is_required,
575 discovered_params.merge({resource => {'type' => 'object'}}).each do |k,v|
577 if ['object', 'array'].index(v["type"]) and method_opts.has_key? k
578 if method_opts[k].andand.match /^\//
579 method_opts[k] = File.open method_opts[k], 'rb' do |f| f.read end
585 return resource, method, method_opts, global_opts, ARGV
594 ENV['ARVADOS_API_VERSION'] ||= 'v1'
596 if not ENV.include?('ARVADOS_API_HOST') or not ENV.include?('ARVADOS_API_TOKEN') then
598 ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be defined as environment variables.
602 # do this if you're testing with a dev server and you don't care about SSL certificate checks:
603 if ENV['ARVADOS_API_HOST_INSECURE']
604 suppress_warnings { OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE }
608 client = ArvadosClient.new(:host => ENV['ARVADOS_API_HOST'], :application_name => 'arvados-cli', :application_version => '1.0')
609 arvados = client.discovered_api('arvados', ENV['ARVADOS_API_VERSION'])
610 rescue Exception => e
611 puts "Failed to connect to Arvados API server: #{e}"
615 # Parse arguments here
616 resource_schema, method, method_opts, global_opts, remaining_opts = parse_arguments(arvados.discovery_document, subcommands)
618 check_subcommands client, arvados, resource_schema, global_opts, remaining_opts
620 controller = resource_schema.pluralize
622 api_method = 'arvados.' + controller + '.' + method
624 if global_opts[:dry_run]
625 if global_opts[:verbose]
626 $stderr.puts "#{api_method} #{method_opts.inspect}"
631 request_parameters = {_profile:true}.merge(method_opts)
632 resource_body = request_parameters.delete(resource_schema.to_sym)
634 # check if resource_body is valid JSON by attempting to parse it
635 resource_body_is_json = true
637 # we don't actually need the results of the parsing,
638 # just checking for the JSON::ParserError exception
639 JSON.parse resource_body
640 rescue JSON::ParserError => e
641 resource_body_is_json = false
643 resource_body_is_readable_file = false
644 # if resource_body is not valid JSON, it should be a filename (or '-' for stdin)
645 if resource_body == '-'
646 resource_body_is_readable_file = true
647 resource_body_file = $stdin
648 elsif File.readable? resource_body
649 resource_body_is_readable_file = true
650 resource_body_file = File.open(resource_body, 'r')
652 if resource_body_is_json and resource_body_is_readable_file
653 abort "Argument specified for option '--#{resource_schema.to_sym}' is both valid JSON and a readable file. Please consider renaming the file: '#{resource_body}'"
654 elsif !resource_body_is_json and !resource_body_is_readable_file
655 if File.exists? resource_body
656 # specified file exists but is not readable
657 abort "Argument specified for option '--#{resource_schema.to_sym}' is an existing file but is not readable. Please check permissions on: '#{resource_body}'"
659 # specified file does not exist
660 abort "Argument specified for option '--#{resource_schema.to_sym}' is neither valid JSON nor an existing file: '#{resource_body}'"
662 elsif resource_body_is_readable_file
663 resource_body = resource_body_file.read()
665 # we don't actually need the results of the parsing,
666 # just checking for the JSON::ParserError exception
667 JSON.parse resource_body
668 rescue JSON::ParserError => e
669 abort "Contents of file '#{resource_body_file.path}' is not valid JSON: #{e}"
671 resource_body_file.close()
674 resource_schema => resource_body
682 'arvados.jobs.log_tail_follow'
684 # Special case for methods that respond with data streams rather
685 # than JSON (TODO: use the discovery document instead of a static
687 uri_s = eval(api_method).generate_uri(request_parameters)
688 Curl::Easy.perform(uri_s) do |curl|
689 curl.headers['Accept'] = 'text/plain'
690 curl.headers['Authorization'] = "OAuth2 #{ENV['ARVADOS_API_TOKEN']}"
691 if ENV['ARVADOS_API_HOST_INSECURE']
692 curl.ssl_verify_peer = false
693 curl.ssl_verify_host = false
695 if global_opts[:verbose]
696 curl.on_header { |data| $stderr.write data }
698 curl.on_body { |data| $stdout.write data }
702 result = client.execute(:api_method => eval(api_method),
703 :parameters => request_parameters,
704 :body_object => request_body,
705 :authenticated => false,
707 authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
712 results = JSON.parse result.body
713 rescue JSON::ParserError => e
714 abort "Failed to parse server response:\n" + e.to_s
717 if results["errors"] then
718 abort "Error: #{results["errors"][0]}"
721 case global_opts[:format]
723 puts Oj.dump(results, :indent => 1)
727 if results["items"] and results["kind"].match /list$/i
728 results['items'].each do |i| puts i['uuid'] end
729 elsif results['uuid'].nil?
730 abort("Response did not include a uuid:\n" +
731 Oj.dump(results, :indent => 1) +