facter 4.0.40 → 4.0.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64bb37710d33d522370161fab93516fed5961615ff3fc44609ee6700318efda4
-  data.tar.gz: 47e222b78a6a4ce13ee4d0fc91cbcca942b4b3c9357e35debbc2ea61d401867c
+  metadata.gz: 71eb4894f5e565033d547ffb64d562aee98c6b6a082bca7387259f9a779830d8
+  data.tar.gz: 95331a72cf0dc86fabbcad33447724a3a55b536c366bb8ba356428fddefd1587
 SHA512:
-  metadata.gz: 4bb85c358a104d83fde58ad5ce0733736f5e2295324d1041e79d24c5c08cf284f2eb32c30b9024a5f216713b8a12a92a01249aab0346aec016ebeecc1c77d82f
-  data.tar.gz: 2f079a4fc5788d5e4c5698d0b5ad31cfc7affa352b19d636c077faa3125e342ba14e4d1c3d53a1684112cd9a76c27365fe9f2f9713502ea52b8d4ceffd56eee7
+  metadata.gz: 24caa700190be726fa0a7dc0f7dbbac290e073fab078c32b2b67d8a79c336daeab4c3254389a58e7bb4538706c8b8114d609173b78c31e7d676ca50d21a3bcb7
+  data.tar.gz: 9edcd692bfe2b0de59a6a6bf6f1700387e25da56127148ffd656edb901fc7fa47db7fe61eae3e4bf17ac8ddaa17e655c65ed366ef3fcc79db2a28e20ab1e6a37

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
 
@@ -220,26 +262,26 @@ module Facter
     end
 
     # Register directories to be searched for custom facts. The registered directories
-    # must be absolute paths or they will be ignored.
-    #
+    #   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,14 +305,13 @@ 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
 
       resolved_facts = Facter::FactManager.instance.resolve_facts
-      Facter::SessionCache.invalidate_all_caches
       Facter::FactCollection.new.build_fact_collection!(resolved_facts)
     end
 
@@ -286,7 +327,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 +346,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)
+      Options[:show_legacy] = true
+      log_blocked_facts
       resolved_facts = Facter::FactManager.instance.resolve_facts(user_queries)
-      Facter::SessionCache.invalidate_all_caches
 
       if user_queries.count.zero?
         Facter::FactCollection.new.build_fact_collection!(resolved_facts)
@@ -336,7 +388,6 @@ module Facter
       logger.info("executed with command line: #{ARGV.drop(1).join(' ')}")
       log_blocked_facts
       resolved_facts = Facter::FactManager.instance.resolve_facts(args)
-      SessionCache.invalidate_all_caches
       fact_formatter = Facter::FormatterFactory.build(Facter::Options.get)
 
       status = error_check(resolved_facts)
@@ -344,6 +395,11 @@ module Facter
       [fact_formatter.format(resolved_facts), status || 0]
     end
 
+    # Logs an exception and an optional message
+    #
+    # @return [nil]
+    #
+    # @api public
     def log_exception(exception, message = nil)
       error_message = []
 
@@ -351,10 +407,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 +419,6 @@ module Facter
     end
 
     # Logs the message parameter as a warning.
-    #
     # @param message [Object] the warning object to be displayed
     #
     # @return [nil]
@@ -375,7 +430,6 @@ module Facter
     end
 
     # Logs only once the same warning message.
-    #
     # @param message [Object] the warning message object
     #
     # @return [nil]
@@ -426,7 +480,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 }

data/lib/facter/config.rb

@@ -0,0 +1,355 @@
+# 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 = {
+        'EC2' => %w[
+          ec2_metadata
+          ec2_userdata
+        ],
+        'GCE' => [
+          'gce'
+        ],
+        '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
+        ],
+        'file system' => %w[
+          mountpoints
+          filesystems
+          partitions
+        ],
+        '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
+          macaddress
+          interfaces
+          domain
+          fqdn
+          dhcp_servers
+          scope6
+        ],
+        '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
+        ],
+        '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.*',
+          'processor*',
+          '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