facter 4.0.15 → 4.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ac142ce04ba0e86b5a01726649b5b779562b472e162fb446261a15d9873efe4
-  data.tar.gz: ed8f02efebff60c27c93be0b6073564c80b38f850b4c564a29e12994b1057636
+  metadata.gz: 2152e5f7eabbae2f7ecbd79149167e8ec542c55f9dbda10c606bd4e4cdd6cf06
+  data.tar.gz: 25cbcb4a4d7ac89508041cc1e0c1833dac198dc2702c0ca3505cb77295f55da8
 SHA512:
-  metadata.gz: 19ca811ddbfeb3fd48f1376bb8a5694242ecb70ff83e85aff34c38eeeb55a43cf5ccf810494b6bbaebe26b6564e0a66dca5f8b9d578550447c757074b7a36bef
-  data.tar.gz: db4abe8360068573b590dfcf648da8e99decf2f392870b1fd29daa6e32695547bd1bc141c5d82c6fdd28bc3f8025c2f2256891a72d7b0920f87d9aff36bd2f28
+  metadata.gz: 64ffad2e78106f6c15fc5712a32b3970ad67c2b44dd21e06192f61865c9a4b33fcca3f8ebc6c82810c6249b95b6e577dd9e975ef94c0edb55058e99e802ad6f4
+  data.tar.gz: 8f9efff21eb866000c71fe6bc4f481741248d39ddbfceda0d651d34612de38346a68818ebafcd89b22c5363444213bb6398d46960133a56a9cb5122b4fbdf193

data/.rubocop.yml

@@ -93,6 +93,7 @@ Metrics/ClassLength:
     - 'lib/custom_facts/util/fact.rb'
     - 'lib/resolvers/windows/networking_resolver.rb'
     - 'lib/custom_facts/util/collection.rb'
+    - 'lib/framework/core/options/option_store.rb'
 
 Style/DoubleNegation:
   Exclude:

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --exclude-limit 1000`
-# on 2020-04-07 19:23:35 +0300 using RuboCop version 0.74.0.
+# on 2020-04-15 10:09:42 +0300 using RuboCop version 0.74.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 79
+# Offense count: 80
 # Configuration parameters: CustomTransform, IgnoreMethods.
 RSpec/FilePath:
   Exclude:
@@ -80,6 +80,7 @@ RSpec/FilePath:
     - 'spec/framework/core/fact_loaders/fact_loader_spec.rb'
     - 'spec/framework/core/fact_loaders/internal_fact_loader_spec.rb'
     - 'spec/framework/core/fact_manager_spec.rb'
+    - 'spec/framework/core/options/option_store_spec.rb'
     - 'spec/framework/core/options/options_validator_spec.rb'
     - 'spec/framework/core/options_spec.rb'
     - 'spec/framework/core/session_cache_spec.rb'
@@ -108,7 +109,7 @@ RSpec/LeakyConstantDeclaration:
     - 'spec/facter/resolvers/macosx/mountpoints_resolver_spec.rb'
     - 'spec/facter/resolvers/utils/windows/network_utils_spec.rb'
 
-# Offense count: 121
+# Offense count: 118
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
@@ -176,7 +177,6 @@ RSpec/MessageSpies:
     - 'spec/facter/facts/windows/ruby/sitedir_spec.rb'
     - 'spec/facter/facts/windows/scope6_interfaces_spec.rb'
     - 'spec/facter/resolvers/utils/aix/odm_query_spec.rb'
-    - 'spec/framework/config/config_reader_spec.rb'
     - 'spec/framework/core/fact_loaders/external_fact_loader_spec.rb'
 
 # Offense count: 26
@@ -190,7 +190,7 @@ RSpec/SubjectStub:
     - 'spec/custom_facts/util/fact_spec.rb'
     - 'spec/custom_facts/util/resolution_spec.rb'
 
-# Offense count: 193
+# Offense count: 179
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:
   Exclude:
@@ -233,7 +233,6 @@ RSpec/VerifiedDoubles:
     - 'spec/facter/resolvers/solaris/zfs_resolver_spec.rb'
     - 'spec/facter/resolvers/solaris/zone_resolver_spec.rb'
     - 'spec/facter/resolvers/solaris/zpool_resolver_spec.rb'
-    - 'spec/facter/resolvers/ssh_resolver_spec.rb'
     - 'spec/facter/resolvers/utils/windows/network_utils_spec.rb'
     - 'spec/facter/resolvers/utils/windows/win32ole_spec.rb'
     - 'spec/facter/resolvers/windows/dmi_bios_resolver_spec.rb'
@@ -252,7 +251,6 @@ RSpec/VerifiedDoubles:
     - 'spec/framework/core/fact_loaders/external_fact_loader_spec.rb'
     - 'spec/framework/core/fact_loaders/fact_loader_spec.rb'
     - 'spec/framework/core/fact_manager_spec.rb'
-    - 'spec/framework/core/options_spec.rb'
     - 'spec/framework/core/session_cache_spec.rb'
     - 'spec/framework/formatters/hocon_fact_formatter_spec.rb'
     - 'spec/framework/formatters/json_fact_formatter_spec.rb'

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 
 
+## [4.0.16](https://github.com/puppetlabs/facter-ng/tree/4.0.16) (2020-04-15)
+
+[Full Changelog](https://github.com/puppetlabs/facter-ng/compare/4.0.15...4.0.16)
+
+### Added
+
+- \(FACT-2233\) Add AIX partitons fact [\#433](https://github.com/puppetlabs/facter-ng/pull/433) ([oanatmaria](https://github.com/oanatmaria))
+- \(FACT-2330\) Add ssh fact for Windows OpenSSH feature [\#424](https://github.com/puppetlabs/facter-ng/pull/424) ([oanatmaria](https://github.com/oanatmaria))
+
+### Fixed
+
+- \(FACT-2528\) Fix for tests/facts/ssh\_key.rb [\#442](https://github.com/puppetlabs/facter-ng/pull/442) ([oanatmaria](https://github.com/oanatmaria))
+- \(FACT-2538\) Don't save core and legacy facts in collection if they have no value [\#441](https://github.com/puppetlabs/facter-ng/pull/441) ([IrimieBogdan](https://github.com/IrimieBogdan))
+
+
+
+## [4.0.15](https://github.com/puppetlabs/facter-ng/tree/4.0.15) (2020-04-08)
+
+[Full Changelog](https://github.com/puppetlabs/facter-ng/compare/4.0.14...4.0.15)
+
+### Added
+
+- \(FACT-2541\) Add TYPE for legacy facts [\#439](https://github.com/puppetlabs/facter-ng/pull/439) ([oanatmaria](https://github.com/oanatmaria))
+- \(FACT-2535\) Allow interpolation of Facter.fact\('fact\_name'\) [\#435](https://github.com/puppetlabs/facter-ng/pull/435) ([sebastian-miclea](https://github.com/sebastian-miclea))
+- \(FACT-2477\) Collect facts from alternative sources [\#422](https://github.com/puppetlabs/facter-ng/pull/422) ([oanatmaria](https://github.com/oanatmaria))
+
+### Fixed
+
+- \(FACT-2513\) Updated how option aliases are displayed [\#434](https://github.com/puppetlabs/facter-ng/pull/434) ([sebastian-miclea](https://github.com/sebastian-miclea))
+- \(FACT-2499\) Facts with aliases are resolved only once [\#429](https://github.com/puppetlabs/facter-ng/pull/429) ([IrimieBogdan](https://github.com/IrimieBogdan))
+
+
+
 ## [4.0.14](https://github.com/puppetlabs/facter-ng/tree/4.0.14) (2020-04-01)
 
 [Full Changelog](https://github.com/puppetlabs/facter-ng/compare/4.0.13...4.0.14)

data/VERSION

@@ -1 +1 @@
-4.0.15
+4.0.16

data/lib/custom_facts/util/parser.rb

@@ -50,7 +50,7 @@ module LegacyFacter
         end
 
         def content
-          @content ||= File.read(filename)
+          @content ||= Facter::Util::FileHelper.safe_read(filename, nil)
         end
 
         # results on the base class is really meant to be just an exception handler

data/lib/custom_facts/version.rb

@@ -79,7 +79,7 @@ module LegacyFacter
   # @return [String] the version -- for example: "1.6.14-6-gea42046" or nil if the VERSION
   #   file does not exist.
   def self.read_version_file(path)
-    File.read(path).chomp if File.readable?(path)
+    Util::FileHelper.safe_read(path).chomp
   end
   private_class_method :read_version_file
 end

data/lib/facter.rb

@@ -11,7 +11,7 @@ require "#{ROOT_DIR}/lib/framework/core/options/options_validator"
 module Facter
   class ResolveCustomFactError < StandardError; end
 
-  @options = Options.instance
+  Options.init
   Log.add_legacy_logger(STDOUT)
   @logger = Log.new(self)
   @already_searched = {}
@@ -103,10 +103,7 @@ module Facter
     #
     # @api public
     def debugging(debug_bool)
-      @options.priority_options[:debug] = debug_bool
-      @options.refresh
-
-      debug_bool
+      Facter::Options[:debug] = debug_bool
     end
 
     # Returns a fact object by name.  If you use this, you still have to
@@ -187,14 +184,12 @@ module Facter
     #
     # @api public
     def to_hash
-      @options.priority_options[:to_hash] = true
-      @options.refresh
-
       log_blocked_facts
 
+      reset
       resolved_facts = Facter::FactManager.instance.resolve_facts
-      SessionCache.invalidate_all_caches
-      FactCollection.new.build_fact_collection!(resolved_facts)
+      Facter::SessionCache.invalidate_all_caches
+      Facter::FactCollection.new.build_fact_collection!(resolved_facts)
     end
 
     # Check whether printing stack trace is enabled
@@ -244,14 +239,14 @@ module Facter
     #
     # @api private
     def to_user_output(cli_options, *args)
-      @options.priority_options = { is_cli: true }.merge!(cli_options.map { |(k, v)| [k.to_sym, v] }.to_h)
-      @options.refresh(args)
+      cli_options = cli_options.map { |(k, v)| [k.to_sym, v] }.to_h
+      Facter::Options.init_from_cli(cli_options, args)
       @logger.info("executed with command line: #{ARGV.drop(1).join(' ')}")
       log_blocked_facts
 
       resolved_facts = Facter::FactManager.instance.resolve_facts(args)
       SessionCache.invalidate_all_caches
-      fact_formatter = Facter::FormatterFactory.build(@options)
+      fact_formatter = Facter::FormatterFactory.build(Facter::Options.get)
 
       status = error_check(args, resolved_facts)
 
@@ -285,7 +280,6 @@ module Facter
     #
     # @return [ResolvedFact]
     def resolve_fact(user_query)
-      @options.refresh([user_query])
       user_query = user_query.to_s
       resolved_facts = Facter::FactManager.instance.resolve_facts([user_query])
       SessionCache.invalidate_all_caches
@@ -311,7 +305,7 @@ module Facter
     #
     # @api private
     def error_check(args, resolved_facts)
-      if Options.instance[:strict]
+      if Options[:strict]
         missing_names = args - resolved_facts.map(&:user_query).uniq
         if missing_names.count.positive?
           status = 1
@@ -330,8 +324,10 @@ module Facter
     #
     # @api private
     def log_blocked_facts
-      block_list = BlockList.instance.block_list
-      @logger.debug("blocking collection of #{block_list.join("\s")} facts") if block_list.any? && Options[:block]
+      block_list = Facter::BlockList.new(Facter::Options[:config]).block_list
+      return unless block_list.any? && Facter::Options[:block]
+
+      @logger.debug("blocking collection of #{block_list.join("\s")} facts")
     end
 
     # Used for printing errors regarding CLI user input validation

data/lib/facts/aix/partitions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Facts
+  module Aix
+    class Partitions
+      FACT_NAME = 'partitions'
+
+      def call_the_resolver
+        partitions = Facter::Resolvers::Aix::Partitions.resolve(:partitions)
+
+        Facter::ResolvedFact.new(FACT_NAME, partitions.empty? ? nil : partitions)
+      end
+    end
+  end
+end

data/lib/facts/windows/ssh.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Facts
+  module Windows
+    class Ssh
+      FACT_NAME = 'ssh'
+
+      def call_the_resolver
+        privileged = Facter::Resolvers::Identity.resolve(:privileged)
+        ssh_info = Facter::Resolvers::Windows::Ssh.resolve(:ssh) if privileged
+        ssh_facts = {}
+        ssh_info&.each { |ssh| ssh_facts.merge!(create_ssh_fact(ssh)) }
+        Facter::ResolvedFact.new(FACT_NAME, ssh_facts.empty? ? nil : ssh_facts)
+      end
+
+      private
+
+      def create_ssh_fact(ssh)
+        { ssh.name.to_sym =>
+              { fingerprints: { sha1: ssh.fingerprint.sha1,
+                                sha256: ssh.fingerprint.sha256 },
+                key: ssh.key,
+                type: ssh.type } }
+      end
+    end
+  end
+end

data/lib/facts_utils/uptime_parser.rb

@@ -16,19 +16,19 @@ module Facter
       private
 
       def uptime_proc_uptime
-        output, _status = Open3.capture2("/bin/cat #{uptime_file} 2>/dev/null")
+        output, _stderr, _status = Open3.capture3("/bin/cat #{uptime_file} 2>/dev/null")
 
         output.chomp.split(' ').first.to_i unless output.empty?
       end
 
       def uptime_sysctl
-        output, _status = Open3.capture2("sysctl -n #{uptime_sysctl_variable} 2>/dev/null")
+        output, _stderr, _status = Open3.capture3("sysctl -n #{uptime_sysctl_variable} 2>/dev/null")
 
         compute_uptime(Time.at(output.match(/\d+/)[0].to_i)) unless output.empty?
       end
 
       def uptime_executable
-        output, _status = Open3.capture2(uptime_executable_cmd + ' 2>/dev/null')
+        output, _stderr, _status = Open3.capture3(uptime_executable_cmd + ' 2>/dev/null')
         return unless output
 
         up = 0

data/lib/framework/cli/cli.rb

@@ -122,7 +122,7 @@ module Facter
     desc '--list-block-groups', 'List block groups'
     map ['--list-block-groups'] => :list_block_groups
     def list_block_groups(*_args)
-      puts Facter::BlockList.instance.block_groups.to_yaml.lines[1..-1].join
+      puts Facter::BlockList.new.block_groups.to_yaml.lines[1..-1].join
     end
 
     def self.exit_on_failure?

data/lib/framework/config/block_list.rb

@@ -2,8 +2,6 @@
 
 module Facter
   class BlockList
-    include Singleton
-
     attr_reader :block_groups, :block_list
 
     def initialize(block_list_path = nil)
@@ -28,8 +26,7 @@ module Facter
 
     def load_block_groups
       @block_groups = File.readable?(@block_groups_file_path) ? Hocon.load(@block_groups_file_path) : {}
-      options = Options.instance
-      @block_list = ConfigReader.new(options[:config]).block_list || {}
+      @block_list = ConfigReader.init(Options[:config]).block_list || {}
     end
   end
 end

data/lib/framework/config/config_reader.rb

@@ -2,42 +2,45 @@
 
 module Facter
   class ConfigReader
-    attr_accessor :conf
+    class << self
+      attr_accessor :conf
 
-    def initialize(config_path = nil)
-      @config_file_path = config_path || default_path
-      refresh_config
-    end
+      def init(config_path = nil)
+        config_path ||= default_path
+        refresh_config(config_path)
+        self
+      end
 
-    def block_list
-      @conf['facts'] && @conf['facts']['blocklist']
-    end
+      def block_list
+        @conf['facts'] && @conf['facts']['blocklist']
+      end
 
-    def ttls
-      @conf['facts'] && @conf['facts']['ttls']
-    end
+      def ttls
+        @conf['facts'] && @conf['facts']['ttls']
+      end
 
-    def global
-      @conf['global']
-    end
+      def global
+        @conf['global']
+      end
 
-    def cli
-      @conf['cli']
-    end
+      def cli
+        @conf['cli']
+      end
 
-    def refresh_config
-      @conf = File.readable?(@config_file_path) ? Hocon.load(@config_file_path) : {}
-    end
+      def refresh_config(config_path)
+        @conf = File.readable?(config_path) ? Hocon.load(config_path) : {}
+      end
 
-    private
+      private
 
-    def default_path
-      os = OsDetector.instance.identifier
+      def default_path
+        os = OsDetector.instance.identifier
 
-      windows_path = File.join('C:', 'ProgramData', 'PuppetLabs', 'facter', 'etc', 'facter.conf')
-      linux_path = File.join('/', 'etc', 'puppetlabs', 'facter', 'facter.conf')
+        windows_path = File.join('C:', 'ProgramData', 'PuppetLabs', 'facter', 'etc', 'facter.conf')
+        linux_path = File.join('/', 'etc', 'puppetlabs', 'facter', 'facter.conf')
 
-      os == :windows ? windows_path : linux_path
+        os == :windows ? windows_path : linux_path
+      end
     end
   end
 end

data/lib/framework/core/fact_filter.rb

@@ -19,9 +19,9 @@ module Facter
     private
 
     def filter_legacy_facts!(resolved_facts)
-      return if Options[:show_legacy]
+      return unless !Options[:show_legacy] && Options[:user_query].empty?
 
-      resolved_facts.reject!(&:legacy?) unless Options[:user_query]
+      resolved_facts.reject!(&:legacy?)
     end
   end
 end

data/lib/framework/core/file_loader.rb

@@ -25,17 +25,17 @@ require "#{ROOT_DIR}/lib/framework/core/options"
 require "#{ROOT_DIR}/lib/framework/logging/multilogger"
 require "#{ROOT_DIR}/lib/framework/logging/logger"
 
+require "#{ROOT_DIR}/lib/util/file_helper"
+
 require "#{ROOT_DIR}/lib/resolvers/base_resolver"
 require "#{ROOT_DIR}/lib/framework/detector/os_detector"
 
 require "#{ROOT_DIR}/lib/framework/config/config_reader"
 require "#{ROOT_DIR}/lib/framework/config/block_list"
-require "#{ROOT_DIR}/lib/resolvers/utils/fingerprint.rb"
-require "#{ROOT_DIR}/lib/resolvers/utils/ssh.rb"
-require "#{ROOT_DIR}/lib/resolvers/utils/filesystem_helper.rb"
 
 load_dir(['config'])
 
+load_lib_dirs('resolvers', 'utils')
 load_lib_dirs('resolvers')
 load_lib_dirs('facts_utils')
 load_lib_dirs('framework', 'core')

data/lib/framework/core/options.rb

@@ -2,70 +2,63 @@
 
 module Facter
   class Options
-    include Facter::DefaultOptions
-    include Facter::ConfigFileOptions
-    include Facter::PriorityOptions
-    include Facter::HelperOptions
-    include Facter::ValidateOptions
-
-    include Singleton
-
-    attr_accessor :priority_options
-
-    def initialize
-      @options = {}
-      @priority_options = {}
-    end
-
-    def refresh(user_query = [])
-      @user_query = user_query
-      initialize_options
-
-      @options
-    end
-
-    def get
-      @options
-    end
-
-    def [](option)
-      @options.fetch(option, nil)
-    end
-
-    def custom_dir?
-      @options[:custom_dir] && @options[:custom_facts]
-    end
-
-    def custom_dir
-      @options[:custom_dir]
-    end
-
-    def external_dir?
-      @options[:external_dir] && @options[:external_facts]
-    end
-
-    def external_dir
-      @options[:external_dir]
-    end
-
-    def self.method_missing(name, *args, &block)
-      Facter::Options.instance.send(name.to_s, *args, &block)
-    rescue NoMethodError
-      super
-    end
-
-    def self.respond_to_missing?(name, include_private) end
-
-    private
-
-    def initialize_options
-      @options = { config: @priority_options[:config] }
-      augment_with_defaults!
-      augment_with_to_hash_defaults! if @priority_options[:to_hash]
-      augment_with_config_file_options!(@options[:config])
-      augment_with_priority_options!(@priority_options)
-      validate_configs
-      augment_with_helper_options!(@user_query)
+    class << self
+      def cli?
+        OptionStore.cli
+      end
+
+      def get
+        OptionStore.all
+      end
+
+      def [](key)
+        OptionStore.send(key.to_sym)
+      end
+
+      def []=(key, value)
+        OptionStore.send("#{key}=".to_sym, value)
+      end
+
+      def custom_dir?
+        OptionStore.custom_dir && OptionStore.custom_facts
+      end
+
+      def custom_dir
+        OptionStore.custom_dir.flatten
+      end
+
+      def external_dir?
+        OptionStore.external_dir && OptionStore.external_facts
+      end
+
+      def external_dir
+        OptionStore.external_dir
+      end
+
+      def init
+        OptionStore.cli = false
+        ConfigFileOptions.init
+        store(ConfigFileOptions.get)
+      end
+
+      def init_from_cli(cli_options = {}, user_query = nil)
+        Facter::OptionStore.cli = true
+        Facter::OptionStore.show_legacy = false
+        Facter::OptionStore.user_query = user_query
+        OptionStore.set(:config, cli_options[:config])
+        ConfigFileOptions.init(cli_options[:config])
+        store(ConfigFileOptions.get)
+        store(cli_options)
+
+        Facter::OptionsValidator.validate_configs(get)
+      end
+
+      def store(options)
+        options.each do |key, value|
+          value = '' if key == 'log_level' && value == 'log_level'
+          OptionStore.set(key, value)
+        end
+      end
     end
   end
 end