facter 4.0.46 → 4.0.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71eb4894f5e565033d547ffb64d562aee98c6b6a082bca7387259f9a779830d8
-  data.tar.gz: 95331a72cf0dc86fabbcad33447724a3a55b536c366bb8ba356428fddefd1587
+  metadata.gz: db03b26f8336c77d444ced6b4d073a927b529e6272ef0ba65eafc69af0e66060
+  data.tar.gz: a07adb46289f6315764d40a3f21c967de22c187fe9070177959a02c82bd1da6a
 SHA512:
-  metadata.gz: 24caa700190be726fa0a7dc0f7dbbac290e073fab078c32b2b67d8a79c336daeab4c3254389a58e7bb4538706c8b8114d609173b78c31e7d676ca50d21a3bcb7
-  data.tar.gz: 9edcd692bfe2b0de59a6a6bf6f1700387e25da56127148ffd656edb901fc7fa47db7fe61eae3e4bf17ac8ddaa17e655c65ed366ef3fcc79db2a28e20ab1e6a37
+  metadata.gz: 1cf1b38ac9c4e67b93e73474afa8f134132f0afd90d9cb5e45a4ced0c2cca3874ca581d1e6dd59ea154eb57e7ffc423a2a0c9aa1d36bdd04501648499dc30c3f
+  data.tar.gz: 0567b4d6940087e0c0d273392b103bd507fe6f15adbcaa826d783db1eda0c512582da10031400a0360b76fa397150101e925b4f814b394bdc478b615a1d1c1d0

data/lib/docs/generate.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Generates a markdown file containing fact documentation.
+# usage: ruby generate.rb > facts.md
+
+require 'yaml'
+require 'erb'
+require 'ostruct'
+
+PATH_TO_SCHEMA = File.join(File.dirname(__FILE__), '../schema/facter.yaml')
+PATH_TO_TEMPLATE = File.join(File.dirname(__FILE__), 'template.erb')
+
+schema = YAML.load_file(PATH_TO_SCHEMA)
+
+def format_facts(fact_hash)
+  scope = OpenStruct.new({
+                           facts: fact_hash
+                         })
+
+  erb = if ERB.instance_method(:initialize).parameters.assoc(:key) # Ruby 2.6+
+          ERB.new(File.read(PATH_TO_TEMPLATE), trim_mode: '-')
+        else
+          ERB.new(File.read(PATH_TO_TEMPLATE), nil, '-')
+        end
+  erb.result(scope.instance_eval { binding })
+end
+
+print "## Modern Facts\n\n"
+print format_facts(schema.reject { |_name, info| info['hidden'] == true })
+print "## Legacy Facts\n\n"
+print format_facts(schema.reject { |_name, info| info['hidden'].nil? || info['hidden'] == false })

data/lib/docs/template.erb

@@ -0,0 +1,34 @@
+<%# This template is used to generate a markdown file documenting facts. -%>
+<%# Run 'ruby generate.rb > facts.md' to generate the markdown file. -%>
+<%
+  def format_fact_element(name, info, indent = '')
+    subelements = (info['elements'] || {}).map{|n, i| format_fact_element(n, i, "#{indent}    ")}.join('')
+
+    "#{indent}* `#{name}` (#{info['type']}) --- #{info['description']}\n#{subelements}"
+  end
+-%>
+<% facts.each do |name, schema| -%>
+### `<%= name %>`
+
+<% if schema['hidden'] -%>
+This legacy fact is hidden by default in Facter's command-line output.
+
+<% end -%>
+**Type:** <%= schema['type'] %>
+
+**Purpose:**
+
+<%= schema['description'] %>
+
+<% if schema['elements'] -%>
+**Elements:**
+
+<%= schema['elements'].map{|name, info| format_fact_element(name, info)}.join('') %>
+<% end -%>
+
+<% if schema['details'] -%>
+**Details:**
+
+<%= schema['details'] %>
+<% end -%>
+<% end -%>

data/lib/facter.rb

@@ -44,6 +44,27 @@ module Facter
       end
     end
 
+    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
+        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()
     # @param name [string] fact name
     #
@@ -261,6 +282,26 @@ module Facter
       nil
     end
 
+    # Enables/Disables external facts.
+    # @param enable_external [boolean]
+    #
+    #  @return nil
+    #
+    # @api public
+    def load_external(enable_external)
+      # enable_external param needs negation because behind the scene
+      # no_external_facts= method is negating the parameter again.
+      Options[:no_external_facts] = !enable_external
+
+      if enable_external
+        logger.debug('Facter.load_external(true) called. External facts will be loaded')
+      else
+        logger.debug('Facter.load_external(false) called. External facts will NOT be loaded')
+      end
+
+      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
@@ -310,9 +351,12 @@ module Facter
     # @api public
     def to_hash
       log_blocked_facts
+      logger.debug("Facter version: #{Facter::VERSION}")
 
       resolved_facts = Facter::FactManager.instance.resolve_facts
-      Facter::FactCollection.new.build_fact_collection!(resolved_facts)
+      resolved_facts.reject! { |fact| fact.type == :custom && fact.value.nil? }
+      collection = Facter::FactCollection.new.build_fact_collection!(resolved_facts)
+      Hash[collection]
     end
 
     # Check whether printing stack trace is enabled
@@ -358,9 +402,9 @@ module Facter
     # @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)
@@ -386,13 +430,13 @@ module Facter
     def to_user_output(cli_options, *args)
       init_cli_options(cli_options, args)
       logger.info("executed with command line: #{ARGV.drop(1).join(' ')}")
+      logger.debug("Facter version: #{Facter::VERSION}")
       log_blocked_facts
-      resolved_facts = Facter::FactManager.instance.resolve_facts(args)
+      resolved_facts = resolve_facts_for_user_query(args)
       fact_formatter = Facter::FormatterFactory.build(Facter::Options.get)
-
       status = error_check(resolved_facts)
 
-      [fact_formatter.format(resolved_facts), status || 0]
+      [fact_formatter.format(resolved_facts), status]
     end
 
     # Logs an exception and an optional message
@@ -446,6 +490,15 @@ module Facter
 
     private
 
+    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
+
+      resolved_facts.reject! { |fact| fact.type == :custom && fact.value.nil? } if user_querie&.empty?
+
+      resolved_facts
+    end
+
     def parse_exception(exception, error_message)
       if exception.is_a?(Exception)
         error_message << exception.message if error_message.empty?
@@ -504,14 +557,13 @@ module Facter
     #
     # @api private
     def error_check(resolved_facts)
+      status = 0
       if Options[:strict]
         missing_names = resolved_facts.select { |fact| fact.type == :nil }.map(&:user_query)
 
         if missing_names.count.positive?
           status = 1
           log_errors(missing_names)
-        else
-          status = nil
         end
       end
 

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'
           ]
         },
         {
@@ -42,6 +55,9 @@ module Facter
     end
     unless defined? FACT_GROUPS
       FACT_GROUPS = {
+        'AIX NIM type' => [
+          'nim_type'
+        ],
         'EC2' => %w[
           ec2_metadata
           ec2_userdata
@@ -49,6 +65,10 @@ module Facter
         'GCE' => [
           'gce'
         ],
+        'Xen' => %w[
+          xen
+          xendomains
+        ],
         'augeas' => %w[
           augeas
           augeasversion
@@ -69,11 +89,18 @@ module Facter
           uuid
           chassistype
         ],
+        'disks' => %w[
+          blockdevices
+          disks
+        ],
         'file system' => %w[
           mountpoints
           filesystems
           partitions
         ],
+        'fips' => [
+          'fips_enabled'
+        ],
         'hypervisors' => [
           'hypervisors'
         ],
@@ -112,12 +139,12 @@ module Facter
           netmask6
           network
           network6
+          scope6
           macaddress
           interfaces
           domain
           fqdn
           dhcp_servers
-          scope6
         ],
         'operating system' => %w[
           os
@@ -210,6 +237,23 @@ module Facter
           is_virtual
           cloud
         ],
+        'ldom' => [
+          'ldom'
+        ],
+        'Solaris zone' => %w[
+          zones
+          zonename
+          solaris_zones
+        ],
+        'ZFS' => %w[
+          zfs_version
+          zfs_featurenumbers
+        ],
+        'ZFS storage pool' => %w[
+          zpool_version
+          zpool_featureflags
+          zpool_featurenumbers
+        ],
         'legacy' => [
           'architecture',
           'augeasversion',
@@ -281,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]

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/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
@@ -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
 
@@ -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?