facter 4.0.28

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

@@ -0,0 +1,55 @@
+module Facter
+  module Core
+    module Execution
+      class Posix < Facter::Core::Execution::Base
+        DEFAULT_SEARCH_PATHS = ['/sbin', '/usr/sbin'].freeze
+
+        def search_paths
+          # Make sure custom_facts is usable even for non-root users. Most commands
+          # in /sbin (like ifconfig) can be run as non privileged users as
+          # long as they do not modify anything - which we do not do with custom_facts
+          ENV['PATH'].split(File::PATH_SEPARATOR) + DEFAULT_SEARCH_PATHS
+        end
+
+        def which(bin)
+          if absolute_path?(bin)
+            return bin if File.executable?(bin) && FileTest.file?(bin)
+          else
+            search_paths.each do |dir|
+              dest = File.join(dir, bin)
+              return dest if File.executable?(dest) && FileTest.file?(dest)
+            end
+          end
+          nil
+        end
+
+        ABSOLUTE_PATH_REGEX = %r{^/}.freeze
+
+        def absolute_path?(path)
+          !!(path =~ ABSOLUTE_PATH_REGEX)
+        end
+
+        DOUBLE_QUOTED_COMMAND = /^"(.+?)"(?:\s+(.*))?/.freeze
+        SINGLE_QUOTED_COMMAND = /^'(.+?)'(?:\s+(.*))?/.freeze
+
+        def expand_command(command)
+          exe = nil
+          args = nil
+
+          if (match = (command.match(DOUBLE_QUOTED_COMMAND) || command.match(SINGLE_QUOTED_COMMAND)))
+            exe, args = match.captures
+          else
+            exe, args = command.split(/ /, 2)
+          end
+
+          return unless exe && (expanded = which(exe))
+
+          expanded = "'#{expanded}'" if expanded =~ /\s/
+          expanded << " #{args}" if args
+
+          expanded
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module Facter
+  module Core
+    module Execution
+      class Windows < Facter::Core::Execution::Base
+        def search_paths
+          ENV['PATH'].split(File::PATH_SEPARATOR)
+        end
+
+        DEFAULT_COMMAND_EXTENSIONS = %w[.COM .EXE .BAT .CMD].freeze
+
+        def which(bin)
+          if absolute_path?(bin)
+            return bin if File.executable?(bin)
+          else
+            search_paths.each do |dir|
+              dest = File.join(dir, bin)
+              dest.gsub!(File::SEPARATOR, File::ALT_SEPARATOR)
+              if File.extname(dest).empty?
+                exts = ENV['PATHEXT']
+                exts = exts ? exts.split(File::PATH_SEPARATOR) : DEFAULT_COMMAND_EXTENSIONS
+                exts.each do |ext|
+                  destext = dest + ext
+                  return destext if File.executable?(destext)
+                end
+              end
+              return dest if File.executable?(dest)
+            end
+          end
+          nil
+        end
+
+        slash = '[\\\\/]'
+        name = '[^\\\\/]+'
+        ABSOLUTE_PATH_REGEX =
+          /^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))/i.freeze
+
+        def absolute_path?(path)
+          !!(path =~ ABSOLUTE_PATH_REGEX)
+        end
+
+        DOUBLE_QUOTED_COMMAND = /^"(.+?)"(?:\s+(.*))?/.freeze
+
+        def expand_command(command)
+          exe = nil
+          args = nil
+
+          if (match = command.match(DOUBLE_QUOTED_COMMAND))
+            exe, args = match.captures
+          else
+            exe, args = command.split(/ /, 2)
+          end
+
+          return unless exe && (expanded = which(exe))
+
+          expanded = "\"#{expanded}\"" if expanded =~ /\s+/
+          expanded << " #{args}" if args
+
+          expanded
+        end
+
+        def execute(command, options = {})
+          expand = options.fetch(:expand, true)
+          raise ArgumentError.new, 'Unsupported argument on Windows expand with value false' unless expand
+
+          super(command, options)
+        end
+      end
+    end
+  end
+end

data/lib/custom_facts/core/file_loader.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "#{ROOT_DIR}/lib/custom_facts/version"
+require "#{ROOT_DIR}/lib/custom_facts/core/logging"
+require "#{ROOT_DIR}/lib/custom_facts/core/legacy_facter"
+require "#{ROOT_DIR}/lib/custom_facts/util/fact"
+require "#{ROOT_DIR}/lib/custom_facts/util/collection"
+require "#{ROOT_DIR}/lib/custom_facts/util/fact"
+require "#{ROOT_DIR}/lib/custom_facts/util/loader"
+require "#{ROOT_DIR}/lib/custom_facts/core/execution/base"
+require "#{ROOT_DIR}/lib/custom_facts/core/execution/windows"
+require "#{ROOT_DIR}/lib/custom_facts/core/execution/posix"
+require "#{ROOT_DIR}/lib/custom_facts/util/values"
+require "#{ROOT_DIR}/lib/custom_facts/util/confine"
+
+require "#{ROOT_DIR}/lib/custom_facts/util/config"
+
+require "#{ROOT_DIR}/lib/custom_facts/util/normalization"
+require "#{ROOT_DIR}/lib/custom_facts/core/execution"
+require "#{ROOT_DIR}/lib/custom_facts/core/resolvable"
+require "#{ROOT_DIR}/lib/custom_facts/core/suitable"
+require "#{ROOT_DIR}/lib/custom_facts/util/resolution"
+require "#{ROOT_DIR}/lib/custom_facts/core/directed_graph"
+require "#{ROOT_DIR}/lib/custom_facts/core/resolvable"
+require "#{ROOT_DIR}/lib/custom_facts/core/aggregate"
+require "#{ROOT_DIR}/lib/custom_facts/util/composite_loader"
+require "#{ROOT_DIR}/lib/custom_facts/util/parser"
+require "#{ROOT_DIR}/lib/custom_facts/util/directory_loader"
+require "#{ROOT_DIR}/lib/custom_facts/util/nothing_loader"
+require "#{ROOT_DIR}/lib/custom_facts/util/nothing_loader"

data/lib/custom_facts/core/legacy_facter.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+# Facter - Host Fact Detection and Reporting
+#
+# Copyright 2011 Puppet Labs Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'pathname'
+
+ROOT_DIR = Pathname.new(File.expand_path('../../../', __dir__)) unless defined?(ROOT_DIR)
+require "#{ROOT_DIR}/lib/custom_facts/core/file_loader"
+
+# Functions as a hash of 'facts' about your system system, such as MAC
+# address, IP address, architecture, etc.
+#
+# @example Retrieve a fact
+#     puts Facter['operatingsystem'].value
+#
+# @example Retrieve all facts
+#   Facter.to_hash
+#    => { "kernel"=>"Linux", "uptime_days"=>0, "ipaddress"=>"10.0.0.1" }
+#
+# @api public
+module LegacyFacter
+  # Most core functionality of custom_facts is implemented in `Facter::Util`.
+  # @api public
+
+  include Comparable
+  include Enumerable
+
+  extend LegacyFacter::Core::Logging
+
+  # module methods
+
+  # Accessor for the collection object which holds all the facts
+  # @return [LegacyFacter::Util::Collection] the collection of facts
+  #
+  # @api private
+  def self.collection
+    unless defined?(@collection) && @collection
+      @collection = LegacyFacter::Util::Collection.new(
+        LegacyFacter::Util::Loader.new,
+        LegacyFacter::Util::Config.ext_fact_loader
+      )
+    end
+    @collection
+  end
+
+  # Returns whether the JSON "feature" is available.
+  #
+  # @api private
+  def self.json?
+    require 'json'
+    true
+  rescue LoadError
+    false
+  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
+  #
+  # @return [Facter::Util::Fact, nil] The fact object, or nil if no fact
+  #   is found.
+  #
+  # @api public
+  def self.[](name)
+    collection.fact(name)
+  end
+
+  # (see [])
+  def self.fact(name)
+    collection.fact(name)
+  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 self.flush
+    collection.flush
+  end
+
+  # Lists all fact names
+  #
+  # @return [Array<String>] array of fact names
+  #
+  # @api public
+  def self.list
+    collection.list
+  end
+
+  # Gets the value for a fact. Returns `nil` if no such fact exists.
+  #
+  # @param name [String] the fact name
+  # @return [Object, nil] the value of the fact, or nil if no fact is
+  #   found
+  #
+  # @api public
+  def self.value(name)
+    collection.value(name)
+  end
+
+  # Gets a hash mapping fact names to their values
+  #
+  # @return [Hash{String => Object}] the hash of fact names and values
+  #
+  # @api public
+  def self.to_hash
+    collection.load_all
+    collection.to_hash
+  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
+  # @see {Facter::Util::Collection#define_fact}
+  def self.define_fact(name, options = {}, &block)
+    collection.define_fact(name, options, &block)
+  end
+
+  # Adds a {Facter::Util::Resolution resolution} mechanism for a named
+  # fact. This does not distinguish between adding a new fact and adding
+  # a new way to resolve a fact.
+  #
+  # @overload add(name, options = {}, { || ... })
+  # @param name [String] the fact name
+  # @param options [Hash] optional parameters for the fact - attributes
+  #   of {Facter::Util::Fact} and {Facter::Util::Resolution} can be
+  #   supplied here
+  # @option options [Integer] :timeout set the
+  #   {Facter::Util::Resolution#timeout timeout} for this resolution
+  # @param block [Proc] a block defining a fact resolution
+  #
+  # @return [Facter::Util::Fact] the fact object, which includes any previously
+  #   defined resolutions
+  #
+  # @api public
+  def self.add(name, options = {}, &block)
+    collection.add(name, options, &block)
+  end
+
+  # Iterates over fact names and values
+  #
+  # @yieldparam [String] name the fact name
+  # @yieldparam [String] value the current value of the fact
+  #
+  # @return [void]
+  #
+  # @api public
+  def self.each
+    # Make sure all facts are loaded.
+    collection.load_all
+
+    collection.each do |*args|
+      yield(*args)
+    end
+  end
+
+  # Clears all cached values and removes all facts from memory.
+  #
+  # @return [void]
+  #
+  # @api public
+  def self.clear
+    LegacyFacter.flush
+    LegacyFacter.reset
+  end
+
+  # Removes all facts from memory. Use this when the fact code has
+  # changed on disk and needs to be reloaded.
+  #
+  # @return [void]
+  #
+  # @api public
+  def self.reset
+    @collection = nil
+  end
+
+  # Loads all facts.
+  #
+  # @return [void]
+  #
+  # @api public
+  def self.loadfacts
+    collection.load_all
+  end
+end

data/lib/custom_facts/core/logging.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module LegacyFacter
+  module Core
+    module Logging
+      extend self
+
+      # @api private
+      GREEN = "\e[0;32m"
+      # @api private
+      RESET = "\e[0m"
+
+      RED = "\e[31m"
+
+      # @api private
+      @@debug = false
+      # @api private
+      @@timing = false
+      # @api private
+      @@trace = false
+
+      # @api private
+      @@warn_messages = {}
+      # @api private
+      @@debug_messages = {}
+
+      # @api private
+      @@message_callback = nil
+
+      # Used to register a callback that is called when a message is logged.
+      # If a block is given, Facter will not log messages.
+      # If a block is not given, Facter will resume logging messages.
+      # @param block [Proc] the callback to call when a message is logged.
+      #   The first argument to the callback will be a symbol representing a level. The supported
+      #   levels are: :trace, :debug, :info, :warn, :error, and :fatal.
+      #   The second argument to the callback will be a string containing the message
+      #   that was logged.
+      # @api public
+      def on_message(&block)
+        @@message_callback = block
+      end
+
+      # Prints a debug message if debugging is turned on
+      #
+      # @param msg [String] the debug message
+      # @return [void]
+      def debug(msg)
+        return unless debugging?
+
+        if msg.nil? || msg.empty?
+          invoker = caller(1..1).first.slice(/.*:\d+/)
+          self.warn "#{self.class}#debug invoked with invalid message #{msg.inspect}:#{msg.class} at #{invoker}"
+        elsif @@message_callback
+          @@message_callback.call(:debug, msg)
+        else
+          puts GREEN + msg + RESET
+        end
+      end
+
+      # Prints a debug message only once.
+      #
+      # @note Uniqueness is based on the string, not the specific location
+      #   of the method call.
+      #
+      # @param msg [String] the debug message
+      # @return [void]
+      def debugonce(msg)
+        return unless msg && !msg.empty? && @@debug_messages[msg].nil?
+
+        @@debug_messages[msg] = true
+        debug(msg)
+      end
+
+      # Prints a warning message. The message is only printed if debugging
+      # is enabled.
+      #
+      # @param msg [String] the warning message to be printed
+      #
+      # @return [void]
+      def warn(msg)
+        if msg.nil? || msg.empty?
+          invoker = caller(1..1).first.slice(/.*:\d+/)
+          msg = "#{self.class}#debug invoked with invalid message #{msg.inspect}:#{msg.class} at #{invoker}"
+        end
+        if @@message_callback
+          @@message_callback.call(:warn, msg)
+        else
+          Kernel.warn msg
+        end
+      end
+
+      # Prints a warning message only once per process. Each unique string
+      # is printed once.
+      #
+      # @note Unlike {warn} the message will be printed even if debugging is
+      #   not turned on. This behavior is likely to change and should not be
+      #   relied on.
+      #
+      # @param msg [String] the warning message to be printed
+      #
+      # @return [void]
+      def warnonce(msg)
+        return unless @@warn_messages[msg].nil?
+
+        self.warn(msg)
+        @@warn_messages[msg] = true
+      end
+
+      def log_exception(exception, message = :default)
+        self.warn(format_exception(exception, message, @@trace))
+      end
+
+      def format_exception(exception, message, trace)
+        arr = []
+
+        if message == :default
+          arr << exception.message
+        elsif message
+          arr << message
+        end
+
+        if trace
+          arr << 'backtrace:'
+          arr.concat(exception.backtrace)
+        end
+
+        "#{RED}#{arr.flatten.join("\n")}#{RESET}"
+      end
+
+      # Print an exception message, and optionally a backtrace if trace is set
+
+      # Print timing information
+      #
+      # @param string [String] the time to print
+      # @return [void]
+      #
+      # @api private
+      def show_time(string)
+        return unless string && timing?
+
+        if @@message_callback
+          @@message_callback.call(:info, string)
+        else
+          $stderr.puts "#{GREEN}#{string}#{RESET}"
+        end
+      end
+
+      # Enable or disable logging of debug messages
+      #
+      # @param bool [true, false]
+      # @return [void]
+      #
+      # @api private
+      def debugging(bool)
+        @@debug = bool
+      end
+
+      # Is debugging enabled?
+      #
+      # @return [true, false]
+      #
+      # @api private
+      def debugging?
+        @@debug
+      end
+
+      # Enable or disable logging of timing information
+      #
+      # @param bool [true, false]
+      # @return [void]
+      #
+      # @api private
+      def timing(bool)
+        @@timing = bool
+      end
+
+      # Returns whether timing output is turned on
+      #
+      # @api private
+      def timing?
+        @@timing
+      end
+
+      def trace(bool)
+        @@trace = bool
+      end
+
+      def trace?
+        @@trace
+      end
+
+      # Clears the seen state of debug and warning messages. See {debugonce} and {warnonce}.
+      #
+      # @return [void]
+      #
+      # @api private
+      def clear_messages
+        @@debug_messages.clear
+        @@warn_messages.clear
+      end
+    end
+  end
+end