sdk/cli/bin/arv-tag

   1 #! /usr/bin/env ruby
   2
   3 # arv tag usage:
   4 #   arv tag add tag1 [tag2 ...] --object obj_uuid1 [--object obj_uuid2 ...]
   5 #   arv tag remove tag1 [tag2 ...] --object obj_uuid1 [--object obj_uuid2 ...]
   6 #   arv tag remove tag1 [tag2 ...] --all
   7
   8 def usage_string
   9   return "\nUsage:\n" +
  10     "arv tag add tag1 [tag2 ...] --object object_uuid1 [object_uuid2...]\n" +
  11     "arv tag remove tag1 [tag2 ...] --object object_uuid1 [object_uuid2...]\n" +
  12     "arv tag remove --all\n"
  13 end
  14
  15 def usage
  16   abort usage_string
  17 end
  18
  19 def api_call(method, parameters:{}, request_body:{})
  20   result = $client.execute(:api_method => method,
  21                            :parameters => parameters,
  22                            :body_object => request_body,
  23                            :authenticated => false,
  24                            :headers => {
  25                              authorization: "OAuth2 #{ENV['ARVADOS_API_TOKEN']}",
  26                            })
  27
  28   begin
  29     results = JSON.parse result.body
  30   rescue JSON::ParserError => e
  31     abort "Failed to parse server response:\n" + e.to_s
  32   end
  33
  34   if results["errors"]
  35     abort "Error: #{results["errors"][0]}"
  36   end
  37
  38   return results
  39 end
  40
  41 def tag_add(tag, obj_uuid)
  42   return api_call($arvados.links.create,
  43                   request_body: {
  44                     :link => {
  45                       :name       => tag,
  46                       :link_class => :tag,
  47                       :head_uuid  => obj_uuid,
  48                     }
  49                   })
  50 end
  51
  52 def tag_remove(tag, obj_uuids=nil)
  53   # If we got a list of objects to untag, look up the uuids for the
  54   # links that need to be deleted.
  55   link_uuids = []
  56   if obj_uuids
  57     obj_uuids.each do |uuid|
  58       link = api_call($arvados.links.list,
  59                       request_body: {
  60                         :where => {
  61                           :link_class => :tag,
  62                           :name => tag,
  63                           :head_uuid => uuid,
  64                         }
  65                       })
  66       if link['items_available'] > 0
  67         link_uuids.push link['items'][0]['uuid']
  68       end
  69     end
  70   else
  71     all_tag_links = api_call($arvados.links.list,
  72                              request_body: {
  73                                :where => {
  74                                  :link_class => :tag,
  75                                  :name => tag,
  76                                }
  77                              })
  78     link_uuids = all_tag_links['items'].map { |obj| obj['uuid'] }
  79   end
  80
  81   results = []
  82   if link_uuids
  83     link_uuids.each do |uuid|
  84       results.push api_call($arvados.links.delete, parameters:{ :uuid => uuid })
  85     end
  86   else
  87     $stderr.puts "no tags found to remove"
  88   end
  89
  90   return results
  91 end
  92
  93 if RUBY_VERSION < '1.9.3' then
  94   abort <<-EOS
  95 #{$0.gsub(/^\.\//,'')} requires Ruby version 1.9.3 or higher.
  96 EOS
  97 end
  98
  99 $arvados_api_version = ENV['ARVADOS_API_VERSION'] || 'v1'
 100 $arvados_api_host = ENV['ARVADOS_API_HOST'] or
 101   abort "#{$0}: fatal: ARVADOS_API_HOST environment variable not set."
 102 $arvados_api_token = ENV['ARVADOS_API_TOKEN'] or
 103   abort "#{$0}: fatal: ARVADOS_API_TOKEN environment variable not set."
 104 $arvados_api_host_insecure = ENV['ARVADOS_API_HOST_INSECURE'] == 'yes'
 105
 106 begin
 107   require 'rubygems'
 108   require 'google/api_client'
 109   require 'json'
 110   require 'pp'
 111   require 'oj'
 112   require 'trollop'
 113 rescue LoadError
 114   abort <<-EOS
 115 #{$0}: fatal: some runtime dependencies are missing.
 116 Try: gem install pp google-api-client json trollop
 117   EOS
 118 end
 119
 120 def debuglog(message, verbosity=1)
 121   $stderr.puts "#{File.split($0).last} #{$$}: #{message}" if $debuglevel >= verbosity
 122 end
 123
 124 module Kernel
 125   def suppress_warnings
 126     original_verbosity = $VERBOSE
 127     $VERBOSE = nil
 128     result = yield
 129     $VERBOSE = original_verbosity
 130     return result
 131   end
 132 end
 133
 134 if $arvados_api_host_insecure or $arvados_api_host.match /local/
 135   # You probably don't care about SSL certificate checks if you're
 136   # testing with a dev server.
 137   suppress_warnings { OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE }
 138 end
 139
 140 class Google::APIClient
 141   def discovery_document(api, version)
 142     api = api.to_s
 143     return @discovery_documents["#{api}:#{version}"] ||=
 144       begin
 145         response = self.execute!(
 146                                  :http_method => :get,
 147                                  :uri => self.discovery_uri(api, version),
 148                                  :authenticated => false
 149                                  )
 150         response.body.class == String ? JSON.parse(response.body) : response.body
 151       end
 152   end
 153 end
 154
 155 global_opts = Trollop::options do
 156   banner usage_string
 157   banner ""
 158   opt :dry_run, "Don't actually do anything", :short => "-n"
 159   opt :verbose, "Print some things on stderr", :short => "-v"
 160   opt :uuid, "Return the UUIDs of the objects in the response, one per line (default)", :short => nil
 161   opt :json, "Return the entire response received from the API server, as a JSON object", :short => "-j"
 162   opt :human, "Return the response received from the API server, as a JSON object with whitespace added for human consumption", :short => "-h"
 163   opt :pretty, "Synonym of --human", :short => nil
 164   opt :yaml, "Return the response received from the API server, in YAML format", :short => "-y"
 165   stop_on ['add', 'remove']
 166 end
 167
 168 p = Trollop::Parser.new do
 169   opt(:all,
 170       "Remove this tag from all objects under your ownership. Only valid with `tag remove'.",
 171       :short => :none)
 172   opt(:object,
 173       "The UUID of an object to which this tag operation should be applied.",
 174       :type => :string,
 175       :multi => true,
 176       :short => :o)
 177 end
 178
 179 $options = Trollop::with_standard_exception_handling p do
 180   p.parse ARGV
 181 end
 182
 183 if $options[:all] and ARGV[0] != 'remove'
 184   usage
 185 end
 186
 187 # Set up the API client.
 188
 189 $client ||= Google::APIClient.
 190   new(:host => $arvados_api_host,
 191       :application_name => File.split($0).last,
 192       :application_version => $application_version.to_s)
 193 $arvados = $client.discovered_api('arvados', $arvados_api_version)
 194
 195 results = []
 196 cmd = ARGV.shift
 197
 198 if ARGV.empty?
 199   usage
 200 end
 201
 202 case cmd
 203 when 'add'
 204   ARGV.each do |tag|
 205     $options[:object].each do |obj|
 206       results.push(tag_add(tag, obj))
 207     end
 208   end
 209 when 'remove'
 210   ARGV.each do |tag|
 211     if $options[:all] then
 212       results.concat tag_remove(tag)
 213     else
 214       results.concat tag_remove(tag, $options[:object])
 215     end
 216   end
 217 else
 218   usage
 219 end
 220
 221 if global_opts[:human] or global_opts[:pretty] then
 222   puts Oj.dump(results, :indent => 1)
 223 elsif global_opts[:yaml] then
 224   puts results.to_yaml
 225 elsif global_opts[:json] then
 226   puts Oj.dump(results)
 227 else
 228   results.each do |r|
 229     if r['uuid'].nil?
 230       abort("Response did not include a uuid:\n" +
 231             Oj.dump(r, :indent => 1) +
 232             "\n")
 233     else
 234       puts r['uuid']
 235     end
 236   end
 237 end