choria-mcorpc-support 2.20.3 → 2.20.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d62fe592f222f86ab9be58dba46bf2e328558806
-  data.tar.gz: f18f3623e930fd5d71e5241dff3c8b80d261aa89
+  metadata.gz: a3f6b0f73405083156308dae503d0498332bc81c
+  data.tar.gz: 7c780d21ec775ddbc5b17640682be709a343c94b
 SHA512:
-  metadata.gz: '081312bf41443aaf3e70ad790bd294309d96d02d9e8aeb509fc52d81add8d92ab8509b4e695518479cf48937ba650d2e14679c7f6dd4985555e9e9f691f4db24'
-  data.tar.gz: cd63595156866613e99116174cc879e57ac47159f91aa23f422a386fb986cafdb5c2f33312e63f068b60db3904b59d29b459e169c0e8ce1fc97f385b699d8a59
+  metadata.gz: 70b7fb634326c07bf3940692641a4e66b734d2388647186d25080025f019c66ad39b07f4b7d60b90e6a8da7171f6f6dbfbb7f5f79aced3e146149f5cc94828be
+  data.tar.gz: de2c15f4c16831773119ce0c167d3a17f9b55aa9f3546e0a90b017353879b74b198fd50b65839f251d387c93f3247faf81941bd54c7de4c85958953038da8b8c

data/lib/mcollective.rb

@@ -1,20 +1,20 @@
-require 'rubygems'
-require 'json'
-require 'timeout'
-require 'digest/md5'
-require 'optparse'
-require 'singleton'
-require 'socket'
-require 'erb'
-require 'shellwords'
-require 'stringio'
-require 'rbconfig'
-require 'tempfile'
-require 'tmpdir'
-require 'mcollective/monkey_patches'
-require 'mcollective/cache'
-require 'mcollective/exceptions'
-require 'systemu'
+require "rubygems"
+require "json"
+require "timeout"
+require "digest/md5"
+require "optparse"
+require "singleton"
+require "socket"
+require "erb"
+require "shellwords"
+require "stringio"
+require "rbconfig"
+require "tempfile"
+require "tmpdir"
+require "mcollective/monkey_patches"
+require "mcollective/cache"
+require "mcollective/exceptions"
+require "systemu"
 
 # == The Marionette Collective
 #
@@ -26,7 +26,6 @@ require 'systemu'
 # For an overview of the idea behind this and what it enables please see:
 #   http://www.devco.net/archives/2009/10/18/middleware_for_systems_administration.php
 module MCollective
-
   require "mcollective/agent"
   require "mcollective/agents"
   require "mcollective/aggregate"
@@ -55,7 +54,7 @@ module MCollective
   require "mcollective/util"
   require "mcollective/validator"
 
-  VERSION="2.20.3"
+  VERSION = "2.20.4".freeze
 
   def self.version
     VERSION

data/lib/mcollective/agent.rb

@@ -1,5 +1,4 @@
 module MCollective
   module Agent
-
   end
 end

data/lib/mcollective/agents.rb

@@ -2,11 +2,11 @@ module MCollective
   # A collection of agents, loads them, reloads them and dispatches messages to them.
   # It uses the PluginManager to store, load and manage instances of plugins.
   class Agents
-    def initialize(agents = {})
+    def initialize(agents={})
       @config = Config.instance
-      raise ("Configuration has not been loaded, can't load agents") unless @config.configured
+      raise "Configuration has not been loaded, can't load agents" unless @config.configured
 
-      @@agents = agents
+      @@agents = agents # rubocop:disable Style/ClassVars
 
       loadagents
     end
@@ -18,7 +18,7 @@ module MCollective
         Util.unsubscribe(Util.make_subscriptions(agent, :broadcast))
       end
 
-      @@agents = {}
+      @@agents = {} # rubocop:disable Style/ClassVars
     end
 
     # Loads all agents from disk
@@ -67,9 +67,10 @@ module MCollective
           Log.debug("Not activating agent #{agentname} due to agent policy in activate? method")
           return false
         end
-      rescue Exception => e
-        Log.error("Loading agent #{agentname} failed: #{e}")
-        PluginManager.delete("#{agentname}_agent")
+      rescue Exception # rubocop:disable Lint/RescueException
+        Log.error("Loading agent %s failed: %s" % [agentname, $!])
+        PluginManager.delete("%s_agent" % agentname)
+
         return false
       end
     end
@@ -91,8 +92,8 @@ module MCollective
         Log.debug("#{klass} does not have an activate? method, activating as default")
         return true
       end
-    rescue Exception => e
-      Log.warn("Agent activation check for #{agent} failed: #{e.class}: #{e}")
+    rescue Exception # rubocop:disable Lint/RescueException
+      Log.warn("Agent activation check for %s #{agent} failed: %s: %s" % [agent, $!.class, $!])
       return false
     end
 
@@ -105,7 +106,7 @@ module MCollective
           return agentfile
         end
       end
-      return false
+      false
     end
 
     # Determines if we have an agent with a certain name
@@ -122,20 +123,18 @@ module MCollective
         begin
           agent = PluginManager["#{request.agent}_agent"]
 
-          Timeout::timeout(agent.timeout) do
+          Timeout.timeout(agent.timeout) do
             replies = agent.handlemsg(request.payload, connection)
 
             # Agents can decide if they wish to reply or not,
             # returning nil will mean nothing goes back to the
             # requestor
-            unless replies == nil
-              yield(replies)
-            end
+            yield(replies) unless replies.nil?
           end
-        rescue Timeout::Error => e
-          Log.warn("Timeout while handling message for #{request.agent}")
-        rescue Exception => e
-          Log.error("Execution of #{request.agent} failed: #{e}")
+        rescue Timeout::Error
+          Log.warn("Timeout while handling message for %s" % request.agent)
+        rescue Exception # rubocop:disable Lint/RescueException
+          Log.error("Execution of %s failed: %s" % [request.agent, $!])
           Log.error(e.backtrace.join("\n\t\t"))
         end
       end

data/lib/mcollective/aggregate.rb

@@ -1,7 +1,7 @@
 module MCollective
   class Aggregate
-    require 'mcollective/aggregate/result'
-    require 'mcollective/aggregate/base'
+    require "mcollective/aggregate/result"
+    require "mcollective/aggregate/base"
 
     attr_accessor :ddl, :functions, :action, :failed
 
@@ -17,7 +17,7 @@ module MCollective
     # Creates instances of the Aggregate functions and stores them in the function array.
     # All aggregate call and summarize method calls operate on these function as a batch.
     def create_functions
-      @ddl[:aggregate].each_with_index do |agg, i|
+      @ddl[:aggregate].each_with_index do |agg, _i|
         output = agg[:args][0]
 
         if contains_output?(output)
@@ -26,11 +26,11 @@ module MCollective
           begin
             @functions << load_function(agg[:function]).new(output, arguments, format, @action)
           rescue Exception => e
-            Log.error("Cannot create aggregate function '#{output}'. #{e.to_s}")
+            Log.error("Cannot create aggregate function '%s': %s" % [output, e])
             @failed << {:name => output, :type => :startup}
           end
         else
-          Log.error("Cannot create aggregate function '#{output}'. '#{output}' has not been specified as a valid ddl output.")
+          Log.error("Cannot create aggregate function '%s'. '%s' has not been specified as a valid ddl output." % [output, output])
           @failed << {:name => output, :type => :create}
         end
       end
@@ -44,11 +44,11 @@ module MCollective
     # Call all the appropriate functions with the reply data received from RPC::Client
     def call_functions(reply)
       @functions.each do |function|
-        Log.debug("Calling aggregate function #{function} for result")
+        Log.debug("Calling aggregate function %s for result" % function)
         begin
           function.process_result(reply[:data][function.output_name], reply)
         rescue Exception => e
-          Log.error("Could not process aggregate function for '#{function.output_name}'. #{e.to_s}")
+          Log.error("Could not process aggregate function for '%s': %s" % [function.output_name, e])
           @failed << {:name => function.output_name, :type => :process_result}
           @functions.delete(function)
         end
@@ -61,13 +61,13 @@ module MCollective
         begin
           function.summarize
         rescue Exception => e
-          Log.error("Could not summarize aggregate result for '#{function.output_name}'. #{e.to_s}")
+          Log.error("Could not summarize aggregate result for '%s': %s" % [function.output_name, e])
           @failed << {:name => function.output_name, :type => :summarize}
           nil
         end
       end
 
-      summary.reject{|x| x.nil?}.sort do |x,y|
+      summary.reject(&:nil?).sort do |x, y|
         x.result[:output] <=> y.result[:output]
       end
     end
@@ -76,10 +76,10 @@ module MCollective
     def load_function(function_name)
       function_name = function_name.to_s.capitalize
 
-      PluginManager.loadclass("MCollective::Aggregate::#{function_name}") unless Aggregate.const_defined?(function_name)
+      PluginManager.loadclass("MCollective::Aggregate::%s" % function_name) unless Aggregate.const_defined?(function_name)
       Aggregate.const_get(function_name)
     rescue Exception
-      raise "Aggregate function file '#{function_name.downcase}.rb' cannot be loaded"
+      raise("Aggregate function file '%s.rb' cannot be loaded" % function_name.downcase)
     end
   end
 end

data/lib/mcollective/application.rb

@@ -1,4 +1,4 @@
-require 'mcollective/rpc'
+require "mcollective/rpc"
 
 module MCollective
   class Application
@@ -70,9 +70,9 @@ module MCollective
                :arguments => [],
                :type => String,
                :required => false,
-               :validate => Proc.new { true }}
+               :validate => proc { true }}
 
-        arguments.each_pair{|k,v| opt[k] = v}
+        arguments.each_pair {|k, v| opt[k] = v}
 
         self[:cli_arguments] << opt
       end
@@ -93,9 +93,7 @@ module MCollective
     end
 
     # The active options hash used for MC::Client and other configuration
-    def options
-      @options
-    end
+    attr_reader :options
 
     # Calls the supplied block in an option for validation, an error raised
     # will log to STDERR and exit the application
@@ -113,12 +111,10 @@ module MCollective
     def clioptions(help)
       oparser = Optionparser.new({:verbose => false, :progress_bar => true}, "filter", application_options[:exclude_arg_sections])
 
-      options = oparser.parse do |parser, options|
-        if block_given?
-          yield(parser, options)
-        end
+      options = oparser.parse do |parser, opts|
+        yield(parser, opts) if block_given?
 
-        RPC::Helpers.add_simplerpc_options(parser, options) unless application_options[:exclude_arg_sections].include?("rpc")
+        RPC::Helpers.add_simplerpc_options(parser, opts) unless application_options[:exclude_arg_sections].include?("rpc")
       end
 
       return oparser.parser.help if help
@@ -128,8 +124,8 @@ module MCollective
       post_option_parser(configuration) if respond_to?(:post_option_parser)
 
       return options
-    rescue Exception => e
-      application_failure(e)
+    rescue Exception # rubocop:disable Lint/RescueException
+      application_failure($!)
     end
 
     # Builds an ObjectParser config, parse the CLI options and validates based
@@ -137,7 +133,7 @@ module MCollective
     def application_parse_options(help=false)
       @options ||= {:verbose => false}
 
-      @options = clioptions(help) do |parser, options|
+      @options = clioptions(help) do |parser, _options|
         parser.define_head application_description if application_description
         parser.banner = ""
 
@@ -156,16 +152,13 @@ module MCollective
         parser.define_tail ""
         parser.define_tail "The Marionette Collective #{MCollective.version}"
 
-
         application_cli_arguments.each do |carg|
           opts_array = []
 
           opts_array << :on
 
           # if a default is set from the application set it up front
-          if carg.include?(:default)
-            configuration[carg[:name]] = carg[:default]
-          end
+          configuration[carg[:name]] = carg[:default] if carg.include?(:default)
 
           # :arguments are multiple possible ones
           if carg[:arguments].is_a?(Array)
@@ -211,11 +204,10 @@ module MCollective
       validation_passed = true
       application_cli_arguments.each do |carg|
         # Check for required arguments
-        if carg[:required]
-          unless configuration[ carg[:name] ]
-            validation_passed = false
-            STDERR.puts "The #{carg[:name]} option is mandatory"
-          end
+        next unless carg[:required]
+        unless configuration[carg[:name]]
+          validation_passed = false
+          STDERR.puts "The #{carg[:name]} option is mandatory"
         end
       end
 
@@ -223,8 +215,6 @@ module MCollective
         STDERR.puts "\nPlease run with --help for detailed help"
         exit 1
       end
-
-
     end
 
     # Retrieves the full hash of application options
@@ -260,15 +250,15 @@ module MCollective
       end
 
       if options[:verbose]
-        err_dest.puts "\nThe %s application failed to run: %s\n" % [ Util.colorize(:bold, $0), Util.colorize(:red, e.to_s)]
+        err_dest.puts "\nThe %s application failed to run: %s\n" % [Util.colorize(:bold, $0), Util.colorize(:red, e.to_s)]
       else
-        err_dest.puts "\nThe %s application failed to run, use -v for full error backtrace details: %s\n" % [ Util.colorize(:bold, $0), Util.colorize(:red, e.to_s)]
+        err_dest.puts "\nThe %s application failed to run, use -v for full error backtrace details: %s\n" % [Util.colorize(:bold, $0), Util.colorize(:red, e.to_s)]
       end
 
       if options.nil? || options[:verbose]
         e.backtrace.first << Util.colorize(:red, "  <----")
-        err_dest.puts "\n%s %s" % [ Util.colorize(:red, e.to_s), Util.colorize(:bold, "(#{e.class.to_s})")]
-        e.backtrace.each{|l| err_dest.puts "\tfrom #{l}"}
+        err_dest.puts "\n%s %s" % [Util.colorize(:red, e.to_s), Util.colorize(:bold, "(#{e.class})")]
+        e.backtrace.each {|l| err_dest.puts "\tfrom #{l}"}
       end
 
       disconnect
@@ -293,14 +283,13 @@ module MCollective
       main
 
       disconnect
-
-    rescue Exception => e
-      application_failure(e)
+    rescue Exception # rubocop:disable Lint/RescueException
+      application_failure($!)
     end
 
     def disconnect
       MCollective::PluginManager["connector_plugin"].disconnect
-    rescue
+    rescue # rubocop:disable Lint/HandleExceptions
     end
 
     # Fake abstract class that logs if the user tries to use an application without
@@ -316,27 +305,27 @@ module MCollective
                        :okcount => 0,
                        :failcount => 0}.merge(stats.to_hash)
 
-      if (request_stats[:discoverytime] == 0 && request_stats[:responses] == 0)
+      if request_stats[:discoverytime] == 0 && request_stats[:responses] == 0
         return 4
       end
 
-      if (request_stats[:discovered] > 0)
-        if (request_stats[:responses] == 0)
+      if request_stats[:discovered] > 0
+        if request_stats[:responses] == 0
           return 3
-        elsif (request_stats[:failcount] > 0)
+        elsif request_stats[:failcount] > 0
           return 2
         end
       end
 
-      if (request_stats[:discovered] == 0)
-        if (request_stats[:responses] && request_stats[:responses] > 0)
+      if request_stats[:discovered] == 0
+        if request_stats[:responses] && request_stats[:responses] > 0
           return 0
         else
           return 1
         end
       end
 
-      return 0
+      0
     end
 
     # A helper that creates a consistent exit code for applications by looking at an
@@ -355,7 +344,7 @@ module MCollective
     # Wrapper around MC::RPC#rpcclient that forcably supplies our options hash
     # if someone forgets to pass in options in an application the filters and other
     # cli options wouldnt take effect which could have a disasterous outcome
-    def rpcclient(agent, flags = {})
+    def rpcclient(agent, flags={})
       flags[:options] = options unless flags.include?(:options)
       flags[:exit_on_failure] = false
 

data/lib/mcollective/applications.rb

@@ -10,17 +10,17 @@ module MCollective
 
       begin
         load_application(appname)
-      rescue Exception => e
+      rescue Exception # rubocop:disable Lint/RescueException
         e.backtrace.first << Util.colorize(:red, "  <----")
-        STDERR.puts "Application '#{appname}' failed to load:"
+        STDERR.puts "Application '%s' failed to load:" % appname
         STDERR.puts
-        STDERR.puts Util.colorize(:red, "   #{e} (#{e.class})")
+        STDERR.puts Util.colorize(:red, "   %s (%s)" % [$!, $!.class])
         STDERR.puts
-        STDERR.puts "       %s" % [e.backtrace.join("\n       ")]
+        STDERR.puts "       %s" % [$!.backtrace.join("\n       ")]
         exit 1
       end
 
-      PluginManager["#{appname}_application"].run
+      PluginManager["%s_application" % appname].run
     end
 
     def self.load_application(appname)
@@ -39,17 +39,16 @@ module MCollective
       PluginManager.find("application")
     rescue SystemExit
       exit 1
-    rescue Exception => e
-      STDERR.puts "Failed to generate application list: #{e.class}: #{e}"
+    rescue Exception # rubocop:disable Lint/RescueException
+      STDERR.puts("Failed to generate application list: %s: %s" % [$!.class, $!])
       exit 1
     end
 
     # Filters a string of opts out using Shellwords
     # keeping only things related to --config and -c
     def self.filter_extra_options(opts)
-      res = ""
       words = Shellwords.shellwords(opts)
-      words.each_with_index do |word,idx|
+      words.each_with_index do |word, idx|
         if word == "-c"
           return "--config=#{words[idx + 1]}"
         elsif word == "--config"
@@ -61,7 +60,7 @@ module MCollective
         end
       end
 
-      return ""
+      ""
     end
 
     # We need to know the config file in order to know the libdir
@@ -110,8 +109,8 @@ module MCollective
           # am done with it
           ENV["MCOLLECTIVE_EXTRA_OPTS"] = filter_extra_options(ENV["MCOLLECTIVE_EXTRA_OPTS"].clone)
           parser.environment("MCOLLECTIVE_EXTRA_OPTS")
-        rescue Exception => e
-          Log.error("Failed to parse MCOLLECTIVE_EXTRA_OPTS: #{e}")
+        rescue Exception # rubocop:disable Lint/RescueException
+          Log.error("Failed to parse MCOLLECTIVE_EXTRA_OPTS: %s" % $!)
         end
 
         ENV["MCOLLECTIVE_EXTRA_OPTS"] = original_extra_opts.clone
@@ -119,14 +118,14 @@ module MCollective
 
       begin
         parser.parse!
-      rescue OptionParser::InvalidOption => e
+      rescue OptionParser::InvalidOption
         retry
       end
 
       ARGV.clear
       original_argv.each {|a| ARGV << a}
 
-      configfile = Util.config_file_for_user unless configfile
+      configfile ||= Util.config_file_for_user
 
       Config.instance.loadconfig(configfile)
     end