facter 4.0.46 → 4.0.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71eb4894f5e565033d547ffb64d562aee98c6b6a082bca7387259f9a779830d8
-  data.tar.gz: 95331a72cf0dc86fabbcad33447724a3a55b536c366bb8ba356428fddefd1587
+  metadata.gz: 87e1b483df51f967d4e88c90f67ddfef304184d235d08746500c61619c56dee2
+  data.tar.gz: d573d4d221bc71e512c36a2f8218b0d70512ace56cb0eaa37dba3a9eee27bcde
 SHA512:
-  metadata.gz: 24caa700190be726fa0a7dc0f7dbbac290e073fab078c32b2b67d8a79c336daeab4c3254389a58e7bb4538706c8b8114d609173b78c31e7d676ca50d21a3bcb7
-  data.tar.gz: 9edcd692bfe2b0de59a6a6bf6f1700387e25da56127148ffd656edb901fc7fa47db7fe61eae3e4bf17ac8ddaa17e655c65ed366ef3fcc79db2a28e20ab1e6a37
+  metadata.gz: 49f5a8c11e45cdc6e9550e6fa50335700b8c43c048b46b1f091ea4b4a1f66588865a36c2ca1b447bea72c80a1548ca37d6f998eca4187047c6f2e95b2daf87d5
+  data.tar.gz: b6b21071a59dbfedc1499b6464e2556aa272f9fc99feb1674c6961a1a3a564570e9a7df127ad80140703ee320f73b1e41c82deec41dfb4160814544f1a0ae2d4

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

@@ -261,6 +261,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 +330,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
@@ -361,6 +384,7 @@ module Facter
       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 +410,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 +470,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 +537,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

@@ -42,6 +42,9 @@ module Facter
     end
     unless defined? FACT_GROUPS
       FACT_GROUPS = {
+        'AIX NIM type' => [
+          'nim_type'
+        ],
         'EC2' => %w[
           ec2_metadata
           ec2_userdata
@@ -49,6 +52,10 @@ module Facter
         'GCE' => [
           'gce'
         ],
+        'Xen' => %w[
+          xen
+          xendomains
+        ],
         'augeas' => %w[
           augeas
           augeasversion
@@ -69,11 +76,18 @@ module Facter
           uuid
           chassistype
         ],
+        'disks' => %w[
+          blockdevices
+          disks
+        ],
         'file system' => %w[
           mountpoints
           filesystems
           partitions
         ],
+        'fips' => [
+          'fips_enabled'
+        ],
         'hypervisors' => [
           'hypervisors'
         ],
@@ -112,12 +126,12 @@ module Facter
           netmask6
           network
           network6
+          scope6
           macaddress
           interfaces
           domain
           fqdn
           dhcp_servers
-          scope6
         ],
         'operating system' => %w[
           os
@@ -210,6 +224,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',

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

@@ -173,7 +173,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)

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

@@ -143,7 +143,7 @@ module LegacyFacter
           # match it.
           next if fact && (env_name != fact)
 
-          LegacyFacter.add(Regexp.last_match(1), fact_type: :external) do
+          LegacyFacter.add(Regexp.last_match(1), fact_type: :external, is_env: true) do
             has_weight 1_000_000
             setcode { value }
           end

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

@@ -110,7 +110,7 @@ module Facter
       #
       # @api private
       def options(options)
-        accepted_options = %i[name value timeout weight fact_type file]
+        accepted_options = %i[name value timeout weight fact_type file is_env]
 
         accepted_options.each do |option_name|
           instance_variable_set("@#{option_name}", options.delete(option_name)) if options.key?(option_name)

data/lib/facter/facts/aix/interfaces.rb

@@ -4,6 +4,7 @@ module Facts
   module Aix
     class Interfaces
       FACT_NAME = 'interfaces'
+      TYPE = :legacy
 
       def call_the_resolver
         fact_value = Facter::Resolvers::Aix::Networking.resolve(:interfaces)

data/lib/facter/facts/aix/memory/swap/available.rb

@@ -11,7 +11,7 @@ module Facts
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:swap)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:available_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:available_bytes])
             end
             [Facter::ResolvedFact.new(FACT_NAME, fact_value), Facter::ResolvedFact.new(ALIASES, fact_value, :legacy)]
           end

data/lib/facter/facts/aix/memory/swap/available_bytes.rb

@@ -13,7 +13,7 @@ module Facts
             fact_value = fact_value[:available_bytes] if fact_value
 
             [Facter::ResolvedFact.new(FACT_NAME, fact_value),
-             Facter::ResolvedFact.new(ALIASES, Facter::FactsUtils::UnitConverter.bytes_to_mb(fact_value), :legacy)]
+             Facter::ResolvedFact.new(ALIASES, Facter::Util::Facts::UnitConverter.bytes_to_mb(fact_value), :legacy)]
           end
         end
       end

data/lib/facter/facts/aix/memory/swap/total.rb

@@ -11,7 +11,7 @@ module Facts
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:swap)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:total_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:total_bytes])
             end
             [Facter::ResolvedFact.new(FACT_NAME, fact_value), Facter::ResolvedFact.new(ALIASES, fact_value, :legacy)]
           end

data/lib/facter/facts/aix/memory/swap/total_bytes.rb

@@ -13,7 +13,7 @@ module Facts
             fact_value = fact_value[:total_bytes] if fact_value
 
             [Facter::ResolvedFact.new(FACT_NAME, fact_value),
-             Facter::ResolvedFact.new(ALIASES, Facter::FactsUtils::UnitConverter.bytes_to_mb(fact_value), :legacy)]
+             Facter::ResolvedFact.new(ALIASES, Facter::Util::Facts::UnitConverter.bytes_to_mb(fact_value), :legacy)]
           end
         end
       end

data/lib/facter/facts/aix/memory/swap/used.rb

@@ -10,7 +10,7 @@ module Facts
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:swap)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:used_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:used_bytes])
             end
             Facter::ResolvedFact.new(FACT_NAME, fact_value)
           end

data/lib/facter/facts/aix/memory/system/available.rb

@@ -11,7 +11,7 @@ module Facts
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:system)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:available_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:available_bytes])
             end
             [Facter::ResolvedFact.new(FACT_NAME, fact_value), Facter::ResolvedFact.new(ALIASES, fact_value, :legacy)]
           end

data/lib/facter/facts/aix/memory/system/available_bytes.rb

@@ -13,7 +13,7 @@ module Facts
             fact_value = fact_value[:available_bytes] if fact_value
 
             [Facter::ResolvedFact.new(FACT_NAME, fact_value),
-             Facter::ResolvedFact.new(ALIASES, Facter::FactsUtils::UnitConverter.bytes_to_mb(fact_value), :legacy)]
+             Facter::ResolvedFact.new(ALIASES, Facter::Util::Facts::UnitConverter.bytes_to_mb(fact_value), :legacy)]
           end
         end
       end

data/lib/facter/facts/aix/memory/system/total.rb

@@ -11,7 +11,7 @@ module Facts
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:system)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:total_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:total_bytes])
             end
             [Facter::ResolvedFact.new(FACT_NAME, fact_value), Facter::ResolvedFact.new(ALIASES, fact_value, :legacy)]
           end

data/lib/facter/facts/aix/memory/system/total_bytes.rb

@@ -13,7 +13,7 @@ module Facts
             fact_value = fact_value[:total_bytes] if fact_value
 
             [Facter::ResolvedFact.new(FACT_NAME, fact_value),
-             Facter::ResolvedFact.new(ALIASES, Facter::FactsUtils::UnitConverter.bytes_to_mb(fact_value), :legacy)]
+             Facter::ResolvedFact.new(ALIASES, Facter::Util::Facts::UnitConverter.bytes_to_mb(fact_value), :legacy)]
           end
         end
       end

data/lib/facter/facts/aix/memory/system/used.rb

@@ -10,7 +10,7 @@ module Facts
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:system)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:used_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:used_bytes])
             end
             Facter::ResolvedFact.new(FACT_NAME, fact_value)
           end

data/lib/facter/facts/aix/processors/speed.rb

@@ -8,7 +8,7 @@ module Facts
 
         def call_the_resolver
           fact_value = Facter::Resolvers::Aix::Processors.resolve(:speed)
-          speed = Facter::FactsUtils::UnitConverter.hertz_to_human_readable(fact_value)
+          speed = Facter::Util::Facts::UnitConverter.hertz_to_human_readable(fact_value)
           Facter::ResolvedFact.new(FACT_NAME, speed)
         end
       end

data/lib/facter/facts/bsd/processors/speed.rb

@@ -8,7 +8,7 @@ module Facts
 
         def call_the_resolver
           fact_value = Facter::Resolvers::Bsd::Processors.resolve(:speed)
-          speed = Facter::FactsUtils::UnitConverter.hertz_to_human_readable(fact_value)
+          speed = Facter::Util::Facts::UnitConverter.hertz_to_human_readable(fact_value)
           Facter::ResolvedFact.new(FACT_NAME, speed)
         end
       end