aspera-cli 4.25.1 → 4.25.3

data/lib/aspera/ascp/installation.rb

@@ -26,10 +26,7 @@ module Aspera
     # Singleton that tells where to find ascp and other local resources (keys..) , using the "path(:name)" method.
     # It is used by object : AgentDirect to find necessary resources
     # By default it takes the first Aspera product found
-    # The user can specify ascp location by calling:
-    # Installation.instance.use_ascp_from_product(product_name)
-    # or
-    # Installation.instance.ascp_path=""
+    # The user can specify `ascp` location by calling: `sdk_folder=` method
     class Installation
       include Singleton
 
@@ -53,37 +50,37 @@ module Aspera
         end
       end
 
-      # set ascp executable "location"
-      def ascp_path=(v)
-        Aspera.assert_type(v, String)
-        Aspera.assert(!v.empty?){'ascp location cannot be empty: check your config file'}
-        @ascp_location = v
-        @ascp_path = nil
+      # Set `ascp` executable "location"
+      # It can be:
+      # - Full path to folder where `ascp` executable is located
+      # - "product:PRODUCT_NAME" to use ascp from named product
+      # - "product:FIRST" to use ascp from first found product
+      def sdk_folder=(ascp_location)
+        Aspera.assert_type(ascp_location, String){'ascp_location'}
+        Aspera.assert(!ascp_location.empty?){'ascp location cannot be empty: check your config file'}
+        folder =
+          if ascp_location.start_with?(USE_PRODUCT_PREFIX)
+            product_name = ascp_location[USE_PRODUCT_PREFIX.length..-1]
+            if product_name.eql?(FIRST_FOUND)
+              pl = installed_products.first
+              raise "No Aspera transfer module or SDK found.\nRefer to the manual or install SDK with command:\nascli conf transferd install" if pl.nil?
+            else
+              pl = installed_products.find{ |i| i[:name].eql?(product_name)}
+              raise "No such product installed: #{product_name}" if pl.nil?
+            end
+            File.dirname(pl[:ascp_path])
+          else
+            ascp_location.include?('/ascp') ? File.dirname(ascp_location) : ascp_location
+          end
+        Log.log.debug{"ascp_folder=#{folder}"}
+        Products::Transferd.sdk_directory = folder
         return
       end
 
-      def ascp_path
+      def sdk_folder
         path(:ascp)
       end
 
-      # Compatibility
-      def sdk_folder=(v)
-        Products::Transferd.sdk_directory = v
-      end
-
-      # find ascp in named product (use value : FIRST_FOUND='FIRST' to just use first one)
-      # or select one from installed_products()
-      def use_ascp_from_product(product_name)
-        if product_name.eql?(FIRST_FOUND)
-          pl = installed_products.first
-          raise "No Aspera transfer module or SDK found.\nRefer to the manual or install SDK with command:\nascli conf transferd install" if pl.nil?
-        else
-          pl = installed_products.find{ |i| i[:name].eql?(product_name)}
-          raise "No such product installed: #{product_name}" if pl.nil?
-        end
-        @ascp_path = pl[:ascp_path]
-      end
-
       # @return [Hash] with key = file name (String), and value = path to file
       def file_paths
         return SDK_FILES.each_with_object({}) do |v, m|
@@ -113,22 +110,8 @@ module Aspera
         case k
         when *EXE_FILES
           file_is_required = k.eql?(:ascp)
-          file = if k.eql?(:transferd)
-            Products::Transferd.transferd_path
-          else
-            # find ascp when needed
-            if @ascp_path.nil?
-              if @ascp_location.start_with?(USE_PRODUCT_PREFIX)
-                use_ascp_from_product(@ascp_location[USE_PRODUCT_PREFIX.length..-1])
-              else
-                @ascp_path = @ascp_location
-              end
-              Aspera.assert(File.exist?(@ascp_path)){"No such file: [#{@ascp_path}]"}
-              Log.log.debug{"ascp_path=#{@ascp_path}"}
-            end
-            # NOTE: that there might be a .exe at the end
-            @ascp_path.gsub('ascp', k.to_s)
-          end
+          file = Products::Transferd.transferd_path
+          file = File.join(File.dirname(file), Environment.instance.exe_file(k.to_s)) unless k.eql?(:transferd)
         when :ssh_private_dsa, :ssh_private_rsa
           # assume last 3 letters are type
           type = k.to_s[-3..-1].to_sym
@@ -197,7 +180,7 @@ module Aspera
       def ascp_info_from_log
         data = {}
         # read PATHs from ascp directly, and pvcl modules as well
-        Open3.popen3(ascp_path, '-DDL-') do |_stdin, _stdout, stderr, thread|
+        Open3.popen3(path(:ascp), '-DDL-') do |_stdin, _stdout, stderr, thread|
           last_line = ''
           while (line = stderr.gets)
             line.chomp!
@@ -230,13 +213,13 @@ module Aspera
       # Openssl information
       def ascp_info_from_file
         data = {}
-        File.binread(ascp_path).scan(/[\x20-\x7E]{10,}/) do |bin_string|
+        File.binread(path(:ascp)).scan(/[\x20-\x7E]{10,}/) do |bin_string|
           if (m = bin_string.match(/OPENSSLDIR.*"(.*)"/))
             data['ascp_openssl_dir'] = m[1]
           elsif (m = bin_string.match(/OpenSSL (\d[^ -]+)/))
             data['ascp_openssl_version'] = m[1]
           end
-        end if File.file?(ascp_path)
+        end if File.file?(path(:ascp))
         return data
       end
 
@@ -374,9 +357,7 @@ module Aspera
       private_constant :DEFAULT_ASPERA_CONF, :EXE_FILES, :SDK_FILES, :TRANSFERD_ARCHIVE_LOCATION_URL
 
       def initialize
-        @ascp_path = nil
-        @ascp_location = nil
-        @sdk_dir = nil
+        # cache for installed products found
         @found_products = nil
         @transferd_urls = TRANSFERD_ARCHIVE_LOCATION_URL
       end

data/lib/aspera/assert.rb

@@ -55,7 +55,7 @@ module Aspera
       assert(classes.any?{ |k| value.is_a?(k)}, type: type){"#{"#{yield}: " if block_given?}expecting #{classes.join(', ')}, but have (#{value.class})#{value.inspect}"}
     end
 
-    # Assert that all value of array are of the same specified type
+    # Assert that all value of array are of the same specified type.
     # @param array   [Array]            The array to check
     # @param klass   [Class]            The expected type of elements
     # @param type    [Exception,Symbol] Exception to raise, or Symbol for Log.log
@@ -93,7 +93,7 @@ module Aspera
     # The value is not one of the expected values
     # @param value  [Object]           The wrong value
     # @param type   [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param block  [Proc]             Additional description in front of message
+    # @param &block [Proc]             Additional description in front of message
     def error_unexpected_value(value, type: InternalError)
       report_error(type, "#{"#{yield}: " if block_given?}unexpected value: #{value.inspect}")
     end

data/lib/aspera/cli/extended_value.rb

@@ -5,6 +5,7 @@ require 'aspera/uri_reader'
 require 'aspera/environment'
 require 'aspera/log'
 require 'aspera/assert'
+require 'aspera/cli/error'
 require 'json'
 require 'base64'
 require 'zlib'

data/lib/aspera/cli/formatter.rb

@@ -30,10 +30,6 @@ module Aspera
       SINGLE_OBJECT_COLUMN_NAMES = %i[field value].freeze
 
       private_constant :FIELDS_LESS, :DISPLAY_FORMATS, :DISPLAY_LEVELS, :SINGLE_OBJECT_COLUMN_NAMES
-      # prefix to display error messages in user messages (terminal)
-      ERROR_FLASH = 'ERROR:'.bg_red.gray.blink.freeze
-      WARNING_FLASH = 'WARNING:'.bg_brown.black.blink.freeze
-      HINT_FLASH = 'HINT:'.bg_green.gray.blink.freeze
 
       class << self
         # nicer display for boolean

data/lib/aspera/cli/hints.rb

@@ -26,7 +26,7 @@ module Aspera
           ]
         },
         {
-          exception:   RestCallError,
+          exception:   Aspera::RestCallError,
           match:       /Signature has expired/,
           remediation: [
             'There is too much time difference between your computer and the server',
@@ -108,6 +108,20 @@ module Aspera
             'Transfer user shall have those parameters in aspera.conf set to: token',
             'authorization_transfer_in_value authorization_transfer_out_value'
           ]
+        },
+        {
+          exception:   Aspera::RestCallError,
+          match:       /invalid_grant/,
+          remediation: [
+            'Check your public key in your AoC user profile.'
+          ]
+        },
+        {
+          exception:   Aspera::RestCallError,
+          match:       /Please configure ACLs for this URI/,
+          remediation: [
+            'server must have: asnodeadmin -mu <node user> --acl-add=internal --internal'
+          ]
         }
       ]
       private_constant :ERROR_HINTS
@@ -129,9 +143,9 @@ module Aspera
                 next unless message.match?(m)
               else Aspera.error_unexpected_value(m)
               end
-              remediation = hint[:remediation]
-              remediation = [remediation] unless remediation.is_a?(Array)
-              remediation.each{ |r| formatter.display_message(:error, "#{Formatter::HINT_FLASH} #{r}")}
+              hint[:remediation].each do |r|
+                Log.log.info{"#{'HINT:'.bg_green.gray.blink.freeze} #{r}"}
+              end
               break
             end
           end

data/lib/aspera/cli/main.rb

@@ -228,7 +228,7 @@ module Aspera
         # 1- processing of error condition
         unless exception_info.nil?
           Log.log.warn(exception_info[:e].message) if Log.instance.logger_type.eql?(:syslog) && exception_info[:security]
-          @context.formatter.display_message(:error, "#{Formatter::ERROR_FLASH} #{exception_info[:t]}: #{exception_info[:e].message}")
+          Log.log.error{"#{exception_info[:t]}: #{exception_info[:e].message}"}
           Log.log.debug{(['Backtrace:'] + exception_info[:e].backtrace).join("\n")} if exception_info[:debug]
           @context.formatter.display_message(:error, 'Use option -h to get help.') if exception_info[:usage]
           # Is that a known error condition with proposal for remediation ?
@@ -237,7 +237,7 @@ module Aspera
         # 2- processing of command not processed (due to exception or bad command line)
         if execute_command || @option_show_config
           @context.options.final_errors.each do |msg|
-            @context.formatter.display_message(:error, "#{Formatter::ERROR_FLASH} Argument: #{msg}")
+            Log.log.error{"Argument: #{msg}"}
             # Add code as exception if there is not already an error
             exception_info = {e: Exception.new(msg), t: 'UnusedArg'} if exception_info.nil?
           end
@@ -291,10 +291,7 @@ module Aspera
         @context.formatter.declare_options(@context.options)
         # Compare $0 with expected name
         current_prog_name = File.basename($PROGRAM_NAME)
-        @context.formatter.display_message(
-          :error,
-          "#{Formatter::WARNING_FLASH} Please use '#{Info::CMD_NAME}' instead of '#{current_prog_name}'"
-        ) unless current_prog_name.eql?(Info::CMD_NAME)
+        Aspera.assert(current_prog_name.eql?(Info::CMD_NAME), type: :warn){"Please use '#{Info::CMD_NAME}' instead of '#{current_prog_name}'"}
         # Declare and parse global options
         declare_global_options
         # Do not display config commands if help is asked

data/lib/aspera/cli/manager.rb

@@ -12,6 +12,37 @@ require 'optparse'
 
 module Aspera
   module Cli
+    module BoolValue
+      # boolean options are set to true/false from the following values
+      YES_SYM = :yes
+      NO_SYM = :no
+      FALSE_VALUES = [NO_SYM, false].freeze
+      TRUE_VALUES = [YES_SYM, true].freeze
+      private_constant :YES_SYM, :NO_SYM, :FALSE_VALUES, :TRUE_VALUES
+      # Boolean values
+      # @return [Array<true, false, :yes, :no>]
+      ALL = (TRUE_VALUES + FALSE_VALUES).freeze
+      TYPES = [FalseClass, TrueClass].freeze
+      SYMBOLS = [NO_SYM, YES_SYM].freeze
+      # @return `true` if value is a value for `true` in ALL
+      def true?(enum)
+        Aspera.assert_values(enum, ALL){'boolean'}
+        return TRUE_VALUES.include?(enum)
+      end
+
+      # @return [:yes, :no]
+      def to_sym(enum)
+        Aspera.assert_values(enum, ALL){'boolean'}
+        return TRUE_VALUES.include?(enum) ? YES_SYM : NO_SYM
+      end
+
+      # @return `true` if value is a value for `true` or `false` in ALL
+      def symbol?(sym)
+        return ALL.include?(sym)
+      end
+      module_function :true?, :to_sym, :symbol?
+    end
+
     # Constants to be used as parameter `allowed:` for `OptionValue`
     module Allowed
       # This option can be set to a single string or array, multiple times, and gives Array of String
@@ -20,7 +51,7 @@ module Aspera
       TYPES_SYMBOL_ARRAY = [Array, Symbol].freeze
       # Value will be coerced to int
       TYPES_INTEGER = [Integer].freeze
-      TYPES_BOOLEAN = [FalseClass, TrueClass].freeze
+      TYPES_BOOLEAN = BoolValue::TYPES
       # no value at all, it's a switch
       TYPES_NONE = [].freeze
       TYPES_ENUM = [Symbol].freeze
@@ -35,7 +66,8 @@ module Aspera
       attr_accessor :values
 
       # @param option      [Symbol] Name of option
-      # @param allowed  [see below] Allowed values
+      # @param description [String] Description for help
+      # @param allowed  [nil,Class,Array<Class>,Array<Symbol>] Allowed values
       # @param handler       [Hash] Accessor: keys: :o(object) and :m(method)
       # @param deprecation [String] Deprecation message
       # `allowed`:
@@ -61,7 +93,7 @@ module Aspera
         else
           :setter
         end
-        Aspera.assert(@object.respond_to?(@read_method)){"#{@object} does not respond to #{method}"} unless @access.eql?(:local)
+        Aspera.assert(@object.respond_to?(@read_method)){"#{@object} does not respond to #{@read_method}"} unless @access.eql?(:local)
         @types = nil
         @values = nil
         if !allowed.nil?
@@ -73,7 +105,7 @@ module Aspera
             @values = allowed[Allowed::TYPES_SYMBOL_ARRAY.length..-1]
           elsif allowed.all?(Class)
             @types = allowed
-            @values = Manager::BOOLEAN_VALUES if allowed.eql?(Allowed::TYPES_BOOLEAN)
+            @values = BoolValue::ALL if allowed.eql?(Allowed::TYPES_BOOLEAN)
             # Default value for array
             @object ||= [] if @types.first.eql?(Array) && !@types.include?(NilClass)
             @object ||= {} if @types.first.eql?(Hash) && !@types.include?(NilClass)
@@ -109,7 +141,7 @@ module Aspera
         Aspera.assert(!@deprecation, type: warn){"Option #{@option} is deprecated: #{@deprecation}"}
         new_value = ExtendedValue.instance.evaluate(value, context: "option: #{@option}", allowed: @types)
         Log.log.trace1{"#{where}: #{@option} <- (#{new_value.class})#{new_value}"}
-        new_value = Manager.enum_to_bool(new_value) if @types.eql?(Allowed::TYPES_BOOLEAN)
+        new_value = BoolValue.true?(new_value) if @types.eql?(Allowed::TYPES_BOOLEAN)
         new_value = Integer(new_value) if @types.eql?(Allowed::TYPES_INTEGER)
         new_value = [new_value] if @types.eql?(Allowed::TYPES_STRING_ARRAY) && new_value.is_a?(String)
         # Setting a Hash to null set an empty hash
@@ -141,20 +173,7 @@ module Aspera
     # arguments options start with '-', others are commands
     # resolves on extended value syntax
     class Manager
-      BOOLEAN_SIMPLE = %i[no yes].freeze
       class << self
-        # @return `true` if value is a value for `true` in BOOLEAN_VALUES
-        def enum_to_bool(enum)
-          Aspera.assert_values(enum, BOOLEAN_VALUES){'boolean'}
-          return TRUE_VALUES.include?(enum)
-        end
-
-        # @return :yes ot :no
-        def enum_to_yes_no(enum)
-          Aspera.assert_values(enum, BOOLEAN_VALUES){'boolean'}
-          return TRUE_VALUES.include?(enum) ? BOOL_YES : BOOL_NO
-        end
-
         # Find shortened string value in allowed symbol list
         def get_from_list(short_value, descr, allowed_values)
           Aspera.assert_type(short_value, String)
@@ -164,7 +183,7 @@ module Aspera
           matching = allowed_values.select{ |i| i.to_s.start_with?(short_value)}
           Aspera.assert(!matching.empty?, multi_choice_assert_msg("unknown value for #{descr}: #{short_value}", allowed_values), type: BadArgument)
           Aspera.assert(matching.length.eql?(1), multi_choice_assert_msg("ambiguous shortcut for #{descr}: #{short_value}", matching), type: BadArgument)
-          return enum_to_bool(matching.first) if allowed_values.eql?(BOOLEAN_VALUES)
+          return BoolValue.true?(matching.first) if allowed_values.eql?(BoolValue::ALL)
           return matching.first
         end
 
@@ -278,11 +297,11 @@ module Aspera
         case option_attrs.types
         when Allowed::TYPES_ENUM, Allowed::TYPES_BOOLEAN
           # This option value must be a symbol (or array of symbols)
-          set_option(option_symbol, Manager.enum_to_bool(default), where: 'default') if option_attrs.values.eql?(BOOLEAN_VALUES) && !default.nil?
+          set_option(option_symbol, BoolValue.true?(default), where: 'default') if option_attrs.values.eql?(BoolValue::ALL) && !default.nil?
           value = get_option(option_symbol)
           help_values =
             if option_attrs.types.eql?(Allowed::TYPES_BOOLEAN)
-              highlight_current_in_list(BOOLEAN_SIMPLE, self.class.enum_to_yes_no(value))
+              highlight_current_in_list(BoolValue::SYMBOLS, BoolValue.to_sym(value))
             else
               highlight_current_in_list(option_attrs.values, value)
             end
@@ -600,9 +619,12 @@ module Aspera
       end
 
       # TODO: use formatter
-      # @return [String] comma separated list of values, with the current value highlighted
+      # Highlight current value in list
+      # @param list    [Array<Symbol>] List of possible values
+      # @param current [Symbol]        Current value
+      # @return [String] comma separated sorted list of values, with the current value highlighted
       def highlight_current_in_list(list, current)
-        list.map do |i|
+        list.sort.map do |i|
           if i.eql?(current)
             $stdout.isatty ? i.to_s.red.bold : "[#{i}]"
           else
@@ -632,12 +654,6 @@ module Aspera
           unprocessed_options.delete(k)
         end
       end
-      # boolean options are set to true/false from the following values
-      BOOL_YES = BOOLEAN_SIMPLE.last
-      BOOL_NO = BOOLEAN_SIMPLE.first
-      FALSE_VALUES = [BOOL_NO, false].freeze
-      TRUE_VALUES = [BOOL_YES, true].freeze
-      BOOLEAN_VALUES = (TRUE_VALUES + FALSE_VALUES).freeze
 
       # Option name separator on command line, e.g. in --option-blah, third "-"
       OPTION_SEP_LINE = '-'
@@ -651,7 +667,7 @@ module Aspera
       OPTIONS_STOP = '--'
       SOURCE_USER = 'cmdline' # cspell:disable-line
 
-      private_constant :BOOL_YES, :BOOL_NO, :FALSE_VALUES, :TRUE_VALUES, :OPTION_SEP_LINE, :OPTION_SEP_SYMBOL, :OPTION_VALUE_SEPARATOR, :OPTION_PREFIX, :OPTIONS_STOP, :SOURCE_USER
+      private_constant :OPTION_SEP_LINE, :OPTION_SEP_SYMBOL, :OPTION_VALUE_SEPARATOR, :OPTION_PREFIX, :OPTIONS_STOP, :SOURCE_USER
     end
   end
 end