facter 4.0.47 → 4.0.52

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87e1b483df51f967d4e88c90f67ddfef304184d235d08746500c61619c56dee2
-  data.tar.gz: d573d4d221bc71e512c36a2f8218b0d70512ace56cb0eaa37dba3a9eee27bcde
+  metadata.gz: 778d4d972d3e950f98d4fd8dbd4100e7b2a0c168369949b234d7088ddeba539f
+  data.tar.gz: 50303cfdfcf434c38d3d9539c35362f190dd84b82a8f85227d804a876b5a4ce3
 SHA512:
-  metadata.gz: 49f5a8c11e45cdc6e9550e6fa50335700b8c43c048b46b1f091ea4b4a1f66588865a36c2ca1b447bea72c80a1548ca37d6f998eca4187047c6f2e95b2daf87d5
-  data.tar.gz: b6b21071a59dbfedc1499b6464e2556aa272f9fc99feb1674c6961a1a3a564570e9a7df127ad80140703ee320f73b1e41c82deec41dfb4160814544f1a0ae2d4
+  metadata.gz: 38f84ef3e3699e3bed3b348ae07562f9423121011659ef9ebac4395a157eb06bd110a64e7481f82331e8f65e908936df826c630f57f879ba79686bee0878ac5a
+  data.tar.gz: bf2a8b2d1d1e23a0d0ba22f21d2b8e228bc238f2eededc1ab4474dff9e0d5f13094ec2c5990f24916a563b28fd75bfa2d745bd728d2f6cda9b31283116d9df34

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
+
+      # user provided options
+      cli_options[:show_legacy] ||= false
+      Facter::Options.store(cli_options)
+
+      queried_facts(cli.args)
+    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, [])
+    # 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
@@ -322,10 +367,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
@@ -369,30 +414,6 @@ 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 [Array] the fact names
-    #
-    # @return [FactCollection] hash with fact names and values
-    #
-    # @api public
-    def values(options, user_queries)
-      init_cli_options(options, user_queries)
-      Options[:show_legacy] = true
-      log_blocked_facts
-      resolved_facts = Facter::FactManager.instance.resolve_facts(user_queries)
-      resolved_facts.reject! { |fact| fact.type == :custom && fact.value.nil? }
-
-      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
@@ -408,7 +429,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
@@ -434,7 +455,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
@@ -470,6 +491,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
@@ -496,9 +529,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)

data/lib/facter/config.rb

@@ -7,10 +7,13 @@ module Facter
         {
           'Linux' => [
             {
-              'Debian' => %w[
-                Elementary
-                Ubuntu
-                Raspbian
+              'Debian' => [
+                'Elementary',
+                { 'Ubuntu' => [
+                  'Linuxmint'
+                ] },
+                'Raspbian',
+                'Devuan'
               ]
             },
             {
@@ -20,13 +23,23 @@ module Facter
                 Centos
                 Ol
                 Scientific
+                Meego
+                Oel
+                Ovs
               ]
             },
             {
-              'Sles' => [
-                'Opensuse'
+              'Sles' => %w[
+                Opensuse
+                Sled
               ]
-            }
+            },
+            'Gentoo',
+            'Alpine',
+            'Photon',
+            'Slackware',
+            'Mageia',
+            'Openwrt'
           ]
         },
         {
@@ -312,8 +325,7 @@ module Facter
           'operatingsystemrelease',
           'osfamily',
           'physicalprocessorcount',
-          'processor.*',
-          'processor*',
+          'processor[0-9]+.*',
           'processorcount',
           'productname',
           'rubyplatform',

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]
@@ -46,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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'popen3'
+
 module Facter
   module Core
     module Execution
@@ -70,8 +72,7 @@ module Facter
             opts = { 'LC_ALL' => 'C', 'LANG' => 'C' }
             require 'timeout'
             @log.debug("Executing command: #{command}")
-            out, stderr = Open3.popen3(opts, command.to_s) do |_, stdout, stderr, wait_thr|
-              pid = wait_thr.pid
+            out, stderr = Popen3.popen3e(opts, command.to_s) do |_, stdout, stderr, pid|
               stdout_messages = +''
               stderr_messages = +''
               out_reader = Thread.new { stdout.read }

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+#
+# Because Open3 uses Process.detach the env $? is not set so
+# this class reimplements Open3.popen3 with Process.wait instead.
+# [FACT-2934] When calling Facter::Core::Execution, $? and $CHILD_STATUS
+# ruby env variables should be set.
+#
+
+module Facter
+  module Core
+    module Execution
+      class Popen3
+        def self.popen_rune(cmd, opts, child_io, parent_io) # :nodoc:
+          pid = spawn(*cmd, opts)
+          child_io.each(&:close)
+          result = [*parent_io, pid]
+          if defined? yield
+            begin
+              return yield(*result)
+            ensure
+              parent_io.each(&:close)
+              Process.wait(pid)
+            end
+          end
+          result
+        end
+
+        def self.popen3e(*cmd, &block)
+          opts = if cmd.last.is_a? Hash
+                   cmd.pop.dup
+                 else
+                   {}
+                 end
+          in_r, in_w = IO.pipe
+          opts[:in] = in_r
+          in_w.sync = true
+          out_r, out_w = IO.pipe
+          opts[:out] = out_w
+          err_r, err_w = IO.pipe
+          opts[:err] = err_w
+          popen_rune(cmd, opts, [in_r, out_w, err_w], [in_w, out_r, err_r], &block)
+        end
+      end
+    end
+  end
+end

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/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
@@ -33,7 +37,7 @@ module Facter
       def initialize(name, options = {})
         @name = name.to_s.downcase.intern
 
-        @options = Facter::Utils.deep_copy(options)
+        @options = options.dup
         extract_ldapname_option!(options)
 
         @ldapname ||= @name.to_s
@@ -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
@@ -55,7 +61,11 @@ module Facter
       #
       # @api private
       def add(options = {}, &block)
-        @options = Facter::Utils.deep_copy(@options.merge(options))
+        @options = @options.merge(options)
+
+        @location = options[:file]
+        @location ||= block.source_location if block_given?
+
         define_resolution(nil, options, &block)
       end
 
@@ -201,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?