aspera-cli 4.2.0 → 4.4.0

data/lib/aspera/command_line_builder.rb

@@ -4,21 +4,45 @@ module Aspera
   # process_param is called repeatedly with all known parameters
   # add_env_args is called to get resulting param list and env var (also checks that all params were used)
   class CommandLineBuilder
+    # transform yes/no to trye/false
+    def self.yes_to_true(value)
+      case value
+      when 'yes'; return true
+      when 'no'; return false
+      end
+      raise "unsupported value: #{value}"
+    end
 
-    private
-    # default value for command line based on option name
-    def switch_name(param_name,options)
-      return options[:option_switch] if options.has_key?(:option_switch)
-      return '--'+param_name.to_s.gsub('_','-')
+    # Called by provider of definition before constructor of this class so that params_definition has all mandatory fields
+    def self.normalize_description(d)
+      d.each do |param_name,options|
+        raise "Expecting Hash, but have #{options.class} in #{param_name}" unless options.is_a?(Hash)
+        #options[:accepted_types]=:bool if options[:cltype].eql?(:envvar) and !options.has_key?(:accepted_types)
+        # by default : not mandatory
+        options[:mandatory]||=false
+        options[:desc]||=''
+        # by default : string, unless it's without arg
+        if ! options.has_key?(:accepted_types)
+          options[:accepted_types]=options[:cltype].eql?(:opt_without_arg) ? :bool : :string
+        end
+        # single type is placed in array
+        options[:accepted_types]=[options[:accepted_types]] unless options[:accepted_types].is_a?(Array)
+        if !options.has_key?(:option_switch) and options.has_key?(:cltype) and [:opt_without_arg,:opt_with_arg].include?(options[:cltype])
+          options[:option_switch]='--'+param_name.to_s.gsub('_','-')
+        end
+      end
     end
 
+    private
+
+    # clvarname : command line variable name
     def env_name(param_name,options)
-      return options[:variable]
+      return options[:clvarname]
     end
 
     public
 
-    BOOLEAN_CLASSES=[TrueClass,FalseClass]
+    attr_reader :params_definition
 
     # @param param_hash
     def initialize(param_hash,params_definition)
@@ -44,15 +68,6 @@ module Aspera
       return nil
     end
 
-    # transform yes/no to trye/false
-    def self.yes_to_true(value)
-      case value
-      when 'yes'; return true
-      when 'no'; return false
-      end
-      raise "unsupported value: #{value}"
-    end
-
     # add options directly to ascp command line
     def add_command_line_options(options)
       return if options.nil?
@@ -71,24 +86,25 @@ module Aspera
     # @param options : options for type
     def process_param(param_name,action=nil)
       options=@params_definition[param_name]
-      action=options[:type] if action.nil?
+      action=options[:cltype] if action.nil?
       # should not happen
       raise "Internal error: ask processing of param #{param_name}" if options.nil?
-      # by default : not mandatory
-      options[:mandatory]||=false
-      if options.has_key?(:accepted_types)
-        # single type is placed in array
-        options[:accepted_types]=[options[:accepted_types]] unless options[:accepted_types].is_a?(Array)
-      else
-        # by default : string, unless it's without arg
-        options[:accepted_types]=action.eql?(:opt_without_arg) ? BOOLEAN_CLASSES : [String]
-      end
       # check mandatory parameter (nil is valid value)
       raise Fasp::Error.new("mandatory parameter: #{param_name}") if options[:mandatory] and !@param_hash.has_key?(param_name)
       parameter_value=@param_hash[param_name]
-      parameter_value=options[:default] if parameter_value.nil? and options.has_key?(:default)
+      #parameter_value=options[:default] if parameter_value.nil? and options.has_key?(:default)
+      expected_classes=options[:accepted_types].map do |s|
+        case s
+        when :string; String
+        when :array; Array
+        when :hash; Hash
+        when :int; Integer
+        when :bool; [TrueClass,FalseClass]
+        else raise "INTERNAL: unexpected value: #{s}"
+        end
+      end.flatten
       # check provided type
-      raise Fasp::Error.new("#{param_name} is : #{parameter_value.class} (#{parameter_value}), shall be #{options[:accepted_types]}, ") unless parameter_value.nil? or options[:accepted_types].inject(false){|m,v|m or parameter_value.is_a?(v)}
+      raise Fasp::Error.new("#{param_name} is : #{parameter_value.class} (#{parameter_value}), shall be #{options[:accepted_types]}, ") unless parameter_value.nil? or expected_classes.include?(parameter_value.class)
       @used_param_names.push(param_name) unless action.eql?(:defer)
 
       # process only non-nil values
@@ -102,7 +118,8 @@ module Aspera
       end
       raise "unsupported value: #{parameter_value}" unless options[:accepted_values].nil? or options[:accepted_values].include?(parameter_value)
       if options[:encode]
-        newvalue=options[:encode].call(parameter_value)
+        # :encode has name of class with encoding method
+        newvalue=Kernel.const_get(options[:encode]).send("encode_#{param_name}",parameter_value)
         raise Fasp::Error.new("unsupported #{param_name}: #{parameter_value}") if newvalue.nil?
         parameter_value=newvalue
       end
@@ -123,12 +140,12 @@ module Aspera
         else raise Fasp::Error.new("unsupported #{param_name}: #{parameter_value}")
         end
         add_param=!add_param if options[:add_on_false]
-        add_command_line_options([switch_name(param_name,options)]) if add_param
+        add_command_line_options([options[:option_switch]]) if add_param
       when :opt_with_arg # transform into command line option with value
         #parameter_value=parameter_value.to_s if parameter_value.is_a?(Integer)
         parameter_value=[parameter_value] unless parameter_value.is_a?(Array)
         # if transfer_spec value is an array, applies option many times
-        parameter_value.each{|v|add_command_line_options([switch_name(param_name,options),v])}
+        parameter_value.each{|v|add_command_line_options([options[:option_switch],v])}
       else
         raise "Error"
       end

data/lib/aspera/cos_node.rb

@@ -6,6 +6,7 @@ module Aspera
   class CosNode < Rest
     attr_reader :add_ts
     IBM_CLOUD_TOKEN_URL='https://iam.cloud.ibm.com/identity'
+    TOKEN_FIELD='delegated_refresh_token'
     def initialize(bucket_name,storage_endpoint,instance_id,api_key,auth_url=IBM_CLOUD_TOKEN_URL)
       @auth_url=auth_url
       @api_key=api_key
@@ -32,7 +33,7 @@ module Aspera
       # prepare transfer spec addition
       @add_ts={'tags'=>{'aspera'=>{'node'=>{'storage_credentials'=>{
         'type'  => 'token',
-        'token' => {'delegated_refresh_token'=>nil}
+        'token' => {TOKEN_FIELD=>nil}
         }}}}}
       generate_token
     end
@@ -45,10 +46,10 @@ module Aspera
         :base_url   => @auth_url,
         :grant      => :delegated_refresh,
         :api_key    => @api_key,
-        :token_field=> 'delegated_refresh_token'
+        :token_field=> TOKEN_FIELD
       })
       # get delagated token to be placed in rest call header and in transfer tags
-      @add_ts['tags']['aspera']['node']['storage_credentials']['token']['delegated_refresh_token']=delegated_oauth.get_authorization().gsub(/^Bearer /,'')
+      @add_ts['tags']['aspera']['node']['storage_credentials']['token'][TOKEN_FIELD]=delegated_oauth.get_authorization().gsub(/^Bearer /,'')
       @params[:headers]={'X-Aspera-Storage-Credentials'=>JSON.generate(@add_ts['tags']['aspera']['node']['storage_credentials'])}
     end
   end

data/lib/aspera/fasp/http_gw.rb

@@ -4,15 +4,14 @@ require 'aspera/log'
 require 'aspera/rest'
 require 'websocket-client-simple'
 require 'securerandom'
-require 'openssl'
 require 'base64'
 require 'json'
-require 'uri'
 
 # ref: https://api.ibm.com/explorer/catalog/aspera/product/ibm-aspera/api/http-gateway-api/doc/guides-toc
+# https://developer.ibm.com/apis/catalog?search=%22aspera%20http%22
 module Aspera
   module Fasp
-    # executes a local "ascp", connects mgt port, equivalent of "Fasp Manager"
+    # start a transfer using Aspera HTTP Gateway, using web socket session
     class HttpGW < Manager
       # message returned by HTTP GW in case of success
       OK_MESSAGE='end upload'
@@ -25,20 +24,36 @@ module Aspera
       end
 
       def upload(transfer_spec)
-        # precalculate size
+        # total size of all files
         total_size=0
-        # currently, files are sent flat
-        source_path=[]
+        # we need to keep track of actual file path because transfer spec is modified to be sent in web socket
+        source_paths=[]
+        # get source root or nil
+        source_root = (transfer_spec.has_key?('source_root') and !transfer_spec['source_root'].empty?) ? transfer_spec['source_root'] : nil
+        # source root is ignored by GW, used only here
+        transfer_spec.delete('source_root')
+        # compute total size of files to upload (for progress)
+        # modify transfer spec to be suitable for GW
         transfer_spec['paths'].each do |item|
-          filepath=item['source']
-          item['source']=item['destination']=File.basename(filepath)
-          total_size+=item['file_size']=File.size(filepath)
-          source_path.push(filepath)
+          # save actual file location to be able read contents later
+          full_src_filepath=item['source']
+          # add source root if needed
+          full_src_filepath=File.join(source_root,full_src_filepath) unless source_root.nil?
+          # GW expects a simple file name in 'source' but if user wants to change the name, we take it
+          item['source']=File.basename(item['destination'].nil? ? item['source'] : item['destination'])
+          item['file_size']=File.size(full_src_filepath)
+          total_size+=item['file_size']
+          # save so that we can actually read the file later
+          source_paths.push(full_src_filepath)
         end
+
         session_id=SecureRandom.uuid
         ws=::WebSocket::Client::Simple::Client.new
+        # error message if any in callback
         error=nil
+        # number of files totally sent
         received=0
+        # setup callbacks on websocket
         ws.on :message do |msg|
           Log.log.info("ws: message: #{msg.data}")
           message=msg.data
@@ -64,44 +79,49 @@ module Aspera
         end
         # open web socket to end point
         ws.connect("#{@gw_api.params[:base_url]}/upload")
+        # async wait ready
         while !ws.open? and error.nil? do
           Log.log.info("ws: wait")
           sleep(0.2)
         end
+        # notify progress bar
         notify_begin(session_id,total_size)
+        # first step send transfer spec
+        Log.dump(:ws_spec,transfer_spec)
         ws_send(ws,:transfer_spec,transfer_spec)
         # current file index
-        filenum=0
+        file_index=0
         # aggregate size sent
         sent_bytes=0
         # last progress event
-        lastevent=Time.now-1
+        lastevent=nil
         transfer_spec['paths'].each do |item|
-          # TODO: on destination write same path?
-          destination_path=item['source']
           # TODO: get mime type?
           file_mime_type=''
-          total=item['file_size']
+          file_size=item['file_size']
+          file_name=File.basename(item[item['destination'].nil? ? 'source' : 'destination'])
           # compute total number of slices
-          numslices=1+(total-1)/@upload_chunksize
-          # current slice index
-          slicenum=0
-          File.open(source_path[filenum]) do |file|
+          numslices=1+(file_size-1)/@upload_chunksize
+          File.open(source_paths[file_index]) do |file|
+            # current slice index
+            slicenum=0
             while !file.eof? do
               data=file.read(@upload_chunksize)
               slice_data={
-                name: destination_path,
+                name: file_name,
                 type: file_mime_type,
-                size: total,
+                size: file_size,
                 data: Base64.strict_encode64(data),
                 slice: slicenum,
                 total_slices: numslices,
-                fileIndex: filenum
+                fileIndex: file_index
               }
+              # log without data
+              Log.dump(:slide_data,slice_data.keys.inject({}){|m,i|m[i]=i.eql?(:data)?'base64 data':slice_data[i];m}) if slicenum.eql?(0)
               ws_send(ws,:slice_upload, slice_data)
               sent_bytes+=data.length
               currenttime=Time.now
-              if (currenttime-lastevent)>UPLOAD_REFRESH_SEC
+              if lastevent.nil? or (currenttime-lastevent)>UPLOAD_REFRESH_SEC
                 notify_progress(session_id,sent_bytes)
                 lastevent=currenttime
               end
@@ -109,7 +129,7 @@ module Aspera
               raise error unless error.nil?
             end
           end
-          filenum+=1
+          file_index+=1
         end
         ws.close
         notify_end(session_id)
@@ -150,7 +170,8 @@ module Aspera
         raise "GW URL must be set" unless !@gw_api.nil?
         raise "option: must be hash (or nil)" unless options.is_a?(Hash)
         raise "paths: must be Array" unless transfer_spec['paths'].is_a?(Array)
-        raise "on token based transfer is supported in GW" unless transfer_spec['token'].is_a?(String)
+        raise "only token based transfer is supported in GW" unless transfer_spec['token'].is_a?(String)
+        Log.dump(:user_spec,transfer_spec)
         transfer_spec['authentication']||='token'
         case transfer_spec['direction']
         when 'send'
@@ -188,6 +209,6 @@ module Aspera
         @upload_chunksize=128000 # TODO: configurable ?
       end
 
-    end # LocalHttp
+    end # HttpGW
   end
 end

data/lib/aspera/fasp/local.rb

@@ -17,15 +17,14 @@ require 'securerandom'
 
 module Aspera
   module Fasp
-    # (public) default transfer username for access key based transfers
-    ACCESS_KEY_TRANSFER_USER='xfer'
     # executes a local "ascp", connects mgt port, equivalent of "Fasp Manager"
     class Local < Manager
-      # options for initialize
+      # options for initialize (same as values in option transfer_info)
       DEFAULT_OPTIONS = {
         :spawn_timeout_sec => 3,
         :spawn_delay_sec   => 2,
         :wss               => false,
+        :multi_incr_udp    => true,
         :resume            => {}
       }
       DEFAULT_UDP_PORT=33001
@@ -64,21 +63,27 @@ module Aspera
           transfer_spec['EX_ssh_key_paths'] = Installation.instance.bypass_keys
         end
 
-        # TODO: check if changing fasp(UDP) port is really necessary, not clear from doc
-        # compute this before using transfer spec, even if the var is not used in single session
-        multi_session_udp_port_base=DEFAULT_UDP_PORT
-        multi_session_number=0
+        # Compute this before using transfer spec because it potentially modifies the transfer spec
+        # (even if the var is not used in single session)
+        multi_session_info=nil
         if transfer_spec.has_key?('multi_session')
-          multi_session_number=transfer_spec['multi_session'].to_i
-          if multi_session_number < 0
+          multi_session_info={
+            count: transfer_spec['multi_session'].to_i,
+          }
+          # Managed by multi-session, so delete from transfer spec
+          transfer_spec.delete('multi_session')
+          if multi_session_info[:count] < 0
             Log.log.error("multi_session(#{transfer_spec['multi_session']}) shall be integer >= 0")
-            multi_session_number = 0
-          end
-          if multi_session_number > 0
-            # managed here, so delete from transfer spec
-            transfer_spec.delete('multi_session')
-            if transfer_spec.has_key?('fasp_port')
-              multi_session_udp_port_base=transfer_spec['fasp_port']
+            multi_session_info = nil
+          elsif multi_session_info[:count].eql?(0)
+            Log.log.debug("multi_session  count is zero: no multisession")
+            multi_session_info = nil
+          else # multi_session_info[:count] > 0
+            # if option not true: keep default udp port for all sessions
+            if @options[:multi_incr_udp]
+              # override if specified, else use default value
+              multi_session_info[:udp_base]=transfer_spec.has_key?('fasp_port') ? transfer_spec['fasp_port'] : DEFAULT_UDP_PORT
+              # delete from original transfer spec, as we will increment values
               transfer_spec.delete('fasp_port')
             end
           end
@@ -111,22 +116,23 @@ module Aspera
           :options  => job_options  # [Hash]
         }
 
-        if multi_session_number <= 1
+        if multi_session_info.nil?
           Log.log.debug('Starting single session thread')
           # single session for transfer : simple
           session[:thread] = Thread.new(session) {|s|transfer_thread_entry(s)}
           xfer_job[:sessions].push(session)
         else
           Log.log.debug('Starting multi session threads')
-          1.upto(multi_session_number) do |i|
+          1.upto(multi_session_info[:count]) do |i|
+            # do not delay the first session
             sleep(@options[:spawn_delay_sec]) unless i.eql?(1)
             # do deep copy (each thread has its own copy because it is modified here below and in thread)
             this_session=session.clone()
             this_session[:env_args]=this_session[:env_args].clone()
             this_session[:env_args][:args]=this_session[:env_args][:args].clone()
-            this_session[:env_args][:args].unshift("-C#{i}:#{multi_session_number}")
-            # necessary only if server is not linux, i.e. server does not support port re-use
-            this_session[:env_args][:args].unshift('-O',"#{multi_session_udp_port_base+i-1}")
+            this_session[:env_args][:args].unshift("-C#{i}:#{multi_session_info[:count]}")
+            # option: increment (default as per ascp manual) or not (cluster on other side ?)
+            this_session[:env_args][:args].unshift('-O',"#{multi_session_info[:udp_base]+i-1}") if @options[:multi_incr_udp]
             this_session[:thread] = Thread.new(this_session) {|s|transfer_thread_entry(s)}
             xfer_job[:sessions].push(this_session)
           end
@@ -260,6 +266,7 @@ module Aspera
                 Log.log.error('need to regenerate token'.red)
                 if session[:options].is_a?(Hash) and session[:options].has_key?(:regenerate_token)
                   # regenerate token here, expired, or error on it
+                  # Note: in multi-session, each session will have a different one.
                   env_args[:env]['ASPERA_SCP_TOKEN']=session[:options][:regenerate_token].call(true)
                 end
               end
@@ -323,7 +330,7 @@ module Aspera
 
       private
 
-      # @param options : keys(symbol): wss, resume
+      # @param options : keys(symbol): see DEFAULT_OPTIONS
       def initialize(options=nil)
         super()
         # by default no interactive progress bar
@@ -332,7 +339,7 @@ module Aspera
         @jobs={}
         # mutex protects global data accessed by threads
         @mutex=Mutex.new
-        # manage options
+        # set default options and override if specified
         @options=DEFAULT_OPTIONS.clone
         if !options.nil?
           raise "expecting Hash (or nil), but have #{options.class}" unless options.is_a?(Hash)
@@ -340,7 +347,7 @@ module Aspera
             if DEFAULT_OPTIONS.has_key?(k)
               @options[k]=v
             else
-              raise "unknown local agent parameter: #{k}, expect one of #{DEFAULT_OPTIONS.keys.map{|i|i.to_s}.join(",")}"
+              raise "Unknown local agent parameter: #{k}, expect one of #{DEFAULT_OPTIONS.keys.map{|i|i.to_s}.join(",")}"
             end
           end
         end

data/lib/aspera/fasp/manager.rb

@@ -72,6 +72,9 @@ module Aspera
       # start_transfer(transfer_spec,options) : start and wait for completion
       # wait_for_transfers_completion : wait for termination of all transfers, @return list of : :success or error message
       # optional: shutdown
+      
+      # This checks the validity of the value returned by wait_for_transfers_completion
+      # it must be a list of :success or exception
       def self.validate_status_list(statuses)
         raise "internal error: bad statuses type: #{statuses.class}" unless statuses.is_a?(Array)
         raise "internal error: bad statuses content: #{statuses}" unless statuses.select{|i|!i.eql?(:success) and !i.is_a?(StandardError)}.empty?

data/lib/aspera/fasp/node.rb

@@ -7,9 +7,12 @@ module Aspera
     # this singleton class is used by the CLI to provide a common interface to start a transfer
     # before using it, the use must set the `node_api` member.
     class Node < Manager
-      def initialize(node_api)
+      # option include: root_id if the node is an access key
+      attr_writer :options
+      def initialize(node_api,options={})
         super()
         @node_api=node_api
+        @options=options
         # TODO: currently only supports one transfer. This is bad shortcut. but ok for CLI.
         @transfer_id=nil
       end
@@ -32,6 +35,25 @@ module Aspera
 
       # generic method
       def start_transfer(transfer_spec,options=nil)
+        # add root id if access key
+        if @options.has_key?(:root_id)
+          case transfer_spec['direction']
+          when 'send';transfer_spec['source_root_id']=@options[:root_id]
+          when 'receive';transfer_spec['destination_root_id']=@options[:root_id]
+          else raise "unexpected direction in ts: #{transfer_spec['direction']}"
+          end
+        end
+        # manage special additional parameter
+        if transfer_spec.has_key?('EX_ssh_key_paths') and transfer_spec['EX_ssh_key_paths'].is_a?(Array) and !transfer_spec['EX_ssh_key_paths'].empty?
+          # not standard, so place standard field
+          if transfer_spec.has_key?('ssh_private_key')
+            Log.log.warn('Both ssh_private_key and EX_ssh_key_paths are present, using ssh_private_key')
+          else
+            Log.log.warn('EX_ssh_key_paths has multiple keys, using first one only') unless transfer_spec['EX_ssh_key_paths'].length.eql?(1)
+            transfer_spec['ssh_private_key']=File.read(transfer_spec['EX_ssh_key_paths'].first)
+            transfer_spec.delete('EX_ssh_key_paths')
+          end
+        end
         if transfer_spec['tags'].is_a?(Hash) and transfer_spec['tags']['aspera'].is_a?(Hash)
           transfer_spec['tags']['aspera']['xfer_retry']||=150
         end