X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/eb73e21144a3b6460d7550583860b25fba3fffc8..0503f58f3f9b78bd803d4fd7544ced9d79e26f1c:/sdk/cli/bin/arv

diff --git a/sdk/cli/bin/arv b/sdk/cli/bin/arv
index b757855b1f..25c28bea23 100755
--- a/sdk/cli/bin/arv
+++ b/sdk/cli/bin/arv
@@ -1,10 +1,14 @@
 #!/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>
 
 require 'fileutils'
+require 'shellwords'
 
 if RUBY_VERSION < '1.9.3' then
   abort <<-EOS
@@ -13,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
@@ -85,7 +98,15 @@ def init_config
 end
 
 
-subcommands = %w(copy create edit keep pipeline run tag ws)
+subcommands = %w(copy create edit get keep pipeline run tag ws)
+
+def exec_bin bin, opts
+  bin_path = `which #{bin.shellescape}`.strip
+  if bin_path.empty?
+    raise "#{bin}: command not found"
+  end
+  exec bin_path, *opts
+end
 
 def check_subcommands client, arvados, subcommand, global_opts, remaining_opts
   case subcommand
@@ -93,32 +114,21 @@ def check_subcommands client, arvados, subcommand, global_opts, remaining_opts
     arv_create client, arvados, global_opts, remaining_opts
   when 'edit'
     arv_edit client, arvados, global_opts, remaining_opts
+  when 'get'
+    arv_get client, arvados, global_opts, remaining_opts
   when 'copy', 'tag', 'ws', 'run'
-    exec `which arv-#{subcommand}`.strip, *remaining_opts
+    exec_bin "arv-#{subcommand}", remaining_opts
   when 'keep'
     @sub = remaining_opts.shift
     if ['get', 'put', 'ls', 'normalize'].index @sub then
       # Native Arvados
-      exec `which arv-#{@sub}`.strip, *remaining_opts
-    elsif ['less', 'check'].index @sub then
-      # wh* shims
-      exec `which wh#{@sub}`.strip, *remaining_opts
+      exec_bin "arv-#{@sub}", remaining_opts
     elsif @sub == 'docker'
-      exec `which arv-keepdocker`.strip, *remaining_opts
+      exec_bin "arv-keepdocker", remaining_opts
     else
       puts "Usage: arv keep [method] [--parameters]\n"
       puts "Use 'arv keep [method] --help' to get more information about specific methods.\n\n"
-      puts "Available methods: ls, get, put, less, check, docker"
-    end
-    abort
-  when 'pipeline'
-    sub = remaining_opts.shift
-    if sub == 'run'
-      exec `which arv-run-pipeline-instance`.strip, *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"
+      puts "Available methods: ls, get, put, docker"
     end
     abort
   end
@@ -150,14 +160,7 @@ end
 
 def edit_and_commit_object initial_obj, tmp_stem, global_opts, &block
 
-  content = case global_opts[:format]
-            when 'json'
-              Oj.dump(initial_obj, :indent => 1)
-            when 'yaml'
-              initial_obj.to_yaml
-            else
-              abort "Unrecognized format #{global_opts[:format]}"
-            end
+  content = get_obj_content initial_obj, global_opts
 
   tmp_file = Tempfile.new([tmp_stem, ".#{global_opts[:format]}"])
   tmp_file.write(content)
@@ -182,6 +185,8 @@ def edit_and_commit_object initial_obj, tmp_stem, global_opts, &block
                    Oj.load(newcontent)
                  when 'yaml'
                    YAML.load(newcontent)
+                 else
+                   abort "Unrecognized format #{global_opts[:format]}"
                  end
 
         yield newobj
@@ -246,20 +251,7 @@ def check_response result
   results
 end
 
-def arv_edit client, arvados, global_opts, remaining_opts
-  uuid = remaining_opts.shift
-  if uuid.nil? or uuid == "-h" or uuid == "--help"
-    puts head_banner
-    puts "Usage: arv edit [uuid] [fields...]\n\n"
-    puts "Fetch the specified Arvados object, select the specified fields, \n"
-    puts "open an interactive text editor on a text representation (json or\n"
-    puts "yaml, use --format) and then update the object.  Will use 'nano'\n"
-    puts "by default, customize with the EDITOR or VISUAL environment variable.\n"
-    exit 255
-  end
-
-  # determine controller
-
+def lookup_uuid_rsc arvados, uuid
   m = /([a-z0-9]{5})-([a-z0-9]{5})-([a-z0-9]{15})/.match uuid
   if !m
     if /^[a-f0-9]{32}/.match uuid
@@ -282,6 +274,11 @@ def arv_edit client, arvados, global_opts, remaining_opts
     abort "Could not determine resource type #{m[2]}"
   end
 
+  return rsc
+end
+
+def fetch_rsc_obj client, arvados, rsc, uuid, remaining_opts
+
   begin
     result = client.execute(:api_method => eval('arvados.' + rsc + '.get'),
                             :parameters => {"uuid" => uuid},
@@ -289,15 +286,45 @@ def arv_edit client, arvados, global_opts, remaining_opts
                             :headers => {
                               authorization: 'OAuth2 '+ENV['ARVADOS_API_TOKEN']
                             })
-    oldobj = check_response result
+    obj = check_response result
   rescue => e
     abort "Server error: #{e}"
   end
 
   if remaining_opts.length > 0
-    oldobj.select! { |k, v| remaining_opts.include? k }
+    obj.select! { |k, v| remaining_opts.include? k }
   end
 
+  return obj
+end
+
+def get_obj_content obj, global_opts
+  content = case global_opts[:format]
+            when 'json'
+              Oj.dump(obj, :indent => 1)
+            when 'yaml'
+              obj.to_yaml
+            else
+              abort "Unrecognized format #{global_opts[:format]}"
+            end
+  return content
+end
+
+def arv_edit client, arvados, global_opts, remaining_opts
+  uuid = remaining_opts.shift
+  if uuid.nil? or uuid == "-h" or uuid == "--help"
+    puts head_banner
+    puts "Usage: arv edit [uuid] [fields...]\n\n"
+    puts "Fetch the specified Arvados object, select the specified fields, \n"
+    puts "open an interactive text editor on a text representation (json or\n"
+    puts "yaml, use --format) and then update the object.  Will use 'nano'\n"
+    puts "by default, customize with the EDITOR or VISUAL environment variable.\n"
+    exit 255
+  end
+
+  rsc = lookup_uuid_rsc arvados, uuid
+  oldobj = fetch_rsc_obj client, arvados, rsc, uuid, remaining_opts
+
   edit_and_commit_object oldobj, uuid, global_opts do |newobj|
     newobj.select! {|k| newobj[k] != oldobj[k]}
     if !newobj.empty?
@@ -318,9 +345,27 @@ def arv_edit client, arvados, global_opts, remaining_opts
   exit 0
 end
 
+def arv_get client, arvados, global_opts, remaining_opts
+  uuid = remaining_opts.shift
+  if uuid.nil? or uuid == "-h" or uuid == "--help"
+    puts head_banner
+    puts "Usage: arv [--format json|yaml] get [uuid] [fields...]\n\n"
+    puts "Fetch the specified Arvados object, select the specified fields,\n"
+    puts "and print a text representation.\n"
+    exit 255
+  end
+
+  rsc = lookup_uuid_rsc arvados, uuid
+  obj = fetch_rsc_obj client, arvados, rsc, uuid, remaining_opts
+  content = get_obj_content obj, global_opts
+
+  puts content
+  exit 0
+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
@@ -337,7 +382,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 ""
@@ -347,7 +392,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
@@ -428,7 +473,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]"
@@ -458,7 +503,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
 
@@ -489,7 +534,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 ""
@@ -499,7 +544,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
@@ -516,14 +561,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 /^\//
@@ -582,6 +631,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
   }