facter 4.0.28 → 4.0.33

data/lib/{resolvers → facter/resolvers}/utils/networking.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'ipaddr'
+
 module Resolvers
   module Utils
     module Networking
@@ -17,11 +19,12 @@ module Resolvers
           { address: addr, netmask: mask.to_s, network: ip.mask(mask_length).to_s }
         end
 
-        def expand_main_bindings(interfaces)
-          interfaces.each_value do |values|
-            expand_binding(values, values[:bindings]) if values[:bindings]
-            expand_binding(values, values[:bindings6], false) if values[:bindings6]
-          end
+        def expand_main_bindings(networking_facts)
+          primary = networking_facts[:primary_interface]
+          interfaces = networking_facts[:interfaces]
+
+          expand_interfaces(interfaces) unless interfaces.nil?
+          expand_primary_interface(networking_facts, primary) unless primary.nil? || interfaces.nil?
         end
 
         def get_scope(ip)
@@ -55,6 +58,19 @@ module Resolvers
 
         private
 
+        def expand_interfaces(interfaces)
+          interfaces.each_value do |values|
+            expand_binding(values, values[:bindings]) if values[:bindings]
+            expand_binding(values, values[:bindings6], false) if values[:bindings6]
+          end
+        end
+
+        def expand_primary_interface(networking_facts, primary)
+          networking_facts[:interfaces][primary].each do |key, value|
+            networking_facts[key] = value unless %i[bindings bindings6].include?(key)
+          end
+        end
+
         def expand_binding(values, bindings, ipv4_type = true)
           binding = find_valid_binding(bindings)
           ip_protocol_type = ipv4_type ? '' : '6'

data/lib/{resolvers → facter/resolvers}/windows/ffi/hardware_ffi.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ffi"
-require "#{ROOT_DIR}/lib/resolvers/windows/ffi/system_info"
+require 'facter/resolvers/windows/ffi/ffi'
+require 'facter/resolvers/windows/ffi/system_info'
 
 module HardwareFFI
   extend FFI::Library

data/lib/{resolvers → facter/resolvers}/windows/ffi/identity_ffi.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ffi"
+require 'facter/resolvers/windows/ffi/ffi'
 
 module IdentityFFI
   extend FFI::Library

data/lib/{resolvers → facter/resolvers}/windows/ffi/kernel_ffi.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ffi"
-require "#{ROOT_DIR}/lib/resolvers/windows/ffi/os_version_info_ex"
+require 'facter/resolvers/windows/ffi/ffi'
+require 'facter/resolvers/windows/ffi/os_version_info_ex'
 
 module KernelFFI
   extend FFI::Library

data/lib/{resolvers → facter/resolvers}/windows/ffi/memory_ffi.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ffi"
-require "#{ROOT_DIR}/lib/resolvers/windows/ffi/performance_information"
+require 'facter/resolvers/windows/ffi/ffi'
+require 'facter/resolvers/windows/ffi/performance_information'
 
 module MemoryFFI
   extend FFI::Library

data/lib/{resolvers → facter/resolvers}/windows/ffi/network_utils.rb

@@ -34,32 +34,5 @@ class NetworkUtils
                                .map { |e| format('%<mac_address>02x', mac_address: e.to_i) }
                                .join(':').upcase
     end
-
-    def build_binding(addr, mask_length)
-      ip = IPAddr.new(addr)
-      mask = if ip.ipv6?
-               IPAddr.new('ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff').mask(mask_length)
-             else
-               IPAddr.new('255.255.255.255').mask(mask_length)
-             end
-      { address: addr, netmask: mask.to_s, network: ip.mask(mask_length).to_s }
-    end
-
-    def get_scope(sockaddr)
-      require 'socket'
-      scope6 = []
-      addrinfo = Addrinfo.new(['AF_INET6', 0, nil, sockaddr], :INET6)
-
-      scope6 << 'compat,' if addrinfo.ipv6_v4compat?
-      scope6 << if addrinfo.ipv6_linklocal?
-                  'link'
-                elsif addrinfo.ipv6_sitelocal?
-                  'site'
-                elsif addrinfo.ipv6_loopback?
-                  'host'
-                else 'global'
-                end
-      scope6.join
-    end
   end
 end

data/lib/{resolvers → facter/resolvers}/windows/ffi/networking_ffi.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ffi"
-require "#{ROOT_DIR}/lib/resolvers/windows/ffi/network_utils"
-require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ip_adapter_addresses_lh"
+require 'facter/resolvers/windows/ffi/ffi'
+require 'facter/resolvers/windows/ffi/network_utils'
+require 'facter/resolvers/windows/ffi/ip_adapter_addresses_lh'
 
 module NetworkingFFI
   extend FFI::Library

data/lib/{resolvers → facter/resolvers}/windows/ffi/system32_ffi.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ffi"
+require 'facter/resolvers/windows/ffi/ffi'
 
 module System32FFI
   extend FFI::Library

data/lib/{resolvers → facter/resolvers}/windows/hardware_architecture_resolver.rb

@@ -13,7 +13,7 @@ module Facter
         end
 
         def read_hardware_information(fact_name)
-          require "#{ROOT_DIR}/lib/resolvers/windows/ffi/hardware_ffi"
+          require 'facter/resolvers/windows/ffi/hardware_ffi'
 
           sys_info_ptr = FFI::MemoryPointer.new(SystemInfo.size)
           HardwareFFI::GetNativeSystemInfo(sys_info_ptr)

data/lib/{resolvers → facter/resolvers}/windows/identity_resolver.rb

@@ -16,7 +16,7 @@ module Facter
         end
 
         def find_username
-          require "#{ROOT_DIR}/lib/resolvers/windows/ffi/identity_ffi"
+          require 'facter/resolvers/windows/ffi/identity_ffi'
 
           size_ptr = FFI::MemoryPointer.new(:win32_ulong, 1)
           IdentityFFI::GetUserNameExW(NAME_SAM_COMPATIBLE, FFI::Pointer::NULL, size_ptr)

data/lib/{resolvers → facter/resolvers}/windows/kernel_resolver.rb

@@ -14,7 +14,7 @@ module Facter
         end
 
         def read_os_version_information(fact_name)
-          require "#{ROOT_DIR}/lib/resolvers/windows/ffi/kernel_ffi"
+          require 'facter/resolvers/windows/ffi/kernel_ffi'
 
           ver_ptr = FFI::MemoryPointer.new(OsVersionInfoEx.size)
           ver = OsVersionInfoEx.new(ver_ptr)

data/lib/{resolvers → facter/resolvers}/windows/memory_resolver.rb

@@ -14,7 +14,7 @@ module Facter
         end
 
         def read_performance_information
-          require "#{ROOT_DIR}/lib/resolvers/windows/ffi/memory_ffi"
+          require 'facter/resolvers/windows/ffi/memory_ffi'
 
           state_ptr = FFI::MemoryPointer.new(PerformanceInformation.size)
           if MemoryFFI::GetPerformanceInfo(state_ptr, state_ptr.size) == FFI::WIN32FALSE

data/lib/{resolvers → facter/resolvers}/windows/networking_resolver.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'ipaddr'
-
 module Facter
   module Resolvers
     class Networking < BaseResolver
@@ -16,7 +14,7 @@ module Facter
         end
 
         def read_network_information(fact_name)
-          require "#{ROOT_DIR}/lib/resolvers/windows/ffi/networking_ffi"
+          require 'facter/resolvers/windows/ffi/networking_ffi'
 
           size_ptr = FFI::MemoryPointer.new(NetworkingFFI::BUFFER_LENGTH)
           adapter_addresses = FFI::MemoryPointer.new(IpAdapterAddressesLh.size, NetworkingFFI::BUFFER_LENGTH)
@@ -26,8 +24,9 @@ module Facter
           return unless (adapter_addresses = get_adapter_addresses(size_ptr, adapter_addresses, flags))
 
           iterate_list(adapter_addresses)
-          set_interfaces_other_facts if @fact_list[:interfaces]
-          @fact_list[:primary_interface] = @fact_list[:primary_interface].to_s
+
+          ::Resolvers::Utils::Networking.expand_main_bindings(@fact_list)
+
           @fact_list[fact_name]
         end
 
@@ -70,7 +69,7 @@ module Facter
               next
             end
             @fact_list[:domain] ||= adapter_address[:DnsSuffix].read_wide_string_without_length
-            name = adapter_address[:FriendlyName].read_wide_string_without_length.to_sym
+            name = adapter_address[:FriendlyName].read_wide_string_without_length
             net_interface[name] = build_interface_info(adapter_address, name)
           end
 
@@ -120,58 +119,14 @@ module Facter
         def find_bindings(sock_addr, unicast, addr)
           return unless [NetworkingFFI::AF_INET, NetworkingFFI::AF_INET6].include?(sock_addr[:sa_family])
 
-          NetworkUtils.build_binding(addr, unicast[:OnLinkPrefixLength])
+          ::Resolvers::Utils::Networking.build_binding(addr, unicast[:OnLinkPrefixLength])
         end
 
         def find_primary_interface(sock_addr, name, addr)
           if !@fact_list[:primary_interface] &&
              ([NetworkingFFI::AF_INET, NetworkingFFI::AF_INET6].include?(sock_addr[:sa_family]) &&
-                 !NetworkUtils.ignored_ip_address(addr))
-            @fact_list[:primary_interface] = name
-          end
-        end
-
-        def set_interfaces_other_facts
-          @fact_list[:interfaces].each do |interface_name, value|
-            if value[:bindings]
-              binding = find_valid_binding(value[:bindings])
-              populate_interface(binding, value)
-            end
-            if value[:bindings6]
-              binding = find_valid_binding(value[:bindings6])
-              populate_interface(binding, value, true)
-            end
-            set_networking_other_facts(value, interface_name)
-          end
-        end
-
-        def find_valid_binding(bindings)
-          bindings.each do |binding|
-            return binding unless NetworkUtils.ignored_ip_address(binding[:address])
-          end
-          bindings.empty? ? nil : bindings.first
-        end
-
-        def populate_interface(bind, interface, ipv6 = false)
-          return if !bind || bind.empty?
-
-          if ipv6
-            interface[:ip6] = bind[:address]
-            interface[:netmask6] = bind[:netmask]
-            interface[:network6] = bind[:network]
-            interface[:scope6] =  NetworkUtils.get_scope(bind[:address])
-          else
-            interface[:network] = bind[:network]
-            interface[:netmask] = bind[:netmask]
-            interface[:ip] = bind[:address]
-          end
-        end
-
-        def set_networking_other_facts(value, interface_name)
-          return unless @fact_list[:primary_interface] == interface_name
-
-          %i[mtu dhcp mac ip ip6 scope6 netmask netmask6 network network6].each do |key|
-            @fact_list[key] = value[key]
+                 !::Resolvers::Utils::Networking.ignored_ip_address(addr))
+            @fact_list[:primary_interface] = name.to_s
           end
         end
       end

data/lib/{resolvers → facter/resolvers}/windows/system32_resolver.rb

@@ -14,7 +14,7 @@ module Facter
         end
 
         def retrieve_windows_binaries_path
-          require "#{ROOT_DIR}/lib/resolvers/windows/ffi/system32_ffi"
+          require 'facter/resolvers/windows/ffi/system32_ffi'
 
           windows_path = ENV['SystemRoot']
 

data/lib/facter/resolvers/xen.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Facter
+  module Resolvers
+    class Xen < BaseResolver
+      @semaphore = Mutex.new
+      @fact_list ||= {}
+
+      XEN_PATH = '/proc/xen/capabilities'
+
+      class << self
+        private
+
+        def post_resolve(fact_name)
+          @fact_list.fetch(fact_name) { detect_xen(fact_name) }
+        end
+
+        def detect_xen(fact_name)
+          @fact_list[:vm] = detect_xen_type
+          @fact_list[:privileged] = privileged?(@fact_list[:vm])
+
+          @fact_list[fact_name]
+        end
+
+        def detect_xen_type
+          xen_type = 'xen0' if File.exist?('/dev/xen/evtchn')
+          xen_type = 'xenu' if !xen_type && (File.exist?('/proc/xen') || File.exist?('/dev/xvda1'))
+
+          xen_type
+        end
+
+        def privileged?(xen_type)
+          content = Util::FileHelper.safe_read(XEN_PATH, nil)
+          content&.strip == 'control_d' || xen_type == 'xen0'
+        end
+      end
+    end
+  end
+end

data/lib/facter/templates/man.erb

@@ -0,0 +1,122 @@
+<%# encoding: UTF-8%>
+SYNOPSIS
+--------
+  facter [options] [query] [query] [...]
+
+DESCRIPTION
+-----------
+Collect and display facts about the current system. The library behind Facter is easy to extend, making Facter an easy way to collect information about a system.
+
+If no queries are given, then all facts will be returned.
+
+Many of the command line options can also be set via the HOCON config file. This file can also be used to block or cache certain fact groups.
+
+OPTIONS
+-------
+<% @Facter::Cli.class_options.each do |name, option| -%><% next if option.hide%>
+  * `<%= option.aliases[0] + '`, `' if option.aliases.any? %>--<%= 'no-' if negate_options.include?(name.to_s)%><%= name.to_s.gsub('_','-') %>`:
+
+    <%= option.description %>
+
+<% end -%>
+
+FILES
+-----
+<em>/etc/puppetlabs/facter/facter.conf</em>
+
+A HOCON config file that can be used to specify directories for custom and external facts, set various command line options, and specify facts to block. See example below for details, or visit the GitHub README.
+
+EXAMPLES
+--------
+Display all facts:
+
+```
+$ facter
+disks => {
+  sda => {
+    model => "Virtual disk",
+    size => "8.00 GiB",
+    size_bytes => 8589934592,
+    vendor => "ExampleVendor"
+  }
+}
+dmi => {
+  bios => {
+    release_date => "06/23/2013",
+    vendor => "Example Vendor",
+    version => "6.00"
+  }
+}
+[\.\.\.]
+```
+
+Display a single structured fact:
+
+```
+$ facter processors
+{
+  count => 2,
+  isa => "x86_64",
+  models => [
+    "Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz",
+    "Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz"
+  ],
+  physicalcount => 2
+}
+```
+
+Display a single fact nested within a structured fact:
+
+```
+$ facter processors.isa
+x86_64
+```
+
+Display a single legacy fact. Note that non-structured facts existing in previous versions of Facter are still available,
+but are not displayed by default due to redundancy with newer structured facts:
+
+```
+$ facter processorcount
+2
+```
+
+Format facts as JSON:
+
+```
+$ facter \-\-json os.name os.release.major processors.isa
+{
+  "os.name": "Ubuntu",
+  "os.release.major": "14.04",
+  "processors.isa": "x86_64"
+}
+```
+
+An example config file.
+
+```
+# always loaded (CLI and as Ruby module)
+global : {
+    external-dir : "~/external/facts",
+    custom-dir   :  [
+       "~/custom/facts",
+       "~/custom/facts/more-facts"
+    ],
+    no-external-facts : false,
+    no-custom-facts   : false,
+    no-ruby           : false
+}
+# loaded when running from the command line
+cli : {
+    debug     : false,
+    trace     : true,
+    verbose   : false,
+    log-level : "info"
+}
+# always loaded, fact-sepcific configuration
+facts : {
+    # for valid blocklist entries, use --list-block-groups
+    blocklist : [ "file system", "EC2" ],
+    # for valid time-to-live entries, use --list-cache-groups
+    ttls : [ { "timezone" : 30 days } ]
+}
+```