facter 4.0.44 → 4.0.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26e4084c96b8e155bea96be6eb69c241acf2974bf31d98ebc20a571f191e3083
-  data.tar.gz: 8cfb10254f2474b003c7d5f4739b455302546258b3dd0b65b1768df6e1a38b1e
+  metadata.gz: 71eb4894f5e565033d547ffb64d562aee98c6b6a082bca7387259f9a779830d8
+  data.tar.gz: 95331a72cf0dc86fabbcad33447724a3a55b536c366bb8ba356428fddefd1587
 SHA512:
-  metadata.gz: 74e4755e3dedc6aedcba900d72577faa265f889b31b7ae60f6c85f0221f1e96f748c8b1342d9fc6ea7eafdf57dcacb675f3001465892b968f076c18432cfe9b7
-  data.tar.gz: cc030bcb93b65dddf47b5fdbbe39487a95f08794caf0f60985134c733f74a98ede9d0822c3647e9e0ab634eb9c336dd4a33a6f22d26ab8438f105787fbe74614
+  metadata.gz: 24caa700190be726fa0a7dc0f7dbbac290e073fab078c32b2b67d8a79c336daeab4c3254389a58e7bb4538706c8b8114d609173b78c31e7d676ca50d21a3bcb7
+  data.tar.gz: 9edcd692bfe2b0de59a6a6bf6f1700387e25da56127148ffd656edb901fc7fa47db7fe61eae3e4bf17ac8ddaa17e655c65ed366ef3fcc79db2a28e20ab1e6a37

data/lib/facter.rb

@@ -177,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
@@ -339,13 +351,15 @@ module Facter
     # @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
+    # @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)
 
       if user_queries.count.zero?

data/lib/facter/config.rb

@@ -117,6 +117,7 @@ module Facter
           domain
           fqdn
           dhcp_servers
+          scope6
         ],
         'operating system' => %w[
           os

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

@@ -98,16 +98,19 @@ module Facter
       # Execute a command and return the output of that program.
       # @param command [String] Command to run
       #
-      # @param options [Hash] Hash with options for the aggregate fact
+      # @param options [Hash] Hash with options for the command
       #
-      # @option options [Object] :on_fail How to behave when the command could
+      # Options accepted values :on_fail How to behave when the command could
       #   not be run. Specifying :raise will raise an error, anything else will
       #   return that object on failure. Default is :raise.
+      #   :logger Optional logger used to log the command's stderr.
+      #   :time_limit Optional time out for the specified command. If no time_limit is passed,
+      #   a default of 300 seconds is used.
       #
       # @raise [Facter::Core::Execution::ExecutionFailure] If the command does
-      #   not exist or could not be executed.
+      #   not exist or could not be executed and :on_fail is set to :raise
       #
-      # @return [String] the output of the program, or the value of :on_fail if
+      # @return [String] the output of the program, or the value of :on_fail (if it's different than :raise) if
       #   command execution failed and :on_fail was specified.
       #
       # @api public
@@ -115,6 +118,27 @@ module Facter
         @@impl.execute(command, options)
       end
 
+      # Execute a command and return the stdout and stderr of that program.
+      # @param command [String] Command to run
+      #
+      # @param on_fail[Object] How to behave when the command could
+      #   not be run. Specifying :raise will raise an error, anything else will
+      #   return that object on failure. Default is :raise.
+      # @param logger Optional logger used to log the command's stderr.
+      # @param time_limit Optional time out for the specified command. If no time_limit is passed,
+      #   a default of 300 seconds is used.
+      #
+      # @raise [Facter::Core::Execution::ExecutionFailure] If the command does
+      #   not exist or could not be executed and :on_fail is set to :raise
+      #
+      # @return [String, String] the stdout and stderr of the program, or the value of
+      #   :on_fail if command execution failed and :on_fail was specified.
+      #
+      # @api private
+      def execute_command(command, on_fail = nil, logger = nil, time_limit = nil)
+        @@impl.execute_command(command, on_fail, logger, time_limit)
+      end
+
       class ExecutionFailure < StandardError; end
     end
   end

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

@@ -4,7 +4,7 @@ module Facter
   module Core
     module Execution
       class Base
-        STDERR_MESSAGE = 'Command %s resulted with the following stderr message: %s'
+        STDERR_MESSAGE = 'Command %s completed with the following stderr message: %s'
 
         def initialize
           @log = Log.new(self)
@@ -57,39 +57,11 @@ module Facter
             return on_fail
           end
 
-          execute_command(expanded_command, on_fail, logger, time_limit)
+          out, = execute_command(expanded_command, on_fail, logger, time_limit)
+          out
         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?
-
-          if logger
-            logger.debug(format(STDERR_MESSAGE, command, msg.strip))
-          else
-            file_name = command.split('/').last
-            logger = Facter::Log.new(file_name)
-            logger.warn(format(STDERR_MESSAGE, command, msg.strip))
-          end
-        end
-
-        def builtin_command?(command)
-          output, _status = Open3.capture2("type #{command}")
-          output.chomp =~ /builtin/ ? true : false
-        end
-
-        def execute_command(command, on_fail, logger = nil, time_limit = nil)
+        def execute_command(command, on_fail = nil, logger = nil, time_limit = nil)
           time_limit ||= 300
           begin
             # Set LC_ALL and LANG to force i18n to C for the duration of this exec;
@@ -128,7 +100,35 @@ module Facter
                   "Failed while executing '#{command}': #{e.message}"
           end
 
-          out.strip
+          [out.strip, stderr]
+        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?
+
+          unless logger
+            file_name = command.split('/').last
+            logger = Facter::Log.new(file_name)
+          end
+
+          logger.debug(format(STDERR_MESSAGE, command, msg.strip))
+        end
+
+        def builtin_command?(command)
+          output, _status = Open3.capture2("type #{command}")
+          output.chomp =~ /builtin/ ? true : false
         end
       end
     end

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

@@ -8,6 +8,8 @@
 module LegacyFacter
   module Util
     module Parser
+      STDERR_MESSAGE = 'Command %s completed with the following stderr message: %s'
+
       @parsers = []
 
       # For support mutliple extensions you can pass an array of extensions as
@@ -75,6 +77,15 @@ module LegacyFacter
           res = KeyValuePairOutputFormat.parse output unless res.is_a?(Hash)
           res
         end
+
+        def log_stderr(msg, command, file)
+          return if !msg || msg.empty?
+
+          file_name = file.split('/').last
+          logger = Facter::Log.new(file_name)
+
+          logger.warn(format(STDERR_MESSAGE, command, msg.strip))
+        end
       end
 
       module KeyValuePairOutputFormat
@@ -139,7 +150,9 @@ module LegacyFacter
 
       class ScriptParser < Base
         def parse_results
-          parse_executable_output(Facter::Core::Execution.exec(quote(filename)))
+          stdout, stderr = Facter::Core::Execution.execute_command(quote(filename))
+          log_stderr(stderr, filename, filename)
+          parse_executable_output(stdout)
         end
 
         private
@@ -172,8 +185,9 @@ module LegacyFacter
 
           shell_command =
             "\"#{powershell}\" -NoProfile -NonInteractive -NoLogo -ExecutionPolicy Bypass -File \"#{filename}\""
-          output = Facter::Core::Execution.exec(shell_command)
-          parse_executable_output(output)
+          stdout, stderr = Facter::Core::Execution.execute_command(shell_command)
+          log_stderr(stderr, shell_command, filename)
+          parse_executable_output(stdout)
         end
       end
 

data/lib/facter/facts/solaris/hypervisors/ldom.rb

@@ -11,6 +11,9 @@ module Facts
         end
 
         def call_the_resolver
+          chassis_serial = Facter::Resolvers::Solaris::Ldom.resolve(:chassis_serial)
+          return Facter::ResolvedFact.new(FACT_NAME, nil) if !chassis_serial || chassis_serial.empty?
+
           fact_value = %i[
             chassis_serial control_domain domain_name
             domain_uuid role_control role_io role_root role_service

data/lib/facter/facts/solaris/ldom.rb

@@ -10,8 +10,11 @@ module Facts
       end
 
       def call_the_resolver
+        chassis_serial = resolve(:chassis_serial)
+        return Facter::ResolvedFact.new(FACT_NAME, nil) if !chassis_serial || chassis_serial.empty?
+
         fact_value = {
-          domainchassis: resolve(:chassis_serial),
+          domainchassis: chassis_serial,
           domaincontrol: resolve(:control_domain),
           domainname: resolve(:domain_name),
           domainrole: {

data/lib/facter/framework/cli/cli.rb

@@ -79,11 +79,6 @@ module Facter
                  type: :boolean,
                  desc: 'Show legacy facts when querying all facts.'
 
-    class_option :puppet,
-                 type: :boolean,
-                 aliases: '-p',
-                 desc: 'Load the Puppet libraries, thus allowing Facter to load Puppet-specific facts.'
-
     class_option :yaml,
                  aliases: '-y',
                  type: :boolean,
@@ -98,6 +93,10 @@ module Facter
                  aliases: '-t',
                  desc: 'Show how much time it took to resolve each fact'
 
+    class_option :sequential,
+                 type: :boolean,
+                 desc: 'Resolve facts sequentially'
+
     desc '--man', 'Display manual.', hide: true
     map ['--man'] => :man
     def man(*args)
@@ -157,6 +156,20 @@ module Facter
       puts cache_groups
     end
 
+    desc '--puppet, -p', '(NOT SUPPORTED)Load the Puppet libraries, thus allowing Facter to load Puppet-specific facts.'
+    map ['--puppet', '-p'] => :puppet
+    def puppet(*args)
+      log = Log.new(self)
+      log.warn('`facter --puppet` and `facter -p` are no longer supported, use `puppet facts show` instead')
+      log.warn('the output does not contain puppet facts!')
+
+      output, status = Facter.to_user_output(@options, *args)
+      puts output
+
+      status = 1 if Facter::Log.errors?
+      exit status
+    end
+
     desc 'help', 'Help for all arguments'
     def help(*args)
       help_string = +''
@@ -201,6 +214,7 @@ module Facter
       end
 
       def build_option(name, aliases, description)
+        name = name.tr('_', '-')
         help_option = +''
         help_option << aliases.join(',').rjust(10)
         help_option << ' '

data/lib/facter/framework/config/fact_groups.rb

@@ -4,10 +4,9 @@ require 'facter/config'
 
 module Facter
   class FactGroups
+    attr_accessor :groups_ttls
     attr_reader :groups, :block_list, :facts_ttls
 
-    @groups_ttls = []
-
     STRING_TO_SECONDS = { 'seconds' => 1, 'minutes' => 60, 'hours' => 3600, 'days' => 3600 * 24 }.freeze
 
     def initialize
@@ -38,7 +37,10 @@ module Facter
       fact = get_fact(fact_name)
       return fact[:group] if fact
 
-      @groups.detect { |k, v| break k if Array(v).find { |f| fact_name =~ /^#{f}.*/ } }
+      # @groups.detect { |k, v| break k if Array(v).find { |f| fact_name =~ /^#{f}.*/ } }
+      @groups.detect do |k, v|
+        break k if Array(v).find { |f| fact_name.include?('.*') ? fact_name == f : fact_name =~ /^#{f}.*/ }
+      end
     end
 
     # Get config ttls for a given group

data/lib/facter/framework/core/cache_manager.rb

@@ -10,7 +10,7 @@ module Facter
     end
 
     def resolve_facts(searched_facts)
-      return searched_facts, [] if !File.directory?(@cache_dir) || !Options[:cache]
+      return searched_facts, [] if (!File.directory?(@cache_dir) || !Options[:cache]) && Options[:ttls].any?
 
       facts = []
       searched_facts.delete_if do |fact|
@@ -27,8 +27,9 @@ module Facter
     end
 
     def cache_facts(resolved_facts)
-      return unless Options[:cache]
+      return unless Options[:cache] && Options[:ttls].any?
 
+      @groups = {}
       resolved_facts.each do |fact|
         cache_fact(fact)
       end
@@ -48,8 +49,8 @@ module Facter
                  false
                end
 
-      fact_group = @fact_groups.get_fact_group(fact_name)
-      delete_cache(fact_group) if fact_group && !cached
+      # fact_group = @fact_groups.get_fact_group(fact_name)
+      # delete_cache(fact_group) if fact_group && !cached
       cached
     end
 
@@ -66,6 +67,8 @@ module Facter
 
       fact = @fact_groups.get_fact(fact_name)
 
+      return if external_fact_in_custom_group?(searched_fact, fact_name, fact)
+
       return unless fact
 
       return unless check_ttls?(fact[:group], fact[:ttls])
@@ -73,6 +76,16 @@ module Facter
       read_fact(searched_fact, fact[:group])
     end
 
+    def external_fact_in_custom_group?(searched_fact, fact_name, fact)
+      if searched_fact.type == :file && fact[:group] != fact_name
+        @log.error("Cannot cache '#{fact_name}' fact from '#{fact[:group]}' group. "\
+                    'Caching custom group is not supported for external facts.')
+        return true
+      end
+
+      false
+    end
+
     def read_fact(searched_fact, fact_group)
       data = nil
       Facter::Framework::Benchmarking::Timer.measure(searched_fact.name, 'cached') do
@@ -80,27 +93,53 @@ module Facter
       end
       return unless data
 
+      unless searched_fact.file
+        return unless valid_format_version?(searched_fact, data, fact_group)
+
+        delete_cache(fact_group) unless data.keys.grep(/#{searched_fact.name}/).any?
+        # data.fetch(searched_fact.name) { delete_cache(fact_group) }
+      end
+
       @log.debug("loading cached values for #{searched_fact.name} facts")
 
       create_facts(searched_fact, data)
     end
 
+    def valid_format_version?(searched_fact, data, fact_group)
+      unless data['cache_format_version'] == 1
+        @log.debug("The fact #{searched_fact.name} could not be read from the cache, \
+cache_format_version is incorrect!")
+        delete_cache(fact_group)
+        return false
+      end
+
+      true
+    end
+
     def create_facts(searched_fact, data)
       if searched_fact.type == :file
-        facts = []
-        data.each do |fact_name, fact_value|
-          fact = Facter::ResolvedFact.new(fact_name, fact_value, searched_fact.type,
-                                          searched_fact.user_query, searched_fact.filter_tokens)
-          fact.file = searched_fact.file
-          facts << fact
-        end
-        facts
+        resolve_external_fact(searched_fact, data)
       else
+        return unless data[searched_fact.name]
+
         [Facter::ResolvedFact.new(searched_fact.name, data[searched_fact.name], searched_fact.type,
                                   searched_fact.user_query, searched_fact.filter_tokens)]
       end
     end
 
+    def resolve_external_fact(searched_fact, data)
+      facts = []
+      data.each do |fact_name, fact_value|
+        next if fact_name == 'cache_format_version'
+
+        fact = Facter::ResolvedFact.new(fact_name, fact_value, searched_fact.type,
+                                        searched_fact.user_query, searched_fact.filter_tokens)
+        fact.file = searched_fact.file
+        facts << fact
+      end
+      facts
+    end
+
     def cache_fact(fact)
       fact_name = if fact.file
                     File.basename(fact.file)
@@ -110,7 +149,7 @@ module Facter
 
       group_name = @fact_groups.get_fact_group(fact_name)
 
-      return if !group_name || fact.value.nil?
+      return unless group_name
 
       return unless fact_cache_enabled?(fact_name)
 
@@ -131,6 +170,8 @@ module Facter
         next if File.readable?(cache_file_name)
 
         @log.debug("caching values for #{group_name} facts")
+
+        data['cache_format_version'] = 1
         File.write(cache_file_name, JSON.pretty_generate(data))
       end
     end
@@ -142,7 +183,7 @@ module Facter
       data = nil
       file = Util::FileHelper.safe_read(cache_file_name)
       begin
-        data = JSON.parse(file)
+        data = JSON.parse(file) unless file.nil?
       rescue JSON::ParserError
         delete_cache(group_name)
       end
@@ -161,12 +202,13 @@ module Facter
         File.delete(cache_file_name)
       end
 
-      @log.debug("#{group_name} facts cache file expired/missing")
+      @log.debug("#{group_name} facts cache file expired, missing or is corrupt")
       true
     end
 
     def delete_cache(group_name)
       cache_file_name = File.join(@cache_dir, group_name)
+
       File.delete(cache_file_name) if File.readable?(cache_file_name)
     end
   end