facter 4.0.39 → 4.0.44

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1cc7c2dc4026c1c24f4140c319b3ac68c5b77dd1b42e61c46f07facff044380
-  data.tar.gz: 3565addd16973284508cfc3058aab779dcf3bb30d4c65257fc9831cee898a380
+  metadata.gz: 26e4084c96b8e155bea96be6eb69c241acf2974bf31d98ebc20a571f191e3083
+  data.tar.gz: 8cfb10254f2474b003c7d5f4739b455302546258b3dd0b65b1768df6e1a38b1e
 SHA512:
-  metadata.gz: ca715b689b8b050d20021ed104770a75737fed542236826592068d01066adfc369b222dbf94f2d1eb867c5b3d2023689f8ebd458f690f3f969e98c1c39375ddb
-  data.tar.gz: cf6be422f902d75dcbf6fb6d147c3c95f718ab2129a18756b0ffe0626f3cfb3fd4f652a8c9f3278801826a7e15e35e9574cf11e22780593f79db315c6aa3b87b
+  metadata.gz: 74e4755e3dedc6aedcba900d72577faa265f889b31b7ae60f6c85f0221f1e96f748c8b1342d9fc6ea7eafdf57dcacb675f3001465892b968f076c18432cfe9b7
+  data.tar.gz: cc030bcb93b65dddf47b5fdbbe39487a95f08794caf0f60985134c733f74a98ede9d0822c3647e9e0ab634eb9c336dd4a33a6f22d26ab8438f105787fbe74614

data/bin/facter

@@ -4,8 +4,7 @@
 require 'pathname'
 require 'facter/framework/cli/cli_launcher.rb'
 
-cli_launcher = CliLauncher.new(ARGV)
+Facter::OptionsValidator.validate(ARGV)
+processed_arguments = CliLauncher.prepare_arguments(ARGV)
 
-cli_launcher.validate_options
-cli_launcher.prepare_arguments
-cli_launcher.start
+CliLauncher.start(processed_arguments)

data/lib/facter.rb

@@ -17,8 +17,31 @@ module Facter
   @warn_once = []
 
   class << self
-    def clear_messages
-      logger.debug('clear_messages is not implemented')
+    # 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'
+
+      args = args_as_string.split(' ')
+
+      Facter::OptionsValidator.validate(args)
+      processed_arguments = CliLauncher.prepare_arguments(args, nil)
+
+      cli = Facter::Cli.new([], processed_arguments)
+
+      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, [])
+      else
+        cli.invoke(:arg_parser)
+      end
     end
 
     # Alias method for Facter.fact()
@@ -62,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])
@@ -115,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
@@ -149,7 +188,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)
@@ -185,6 +223,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
 
@@ -199,26 +250,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.
@@ -242,14 +293,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
 
@@ -265,7 +315,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)
@@ -284,6 +334,27 @@ 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 [String] the fact names
+    #
+    # @return [FactCollection] hash with fact names and values
+    #
+    # @api public
+    def values(options, user_queries)
+      init_cli_options(options, user_queries)
+      resolved_facts = Facter::FactManager.instance.resolve_facts(user_queries)
+
+      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
@@ -303,7 +374,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)
@@ -311,23 +381,22 @@ module Facter
       [fact_formatter.format(resolved_facts), status || 0]
     end
 
-    def log_exception(exception, message = :default)
-      arr = []
-      if message == :default
-        arr << exception.message
-      elsif message
-        arr << message
-      end
-      if Options[:trace]
-        arr << 'backtrace:'
-        arr.concat(exception.backtrace)
-      end
+    # Logs an exception and an optional message
+    #
+    # @return [nil]
+    #
+    # @api public
+    def log_exception(exception, message = nil)
+      error_message = []
+
+      error_message << message.to_s unless message.nil? || (message.is_a?(String) && message.empty?)
 
-      logger.error(arr.flatten.join("\n"))
+      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
@@ -336,7 +405,6 @@ module Facter
     end
 
     # Logs the message parameter as a warning.
-    #
     # @param message [Object] the warning object to be displayed
     #
     # @return [nil]
@@ -348,7 +416,6 @@ module Facter
     end
 
     # Logs only once the same warning message.
-    #
     # @param message [Object] the warning message object
     #
     # @return [nil]
@@ -365,6 +432,19 @@ module Facter
 
     private
 
+    def parse_exception(exception, error_message)
+      if exception.is_a?(Exception)
+        error_message << exception.message if error_message.empty?
+
+        if Options[:trace] && !exception.backtrace.nil?
+          error_message << 'backtrace:'
+          error_message.concat(exception.backtrace)
+        end
+      elsif error_message.empty?
+        error_message << exception.to_s
+      end
+    end
+
     def logger
       @logger ||= Log.new(self)
     end
@@ -386,7 +466,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,354 @@
+# 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
+        ],
+        '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