facter 4.0.43 → 4.0.49

data/lib/facter/custom_facts/core/aggregate.rb

@@ -24,6 +24,13 @@ module Facter
       # @api public
       attr_reader :name
 
+      # @!attribute [r] fact_type
+      #
+      # @return [Symbol] The fact type of the aggregate resolution
+      #
+      # @api private
+      attr_reader :fact_type
+
       # @!attribute [r] deps
       #
       # @return [LegacyFacter::Core::DirectedGraph]

data/lib/facter/custom_facts/core/execution.rb

@@ -98,16 +98,19 @@ module Facter
       # Execute a command and return the output of that program.
       # @param command [String] Command to run
       #
-      # @param options [Hash] Hash with options for the aggregate fact
+      # @param options [Hash] Hash with options for the command
       #
-      # @option options [Object] :on_fail How to behave when the command could
+      # Options accepted values :on_fail How to behave when the command could
       #   not be run. Specifying :raise will raise an error, anything else will
       #   return that object on failure. Default is :raise.
+      #   :logger Optional logger used to log the command's stderr.
+      #   :time_limit Optional time out for the specified command. If no time_limit is passed,
+      #   a default of 300 seconds is used.
       #
       # @raise [Facter::Core::Execution::ExecutionFailure] If the command does
-      #   not exist or could not be executed.
+      #   not exist or could not be executed and :on_fail is set to :raise
       #
-      # @return [String] the output of the program, or the value of :on_fail if
+      # @return [String] the output of the program, or the value of :on_fail (if it's different than :raise) if
       #   command execution failed and :on_fail was specified.
       #
       # @api public
@@ -115,6 +118,27 @@ module Facter
         @@impl.execute(command, options)
       end
 
+      # Execute a command and return the stdout and stderr of that program.
+      # @param command [String] Command to run
+      #
+      # @param on_fail[Object] How to behave when the command could
+      #   not be run. Specifying :raise will raise an error, anything else will
+      #   return that object on failure. Default is :raise.
+      # @param logger Optional logger used to log the command's stderr.
+      # @param time_limit Optional time out for the specified command. If no time_limit is passed,
+      #   a default of 300 seconds is used.
+      #
+      # @raise [Facter::Core::Execution::ExecutionFailure] If the command does
+      #   not exist or could not be executed and :on_fail is set to :raise
+      #
+      # @return [String, String] the stdout and stderr of the program, or the value of
+      #   :on_fail if command execution failed and :on_fail was specified.
+      #
+      # @api private
+      def execute_command(command, on_fail = nil, logger = nil, time_limit = nil)
+        @@impl.execute_command(command, on_fail, logger, time_limit)
+      end
+
       class ExecutionFailure < StandardError; end
     end
   end

data/lib/facter/custom_facts/core/execution/base.rb

@@ -4,7 +4,7 @@ module Facter
   module Core
     module Execution
       class Base
-        STDERR_MESSAGE = 'Command %s resulted with the following stderr message: %s'
+        STDERR_MESSAGE = 'Command %s completed with the following stderr message: %s'
 
         def initialize
           @log = Log.new(self)
@@ -57,39 +57,11 @@ module Facter
             return on_fail
           end
 
-          execute_command(expanded_command, on_fail, logger, time_limit)
+          out, = execute_command(expanded_command, on_fail, logger, time_limit)
+          out
         end
 
-        private
-
-        def extract_options(options)
-          on_fail = options.fetch(:on_fail, :raise)
-          expand = options.fetch(:expand, true)
-          logger = options[:logger]
-          time_limit = options[:limit].to_i
-          time_limit = time_limit.positive? ? time_limit : nil
-
-          [on_fail, expand, logger, time_limit]
-        end
-
-        def log_stderr(msg, command, logger)
-          return if !msg || msg.empty?
-
-          if logger
-            logger.debug(format(STDERR_MESSAGE, command, msg.strip))
-          else
-            file_name = command.split('/').last
-            logger = Facter::Log.new(file_name)
-            logger.warn(format(STDERR_MESSAGE, command, msg.strip))
-          end
-        end
-
-        def builtin_command?(command)
-          output, _status = Open3.capture2("type #{command}")
-          output.chomp =~ /builtin/ ? true : false
-        end
-
-        def execute_command(command, on_fail, logger = nil, time_limit = nil)
+        def execute_command(command, on_fail = nil, logger = nil, time_limit = nil)
           time_limit ||= 300
           begin
             # Set LC_ALL and LANG to force i18n to C for the duration of this exec;
@@ -128,7 +100,35 @@ module Facter
                   "Failed while executing '#{command}': #{e.message}"
           end
 
-          out.strip
+          [out.strip, stderr]
+        end
+
+        private
+
+        def extract_options(options)
+          on_fail = options.fetch(:on_fail, :raise)
+          expand = options.fetch(:expand, true)
+          logger = options[:logger]
+          time_limit = options[:limit].to_i
+          time_limit = time_limit.positive? ? time_limit : nil
+
+          [on_fail, expand, logger, time_limit]
+        end
+
+        def log_stderr(msg, command, logger)
+          return if !msg || msg.empty?
+
+          unless logger
+            file_name = command.split('/').last
+            logger = Facter::Log.new(file_name)
+          end
+
+          logger.debug(format(STDERR_MESSAGE, command, msg.strip))
+        end
+
+        def builtin_command?(command)
+          output, _status = Open3.capture2("type #{command}")
+          output.chomp =~ /builtin/ ? true : false
         end
       end
     end

data/lib/facter/custom_facts/util/collection.rb

@@ -115,8 +115,7 @@ module LegacyFacter
         internal_loader.load_all unless @loaded
         @loaded = true
 
-        custom_facts = @facts.select { |_k, v| v.options[:fact_type] == :custom }
-        @custom_facts = Facter::Utils.deep_copy(custom_facts.keys)
+        @custom_facts = @facts.select { |_k, v| v.options[:fact_type] == :custom }
       end
 
       def load(name)

data/lib/facter/custom_facts/util/directory_loader.rb

@@ -109,7 +109,7 @@ module LegacyFacter
 
       def entries
         dirs = @directories.select { |directory| File.directory?(directory) }.map do |directory|
-          Dir.entries(directory).map { |directory_entry| File.join(directory, directory_entry) }
+          Dir.entries(directory).map { |directory_entry| File.join(directory, directory_entry) }.sort.reverse!
         end
         dirs.flatten.select { |f| should_parse?(f) }
       rescue Errno::ENOENT

data/lib/facter/custom_facts/util/fact.rb

@@ -9,6 +9,10 @@
 module Facter
   module Util
     class Fact
+      # The location from where fact is resolved
+      # @return [String]
+      attr_reader :location
+
       # The name of the fact
       # @return [String]
       attr_reader :name
@@ -43,6 +47,8 @@ module Facter
         @used_resolution_weight = 0
 
         @value = nil
+
+        @log = Facter::Log.new(self)
       end
 
       # Adds a new {Facter::Util::Resolution resolution}.  This requires a
@@ -56,6 +62,10 @@ module Facter
       # @api private
       def add(options = {}, &block)
         @options = Facter::Utils.deep_copy(@options.merge(options))
+
+        @location = options[:file]
+        @location ||= block.source_location if block_given?
+
         define_resolution(nil, options, &block)
       end
 
@@ -155,7 +165,7 @@ module Facter
         @searching
       end
 
-      # Lock our searching process, so we never ge stuck in recursion.
+      # Lock our searching process, so we never get stuck in recursion.
       def searching
         raise "Caught recursion on #{@name}" if searching?
 
@@ -173,7 +183,24 @@ module Facter
       end
 
       def sort_by_weight(resolutions)
-        resolutions.sort { |a, b| b <=> a }
+        # sort resolutions:
+        # - descending by weight
+        # - multiple facts have the same weight but different types, the :external fact take precedence
+        # - multiple facts with the same weight and type, the order is preserved.
+        # note: sort_by with index is slower than .sort
+        # we cannot use .sort because it is not stable: https://bugs.ruby-lang.org/issues/1089
+        # solution from: https://bugs.ruby-lang.org/issues/1089#note-10
+
+        # rubocop:disable Style/NestedTernaryOperator
+        idx = 0
+        resolutions.sort_by do |x|
+          [
+            -x.weight,
+            x.respond_to?(:fact_type) ? x.fact_type == :external ? 0 : 1 : 1,
+            idx += 1
+          ]
+        end
+        # rubocop:enable Style/NestedTernaryOperator
       end
 
       def find_first_real_value(resolutions)
@@ -184,11 +211,20 @@ module Facter
             break
           end
           @used_resolution_weight = resolve.weight
-          return value unless value.nil?
+          next if value.nil?
+
+          log_fact_path(resolve)
+
+          return value
         end
         nil
       end
 
+      def log_fact_path(resolve)
+        fact = resolve.fact
+        @log.debug("#{resolve.fact_type} fact #{fact.name} got resolved from: #{fact.location}")
+      end
+
       def announce_when_no_suitable_resolution(resolutions)
         return unless resolutions.empty?
 

data/lib/facter/custom_facts/util/loader.rb

@@ -143,7 +143,7 @@ module LegacyFacter
           # match it.
           next if fact && (env_name != fact)
 
-          LegacyFacter.add(Regexp.last_match(1), fact_type: :external) do
+          LegacyFacter.add(Regexp.last_match(1), fact_type: :external, is_env: true) do
             has_weight 1_000_000
             setcode { value }
           end

data/lib/facter/custom_facts/util/parser.rb

@@ -8,6 +8,8 @@
 module LegacyFacter
   module Util
     module Parser
+      STDERR_MESSAGE = 'Command %s completed with the following stderr message: %s'
+
       @parsers = []
 
       # For support mutliple extensions you can pass an array of extensions as
@@ -75,6 +77,15 @@ module LegacyFacter
           res = KeyValuePairOutputFormat.parse output unless res.is_a?(Hash)
           res
         end
+
+        def log_stderr(msg, command, file)
+          return if !msg || msg.empty?
+
+          file_name = file.split('/').last
+          logger = Facter::Log.new(file_name)
+
+          logger.warn(format(STDERR_MESSAGE, command, msg.strip))
+        end
       end
 
       module KeyValuePairOutputFormat
@@ -139,7 +150,9 @@ module LegacyFacter
 
       class ScriptParser < Base
         def parse_results
-          parse_executable_output(Facter::Core::Execution.exec(quote(filename)))
+          stdout, stderr = Facter::Core::Execution.execute_command(quote(filename))
+          log_stderr(stderr, filename, filename)
+          parse_executable_output(stdout)
         end
 
         private
@@ -172,8 +185,9 @@ module LegacyFacter
 
           shell_command =
             "\"#{powershell}\" -NoProfile -NonInteractive -NoLogo -ExecutionPolicy Bypass -File \"#{filename}\""
-          output = Facter::Core::Execution.exec(shell_command)
-          parse_executable_output(output)
+          stdout, stderr = Facter::Core::Execution.execute_command(shell_command)
+          log_stderr(stderr, shell_command, filename)
+          parse_executable_output(stdout)
         end
       end
 

data/lib/facter/custom_facts/util/resolution.rb

@@ -51,7 +51,7 @@ module Facter
       # @return [Facter::Util::Fact] Associated fact with this resolution.
       #
       # @api private
-      attr_reader :fact
+      attr_reader :fact, :last_evaluated, :file
 
       # Create a new resolution mechanism.
       #
@@ -110,7 +110,7 @@ module Facter
       #
       # @api private
       def options(options)
-        accepted_options = %i[name value timeout weight fact_type file]
+        accepted_options = %i[name value timeout weight fact_type file is_env]
 
         accepted_options.each do |option_name|
           instance_variable_set("@#{option_name}", options.delete(option_name)) if options.key?(option_name)

data/lib/facter/facts/aix/disks.rb

@@ -4,7 +4,7 @@ module Facts
   module Aix
     class Disks
       FACT_NAME = 'disks'
-      ALIASES = %w[blockdevices blockdevice_.*_size'].freeze
+      ALIASES = %w[blockdevices blockdevice_.*_size].freeze
 
       def call_the_resolver
         facts = []

data/lib/facter/facts/aix/interfaces.rb

@@ -4,6 +4,7 @@ module Facts
   module Aix
     class Interfaces
       FACT_NAME = 'interfaces'
+      TYPE = :legacy
 
       def call_the_resolver
         fact_value = Facter::Resolvers::Aix::Networking.resolve(:interfaces)

data/lib/facter/facts/aix/memory/swap/available.rb

@@ -11,7 +11,7 @@ module Facts
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:swap)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:available_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:available_bytes])
             end
             [Facter::ResolvedFact.new(FACT_NAME, fact_value), Facter::ResolvedFact.new(ALIASES, fact_value, :legacy)]
           end

data/lib/facter/facts/aix/memory/swap/available_bytes.rb

@@ -13,7 +13,7 @@ module Facts
             fact_value = fact_value[:available_bytes] if fact_value
 
             [Facter::ResolvedFact.new(FACT_NAME, fact_value),
-             Facter::ResolvedFact.new(ALIASES, Facter::FactsUtils::UnitConverter.bytes_to_mb(fact_value), :legacy)]
+             Facter::ResolvedFact.new(ALIASES, Facter::Util::Facts::UnitConverter.bytes_to_mb(fact_value), :legacy)]
           end
         end
       end

data/lib/facter/facts/aix/memory/swap/total.rb

@@ -11,7 +11,7 @@ module Facts
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:swap)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:total_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:total_bytes])
             end
             [Facter::ResolvedFact.new(FACT_NAME, fact_value), Facter::ResolvedFact.new(ALIASES, fact_value, :legacy)]
           end

data/lib/facter/facts/aix/memory/swap/total_bytes.rb

@@ -13,7 +13,7 @@ module Facts
             fact_value = fact_value[:total_bytes] if fact_value
 
             [Facter::ResolvedFact.new(FACT_NAME, fact_value),
-             Facter::ResolvedFact.new(ALIASES, Facter::FactsUtils::UnitConverter.bytes_to_mb(fact_value), :legacy)]
+             Facter::ResolvedFact.new(ALIASES, Facter::Util::Facts::UnitConverter.bytes_to_mb(fact_value), :legacy)]
           end
         end
       end

data/lib/facter/facts/aix/memory/swap/used.rb

@@ -10,7 +10,7 @@ module Facts
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:swap)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:used_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:used_bytes])
             end
             Facter::ResolvedFact.new(FACT_NAME, fact_value)
           end

data/lib/facter/facts/aix/memory/system/available.rb

@@ -11,7 +11,7 @@ module Facts
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:system)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:available_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:available_bytes])
             end
             [Facter::ResolvedFact.new(FACT_NAME, fact_value), Facter::ResolvedFact.new(ALIASES, fact_value, :legacy)]
           end

data/lib/facter/facts/aix/memory/system/available_bytes.rb

@@ -13,7 +13,7 @@ module Facts
             fact_value = fact_value[:available_bytes] if fact_value
 
             [Facter::ResolvedFact.new(FACT_NAME, fact_value),
-             Facter::ResolvedFact.new(ALIASES, Facter::FactsUtils::UnitConverter.bytes_to_mb(fact_value), :legacy)]
+             Facter::ResolvedFact.new(ALIASES, Facter::Util::Facts::UnitConverter.bytes_to_mb(fact_value), :legacy)]
           end
         end
       end

data/lib/facter/facts/aix/memory/system/total.rb

@@ -11,7 +11,7 @@ module Facts
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:system)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:total_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:total_bytes])
             end
             [Facter::ResolvedFact.new(FACT_NAME, fact_value), Facter::ResolvedFact.new(ALIASES, fact_value, :legacy)]
           end

data/lib/facter/facts/aix/memory/system/total_bytes.rb

@@ -13,7 +13,7 @@ module Facts
             fact_value = fact_value[:total_bytes] if fact_value
 
             [Facter::ResolvedFact.new(FACT_NAME, fact_value),
-             Facter::ResolvedFact.new(ALIASES, Facter::FactsUtils::UnitConverter.bytes_to_mb(fact_value), :legacy)]
+             Facter::ResolvedFact.new(ALIASES, Facter::Util::Facts::UnitConverter.bytes_to_mb(fact_value), :legacy)]
           end
         end
       end

data/lib/facter/facts/aix/memory/system/used.rb

@@ -10,7 +10,7 @@ module Facts
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:system)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:used_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:used_bytes])
             end
             Facter::ResolvedFact.new(FACT_NAME, fact_value)
           end