facter 4.0.51 → 4.0.52

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db03b26f8336c77d444ced6b4d073a927b529e6272ef0ba65eafc69af0e66060
-  data.tar.gz: a07adb46289f6315764d40a3f21c967de22c187fe9070177959a02c82bd1da6a
+  metadata.gz: 778d4d972d3e950f98d4fd8dbd4100e7b2a0c168369949b234d7088ddeba539f
+  data.tar.gz: 50303cfdfcf434c38d3d9539c35362f190dd84b82a8f85227d804a876b5a4ce3
 SHA512:
-  metadata.gz: 1cf1b38ac9c4e67b93e73474afa8f134132f0afd90d9cb5e45a4ced0c2cca3874ca581d1e6dd59ea154eb57e7ffc423a2a0c9aa1d36bdd04501648499dc30c3f
-  data.tar.gz: 0567b4d6940087e0c0d273392b103bd507fe6f15adbcaa826d783db1eda0c512582da10031400a0360b76fa397150101e925b4f814b394bdc478b615a1d1c1d0
+  metadata.gz: 38f84ef3e3699e3bed3b348ae07562f9423121011659ef9ebac4395a157eb06bd110a64e7481f82331e8f65e908936df826c630f57f879ba79686bee0878ac5a
+  data.tar.gz: bf2a8b2d1d1e23a0d0ba22f21d2b8e228bc238f2eededc1ab4474dff9e0d5f13094ec2c5990f24916a563b28fd75bfa2d745bd728d2f6cda9b31283116d9df34

data/lib/docs/generate_cli.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'facter/framework/cli/cli_launcher'
+
+cli = Facter::Cli.new([])
+
+puts cli.man

data/lib/facter.rb

@@ -27,23 +27,32 @@ module Facter
       require 'facter/framework/cli/cli_launcher'
 
       args = args_as_string.split(' ')
-
       Facter::OptionsValidator.validate(args)
       processed_arguments = CliLauncher.prepare_arguments(args, nil)
-
       cli = Facter::Cli.new([], processed_arguments)
-
-      if cli.args.include?(:version)
-        cli.invoke(:version, [])
-      elsif cli.args.include?('--list-cache-groups')
-        cli.invoke(:list_cache_groups, [])
-      elsif cli.args.include?('--list-block-groups')
-        cli.invoke(:list_block_groups, [])
-      else
-        cli.invoke(:arg_parser)
+      cli_options = cli.options.dup
+
+      # config file options
+      config_file = cli_options.delete(:config)
+      if config_file
+        Facter::OptionStore.set(:config, config_file)
+        Facter::ConfigFileOptions.init(config_file)
+        Facter::Options.store(ConfigFileOptions.get)
       end
+
+      # user provided options
+      cli_options[:show_legacy] ||= false
+      Facter::Options.store(cli_options)
+
+      queried_facts(cli.args)
     end
 
+    # Method used by cli to set puppet paths
+    # in order to retrieve puppet custom and external facts
+    #
+    # @return nil
+    #
+    # @api private
     def puppet_facts
       require 'puppet'
 
@@ -110,10 +119,10 @@ module Facter
       nil
     end
 
-    # Gets the value for a core fact, external or custom facts are
-    #   not returned with this call. Returns `nil` if no such fact exists.
+    # Retrieves the value of a core fact. External or custom facts are
+    # not returned with this call. Returns `nil` if no such fact exists.
     #
-    # @return [FactCollection] hash with fact names and values
+    # @return [FactCollection] A hash with fact names and values
     #
     # @api private
     def core_value(user_query)
@@ -198,14 +207,29 @@ module Facter
       Facter::Options[:debug] = debug_bool
     end
 
+    # Enable sequential resolving of facts
+    #
+    # @return [bool]
+    #
+    # @api public
     def enable_sequential
       Facter::Options[:sequential] = true
     end
 
+    # Disable sequential resolving of facts
+    #
+    # @return [bool]
+    #
+    # @api public
     def disable_sequential
       Facter::Options[:sequential] = false
     end
 
+    # Check if facts are resolved sequentially or not
+    #
+    # @return [bool]
+    #
+    # @api public
     def sequential?
       Facter::Options[:sequential]
     end
@@ -343,10 +367,10 @@ module Facter
       Options.custom_dir
     end
 
-    # Gets a hash mapping fact names to their values
-    # The hash contains core facts, legacy facts, custom facts and external facts (all facts that can be resolved).
+    # Retrieves a fact's value. Returns `nil` if no such fact exists.
     #
-    # @return [FactCollection] hash with fact names and values
+    # @param user_query [String] the fact name
+    # @return [String] the value of the fact, or nil if no fact is found
     #
     # @api public
     def to_hash
@@ -390,29 +414,6 @@ module Facter
       @already_searched[user_query]&.value
     end
 
-    # Gets the values for multiple facts.
-    #
-    # @param options [Hash] parameters for the fact - attributes
-    #   of {Facter::Util::Fact} and {Facter::Util::Resolution} can be
-    #   supplied here
-    # @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)
-      else
-        FormatterHelper.retrieve_facts_to_display_for_user_query(user_queries, resolved_facts)
-      end
-    end
-
     # Returns Facter version
     #
     # @return [String] Current version
@@ -428,7 +429,7 @@ module Facter
     #
     # @api private
     def to_user_output(cli_options, *args)
-      init_cli_options(cli_options, args)
+      init_cli_options(cli_options)
       logger.info("executed with command line: #{ARGV.drop(1).join(' ')}")
       logger.debug("Facter version: #{Facter::VERSION}")
       log_blocked_facts
@@ -454,7 +455,7 @@ module Facter
       nil
     end
 
-    # Returns a list with the names of all solved facts
+    # Returns a list with the names of all resolved facts
     # @return [Array] the list with all the fact names
     #
     # @api public
@@ -490,6 +491,18 @@ module Facter
 
     private
 
+    def queried_facts(user_query)
+      log_blocked_facts
+      resolved_facts = Facter::FactManager.instance.resolve_facts(user_query)
+      resolved_facts.reject! { |fact| fact.type == :custom && fact.value.nil? }
+
+      if user_query.count.zero?
+        Facter::FactCollection.new.build_fact_collection!(resolved_facts)
+      else
+        FormatterHelper.retrieve_facts_to_display_for_user_query(user_query, resolved_facts)
+      end
+    end
+
     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
@@ -516,9 +529,9 @@ module Facter
       @logger ||= Log.new(self)
     end
 
-    def init_cli_options(options, args)
+    def init_cli_options(options)
       options = options.map { |(k, v)| [k.to_sym, v] }.to_h
-      Facter::Options.init_from_cli(options, args)
+      Facter::Options.init_from_cli(options)
     end
 
     def add_fact_to_searched_facts(user_query, value)

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

@@ -53,6 +53,15 @@ module Facter
       # @api private
       attr_reader :fact
 
+      # Create a new aggregated resolution mechanism.
+      #
+      # @param name [String] The name of the resolution.
+      # @param fact [Facter::Fact] The fact to which this
+      #             resolution will be added.
+      #
+      # @return [Facter::Util::Resolution] The created resolution
+      #
+      # @api private
       def initialize(name, fact)
         @name = name
         @fact = fact

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

@@ -59,6 +59,17 @@ module LegacyFacter
         @on_flush_block&.call
       end
 
+      # Resolves the fact's value or loggs an error if the value
+      # couldn't be resolved.
+      #
+      # @raise Facter::ResolveCustomFactError if an error was raised
+      # (except Timeout::Error or Narmalization::NarmalizationError
+      # in which case an error message is logged and the execution
+      # isn't suspended).
+      #
+      # @return value (hash, string, int, array, etc) or nil
+      #
+      # @api private
       def value
         result = nil
 

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

@@ -56,6 +56,8 @@ module Facter
       # Create a new resolution mechanism.
       #
       # @param name [String] The name of the resolution.
+      # @param fact [Facter::Fact] The fact to which this
+      #             resolution will be added.
       #
       # @return [Facter::Util::Resolution] The created resolution
       #

data/lib/facter/facts/amzn/lsbdistcodename.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Facts
+  module Amzn
+    class Lsbdistcodename
+      FACT_NAME = 'lsbdistcodename'
+      TYPE = :legacy
+
+      def call_the_resolver
+        fact_value = Facter::Resolvers::LsbRelease.resolve(:codename)
+
+        Facter::ResolvedFact.new(FACT_NAME, fact_value, :legacy)
+      end
+    end
+  end
+end

data/lib/facter/facts/amzn/lsbdistdescription.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Facts
+  module Amzn
+    class Lsbdistdescription
+      FACT_NAME = 'lsbdistdescription'
+      TYPE = :legacy
+
+      def call_the_resolver
+        fact_value = Facter::Resolvers::LsbRelease.resolve(:description)
+
+        Facter::ResolvedFact.new(FACT_NAME, fact_value, :legacy)
+      end
+    end
+  end
+end

data/lib/facter/facts/amzn/lsbdistid.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Facts
+  module Amzn
+    class Lsbdistid
+      FACT_NAME = 'lsbdistid'
+      TYPE = :legacy
+
+      def call_the_resolver
+        fact_value = Facter::Resolvers::LsbRelease.resolve(:distributor_id)
+
+        Facter::ResolvedFact.new(FACT_NAME, fact_value, :legacy)
+      end
+    end
+  end
+end

data/lib/facter/facts/amzn/os/distro/codename.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Facts
+  module Amzn
+    module Os
+      module Distro
+        class Codename
+          FACT_NAME = 'os.distro.codename'
+
+          def call_the_resolver
+            fact_value = Facter::Resolvers::SpecificReleaseFile.resolve(
+              :release, release_file: '/etc/system-release'
+            ).match(/.*release.*(\(.*\)).*/)
+
+            fact_value = fact_value[1].gsub(/\(|\)/, '') if fact_value
+            fact_value ||= 'n/a'
+
+            Facter::ResolvedFact.new(FACT_NAME, fact_value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/facter/facts/amzn/os/distro/description.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Facts
+  module Amzn
+    module Os
+      module Distro
+        class Description
+          FACT_NAME = 'os.distro.description'
+
+          def call_the_resolver
+            fact_value = Facter::Resolvers::SpecificReleaseFile.resolve(
+              :release, release_file: '/etc/system-release'
+            )
+
+            Facter::ResolvedFact.new(FACT_NAME, fact_value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/facter/facts/amzn/os/distro/id.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Facts
+  module Amzn
+    module Os
+      module Distro
+        class Id
+          FACT_NAME = 'os.distro.id'
+
+          def call_the_resolver
+            fact_value = Facter::Resolvers::SpecificReleaseFile.resolve(
+              :release, release_file: '/etc/system-release'
+            ).split('release')[0].split.reject { |el| el.casecmp('linux').zero? }.join
+
+            Facter::ResolvedFact.new(FACT_NAME, fact_value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/facter/facts/amzn/os/distro/release.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Facts
+  module Amzn
+    module Os
+      module Distro
+        class Release
+          FACT_NAME = 'os.distro.release'
+          ALIASES = %w[lsbdistrelease lsbmajdistrelease lsbminordistrelease].freeze
+
+          def call_the_resolver
+            version = determine_release_version
+
+            return Facter::ResolvedFact.new(FACT_NAME, nil) unless version
+
+            [Facter::ResolvedFact.new(FACT_NAME, version),
+             Facter::ResolvedFact.new(ALIASES[0], version['full'], :legacy),
+             Facter::ResolvedFact.new(ALIASES[1], version['major'], :legacy),
+             Facter::ResolvedFact.new(ALIASES[2], version['minor'], :legacy)]
+          end
+
+          def determine_release_version
+            version = Facter::Resolvers::ReleaseFromFirstLine.resolve(:release, release_file: '/etc/system-release')
+            version ||= Facter::Resolvers::OsRelease.resolve(:version_id)
+
+            Facter::Util::Facts.release_hash_from_string(version)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/facter/facts/linux/az_metadata.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Facts
+  module Linux
+    class AzMetadata
+      FACT_NAME = 'az_metadata'
+
+      def initialize
+        @virtual = Facter::Util::Facts::VirtualDetector.new
+      end
+
+      def call_the_resolver
+        return Facter::ResolvedFact.new(FACT_NAME, nil) unless azure_hypervisor?
+
+        fact_value = Facter::Resolvers::Az.resolve(:metadata)
+
+        Facter::ResolvedFact.new(FACT_NAME, fact_value&.empty? ? nil : fact_value)
+      end
+
+      private
+
+      def azure_hypervisor?
+        @virtual.platform == 'hyperv'
+      end
+    end
+  end
+end

data/lib/facter/facts/linux/cloud/provider.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Facts
+  module Linux
+    module Cloud
+      class Provider
+        FACT_NAME = 'cloud.provider'
+
+        def call_the_resolver
+          az_metadata = Facter::Resolvers::Az.resolve(:metadata)
+
+          Facter::ResolvedFact.new(FACT_NAME, az_metadata&.empty? ? nil : 'azure')
+        end
+      end
+    end
+  end
+end