choria-mcorpc-support 2.21.1 → 2.23.1

data/lib/mcollective/facts/yaml_facts.rb

@@ -1,13 +1,13 @@
 module MCollective
   module Facts
-    require 'yaml'
+    require "yaml"
 
     # A factsource that reads a hash of facts from a YAML file
     #
     # Multiple files can be specified seperated with a : in the
     # config file, they will be merged with later files overriding
     # earlier ones in the list.
-    class Yaml_facts<Base
+    class Yaml_facts < Base
       def initialize
         @yaml_file_mtimes = {}
 
@@ -23,15 +23,15 @@ module MCollective
         fact_files.each do |file|
           begin
             if File.exist?(file)
-	      if YAML.respond_to? :safe_load
-                facts.merge!(YAML.safe_load(File.read(file))) 
-	      else
-                facts.merge!(YAML.load(File.read(file)))  # rubocop:disable Security/YAMLLoad
+              if YAML.respond_to? :safe_load
+                facts.merge!(YAML.safe_load(File.read(file)))
+              else
+                facts.merge!(YAML.load(File.read(file)))
               end
             else
               raise("Can't find YAML file to load: #{file}")
             end
-          rescue Exception => e
+          rescue Exception => e # rubocop:disable Lint/RescueException
             Log.error("Failed to load yaml facts from #{file}: #{e.class}: #{e}")
           end
         end
@@ -49,13 +49,13 @@ module MCollective
           @yaml_file_mtimes[file] ||= File.stat(file).mtime
           mtime = File.stat(file).mtime
 
-          if mtime > @yaml_file_mtimes[file]
-            @yaml_file_mtimes[file] = mtime
+          next unless mtime > @yaml_file_mtimes[file]
 
-            Log.debug("Forcing fact reload due to age of #{file}")
+          @yaml_file_mtimes[file] = mtime
 
-            return true
-          end
+          Log.debug("Forcing fact reload due to age of #{file}")
+
+          return true
         end
 
         false

data/lib/mcollective/generators.rb

@@ -1,7 +1,7 @@
 module MCollective
   module Generators
-    require "mcollective/generators/base.rb"
-    require "mcollective/generators/data_generator.rb"
-    require "mcollective/generators/agent_generator.rb"
+    require "mcollective/generators/base"
+    require "mcollective/generators/data_generator"
+    require "mcollective/generators/agent_generator"
   end
 end

data/lib/mcollective/generators/agent_generator.rb

@@ -1,11 +1,10 @@
 module MCollective
   module Generators
-    class AgentGenerator<Base
-
+    class AgentGenerator < Base
       attr_accessor :ddl, :content
 
-      def initialize(plugin_name, actions = [],  name = nil, description = nil, author = nil ,
-                     license = nil, version = nil, url = nil, timeout = nil)
+      def initialize(plugin_name, actions=[], name=nil, description=nil, author=nil,
+                     license=nil, version=nil, url=nil, timeout=nil)
 
         super(name, description, author, license, version, url, timeout)
         @plugin_name = plugin_name

data/lib/mcollective/generators/base.rb

@@ -2,6 +2,7 @@ module MCollective
   module Generators
     class Base
       attr_accessor :meta, :plugin_name, :mod_name
+
       def initialize(name, description, author, license, version, url, timeout)
         @meta = {:name => name,
                  :description => description,
@@ -23,23 +24,21 @@ module MCollective
       end
 
       def write_plugins
-        begin
-          Dir.mkdir @plugin_name
-          dirname = File.join(@plugin_name, @mod_name.downcase)
-          Dir.mkdir dirname
-          puts "Created plugin directory : #{@plugin_name}"
+        Dir.mkdir @plugin_name
+        dirname = File.join(@plugin_name, @mod_name.downcase)
+        Dir.mkdir dirname
+        puts "Created plugin directory : #{@plugin_name}"
 
-          File.open(File.join(dirname, "#{@plugin_name}.ddl"), "w"){|f| f.puts @ddl}
-          puts "Created DDL file : #{File.join(dirname, "#{@plugin_name}.ddl")}"
+        File.open(File.join(dirname, "#{@plugin_name}.ddl"), "w") {|f| f.puts @ddl}
+        puts "Created DDL file : #{File.join(dirname, "#{@plugin_name}.ddl")}"
 
-          File.open(File.join(dirname, "#{@plugin_name}.rb"), "w"){|f| f.puts @plugin}
-          puts "Created #{@mod_name} file : #{File.join(dirname, "#{@plugin_name}.rb")}"
-        rescue Errno::EEXIST
-          raise "cannot generate '#{@plugin_name}' : plugin directory already exists."
-        rescue Exception => e
-          FileUtils.rm_rf(@plugin_name) if File.directory?(@plugin_name)
-          raise "cannot generate plugin - #{e}"
-        end
+        File.open(File.join(dirname, "#{@plugin_name}.rb"), "w") {|f| f.puts @plugin}
+        puts "Created #{@mod_name} file : #{File.join(dirname, "#{@plugin_name}.rb")}"
+      rescue Errno::EEXIST
+        raise "cannot generate '#{@plugin_name}' : plugin directory already exists."
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        FileUtils.rm_rf(@plugin_name) if File.directory?(@plugin_name)
+        raise "cannot generate plugin - #{e}"
       end
     end
   end

data/lib/mcollective/generators/data_generator.rb

@@ -1,11 +1,10 @@
 module MCollective
   module Generators
-    class DataGenerator<Base
-
+    class DataGenerator < Base
       attr_accessor :ddl, :content
 
-      def initialize(plugin_name, outputs = [],  name = nil, description = nil, author = nil ,
-                     license = nil, version = nil, url = nil, timeout = nil)
+      def initialize(plugin_name, outputs=[], name=nil, description=nil, author=nil,
+                     license=nil, version=nil, url=nil, timeout=nil)
 
         super(name, description, author, license, version, url, timeout)
         @mod_name = "Data"
@@ -22,7 +21,7 @@ module MCollective
         query_text = "dataquery :description => \"Query information\" do\n"
         query_text += ERB.new(File.read(File.join(File.dirname(__FILE__), "templates", "data_input_snippet.erb"))).result
 
-        @outputs.each_with_index do |output,i|
+        @outputs.each_with_index do |output, i|
           query_text += "%2s%s" % [" ", "output :#{output},\n"]
           query_text += "%9s%s" % [" ", ":description => \"%DESCRIPTION%\",\n"]
           query_text += "%9s%s" % [" ", ":display_as => \"%DESCRIPTION%\"\n"]
@@ -39,7 +38,7 @@ module MCollective
         content_text = "%6s%s" % [" ", "query do |what|\n"]
 
         @outputs.each do |output|
-           content_text += "%8s%s" % [" ", "result[:#{output}] = nil\n"]
+          content_text += "%8s%s" % [" ", "result[:#{output}] = nil\n"]
         end
         content_text += "%6s%s" % [" ", "end\n"]
 

data/lib/mcollective/log.rb

@@ -60,7 +60,7 @@ module MCollective
         else
           t = Time.new.strftime("%H:%M:%S")
 
-          STDERR.puts "#{t}: #{level}: #{from}: #{msg}"
+          warn "#{t}: #{level}: #{from}: #{msg}"
         end
       end
 
@@ -98,7 +98,7 @@ module MCollective
         @logger.start
       rescue Exception => e # rubocop:disable Lint/RescueException
         @configured = false
-        STDERR.puts "Could not start logger: #{e.class} #{e}"
+        warn "Could not start logger: #{e.class} #{e}"
       end
 
       # figures out the filename that called us

data/lib/mcollective/logger/base.rb

@@ -29,7 +29,7 @@ module MCollective
       end
 
       # Sets a new level and record it in @active_level
-      def set_level(level)
+      def set_level(level) # rubocop:disable Naming/AccessorMethodName
         set_logging_level(level)
         @active_level = level.to_sym
       end
@@ -47,6 +47,7 @@ module MCollective
       end
 
       private
+
       def map_level(level)
         raise "Logger class do not know how to handle #{level} messages" unless valid_levels.include?(level.to_sym)
 
@@ -54,7 +55,7 @@ module MCollective
       end
 
       # Gets the next level in the list, cycles down to the firt once it reaches the end
-      def get_next_level
+      def get_next_level # rubocop:disable Naming/AccessorMethodName
         # if all else fails, always go to debug mode
         nextlvl = :debug
 

data/lib/mcollective/logger/console_logger.rb

@@ -1,7 +1,7 @@
 module MCollective
   module Logger
     # Implements a syslog based logger using the standard ruby syslog class
-    class Console_logger<Base
+    class Console_logger < Base
       def start
         set_level(:info)
 
@@ -9,19 +9,19 @@ module MCollective
         set_level(config.loglevel.to_sym) if config.configured
       end
 
-      def set_logging_level(level)
+      def set_logging_level(level) # rubocop:disable Naming/AccessorMethodName
         # nothing to do here, we ignore high levels when we log
       end
 
       def valid_levels
-        {:info  => :info,
-         :warn  => :warning,
+        {:info => :info,
+         :warn => :warning,
          :debug => :debug,
          :fatal => :crit,
          :error => :err}
       end
 
-      def log(level, from, msg, normal_output=STDERR, last_resort_output=STDERR)
+      def log(level, from, msg, normal_output=$stderr, last_resort_output=$stderr)
         if @known_levels.index(level) >= @known_levels.index(@active_level)
           time = Time.new.strftime("%Y/%m/%d %H:%M:%S")
 
@@ -41,20 +41,20 @@ module MCollective
 
         colors = {:error => Util.color(:red),
                   :fatal => Util.color(:red),
-                  :warn  => Util.color(:yellow),
-                  :info  => Util.color(:green),
+                  :warn => Util.color(:yellow),
+                  :info => Util.color(:green),
                   :reset => Util.color(:reset)}
 
         if colorize
-          return colors[level] || ""
+          colors[level] || ""
         else
-          return ""
+          ""
         end
       end
 
       # Helper to return a string in specific color
       def colorize(level, msg)
-        "%s%s%s" % [ color(level), msg, color(:reset) ]
+        "%s%s%s" % [color(level), msg, color(:reset)]
       end
     end
   end

data/lib/mcollective/logger/file_logger.rb

@@ -1,4 +1,4 @@
-require 'logger'
+require "logger"
 
 module MCollective
   module Logger
@@ -9,7 +9,7 @@ module MCollective
     #   - config.logfile
     #   - config.keeplogs defaults to 2097152
     #   - config.max_log_size defaults to 5
-    class File_logger<Base
+    class File_logger < Base
       def start
         config = Config.instance
 
@@ -19,16 +19,16 @@ module MCollective
         set_level(config.loglevel.to_sym)
       end
 
-      def set_logging_level(level)
+      def set_logging_level(level) # rubocop:disable Naming/AccessorMethodName
         @logger.level = map_level(level)
-      rescue Exception => e
+      rescue Exception => e # rubocop:disable Lint/RescueException
         @logger.level = ::Logger::DEBUG
         log(:error, "", "Could not set logging to #{level} using debug instead: #{e.class} #{e}")
       end
 
       def valid_levels
-        {:info  => ::Logger::INFO,
-         :warn  => ::Logger::WARN,
+        {:info => ::Logger::INFO,
+         :warn => ::Logger::WARN,
          :debug => ::Logger::DEBUG,
          :fatal => ::Logger::FATAL,
          :error => ::Logger::ERROR}
@@ -39,7 +39,7 @@ module MCollective
       rescue
         # if this fails we probably cant show the user output at all,
         # STDERR it as last resort
-        STDERR.puts("#{level}: #{msg}")
+        warn("#{level}: #{msg}")
       end
 
       def reopen

data/lib/mcollective/logger/syslog_logger.rb

@@ -1,8 +1,8 @@
 module MCollective
   module Logger
     # Implements a syslog based logger using the standard ruby syslog class
-    class Syslog_logger<Base
-      require 'syslog'
+    class Syslog_logger < Base
+      require "syslog"
 
       include Syslog::Constants
 
@@ -19,34 +19,30 @@ module MCollective
       end
 
       def syslog_facility(facility)
-        begin
-          Syslog.const_get("LOG_#{facility.upcase}")
-        rescue NameError => e
-          STDERR.puts "Invalid syslog facility #{facility} supplied, reverting to USER"
-          Syslog::LOG_USER
-        end
+        Syslog.const_get("LOG_#{facility.upcase}")
+      rescue NameError
+        warn "Invalid syslog facility #{facility} supplied, reverting to USER"
+        Syslog::LOG_USER
       end
 
-      def set_logging_level(level)
+      def set_logging_level(level) # rubocop:disable Naming/AccessorMethodName
         # noop
       end
 
       def valid_levels
-        {:info  => :info,
-         :warn  => :warning,
+        {:info => :info,
+         :warn => :warning,
          :debug => :debug,
          :fatal => :crit,
          :error => :err}
       end
 
       def log(level, from, msg)
-        if @known_levels.index(level) >= @known_levels.index(@active_level)
-          Syslog.send(map_level(level), "#{from} #{msg}")
-        end
+        Syslog.send(map_level(level), "#{from} #{msg}") if @known_levels.index(level) >= @known_levels.index(@active_level)
       rescue
         # if this fails we probably cant show the user output at all,
         # STDERR it as last resort
-        STDERR.puts("#{level}: #{msg}")
+        warn("#{level}: #{msg}")
       end
     end
   end

data/lib/mcollective/message.rb

@@ -2,8 +2,7 @@ module MCollective
   # container for a message, its headers, agent, collective and other meta data
   class Message
     attr_reader :message, :request, :validated, :msgtime, :payload, :type, :expected_msgid, :reply_to
-    attr_accessor :headers, :agent, :collective, :filter
-    attr_accessor :requestid, :discovered_hosts, :options, :ttl
+    attr_accessor :headers, :agent, :collective, :filter, :requestid, :discovered_hosts, :options, :ttl
 
     VALIDTYPES = [:message, :request, :direct_request, :reply].freeze
 
@@ -79,9 +78,7 @@ module MCollective
       if type == :direct_request
         raise "Direct requests is not enabled using the direct_addressing config option" unless Config.instance.direct_addressing
 
-        unless @discovered_hosts && !@discovered_hosts.empty?
-          raise "Can only set type to :direct_request if discovered_hosts have been set"
-        end
+        raise "Can only set type to :direct_request if discovered_hosts have been set" unless @discovered_hosts && !@discovered_hosts.empty?
 
         # clear out the filter, custom discovery sources might interpret the filters
         # different than the remote mcollectived and in directed mode really the only
@@ -109,6 +106,7 @@ module MCollective
     # at us.
     def expected_msgid=(msgid)
       raise "Can only store the expected msgid for reply messages" unless @type == :reply
+
       @expected_msgid = msgid
     end
 
@@ -132,7 +130,7 @@ module MCollective
 
     def description
       cid = ""
-      cid += payload[:callerid] + "@" if payload.include?(:callerid)
+      cid += "#{payload[:callerid]}@" if payload.include?(:callerid)
       cid += payload[:senderid]
 
       "#{requestid} for agent '#{agent}' in collective '#{collective}' from #{cid}"
@@ -150,8 +148,6 @@ module MCollective
         @requestid = request.payload[:requestid]
         @payload = PluginManager["security_plugin"].encodereply(agent, payload, requestid, request.payload[:callerid])
       when :request, :direct_request
-        validate_compound_filter(@filter["compound"]) unless @filter["compound"].empty?
-
         @requestid ||= create_reqid
         @payload = PluginManager["security_plugin"].encoderequest(Config.instance.identity, payload, requestid, filter, agent, collective, ttl)
       else
@@ -159,29 +155,6 @@ module MCollective
       end
     end
 
-    def validate_compound_filter(compound_filter)
-      compound_filter.each do |filter|
-        filter.each do |statement|
-          next unless statement["fstatement"]
-          functionname = statement["fstatement"]["name"]
-          pluginname = Data.pluginname(functionname)
-          value = statement["fstatement"]["value"]
-
-          ddl = DDL.new(pluginname, :data)
-
-          # parses numbers and booleans entered as strings into proper
-          # types of data so that DDL validation will pass
-          statement["fstatement"]["params"] = Data.ddl_transform_input(ddl, statement["fstatement"]["params"])
-
-          Data.ddl_validate(ddl, statement["fstatement"]["params"])
-
-          unless value && Data.ddl_has_output?(ddl, value)
-            raise(DDLValidationError, "Data plugin '%s()' does not return a '%s' value" % [functionname, value])
-          end
-        end
-      end
-    end
-
     def decode!
       raise "Cannot decode message type #{type}" unless [:request, :reply].include?(type)
 
@@ -194,15 +167,15 @@ module MCollective
         else
           # We're in the client, log and carry on as best we can
 
-          # Note: mc_sender is unverified.  The verified identity is in the
+          # NOTE: mc_sender is unverified.  The verified identity is in the
           # payload we just failed to decode
           Log.warn("Failed to decode a message from '#{headers['mc_sender']}': #{e}")
           return
         end
       end
 
-      if type == :request
-        raise "callerid in request is not valid, surpressing reply to potentially forged request" unless PluginManager["security_plugin"].valid_callerid?(payload[:callerid])
+      if type == :request && !PluginManager["security_plugin"].valid_callerid?(payload[:callerid])
+        raise "callerid in request is not valid, surpressing reply to potentially forged request"
       end
 
       [:collective, :agent, :filter, :requestid, :ttl, :msgtime].each do |prop|
@@ -216,11 +189,7 @@ module MCollective
 
       msg_age = Time.now.utc.to_i - msgtime
 
-      if msg_age > ttl
-        PluginManager["global_stats"].ttlexpired
-        raise(MsgTTLExpired, "Message #{description} created at #{msgtime} is #{msg_age} seconds old, TTL is #{ttl}. Rejecting message.")
-      end
-
+      raise(MsgTTLExpired, "Message #{description} created at #{msgtime} is #{msg_age} seconds old, TTL is #{ttl}. Rejecting message.") if msg_age > ttl
       raise(NotTargettedAtUs, "Message #{description} does not pass filters. Ignoring message.") unless PluginManager["security_plugin"].validate_filter?(payload[:filter])
 
       @validated = true