facter 4.0.33 → 4.0.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32bb403fb4187d3a595b0b8aa4ed12ba472b1efc6d785cf2d371fc1488afd2d7
-  data.tar.gz: b8b159eedc00a4c17e2121e73f38bb76d383b298746731104511a36955ba382d
+  metadata.gz: 4cded925592073cd18baac69fc11f1154cbeda4370359e9d3e6655f97194d467
+  data.tar.gz: 16ea8f7a28b6ae86b0098a8c9412329dfa2665e1ca1a66ca3cc2d7e734452fa7
 SHA512:
-  metadata.gz: 3a0f55015be59493c79b53f054e609a336d6e64385547534ffe62084b060d1b70da511f0a4d74179717bf8fe11287ed972586fb159c20a33d4832ba01f287ffc
-  data.tar.gz: 1814bfa9210ec33c2ddeafad6d123a4f2c7377c792cd4a494de5d467f606b46943f2a294c6abc4f1e1700a87edaeeffe3e1de0712782a46ada76ae289367e17f
+  metadata.gz: be78011c78dab1cdc01e44af6a2e2e053f3600c43a4c758e1edbf2b6a067052de36a8166749148fc2740694394af682c38cd7f72d516f75a323af9c69a278667
+  data.tar.gz: 3b614e324b33c54c571e5857ea184dcf89d0e7e1fdc9030ee57478bdc3eaa6c0511d73f8f18441e33d31258ea5be7f227b3412770a90f82ed8fe789f9f3690f8

data/lib/facter.rb

@@ -13,6 +13,8 @@ module Facter
   Options.init
   Log.output(STDOUT)
   @already_searched = {}
+  @debug_once = []
+  @warn_once = []
 
   class << self
     def clear_messages
@@ -54,6 +56,8 @@ module Facter
     # @api public
     def clear
       @already_searched = {}
+      @debug_once = []
+      @warn_once = []
       LegacyFacter.clear
       Options[:custom_dir] = []
       LegacyFacter.collection.invalidate_custom_facts
@@ -68,16 +72,33 @@ module Facter
       fact_collection.dig(*splitted_user_query)
     end
 
-    # Prints out a debug message when debug option is set to true
-    # @param msg [String] Message to be printed out
+    # Logs debug message when debug option is set to true
+    # @param message [Object] Message object to be logged
     #
     # @return [nil]
     #
     # @api public
-    def debug(msg)
+    def debug(message)
       return unless debugging?
 
-      logger.debug(msg)
+      logger.debug(message.to_s)
+      nil
+    end
+
+    # Logs the same debug message only once when debug option is set to true
+    # @param message [Object] Message object to be logged
+    #
+    # @return [nil]
+    #
+    # @api public
+    def debugonce(message)
+      return unless debugging?
+
+      message_string = message.to_s
+      return if @debug_once.include? message_string
+
+      @debug_once << message_string
+      logger.debug(message_string)
       nil
     end
 
@@ -85,7 +106,7 @@ module Facter
       Facter::Log.on_message(&block)
     end
 
-    # Check whether debuging is enabled
+    # Check whether debugging is enabled
     #
     # @return [bool]
     #
@@ -108,7 +129,7 @@ module Facter
     # call {Facter::Util::Fact#value `value`} on it to retrieve the actual
     # value.
     #
-    # @param name [String] the name of the fact
+    # @param user_query [String] the name of the fact
     #
     # @return [Facter::Util::Fact, nil] The fact object, or nil if no fact
     #   is found.
@@ -199,7 +220,7 @@ module Facter
     end
 
     # Enable or disable trace
-    # @param debug_bool [bool] Set trace on debug state
+    # @param bool [bool] Set trace on debug state
     #
     # @return [type] [description]
     #
@@ -210,7 +231,7 @@ module Facter
 
     # Gets the value for a fact. Returns `nil` if no such fact exists.
     #
-    # @param name [String] the fact name
+    # @param user_query [String] the fact name
     # @return [String] the value of the fact, or nil if no fact is found
     #
     # @api public
@@ -262,6 +283,43 @@ module Facter
       logger.error(arr.flatten.join("\n"))
     end
 
+    # Returns a list with the names of all solved facts
+    #
+    # @return [Array] the list with all the fact names
+    #
+    # @api public
+    def list
+      to_hash.keys.sort
+    end
+
+    # Logs the message parameter as a warning.
+    #
+    # @param message [Object] the warning object to be displayed
+    #
+    # @return [nil]
+    #
+    # @api public
+    def warn(message)
+      logger.warn(message.to_s)
+      nil
+    end
+
+    # Logs only once the same warning message.
+    #
+    # @param message [Object] the warning message object
+    #
+    # @return [nil]
+    #
+    # @api public
+    def warnonce(message)
+      message_string = message.to_s
+      return if @warn_once.include? message_string
+
+      @warn_once << message_string
+      logger.warn(message_string)
+      nil
+    end
+
     private
 
     def logger
@@ -303,10 +361,9 @@ module Facter
     # Returns exit status when user query contains facts that do
     #   not exist
     #
-    # @param dirs [Array] Arguments sent to CLI
-    # @param dirs [Array] List of resolved facts
+    # @param resolved_facts [Array] List of resolved facts
     #
-    # @return [Integer, nil] Will return status 1 if user query contains
+    # @return [1/nil] Will return status 1 if user query contains
     #  facts that are not found or resolved, otherwise it will return nil
     #
     # @api private

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

@@ -35,6 +35,7 @@ module LegacyFacter
       def initialize(dir = LegacyFacter::Util::Config.external_facts_dirs, weight = EXTERNAL_FACT_WEIGHT)
         @directories = [dir].flatten
         @weight = weight
+        @log ||= Facter::Log.new(self)
       end
 
       # Load facts from files in fact directory using the relevant parser classes to
@@ -83,11 +84,12 @@ module LegacyFacter
           parser = LegacyFacter::Util::Parser.parser_for(fact.file)
           next if parser.nil?
 
-          data = parser.results
+          data = resolve_fact(fact, parser)
+
           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"
+            @log.debug("Fact file #{fact.file} was parsed but no key=>value data was returned")
           else
             data.each do |p, v|
               collection.add(p, value: v, fact_type: :external,
@@ -97,6 +99,14 @@ module LegacyFacter
         end
       end
 
+      def resolve_fact(fact, parser)
+        data = nil
+        fact_name = File.basename(fact.file)
+        Facter::Framework::Benchmarking::Timer.measure(fact_name) { data = parser.results }
+
+        data
+      end
+
       def entries
         dirs = @directories.select { |directory| File.directory?(directory) }.map do |directory|
           Dir.entries(directory).map { |directory_entry| File.join(directory, directory_entry) }

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

@@ -118,7 +118,10 @@ module Facter
 
         searching do
           suitable_resolutions = sort_by_weight(find_suitable_resolutions(@resolves))
-          @value = find_first_real_value(suitable_resolutions)
+
+          Facter::Framework::Benchmarking::Timer.measure(@name) do
+            @value = find_first_real_value(suitable_resolutions)
+          end
 
           announce_when_no_suitable_resolution(suitable_resolutions)
           announce_when_no_value_found(@value)

data/lib/facter/fact_groups.conf

@@ -165,5 +165,144 @@
 		"virtual",
 		"is_virtual",
 		"cloud"
+	],
+	"legacy": [
+		"architecture",
+		"augeasversion",
+		"bios_release_date",
+		"bios_vendor",
+		"bios_version",
+		"blockdevice_*_model",
+		"blockdevice_*_size",
+		"blockdevice_*_vendor",
+		"blockdevices",
+		"boardassettag",
+		"boardmanufacturer",
+		"boardproductname",
+		"boardserialnumber",
+		"chassisassettag",
+		"chassistype",
+		"dhcp_servers",
+		"domain",
+		"fqdn",
+		"gid",
+		"hardwareisa",
+		"hardwaremodel",
+		"hostname",
+		"id",
+		"interfaces",
+		"ipaddress",
+		"ipaddress_.*",
+		"ipaddress_*",
+		"ipaddress6",
+		"ipaddress6_.*",
+		"ipaddress6_*",
+		"ldom_*",
+		"lsbdistcodename",
+		"lsbdistdescription",
+		"lsbdistid",
+		"lsbdistrelease",
+		"lsbmajdistrelease",
+		"lsbminordistrelease",
+		"lsbrelease",
+		"macaddress",
+		"macaddress_.*",
+		"macaddress_*",
+		"macosx_buildversion",
+		"macosx_productname",
+		"macosx_productversion",
+		"macosx_productversion_major",
+		"macosx_productversion_minor",
+		"manufacturer",
+		"memoryfree",
+		"memoryfree_mb",
+		"memorysize",
+		"memorysize_mb",
+		"mtu_.*",
+		"mtu_*",
+		"netmask",
+		"netmask_.*",
+		"netmask_*",
+		"netmask6",
+		"netmask6_.*",
+		"netmask6_*",
+		"network",
+		"network_.*",
+		"network_*",
+		"network6",
+		"network6_.*",
+		"network6_*",
+		"operatingsystem",
+		"operatingsystemmajrelease",
+		"operatingsystemrelease",
+		"osfamily",
+		"physicalprocessorcount",
+		"processor.*",
+		"processor*",
+		"processorcount",
+		"productname",
+		"rubyplatform",
+		"rubysitedir",
+		"rubyversion",
+		"scope6",
+		"scope6_.*",
+		"selinux",
+		"selinux_config_mode",
+		"selinux_config_policy",
+		"selinux_current_mode",
+		"selinux_enforced",
+		"selinux_policyversion",
+		"serialnumber",
+		"sp_*",
+		"sp_boot_mode",
+		"sp_boot_rom_version",
+		"sp_boot_volume",
+		"sp_cpu_type",
+		"sp_current_processor_speed",
+		"sp_kernel_version",
+		"sp_l2_cache_core",
+		"sp_l3_cache",
+		"sp_local_host_name",
+		"sp_machine_model",
+		"sp_machine_name",
+		"sp_number_processors",
+		"sp_os_version",
+		"sp_packages",
+		"sp_physical_memory",
+		"sp_platform_uuid",
+		"sp_secure_vm",
+		"sp_serial_number",
+		"sp_smc_version_system",
+		"sp_uptime",
+		"sp_user_name",
+		"ssh.*key",
+		"ssh*key",
+		"sshfp_.*",
+		"sshfp_*",
+		"swapencrypted",
+		"swapfree",
+		"swapfree_mb",
+		"swapsize",
+		"swapsize_mb",
+		"system32",
+		"uptime",
+		"uptime_days",
+		"uptime_hours",
+		"uptime_seconds",
+		"uuid",
+		"windows_edition_id",
+		"windows_installation_type",
+		"windows_product_name",
+		"windows_release_id",
+		"xendomains",
+		"zone_*_brand",
+		"zone_*_id",
+		"zone_*_iptype",
+		"zone_*_name",
+		"zone_*_path",
+		"zone_*_status",
+		"zone_*_uuid",
+		"zonename",
+		"zones"
 	]
-}
+}

data/lib/facter/facts/aix/disks.rb

@@ -4,13 +4,28 @@ module Facts
   module Aix
     class Disks
       FACT_NAME = 'disks'
+      ALIASES = %w[blockdevices blockdevice_.*_size'].freeze
 
       def call_the_resolver
+        facts = []
         disks = Facter::Resolvers::Aix::Disks.resolve(:disks)
 
-        disks = disks&.empty? ? nil : disks
+        return Facter::ResolvedFact.new(FACT_NAME, nil) if disks.nil? || disks.empty?
 
-        Facter::ResolvedFact.new(FACT_NAME, disks)
+        blockdevices = disks.keys.join(',')
+        facts.push(Facter::ResolvedFact.new(FACT_NAME, disks))
+        facts.push(Facter::ResolvedFact.new('blockdevices', blockdevices, :legacy))
+        add_legacy_facts(disks, facts)
+
+        facts
+      end
+
+      private
+
+      def add_legacy_facts(disks, facts)
+        disks.each do |disk_name, disk_info|
+          facts.push(Facter::ResolvedFact.new("blockdevice_#{disk_name}_size", disk_info[:size_bytes].to_s, :legacy))
+        end
       end
     end
   end

data/lib/facter/facts/aix/networking/scope6.rb

@@ -5,11 +5,13 @@ module Facts
     module Networking
       class Scope6
         FACT_NAME = 'networking.scope6'
+        ALIASES = 'scope6'
 
         def call_the_resolver
           fact_value = Facter::Resolvers::Aix::Networking.resolve(:scope6)
 
-          Facter::ResolvedFact.new(FACT_NAME, fact_value)
+          [Facter::ResolvedFact.new(FACT_NAME, fact_value),
+           Facter::ResolvedFact.new('scope6', fact_value, :legacy)]
         end
       end
     end

data/lib/facter/facts/aix/scope6_interfaces.rb

@@ -9,7 +9,6 @@ module Facts
       def call_the_resolver
         resolved_facts = []
         interfaces = Facter::Resolvers::Aix::Networking.resolve(:interfaces)
-        scope6 = Facter::Resolvers::Aix::Networking.resolve(:scope6)
 
         interfaces&.each do |interface_name, info|
           if info[:scope6]
@@ -17,7 +16,6 @@ module Facts
           end
         end
 
-        resolved_facts << Facter::ResolvedFact.new('scope6', scope6, :legacy) if scope6
         resolved_facts
       end
     end

data/lib/facter/facts/aix/serialnumber.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Facts
+  module Aix
+    class Serialnumber
+      FACT_NAME = 'serialnumber'
+      TYPE = :legacy
+
+      def call_the_resolver
+        Facter::ResolvedFact.new(FACT_NAME, fact_value, :legacy)
+      end
+
+      private
+
+      def fact_value
+        Facter::Resolvers::Aix::Serialnumber.resolve(:serialnumber)
+      end
+    end
+  end
+end

data/lib/facter/facts/aix/ssh.rb

@@ -12,7 +12,7 @@ module Facts
       private
 
       def fact_value
-        resolver_data.map! { |el| create_ssh_fact(el) }.inject(:merge!)
+        resolver_data.map { |el| create_ssh_fact(el) }.inject(:merge)
       end
 
       def resolver_data
@@ -20,6 +20,8 @@ module Facts
       end
 
       def create_ssh_fact(ssh)
+        return {} unless ssh
+
         { ssh.name.to_sym => {
           fingerprints: {
             sha1: ssh.fingerprint.sha1,