facter 4.0.25 → 4.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 258f3076e55739266049906ec76f9813481b5289a90e45ba96ad06ff59e4bc8c
-  data.tar.gz: 5797140df4c3063e3121bf5d9118aa23975c563517181c17263607a27c1939ec
+  metadata.gz: 58032c19dc544418cdd5bdc8598a48d6d8cc2b9c67f3ef3ac081fe98cf03ac6a
+  data.tar.gz: db8bd43f5f28c4c7ea30d67c2ecb02367d398b70c2096fa5ee5f0319c2473640
 SHA512:
-  metadata.gz: f810ad19ee6d8246684844aa388979089d4283ddea1dccb5cbdf3e1116c87f383a194e5ceb88c7c1894578196980271c6b6f0a435edaf89e0b0699e65b6aacc4
-  data.tar.gz: 828a1dadd8c44eb2dedfd1e6c4b8a1bfc77c05794bcad4e9cae5ad251f3e8a18f85b4b0c9ed6f3cb9be7f3ed6233e3a9d3a33bb34186e9c69be2b51bcad11a3a
+  metadata.gz: 52a387b13db0d8064f5cfc7e968b1b8c65843098071e04b662ee76a5c57bbdf5cbcbc669230a30544007fecc648645553496e4ccf000eba81cf7dbb0e6103d90
+  data.tar.gz: 61e0b00e59b79820c2ec91118c8bba3b3d692bc620807a29341e0cc2530565d574fd80648167547e55d556db145176ca78d126f2e8ff7f4093155c95534fe5a5

data/bin/facter

@@ -2,5 +2,10 @@
 # frozen_string_literal: true
 
 require 'pathname'
-ROOT_DIR = Pathname.new(File.expand_path('..', __dir__)) unless defined?(ROOT_DIR)
-require "#{ROOT_DIR}/lib/framework/cli/cli_launcher.rb"
+require 'facter/framework/cli/cli_launcher.rb'
+
+cli_launcher = CliLauncher.new(ARGV)
+
+cli_launcher.validate_options
+cli_launcher.prepare_arguments
+cli_launcher.start

data/lib/facter.rb

@@ -3,10 +3,9 @@
 require 'pathname'
 require_relative 'util/api_debugger' if ENV['API_DEBUG']
 
-ROOT_DIR = Pathname.new(File.expand_path('..', __dir__)) unless defined?(ROOT_DIR)
-
-require "#{ROOT_DIR}/lib/framework/core/file_loader"
-require "#{ROOT_DIR}/lib/framework/core/options/options_validator"
+require 'facter/version'
+require 'facter/framework/core/file_loader'
+require 'facter/framework/core/options/options_validator'
 
 module Facter
   class ResolveCustomFactError < StandardError; end
@@ -14,7 +13,6 @@ module Facter
   Options.init
   Log.output(STDOUT)
   @already_searched = {}
-  @trace = false
 
   class << self
     def clear_messages
@@ -197,7 +195,7 @@ module Facter
     #
     # @api public
     def trace?
-      @trace
+      Options[:trace]
     end
 
     # Enable or disable trace
@@ -207,7 +205,7 @@ module Facter
     #
     # @api public
     def trace(bool)
-      @trace = bool
+      Options[:trace] = bool
     end
 
     # Gets the value for a fact. Returns `nil` if no such fact exists.
@@ -228,8 +226,7 @@ module Facter
     #
     # @api public
     def version
-      version_file = ::File.join(ROOT_DIR, 'VERSION')
-      ::File.read(version_file).strip
+      Facter::VERSION
     end
 
     # Gets a hash mapping fact names to their values
@@ -245,7 +242,7 @@ module Facter
       SessionCache.invalidate_all_caches
       fact_formatter = Facter::FormatterFactory.build(Facter::Options.get)
 
-      status = error_check(args, resolved_facts)
+      status = error_check(resolved_facts)
 
       [fact_formatter.format(resolved_facts), status || 0]
     end
@@ -257,7 +254,7 @@ module Facter
       elsif message
         arr << message
       end
-      if @trace
+      if Options[:trace]
         arr << 'backtrace:'
         arr.concat(exception.backtrace)
       end
@@ -289,6 +286,9 @@ module Facter
       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 }
       fact_collection = FactCollection.new.build_fact_collection!(resolved_facts)
       splitted_user_query = Facter::Utils.split_user_query(user_query)
 
@@ -310,9 +310,10 @@ module Facter
     #  facts that are not found or resolved, otherwise it will return nil
     #
     # @api private
-    def error_check(args, resolved_facts)
+    def error_check(resolved_facts)
       if Options[:strict]
-        missing_names = args - resolved_facts.map(&:user_query).uniq
+        missing_names = resolved_facts.select { |fact| fact.type == :nil }.map(&:user_query)
+
         if missing_names.count.positive?
           status = 1
           log_errors(missing_names)

data/lib/{custom_facts → facter/custom_facts}/core/aggregate.rb

@@ -48,6 +48,10 @@ module Facter
         @deps = LegacyFacter::Core::DirectedGraph.new
       end
 
+      def <=>(other)
+        weight <=> other.weight
+      end
+
       def options(options)
         accepted_options = %i[name timeout weight fact_type]
         accepted_options.each do |option_name|

data/lib/{custom_facts → facter/custom_facts}/core/execution/base.rb

@@ -6,6 +6,8 @@ module Facter
       class Base
         STDERR_MESSAGE = 'Command %s resulted with the following stderr message: %s'
 
+        # This is part of the public API. No race condition can happen
+        # here because custom facts are executed sequentially
         def with_env(values)
           old = {}
           values.each do |var, value|
@@ -38,27 +40,22 @@ module Facter
           expand = options.fetch(:expand, true)
           logger = options[:logger]
 
-          # 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
-          with_env 'LC_ALL' => 'C', 'LANG' => 'C' do
-            expanded_command = if !expand && builtin_command?(command) || logger
-                                 command
-                               else
-                                 expand_command(command)
-                               end
+          expanded_command = if !expand && builtin_command?(command) || logger
+                               command
+                             else
+                               expand_command(command)
+                             end
 
-            if expanded_command.nil?
-              if on_fail == :raise
-                raise Facter::Core::Execution::ExecutionFailure.new,
-                      "Could not execute '#{command}': command not found"
-              end
-
-              return on_fail
+          if expanded_command.nil?
+            if on_fail == :raise
+              raise Facter::Core::Execution::ExecutionFailure.new,
+                    "Could not execute '#{command}': command not found"
             end
 
-            execute_command(expanded_command, on_fail, logger)
+            return on_fail
           end
+
+          execute_command(expanded_command, on_fail, logger)
         end
 
         private
@@ -82,7 +79,10 @@ module Facter
 
         def execute_command(command, on_fail, logger = nil)
           begin
-            out, stderr, _status_ = Open3.capture3(command.to_s)
+            # 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)
             log_stderr(stderr, command, logger)
           rescue StandardError => e
             return '' if logger

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'facter/custom_facts/core/logging'
+require 'facter/custom_facts/core/legacy_facter'
+require 'facter/custom_facts/util/fact'
+require 'facter/custom_facts/util/collection'
+require 'facter/custom_facts/util/fact'
+require 'facter/custom_facts/util/loader'
+require 'facter/custom_facts/core/execution/base'
+require 'facter/custom_facts/core/execution/windows'
+require 'facter/custom_facts/core/execution/posix'
+require 'facter/custom_facts/util/values'
+require 'facter/custom_facts/util/confine'
+
+require 'facter/custom_facts/util/config'
+
+require 'facter/custom_facts/util/normalization'
+require 'facter/custom_facts/core/execution'
+require 'facter/custom_facts/core/resolvable'
+require 'facter/custom_facts/core/suitable'
+require 'facter/custom_facts/util/resolution'
+require 'facter/custom_facts/core/directed_graph'
+require 'facter/custom_facts/core/resolvable'
+require 'facter/custom_facts/core/aggregate'
+require 'facter/custom_facts/util/composite_loader'
+require 'facter/custom_facts/util/parser'
+require 'facter/custom_facts/util/directory_loader'
+require 'facter/custom_facts/util/nothing_loader'
+require 'facter/custom_facts/util/nothing_loader'

data/lib/{custom_facts → facter/custom_facts}/core/legacy_facter.rb

@@ -18,8 +18,7 @@
 
 require 'pathname'
 
-ROOT_DIR = Pathname.new(File.expand_path('../../../', __dir__)) unless defined?(ROOT_DIR)
-require "#{ROOT_DIR}/lib/custom_facts/core/file_loader"
+require 'facter/custom_facts/core/file_loader'
 
 # Functions as a hash of 'facts' about your system system, such as MAC
 # address, IP address, architecture, etc.

data/lib/{custom_facts → facter/custom_facts}/util/collection.rb

@@ -95,8 +95,7 @@ module LegacyFacter
         return @external_facts unless @external_facts.nil?
 
         load_external_facts
-        external_facts = @facts.select { |_k, v| v.options[:fact_type] == :external }
-        @external_facts = Facter::Utils.deep_copy(external_facts.keys)
+        @external_facts = @facts.select { |_k, v| v.options[:fact_type] == :external }
       end
 
       def invalidate_custom_facts
@@ -148,11 +147,7 @@ module LegacyFacter
 
       def value(name)
         fact = fact(name)
-        fact_value = fact&.value
-        return Facter.core_value(name) if fact_value.nil?
-
-        core_value = Facter.core_value(name) if fact.used_resolution_weight <= 0
-        core_value.nil? ? fact_value : core_value
+        fact&.value
       end
 
       private

data/lib/{custom_facts → facter/custom_facts}/util/config.rb

@@ -8,7 +8,7 @@ module LegacyFacter
   module Util
     module Config
       def self.ext_fact_loader
-        @ext_fact_loader || LegacyFacter::Util::DirectoryLoader.default_loader
+        @ext_fact_loader || LegacyFacter::Util::DirectoryLoader.new
       end
 
       def self.ext_fact_loader=(loader)

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+# A Facter plugin that loads external facts.
+#
+# Default Unix Directories:
+# /opt/puppetlabs/custom_facts/facts.d, /etc/custom_facts/facts.d, /etc/puppetlabs/custom_facts/facts.d
+#
+# Beginning with Facter 3, only /opt/puppetlabs/custom_facts/facts.d will be a default external fact
+# directory in Unix.
+#
+# Default Windows Direcotires:
+# C:\ProgramData\Puppetlabs\custom_facts\facts.d (2008)
+# C:\Documents and Settings\All Users\Application Data\Puppetlabs\custom_facts\facts.d (2003)
+#
+# Can also load from command-line specified directory
+#
+# Facts can be in the form of JSON, YAML or Text files
+# and any executable that returns key=value pairs.
+
+require 'yaml'
+
+module LegacyFacter
+  module Util
+    class DirectoryLoader
+      class NoSuchDirectoryError < RuntimeError
+      end
+
+      # This value makes it highly likely that external facts will take
+      # precedence over all other facts
+      EXTERNAL_FACT_WEIGHT = 10_000
+
+      # Directory for fact loading
+      attr_reader :directories
+
+      def initialize(dir = LegacyFacter::Util::Config.external_facts_dirs, weight = EXTERNAL_FACT_WEIGHT)
+        @directories = [dir].flatten
+        @weight = weight
+      end
+
+      # Load facts from files in fact directory using the relevant parser classes to
+      # parse them.
+      def load(collection)
+        weight = @weight
+
+        searched_facts, cached_facts = load_directory_entries(collection)
+
+        load_cached_facts(collection, cached_facts, weight)
+
+        load_searched_facts(collection, searched_facts, weight)
+      end
+
+      private
+
+      def load_directory_entries(_collection)
+        cm = Facter::CacheManager.new
+        facts = []
+        entries.each do |file|
+          basename = File.basename(file)
+          if facts.find { |f| f.name == basename } && cm.group_cached?(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
+            searched_fact = Facter::SearchedFact.new(basename, nil, [], nil, :file)
+            searched_fact.file = file
+            facts << searched_fact
+          end
+        end
+
+        cm.resolve_facts(facts)
+      end
+
+      def load_cached_facts(collection, cached_facts, weight)
+        cached_facts.each do |cached_fact|
+          collection.add(cached_fact.name, value: cached_fact.value, fact_type: :external,
+                                           file: cached_fact.file) { has_weight(weight) }
+        end
+      end
+
+      def load_searched_facts(collection, searched_facts, weight)
+        searched_facts.each do |fact|
+          parser = LegacyFacter::Util::Parser.parser_for(fact.file)
+          next if parser.nil?
+
+          data = parser.results
+          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"
+          else
+            data.each do |p, v|
+              collection.add(p, value: v, fact_type: :external,
+                                file: fact.file) { has_weight(weight) }
+            end
+          end
+        end
+      end
+
+      def entries
+        dirs = @directories.select { |directory| File.directory?(directory) }.map do |directory|
+          Dir.entries(directory).map { |directory_entry| File.join(directory, directory_entry) }
+        end
+        dirs.flatten.select { |f| should_parse?(f) }
+      rescue Errno::ENOENT
+        []
+      end
+
+      def should_parse?(file)
+        File.basename(file) !~ /^\./
+      end
+    end
+  end
+end

data/lib/{custom_facts → facter/custom_facts}/util/fact.rb

@@ -123,8 +123,10 @@ module Facter
           announce_when_no_suitable_resolution(suitable_resolutions)
           announce_when_no_value_found(@value)
 
-          @value
+          @value = resolve_value
         end
+
+        @value
       end
 
       # @api private
@@ -138,6 +140,13 @@ module Facter
 
       private
 
+      def resolve_value
+        return Facter.core_value(name) if @value.nil?
+
+        core_value = Facter.core_value(name) if @used_resolution_weight <= 0
+        core_value.nil? ? @value : core_value
+      end
+
       # Are we in the midst of a search?
       def searching?
         @searching

data/lib/{custom_facts → facter/custom_facts}/util/loader.rb

@@ -39,6 +39,8 @@ module LegacyFacter
 
         paths = search_path
         paths&.each do |dir|
+          # clean the search path of wrong slashes and backslashes
+          dir = dir.gsub(%r{[\/\\]+}, File::SEPARATOR)
           # dir is already an absolute path
           Dir.glob(File.join(dir, '*.rb')).each do |path|
             # exclude dirs that end with .rb

data/lib/{custom_facts → facter/custom_facts}/util/parser.rb

@@ -56,7 +56,7 @@ module LegacyFacter
         # wrapper.
         def results
           parse_results
-        rescue Exception => e
+        rescue StandardError => e
           Facter.log_exception(e, "Failed to handle #{filename} as #{self.class} facts: #{e.message}")
           nil
         end
@@ -68,8 +68,8 @@ module LegacyFacter
         def parse_executable_output(output)
           res = nil
           begin
-            res = YAML.safe_load output
-          rescue Exception => e
+            res = YAML.safe_load(output, [Symbol, Time])
+          rescue StandardError => e
             Facter.debug("Could not parse executable fact output as YAML or JSON (#{e.message})")
           end
           res = KeyValuePairOutputFormat.parse output unless res.is_a?(Hash)