facter 4.0.44 → 4.0.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26e4084c96b8e155bea96be6eb69c241acf2974bf31d98ebc20a571f191e3083
-  data.tar.gz: 8cfb10254f2474b003c7d5f4739b455302546258b3dd0b65b1768df6e1a38b1e
+  metadata.gz: c40ef2043f777620f54c82fc1ee3e746a9b881b74771b3e6ed693773e2ae2e57
+  data.tar.gz: d6f1f89339c820f37f0a37b07ae42085a231468ce759c9d1a92b0fc7963e7f9e
 SHA512:
-  metadata.gz: 74e4755e3dedc6aedcba900d72577faa265f889b31b7ae60f6c85f0221f1e96f748c8b1342d9fc6ea7eafdf57dcacb675f3001465892b968f076c18432cfe9b7
-  data.tar.gz: cc030bcb93b65dddf47b5fdbbe39487a95f08794caf0f60985134c733f74a98ede9d0822c3647e9e0ab634eb9c336dd4a33a6f22d26ab8438f105787fbe74614
+  metadata.gz: 91d8d74575aeff6e4b31445a362019fd8f2200f888478b3e2c019a5ccf740b1f9a8590f3edde89f69a66af3bca778d3ab6b73b658c04853122507633221066e3
+  data.tar.gz: e6cf614befcb67eea1ac89c35a22532c04e40225a87b1d81a6dbf00d227ff55f29630a8637239daf44e4f4ab5de13cb5c9c29b4b612358a8063ee36985d243f8

data/lib/docs/generate.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Generates a markdown file containing fact documentation.
+# usage: ruby generate.rb > facts.md
+
+require 'yaml'
+require 'erb'
+require 'ostruct'
+
+PATH_TO_SCHEMA = File.join(File.dirname(__FILE__), '../schema/facter.yaml')
+PATH_TO_TEMPLATE = File.join(File.dirname(__FILE__), 'template.erb')
+
+schema = YAML.load_file(PATH_TO_SCHEMA)
+
+def format_facts(fact_hash)
+  scope = OpenStruct.new({
+                           facts: fact_hash
+                         })
+
+  erb = if ERB.instance_method(:initialize).parameters.assoc(:key) # Ruby 2.6+
+          ERB.new(File.read(PATH_TO_TEMPLATE), trim_mode: '-')
+        else
+          ERB.new(File.read(PATH_TO_TEMPLATE), nil, '-')
+        end
+  erb.result(scope.instance_eval { binding })
+end
+
+print "## Modern Facts\n\n"
+print format_facts(schema.reject { |_name, info| info['hidden'] == true })
+print "## Legacy Facts\n\n"
+print format_facts(schema.reject { |_name, info| info['hidden'].nil? || info['hidden'] == false })

data/lib/docs/template.erb

@@ -0,0 +1,34 @@
+<%# This template is used to generate a markdown file documenting facts. -%>
+<%# Run 'ruby generate.rb > facts.md' to generate the markdown file. -%>
+<%
+  def format_fact_element(name, info, indent = '')
+    subelements = (info['elements'] || {}).map{|n, i| format_fact_element(n, i, "#{indent}    ")}.join('')
+
+    "#{indent}* `#{name}` (#{info['type']}) --- #{info['description']}\n#{subelements}"
+  end
+-%>
+<% facts.each do |name, schema| -%>
+### `<%= name %>`
+
+<% if schema['hidden'] -%>
+This legacy fact is hidden by default in Facter's command-line output.
+
+<% end -%>
+**Type:** <%= schema['type'] %>
+
+**Purpose:**
+
+<%= schema['description'] %>
+
+<% if schema['elements'] -%>
+**Elements:**
+
+<%= schema['elements'].map{|name, info| format_fact_element(name, info)}.join('') %>
+<% end -%>
+
+<% if schema['details'] -%>
+**Details:**
+
+<%= schema['details'] %>
+<% end -%>
+<% end -%>

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
@@ -249,6 +261,26 @@ module Facter
       nil
     end
 
+    # Enables/Disables external facts.
+    # @param enable_external [boolean]
+    #
+    #  @return nil
+    #
+    # @api public
+    def load_external(enable_external)
+      # enable_external param needs negation because behind the scene
+      # no_external_facts= method is negating the parameter again.
+      Options[:no_external_facts] = !enable_external
+
+      if enable_external
+        logger.debug('Facter.load_external(true) called. External facts will be loaded')
+      else
+        logger.debug('Facter.load_external(false) called. External facts will NOT be loaded')
+      end
+
+      nil
+    end
+
     # Register directories to be searched for custom facts. The registered directories
     #   must be absolute paths or they will be ignored.
     # @param dirs [Array<String>] An array of searched directories
@@ -298,9 +330,12 @@ module Facter
     # @api public
     def to_hash
       log_blocked_facts
+      logger.debug("Facter version: #{Facter::VERSION}")
 
       resolved_facts = Facter::FactManager.instance.resolve_facts
-      Facter::FactCollection.new.build_fact_collection!(resolved_facts)
+      resolved_facts.reject! { |fact| fact.type == :custom && fact.value.nil? }
+      collection = Facter::FactCollection.new.build_fact_collection!(resolved_facts)
+      Hash[collection]
     end
 
     # Check whether printing stack trace is enabled
@@ -339,14 +374,16 @@ 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)
+      log_blocked_facts
       resolved_facts = Facter::FactManager.instance.resolve_facts(user_queries)
+      resolved_facts.reject! { |fact| fact.type == :custom && fact.value.nil? }
 
       if user_queries.count.zero?
         Facter::FactCollection.new.build_fact_collection!(resolved_facts)
@@ -372,13 +409,13 @@ module Facter
     def to_user_output(cli_options, *args)
       init_cli_options(cli_options, args)
       logger.info("executed with command line: #{ARGV.drop(1).join(' ')}")
+      logger.debug("Facter version: #{Facter::VERSION}")
       log_blocked_facts
-      resolved_facts = Facter::FactManager.instance.resolve_facts(args)
+      resolved_facts = resolve_facts_for_user_query(args)
       fact_formatter = Facter::FormatterFactory.build(Facter::Options.get)
-
       status = error_check(resolved_facts)
 
-      [fact_formatter.format(resolved_facts), status || 0]
+      [fact_formatter.format(resolved_facts), status]
     end
 
     # Logs an exception and an optional message
@@ -432,6 +469,15 @@ module Facter
 
     private
 
+    def resolve_facts_for_user_query(user_query)
+      resolved_facts = Facter::FactManager.instance.resolve_facts(user_query)
+      user_querie = resolved_facts.uniq(&:user_query).map(&:user_query).first
+
+      resolved_facts.reject! { |fact| fact.type == :custom && fact.value.nil? } if user_querie&.empty?
+
+      resolved_facts
+    end
+
     def parse_exception(exception, error_message)
       if exception.is_a?(Exception)
         error_message << exception.message if error_message.empty?
@@ -490,14 +536,13 @@ module Facter
     #
     # @api private
     def error_check(resolved_facts)
+      status = 0
       if Options[:strict]
         missing_names = resolved_facts.select { |fact| fact.type == :nil }.map(&:user_query)
 
         if missing_names.count.positive?
           status = 1
           log_errors(missing_names)
-        else
-          status = nil
         end
       end
 

data/lib/facter/config.rb

@@ -7,10 +7,13 @@ module Facter
         {
           'Linux' => [
             {
-              'Debian' => %w[
-                Elementary
-                Ubuntu
-                Raspbian
+              'Debian' => [
+                'Elementary',
+                { 'Ubuntu' => [
+                  'Linuxmint'
+                ] },
+                'Raspbian',
+                'Devuan'
               ]
             },
             {
@@ -20,13 +23,23 @@ module Facter
                 Centos
                 Ol
                 Scientific
+                Meego
+                Oel
+                Ovs
               ]
             },
             {
-              'Sles' => [
-                'Opensuse'
+              'Sles' => %w[
+                Opensuse
+                Sled
               ]
-            }
+            },
+            'Gentoo',
+            'Alpine',
+            'Photon',
+            'Slackware',
+            'Mageia',
+            'Openwrt'
           ]
         },
         {
@@ -42,6 +55,9 @@ module Facter
     end
     unless defined? FACT_GROUPS
       FACT_GROUPS = {
+        'AIX NIM type' => [
+          'nim_type'
+        ],
         'EC2' => %w[
           ec2_metadata
           ec2_userdata
@@ -49,6 +65,10 @@ module Facter
         'GCE' => [
           'gce'
         ],
+        'Xen' => %w[
+          xen
+          xendomains
+        ],
         'augeas' => %w[
           augeas
           augeasversion
@@ -69,11 +89,18 @@ module Facter
           uuid
           chassistype
         ],
+        'disks' => %w[
+          blockdevices
+          disks
+        ],
         'file system' => %w[
           mountpoints
           filesystems
           partitions
         ],
+        'fips' => [
+          'fips_enabled'
+        ],
         'hypervisors' => [
           'hypervisors'
         ],
@@ -112,6 +139,7 @@ module Facter
           netmask6
           network
           network6
+          scope6
           macaddress
           interfaces
           domain
@@ -209,6 +237,23 @@ module Facter
           is_virtual
           cloud
         ],
+        'ldom' => [
+          'ldom'
+        ],
+        'Solaris zone' => %w[
+          zones
+          zonename
+          solaris_zones
+        ],
+        'ZFS' => %w[
+          zfs_version
+          zfs_featurenumbers
+        ],
+        'ZFS storage pool' => %w[
+          zpool_version
+          zpool_featureflags
+          zpool_featurenumbers
+        ],
         'legacy' => [
           'architecture',
           'augeasversion',
@@ -280,8 +325,7 @@ module Facter
           'operatingsystemrelease',
           'osfamily',
           'physicalprocessorcount',
-          'processor.*',
-          'processor*',
+          'processor[0-9]+.*',
           'processorcount',
           'productname',
           'rubyplatform',

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

@@ -24,6 +24,13 @@ module Facter
       # @api public
       attr_reader :name
 
+      # @!attribute [r] fact_type
+      #
+      # @return [Symbol] The fact type of the aggregate resolution
+      #
+      # @api private
+      attr_reader :fact_type
+
       # @!attribute [r] deps
       #
       # @return [LegacyFacter::Core::DirectedGraph]

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

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require_relative 'popen3'
+
 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 +59,11 @@ module Facter
             return on_fail
           end
 
-          execute_command(expanded_command, on_fail, logger, time_limit)
-        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
+          out, = execute_command(expanded_command, on_fail, logger, time_limit)
+          out
         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;
@@ -98,8 +72,7 @@ module Facter
             opts = { 'LC_ALL' => 'C', 'LANG' => 'C' }
             require 'timeout'
             @log.debug("Executing command: #{command}")
-            out, stderr = Open3.popen3(opts, command.to_s) do |_, stdout, stderr, wait_thr|
-              pid = wait_thr.pid
+            out, stderr = Popen3.popen3e(opts, command.to_s) do |_, stdout, stderr, pid|
               stdout_messages = +''
               stderr_messages = +''
               out_reader = Thread.new { stdout.read }
@@ -128,7 +101,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