facter 4.0.42 → 4.0.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffa55de7f92a74b84788507b7e9667f158edc68abef1412f40ab5d3beb8f6aad
-  data.tar.gz: e92ff5798a9abab30f1887c5e4f934d75cef67975b2485e53ba6dc58b59ee899
+  metadata.gz: a97076330c5a6ac8a2d8ba6a5a36ecc3b8b3d5661d46057a444f0bafc1fe1e35
+  data.tar.gz: b84fcccd87ee9e7554e99342bf3722f383f23481480b9090e1cdba1ed26021ed
 SHA512:
-  metadata.gz: 4841268cf5f76f1ad2b0ed2bf16b2527dd73e4d41728c64dbe13986b1a574759f900e2748e72ce72f6c677cf754d8a4f5115530140285412a07943e13b6312a5
-  data.tar.gz: bd48e0942af375429188957956a5555963297d62a9bc6549529ae1713b7670b41bfc5eea6b894d961e3e32507963e394779c372ad3b12a6422b5218f94b0f9e4
+  metadata.gz: beba9d7a66f00a6914558d54df18438a64e0e78f9d5109f5a5657f605480a26519a8c5a3b5b12e31c6c312a48c43066fadf302e433f6e57f129ba9214277e266
+  data.tar.gz: 73348a9dd6e2b68f50c7b73f543b0e90153b4753d2f7641ff078ee58860229af32c2f4a3871c25fc7da011308cb5ce20d2c6e455645b6c1e8ae2c59f9092b3b9

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

@@ -17,6 +17,12 @@ module Facter
   @warn_once = []
 
   class << self
+    # Method used by puppet-agent to retrieve facts
+    # @param args_as_string [string] facter cli arguments
+    #
+    # @return query result
+    #
+    # @api private
     def resolve(args_as_string)
       require 'facter/framework/cli/cli_launcher'
 
@@ -38,10 +44,6 @@ module Facter
       end
     end
 
-    def clear_messages
-      logger.debug('clear_messages is not implemented')
-    end
-
     # Alias method for Facter.fact()
     # @param name [string] fact name
     #
@@ -83,8 +85,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])
@@ -136,8 +146,16 @@ module Facter
       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
@@ -159,6 +177,18 @@ module Facter
       Facter::Options[:debug] = debug_bool
     end
 
+    def enable_sequential
+      Facter::Options[:sequential] = true
+    end
+
+    def disable_sequential
+      Facter::Options[:sequential] = false
+    end
+
+    def sequential?
+      Facter::Options[:sequential]
+    end
+
     # Iterates over fact names and values
     #
     # @yieldparam [String] name the fact name
@@ -170,7 +200,6 @@ module Facter
     def each
       log_blocked_facts
       resolved_facts = Facter::FactManager.instance.resolve_facts
-      SessionCache.invalidate_all_caches
 
       resolved_facts.each do |fact|
         yield(fact.name, fact.value)
@@ -206,6 +235,19 @@ module Facter
       LegacyFacter.reset
       Options[:custom_dir] = []
       Options[:external_dir] = []
+      SessionCache.invalidate_all_caches
+      nil
+    end
+
+    # Flushes cached values for all facts. This does not cause code to be
+    # reloaded; it only clears the cached results.
+    #
+    # @return [void]
+    #
+    # @api public
+    def flush
+      LegacyFacter.flush
+      SessionCache.invalidate_all_caches
       nil
     end
 
@@ -219,27 +261,47 @@ module Facter
       nil
     end
 
-    # Register directories to be searched for custom facts. The registered directories
-    # must be absolute paths or they will be ignored.
+    # 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
     #
-    # @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.
@@ -263,15 +325,17 @@ 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
+      logger.debug("Facter version: #{Facter::VERSION}")
 
       resolved_facts = Facter::FactManager.instance.resolve_facts
-      Facter::SessionCache.invalidate_all_caches
-      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
@@ -286,7 +350,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)
@@ -305,10 +369,21 @@ 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)
+      log_blocked_facts
       resolved_facts = Facter::FactManager.instance.resolve_facts(user_queries)
-      Facter::SessionCache.invalidate_all_caches
+      resolved_facts.reject! { |fact| fact.type == :custom && fact.value.nil? }
 
       if user_queries.count.zero?
         Facter::FactCollection.new.build_fact_collection!(resolved_facts)
@@ -334,16 +409,20 @@ 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)
-      SessionCache.invalidate_all_caches
+      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
+    #
+    # @return [nil]
+    #
+    # @api public
     def log_exception(exception, message = nil)
       error_message = []
 
@@ -351,10 +430,10 @@ module Facter
 
       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
@@ -363,7 +442,6 @@ module Facter
     end
 
     # Logs the message parameter as a warning.
-    #
     # @param message [Object] the warning object to be displayed
     #
     # @return [nil]
@@ -375,7 +453,6 @@ module Facter
     end
 
     # Logs only once the same warning message.
-    #
     # @param message [Object] the warning message object
     #
     # @return [nil]
@@ -392,6 +469,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?
@@ -426,7 +512,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 }
@@ -451,14 +536,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

@@ -0,0 +1,385 @@
+# frozen_string_literal: true
+
+module Facter
+  module Config
+    unless defined?(OS_HIERARCHY)
+      OS_HIERARCHY = [
+        {
+          'Linux' => [
+            {
+              'Debian' => %w[
+                Elementary
+                Ubuntu
+                Raspbian
+              ]
+            },
+            {
+              'Rhel' => %w[
+                Fedora
+                Amzn
+                Centos
+                Ol
+                Scientific
+              ]
+            },
+            {
+              'Sles' => [
+                'Opensuse'
+              ]
+            }
+          ]
+        },
+        {
+          'Bsd' => [
+            'Freebsd'
+          ]
+        },
+        'Solaris',
+        'Macosx',
+        'Windows',
+        'Aix'
+      ].freeze
+    end
+    unless defined? FACT_GROUPS
+      FACT_GROUPS = {
+        'AIX NIM type' => [
+          'nim_type'
+        ],
+        'EC2' => %w[
+          ec2_metadata
+          ec2_userdata
+        ],
+        'GCE' => [
+          'gce'
+        ],
+        'Xen' => %w[
+          xen
+          xendomains
+        ],
+        'augeas' => %w[
+          augeas
+          augeasversion
+        ],
+        'desktop management interface' => %w[
+          dmi
+          bios_vendor
+          bios_version
+          bios_release_date
+          boardassettag
+          boardmanufacturer
+          boardproductname
+          boardserialnumber
+          chassisassettag
+          manufacturer
+          productname
+          serialnumber
+          uuid
+          chassistype
+        ],
+        'disks' => %w[
+          blockdevices
+          disks
+        ],
+        'file system' => %w[
+          mountpoints
+          filesystems
+          partitions
+        ],
+        'fips' => [
+          'fips_enabled'
+        ],
+        'hypervisors' => [
+          'hypervisors'
+        ],
+        'id' => %w[
+          id
+          gid
+          identity
+        ],
+        'kernel' => %w[
+          kernel
+          kernelversion
+          kernelrelease
+          kernelmajversion
+        ],
+        'load_average' => [
+          'load_averages'
+        ],
+        'memory' => %w[
+          memory
+          memoryfree
+          memoryfree_mb
+          memorysize
+          memorysize_mb
+          swapfree
+          swapfree_mb
+          swapsize
+          swapsize_mb
+          swapencrypted
+        ],
+        'networking' => %w[
+          networking
+          hostname
+          ipaddress
+          ipaddress6
+          netmask
+          netmask6
+          network
+          network6
+          scope6
+          macaddress
+          interfaces
+          domain
+          fqdn
+          dhcp_servers
+        ],
+        'operating system' => %w[
+          os
+          operatingsystem
+          osfamily
+          operatingsystemrelease
+          operatingsystemmajrelease
+          hardwaremodel
+          architecture
+          lsbdistid
+          lsbdistrelease
+          lsbdistcodename
+          lsbdistdescription
+          lsbmajdistrelease
+          lsbminordistrelease
+          lsbrelease
+          macosx_buildversion
+          macosx_productname
+          macosx_productversion
+          macosx_productversion_major
+          macosx_productversion_minor
+          windows_edition_id
+          windows_installation_type
+          windows_product_name
+          windows_release_id
+          system32
+          selinux
+          selinux_enforced
+          selinux_policyversion
+          selinux_current_mode
+          selinux_config_mode
+          selinux_config_policy
+        ],
+        'path' => [
+          'path'
+        ],
+        'processor' => %w[
+          processors
+          processorcount
+          physicalprocessorcount
+          hardwareisa
+        ],
+        'ssh' => %w[
+          ssh
+          sshdsakey
+          sshrsakey
+          sshecdsakey
+          sshed25519key
+          sshfp_dsa
+          sshfp_rsa
+          sshfp_ecdsa
+          sshfp_ed25519
+        ],
+        'system profiler' => %w[
+          system_profiler
+          sp_boot_mode
+          sp_boot_rom_version
+          sp_boot_volume
+          sp_cpu_type
+          sp_current_processor_speed
+          sp_kernel_version
+          sp_l2_cache_core
+          sp_l3_cache
+          sp_local_host_name
+          sp_machine_model
+          sp_machine_name
+          sp_number_processors
+          sp_os_version
+          sp_packages
+          sp_physical_memory
+          sp_platform_uuid
+          sp_secure_vm
+          sp_serial_number
+          sp_smc_version_system
+          sp_uptime
+          sp_user_name
+        ],
+        'timezone' => [
+          'timezone'
+        ],
+        'uptime' => %w[
+          system_uptime
+          uptime
+          uptime_days
+          uptime_hours
+          uptime_seconds
+        ],
+        'virtualization' => %w[
+          virtual
+          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',
+          'bios_release_date',
+          'bios_vendor',
+          'bios_version',
+          'blockdevice_*_model',
+          'blockdevice_*_size',
+          'blockdevice_*_vendor',
+          'blockdevices',
+          'boardassettag',
+          'boardmanufacturer',
+          'boardproductname',
+          'boardserialnumber',
+          'chassisassettag',
+          'chassistype',
+          'dhcp_servers',
+          'domain',
+          'fqdn',
+          'gid',
+          'hardwareisa',
+          'hardwaremodel',
+          'hostname',
+          'id',
+          'interfaces',
+          'ipaddress',
+          'ipaddress_.*',
+          'ipaddress_*',
+          'ipaddress6',
+          'ipaddress6_.*',
+          'ipaddress6_*',
+          'ldom_*',
+          'lsbdistcodename',
+          'lsbdistdescription',
+          'lsbdistid',
+          'lsbdistrelease',
+          'lsbmajdistrelease',
+          'lsbminordistrelease',
+          'lsbrelease',
+          'macaddress',
+          'macaddress_.*',
+          'macaddress_*',
+          'macosx_buildversion',
+          'macosx_productname',
+          'macosx_productversion',
+          'macosx_productversion_major',
+          'macosx_productversion_minor',
+          'manufacturer',
+          'memoryfree',
+          'memoryfree_mb',
+          'memorysize',
+          'memorysize_mb',
+          'mtu_.*',
+          'mtu_*',
+          'netmask',
+          'netmask_.*',
+          'netmask_*',
+          'netmask6',
+          'netmask6_.*',
+          'netmask6_*',
+          'network',
+          'network_.*',
+          'network_*',
+          'network6',
+          'network6_.*',
+          'network6_*',
+          'operatingsystem',
+          'operatingsystemmajrelease',
+          'operatingsystemrelease',
+          'osfamily',
+          'physicalprocessorcount',
+          'processor[0-9]+.*',
+          'processorcount',
+          'productname',
+          'rubyplatform',
+          'rubysitedir',
+          'rubyversion',
+          'scope6',
+          'scope6_.*',
+          'selinux',
+          'selinux_config_mode',
+          'selinux_config_policy',
+          'selinux_current_mode',
+          'selinux_enforced',
+          'selinux_policyversion',
+          'serialnumber',
+          'sp_*',
+          'sp_boot_mode',
+          'sp_boot_rom_version',
+          'sp_boot_volume',
+          'sp_cpu_type',
+          'sp_current_processor_speed',
+          'sp_kernel_version',
+          'sp_l2_cache_core',
+          'sp_l3_cache',
+          'sp_local_host_name',
+          'sp_machine_model',
+          'sp_machine_name',
+          'sp_number_processors',
+          'sp_os_version',
+          'sp_packages',
+          'sp_physical_memory',
+          'sp_platform_uuid',
+          'sp_secure_vm',
+          'sp_serial_number',
+          'sp_smc_version_system',
+          'sp_uptime',
+          'sp_user_name',
+          'ssh.*key',
+          'ssh*key',
+          'sshfp_.*',
+          'sshfp_*',
+          'swapencrypted',
+          'swapfree',
+          'swapfree_mb',
+          'swapsize',
+          'swapsize_mb',
+          'system32',
+          'uptime',
+          'uptime_days',
+          'uptime_hours',
+          'uptime_seconds',
+          'uuid',
+          'windows_edition_id',
+          'windows_installation_type',
+          'windows_product_name',
+          'windows_release_id',
+          'xendomains',
+          'zone_*_brand',
+          'zone_*_id',
+          'zone_*_iptype',
+          'zone_*_name',
+          'zone_*_path',
+          'zone_*_status',
+          'zone_*_uuid',
+          'zonename',
+          'zones'
+        ]
+      }.freeze
+    end
+  end
+end