aspera-cli 4.24.1 → 4.25.0.pre

data/lib/aspera/cli/main.rb

@@ -4,7 +4,7 @@ require 'aspera/cli/manager'
 require 'aspera/cli/formatter'
 require 'aspera/cli/plugins/config'
 require 'aspera/cli/extended_value'
-require 'aspera/cli/plugin_factory'
+require 'aspera/cli/plugins/factory'
 require 'aspera/cli/transfer_agent'
 require 'aspera/cli/version'
 require 'aspera/cli/info'
@@ -46,29 +46,13 @@ module Aspera
       STATUS_FIELD = 'status'
       COMMAND_CONFIG = :config
       COMMAND_HELP = :help
-      # types that go to result of type = text
+      # Types that go to result of type = text
       SCALAR_TYPES = [String, Integer, Symbol].freeze
       USER_INTERFACES = %i[text graphical].freeze
 
       private_constant :COMMAND_CONFIG, :COMMAND_HELP, :SCALAR_TYPES, :USER_INTERFACES
 
       class << self
-        # early debug for parser
-        # Note: does not accept shortcuts
-        def early_debug_setup(argv)
-          Log.instance.program_name = Info::CMD_NAME
-          argv.each do |arg|
-            case arg
-            when '--' then break
-            when /^--log-level=(.*)/ then Log.instance.level = Regexp.last_match(1).to_sym
-            when /^--logger=(.*)/ then Log.instance.logger_type = Regexp.last_match(1).to_sym
-            end
-          rescue => e
-            $stderr.puts("Error: #{e}") # rubocop:disable Style/StderrPuts
-            Process.exit(1)
-          end
-        end
-
         def result_special(how); {type: :special, data: how}; end
 
         # Expect some list, but nothing to display
@@ -81,13 +65,13 @@ module Aspera
         # @param status [String] The status
         def result_status(status); return {type: :status, data: status}; end
 
-        # text result coming from command result
+        # Text result coming from command result
         def result_text(data); return {type: :text, data: data}; end
 
         def result_success; return result_status('complete'); end
 
         # Process statuses of finished transfer sessions
-        # raise exception if there is one error
+        # @raise exception if there is one error
         # else returns an empty status
         def result_transfer(statuses)
           worst = TransferAgent.session_status(statuses)
@@ -98,10 +82,10 @@ module Aspera
         # Used when one command executes several transfer jobs (each job being possibly multi session)
         # @param status_table [Array] [{STATUS_FIELD=>[status array],...},...]
         # @return a status object suitable as command result
-        # each element has a key STATUS_FIELD which contains the result of possibly multiple sessions
+        # Each element has a key STATUS_FIELD which contains the result of possibly multiple sessions
         def result_transfer_multiple(status_table)
           global_status = :success
-          # transform status array into string and find if there was problem
+          # Transform status array into string and find if there was problem
           status_table.each do |item|
             worst = TransferAgent.session_status(item[STATUS_FIELD])
             global_status = worst unless worst.eql?(:success)
@@ -153,7 +137,7 @@ module Aspera
         end
       end
 
-      # minimum initialization, no exception raised
+      # Minimum initialization, no exception raised
       def initialize(argv)
         @argv = argv
         Log.dump(:argv, @argv, level: :trace2)
@@ -163,16 +147,16 @@ module Aspera
         @context = Context.new
       end
 
-      # this is the main function called by initial script just after constructor
+      # This is the main function called by initial script just after constructor
       def process_command_line
-        # catch exception information , if any
+        # Catch exception information , if any
         exception_info = nil
-        # false if command shall not be executed (e.g. --show-config)
+        # False if command shall not be executed (e.g. --show-config)
         execute_command = true
-        # catch exceptions
+        # Catch exceptions
         begin
           init_agents_options_plugins
-          # help requested without command ? (plugins must be known here)
+          # Help requested without command ? (plugins must be known here)
           show_usage if @option_help && @context.options.command_or_arg_empty?
           generate_bash_completion if @bash_completion
           @context.config.periodic_check_newer_gem_version
@@ -180,35 +164,35 @@ module Aspera
             if @option_show_config && @context.options.command_or_arg_empty?
               COMMAND_CONFIG
             else
-              @context.options.get_next_command(PluginFactory.instance.plugin_list.unshift(COMMAND_HELP))
+              @context.options.get_next_command(Plugins::Factory.instance.plugin_list.unshift(COMMAND_HELP))
             end
-          # command will not be executed, but we need manual
+          # Command will not be executed, but we need manual
           @context.options.fail_on_missing_mandatory = false if @option_help || @option_show_config
-          # main plugin is not dynamically instantiated
+          # Main plugin is not dynamically instantiated
           case command_sym
           when COMMAND_HELP
             show_usage
           when COMMAND_CONFIG
             command_plugin = @context.config
           else
-            # get plugin, set options, etc
+            # Get plugin, set options, etc
             command_plugin = get_plugin_instance_with_options(command_sym)
-            # parse plugin specific options
+            # Parse plugin specific options
             @context.options.parse_options!
           end
-          # help requested for current plugin
+          # Help requested for current plugin
           show_usage(all: false) if @option_help
           if @option_show_config
             @context.formatter.display_results(type: :single_object, data: @context.options.known_options(only_defined: true).stringify_keys)
             execute_command = false
           end
-          # locking for single execution (only after "per plugin" option, in case lock port is there)
+          # Locking for single execution (only after "per plugin" option, in case lock port is there)
           lock_port = @context.options.get_option(:lock_port)
           if !lock_port.nil?
             begin
-              # no need to close later, will be freed on process exit. must save in member else it is garbage collected
+              # No need to close later, will be freed on process exit. must save in member else it is garbage collected
               Log.log.debug{"Opening lock port #{lock_port}"}
-              # loopback address, could also be 'localhost'
+              # Loopback address, could also be 'localhost'
               @tcp_server = TCPServer.new('127.0.0.1', lock_port)
             rescue StandardError => e
               execute_command = false
@@ -221,15 +205,16 @@ module Aspera
             Log.log.debug{"Wrote pid #{Process.pid} to #{pid_file}"}
             at_exit{File.delete(pid_file)}
           end
-          # execute and display (if not exclusive execution)
+          # Execute and display (if not exclusive execution)
           @context.formatter.display_results(**command_plugin.execute_action) if execute_command
-          # save config file if command modified it
+          # Save config file if command modified it
           @context.config.save_config_file_if_needed
-          # finish
+          # Finish
           @context.transfer.shutdown
         rescue Net::SSH::AuthenticationFailed => e; exception_info = {e: e, t: 'SSH', security: true}
         rescue OpenSSL::SSL::SSLError => e;         exception_info = {e: e, t: 'SSL'}
         rescue Cli::BadArgument => e;               exception_info = {e: e, t: 'Argument', usage: true}
+        rescue Cli::MissingArgument => e;           exception_info = {e: e, t: 'Missing', usage: true}
         rescue Cli::BadIdentifier => e;             exception_info = {e: e, t: 'Identifier'}
         rescue Cli::Error => e;                     exception_info = {e: e, t: 'Tool', usage: true}
         rescue Transfer::Error => e;                exception_info = {e: e, t: 'Transfer'}
@@ -238,12 +223,13 @@ module Aspera
         rescue StandardError => e;                  exception_info = {e: e, t: "Other(#{e.class.name})", debug: true}
         rescue Interrupt => e;                      exception_info = {e: e, t: 'Interruption', debug: true}
         end
-        # cleanup file list files
+        # Cleanup file list files
         TempFileManager.instance.cleanup
         # 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.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 ?
           Hints.hint_for(exception_info[:e], @context.formatter)
@@ -252,15 +238,15 @@ module Aspera
         if execute_command || @option_show_config
           @context.options.final_errors.each do |msg|
             @context.formatter.display_message(:error, "#{Formatter::ERROR_FLASH} Argument: #{msg}")
-            # add code as exception if there is not already an error
+            # Add code as exception if there is not already an error
             exception_info = {e: Exception.new(msg), t: 'UnusedArg'} if exception_info.nil?
           end
         end
         # 3- in case of error, fail the process status
         unless exception_info.nil?
-          # show stack trace in debug mode
+          # Show stack trace in debug mode
           raise exception_info[:e] if Log.log.debug?
-          # else give hint and exit
+          # Else give hint and exit
           @context.formatter.display_message(:error, 'Use --log-level=debug to get more details.') if exception_info[:debug]
           Process.exit(1)
         end
@@ -269,24 +255,24 @@ module Aspera
 
       def init_agents_options_plugins
         init_agents_and_options
-        # find plugins, shall be after parse! ?
-        PluginFactory.instance.add_plugins_from_lookup_folders
+        # Find plugins, shall be after parse! ?
+        Plugins::Factory.instance.add_plugins_from_lookup_folders
       end
 
       def show_usage(all: true, exit: true)
-        # display main plugin options (+config)
+        # Display main plugin options (+config)
         @context.formatter.display_message(:error, @context.options.parser)
         if all
           @context.only_manual
-          # list plugins that have a "require" field, i.e. all but main plugin
-          PluginFactory.instance.plugin_list.each do |plugin_name_sym|
-            # config was already included in the global options
+          # List plugins that have a "require" field, i.e. all but main plugin
+          Plugins::Factory.instance.plugin_list.each do |plugin_name_sym|
+            # Config was already included in the global options
             next if plugin_name_sym.eql?(COMMAND_CONFIG)
-            # override main option parser with a brand new, to avoid having global options
+            # Override main option parser with a brand new, to avoid having global options
             @context.options = Manager.new(Info::CMD_NAME)
-            @context.options.parser.banner = '' # remove default banner
+            @context.options.parser.banner = '' # Remove default banner
             get_plugin_instance_with_options(plugin_name_sym)
-            # display generated help for plugin options
+            # Display generated help for plugin options
             @context.formatter.display_message(:error, @context.options.parser.help)
           end
         end
@@ -297,34 +283,33 @@ module Aspera
 
       # This can throw exception if there is a problem with the environment, needs to be caught by execute method
       def init_agents_and_options
-        # create formatter, in case there is an exception, it is used to display.
+        # Create formatter, in case there is an exception, it is used to display.
         @context.formatter = Formatter.new
-        # create command line manager with arguments
+        # Create command line manager with arguments
         @context.options = Manager.new(Info::CMD_NAME, @argv)
-        # formatter adds options
+        # Formatter adds options
         @context.formatter.declare_options(@context.options)
-        ExtendedValue.instance.default_decoder = @context.options.get_option(:struct_parser)
-        # compare $0 with expected name
+        # 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)
-        # declare and parse global options
+        # Declare and parse global options
         declare_global_options
-        # do not display config commands if help is asked
+        # Do not display config commands if help is asked
         @context.man_header = false
-        # the Config plugin adds the @preset parser, so declare before TransferAgent which may use it
+        # The Config plugin adds the @preset parser, so declare before TransferAgent which may use it
         @context.config = Plugins::Config.new(context: @context)
         @context.man_header = true
-        # data persistency is set in config
+        # Data persistency is set in config
         Aspera.assert(@context.persistency){'missing persistency object'}
-        # the TransferAgent plugin may use the @preset parser
+        # The TransferAgent plugin may use the @preset parser
         @context.transfer = TransferAgent.new(@context.options, @context.config)
-        # add commands for config plugin after all options have been added
+        # Add commands for config plugin after all options have been added
         @context.config.add_manual_header(false)
         @context.validate
-        # set banner when all environment is created so that additional extended value modifiers are known, e.g. @preset
+        # Set banner when all environment is created so that additional extended value modifiers are known, e.g. @preset
         @context.options.parser.banner = app_banner
       end
 
@@ -362,48 +347,55 @@ module Aspera
         END_OF_BANNER
       end
 
-      # define header for manual
+      # Define header for manual
       def declare_global_options
         Log.log.debug('declare_global_options')
-        @context.options.declare(:help, 'Show this message', values: :none, short: 'h'){@option_help = true}
-        @context.options.declare(:bash_comp, 'Generate bash completion for command', values: :none){@bash_completion = true}
-        @context.options.declare(:show_config, 'Display parameters used for the provided action', values: :none){@option_show_config = true}
-        @context.options.declare(:version, 'Display version', values: :none, short: 'v'){@context.formatter.display_message(:data, Cli::VERSION); Process.exit(0)} # rubocop:disable Style/Semicolon
+        @context.options.declare(:help, 'Show this message', allowed: Allowed::TYPES_NONE, short: 'h'){@option_help = true}
+        @context.options.declare(:bash_comp, 'Generate bash completion for command', allowed: Allowed::TYPES_NONE){@bash_completion = true}
+        @context.options.declare(:show_config, 'Display parameters used for the provided action', allowed: Allowed::TYPES_NONE){@option_show_config = true}
+        @context.options.declare(:version, 'Display version', allowed: Allowed::TYPES_NONE, short: 'v'){@context.formatter.display_message(:data, Cli::VERSION); Process.exit(0)} # rubocop:disable Style/Semicolon
         @context.options.declare(
           :ui, 'Method to start browser',
-          values: USER_INTERFACES,
+          allowed: USER_INTERFACES,
           handler: {o: Environment.instance, m: :url_method}
         )
         @context.options.declare(
           :invalid_characters, 'Replacement character and invalid filename characters',
           handler: {o: Environment.instance, m: :file_illegal_characters}
         )
-        @context.options.declare(:log_level, 'Log level', values: Log::LEVELS, handler: {o: Log.instance, m: :level})
-        @context.options.declare(:log_format, 'Log formatter', types: [Proc, Logger::Formatter, String], handler: {o: Log.instance, m: :formatter})
-        @context.options.declare(:logger, 'Logging method', values: Log::LOG_TYPES, handler: {o: Log.instance, m: :logger_type})
-        @context.options.declare(:lock_port, 'Prevent dual execution of a command, e.g. in cron', coerce: Integer, types: Integer)
-        @context.options.declare(:once_only, 'Process only new items (some commands)', values: :bool, default: false)
-        @context.options.declare(:log_secrets, 'Show passwords in logs', values: :bool, handler: {o: SecretHider.instance, m: :log_secrets})
-        @context.options.declare(:clean_temp, 'Cleanup temporary files on exit', values: :bool, handler: {o: TempFileManager.instance, m: :cleanup_on_exit})
-        @context.options.declare(:pid_file, 'Write process identifier to file, delete on exit', types: String)
-        # parse declared options
+        @context.options.declare(:log_level, 'Log level', allowed: Log::LEVELS, handler: {o: Log.instance, m: :level})
+        @context.options.declare(:log_format, 'Log formatter', allowed: [Proc, Logger::Formatter, String], handler: {o: Log.instance, m: :formatter})
+        @context.options.declare(:logger, 'Logging method', allowed: Log::LOG_TYPES, handler: {o: Log.instance, m: :logger_type})
+        @context.options.declare(:lock_port, 'Prevent dual execution of a command, e.g. in cron', allowed: Allowed::TYPES_INTEGER)
+        @context.options.declare(:once_only, 'Process only new items (some commands)', allowed: Allowed::TYPES_BOOLEAN, default: false)
+        @context.options.declare(:log_secrets, 'Show passwords in logs', allowed: Allowed::TYPES_BOOLEAN, handler: {o: SecretHider.instance, m: :log_secrets})
+        @context.options.declare(:clean_temp, 'Cleanup temporary files on exit', allowed: Allowed::TYPES_BOOLEAN, handler: {o: TempFileManager.instance, m: :cleanup_on_exit})
+        @context.options.declare(:temp_folder, 'Temporary folder', handler: {o: TempFileManager.instance, m: :global_temp})
+        @context.options.declare(:pid_file, 'Write process identifier to file, delete on exit')
+        @context.options.declare(
+          :parser, 'Default parser for structured parameters and options',
+          handler: {o: ExtendedValue.instance, m: :default_decoder},
+          allowed: ExtendedValue::DEFAULT_DECODERS,
+          default: ExtendedValue::DEFAULT_DECODERS.first
+        )
+        # Parse declared options
         @context.options.parse_options!
       end
 
       # @return the plugin instance, based on name
-      # also loads the plugin options, and default values from conf file
+      # Also loads the plugin options, and default values from conf file
       # @param plugin_name_sym : symbol for plugin name
       def get_plugin_instance_with_options(plugin_name_sym)
         Log.log.debug{"get_plugin_instance_with_options(#{plugin_name_sym})"}
-        # load default params only if no param already loaded before plugin instantiation
+        # Load default params only if no param already loaded before plugin instantiation
         @context.config.add_plugin_default_preset(plugin_name_sym)
-        command_plugin = PluginFactory.instance.create(plugin_name_sym, context: @context)
+        command_plugin = Plugins::Factory.instance.create(plugin_name_sym, context: @context)
         return command_plugin
       end
 
       def generate_bash_completion
         if @context.options.get_next_argument('', multiple: true, mandatory: false).nil?
-          PluginFactory.instance.plugin_list.each{ |p| puts p}
+          Plugins::Factory.instance.plugin_list.each{ |p| puts p}
         else
           Log.log.warn('only first level completion so far')
         end