X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/3da10f0c0f5a0c0c91d49436a5995c890b03d228..9d413ff4e3868761422f79b4f81177cec05cbae5:/sdk/cli/bin/arv diff --git a/sdk/cli/bin/arv b/sdk/cli/bin/arv index 185a5b0673..7110b4b991 100755 --- a/sdk/cli/bin/arv +++ b/sdk/cli/bin/arv @@ -1,4 +1,7 @@ #!/usr/bin/env ruby +# Copyright (C) The Arvados Authors. All rights reserved. +# +# SPDX-License-Identifier: Apache-2.0 # Arvados cli client # @@ -14,24 +17,33 @@ if RUBY_VERSION < '1.9.3' then 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 @@ -363,7 +375,7 @@ end 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 @@ -380,7 +392,7 @@ def arv_create client, arvados, global_opts, remaining_opts 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 "" @@ -390,7 +402,7 @@ def arv_create client, arvados, global_opts, remaining_opts 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 @@ -471,7 +483,7 @@ end 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]" @@ -501,7 +513,7 @@ def parse_arguments(discovery_document, subcommands) 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 @@ -532,7 +544,7 @@ def parse_arguments(discovery_document, subcommands) 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 "" @@ -542,7 +554,7 @@ def parse_arguments(discovery_document, subcommands) 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 @@ -559,14 +571,18 @@ def parse_arguments(discovery_document, subcommands) if body_object["required"] == false is_required = false end - opt resource.to_sym, "#{resource} (request body)", { + 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." + end + 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 /^\// @@ -625,6 +641,45 @@ end request_parameters = {_profile:true}.merge(method_opts) resource_body = request_parameters.delete(resource_schema.to_sym) if resource_body + # check if resource_body is valid JSON by attempting to parse it + resource_body_is_json = true + 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 + 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 + # 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_file.close() + end request_body = { resource_schema => resource_body }