facter 4.2.2 → 4.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 867b1b34ad64d40d49cd01bb749e9ff6152e9b358fd3cdfd38134fa25b6cafcc
-  data.tar.gz: f4e5ea1361c76d4262d4af77c84c815c38ab5a70881661aa63f663628255d5cd
+  metadata.gz: 353d24b45ac4083ff9a2f7de05702a93e8701487cc6020de93ed974d527e7f53
+  data.tar.gz: c02329462e40922777fac34fab775ea1d68b884b7d4d8f8e99544bdb737f57e8
 SHA512:
-  metadata.gz: 60c92e85c30157b841c2c82b1581241c6943daa087ac82bbc7ced27722d12923f83e2548bcd6ca426685953994c48a5c5a6298c0dfea502741d03efce7e35abb
-  data.tar.gz: 987fc13f8c8c32f71dcbcbdf4ce49c97c11f99c5c9a5f448456670a1603b18de0bedf3519526376e7ea6c2a968400434a5c0ea1b691229e7b252f5480c0817df
+  metadata.gz: 1ccd6eb8e93836cf558c7ed12c943d8c30d14bad521f2de821b014ceb30b3d1f4fc92cc3c54690ff853b5d62dd4c3521293127f87d08fe6525d5ff2f317e3637
+  data.tar.gz: d4a75033160dac87a2244855c7a2ff8d34fb733b527cc8ffd45279c3e2821b0860f3b1982ab1e0e4182c9c75cf45129ebe0c68738eeb605b9e435b5d460da309

data/lib/facter.rb

@@ -13,8 +13,6 @@ module Facter
   Options.init
   Log.output(STDOUT)
   @already_searched = {}
-  @debug_once = []
-  @warn_once = []
 
   class << self
     # Method used by puppet-agent to retrieve facts
@@ -109,8 +107,7 @@ module Facter
     # @api public
     def clear
       @already_searched = {}
-      @debug_once = []
-      @warn_once = []
+      Facter.clear_messages
       LegacyFacter.clear
       Options[:custom_dir] = []
       LegacyFacter.collection.invalidate_custom_facts
@@ -119,6 +116,13 @@ module Facter
       nil
     end
 
+    # Clears the seen state of debug and warning messages.
+    #
+    # @return [nil]
+    def clear_messages
+      Facter::Log.clear_messages
+    end
+
     # Retrieves the value of a core fact. External or custom facts are
     # not returned with this call. Returns `nil` if no such fact exists.
     #
@@ -153,13 +157,7 @@ module Facter
     #
     # @api public
     def debugonce(message)
-      return unless debugging?
-
-      message_string = message.to_s
-      return if @debug_once.include? message_string
-
-      @debug_once << message_string
-      logger.debug(message_string)
+      logger.debugonce(message)
       nil
     end
 
@@ -482,11 +480,7 @@ module Facter
     #
     # @api public
     def warnonce(message)
-      message_string = message.to_s
-      return if @warn_once.include? message_string
-
-      @warn_once << message_string
-      logger.warn(message_string)
+      logger.warnonce(message)
       nil
     end
 

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'facter/custom_facts/core/logging'
 require 'facter/custom_facts/core/legacy_facter'
 require 'facter/custom_facts/util/fact'
 require 'facter/custom_facts/util/collection'

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

@@ -38,8 +38,6 @@ module LegacyFacter
   include Comparable
   include Enumerable
 
-  extend LegacyFacter::Core::Logging
-
   # module methods
 
   # Accessor for the collection object which holds all the facts

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

@@ -103,7 +103,7 @@ module LegacyFacter
 
         finishtime = Time.now.to_f
         ms = (finishtime - starttime) * 1000
-        LegacyFacter.show_time format('%<qn>s: %<ms>.2fms', qn: qualified_name, ms: ms)
+        Facter::Log.show_time format('%<qn>s: %<ms>.2fms', qn: qualified_name, ms: ms)
       end
 
       def qualified_name

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

@@ -32,7 +32,7 @@ module LegacyFacter
 
         fact
       rescue StandardError => e
-        Facter.log_exception(e, "Unable to add fact #{name}: #{e}")
+        log.log_exception("Unable to add fact #{name}: #{e}")
       end
 
       # Add a resolution mechanism for a named fact.  This does not distinguish
@@ -71,9 +71,7 @@ module LegacyFacter
         # Try HARDER
         internal_loader.load_all unless @facts[name]
 
-        if @facts.empty?
-          LegacyFacter.warnonce("No facts loaded from #{internal_loader.search_path.join(File::PATH_SEPARATOR)}")
-        end
+        log.warnonce("No facts loaded from #{internal_loader.search_path.join(File::PATH_SEPARATOR)}") if @facts.empty?
 
         @facts[name]
       end
@@ -181,6 +179,10 @@ module LegacyFacter
         @external_facts_loaded = true
         external_loader.load(self)
       end
+
+      def log
+        @log ||= Facter::Log.new(self)
+      end
     end
   end
 end

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

@@ -41,13 +41,13 @@ module LegacyFacter
           begin
             return !!@block.call
           rescue StandardError => e
-            LegacyFacter.debug "Confine raised #{e.class} #{e}"
+            log.debug "Confine raised #{e.class} #{e}"
             return false
           end
         end
 
         unless (fact = Facter[@fact])
-          LegacyFacter.debug format('No fact for %<fact>s', fact: @fact)
+          log.debug format('No fact for %<fact>s', fact: @fact)
           return false
         end
         value = convert(fact.value)
@@ -58,13 +58,19 @@ module LegacyFacter
           begin
             return !!@block.call(value)
           rescue StandardError => e
-            LegacyFacter.debug "Confine raised #{e.class} #{e}"
+            log.debug "Confine raised #{e.class} #{e}"
             return false
           end
         end
 
         @values.any? { |v| convert(v) === value }
       end
+
+      private
+
+      def log
+        @log ||= Facter::Log.new(self)
+      end
     end
   end
 end

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

@@ -52,6 +52,10 @@ module LegacyFacter
 
       private
 
+      def log
+        @log ||= Facter::Log.new(self)
+      end
+
       def load_directory_entries(_collection)
         cm = Facter::CacheManager.new
         facts = []
@@ -87,18 +91,26 @@ module LegacyFacter
           data = resolve_fact(fact, parser)
 
           if data == false
-            LegacyFacter.warn "Could not interpret fact file #{fact.file}"
+            log.warn "Could not interpret fact file #{fact.file}"
           elsif (data == {}) || data.nil?
-            @log.debug("Fact file #{fact.file} was parsed but no key=>value data was returned")
+            log.debug("Fact file #{fact.file} was parsed but no key=>value data was returned")
           else
-            data.each do |p, v|
-              collection.add(p, value: v, fact_type: :external,
-                                file: fact.file) { has_weight(weight) }
-            end
+            add_data(data, collection, fact, weight)
           end
         end
       end
 
+      def add_data(data, collection, fact, weight)
+        data.each do |key, value|
+          collection.add(
+            key,
+            value: value,
+            fact_type: :external,
+            file: fact.file
+          ) { has_weight(weight) }
+        end
+      end
+
       def resolve_fact(fact, parser)
         data = nil
         fact_name = File.basename(fact.file)

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

@@ -47,8 +47,6 @@ module Facter
         @used_resolution_weight = 0
 
         @value = nil
-
-        @log = Facter::Log.new(self)
       end
 
       # Adds a new {Facter::Util::Resolution resolution}.  This requires a
@@ -87,8 +85,8 @@ module Facter
 
         resolve
       rescue StandardError => e
-        LegacyFacter
-          .log_exception(e, "Unable to add resolve #{resolution_name.inspect} for fact #{@name}: #{e.message}")
+        log.log_exception("Unable to add resolve #{resolution_name.inspect} for fact #{@name}: #{e.message}")
+        nil
       end
 
       # Retrieve an existing resolution by name
@@ -122,7 +120,7 @@ module Facter
         return @value if @value
 
         if @resolves.empty?
-          LegacyFacter.debug format('No resolves for %<name>s', name: @name)
+          log.debug format('No resolves for %<name>s', name: @name)
           return nil
         end
 
@@ -147,12 +145,16 @@ module Facter
       def extract_ldapname_option!(options)
         return unless options[:ldapname]
 
-        LegacyFacter.warnonce('ldapname is deprecated and will be removed in a future version')
+        log.warnonce('ldapname is deprecated and will be removed in a future version')
         self.ldapname = options.delete(:ldapname)
       end
 
       private
 
+      def log
+        @log ||= Facter::Log.new(self)
+      end
+
       def resolve_value
         return Facter.core_value(name) if @value.nil?
 
@@ -222,18 +224,18 @@ module Facter
 
       def log_fact_path(resolve)
         fact = resolve.fact
-        @log.debug("#{resolve.fact_type} fact #{fact.name} got resolved from: #{fact.location}")
+        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?
 
-        LegacyFacter.debug format('Found no suitable resolves of %<resolver_length> for %<name>s',
-                                  resolver_length: @resolves.length, name: @name)
+        log.debug format('Found no suitable resolves of %<resolver_length> for %<name>s',
+                         resolver_length: @resolves.length, name: @name)
       end
 
       def announce_when_no_value_found(value)
-        LegacyFacter.debug(format('value for %<name>s is still nil', name: @name)) if value.nil?
+        log.debug(format('value for %<name>s is still nil', name: @name)) if value.nil?
       end
 
       def create_or_return_resolution(resolution_name, resolution_type)

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

@@ -78,7 +78,7 @@ module LegacyFacter
           if valid_search_path?(path)
             search_paths << path
           else
-            LegacyFacter.warn "Excluding #{path} from search path. Fact file paths must be an absolute directory"
+            log.debug "Excluding #{path} from search path. Fact file paths must be an absolute directory"
           end
         end
 
@@ -89,6 +89,10 @@ module LegacyFacter
 
       private
 
+      def log
+        @log ||= Facter::Log.new(self)
+      end
+
       # Validate that the given path is valid, ie it is an absolute path.
       #
       # @api private

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

@@ -137,11 +137,17 @@ module LegacyFacter
           if LegacyFacter.json?
             JSON.parse(content)
           else
-            LegacyFacter.warnonce "Cannot parse JSON data file #{filename} without the json library."
-            LegacyFacter.warnonce 'Suggested next step is `gem install json` to install the json library.'
+            log.warnonce "Cannot parse JSON data file #{filename} without the json library."
+            log.warnonce 'Suggested next step is `gem install json` to install the json library.'
             nil
           end
         end
+
+        private
+
+        def log
+          @log ||= Facter::Log.new(self)
+        end
       end
 
       register(JsonParser) do |filename|

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

@@ -91,7 +91,7 @@ module Facter
           msg = "Already evaluated #{@name}"
           msg << " at #{@last_evaluated}" if msg.is_a? String
           msg << ', reevaluating anyways'
-          LegacyFacter.warn msg
+          log.warn msg
         end
 
         instance_eval(&block)
@@ -171,6 +171,10 @@ module Facter
 
       private
 
+      def log
+        @log ||= Facter::Log.new(self)
+      end
+
       # If the weights are equal, we consider external facts greater tan custom facts
       def compare_equal_weights(other)
         # Other is considered greater because self is custom fact and other is external

data/lib/facter/framework/core/fact/internal/internal_fact_manager.rb

@@ -11,10 +11,8 @@ module Facter
     def resolve_facts(searched_facts)
       internal_searched_facts = filter_internal_facts(searched_facts)
       resolved_facts = if Options[:sequential]
-                         log.debug('Resolving facts sequentially')
                          resolve_sequentially(internal_searched_facts)
                        else
-                         log.debug('Resolving fact in parallel')
                          resolve_in_parallel(internal_searched_facts)
                        end
 

data/lib/facter/framework/core/fact_loaders/fact_loader.rb

@@ -29,7 +29,6 @@ module Facter
     end
 
     def load_internal_facts(user_query, options)
-      @log.debug('Loading internal facts')
       internal_facts = []
       if user_query || options[:show_legacy]
         # if we have a user query, then we must search in core facts and legacy facts

data/lib/facter/framework/core/fact_manager.rb

@@ -13,6 +13,7 @@ module Facter
     end
 
     def resolve_facts(user_query = [])
+      log_resolving_method
       @options[:user_query] = user_query
       cache_manager = Facter::CacheManager.new
 
@@ -40,6 +41,7 @@ module Facter
     # - load all the core facts, external facts and env facts
     # - load all custom facts
     def resolve_fact(user_query)
+      log_resolving_method
       @options[:user_query] = user_query
       @log.debug("resolving fact with user_query: #{user_query}")
 
@@ -58,12 +60,21 @@ module Facter
     end
 
     def resolve_core(user_query = [], options = {})
+      log_resolving_method
       @cache_manager = CacheManager.new
       core_fact(user_query, options)
     end
 
     private
 
+    def log_resolving_method
+      if Options[:sequential]
+        @log.debugonce('Resolving facts sequentially')
+      else
+        @log.debugonce('Resolving fact in parallel')
+      end
+    end
+
     def core_fact(user_query, options)
       loaded_facts_hash = @fact_loader.load_internal_facts(user_query, options)
 

data/lib/facter/framework/logging/logger.rb

@@ -15,8 +15,16 @@ module Facter
     @@logger = nil
     @@message_callback = nil
     @@has_errors = false
+    @@debug_messages = []
+    @@warn_messages = []
+    @@timing = false
 
     class << self
+      def clear_messages
+        @@debug_messages.clear
+        @@warn_messages.clear
+      end
+
       def on_message(&block)
         @@message_callback = block
       end
@@ -47,6 +55,41 @@ module Facter
           "[#{datetime}] #{severity} #{msg} \n"
         end
       end
+
+      # Print an exception message, and optionally a backtrace if trace is set
+
+      # Print timing information
+      #
+      # @param string [String] the time to print
+      # @return [void]
+      #
+      # @api private
+      def show_time(string)
+        return unless string && timing?
+
+        if @@message_callback
+          @@message_callback.call(:info, string)
+        else
+          warn("#{GREEN}#{string}#{RESET}")
+        end
+      end
+
+      # Enable or disable logging of timing information
+      #
+      # @param bool [true, false]
+      # @return [void]
+      #
+      # @api private
+      def timing(bool)
+        @@timing = bool
+      end
+
+      # Returns whether timing output is turned on
+      #
+      # @api private
+      def timing?
+        @@timing
+      end
     end
 
     def initialize(logged_class)
@@ -68,6 +111,16 @@ module Facter
       end
     end
 
+    def debugonce(msg)
+      return unless debugging_active?
+
+      message_string = msg.to_s
+      return if @@debug_messages.include? message_string
+
+      @@debug_messages << message_string
+      debug(message_string)
+    end
+
     def info(msg)
       if msg.nil? || msg.empty?
         empty_message_error(msg)
@@ -88,6 +141,14 @@ module Facter
       end
     end
 
+    def warnonce(message)
+      message_string = message.to_s
+      return if @@warn_messages.include? message_string
+
+      @@warn_messages << message_string
+      warn(message_string)
+    end
+
     def error(msg, colorize = false)
       @@has_errors = true
 

data/lib/facter/framework/parsers/query_parser.rb

@@ -24,13 +24,11 @@ module Facter
       # Returns a list of SearchedFact objects that resolve the users query.
       def parse(query_list, loaded_fact)
         matched_facts = []
-        @log.debug "User query is: #{query_list}"
         @query_list = query_list
 
         return no_user_query(loaded_fact) unless query_list.any?
 
         query_list.each do |query|
-          @log.debug "Query is #{query}"
           found_facts = search_for_facts(query, loaded_fact)
           matched_facts << found_facts
         end
@@ -65,7 +63,6 @@ module Facter
       end
 
       def get_facts_matching_tokens(query_tokens, query_token_range, loaded_fact_hash)
-        @log.debug "Checking query tokens #{query_tokens[query_token_range].join('.')}"
         resolvable_fact_list = []
 
         loaded_fact_hash.each do |loaded_fact|
@@ -77,7 +74,7 @@ module Facter
           resolvable_fact_list << searched_fact
         end
 
-        @log.debug "List of resolvable facts: #{resolvable_fact_list.inspect}"
+        @log.debug "List of resolvable facts: #{resolvable_fact_list.inspect}" if resolvable_fact_list.any?
         resolvable_fact_list
       end
 

data/lib/facter/resolvers/os_release.rb

@@ -53,12 +53,15 @@ module Facter
         end
 
         def process_name
-          return unless @fact_list[:name]
+          os_name = @fact_list[:name]
+          return unless os_name
 
-          @fact_list[:name] = if @fact_list[:name].downcase.start_with?('red', 'oracle')
-                                @fact_list[:name].split(' ')[0..1].join
+          @fact_list[:name] = if os_name.downcase.start_with?('red', 'oracle', 'arch', 'manjaro')
+                                os_name = os_name.split(' ')[0..1].join
+                                os_name = os_name.capitalize if os_name.downcase.start_with?('arch', 'manjaro')
+                                os_name
                               else
-                                @fact_list[:name].split(' ')[0].strip
+                                os_name.split(' ')[0].strip
                               end
         end
 

data/lib/facter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Facter
-  VERSION = '4.2.2' unless defined?(VERSION)
+  VERSION = '4.2.3' unless defined?(VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facter
 version: !ruby/object:Gem::Version
-  version: 4.2.2
+  version: 4.2.3
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -214,7 +214,6 @@ files:
 - lib/facter/custom_facts/core/execution/windows.rb
 - lib/facter/custom_facts/core/file_loader.rb
 - lib/facter/custom_facts/core/legacy_facter.rb
-- lib/facter/custom_facts/core/logging.rb
 - lib/facter/custom_facts/core/resolvable.rb
 - lib/facter/custom_facts/core/suitable.rb
 - lib/facter/custom_facts/util/collection.rb

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

@@ -1,203 +0,0 @@
-# frozen_string_literal: true
-
-module LegacyFacter
-  module Core
-    module Logging
-      extend self
-
-      # @api private
-      GREEN = "\e[0;32m"
-      # @api private
-      RESET = "\e[0m"
-
-      RED = "\e[31m"
-
-      # @api private
-      @@debug = false
-      # @api private
-      @@timing = false
-      # @api private
-      @@trace = false
-
-      # @api private
-      @@warn_messages = {}
-      # @api private
-      @@debug_messages = {}
-
-      # @api private
-      @@message_callback = nil
-
-      # Used to register a callback that is called when a message is logged.
-      # If a block is given, Facter will not log messages.
-      # If a block is not given, Facter will resume logging messages.
-      # @param block [Proc] the callback to call when a message is logged.
-      #   The first argument to the callback will be a symbol representing a level. The supported
-      #   levels are: :trace, :debug, :info, :warn, :error, and :fatal.
-      #   The second argument to the callback will be a string containing the message
-      #   that was logged.
-      # @api public
-      def on_message(&block)
-        @@message_callback = block
-      end
-
-      # Prints a debug message if debugging is turned on
-      #
-      # @param msg [String] the debug message
-      # @return [void]
-      def debug(msg)
-        return unless debugging?
-
-        if msg.nil? || msg.empty?
-          invoker = caller(1..1).first.slice(/.*:\d+/)
-          self.warn "#{self.class}#debug invoked with invalid message #{msg.inspect}:#{msg.class} at #{invoker}"
-        elsif @@message_callback
-          @@message_callback.call(:debug, msg)
-        else
-          puts GREEN + msg + RESET
-        end
-      end
-
-      # Prints a debug message only once.
-      #
-      # @note Uniqueness is based on the string, not the specific location
-      #   of the method call.
-      #
-      # @param msg [String] the debug message
-      # @return [void]
-      def debugonce(msg)
-        return unless msg && !msg.empty? && @@debug_messages[msg].nil?
-
-        @@debug_messages[msg] = true
-        debug(msg)
-      end
-
-      # Prints a warning message. The message is only printed if debugging
-      # is enabled.
-      #
-      # @param msg [String] the warning message to be printed
-      #
-      # @return [void]
-      def warn(msg)
-        if msg.nil? || msg.empty?
-          invoker = caller(1..1).first.slice(/.*:\d+/)
-          msg = "#{self.class}#debug invoked with invalid message #{msg.inspect}:#{msg.class} at #{invoker}"
-        end
-        if @@message_callback
-          @@message_callback.call(:warn, msg)
-        else
-          Kernel.warn msg
-        end
-      end
-
-      # Prints a warning message only once per process. Each unique string
-      # is printed once.
-      #
-      # @note Unlike {warn} the message will be printed even if debugging is
-      #   not turned on. This behavior is likely to change and should not be
-      #   relied on.
-      #
-      # @param msg [String] the warning message to be printed
-      #
-      # @return [void]
-      def warnonce(msg)
-        return unless @@warn_messages[msg].nil?
-
-        self.warn(msg)
-        @@warn_messages[msg] = true
-      end
-
-      def log_exception(exception, message = :default)
-        self.warn(format_exception(exception, message, @@trace))
-      end
-
-      def format_exception(exception, message, trace)
-        arr = []
-
-        if message == :default
-          arr << exception.message
-        elsif message
-          arr << message
-        end
-
-        if trace
-          arr << 'backtrace:'
-          arr.concat(exception.backtrace)
-        end
-
-        "#{RED}#{arr.flatten.join("\n")}#{RESET}"
-      end
-
-      # Print an exception message, and optionally a backtrace if trace is set
-
-      # Print timing information
-      #
-      # @param string [String] the time to print
-      # @return [void]
-      #
-      # @api private
-      def show_time(string)
-        return unless string && timing?
-
-        if @@message_callback
-          @@message_callback.call(:info, string)
-        else
-          $stderr.puts "#{GREEN}#{string}#{RESET}"
-        end
-      end
-
-      # Enable or disable logging of debug messages
-      #
-      # @param bool [true, false]
-      # @return [void]
-      #
-      # @api private
-      def debugging(bool)
-        @@debug = bool
-      end
-
-      # Is debugging enabled?
-      #
-      # @return [true, false]
-      #
-      # @api private
-      def debugging?
-        @@debug
-      end
-
-      # Enable or disable logging of timing information
-      #
-      # @param bool [true, false]
-      # @return [void]
-      #
-      # @api private
-      def timing(bool)
-        @@timing = bool
-      end
-
-      # Returns whether timing output is turned on
-      #
-      # @api private
-      def timing?
-        @@timing
-      end
-
-      def trace(bool)
-        @@trace = bool
-      end
-
-      def trace?
-        @@trace
-      end
-
-      # Clears the seen state of debug and warning messages. See {debugonce} and {warnonce}.
-      #
-      # @return [void]
-      #
-      # @api private
-      def clear_messages
-        @@debug_messages.clear
-        @@warn_messages.clear
-      end
-    end
-  end
-end