facter 4.0.40 → 4.0.46

data/lib/facter/framework/benchmarking/timer.rb

@@ -7,11 +7,13 @@ module Facter
     module Benchmarking
       class Timer
         class << self
-          def measure(fact_name)
+          def measure(fact_name, prefix_message = '')
             if Options[:timing]
               time = Benchmark.measure { yield }
 
-              puts "fact `#{fact_name}`, took: #{time.format('%r')} seconds"
+              log = "fact '#{fact_name}', took: #{time.format('%r')} seconds"
+              prefix_message = "#{prefix_message} " unless prefix_message.empty?
+              puts "#{prefix_message}#{log}"
             else
               yield
             end

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

@@ -75,11 +75,6 @@ module Facter
                  type: :boolean,
                  desc: 'Enable verbose (info) output.'
 
-    class_option :puppet,
-                 type: :boolean,
-                 aliases: '-p',
-                 desc: 'Load the Puppet libraries, thus allowing Facter to load Puppet-specific facts.'
-
     class_option :show_legacy,
                  type: :boolean,
                  desc: 'Show legacy facts when querying all facts.'
@@ -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

@@ -1,17 +1,16 @@
 # frozen_string_literal: true
 
+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(group_list_path = nil)
-      default_path = File.join(File.dirname(__FILE__), '../../fact_groups.conf')
-      @groups_file_path = group_list_path || default_path
-      @groups ||= File.readable?(@groups_file_path) ? Hocon.load(@groups_file_path) : {}
+    def initialize
+      @groups = Facter::Config::FACT_GROUPS.dup
       load_groups
       load_groups_from_options
       load_facts_ttls
@@ -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
@@ -91,7 +93,7 @@ module Facter
 
     def load_groups
       config = ConfigReader.init(Options[:config])
-      @block_list = config.block_list || {}
+      @block_list = config.block_list || []
       @groups_ttls = config.ttls || []
       @groups.merge!(config.fact_groups) if config.fact_groups
     end

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,21 +49,25 @@ 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
 
     private
 
     def resolve_fact(searched_fact)
-      return unless fact_cache_enabled?(searched_fact.name)
+      fact_name = if searched_fact.file
+                    File.basename(searched_fact.file)
+                  else
+                    searched_fact.name
+                  end
+
+      return unless fact_cache_enabled?(fact_name)
+
+      fact = @fact_groups.get_fact(fact_name)
 
-      fact = if searched_fact.file
-               @fact_groups.get_fact(File.basename(searched_fact.file))
-             else
-               @fact_groups.get_fact(searched_fact.name)
-             end
+      return if external_fact_in_custom_group?(searched_fact, fact_name, fact)
 
       return unless fact
 
@@ -71,40 +76,82 @@ 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 = read_group_json(fact_group)
+      data = nil
+      Facter::Framework::Benchmarking::Timer.measure(searched_fact.name, 'cached') do
+        data = read_group_json(fact_group)
+      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)
-      group_name = if fact.file
-                     File.basename(fact.file)
-                   else
-                     @fact_groups.get_fact_group(fact.name)
-                   end
-      return if !group_name || fact.value.nil?
+      fact_name = if fact.file
+                    File.basename(fact.file)
+                  else
+                    fact.name
+                  end
+
+      group_name = @fact_groups.get_fact_group(fact_name)
 
-      return unless fact_cache_enabled?(fact.name)
+      return unless group_name
+
+      return unless fact_cache_enabled?(fact_name)
 
       @groups[group_name] ||= {}
       @groups[group_name][fact.name] = fact.value
@@ -123,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
@@ -134,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
@@ -153,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

data/lib/facter/framework/core/fact/internal/core_fact.rb

@@ -11,7 +11,12 @@ module Facter
 
       return unless fact_class
 
-      fact_class.new.call_the_resolver
+      fact_value = nil
+      Facter::Framework::Benchmarking::Timer.measure(@searched_fact.name) do
+        fact_value = fact_class.new.call_the_resolver
+      end
+
+      fact_value
     end
   end
 end

data/lib/facter/framework/core/fact/internal/internal_fact_manager.rb

@@ -7,7 +7,15 @@ module Facter
     def resolve_facts(searched_facts)
       internal_searched_facts = filter_internal_facts(searched_facts)
 
-      resolved_facts = resolve(internal_searched_facts)
+      resolved_facts = if Options[:sequential]
+                         @@log.debug('Resolving facts sequentially')
+                         resolve_sequentially(internal_searched_facts)
+                       else
+                         @@log.debug('Resolving fact in parallel')
+                         threads = start_threads(internal_searched_facts)
+                         join_threads(threads, internal_searched_facts)
+                       end
+
       nil_resolved_facts = resolve_nil_facts(searched_facts)
 
       resolved_facts.concat(nil_resolved_facts)
@@ -28,7 +36,7 @@ module Facter
       resolved_facts
     end
 
-    def resolve(searched_facts)
+    def resolve_sequentially(searched_facts)
       resolved_facts = []
 
       searched_facts
@@ -36,8 +44,7 @@ module Facter
         .each do |searched_fact|
         begin
           fact = CoreFact.new(searched_fact)
-          fact_value = nil
-          Facter::Framework::Benchmarking::Timer.measure(searched_fact.name) { fact_value = fact.create }
+          fact_value = fact.create
           resolved_facts << fact_value unless fact_value.nil?
         rescue StandardError => e
           @@log.log_exception(e)
@@ -47,5 +54,32 @@ module Facter
       resolved_facts.flatten!
       FactAugmenter.augment_resolved_facts(searched_facts, resolved_facts)
     end
+
+    def start_threads(searched_facts)
+      # only resolve a fact once, even if multiple search facts depend on that fact
+      searched_facts
+        .uniq { |searched_fact| searched_fact.fact_class.name }
+        .map do |searched_fact|
+        Thread.new do
+          resolve_fact(searched_fact)
+        end
+      end
+    end
+
+    def join_threads(threads, searched_facts)
+      resolved_facts = threads.map(&:value)
+      resolved_facts.compact!
+      resolved_facts.flatten!
+
+      FactAugmenter.augment_resolved_facts(searched_facts, resolved_facts)
+    end
+
+    def resolve_fact(searched_fact)
+      fact = CoreFact.new(searched_fact)
+      fact.create
+    rescue StandardError => e
+      @@log.log_exception(e)
+      nil
+    end
   end
 end

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

@@ -16,7 +16,7 @@ module Facter
     private_class_method def self.get_resolved_facts_for_searched_fact(searched_fact, resolved_facts)
       if searched_fact.name.include?('.*')
         resolved_facts
-          .select { |resolved_fact| resolved_fact.name.match(searched_fact.user_query) }
+          .select { |resolved_fact| resolved_fact.name.match(searched_fact.name) }
           .reject(&:user_query)
           .uniq(&:name)
       else

data/lib/facter/framework/core/fact_loaders/fact_loader.rb

@@ -84,7 +84,7 @@ module Facter
 
       blocked_facts.each do |blocked|
         facts.each do |fact|
-          next unless fact.name =~ /^#{blocked}/
+          next unless fact.name =~ /^#{blocked}\..*|^#{blocked}$/
 
           if fact.type == :core
             reject_list_core << fact

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

@@ -27,8 +27,8 @@ module Facter
 
       resolved_facts = override_core_facts(internal_facts, external_facts)
 
-      cache_manager.cache_facts(resolved_facts)
       resolved_facts = resolved_facts.concat(cached_facts)
+      cache_manager.cache_facts(resolved_facts)
 
       FactFilter.new.filter_facts!(resolved_facts)
 

data/lib/facter/framework/core/options/config_file_options.rb

@@ -19,14 +19,18 @@ module Facter
       private
 
       def augment_all
-        if Options.cli?
-          augment_cli(Facter::ConfigReader.cli)
-          augment_ruby(Facter::ConfigReader.global)
-        end
+        augment_cli(Facter::ConfigReader.cli) if Options.cli?
+        augment_globals
+        augment_facts(Facter::ConfigReader.ttls, Facter::ConfigReader.fact_groups)
+      end
+
+      def augment_globals
+        augment_ruby(Facter::ConfigReader.global)
+
         augment_custom(Facter::ConfigReader.global)
         augment_external(Facter::ConfigReader.global)
         augment_show_legacy(Facter::ConfigReader.global)
-        augment_facts(Facter::ConfigReader.ttls, Facter::ConfigReader.fact_groups)
+        augment_sequential(Facter::ConfigReader.global)
       end
 
       def augment_config_path(config_path)
@@ -68,6 +72,7 @@ module Facter
 
       def augment_ruby(global_conf)
         return unless global_conf
+        return unless Options.cli?
 
         @options[:no_ruby] = global_conf['no-ruby'].nil? ? false : global_conf['no-ruby']
       end
@@ -78,6 +83,12 @@ module Facter
         @options[:show_legacy] = global_conf['show-legacy'] unless global_conf['show-legacy'].nil?
       end
 
+      def augment_sequential(global_conf)
+        return unless global_conf
+
+        @options[:sequential] = global_conf['sequential'] unless global_conf['sequential'].nil?
+      end
+
       def augment_facts(ttls, groups)
         fact_groups = Facter::FactGroups.new