add "arv pipeline run" -> "arv-run-pipeline-instance" wrapper
[arvados.git] / sdk / cli / bin / arv
1 #!/usr/bin/env ruby
2
3 # Arvados cli client
4 #
5 # Ward Vandewege <ward@clinicalfuture.com>
6
7 if RUBY_VERSION < '1.9.3' then
8   abort <<-EOS
9 #{$0.gsub(/^\.\//,'')} requires Ruby version 1.9.3 or higher.
10   EOS
11 end
12
13 if ARGV[0] == 'keep'
14   ARGV.shift
15   @sub = ARGV.shift
16   if ['ls', 'get', 'put', 'less', 'check'].index @sub then
17     exec `which wh#{@sub}`.strip, *ARGV
18   else
19     puts "Usage: \n" +
20       "#{$0} keep ls\n" +
21       "#{$0} keep get\n" +
22       "#{$0} keep put\n" +
23       "#{$0} keep less\n" +
24       "#{$0} keep check\n"
25   end
26   abort
27 end
28
29 if ARGV[0] == 'pipeline'
30   ARGV.shift
31   @sub = ARGV.shift
32   if ['run'].index @sub then
33     exec `which arv-run-pipeline-instance`.strip, *ARGV
34   else
35     puts "Usage: \n" +
36       "#{$0} pipeline run [...]\n" +
37       "(see arv-run-pipeline-instance --help for details)\n"
38   end
39   abort
40 end
41
42 ENV['ARVADOS_API_VERSION'] ||= 'v1'
43
44 if not ENV.include?('ARVADOS_API_HOST') or not ENV.include?('ARVADOS_API_TOKEN') then
45   abort <<-EOS
46 ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be defined as environment variables.
47   EOS
48 end
49
50 begin
51   require 'rubygems'
52   require 'google/api_client'
53   require 'json'
54   require 'pp'
55   require 'trollop'
56   require 'andand'
57   require 'oj'
58   require 'active_support/inflector'
59 rescue LoadError
60   abort <<-EOS
61
62 Please install all required gems: 
63
64   gem install google-api-client json trollop andand oj activesupport
65
66   EOS
67 end
68
69 ActiveSupport::Inflector.inflections do |inflect|
70   inflect.irregular 'specimen', 'specimens'
71   inflect.irregular 'human', 'humans'
72 end
73
74 module Kernel
75   def suppress_warnings
76     original_verbosity = $VERBOSE
77     $VERBOSE = nil
78     result = yield
79     $VERBOSE = original_verbosity
80     return result
81   end
82 end
83
84 # do this if you're testing with a dev server and you don't care about SSL certificate checks:
85 if ENV['ARVADOS_API_HOST_INSECURE']
86   suppress_warnings { OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE }
87 end
88
89 class Google::APIClient
90  def discovery_document(api, version)
91   api = api.to_s
92   return @discovery_documents["#{api}:#{version}"] ||= (begin
93     response = self.execute!(
94       :http_method => :get,
95       :uri => self.discovery_uri(api, version),
96       :authenticated => false
97     )
98     response.body.class == String ? JSON.parse(response.body) : response.body
99   end)
100  end
101 end
102
103 client = Google::APIClient.new(:host => ENV['ARVADOS_API_HOST'], :application_name => 'arvados-cli', :application_version => '1.0')
104 arvados = client.discovered_api('arvados', ENV['ARVADOS_API_VERSION'])
105
106 def to_boolean(s)
107   !!(s =~ /^(true|t|yes|y|1)$/i)
108 end
109
110 def parse_arguments(discovery_document)
111   resource_types = Array.new()
112   resource_types << '--help'
113   discovery_document["resources"].each do |k,v|
114     resource_types << k.singularize
115   end
116
117   global_opts = Trollop::options do
118     banner "arvados cli client"
119     opt :dry_run, "Don't actually do anything", :short => "-n"
120     opt :verbose, "Print some things on stderr", :short => "-v"
121     opt :uuid, "Return the UUIDs of the objects in the response, one per line (default)", :short => nil
122     opt :json, "Return the entire response received from the API server, as a JSON object", :short => "-j"
123     opt :human, "Return the response received from the API server, as a JSON object with whitespace added for human consumption", :short => "-h"
124     opt :pretty, "Synonym of --human", :short => nil
125     stop_on resource_types
126   end
127   
128   # get the subcommand
129   resource_arg = ARGV.shift
130   if resource_types.include?(resource_arg) and resource_arg != '--help' then
131     # subcommand exists
132     # Now see if the method supplied exists
133     method = ARGV.shift
134     if discovery_document["resources"][resource_arg.pluralize]["methods"].include?(method) then
135       # method exists. Collect arguments.
136       discovered_params = discovery_document["resources"][resource_arg.pluralize]["methods"][method]["parameters"]
137       method_opts = Trollop::options do
138         discovered_params.each do |k,v|
139           opts = Hash.new()
140           opts[:type] = v["type"].to_sym if v.include?("type")
141           if [:datetime, :text, :object].index opts[:type]
142             opts[:type] = :string                       # else trollop bork
143           end
144           opts[:default] = v["default"] if v.include?("default")
145           opts[:default] = v["default"].to_i if opts[:type] == :integer
146           opts[:default] = to_boolean(v["default"]) if opts[:type] == :boolean
147           opts[:required] = true if v.include?("required") and v["required"]
148           description = ''
149           description = '  ' + v["description"] if v.include?("description")
150           opt k.to_sym, description, opts
151         end
152       end
153       discovered_params.each do |k,v|
154         if v["type"] == "object" and method_opts.has_key? k
155           method_opts[k] = JSON.parse method_opts[k]
156         end
157       end
158     else
159       banner = "\nThis resource type supports the following methods:\n\n"
160       discovery_document["resources"][resource_arg.pluralize]["methods"].each do |k,v|
161         description = ''
162         description = '  ' + v["description"] if v.include?("description")
163         banner += "   #{sprintf("%20s",k)}#{description}\n"
164       end
165       banner += "\n"
166
167       STDERR.puts banner
168   
169       if not method.nil? and method != '--help' then 
170         Trollop::die "Unknown method #{method.to_s} for command #{resource_arg.to_s}"
171       else
172         exit 255
173       end
174
175     end
176     
177   else
178     banner = "\nThis Arvados instance supports the following resource types:\n\n"
179     discovery_document["resources"].each do |k,v|
180       description = ''
181       if discovery_document["schemas"].include?(k.singularize.capitalize) and 
182          discovery_document["schemas"][k.singularize.capitalize].include?('description') then
183         description = '  ' + discovery_document["schemas"][k.singularize.capitalize]["description"]
184       end
185       banner += "   #{sprintf("%30s",k.singularize)}#{description}\n"
186     end
187     banner += "\n"
188
189     STDERR.puts banner
190
191     if not resource_arg.nil? and resource_arg != '--help' then 
192       Trollop::die "Unknown resource type #{resource_arg.inspect}"
193     else
194       exit 255
195     end
196   end
197
198   return resource_arg.pluralize, method, method_opts, global_opts, ARGV
199 end
200
201 controller, method, method_opts, global_opts, remaining_opts = parse_arguments(arvados.discovery_document)
202
203 api_method = 'arvados.' + controller + '.' + method
204
205 if global_opts[:dry_run]
206   if global_opts[:verbose]
207     $stderr.puts "#{api_method} #{method_opts.inspect}"
208   end
209   exit
210 end
211
212 result = client.execute :api_method => eval(api_method), :parameters => { :api_token => ENV['ARVADOS_API_TOKEN'] }.merge(method_opts), :authenticated => false
213 results = JSON.parse result.body
214
215 if results["errors"] then
216   abort "Error: #{results["errors"][0]}"
217 end
218
219 if global_opts[:human] or global_opts[:pretty] then
220   puts Oj.dump(results, :indent => 1)
221 elsif global_opts[:json] then
222   puts Oj.dump(results)
223 elsif results["items"] and results["kind"].match /list$/i
224   results['items'].each do |i| puts i['uuid'] end
225 else
226   puts results['uuid']
227 end