facter 4.0.50 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c40ef2043f777620f54c82fc1ee3e746a9b881b74771b3e6ed693773e2ae2e57
-  data.tar.gz: d6f1f89339c820f37f0a37b07ae42085a231468ce759c9d1a92b0fc7963e7f9e
+  metadata.gz: 9921e9c05d22c7fe9c84a9061a374dd9b31b2f7a28bfa292a62fd0e33ec7eb16
+  data.tar.gz: 44606e1ec31a336cb71971be5b6c21138f0d33b88d023bb71955526550a54fd2
 SHA512:
-  metadata.gz: 91d8d74575aeff6e4b31445a362019fd8f2200f888478b3e2c019a5ccf740b1f9a8590f3edde89f69a66af3bca778d3ab6b73b658c04853122507633221066e3
-  data.tar.gz: e6cf614befcb67eea1ac89c35a22532c04e40225a87b1d81a6dbf00d227ff55f29630a8637239daf44e4f4ab5de13cb5c9c29b4b612358a8063ee36985d243f8
+  metadata.gz: c01cbeb07ac105bbcfcd41598a818962dae3634a72b24f5e850c9dd8b0410c31d52eef1553d9fcc2f3111166d24cba5cb8ae129c3470a1c67a9fc8be12a669cf
+  data.tar.gz: d53fe66fd09af1c5d73a3789160a38c236eacf45e43a5096357ab5eb719dcff38d251e8e29dab09a1763d0e2056909977758453e9fb0a272a229f30d70d85ba1

data/lib/docs/generate_cli.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'facter/framework/cli/cli_launcher'
+
+cli = Facter::Cli.new([])
+
+puts cli.man

data/lib/facter.rb

@@ -27,21 +27,51 @@ module Facter
       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)
+      cli_options = cli.options.dup
+
+      # config file options
+      config_file = cli_options.delete(:config)
+      if config_file
+        Facter::OptionStore.set(:config, config_file)
+        Facter::ConfigFileOptions.init(config_file)
+        Facter::Options.store(ConfigFileOptions.get)
+      end
 
-      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, [])
+      # user provided options
+      cli_options[:show_legacy] ||= false
+      Facter::Options.store(cli_options)
+
+      queried_facts(cli.args)
+    end
+
+    # Method used by cli to set puppet paths
+    # in order to retrieve puppet custom and external facts
+    #
+    # @return nil
+    #
+    # @api private
+    def puppet_facts
+      require 'puppet'
+
+      # don't allow puppet logger to be injected in Facter
+      Options[:allow_external_loggers] = false
+
+      Puppet.initialize_settings
+      $LOAD_PATH << Puppet[:libdir] unless $LOAD_PATH.include?(Puppet[:libdir])
+      Facter.reset
+      Facter.search_external([Puppet[:pluginfactdest]])
+      if Puppet.respond_to? :initialize_facts
+        Puppet.initialize_facts
       else
-        cli.invoke(:arg_parser)
+        Facter.add(:puppetversion) do
+          setcode { Puppet.version.to_s }
+        end
       end
+    rescue LoadError => e
+      logger.error("Could not load puppet gem, got #{e}")
     end
 
     # Alias method for Facter.fact()
@@ -89,10 +119,10 @@ module Facter
       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.
+    # Retrieves the value of 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
+    # @return [FactCollection] A hash with fact names and values
     #
     # @api private
     def core_value(user_query)
@@ -177,14 +207,29 @@ module Facter
       Facter::Options[:debug] = debug_bool
     end
 
+    # Enable sequential resolving of facts
+    #
+    # @return [bool]
+    #
+    # @api public
     def enable_sequential
       Facter::Options[:sequential] = true
     end
 
+    # Disable sequential resolving of facts
+    #
+    # @return [bool]
+    #
+    # @api public
     def disable_sequential
       Facter::Options[:sequential] = false
     end
 
+    # Check if facts are resolved sequentially or not
+    #
+    # @return [bool]
+    #
+    # @api public
     def sequential?
       Facter::Options[:sequential]
     end
@@ -208,23 +253,6 @@ module Facter
       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.
-    #
-    # @param user_query [String] the name of the fact
-    #
-    # @return [Facter::Util::Fact, nil] The fact object, or nil if no fact
-    #   is found.
-    #
-    # @api public
-    def fact(user_query)
-      user_query = user_query.to_s
-      resolve_fact(user_query)
-
-      @already_searched[user_query]
-    end
-
     # Reset search paths for custom and external facts
     # If config file is set custom and external facts will be reloaded
     #
@@ -322,10 +350,10 @@ module Facter
       Options.custom_dir
     end
 
-    # 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).
+    # Retrieves a fact's value. Returns `nil` if no such fact exists.
     #
-    # @return [FactCollection] hash with fact names and values
+    # @param user_query [String] the fact name
+    # @return [String] the value of the fact, or nil if no fact is found
     #
     # @api public
     def to_hash
@@ -366,30 +394,25 @@ module Facter
     def value(user_query)
       user_query = user_query.to_s
       resolve_fact(user_query)
+
       @already_searched[user_query]&.value
     end
 
-    # Gets the values for multiple facts.
+    # 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.
     #
-    # @param options [Hash] parameters for the fact - attributes
-    #   of {Facter::Util::Fact} and {Facter::Util::Resolution} can be
-    #   supplied here
-    # @param user_queries [Array] the fact names
+    # @param user_query [String] the name of the fact
     #
-    # @return [FactCollection] hash with fact names and values
+    # @return [Facter::Util::Fact, nil] The fact object, or nil if no fact
+    #   is found.
     #
     # @api public
-    def values(options, user_queries)
-      init_cli_options(options, user_queries)
-      log_blocked_facts
-      resolved_facts = Facter::FactManager.instance.resolve_facts(user_queries)
-      resolved_facts.reject! { |fact| fact.type == :custom && fact.value.nil? }
+    def fact(user_query)
+      user_query = user_query.to_s
+      resolve_fact(user_query)
 
-      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
+      @already_searched[user_query]
     end
 
     # Returns Facter version
@@ -407,7 +430,7 @@ module Facter
     #
     # @api private
     def to_user_output(cli_options, *args)
-      init_cli_options(cli_options, args)
+      init_cli_options(cli_options)
       logger.info("executed with command line: #{ARGV.drop(1).join(' ')}")
       logger.debug("Facter version: #{Facter::VERSION}")
       log_blocked_facts
@@ -433,7 +456,7 @@ module Facter
       nil
     end
 
-    # Returns a list with the names of all solved facts
+    # Returns a list with the names of all resolved facts
     # @return [Array] the list with all the fact names
     #
     # @api public
@@ -469,6 +492,18 @@ module Facter
 
     private
 
+    def queried_facts(user_query)
+      log_blocked_facts
+      resolved_facts = Facter::FactManager.instance.resolve_facts(user_query)
+      resolved_facts.reject! { |fact| fact.type == :custom && fact.value.nil? }
+
+      if user_query.count.zero?
+        Facter::FactCollection.new.build_fact_collection!(resolved_facts)
+      else
+        FormatterHelper.retrieve_facts_to_display_for_user_query(user_query, resolved_facts)
+      end
+    end
+
     def resolve_facts_for_user_query(user_query)
       resolved_facts = Facter::FactManager.instance.resolve_facts(user_query)
       user_querie = resolved_facts.uniq(&:user_query).map(&:user_query).first
@@ -495,9 +530,9 @@ module Facter
       @logger ||= Log.new(self)
     end
 
-    def init_cli_options(options, args)
+    def init_cli_options(options)
       options = options.map { |(k, v)| [k.to_sym, v] }.to_h
-      Facter::Options.init_from_cli(options, args)
+      Facter::Options.init_from_cli(options)
     end
 
     def add_fact_to_searched_facts(user_query, value)
@@ -511,17 +546,16 @@ module Facter
     # @return [ResolvedFact]
     def resolve_fact(user_query)
       user_query = user_query.to_s
-      resolved_facts = Facter::FactManager.instance.resolve_facts([user_query])
+      resolved_facts = Facter::FactManager.instance.resolve_fact(user_query)
       # 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 }
       fact_collection = FactCollection.new.build_fact_collection!(resolved_facts)
-      splitted_user_query = Facter::Utils.split_user_query(user_query)
 
       begin
-        value = fact_collection.value(*splitted_user_query)
+        value = fact_collection.value(user_query)
         add_fact_to_searched_facts(user_query, value)
-      rescue KeyError
+      rescue KeyError, TypeError
         nil
       end
     end

data/lib/facter/config.rb

@@ -166,6 +166,7 @@ module Facter
           macosx_productversion
           macosx_productversion_major
           macosx_productversion_minor
+          macosx_productversion_patch
           windows_edition_id
           windows_installation_type
           windows_product_name
@@ -301,6 +302,7 @@ module Facter
           'macosx_productversion',
           'macosx_productversion_major',
           'macosx_productversion_minor',
+          'macosx_productversion_patch',
           'manufacturer',
           'memoryfree',
           'memoryfree_mb',

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

@@ -53,6 +53,15 @@ module Facter
       # @api private
       attr_reader :fact
 
+      # Create a new aggregated resolution mechanism.
+      #
+      # @param name [String] The name of the resolution.
+      # @param fact [Facter::Fact] The fact to which this
+      #             resolution will be added.
+      #
+      # @return [Facter::Util::Resolution] The created resolution
+      #
+      # @api private
       def initialize(name, fact)
         @name = name
         @fact = fact

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

@@ -94,11 +94,15 @@ module Facter
             end
             log_stderr(stderr, command, logger)
           rescue StandardError => e
-            return '' if logger
+            message = "Failed while executing '#{command}': #{e.message}"
+            if logger
+              @log.debug(message)
+              return ''
+            end
+
             return on_fail unless on_fail == :raise
 
-            raise Facter::Core::Execution::ExecutionFailure.new,
-                  "Failed while executing '#{command}': #{e.message}"
+            raise Facter::Core::Execution::ExecutionFailure.new, message
           end
 
           [out.strip, stderr]

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

@@ -11,6 +11,8 @@ module Facter
   module Core
     module Execution
       class Popen3
+        @log ||= Log.new(self)
+
         def self.popen_rune(cmd, opts, child_io, parent_io) # :nodoc:
           pid = spawn(*cmd, opts)
           child_io.each(&:close)
@@ -20,7 +22,17 @@ module Facter
               return yield(*result)
             ensure
               parent_io.each(&:close)
-              Process.wait(pid)
+              begin
+                Process.wait(pid)
+              rescue Errno::ENOENT
+                # For some reason, the first Process.wait executed in JRuby
+                # always fails with ENOENT. However, the command output is
+                # filled in so we just need to silently continue.
+                # https://github.com/jruby/jruby/issues/5971
+                raise unless RUBY_PLATFORM == 'java'
+
+                @log.debug('Caught ENOENT during Process.wait on JRuby, continuing...')
+              end
             end
           end
           result

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

@@ -29,8 +29,8 @@ module Facter
           !!(path =~ ABSOLUTE_PATH_REGEX)
         end
 
-        DOUBLE_QUOTED_COMMAND = /^"(.+?)"(?:\s+(.*))?/.freeze
-        SINGLE_QUOTED_COMMAND = /^'(.+?)'(?:\s+(.*))?/.freeze
+        DOUBLE_QUOTED_COMMAND = /\A"(.+?)"(?:\s+(.*))?/.freeze
+        SINGLE_QUOTED_COMMAND = /\A'(.+?)'(?:\s+(.*))?/.freeze
 
         def expand_command(command)
           exe = nil

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

@@ -38,7 +38,7 @@ module Facter
           !!(path =~ ABSOLUTE_PATH_REGEX)
         end
 
-        DOUBLE_QUOTED_COMMAND = /^"(.+?)"(?:\s+(.*))?/.freeze
+        DOUBLE_QUOTED_COMMAND = /\A"(.+?)"(?:\s+(.*))?/.freeze
 
         def expand_command(command)
           exe = nil

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

@@ -59,6 +59,17 @@ module LegacyFacter
         @on_flush_block&.call
       end
 
+      # Resolves the fact's value or loggs an error if the value
+      # couldn't be resolved.
+      #
+      # @raise Facter::ResolveCustomFactError if an error was raised
+      # (except Timeout::Error or Narmalization::NarmalizationError
+      # in which case an error message is logged and the execution
+      # isn't suspended).
+      #
+      # @return value (hash, string, int, array, etc) or nil
+      #
+      # @api private
       def value
         result = nil
 

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

@@ -106,6 +106,11 @@ module LegacyFacter
         @loaded = false
       end
 
+      def custom_fact(fact_name)
+        internal_loader.load(fact_name)
+        @custom_facts = @facts.select { |_k, v| v.options[:fact_type] == :custom }
+      end
+
       # Builds a hash of custom facts
       def custom_facts
         return @custom_facts if @valid_custom_facts

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

@@ -63,7 +63,7 @@ module LegacyFacter
             Facter.log_exception(Exception.new("Caching is enabled for group \"#{basename}\" while "\
               'there are at least two external facts files with the same filename'))
           else
-            searched_fact = Facter::SearchedFact.new(basename, nil, [], nil, :file)
+            searched_fact = Facter::SearchedFact.new(basename, nil, nil, :file)
             searched_fact.file = file
             facts << searched_fact
           end

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

@@ -5,7 +5,10 @@ module LegacyFacter
     module Normalization
       class NormalizationError < StandardError; end
 
-      VALID_TYPES = [Integer, Float, TrueClass, FalseClass, NilClass, Symbol, String, Array, Hash].freeze
+      # load Date and Time classes
+      require 'time'
+
+      VALID_TYPES = [Integer, Float, TrueClass, FalseClass, NilClass, Symbol, String, Array, Hash, Date, Time].freeze
 
       module_function
 
@@ -16,8 +19,10 @@ module LegacyFacter
       # @return [void]
       def normalize(value)
         case value
-        when Integer, Float, TrueClass, FalseClass, NilClass, Symbol, Date
+        when Integer, Float, TrueClass, FalseClass, NilClass, Symbol
           value
+        when Date, Time
+          value.iso8601
         when String
           normalize_string(value)
         when Array

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

@@ -56,6 +56,8 @@ module Facter
       # Create a new resolution mechanism.
       #
       # @param name [String] The name of the resolution.
+      # @param fact [Facter::Fact] The fact to which this
+      #             resolution will be added.
       #
       # @return [Facter::Util::Resolution] The created resolution
       #