facter 4.0.28

data/lib/util/api_debugger.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ApiDebugger
+  def self.prepended(receiver) # rubocop:disable Metrics/AbcSize
+    exclude, print_caller = parse_options(ENV['API_DEBUG'])
+
+    receiver_methods = receiver.instance_methods - Object.methods
+    receiver_methods.each do |meth|
+      ApiDebugger.class_eval do
+        define_method(meth) do |*args|
+          method_call = super(*args)
+
+          unless exclude.include?(meth)
+            puts '#' * 80
+            puts "Method call: #{meth}"
+            puts "Called with: #{args.inspect}"
+            if print_caller.include?(meth)
+              puts '-' * 80
+              puts caller
+            end
+            puts '#' * 80
+          end
+          method_call
+        end
+      end
+    end
+  end
+
+  def self.parse_options(options)
+    exclude = []
+    print_caller = []
+
+    options.split(',').each do |option|
+      if option.start_with?('-')
+        exclude << option[1..-1].to_sym
+      elsif option.start_with?('+')
+        print_caller << option[1..-1].to_sym
+      end
+    end
+
+    [exclude, print_caller]
+  end
+end

data/lib/util/file_helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Facter
+  module Util
+    class FileHelper
+      @log = Log.new(self)
+
+      class << self
+        DEBUG_MESSAGE = 'File at: %s is not accessible.'
+
+        def safe_read(path, default_return = '')
+          return File.read(path) if File.readable?(path)
+
+          log_failed_to_read(path)
+          default_return
+        end
+
+        def safe_readlines(path, default_return = [])
+          return File.readlines(path) if File.readable?(path)
+
+          log_failed_to_read(path)
+          default_return
+        end
+
+        private
+
+        def log_failed_to_read(path)
+          @log.debug(DEBUG_MESSAGE % path)
+        end
+      end
+    end
+  end
+end

data/os_hierarchy.json

@@ -0,0 +1,37 @@
+[
+  {
+    "Linux": [
+      {
+        "Debian": [
+          "Elementary",
+          "Ubuntu",
+          "Raspbian"
+        ]
+      },
+      {
+        "Rhel": [
+          "Fedora",
+          "Amzn",
+          "Centos"
+        ]
+      },
+      {
+        "Sles": [
+          "Opensuse"
+        ]
+      }
+    ]
+  },
+  {
+    "Solaris": [
+      {
+        "Bsd": [
+          "Freebsd"
+        ]
+      }
+    ]
+  },
+  "Macosx",
+  "Windows",
+  "Aix"
+]

data/tasks/commits.rake

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+desc 'verify that commit messages match CONTRIBUTING.md requirements'
+task(:commits) do
+  # This rake task looks at the summary from every commit from this branch not
+  # in the branch targeted for a PR. This is accomplished by using the
+  # TRAVIS_COMMIT_RANGE environment variable, which is present in travis CI and
+  # populated with the range of commits the PR contains. If not available, this
+  # falls back to `master..HEAD` as a next best bet as `master` is unlikely to
+  # ever be absent.
+  commit_range = 'HEAD^..HEAD'
+  puts "Checking commits #{commit_range}"
+  `git log --no-merges --pretty=%s #{commit_range}`.each_line do |commit_summary|
+    # This regex tests for the currently supported commit summary tokens: maint, doc, gem, or fact-<number>.
+    # The exception tries to explain it in more full.
+    if /^\((maint|doc|docs|gem|fact-\d+)\)|revert|merge/i.match(commit_summary).nil?
+      raise "\n\n\n\tThis commit summary didn't match CONTRIBUTING.md guidelines:\n" \
+        "\n\t\t#{commit_summary}\n" \
+        "\tThe commit summary (i.e. the first line of the commit message) should start with one of:\n"  \
+        "\t\t(FACT-<digits>) # this is most common and should be a ticket at tickets.puppet.com\n" \
+        "\t\t(docs)\n" \
+        "\t\t(docs)(DOCUMENT-<digits>)\n" \
+        "\t\t(maint)\n" \
+        "\t\t(gem)\n" \
+        "\n\tThis test for the commit summary is case-insensitive.\n\n\n"
+    else
+      puts commit_summary.to_s
+    end
+    puts '...passed'
+  end
+end

data/tasks/create_fact.rake

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+desc 'Create a fact template for the specified arguments'
+task :create_fact, [:os, :fact_name] do |_, args|
+  require_relative 'fact_generator/fact_creator'
+
+  abort 'Usage: rake \'create_facts[os,fact_name]\'' if !args[:os] || !args[:fact_name]
+
+  fact_creator = FactCreator.new
+  fact_creator.create_fact(args[:os], args[:fact_name])
+end
+
+desc 'Create one or multiple facts by reading descriptions from facts.json'
+task :create_facts do
+  require_relative 'fact_generator/fact_creator'
+
+  fact_creator = FactCreator.new
+  fact_creator.create_facts
+end

data/tasks/fact_generator/fact.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Facter
+  module <%= os_name %>
+    class <%= camelcase_fact_name %>
+      FACT_NAME = '<%= fact_name %>'
+
+      def call_the_resolver
+        fact_value = 'should call a resolver'
+        ResolvedFact.new(FACT_NAME, fact_value)
+      end
+    end
+  end
+end

data/tasks/fact_generator/fact_creator.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'json'
+require 'pathname'
+require 'fileutils'
+require 'erb'
+
+ROOT_DIR = Pathname.new(File.expand_path('../..', __dir__)) unless defined?(ROOT_DIR)
+
+require "#{ROOT_DIR}/tasks/fact_generator/path"
+require "#{ROOT_DIR}/lib/framework/logging/multilogger"
+require "#{ROOT_DIR}/lib/framework/logging/legacy_logger"
+require "#{ROOT_DIR}/lib/framework/logging/logger"
+
+class FactCreator
+  def initialize
+    @log = Facter::Log.new(self)
+  end
+
+  def create_facts
+    facts_json_string = File.read(File.join(ROOT_DIR, 'tasks', 'fact_generator', 'facts.json'))
+    facts = JSON.parse(facts_json_string)
+
+    facts.each do |fact|
+      operating_system = fact['os']
+      fact_name = fact['fact_name']
+      create_fact(operating_system, fact_name)
+    end
+  end
+
+  def create_fact(operating_system, fact_name)
+    @log.info("Creating fact with name #{fact_name} for os #{operating_system}")
+
+    path = create_directory_path(operating_system, fact_name)
+    create_directory_structure(path)
+
+    create_fact_files(path, fact_name, operating_system)
+  end
+
+  private
+
+  def create_directory_path(operating_system, fact_name)
+    fact_tokens = fact_name.split('.')
+    fact_tokens = fact_tokens.first(fact_tokens.size - 1)
+
+    fact_directory = File.join(ROOT_DIR, 'lib', 'facts', operating_system, fact_tokens)
+    fact_spec_directory = File.join(ROOT_DIR, 'spec', 'facter', 'facts', operating_system, fact_tokens)
+    Path.new(fact_directory, fact_spec_directory)
+  end
+
+  def create_directory_structure(path)
+    FileUtils.mkdir_p(path.fact) unless File.directory?(path.fact)
+    FileUtils.mkdir_p(path.spec) unless File.directory?(path.spec)
+  end
+
+  def create_fact_files(path, fact_name, operating_system)
+    create_fact_file(path.fact, fact_name, operating_system)
+    create_spec_file(path.spec, fact_name, operating_system)
+  end
+
+  def create_fact_file(fact_path, fact_name, operating_system)
+    fact_tokens = fact_name.split('.')
+    fact_file_name = fact_tokens.reverse.first + '.rb'
+    fact_file_with_path = File.join(fact_path, fact_file_name)
+
+    return if File.exist?(fact_file_with_path)
+
+    fact_file = File.new(File.join(fact_path, fact_file_name), 'w')
+    fact_class_content = create_fact_from_template(fact_name, operating_system)
+    fact_file.write(fact_class_content)
+  end
+
+  def create_spec_file(spec_path, fact_name, operating_system)
+    fact_tokens = fact_name.split('.')
+    spec_file_name = fact_tokens.reverse.first + '_spec.rb'
+    spec_file_with_path = File.join(spec_path, spec_file_name)
+
+    return if File.exist?(spec_file_with_path)
+
+    spec_file = File.new(File.join(spec_path, spec_file_name), 'w')
+    spec_class_content = create_spec_from_template(fact_name, operating_system)
+    spec_file.write(spec_class_content)
+  end
+
+  def create_fact_from_template(fact_name, operating_system)
+    delimiters = ['.', '_']
+    fact_tokens = fact_name.split(Regexp.union(delimiters))
+    template = ERB.new(File.read(File.join(ROOT_DIR, 'tasks', 'fact_generator', 'fact.erb')))
+
+    os_name = operating_system.capitalize
+    camelcase_fact_name = fact_tokens.map(&:capitalize).join('')
+    template.result(binding)
+  end
+
+  def create_spec_from_template(fact_name, operating_system)
+    delimiters = ['.', '_']
+    fact_tokens = fact_name.split(Regexp.union(delimiters))
+    template = ERB.new(File.read(File.join(ROOT_DIR, 'tasks', 'fact_generator', 'fact_spec.erb')))
+
+    os_name = operating_system.capitalize
+    camelcase_fact_name = fact_tokens.map(&:capitalize).join('')
+    template.result(binding)
+  end
+end

data/tasks/fact_generator/fact_spec.erb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+describe '<%= os_name %> <%= camelcase_fact_name %>' do
+  context '#call_the_resolver' do
+    let(:value) { <fact_value> }
+    let(:expected_resolved_fact) { double(Facter::ResolvedFact, name: '<%= fact_name %>', value: value) }
+    subject(:fact) { Facter::<%= os_name %>::<%= camelcase_fact_name %>.new }
+
+    before do
+      expect(<resolver_name>).to receive(:resolve).with(<resolver_fact>).and_return(value)
+      expect(Facter::ResolvedFact).to receive(:new).with('<%= fact_name %>', value).and_return(expected_resolved_fact)
+    end
+
+    it 'returns <%= fact_name %> fact' do
+      expect(fact.call_the_resolver).to eq(expected_resolved_fact)
+    end
+  end
+end

data/tasks/fact_generator/facts.json

@@ -0,0 +1,358 @@
+[
+  {
+    "os":"macosx",
+    "fact_name":"aio_agent_version"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"augeas.version"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"dmi.product.name"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"facterversion"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"filesystems"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"identity.gid"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"identity.group"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"identity.privileged"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"identity.uid"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"identity.user"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"is_virtual"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"kernel"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"kernelmajversion"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"kernelrelease"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"kernelversion"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"load_averages"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.swap.available"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.swap.available_bytes"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.swap.capacity"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.swap.encrypted"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.swap.total"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.swap.total_bytes"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.swap.used"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.swap.used_bytes"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.system.available"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.system.available_bytes"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.system.capacity"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.system.total"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.system.total_bytes"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.system.used"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"memory.system.used_bytes"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"mountpoints"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.dhcp"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.domain"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.fqdn"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.hostname"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.interfaces"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.ip"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.ip6"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.mac"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.mtu"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.netmask"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.netmask6"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.network"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.network6"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"networking.primary"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"os.architecture"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"os.family"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"os.hardware"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"os.macosx.build"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"os.macosx.product"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"os.macosx.version"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"os.name"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"os.release"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"path"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"processors.count"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"processors.isa"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"processors.models"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"processors.physicalcount"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"processors.speed"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"ruby.platform"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"ruby.sitedir"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"ruby.version"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.boot_mode"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.boot_rom_version"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.boot_volume"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.computer_name"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.cores"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.hardware_uuid"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.kernel_version"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.l2_cache_per_core"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.l3_cache"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.memory"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.model_identifier"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.model_name"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.processor_name"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.processor_speed"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.processors"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.secure_virtual_memory"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.serial_number"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.system_version"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.uptime"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_profiler.username"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_uptime.days"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_uptime.hours"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_uptime.seconds"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"system_uptime.uptime"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"timezone"
+  },
+  {
+    "os":"macosx",
+    "fact_name":"virtual"
+  }
+]