aspera-cli 4.0.0 → 4.2.2

data/lib/aspera/cli/main.rb

@@ -10,6 +10,7 @@ require 'aspera/persistency_folder'
 require 'aspera/log'
 require 'aspera/rest'
 require 'aspera/nagios'
+require 'aspera/secrets'
 
 module Aspera
   module Cli
@@ -20,15 +21,17 @@ module Aspera
       private
       # name of application, also foldername where config is stored
       PROGRAM_NAME = 'ascli'
+      # name of the containing gem, same as in <gem name>.gemspec
       GEM_NAME = 'aspera-cli'
-      VERBOSE_LEVELS=[:normal,:minimal,:quiet]
-
-      private_constant :PROGRAM_NAME,:GEM_NAME,:VERBOSE_LEVELS
+      HELP_URL = "http://www.rubydoc.info/gems/#{GEM_NAME}"
+      GEM_URL  = "https://rubygems.org/gems/#{GEM_NAME}"
+      SRC_URL  = "https://github.com/IBM/aspera-cli"
+      STATUS_FIELD = 'status'
 
+      private_constant :PROGRAM_NAME,:GEM_NAME,:HELP_URL,:GEM_URL
       # =============================================================
       # Parameter handlers
       #
-
       def option_insecure; Rest.insecure ; end
 
       def option_insecure=(value); Rest.insecure = value; end
@@ -39,32 +42,41 @@ module Aspera
 
       # minimum initialization
       def initialize(argv)
-        # first thing : manage debug level (allows debugging or option parser)
+        # first thing : manage debug level (allows debugging of option parser)
         early_debug_setup(argv)
+        # compare $0 with expected name
         current_prog_name=File.basename($PROGRAM_NAME)
         unless current_prog_name.eql?(PROGRAM_NAME)
           @plugin_env[:formater].display_message(:error,"#{"WARNING".bg_red.blink.gray} Please use '#{PROGRAM_NAME}' instead of '#{current_prog_name}', '#{current_prog_name}' will be removed in a future version")
         end
-        # overriding parameters on transfer spec
         @option_help=false
         @bash_completion=false
         @option_show_config=false
+        # environment provided to plugin for various capabilities
         @plugin_env={}
-        @help_url='http://www.rubydoc.info/gems/'+GEM_NAME
-        @gem_url='https://rubygems.org/gems/'+GEM_NAME
+        # find out application main folder
+        app_main_folder=ENV[conf_dir_env_var]
+        # if env var undefined or empty
+        if app_main_folder.nil? or app_main_folder.empty?
+          user_home_folder=Dir.home
+          raise CliError,"Home folder does not exist: #{user_home_folder}. Check your user environment or use #{conf_dir_env_var}." unless Dir.exist?(user_home_folder)
+          app_main_folder=File.join(user_home_folder,Plugins::Config::ASPERA_HOME_FOLDER_NAME,PROGRAM_NAME)
+        end
         # give command line arguments to option manager (no parsing)
-        @plugin_env[:options]=@opt_mgr=Manager.new(self.program_name,argv,app_banner())
+        @plugin_env[:options]=@opt_mgr=Manager.new(PROGRAM_NAME,argv,app_banner())
         @plugin_env[:formater]=Formater.new(@plugin_env[:options])
-        Rest.user_agent=self.program_name
-        # must override help methods before parser called (in other constructors)
+        Rest.user_agent=PROGRAM_NAME
+        # declare and parse global options
         init_global_options()
+        # secret manager
+        @plugin_env[:secret]=Aspera::Secrets.new
         # the Config plugin adds the @preset parser
-        @plugin_env[:config]=Plugins::Config.new(@plugin_env,self.program_name,@help_url,Aspera::Cli::VERSION)
+        @plugin_env[:config]=Plugins::Config.new(@plugin_env,PROGRAM_NAME,HELP_URL,Aspera::Cli::VERSION,app_main_folder)
         # the TransferAgent plugin may use the @preset parser
         @plugin_env[:transfer]=TransferAgent.new(@plugin_env)
-        Log.log.debug('created plugin env'.red)
         # set application folder for modules
         @plugin_env[:persistency]=PersistencyFolder.new(File.join(@plugin_env[:config].main_folder,'persist_store'))
+        Log.log.debug('plugin env created'.red)
         Oauth.persist_mgr=@plugin_env[:persistency]
         Fasp::Parameters.file_list_folder=File.join(@plugin_env[:config].main_folder,'filelists')
         Aspera::RestErrorAnalyzer.instance.log_file=File.join(@plugin_env[:config].main_folder,'rest_exceptions.log')
@@ -73,21 +85,21 @@ module Aspera
       end
 
       def app_banner
-        banner = "NAME\n\t#{self.program_name} -- a command line tool for Aspera Applications (v#{Aspera::Cli::VERSION})\n\n"
+        banner = "NAME\n\t#{PROGRAM_NAME} -- a command line tool for Aspera Applications (v#{Aspera::Cli::VERSION})\n\n"
         banner << "SYNOPSIS\n"
-        banner << "\t#{self.program_name} COMMANDS [OPTIONS] [ARGS]\n"
-        banner << "\n"
-        banner << "DESCRIPTION\n"
+        banner << "\t#{PROGRAM_NAME} COMMANDS [OPTIONS] [ARGS]\n"
+        banner << "\nDESCRIPTION\n"
         banner << "\tUse Aspera application to perform operations on command line.\n"
-        banner << "\tDocumentation and examples: #{@gem_url}\n"
-        banner << "\texecute: #{self.program_name} conf doc\n"
-        banner << "\tor visit: #{@help_url}\n"
-        banner << "\n"
-        banner << "COMMANDS\n"
-        banner << "\tTo list first level commands, execute: #{self.program_name}\n"
+        banner << "\tDocumentation and examples: #{GEM_URL}\n"
+        banner << "\texecute: #{PROGRAM_NAME} conf doc\n"
+        banner << "\tor visit: #{HELP_URL}\n"
+        banner << "\nENVIRONMENT VARIABLES\n"
+        banner << "\t#{conf_dir_env_var}  config folder, default: $HOME/#{Plugins::Config::ASPERA_HOME_FOLDER_NAME}/#{PROGRAM_NAME}\n"
+        banner << "\t#any option can be set as an environment variable, refer to the manual\n"
+        banner << "\nCOMMANDS\n"
+        banner << "\tTo list first level commands, execute: #{PROGRAM_NAME}\n"
         banner << "\tNote that commands can be written shortened (provided it is unique).\n"
-        banner << "\n"
-        banner << "OPTIONS\n"
+        banner << "\nOPTIONS\n"
         banner << "\tOptions begin with a '-' (minus), and value is provided on command line.\n"
         banner << "\tSpecial values are supported beginning with special prefix, like: #{ExtendedValue.instance.modifiers.map{|m|"@#{m}:"}.join(' ')}.\n"
         banner << "\tDates format is 'DD-MM-YY HH:MM:SS', or 'now' or '-<num>h'\n\n"
@@ -167,7 +179,7 @@ module Aspera
             # override main option parser with a brand new, to avoid having global options
             plugin_env=@plugin_env.clone
             plugin_env[:man_only]=true
-            plugin_env[:options]=Manager.new(self.program_name,[],'')
+            plugin_env[:options]=Manager.new(PROGRAM_NAME,[],'')
             get_plugin_instance_with_options(plugin_name_sym,plugin_env)
             # display generated help for plugin options
             @plugin_env[:formater].display_message(:error,plugin_env[:options].parser.to_s)
@@ -178,10 +190,16 @@ module Aspera
 
       protected
 
+      # env var name to override the app's main folder
+      # default main folder is $HOME/<vendor main app folder>/<program name>
+      def conf_dir_env_var
+        return "#{PROGRAM_NAME}_home".upcase
+      end
+
       # early debug for parser
       # Note: does not accept shortcuts
       def early_debug_setup(argv)
-        Log.instance.program_name=self.program_name
+        Log.instance.program_name=PROGRAM_NAME
         argv.each do |arg|
           case arg
           when '--'
@@ -205,14 +223,28 @@ module Aspera
         return Main.result_nothing
       end
 
-      def options;@opt_mgr;end
-
-      def program_name;PROGRAM_NAME;end
+      # used when one command executes several transfer jobs (each job being possibly multi session)
+      # @param status_table [Array] [{STATUS_FIELD=>[status array],...},...]
+      # each element has a key STATUS_FIELD which contains the result of possibly mulmtiple sessions
+      def self.result_transfer_multiple(status_table)
+        global_status=:success
+        # transform status 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)
+          item[STATUS_FIELD]=item[STATUS_FIELD].map{|i|i.to_s}.join(',')
+        end
+        raise global_status unless global_status.eql?(:success)
+        return {:type=>:object_list,:data=>status_table}
+      end
 
       # this is the main function called by initial script just after constructor
       def process_command_line
         Log.log.debug('process_command_line')
+        # catch exception information , if any
         exception_info=nil
+        # false if command shall not be executed ("once_only")
+        execute_command=true
         begin
           # find plugins, shall be after parse! ?
           @plugin_env[:config].add_plugins_from_lookup_folders
@@ -222,16 +254,7 @@ module Aspera
           # load global default options and process
           @plugin_env[:config].add_plugin_default_preset(Plugins::Config::CONF_GLOBAL_SYM)
           @opt_mgr.parse_options!
-          # dual execution locking
-          lock_port=@opt_mgr.get_option(:lock_port,:optional)
-          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
-              @tcp_server=TCPServer.new('127.0.0.1',lock_port.to_i)
-            rescue => e
-              raise CliError,"Another instance is already running (lock port=#{lock_port})."
-            end
-          end
+          @plugin_env[:config].periodic_check_newer_gem_version
           if @option_show_config and @opt_mgr.command_or_arg_empty?
             command_sym=Plugins::Config::CONF_PLUGIN_SYM
           else
@@ -255,18 +278,30 @@ module Aspera
             @plugin_env[:formater].display_results({:type=>:single_object,:data=>@opt_mgr.declared_options(false)})
             Process.exit(0)
           end
-          # execute and display
-          @plugin_env[:formater].display_results(command_plugin.execute_action)
+          # locking for single execution (only after "per plugin" option, in case lock port is there)
+          lock_port=@opt_mgr.get_option(:lock_port,:optional)
+          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
+              Log.log.debug("Opening lock port #{lock_port.to_i}")
+              @tcp_server=TCPServer.new('127.0.0.1',lock_port.to_i)
+            rescue => e
+              execute_command=false
+              Log.log.warn("Another instance is already running (#{e.message}).")
+            end
+          end
+          # execute and display (if not exclusive execution)
+          @plugin_env[:formater].display_results(command_plugin.execute_action) if execute_command
           # finish
           @plugin_env[:transfer].shutdown
         rescue CliBadArgument => e;          exception_info=[e,'Argument',:usage]
         rescue CliNoSuchId => e;             exception_info=[e,'Identifier']
         rescue CliError => e;                exception_info=[e,'Tool',:usage]
-        rescue Fasp::Error => e;             exception_info=[e,"FASP(ascp]"]
-        rescue Aspera::RestCallError => e; exception_info=[e,"Rest"]
-        rescue SocketError => e;             exception_info=[e,"Network"]
-        rescue StandardError => e;           exception_info=[e,"Other",:debug]
-        rescue Interrupt => e;               exception_info=[e,"Interruption",:debug]
+        rescue Fasp::Error => e;             exception_info=[e,'FASP(ascp)']
+        rescue Aspera::RestCallError => e;   exception_info=[e,'Rest']
+        rescue SocketError => e;             exception_info=[e,'Network']
+        rescue StandardError => e;           exception_info=[e,'Other',:debug]
+        rescue Interrupt => e;               exception_info=[e,'Interruption',:debug]
         end
         # cleanup file list files
         TempFileManager.instance.cleanup
@@ -274,10 +309,15 @@ module Aspera
         unless exception_info.nil?
           @plugin_env[:formater].display_message(:error,"ERROR:".bg_red.gray.blink+" "+exception_info[1]+": "+exception_info[0].message)
           @plugin_env[:formater].display_message(:error,"Use '-h' option to get help.") if exception_info[2].eql?(:usage)
+          if exception_info.first.is_a?(Fasp::Error) and exception_info.first.message.eql?('Remote host is not who we expected')
+            @plugin_env[:formater].display_message(:error,"For this specific error, refer to:\n#{SRC_URL}#error-remote-host-is-not-who-we-expected\nAdd this to arguments:\n--ts=@json:'{\"sshfp\":null}'")
+          end
         end
         # 2- processing of command not processed (due to exception or bad command line)
-        @opt_mgr.final_errors.each do |msg|
-          @plugin_env[:formater].display_message(:error,"ERROR:".bg_red.gray.blink+" Argument: "+msg)
+        if execute_command
+          @opt_mgr.final_errors.each do |msg|
+            @plugin_env[:formater].display_message(:error,"ERROR:".bg_red.gray.blink+" Argument: "+msg)
+          end
         end
         # 3- in case of error, fail the process status
         unless exception_info.nil?

data/lib/aspera/cli/plugin.rb

@@ -67,7 +67,10 @@ module Aspera
         when :delete
           rest_api.delete(one_res_path)
           return Main.result_status("deleted")
+        else
+          raise "unknown action: #{command}"
         end
+        raise "internal error should not reach here"
       end
 
       # implement generic rest operations on given resource path
@@ -77,13 +80,15 @@ module Aspera
         return entity_command(command,rest_api,res_class_path,display_fields,id_symb,id_default,subkey)
       end
 
-      def options;@agents[:options];end
+      def options; return @agents[:options];end
 
-      def transfer;@agents[:transfer];end
+      def transfer; return @agents[:transfer];end
 
-      def config;return @agents[:config];end
+      def config; return @agents[:config];end
 
-      def format;return @agents[:formater];end
+      def format; return @agents[:formater];end
+
+      def persistency; return @agents[:persistency];end
 
     end # Plugin
   end # Cli

data/lib/aspera/cli/plugins/alee.rb

@@ -12,7 +12,7 @@ module Aspera
           command=self.options.get_next_command(ACTIONS)
           case command
           when :entitlement
-            entitlement_id = self.options.get_option(:username,:mandatory),
+            entitlement_id = self.options.get_option(:username,:mandatory)
             customer_id = self.options.get_option(:password,:mandatory)
             api_metering=AoC.metering_api(entitlement_id,customer_id)
             return {:type=>:single_object, :data=>api_metering.read('entitlement')[:data]}