Merge branch '14009-container-reuse-index'
[arvados.git] / sdk / cli / bin / arv
index b377ffed63796b9f5a3b83d98f4799a0beeae3d8..7110b4b991ab41da1f77fc256ed67b7eadd3daef 100755 (executable)
@@ -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
 #
@@ -32,7 +35,7 @@ begin
   require 'andand'
   require 'curb'
   require 'oj'
-  require 'trollop'
+  require 'optimist'
 rescue LoadError => error
   abort <<-EOS
 
@@ -40,7 +43,7 @@ Error loading gems: #{error}
 
 Please install all required gems:
 
-  gem install arvados activesupport andand curb json oj trollop
+  gem install arvados activesupport andand curb json oj optimist
 
   EOS
 end
@@ -372,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
@@ -389,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 ""
@@ -399,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
@@ -480,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]"
@@ -510,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
 
@@ -541,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 ""
@@ -551,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
@@ -568,7 +571,11 @@ 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
         }
@@ -634,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
   }