#!/usr/bin/env ruby
+# Copyright (C) The Arvados Authors. All rights reserved.
+#
+# SPDX-License-Identifier: Apache-2.0
# Arvados cli client
#
-# Ward Vandewege <ward@curoverse.com>
+# Ward Vandewege <ward@curii.com>
require 'fileutils'
require 'shellwords'
end
begin
- require 'curb'
- require 'rubygems'
- require 'arvados/google_api_client'
require 'json'
+ require 'net/http'
require 'pp'
- require 'trollop'
+ require 'tempfile'
+ require 'yaml'
+rescue LoadError => error
+ abort "Error loading libraries: #{error}\n"
+end
+
+begin
+ require 'rubygems'
+ # Load the gems with more requirements first, so we respect any version
+ # constraints they put on gems loaded later.
+ require 'arvados/google_api_client'
+ require 'active_support/inflector'
require 'andand'
+ require 'curb'
require 'oj'
- require 'active_support/inflector'
- require 'yaml'
- require 'tempfile'
- require 'net/http'
-rescue LoadError
+ require 'optimist'
+rescue LoadError => error
abort <<-EOS
+Error loading gems: #{error}
+
Please install all required gems:
- gem install activesupport andand curb google-api-client json oj trollop yaml
+ gem install arvados activesupport andand curb json oj optimist
EOS
end
end
end
-class ArvadosClient < Google::APIClient
- def execute(*args)
- if args.last.is_a? Hash
- args.last[:headers] ||= {}
- args.last[:headers]['Accept'] ||= 'application/json'
- end
- super(*args)
- end
-end
-
def init_config
# read authentication data from arvados configuration file if present
lineno = 0
end
-subcommands = %w(copy create edit get keep pipeline run tag ws)
+subcommands = %w(copy create edit get keep tag ws)
def exec_bin bin, opts
bin_path = `which #{bin.shellescape}`.strip
arv_edit client, arvados, global_opts, remaining_opts
when 'get'
arv_get client, arvados, global_opts, remaining_opts
- when 'copy', 'tag', 'ws', 'run'
+ when 'copy', 'tag', 'ws'
exec_bin "arv-#{subcommand}", remaining_opts
when 'keep'
@sub = remaining_opts.shift
puts "Available methods: ls, get, put, docker"
end
abort
- when 'pipeline'
- sub = remaining_opts.shift
- if sub == 'run'
- exec_bin "arv-run-pipeline-instance", remaining_opts
- else
- puts "Usage: arv pipeline [method] [--parameters]\n"
- puts "Use 'arv pipeline [method] --help' to get more information about specific methods.\n\n"
- puts "Available methods: run"
- end
- abort
end
end
# Load the new object
newobj = case global_opts[:format]
when 'json'
- Oj.load(newcontent)
+ Oj.safe_load(newcontent)
when 'yaml'
YAML.load(newcontent)
else
def arv_create client, arvados, global_opts, remaining_opts
types = resource_types(arvados.discovery_document)
- create_opts = Trollop::options do
+ create_opts = Optimist::options do
opt :project_uuid, "Project uuid in which to create the object", :type => :string
stop_on resource_types(arvados.discovery_document)
end
rsc = rsc.first
discovered_params = arvados.discovery_document["resources"][rsc]["methods"]["create"]["parameters"]
- method_opts = Trollop::options do
+ method_opts = Optimist::options do
banner head_banner
banner "Usage: arv create [--project-uuid] #{object_type} [create parameters]"
banner ""
opts = Hash.new()
opts[:type] = v["type"].to_sym if v.include?("type")
if [:datetime, :text, :object, :array].index opts[:type]
- opts[:type] = :string # else trollop bork
+ opts[:type] = :string # else optimist bork
end
opts[:default] = v["default"] if v.include?("default")
opts[:default] = v["default"].to_i if opts[:type] == :integer
def parse_arguments(discovery_document, subcommands)
resources_and_subcommands = resource_types(discovery_document) + subcommands
- option_parser = Trollop::Parser.new do
+ option_parser = Optimist::Parser.new do
version __FILE__
banner head_banner
banner "Usage: arv [--flags] subcommand|resource [method] [--parameters]"
stop_on resources_and_subcommands
end
- global_opts = Trollop::with_standard_exception_handling option_parser do
+ global_opts = Optimist::with_standard_exception_handling option_parser do
o = option_parser.parse ARGV
end
discovered_params = discovery_document\
["resources"][resource.pluralize]\
["methods"][method]["parameters"]
- method_opts = Trollop::options do
+ method_opts = Optimist::options do
banner head_banner
banner "Usage: arv #{resource} #{method} [--parameters]"
banner ""
opts = Hash.new()
opts[:type] = v["type"].to_sym if v.include?("type")
if [:datetime, :text, :object, :array].index opts[:type]
- opts[:type] = :string # else trollop bork
+ opts[:type] = :string # else optimist bork
end
opts[:default] = v["default"] if v.include?("default")
opts[:default] = v["default"].to_i if opts[:type] == :integer
if body_object["required"] == false
is_required = false
end
- _resource_opt_desc = "Either a string representing #{resource} as JSON or a filename from which to read #{resource} JSON (use '-' to read from stdin)."
+ resource_opt_desc = "Either a string representing #{resource} as JSON or a filename from which to read #{resource} JSON (use '-' to read from stdin)."
if is_required
- _resource_opt_desc += " This option must be specified."
+ resource_opt_desc += " This option must be specified."
end
- opt resource.to_sym, _resource_opt_desc, {
+ opt resource.to_sym, resource_opt_desc, {
required: is_required,
type: :string
}
end
end
- discovered_params.each do |k,v|
+ discovered_params.merge({resource => {'type' => 'object'}}).each do |k,v|
k = k.to_sym
if ['object', 'array'].index(v["type"]) and method_opts.has_key? k
if method_opts[k].andand.match /^\//
end
begin
- client = ArvadosClient.new(:host => ENV['ARVADOS_API_HOST'], :application_name => 'arvados-cli', :application_version => '1.0')
+ client = Google::APIClient.new(:host => ENV['ARVADOS_API_HOST'], :application_name => 'arvados-cli', :application_version => '1.0')
arvados = client.discovered_api('arvados', ENV['ARVADOS_API_VERSION'])
rescue Exception => e
puts "Failed to connect to Arvados API server: #{e}"
resource_body = request_parameters.delete(resource_schema.to_sym)
if resource_body
# check if resource_body is valid JSON by attempting to parse it
- _is_json = true
+ resource_body_is_json = true
begin
- # we don't actually need the results of the parsing,
+ # we don't actually need the results of the parsing,
# just checking for the JSON::ParserError exception
JSON.parse resource_body
rescue JSON::ParserError => e
- _is_json = false
- end
- if !_is_json
- # if resource_body is not valid JSON, it should be a filename (or '-' for stdin)
- if resource_body == '-'
- _resource_body_file = $stdin
+ resource_body_is_json = false
+ end
+ resource_body_is_readable_file = false
+ # if resource_body is not valid JSON, it should be a filename (or '-' for stdin)
+ if resource_body == '-'
+ resource_body_is_readable_file = true
+ resource_body_file = $stdin
+ elsif File.readable? resource_body
+ resource_body_is_readable_file = true
+ resource_body_file = File.open(resource_body, 'r')
+ end
+ if resource_body_is_json and resource_body_is_readable_file
+ abort "Argument specified for option '--#{resource_schema.to_sym}' is both valid JSON and a readable file. Please consider renaming the file: '#{resource_body}'"
+ elsif !resource_body_is_json and !resource_body_is_readable_file
+ if File.exists? resource_body
+ # specified file exists but is not readable
+ abort "Argument specified for option '--#{resource_schema.to_sym}' is an existing file but is not readable. Please check permissions on: '#{resource_body}'"
else
- if File.readable? resource_body
- _resource_body_file = File.open(resource_body, 'r')
- else
- if File.exists? resource_body
- # specified file exists but is not readable
- abort "File '#{resource_body}' specified for option '--#{resource_schema.to_sym}' exists but is not readable."
- else
- # specified file does not exist
- abort "File '#{resource_body}' specified for option '--#{resource_schema.to_sym}' does not exist."
- end
- end
+ # specified file does not exist
+ abort "Argument specified for option '--#{resource_schema.to_sym}' is neither valid JSON nor an existing file: '#{resource_body}'"
+ end
+ elsif resource_body_is_readable_file
+ resource_body = resource_body_file.read()
+ begin
+ # we don't actually need the results of the parsing,
+ # just checking for the JSON::ParserError exception
+ JSON.parse resource_body
+ rescue JSON::ParserError => e
+ abort "Contents of file '#{resource_body_file.path}' is not valid JSON: #{e}"
end
- resource_body = _resource_body_file.read()
- _resource_body_file.close()
+ resource_body_file.close()
end
request_body = {
resource_schema => resource_body
})
end
+request_id = result.headers[:x_request_id]
begin
results = JSON.parse result.body
rescue JSON::ParserError => e
- abort "Failed to parse server response:\n" + e.to_s
+ err_msg = "Failed to parse server response:\n" + e.to_s
+ if request_id
+ err_msg += "\nRequest ID: #{request_id or client.request_id}"
+ end
+ abort err_msg
end
if results["errors"] then
- abort "Error: #{results["errors"][0]}"
+ err_message = results["errors"][0]
+ if request_id and !err_message.match(/.*req-[0-9a-zA-Z]{20}.*/)
+ err_message += " (#{request_id})"
+ end
+ abort "Error: #{err_message}"
end
case global_opts[:format]
projects / arvados.git / blobdiff