facter 4.0.39 → 4.0.44

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

@@ -18,22 +18,31 @@ module Facter
       include LegacyFacter::Core::Resolvable
 
       # @!attribute [r] name
-      #   @return [Symbol] The name of the aggregate resolution
+      #
+      # @return [Symbol] The name of the aggregate resolution
+      #
+      # @api public
       attr_reader :name
 
       # @!attribute [r] deps
-      #   @api private
-      #   @return [LegacyFacter::Core::DirectedGraph]
+      #
+      # @return [LegacyFacter::Core::DirectedGraph]
+      #
+      # @api private
       attr_reader :deps
 
       # @!attribute [r] confines
-      #   @return [Array<LegacyFacter::Core::Confine>] An array of confines restricting
-      #     this to a specific platform
-      #   @see Facter::Core::Suitable
+      #
+      # @return [Array<LegacyFacter::Core::Confine>] An array of confines restricting
+      #  this to a specific platform
+      #
+      # @api private
       attr_reader :confines
 
       # @!attribute [r] fact
+      #
       # @return [Facter::Util::Fact]
+      #
       # @api private
       attr_reader :fact
 
@@ -48,10 +57,20 @@ module Facter
         @deps = LegacyFacter::Core::DirectedGraph.new
       end
 
+      # Compares the weight of two aggregate facts
+      #
+      # @return [bool] Weight comparison result
+      #
+      # @api private
       def <=>(other)
         weight <=> other.weight
       end
 
+      # Sets options for the aggregate fact
+      #
+      # @return [nil]
+      #
+      # @api private
       def options(options)
         accepted_options = %i[name timeout weight fact_type]
         accepted_options.each do |option_name|
@@ -60,14 +79,17 @@ module Facter
         raise ArgumentError, "Invalid aggregate options #{options.keys.inspect}" unless options.keys.empty?
       end
 
+      # Evaluates the given block
+      #
+      # @return [String] Result of the block's evaluation
+      #
+      # @api private
       def evaluate(&block)
         instance_eval(&block)
       end
 
       # Define a new chunk for the given aggregate
       #
-      # @api public
-      #
       # @example Defining a chunk with no dependencies
       #   aggregate.chunk(:mountpoints) do
       #     # generate mountpoint information
@@ -80,14 +102,14 @@ module Facter
       #   end
       #
       # @param name [Symbol] A name unique to this aggregate describing the chunk
-      # @param opts [Hash]
-      # @options opts [Array<Symbol>, Symbol] :require One or more chunks
-      #   to evaluate and pass to this block.
-      # @yield [*Object] Zero or more chunk results
       #
-      # @return [void]
+      # @param opts [Hash] Hash with options for the aggregate fact
+      #
+      # @return [Facter::Core::Aggregate] The aggregate object
+      #
+      # @api public
       def chunk(name, opts = {}, &block)
-        raise ArgumentError, "#{self.class.name}#chunk requires a block" unless block_given?
+        evaluate_params(name, &block)
 
         deps = Array(opts.delete(:require))
 
@@ -97,12 +119,11 @@ module Facter
 
         @deps[name] = deps
         @chunks[name] = block
+        self
       end
 
       # Define how all chunks should be combined
       #
-      # @api public
-      #
       # @example Merge all chunks
       #   aggregate.aggregate do |chunks|
       #     final_result = {}
@@ -124,19 +145,32 @@ module Facter
       # @yield [Hash<Symbol, Object>] A hash containing chunk names and
       #   chunk values
       #
-      # @return [void]
+      # @return [Facter::Core::Aggregate] The aggregate fact
+      #
+      # @api public
       def aggregate(&block)
         raise ArgumentError, "#{self.class.name}#aggregate requires a block" unless block_given?
 
         @aggregate = block
+        self
       end
 
+      # Returns the fact's resolution type
+      #
+      # @return [Symbol] The fact's type
+      #
+      # @api private
       def resolution_type
         :aggregate
       end
 
       private
 
+      def evaluate_params(name)
+        raise ArgumentError, "#{self.class.name}#chunk requires a block" unless block_given?
+        raise ArgumentError, "#{self.class.name}#expected chunk name to be a Symbol" unless name.is_a? Symbol
+      end
+
       # Evaluate the results of this aggregate.
       #
       # @see Facter::Core::Resolvable#value

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

@@ -3,10 +3,6 @@
 module Facter
   module Core
     module Execution
-      # require_relative 'execution/base'
-      # require_relative 'execution/windows'
-      # require_relative 'execution/posix'
-
       @@impl = if LegacyFacter::Util::Config.windows?
                  Facter::Core::Execution::Windows.new
                else
@@ -20,24 +16,22 @@ module Facter
       module_function
 
       # Returns the locations to be searched when looking for a binary. This
-      # is currently determined by the +PATH+ environment variable plus
-      # `/sbin` and `/usr/sbin` when run on unix
+      #   is currently determined by the +PATH+ environment variable plus
+      #   `/sbin` and `/usr/sbin` when run on unix
+      #
+      # @return [Array<String>] The paths to be searched for binaries
       #
-      # @return [Array<String>] the paths to be searched for binaries
       # @api private
       def search_paths
         @@impl.search_paths
       end
 
       # Determines the full path to a binary. If the supplied filename does not
-      # already describe an absolute path then different locations (determined
-      # by {search_paths}) will be searched for a match.
+      #   already describe an absolute path then different locations (determined
+      #   by {search_paths}) will be searched for a match.
+      # @param bin [String] The executable to locate
       #
-      # Returns nil if no matching executable can be found otherwise returns
-      # the expanded pathname.
-      #
-      # @param bin [String] the executable to locate
-      # @return [String,nil] the full path to the executable or nil if not
+      # @return [String/nil] The full path to the executable or nil if not
       #   found
       #
       # @api public
@@ -46,10 +40,12 @@ module Facter
       end
 
       # Determine in a platform-specific way whether a path is absolute. This
-      # defaults to the local platform if none is specified.
+      #   defaults to the local platform if none is specified.
+      # @param path [String] The path to check
+
+      # @param platform [:posix/:windows/nil] The platform logic to use
       #
-      # @param path [String] the path to check
-      # @param platform [:posix,:windows,nil] the platform logic to use
+      # @api private
       def absolute_path?(path, platform = nil)
         case platform
         when :posix
@@ -62,38 +58,35 @@ module Facter
       end
 
       # Given a command line, this returns the command line with the
-      # executable written as an absolute path. If the executable contains
-      # spaces, it has be put in double quotes to be properly recognized.
-      #
+      #   executable written as an absolute path. If the executable contains
+      #   spaces, it has to be put in double quotes to be properly recognized.
       # @param command [String] the command line
       #
-      # @return [String, nil] the command line with the executable's path
-      # expanded, or nil if the executable cannot be found.
+      # @return [String/nil] The command line with the executable's path
+      #   expanded, or nil if the executable cannot be found.
+      #
+      # @api private
       def expand_command(command)
         @@impl.expand_command(command)
       end
 
       # Overrides environment variables within a block of code.  The
-      # specified values will be set for the duration of the block, after
-      # which the original values (if any) will be restored.
-      #
-      # @overload with_env(values, { || ... })
-      #
+      #   specified values will be set for the duration of the block, after
+      #   which the original values (if any) will be restored.
       # @param values [Hash<String=>String>] A hash of the environment
       #   variables to override
       #
-      # @return [void]
+      # @return [String] The block's return string
       #
-      # @api public
+      # @api private
       def with_env(values, &block)
         @@impl.with_env(values, &block)
       end
 
       # Try to execute a command and return the output.
+      # @param command [String] Command to run
       #
-      # @param code [String] the program to run
-      #
-      # @return [String] the output of the program, or nil if the command does
+      # @return [String/nil] Output of the program, or nil if the command does
       #   not exist or could not be executed.
       #
       # @deprecated Use #{execute} instead
@@ -103,9 +96,9 @@ module Facter
       end
 
       # Execute a command and return the output of that program.
+      # @param command [String] Command to run
       #
-      # @param code [String] the program to run
-      # @param options [Hash]
+      # @param options [Hash] Hash with options for the aggregate fact
       #
       # @option options [Object] :on_fail How to behave when the command could
       #   not be run. Specifying :raise will raise an error, anything else will
@@ -118,7 +111,6 @@ module Facter
       #   command execution failed and :on_fail was specified.
       #
       # @api public
-      # @since 2.0.1
       def execute(command, options = {})
         @@impl.execute(command, options)
       end

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

@@ -90,7 +90,7 @@ module Facter
         end
 
         def execute_command(command, on_fail, logger = nil, time_limit = nil)
-          time_limit ||= 1.5
+          time_limit ||= 300
           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
@@ -100,18 +100,24 @@ module Facter
             @log.debug("Executing command: #{command}")
             out, stderr = Open3.popen3(opts, command.to_s) do |_, stdout, stderr, wait_thr|
               pid = wait_thr.pid
-              output = +''
-              err = +''
+              stdout_messages = +''
+              stderr_messages = +''
+              out_reader = Thread.new { stdout.read }
+              err_reader = Thread.new { stderr.read }
               begin
                 Timeout.timeout(time_limit) do
-                  output << stdout.read
-                  err << stderr.read
+                  stdout_messages << out_reader.value
+                  stderr_messages << err_reader.value
                 end
               rescue Timeout::Error
-                @log.debug("Timeout encounter after #{time_limit}s, killing process with pid: #{pid}")
+                message = "Timeout encounter after #{time_limit}s, killing process with pid: #{pid}"
                 Process.kill('KILL', pid)
+                on_fail == :raise ? (raise StandardError, message) : @log.debug(message)
+              ensure
+                out_reader.kill
+                err_reader.kill
               end
-              [output, err]
+              [stdout_messages, stderr_messages]
             end
             log_stderr(stderr, command, logger)
           rescue StandardError => e

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

@@ -59,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

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

@@ -155,7 +155,7 @@ module Facter
         @searching
       end
 
-      # Lock our searching process, so we never ge stuck in recursion.
+      # Lock our searching process, so we never get stuck in recursion.
       def searching
         raise "Caught recursion on #{@name}" if searching?
 

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

@@ -14,6 +14,8 @@ module Facter
     class Resolution
       # @api private
       attr_accessor :code, :fact_type
+
+      # @api private
       attr_writer :value
 
       extend Facter::Core::Execution
@@ -24,7 +26,12 @@ module Facter
         # compatibility.
         #
         # @deprecated
-        public :search_paths, :which, :absolute_path?, :expand_command, :with_env, :exec
+        #
+        # @api public
+        public :which, :exec
+
+        # @api private
+        public :with_env
       end
 
       include LegacyFacter::Core::Resolvable
@@ -32,22 +39,27 @@ module Facter
 
       # @!attribute [rw] name
       # The name of this resolution. The resolution name should be unique with
-      # respect to the given fact.
+      #   respect to the given fact.
+      #
       # @return [String]
+      #
       # @api public
       attr_accessor :name
 
       # @!attribute [r] fact
-      # @return [Facter::Util::Fact]
+      #
+      # @return [Facter::Util::Fact] Associated fact with this resolution.
+      #
       # @api private
       attr_reader :fact
 
       # Create a new resolution mechanism.
       #
       # @param name [String] The name of the resolution.
-      # @return [void]
       #
-      # @api private
+      # @return [Facter::Util::Resolution] The created resolution
+      #
+      # @api public
       def initialize(name, fact)
         @name = name
         @fact = fact
@@ -57,6 +69,11 @@ module Facter
         @weight = nil
       end
 
+      # Returns the fact's resolution type
+      #
+      # @return [Symbol] The fact's type
+      #
+      # @api private
       def resolution_type
         :simple
       end
@@ -64,7 +81,9 @@ module Facter
       # Evaluate the given block in the context of this resolution. If a block has
       # already been evaluated emit a warning to that effect.
       #
-      # @return [void]
+      # @return [String] Result of the block's evaluation
+      #
+      # @api private
       def evaluate(&block)
         if @last_evaluated
           msg = "Already evaluated #{@name}"
@@ -85,6 +104,11 @@ module Facter
                           end
       end
 
+      # Sets options for the aggregate fact
+      #
+      # @return [nil]
+      #
+      # @api private
       def options(options)
         accepted_options = %i[name value timeout weight fact_type file]
 
@@ -98,8 +122,6 @@ module Facter
       # Sets the code block or external program that will be evaluated to
       # get the value of the fact.
       #
-      # @return [void]
-      #
       # @overload setcode(string)
       #   Sets an external program to call to get the value of the resolution
       #   @param [String] string the external program to run to get the
@@ -111,6 +133,8 @@ module Facter
       #     This block is run when the fact is evaluated. Errors raised from
       #     inside the block are rescued and printed to stderr.
       #
+      # @return [Facter::Util::Resolution] Returns itself
+      #
       # @api public
       def setcode(string = nil, &block)
         if string
@@ -127,11 +151,16 @@ module Facter
         else
           raise ArgumentError, 'You must pass either code or a block'
         end
+        self
       end
 
-      # Comparation is done based on weight and fact type.
-      # The greatter the weight, the higher the priority.
-      # If weights are equal, we consider external facts greater than custom facts
+      # Comparison is done based on weight and fact type.
+      #   The greater the weight, the higher the priority.
+      #   If weights are equal, we consider external facts greater than custom facts.
+      #
+      # @return [bool] Weight comparison result
+      #
+      # @api private
       def <=>(other)
         return compare_equal_weights(other) if weight == other.weight
         return 1 if weight > other.weight