facter 4.0.28

data/acceptance/tests/options/verbose.rb

@@ -0,0 +1,12 @@
+# This test is intended to ensure that the --verbose command-line option
+# works properly. This option provides verbose (INFO) output to stderr.
+test_name "C99986: --verbose command-line option prints verbose information to stderr" do
+
+  agents.each do |agent|
+    step "Agent #{agent}: retrieve verbose info from stderr using --verbose option" do
+      on(agent, facter('--verbose')) do
+        assert_match(/INFO .* executed with command line: --verbose/, stderr, "Expected stderr to contain verbose (INFO) statements")
+      end
+    end
+  end
+end

data/acceptance/tests/options/version.rb

@@ -0,0 +1,12 @@
+# This test is intended to ensure that the --version command-line option works
+# properly. This option outputs the current Facter version.
+test_name "C99983: --version command-line option returns the version string" do
+
+  agents.each do |agent|
+    step "Agent #{agent}: retrieve version info using the --version option" do
+      on(agent, facter('--version')) do
+        assert_match(/\d+\.\d+\.\d+/, stdout, "Output #{stdout} is not a recognized version string")
+      end
+    end
+  end
+end

data/acceptance/tests/options/yaml.rb

@@ -0,0 +1,43 @@
+# This test is intended to ensure that the --yaml command-line option works
+# properly. This option causes Facter to output facts in YAML format.
+# A custom fact is used to test for parity between Facter's output and
+# the expected YAML output.
+test_name "C99967: --yaml command-line option results in valid YAML output" do
+
+  require 'yaml'
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  content = <<EOM
+Facter.add('structured_fact') do
+  setcode do
+    { "foo" => {"nested" => "value1"}, "bar" => "value2", "baz" => "value3" }
+  end
+end
+EOM
+
+  agents.each do |agent|
+    step "Agent #{agent}: create a structured custom fact" do
+      custom_dir = get_user_fact_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+      custom_fact = File.join(custom_dir, 'custom_fact.rb')
+      on(agent, "mkdir -p '#{custom_dir}'")
+      create_remote_file(agent, custom_fact, content)
+      on(agent, "chmod +x '#{custom_fact}'")
+
+      teardown do
+        on(agent, "rm -f '#{custom_fact}'")
+      end
+
+      step "Agent #{agent}: retrieve output using the --yaml option" do
+        on(agent, facter("--custom-dir '#{custom_dir}' --yaml structured_fact")) do
+          begin
+            expected = {"structured_fact" => {"foo" => {"nested" => "value1"}, "bar" => "value2", "baz" => "value3" }}
+            assert_equal(expected, YAML.load(stdout), "YAML output does not match expected output")
+          rescue
+            fail_test "Couldn't parse output as YAML"
+          end
+        end
+      end
+    end
+  end
+end

data/acceptance/tests/ticket_1123_facter_with_invalid_locale.rb

@@ -0,0 +1,23 @@
+test_name 'C89524: facter should not crash with invalid locale setting' do
+  tag 'risk:high', 'facter_3'
+
+
+  confine :except, :platform => 'windows'
+  confine :except, :platform => /^cisco_/ # See CISCO-43
+  confine :except, :platform => /^huawei/ # See HUAWEI-24
+
+  agents.each do |agent|
+    step 'facter should run when started with an invalid locale' do
+      on(agent, facter('facterversion'), :environment => {'LANG' => 'ABCD'}) do |facter_output|
+        assert_match(/^\d+\.\d+\.\d+$/, facter_output.stdout, 'facter did not continue running')
+
+        if agent['platform'] !~ /solaris|aix|cumulus|osx/
+          step 'facter should return an error message when started with an invalid locale' do
+            assert_match(/locale environment variables were bad; continuing with LANG=C LC_ALL=C/, facter_output.stderr,
+                         'Expected facter to return a locale error message')
+          end
+        end
+      end
+    end
+  end
+end

data/acceptance/tests/ticket_1238_hostname_fqdn.rb

@@ -0,0 +1,57 @@
+test_name 'C93827: facter fqdn should return the hostname when its a fully qualified domain name' do
+  tag 'risk:high'
+  require 'timeout'
+
+  confine :except, :platform => 'windows'
+
+  fqdn = 'foo.bar.example.org'
+  fqdn_long = 'a23456789.b23456789.c23456789.d23456789.e23456789.f23456789.wxyz'
+
+  agents.each do |agent|
+    orig_hostname = on(agent, 'hostname').stdout.chomp
+
+    teardown do
+      step 'restore original hostname' do
+        on(agent, "hostname #{orig_hostname}")
+      end
+    end
+
+    step "set hostname as #{fqdn}" do
+      on(agent, "hostname #{fqdn}")
+      begin
+        Timeout.timeout(20) do
+          until on(agent, 'hostname').stdout =~ /#{fqdn}/
+            sleep(0.25) # on Solaris 11 hostname returns before the hostname is updated
+          end
+        end
+      rescue Timeout::Error
+        raise "Failed to reset the hostname of the test machine to #{fqdn}"
+      end
+    end
+
+    step 'validate facter uses hostname as the fqdn if its a fully qualified domain name' do
+      on(agent, 'facter fqdn') do |facter_output|
+        assert_equal(fqdn, facter_output.stdout.chomp, 'facter did not return the hostname set by the test')
+      end
+    end
+  end
+
+  step "long hostname as #{fqdn_long}" do
+    on(agent, "hostname #{fqdn_long}")
+    begin
+      Timeout.timeout(20) do
+        until on(agent, 'hostname').stdout =~ /#{fqdn_long}/
+          sleep(0.25) # on Solaris 11 hostname returns before the hostname is updated
+        end
+      end
+    rescue Timeout::Error
+      raise "Failed to reset the hostname of the test machine to #{fqdn_long}"
+    end
+  end
+
+  step 'validate facter uses hostname as the LONG fqdn if its a fully qualified domain name' do
+    on(agent, 'facter fqdn') do |facter_output|
+      assert_equal(fqdn_long, facter_output.stdout.chomp, 'facter did not return the hostname set by the test')
+    end
+  end
+end

data/agent/facter-ng.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative '../config/config'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'facter-ng'
+  spec.version       = FACTER_VERSION
+  spec.authors       = ['Puppet']
+  spec.email         = ['team-nw@puppet.com']
+
+  spec.summary       = 'New version of Facter'
+  spec.description   = 'New version of Facter'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = if system('git --help > /dev/null')
+                 `git ls-files -z`.split("\x0")
+               else
+                 Dir.glob('**/*')
+               end
+
+  spec.required_ruby_version = '~> 2.3'
+  spec.files.reject! do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.files.reject! do |f|
+    f == 'bin/facter'
+  end
+
+  spec.bindir = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['agent/lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8.23'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.74.0'
+  spec.add_development_dependency 'rubycritic', '~> 4.1.0'
+
+  spec.add_runtime_dependency 'ffi', '~> 1.9'
+  spec.add_runtime_dependency 'hocon', '~> 1.3'
+  spec.add_runtime_dependency 'sys-filesystem', '~> 1.3' unless Gem.win_platform?
+  spec.add_runtime_dependency 'thor', ['>= 1.0.1', '< 2.0']
+end

data/agent/lib/facter-ng.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+ROOT_DIR = Pathname.new(File.expand_path('../../', __dir__)) unless defined?(ROOT_DIR)
+
+require "#{ROOT_DIR}/lib/facter"

data/bin/facter

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pathname'
+ROOT_DIR = Pathname.new(File.expand_path('..', __dir__)) unless defined?(ROOT_DIR)
+require "#{ROOT_DIR}/lib/framework/cli/cli_launcher.rb"
+
+cli_launcher = CliLauncher.new(ARGV)
+
+cli_launcher.validate_options
+cli_launcher.prepare_arguments
+cli_launcher.start

data/check.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+set -e
+
+# run unit tests
+rspec
+
+# run linting
+rubocop --parallel
+
+# It will be disabled untill we rewrite it's rules
+# rubycritic --no-browser -f console

data/config/config.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'pathname'
+ROOT_DIR = Pathname.new(File.expand_path('..', __dir__)) unless defined?(ROOT_DIR)
+
+FACTER_VERSION = File.read("#{ROOT_DIR}/VERSION").strip

data/custom_facts/my_custom_fact.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Facter.add(:my_custom_fact) do
+  has_weight(10_000)
+  setcode do
+    # 'my_custom_fact'
+    Facter.value('os')
+  end
+end

data/custom_facts/my_custom_os_fact.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+Facter.add(:oss) do
+  has_weight(10_000)
+  setcode do
+    'my_custom_os'
+  end
+end

data/external_facts/my_external_fact.txt

@@ -0,0 +1 @@
+my_external_fact=123

data/fact_groups.conf

@@ -0,0 +1,169 @@
+{
+	"EC2": [
+		"ec2_metadata",
+		"ec2_userdata"
+	],
+	"GCE": [
+		"gce"
+	],
+	"augeas": [
+		"augeas",
+		"augeasversion"
+	],
+	"desktop management interface": [
+		"dmi",
+		"bios_vendor",
+		"bios_version",
+		"bios_release_date",
+		"boardassettag",
+		"boardmanufacturer",
+		"boardproductname",
+		"boardserialnumber",
+		"chassisassettag",
+		"manufacturer",
+		"productname",
+		"serialnumber",
+		"uuid",
+		"chassistype"
+	],
+	"file system": [
+		"mountpoints",
+		"filesystems",
+		"partitions"
+	],
+	"hypervisors": [
+		"hypervisors"
+	],
+	"id": [
+		"id",
+		"gid",
+		"identity"
+	],
+	"kernel": [
+		"kernel",
+		"kernelversion",
+		"kernelrelease",
+		"kernelmajversion"
+	],
+	"load_average": [
+		"load_averages"
+	],
+	"memory": [
+		"memory",
+		"memoryfree",
+		"memoryfree_mb",
+		"memorysize",
+		"memorysize_mb",
+		"swapfree",
+		"swapfree_mb",
+		"swapsize",
+		"swapsize_mb",
+		"swapencrypted"
+	],
+	"networking": [
+		"networking",
+		"hostname",
+		"ipaddress",
+		"ipaddress6",
+		"netmask",
+		"netmask6",
+		"network",
+		"network6",
+		"macaddress",
+		"interfaces",
+		"domain",
+		"fqdn",
+		"dhcp_servers"
+	],
+	"operating system": [
+		"os",
+		"operatingsystem",
+		"osfamily",
+		"operatingsystemrelease",
+		"operatingsystemmajrelease",
+		"hardwaremodel",
+		"architecture",
+		"lsbdistid",
+		"lsbdistrelease",
+		"lsbdistcodename",
+		"lsbdistdescription",
+		"lsbmajdistrelease",
+		"lsbminordistrelease",
+		"lsbrelease",
+		"macosx_buildversion",
+		"macosx_productname",
+		"macosx_productversion",
+		"macosx_productversion_major",
+		"macosx_productversion_minor",
+		"windows_edition_id",
+		"windows_installation_type",
+		"windows_product_name",
+		"windows_release_id",
+		"system32",
+		"selinux",
+		"selinux_enforced",
+		"selinux_policyversion",
+		"selinux_current_mode",
+		"selinux_config_mode",
+		"selinux_config_policy"
+	],
+	"path": [
+		"path"
+	],
+	"processor": [
+		"processors",
+		"processorcount",
+		"physicalprocessorcount",
+		"hardwareisa"
+	],
+	"ssh": [
+		"ssh",
+		"sshdsakey",
+		"sshrsakey",
+		"sshecdsakey",
+		"sshed25519key",
+		"sshfp_dsa",
+		"sshfp_rsa",
+		"sshfp_ecdsa",
+		"sshfp_ed25519"
+	],
+	"system profiler": [
+		"system_profiler",
+		"sp_boot_mode",
+		"sp_boot_rom_version",
+		"sp_boot_volume",
+		"sp_cpu_type",
+		"sp_current_processor_speed",
+		"sp_kernel_version",
+		"sp_l2_cache_core",
+		"sp_l3_cache",
+		"sp_local_host_name",
+		"sp_machine_model",
+		"sp_machine_name",
+		"sp_number_processors",
+		"sp_os_version",
+		"sp_packages",
+		"sp_physical_memory",
+		"sp_platform_uuid",
+		"sp_secure_vm",
+		"sp_serial_number",
+		"sp_smc_version_system",
+		"sp_uptime",
+		"sp_user_name"
+	],
+	"timezone": [
+		"timezone"
+	],
+	"uptime": [
+		"system_uptime",
+		"uptime",
+		"uptime_days",
+		"uptime_hours",
+		"uptime_seconds"
+	],
+	"virtualization": [
+		"virtual",
+		"is_virtual",
+		"cloud"
+	]
+}

data/facter.conf

@@ -0,0 +1,25 @@
+facts : {
+  blocklist : [ "file system", "EC2", "os.name" ],
+  ttls : [
+    { "timezone" : 30 days },
+  ]
+}
+global : {
+  external-dir     : [ "./external_facts"],
+  custom-dir       : [ "./custom-facts", "./custom-facts2" ],
+  no-external-facts : false,
+  no-custom-facts  : false,
+  no-ruby          : false
+  show-legacy      : false
+}
+
+cli : {
+  debug     : false,
+  trace     : true,
+  verbose   : false,
+  log-level : "warn"
+}
+
+fact-groups : {
+  cached-custom-facts : ["my_custom_fact"],
+}