openfact 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e52f6542f74fd6ae174527c89973ccf46aa5542e44d9f397bc800fbc92d357bd
-  data.tar.gz: ce3214f7c6274abcff1fb2606963f551f207a2aa0a67016b01614468a685f42a
+  metadata.gz: 4daa243a80d8ba47b89553843beda2cb577af1592688fc50824b28b4453c4e72
+  data.tar.gz: 1e1cbf1a2817cf2eb906ed791fd58bc60d0b1acaa229ace93e8a55d2f353c758
 SHA512:
-  metadata.gz: 864114f9fa9ed5f294a306aa3d7d0e10d069bc3ad3020e33d63a022c83989e4fb4bd16fae775a6ee125dcf8feb5d67b3e571ebd95c869f5bcf5390c7b3b749a0
-  data.tar.gz: af09f689814fbd7ea78a4323025522447b7edb9811a257973efaf083f45fa78f4c55945ccc8384e3fadd7e0b20786e7bf499fdc3d88a8bfa91cd1a4a1b28a9c3
+  metadata.gz: 1791dc19b98a3676c9adcbc03df513ba5907d123159de09e6a67317ecdee1003eb5c1ea057b9099d81972c10f39e55a9f73f02f5a498918cc7fd227a710990b6
+  data.tar.gz: ba01bd6bf64dfe485897a0be96bcb8f7686b8500298f3205b28c7d8f20905b3d4db9530e11221be1e5bc55e92370eea7d82f0dcc80d82eaf58d19b4f6b74a861

data/lib/docs/template.erb

@@ -11,7 +11,7 @@
 ### `<%= name %>`
 
 <% if schema['hidden'] -%>
-This legacy fact is hidden by default in Facter's command-line output.
+This legacy fact is hidden by default in OpenFact's command-line output.
 
 <% end -%>
 **Type:** <%= schema['type'] %>

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# A Facter plugin that loads external facts.
+# An OpenFact plugin that loads external facts.
 #
 # Default Unix Directories:
 # /opt/puppetlabs/custom_facts/facts.d, /etc/custom_facts/facts.d, /etc/puppetlabs/custom_facts/facts.d

data/lib/facter/framework/cli/cli.rb

@@ -104,7 +104,7 @@ module Facter
     class_option :puppet,
                  type: :boolean,
                  aliases: '-p',
-                 desc: 'Load the Puppet libraries, thus allowing Facter to load Puppet-specific facts.'
+                 desc: 'Load the OpenVox libraries, thus allowing OpenFact to load OpenVox-specific facts.'
 
     desc '--man', 'Display manual.', hide: true
     map ['--man'] => :man

data/lib/facter/framework/config/config_reader.rb

@@ -34,7 +34,7 @@ module Facter
       def refresh_config(config_path)
         @conf = File.readable?(config_path) ? Hocon.load(config_path) : {}
       rescue StandardError => e
-        log.warn("Facter failed to read config file #{config_path} with the following error: #{e.message}")
+        log.warn("OpenFact failed to read config file #{config_path} with the following error: #{e.message}")
         @conf = {}
       end
 

data/lib/facter/framework/logging/logger.rb

@@ -52,7 +52,7 @@ module Facter
 
       def set_logger_format
         @@logger.formatter = proc do |severity, datetime, _progname, msg|
-          datetime = datetime.strftime(@datetime_format || '%Y-%m-%d %H:%M:%S.%6N ')
+          datetime = datetime.strftime('%Y-%m-%dT%H:%M:%S.%6N%:z')
           "[#{datetime}] #{severity} #{msg} \n"
         end
       end

data/lib/facter/resolvers/ec2.rb

@@ -18,14 +18,19 @@ module Facter
         end
 
         def read_facts(fact_name)
-          @fact_list[:metadata] = {}
-          query_for_metadata(EC2_METADATA_ROOT_URL, @fact_list[:metadata])
-          @fact_list[:userdata] = get_data_from(EC2_USERDATA_ROOT_URL).strip.force_encoding('UTF-8')
+          if fact_name == :metadata
+            metadata = {}
+            query_for_metadata(EC2_METADATA_ROOT_URL, metadata)
+            @fact_list[:metadata] = metadata
+          else
+            @fact_list[:userdata] = get_data_from(EC2_USERDATA_ROOT_URL).strip.force_encoding('UTF-8')
+          end
+
           @fact_list[fact_name]
         end
 
         def query_for_metadata(url, container)
-          metadata = get_data_from(url)
+          metadata = get_metadata_from(url)
           metadata.each_line do |line|
             next if line.empty?
 
@@ -34,14 +39,15 @@ module Facter
 
             if http_path_component.end_with?('/')
               child = {}
-              child[http_path_component] = query_for_metadata("#{url}#{http_path_component}", child)
-              child.reject! { |key, _info| key == http_path_component }
+              query_for_metadata("#{url}#{http_path_component}", child)
               name = http_path_component.chomp('/')
               container[name] = child
             else
-              container[http_path_component] = get_data_from("#{url}#{http_path_component}").strip
+              container[http_path_component] = get_metadata_from("#{url}#{http_path_component}").strip
             end
           end
+
+          container
         end
 
         def build_path_component(line)
@@ -55,6 +61,12 @@ module Facter
           Facter::Util::Resolvers::Http.get_request(url, headers, { session: determine_session_timeout }, false)
         end
 
+        def get_metadata_from(url)
+          headers = {}
+          headers['X-aws-ec2-metadata-token'] = v2_token if v2_token
+          Facter::Util::Resolvers::Http.get_request!(url, headers, { session: determine_session_timeout }, false)
+        end
+
         def determine_session_timeout
           session_env = ENV.fetch('EC2_SESSION_TIMEOUT', nil)
           session_env ? session_env.to_i : EC2_SESSION_TIMEOUT

data/lib/facter/resolvers/solaris/ffi/structs.rb

@@ -10,20 +10,20 @@ module Facter
         end
 
         class Sockaddr < ::FFI::Struct
-          layout  :sa_family, :sa_family_t,
-                  :sa_data, [:uchar, 14]
+          layout :sa_family, :sa_family_t,
+                 :sa_data, [:uchar, 14]
         end
 
         class Lifnum < ::FFI::Struct
-          layout  :lifn_family, :sa_family_t,
-                  :lifn_flags, :int,
-                  :lifn_count, :int
+          layout :lifn_family, :sa_family_t,
+                 :lifn_flags, :int,
+                 :lifn_count, :int
         end
 
         class Arpreq < ::FFI::Struct
-          layout  :arp_pa, Sockaddr,
-                  :arp_ha, Sockaddr,
-                  :arp_flags, :int
+          layout :arp_pa, Sockaddr,
+                 :arp_ha, Sockaddr,
+                 :arp_flags, :int
 
           def sa_data_to_mac
             self[:arp_ha][:sa_data].entries[0, 6].map do |s|
@@ -41,27 +41,27 @@ module Facter
         end
 
         class Lifru1 < ::FFI::Union
-          layout  :lifru_addrlen, :int,
-                  :lifru_ppa, :uint_t
+          layout :lifru_addrlen, :int,
+                 :lifru_ppa, :uint_t
         end
 
         class Lifru < ::FFI::Union
-          layout  :lifru_addr, SockaddrStorage,
-                  :lifru_dstaddr, SockaddrStorage,
-                  :lifru_broadaddr, SockaddrStorage,
-                  :lifru_token, SockaddrStorage,
-                  :lifru_subnet, SockaddrStorage,
-                  :lifru_flags, :uint64,
-                  :lifru_metric, :int,
-                  :pad, [:char, 80]
+          layout :lifru_addr, SockaddrStorage,
+                 :lifru_dstaddr, SockaddrStorage,
+                 :lifru_broadaddr, SockaddrStorage,
+                 :lifru_token, SockaddrStorage,
+                 :lifru_subnet, SockaddrStorage,
+                 :lifru_flags, :uint64,
+                 :lifru_metric, :int,
+                 :pad, [:char, 80]
         end
 
         class Lifreq < ::FFI::Struct
-          layout  :lifr_name, [:char, 32],
-                  :lifr_lifru1, Lifru1,
-                  :lifr_movetoindex, :int,
-                  :lifr_lifru, Lifru,
-                  :pad, [:char, 80]
+          layout :lifr_name, [:char, 32],
+                 :lifr_lifru1, Lifru1,
+                 :lifr_movetoindex, :int,
+                 :lifr_lifru, Lifru,
+                 :pad, [:char, 80]
 
           def name
             self[:lifr_name].to_s
@@ -77,10 +77,10 @@ module Facter
         end
 
         class Lifconf < ::FFI::Struct
-          layout  :lifc_family, :uint,
-                  :lifc_flags, :int,
-                  :lifc_len, :int,
-                  :lifc_buf, :pointer
+          layout :lifc_family, :uint,
+                 :lifc_flags, :int,
+                 :lifc_len, :int,
+                 :lifc_buf, :pointer
 
           def self.new_for_ioctl(interface_count)
             lifconf = new
@@ -93,8 +93,8 @@ module Facter
         end
 
         class Lifcu < ::FFI::Union
-          layout  :lifcu_buf, :caddr_t,
-                  :lifcu_req, Lifreq
+          layout :lifcu_buf, :caddr_t,
+                 :lifcu_req, Lifreq
         end
 
         class InAddr < ::FFI::Struct
@@ -102,10 +102,10 @@ module Facter
         end
 
         class SockaddrIn < ::FFI::Struct
-          layout  :sin_family, :sa_family_t,
-                  :sin_port, :in_port_t,
-                  :sin_addr, InAddr,
-                  :sin_zero, [:char, 8]
+          layout :sin_family, :sa_family_t,
+                 :sin_port, :in_port_t,
+                 :sin_addr, InAddr,
+                 :sin_zero, [:char, 8]
 
           def s_addr
             self[:sin_addr][:s_addr]
@@ -117,11 +117,11 @@ module Facter
         end
 
         class SockaddrIn6 < ::FFI::Struct
-          layout  :sin6_family, :sa_family_t,
-                  :sin6_port, :in_port_t,
-                  :sin6_flowinfo, :uint32_t,
-                  :sin6_addr, In6Addr,
-                  :sin6_scope_id, :uint32_t
+          layout :sin6_family, :sa_family_t,
+                 :sin6_port, :in_port_t,
+                 :sin6_flowinfo, :uint32_t,
+                 :sin6_addr, In6Addr,
+                 :sin6_scope_id, :uint32_t
         end
       end
     end

data/lib/facter/resolvers/windows/netkvm.rb

@@ -23,9 +23,8 @@ module Facter
         end
 
         def build_fact_list(reg)
-          # rubocop:disable Performance/InefficientHashSearch
+          # rubocop:disable-next Performance/InefficientHashSearch
           @fact_list[:kvm] = reg.keys.include?('netkvm')
-          # rubocop:enable Performance/InefficientHashSearch
         end
       end
     end

data/lib/facter/util/file_helper.rb

@@ -15,19 +15,18 @@ module Facter
           default_return
         end
 
-        # rubocop:disable Style/SpecialGlobalVars
+        # rubocop:disable-next Style/SpecialGlobalVars
         def safe_readlines(path, default_return = [], sep = $/, chomp: false)
           return File.readlines(path, sep, chomp: chomp, encoding: Encoding::UTF_8) if File.readable?(path)
 
           log_failed_to_read(path)
           default_return
         end
-        # rubocop:enable Style/SpecialGlobalVars
 
         # This previously acted as a helper method for versions of Ruby older
         # than 2.5, before Dir.children was added. As it isn't a private
-        # method, we can't remove it entirely until the next major Facter
-        # release (presumably Facter 5).
+        # method, we can't remove it entirely until the next major OpenFact
+        # release.
         def dir_children(path)
           Dir.children(path)
         end

data/lib/facter/util/resolvers/http.rb

@@ -6,6 +6,8 @@ module Facter
       module Http
         @log = Facter::Log.new(self)
 
+        class RequestError < StandardError; end
+
         class << self
           CONNECTION_TIMEOUT = 0.6
           SESSION_TIMEOUT = 5
@@ -27,6 +29,15 @@ module Facter
             make_request(url, headers, timeouts, 'GET', proxy)
           end
 
+          # Makes a GET HTTP request and returns its response body.
+          #
+          # Unlike get_request, this method raises when the response code is
+          # not 200 or when the request fails. A successful empty response is
+          # still returned as an empty string.
+          def get_request!(url, headers = {}, timeouts = {}, proxy = true)
+            make_request!(url, headers, timeouts, 'GET', proxy)
+          end
+
           # Makes a PUT HTTP request and returns its response
           # @param (see #get_request)
           # @return (see #get_request)
@@ -37,6 +48,28 @@ module Facter
           private
 
           def make_request(url, headers, timeouts, request_type, proxy)
+            response = perform_request(url, headers, timeouts, request_type, proxy)
+
+            successful_response?(response) ? response.body : ''
+          rescue StandardError => e
+            @log.debug("Trying to connect to #{url} but got: #{e.message}")
+            ''
+          end
+
+          def make_request!(url, headers, timeouts, request_type, proxy)
+            response = perform_request(url, headers, timeouts, request_type, proxy)
+
+            return response.body if successful_response?(response)
+
+            raise RequestError, "Request to #{url} failed with HTTP status #{response.code}"
+          rescue RequestError
+            raise
+          rescue StandardError => e
+            @log.debug("Trying to connect to #{url} but got: #{e.message}")
+            raise
+          end
+
+          def perform_request(url, headers, timeouts, request_type, proxy)
             require 'net/http'
 
             uri = URI.parse(url)
@@ -52,11 +85,7 @@ module Facter
             # Make the request
             response = http.request(request)
             response.uri = url
-
-            successful_response?(response) ? response.body : ''
-          rescue StandardError => e
-            @log.debug("Trying to connect to #{url} but got: #{e.message}")
-            ''
+            response
           end
 
           def http_obj(parsed_url, timeouts, proxy)

data/lib/facter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Facter
-  VERSION = '6.0.0' unless defined?(VERSION)
+  VERSION = '6.1.0' unless defined?(VERSION)
 end

data/lib/facter.rb

@@ -15,7 +15,7 @@ module Facter
   @already_searched = {}
 
   class << self
-    # Method used by puppet-agent to retrieve facts
+    # Method used by openvox-agent to retrieve facts
     # @param args_as_string [string] facter cli arguments
     #
     # @return [Hash<String, Object>]
@@ -45,8 +45,8 @@ module Facter
       Hash[queried_facts(cli.args)]
     end
 
-    # Method used by cli to set puppet paths
-    # in order to retrieve puppet custom and external facts
+    # Method used by cli to set OpenVox paths
+    # in order to retrieve OpenVox custom and external facts
     #
     # @return nil
     #
@@ -54,7 +54,7 @@ module Facter
     def puppet_facts
       require 'puppet'
 
-      # don't allow puppet logger to be injected in Facter
+      # don't allow the OpenVox logger to be injected in OpenFact
       Options[:allow_external_loggers] = false
 
       Puppet.initialize_settings
@@ -69,7 +69,7 @@ module Facter
         end
       end
     rescue LoadError => e
-      logger.error("Could not load puppet gem, got #{e}")
+      logger.error("Could not load the openvox gem, got #{e}")
     end
 
     # Alias method for Facter.fact()
@@ -375,7 +375,7 @@ module Facter
     # @api public
     def to_hash
       log_blocked_facts
-      logger.debug("Facter version: #{Facter::VERSION}")
+      logger.debug("OpenFact version: #{Facter::VERSION}")
 
       resolved_facts = Facter::FactManager.instance.resolve_facts
       resolved_facts.reject! { |fact| fact.type == :custom && fact.value.nil? }
@@ -439,7 +439,7 @@ module Facter
       @already_searched[user_query]
     end
 
-    # Returns Facter version
+    # Returns OpenFact version
     #
     # @return [String] Current version
     #
@@ -456,7 +456,7 @@ module Facter
     def to_user_output(cli_options, *args)
       init_cli_options(cli_options)
       logger.info("executed with command line: #{ARGV.drop(1).join(' ')}")
-      logger.debug("Facter version: #{Facter::VERSION}")
+      logger.debug("OpenFact version: #{Facter::VERSION}")
       log_blocked_facts
       resolved_facts = resolve_facts_for_user_query(args)
       fact_formatter = Facter::FormatterFactory.build(Facter::Options.get)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openfact
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - OpenVox Project
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.88.0
+        version: 1.90.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.88.0
+        version: 1.90.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement