facter 4.0.35 → 4.0.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 310bcaf0123dcbfdc035568dd69e5701204fdd47286c4f1a57cc2cec1bb310f2
-  data.tar.gz: 1165a5771b7da00ba62b0869b3c951a475466cf99d959090e7ff168565076134
+  metadata.gz: 64bb37710d33d522370161fab93516fed5961615ff3fc44609ee6700318efda4
+  data.tar.gz: 47e222b78a6a4ce13ee4d0fc91cbcca942b4b3c9357e35debbc2ea61d401867c
 SHA512:
-  metadata.gz: e3a8f6a079db9d1ab380205953ea1f325ab4274de480ba49ef4e1d162e6ff3058ee78ac89ef845fb19949806d53d857cc0f8f9ff651d346ff71179a5fd6b682d
-  data.tar.gz: 0270a90dd9010adc24a61cb00c31b4ebade6847a2d8697d56bef09ea8e66ce6417e7298885bf3c8cd36ccc90917c5ba7e25c0efe81e795b8fd5df90d43c5d308
+  metadata.gz: 4bb85c358a104d83fde58ad5ce0733736f5e2295324d1041e79d24c5c08cf284f2eb32c30b9024a5f216713b8a12a92a01249aab0346aec016ebeecc1c77d82f
+  data.tar.gz: 2f079a4fc5788d5e4c5698d0b5ad31cfc7affa352b19d636c077faa3125e342ba14e4d1c3d53a1684112cd9a76c27365fe9f2f9713502ea52b8d4ceffd56eee7

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

@@ -13,8 +13,31 @@ module Facter
   Options.init
   Log.output(STDOUT)
   @already_searched = {}
+  @debug_once = []
+  @warn_once = []
 
   class << self
+    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
+
     def clear_messages
       logger.debug('clear_messages is not implemented')
     end
@@ -54,6 +77,8 @@ module Facter
     # @api public
     def clear
       @already_searched = {}
+      @debug_once = []
+      @warn_once = []
       LegacyFacter.clear
       Options[:custom_dir] = []
       LegacyFacter.collection.invalidate_custom_facts
@@ -68,24 +93,54 @@ module Facter
       fact_collection.dig(*splitted_user_query)
     end
 
-    # Prints out a debug message when debug option is set to true
-    # @param msg [String] Message to be printed out
+    # Logs debug message when debug option is set to true
+    # @param message [Object] Message object to be logged
+    #
+    # @return [nil]
+    #
+    # @api public
+    def debug(message)
+      return unless debugging?
+
+      logger.debug(message.to_s)
+      nil
+    end
+
+    # Logs the same debug message only once when debug option is set to true
+    # @param message [Object] Message object to be logged
     #
     # @return [nil]
     #
     # @api public
-    def debug(msg)
+    def debugonce(message)
       return unless debugging?
 
-      logger.debug(msg)
+      message_string = message.to_s
+      return if @debug_once.include? message_string
+
+      @debug_once << message_string
+      logger.debug(message_string)
       nil
     end
 
+    # Define a new fact or extend an existing fact.
+    #
+    # @param name [Symbol] The name of the fact to define
+    # @param options [Hash] A hash of options to set on the fact
+    #
+    # @return [Facter::Util::Fact] The fact that was defined
+    #
+    # @api public
+    def define_fact(name, options = {}, &block)
+      options[:fact_type] = :custom
+      LegacyFacter.define_fact(name, options, &block)
+    end
+
     def on_message(&block)
       Facter::Log.on_message(&block)
     end
 
-    # Check whether debuging is enabled
+    # Check whether debugging is enabled
     #
     # @return [bool]
     #
@@ -104,11 +159,31 @@ module Facter
       Facter::Options[:debug] = debug_bool
     end
 
+    # Iterates over fact names and values
+    #
+    # @yieldparam [String] name the fact name
+    # @yieldparam [String] value the current value of the fact
+    #
+    # @return [Facter]
+    #
+    # @api public
+    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)
+      end
+
+      self
+    end
+
     # Returns a fact object by name.  If you use this, you still have to
     # call {Facter::Util::Fact#value `value`} on it to retrieve the actual
     # value.
     #
-    # @param name [String] the name of the fact
+    # @param user_query [String] the name of the fact
     #
     # @return [Facter::Util::Fact, nil] The fact object, or nil if no fact
     #   is found.
@@ -134,6 +209,16 @@ module Facter
       nil
     end
 
+    # Loads all facts
+    #
+    # @return [nil]
+    #
+    # @api public
+    def loadfacts
+      LegacyFacter.loadfacts
+      nil
+    end
+
     # Register directories to be searched for custom facts. The registered directories
     # must be absolute paths or they will be ignored.
     #
@@ -199,7 +284,7 @@ module Facter
     end
 
     # Enable or disable trace
-    # @param debug_bool [bool] Set trace on debug state
+    # @param bool [bool] Set trace on debug state
     #
     # @return [type] [description]
     #
@@ -210,7 +295,7 @@ module Facter
 
     # Gets the value for a fact. Returns `nil` if no such fact exists.
     #
-    # @param name [String] the fact name
+    # @param user_query [String] the fact name
     # @return [String] the value of the fact, or nil if no fact is found
     #
     # @api public
@@ -220,6 +305,18 @@ module Facter
       @already_searched[user_query]&.value
     end
 
+    def values(options, user_queries)
+      init_cli_options(options, user_queries)
+      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)
+      else
+        FormatterHelper.retrieve_facts_to_display_for_user_query(user_queries, resolved_facts)
+      end
+    end
+
     # Returns Facter version
     #
     # @return [String] Current version
@@ -247,23 +344,67 @@ 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
+    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"))
+    end
+
+    # Returns a list with the names of all solved facts
+    #
+    # @return [Array] the list with all the fact names
+    #
+    # @api public
+    def list
+      to_hash.keys.sort
+    end
+
+    # Logs the message parameter as a warning.
+    #
+    # @param message [Object] the warning object to be displayed
+    #
+    # @return [nil]
+    #
+    # @api public
+    def warn(message)
+      logger.warn(message.to_s)
+      nil
+    end
+
+    # Logs only once the same warning message.
+    #
+    # @param message [Object] the warning message object
+    #
+    # @return [nil]
+    #
+    # @api public
+    def warnonce(message)
+      message_string = message.to_s
+      return if @warn_once.include? message_string
+
+      @warn_once << message_string
+      logger.warn(message_string)
+      nil
     end
 
     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
@@ -303,10 +444,9 @@ module Facter
     # Returns exit status when user query contains facts that do
     #   not exist
     #
-    # @param dirs [Array] Arguments sent to CLI
-    # @param dirs [Array] List of resolved facts
+    # @param resolved_facts [Array] List of resolved facts
     #
-    # @return [Integer, nil] Will return status 1 if user query contains
+    # @return [1/nil] Will return status 1 if user query contains
     #  facts that are not found or resolved, otherwise it will return nil
     #
     # @api private

data/lib/facter/custom_facts/core/execution/base.rb

@@ -6,6 +6,10 @@ module Facter
       class Base
         STDERR_MESSAGE = 'Command %s resulted with the following stderr message: %s'
 
+        def initialize
+          @log = Log.new(self)
+        end
+
         # This is part of the public API. No race condition can happen
         # here because custom facts are executed sequentially
         def with_env(values)
@@ -36,9 +40,7 @@ module Facter
         end
 
         def execute(command, options = {})
-          on_fail = options.fetch(:on_fail, :raise)
-          expand = options.fetch(:expand, true)
-          logger = options[:logger]
+          on_fail, expand, logger, time_limit = extract_options(options)
 
           expanded_command = if !expand && builtin_command?(command) || logger
                                command
@@ -55,11 +57,21 @@ module Facter
             return on_fail
           end
 
-          execute_command(expanded_command, on_fail, logger)
+          execute_command(expanded_command, on_fail, logger, time_limit)
         end
 
         private
 
+        def extract_options(options)
+          on_fail = options.fetch(:on_fail, :raise)
+          expand = options.fetch(:expand, true)
+          logger = options[:logger]
+          time_limit = options[:limit].to_i
+          time_limit = time_limit.positive? ? time_limit : nil
+
+          [on_fail, expand, logger, time_limit]
+        end
+
         def log_stderr(msg, command, logger)
           return if !msg || msg.empty?
 
@@ -77,12 +89,30 @@ module Facter
           output.chomp =~ /builtin/ ? true : false
         end
 
-        def execute_command(command, on_fail, logger = nil)
+        def execute_command(command, on_fail, logger = nil, time_limit = nil)
+          time_limit ||= 1.5
           begin
             # Set LC_ALL and LANG to force i18n to C for the duration of this exec;
             # this ensures that any code that parses the
             # output of the command can expect it to be in a consistent / predictable format / locale
-            out, stderr, _status_ = Open3.capture3({ 'LC_ALL' => 'C', 'LANG' => 'C' }, command.to_s)
+            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
+              output = +''
+              err = +''
+              begin
+                Timeout.timeout(time_limit) do
+                  output << stdout.read
+                  err << stderr.read
+                end
+              rescue Timeout::Error
+                @log.debug("Timeout encounter after #{time_limit}s, killing process with pid: #{pid}")
+                Process.kill('KILL', pid)
+              end
+              [output, err]
+            end
             log_stderr(stderr, command, logger)
           rescue StandardError => e
             return '' if logger

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

@@ -35,6 +35,7 @@ module LegacyFacter
       def initialize(dir = LegacyFacter::Util::Config.external_facts_dirs, weight = EXTERNAL_FACT_WEIGHT)
         @directories = [dir].flatten
         @weight = weight
+        @log ||= Facter::Log.new(self)
       end
 
       # Load facts from files in fact directory using the relevant parser classes to
@@ -58,7 +59,7 @@ module LegacyFacter
           basename = File.basename(file)
           next if file_blocked?(basename)
 
-          if facts.find { |f| f.name == basename } && cm.group_cached?(basename)
+          if facts.find { |f| f.name == basename } && cm.fact_cache_enabled?(basename)
             Facter.log_exception(Exception.new("Caching is enabled for group \"#{basename}\" while "\
               'there are at least two external facts files with the same filename'))
           else
@@ -83,11 +84,12 @@ module LegacyFacter
           parser = LegacyFacter::Util::Parser.parser_for(fact.file)
           next if parser.nil?
 
-          data = parser.results
+          data = resolve_fact(fact, parser)
+
           if data == false
             LegacyFacter.warn "Could not interpret fact file #{fact.file}"
           elsif (data == {}) || data.nil?
-            LegacyFacter.warn "Fact file #{fact.file} was parsed but returned an empty data set"
+            @log.debug("Fact file #{fact.file} was parsed but no key=>value data was returned")
           else
             data.each do |p, v|
               collection.add(p, value: v, fact_type: :external,
@@ -97,6 +99,14 @@ module LegacyFacter
         end
       end
 
+      def resolve_fact(fact, parser)
+        data = nil
+        fact_name = File.basename(fact.file)
+        Facter::Framework::Benchmarking::Timer.measure(fact_name) { data = parser.results }
+
+        data
+      end
+
       def entries
         dirs = @directories.select { |directory| File.directory?(directory) }.map do |directory|
           Dir.entries(directory).map { |directory_entry| File.join(directory, directory_entry) }

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

@@ -118,7 +118,10 @@ module Facter
 
         searching do
           suitable_resolutions = sort_by_weight(find_suitable_resolutions(@resolves))
-          @value = find_first_real_value(suitable_resolutions)
+
+          Facter::Framework::Benchmarking::Timer.measure(@name) do
+            @value = find_first_real_value(suitable_resolutions)
+          end
 
           announce_when_no_suitable_resolution(suitable_resolutions)
           announce_when_no_value_found(@value)

data/lib/facter/fact_groups.conf

@@ -165,5 +165,144 @@
 		"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"
 	]
-}
+}