facter 4.0.38 → 4.0.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cded925592073cd18baac69fc11f1154cbeda4370359e9d3e6655f97194d467
-  data.tar.gz: 16ea8f7a28b6ae86b0098a8c9412329dfa2665e1ca1a66ca3cc2d7e734452fa7
+  metadata.gz: 02e89a2638e45004e55f6b0ec4d902946c844b5253ee4e27139ab01d1ee12a92
+  data.tar.gz: bd4405449c4804a3c872510042a33c2cd6cf7fd588df8f95a99893fcb9248291
 SHA512:
-  metadata.gz: be78011c78dab1cdc01e44af6a2e2e053f3600c43a4c758e1edbf2b6a067052de36a8166749148fc2740694394af682c38cd7f72d516f75a323af9c69a278667
-  data.tar.gz: 3b614e324b33c54c571e5857ea184dcf89d0e7e1fdc9030ee57478bdc3eaa6c0511d73f8f18441e33d31258ea5be7f227b3412770a90f82ed8fe789f9f3690f8
+  metadata.gz: 31feabfeb9c2008ae30f16b6469cdf689b78e8711d64e3b614481a3e98b41d8271822b6cb26511a56ba5e19394f2ea811552b29168484d8ee377dbd3697f6655
+  data.tar.gz: f579f81b0dc6fedf937d016e531650c183bc4f89ce66c918f47932af01e97bfc19f0e0f012adcfe36a52e4a9a314685765055fe23bde5aa4cf5b2f92353a450c

data/bin/facter

@@ -4,8 +4,7 @@
 require 'pathname'
 require 'facter/framework/cli/cli_launcher.rb'
 
-cli_launcher = CliLauncher.new(ARGV)
+Facter::OptionsValidator.validate(ARGV)
+processed_arguments = CliLauncher.prepare_arguments(ARGV)
 
-cli_launcher.validate_options
-cli_launcher.prepare_arguments
-cli_launcher.start
+CliLauncher.start(processed_arguments)

data/lib/facter.rb

@@ -17,8 +17,32 @@ module Facter
   @warn_once = []
 
   class << self
-    def clear_messages
-      logger.debug('clear_messages is not implemented')
+    # Method used by puppet-agent to retrieve facts
+    # @param args_as_string [string] facter cli arguments
+    #
+    # @return nil
+    #
+    # @api private
+    def resolve(args_as_string)
+      require 'facter/framework/cli/cli_launcher'
+
+      args = args_as_string.split(' ')
+
+      Facter::OptionsValidator.validate(args)
+      processed_arguments = CliLauncher.prepare_arguments(args, nil)
+
+      cli = Facter::Cli.new([], processed_arguments)
+
+      if cli.args.include?(:version)
+        cli.invoke(:version, [])
+      elsif cli.args.include?('--list-cache-groups')
+        cli.invoke(:list_cache_groups, [])
+      elsif cli.args.include?('--list-block-groups')
+        cli.invoke(:list_block_groups, [])
+      else
+        cli.invoke(:arg_parser)
+      end
+      nil
     end
 
     # Alias method for Facter.fact()
@@ -62,8 +86,16 @@ module Facter
       Options[:custom_dir] = []
       LegacyFacter.collection.invalidate_custom_facts
       LegacyFacter.collection.reload_custom_facts
+      SessionCache.invalidate_all_caches
+      nil
     end
 
+    # Gets the value for a core fact, external or custom facts are
+    #   not returned with this call. Returns `nil` if no such fact exists.
+    #
+    # @return [FactCollection] hash with fact names and values
+    #
+    # @api private
     def core_value(user_query)
       user_query = user_query.to_s
       resolved_facts = Facter::FactManager.instance.resolve_core([user_query])
@@ -102,8 +134,29 @@ module Facter
       nil
     end
 
+    # Define a new fact or extend an existing fact.
+    #
+    # @param name [Symbol] The name of the fact to define
+    # @param options [Hash] A hash of options to set on the fact
+    #
+    # @return [Facter::Util::Fact] The fact that was defined
+    #
+    # @api public
+    def define_fact(name, options = {}, &block)
+      options[:fact_type] = :custom
+      LegacyFacter.define_fact(name, options, &block)
+    end
+
+    # Stores a proc that will be used to output custom messages.
+    #   The proc must receive one parameter that will be the message to log.
+    # @param block [Proc] a block defining messages handler
+    #
+    # @return [nil]
+    #
+    # @api public
     def on_message(&block)
       Facter::Log.on_message(&block)
+      nil
     end
 
     # Check whether debugging is enabled
@@ -125,6 +178,25 @@ module Facter
       Facter::Options[:debug] = debug_bool
     end
 
+    # Iterates over fact names and values
+    #
+    # @yieldparam [String] name the fact name
+    # @yieldparam [String] value the current value of the fact
+    #
+    # @return [Facter]
+    #
+    # @api public
+    def each
+      log_blocked_facts
+      resolved_facts = Facter::FactManager.instance.resolve_facts
+
+      resolved_facts.each do |fact|
+        yield(fact.name, fact.value)
+      end
+
+      self
+    end
+
     # Returns a fact object by name.  If you use this, you still have to
     # call {Facter::Util::Fact#value `value`} on it to retrieve the actual
     # value.
@@ -152,30 +224,41 @@ module Facter
       LegacyFacter.reset
       Options[:custom_dir] = []
       Options[:external_dir] = []
+      SessionCache.invalidate_all_caches
       nil
     end
 
-    # Register directories to be searched for custom facts. The registered directories
-    # must be absolute paths or they will be ignored.
+    # Loads all facts
     #
+    # @return [nil]
+    #
+    # @api public
+    def loadfacts
+      LegacyFacter.loadfacts
+      nil
+    end
+
+    # Register directories to be searched for custom facts. The registered directories
+    #   must be absolute paths or they will be ignored.
     # @param dirs [Array<String>] An array of searched directories
     #
-    # @return [void]
+    # @return [nil]
     #
     # @api public
     def search(*dirs)
       Options[:custom_dir] += dirs
+      nil
     end
 
     # Registers directories to be searched for external facts.
-    #
     # @param dirs [Array<String>] An array of searched directories
     #
-    # @return [void]
+    # @return [nil]
     #
     # @api public
     def search_external(dirs)
       Options[:external_dir] += dirs
+      nil
     end
 
     # Returns the registered search directories.for external facts.
@@ -199,14 +282,13 @@ module Facter
     # Gets a hash mapping fact names to their values
     # The hash contains core facts, legacy facts, custom facts and external facts (all facts that can be resolved).
     #
-    # @return [FactCollection] the hash of fact names and values
+    # @return [FactCollection] hash with fact names and values
     #
     # @api public
     def to_hash
       log_blocked_facts
 
       resolved_facts = Facter::FactManager.instance.resolve_facts
-      Facter::SessionCache.invalidate_all_caches
       Facter::FactCollection.new.build_fact_collection!(resolved_facts)
     end
 
@@ -222,7 +304,7 @@ module Facter
     # Enable or disable trace
     # @param bool [bool] Set trace on debug state
     #
-    # @return [type] [description]
+    # @return [bool] Value of trace debug state
     #
     # @api public
     def trace(bool)
@@ -241,6 +323,27 @@ module Facter
       @already_searched[user_query]&.value
     end
 
+    # Gets the values for multiple facts.
+    #
+    # @param options [Hash] parameters for the fact - attributes
+    #   of {Facter::Util::Fact} and {Facter::Util::Resolution} can be
+    #   supplied here
+    # @param user_queries [String] the fact names
+    #
+    # @return [FactCollection] hash with fact names and values
+    #
+    # @api public
+    def values(options, user_queries)
+      init_cli_options(options, user_queries)
+      resolved_facts = Facter::FactManager.instance.resolve_facts(user_queries)
+
+      if user_queries.count.zero?
+        Facter::FactCollection.new.build_fact_collection!(resolved_facts)
+      else
+        FormatterHelper.retrieve_facts_to_display_for_user_query(user_queries, resolved_facts)
+      end
+    end
+
     # Returns Facter version
     #
     # @return [String] Current version
@@ -260,7 +363,6 @@ module Facter
       logger.info("executed with command line: #{ARGV.drop(1).join(' ')}")
       log_blocked_facts
       resolved_facts = Facter::FactManager.instance.resolve_facts(args)
-      SessionCache.invalidate_all_caches
       fact_formatter = Facter::FormatterFactory.build(Facter::Options.get)
 
       status = error_check(resolved_facts)
@@ -268,23 +370,22 @@ module Facter
       [fact_formatter.format(resolved_facts), status || 0]
     end
 
-    def log_exception(exception, message = :default)
-      arr = []
-      if message == :default
-        arr << exception.message
-      elsif message
-        arr << message
-      end
-      if Options[:trace]
-        arr << 'backtrace:'
-        arr.concat(exception.backtrace)
-      end
+    # Logs an exception and an optional message
+    #
+    # @return [nil]
+    #
+    # @api public
+    def log_exception(exception, message = nil)
+      error_message = []
 
-      logger.error(arr.flatten.join("\n"))
+      error_message << message.to_s unless message.nil? || (message.is_a?(String) && message.empty?)
+
+      parse_exception(exception, error_message)
+      logger.error(error_message.flatten.join("\n"))
+      nil
     end
 
     # Returns a list with the names of all solved facts
-    #
     # @return [Array] the list with all the fact names
     #
     # @api public
@@ -293,7 +394,6 @@ module Facter
     end
 
     # Logs the message parameter as a warning.
-    #
     # @param message [Object] the warning object to be displayed
     #
     # @return [nil]
@@ -305,7 +405,6 @@ module Facter
     end
 
     # Logs only once the same warning message.
-    #
     # @param message [Object] the warning message object
     #
     # @return [nil]
@@ -322,6 +421,19 @@ module Facter
 
     private
 
+    def parse_exception(exception, error_message)
+      if exception.is_a?(Exception)
+        error_message << exception.message if error_message.empty?
+
+        if Options[:trace] && !exception.backtrace.nil?
+          error_message << 'backtrace:'
+          error_message.concat(exception.backtrace)
+        end
+      elsif error_message.empty?
+        error_message << exception.to_s
+      end
+    end
+
     def logger
       @logger ||= Log.new(self)
     end
@@ -343,7 +455,6 @@ module Facter
     def resolve_fact(user_query)
       user_query = user_query.to_s
       resolved_facts = Facter::FactManager.instance.resolve_facts([user_query])
-      SessionCache.invalidate_all_caches
       # we must make a distinction between custom facts that return nil and nil facts
       # Nil facts should not be packaged as ResolvedFacts! (add_fact_to_searched_facts packages facts)
       resolved_facts = resolved_facts.reject { |fact| fact.type == :nil }

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

@@ -18,22 +18,31 @@ module Facter
       include LegacyFacter::Core::Resolvable
 
       # @!attribute [r] name
-      #   @return [Symbol] The name of the aggregate resolution
+      #
+      # @return [Symbol] The name of the aggregate resolution
+      #
+      # @api public
       attr_reader :name
 
       # @!attribute [r] deps
-      #   @api private
-      #   @return [LegacyFacter::Core::DirectedGraph]
+      #
+      # @return [LegacyFacter::Core::DirectedGraph]
+      #
+      # @api private
       attr_reader :deps
 
       # @!attribute [r] confines
-      #   @return [Array<LegacyFacter::Core::Confine>] An array of confines restricting
-      #     this to a specific platform
-      #   @see Facter::Core::Suitable
+      #
+      # @return [Array<LegacyFacter::Core::Confine>] An array of confines restricting
+      #  this to a specific platform
+      #
+      # @api private
       attr_reader :confines
 
       # @!attribute [r] fact
+      #
       # @return [Facter::Util::Fact]
+      #
       # @api private
       attr_reader :fact
 
@@ -48,10 +57,20 @@ module Facter
         @deps = LegacyFacter::Core::DirectedGraph.new
       end
 
+      # Compares the weight of two aggregate facts
+      #
+      # @return [bool] Weight comparison result
+      #
+      # @api private
       def <=>(other)
         weight <=> other.weight
       end
 
+      # Sets options for the aggregate fact
+      #
+      # @return [nil]
+      #
+      # @api private
       def options(options)
         accepted_options = %i[name timeout weight fact_type]
         accepted_options.each do |option_name|
@@ -60,14 +79,17 @@ module Facter
         raise ArgumentError, "Invalid aggregate options #{options.keys.inspect}" unless options.keys.empty?
       end
 
+      # Evaluates the given block
+      #
+      # @return [String] Result of the block's evaluation
+      #
+      # @api private
       def evaluate(&block)
         instance_eval(&block)
       end
 
       # Define a new chunk for the given aggregate
       #
-      # @api public
-      #
       # @example Defining a chunk with no dependencies
       #   aggregate.chunk(:mountpoints) do
       #     # generate mountpoint information
@@ -80,14 +102,14 @@ module Facter
       #   end
       #
       # @param name [Symbol] A name unique to this aggregate describing the chunk
-      # @param opts [Hash]
-      # @options opts [Array<Symbol>, Symbol] :require One or more chunks
-      #   to evaluate and pass to this block.
-      # @yield [*Object] Zero or more chunk results
       #
-      # @return [void]
+      # @param opts [Hash] Hash with options for the aggregate fact
+      #
+      # @return [Facter::Core::Aggregate] The aggregate object
+      #
+      # @api public
       def chunk(name, opts = {}, &block)
-        raise ArgumentError, "#{self.class.name}#chunk requires a block" unless block_given?
+        evaluate_params(name, &block)
 
         deps = Array(opts.delete(:require))
 
@@ -97,12 +119,11 @@ module Facter
 
         @deps[name] = deps
         @chunks[name] = block
+        self
       end
 
       # Define how all chunks should be combined
       #
-      # @api public
-      #
       # @example Merge all chunks
       #   aggregate.aggregate do |chunks|
       #     final_result = {}
@@ -124,19 +145,32 @@ module Facter
       # @yield [Hash<Symbol, Object>] A hash containing chunk names and
       #   chunk values
       #
-      # @return [void]
+      # @return [Facter::Core::Aggregate] The aggregate fact
+      #
+      # @api public
       def aggregate(&block)
         raise ArgumentError, "#{self.class.name}#aggregate requires a block" unless block_given?
 
         @aggregate = block
+        self
       end
 
+      # Returns the fact's resolution type
+      #
+      # @return [Symbol] The fact's type
+      #
+      # @api private
       def resolution_type
         :aggregate
       end
 
       private
 
+      def evaluate_params(name)
+        raise ArgumentError, "#{self.class.name}#chunk requires a block" unless block_given?
+        raise ArgumentError, "#{self.class.name}#expected chunk name to be a Symbol" unless name.is_a? Symbol
+      end
+
       # Evaluate the results of this aggregate.
       #
       # @see Facter::Core::Resolvable#value