facter 2.5.7 → 3.9.6.cfacter.20180606

data/ext/facter/facter/acceptance/tests/options/no_custom_facts.rb

@@ -0,0 +1,34 @@
+# This test verifies that --no-custom-facts does not load custom facts
+test_name "C64171: custom fact command line option --no-custom-facts does not load custom facts" do
+  tag 'risk:med'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  content = <<EOM
+Facter.add('custom_fact') do
+  setcode do
+    "testvalue"
+  end
+end
+EOM
+
+  agents.each do |agent|
+    step "Agent #{agent}: create custom fact directory and custom fact" do
+      custom_dir = get_user_fact_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+      on(agent, "mkdir -p '#{custom_dir}'")
+      custom_fact = File.join(custom_dir, 'custom_fact.rb')
+      create_remote_file(agent, custom_fact, content)
+
+      teardown do
+        on(agent, "rm -f '#{custom_fact}'")
+      end
+
+      step "Agent #{agent}: --no-custom-facts option should not load custom facts" do
+        on(agent, facter("--no-custom-facts custom_fact")) do |facter_output|
+          assert_equal("", facter_output.stdout.chomp, "Custom fact should not have resolved")
+        end
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/options/no_custom_facts_and_custom_dir.rb

@@ -0,0 +1,19 @@
+# This test verifies that calling facter with both --no-custom-facts and --custom-dir results
+# in an options conflict error
+test_name "C100001: custom fact commandline options --no-custom-facts together with --custom-dir should produce an error" do
+  tag 'risk:low'
+
+  agents.each do |agent|
+    custom_dir = agent.tmpdir('custom_dir')
+
+    teardown do
+      on(agent, "rm -rf '#{custom_dir}'")
+    end
+
+    step "Agent #{agent}: --no-custom-facts and --custom-dir options should result in a error" do
+      on(agent, facter("--no-custom-facts --custom-dir '#{custom_dir}'"), :acceptable_exit_codes => 1) do |facter_output|
+        assert_match(/options conflict/, facter_output.stderr.chomp, "Output does not contain error string")
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/options/no_custom_facts_and_facterlib.rb

@@ -0,0 +1,34 @@
+# This test verifies that --no-custom-facts keeps facter from loading facts from the environment
+# variable FACTERLIB
+test_name "C100000: custom fact commandline options --no-custom-facts does not load from FACTERLIB" do
+  tag 'risk:low'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  content = <<EOM
+Facter.add('custom_fact') do
+  setcode do
+    "testvalue"
+  end
+end
+EOM
+
+  agents.each do |agent|
+    step "Agent #{agent}: create a custom fact directory and fact" do
+      facterlib_dir = agent.tmpdir('facterlib')
+      custom_fact = File.join(facterlib_dir, 'custom_fact.rb')
+      create_remote_file(agent, custom_fact, content)
+
+      teardown do
+        on(agent, "rm -rf '#{facterlib_dir}'")
+      end
+
+      step "Agent #{agent}: --no-custom-facts should ignore the FACTERLIB environment variable" do
+        on(agent, facter('--no-custom-facts custom_fact', :environment => { 'FACTERLIB' => facterlib_dir })) do |facter_output|
+          assert_equal("", facter_output.stdout.chomp, "Custom fact in FACTERLIB should not have resolved")
+        end
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/options/no_custom_facts_and_load_path.rb

@@ -0,0 +1,43 @@
+# This tests verifies that when --no-custom-facts is used we do not look for
+# 'facter' subdirectories in the $LOAD_PATH
+#
+# Facter searches all directories in the Ruby $LOAD_PATH variable for subdirectories
+# named ‘facter’, and loads all Ruby files in those directories.
+test_name "C100003: custom fact commandline options --no-custom-facts does not load $LOAD_PATH facter directories" do
+  confine :except, :platform => 'cisco_nexus' # see BKR-749
+  tag 'risk:low'
+
+  require 'puppet/acceptance/common_utils'
+  extend Puppet::Acceptance::CommandUtils
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  content = <<EOM
+Facter.add('custom_fact') do
+  setcode do
+    "testvalue"
+  end
+end
+EOM
+
+  agents.each do |agent|
+    step("Agent #{agent}: determine the load path and create a custom facter directory on it") do
+      on(agent, "#{ruby_command(agent)} -e 'puts $LOAD_PATH[0]'")
+      load_path_facter_dir = File.join(stdout.chomp, 'facter')
+      on(agent, "mkdir -p \"#{load_path_facter_dir}\"")
+      custom_fact = File.join(load_path_facter_dir, 'custom_fact.rb')
+      create_remote_file(agent, custom_fact, content)
+
+      teardown do
+        on(agent, "rm -rf '#{load_path_facter_dir}'")
+      end
+
+      step("Agent #{agent}: using --no-custom-facts should not resolve facts on the $LOAD_PATH") do
+        on(agent, facter("--no-custom-facts custom_fact")) do |facter_output|
+          assert_equal("", facter_output.stdout.chomp, "Custom fact in $LOAD_PATH/facter should not have resolved")
+        end
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/options/no_external_facts.rb

@@ -0,0 +1,28 @@
+# This test verifies that --no-external-facts does not load external facts
+
+test_name "C99961: external fact command line option --no-external-facts does not load external facts" do
+  tag 'risk:medium'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  agents.each do |agent|
+    step "Agent #{agent}: create external fact directory and external fact" do
+      external_dir = agent.tmpdir('external_dir')
+      ext = get_external_fact_script_extension(agent['platform'])
+      external_fact = File.join(external_dir, "external_fact#{ext}")
+      create_remote_file(agent, external_fact, external_fact_content(agent['platform'], 'external_fact', 'external_value'))
+      on(agent, "chmod +x '#{external_fact}'")
+
+      teardown do
+        on(agent, "rm -rf '#{external_dir}'")
+      end
+
+      step "Agent #{agent}: --no-external-facts option should not load external facts" do
+        on(agent, facter("--no-external-facts external_fact")) do |facter_output|
+          assert_equal("", facter_output.stdout.chomp, "External fact should not have resolved")
+        end
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/options/no_external_facts_and_external_dir.rb

@@ -0,0 +1,19 @@
+# This test verifies that calling facter with both --no-external-facts and --external-dir results
+# in an options conflict error
+test_name "C100002: external fact commandline options --no-external-facts together with --external-dir should produce an error" do
+  tag 'risk:low'
+
+  agents.each do |agent|
+    external_dir = agent.tmpdir('external_dir')
+
+    teardown do
+      on(agent, "rm -rf '#{external_dir}'")
+    end
+
+    step "Agent #{agent}: --no-external-facts and --external-dir options should result in a error" do
+      on(agent, facter("--no-external-facts --external-dir '#{external_dir}'"), :acceptable_exit_codes => 1) do |facter_output|
+        assert_match(/options conflict/, facter_output.stderr.chomp, "Output does not contain error string")
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/options/no_ruby.rb

@@ -0,0 +1,44 @@
+# These tests are intended to ensure that the --no-ruby command-line option
+# works properly. The first ensures that the built in Ruby fact does not resolve
+# when using the --no-ruby fact, and also checks that the 'No Ruby' warning does
+# not appear in stderr. The second test ensures that custom facts are not resolved
+# when the --no-ruby option is present.
+test_name "C99987: --no-ruby commandline option" do
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  content = <<EOM
+Facter.add('custom_fact') do
+  setcode do
+    "testvalue"
+  end
+end
+EOM
+
+  agents.each do |agent|
+    step "--no-ruby option should disable Ruby and facts requiring ruby from being loaded" do
+      on(agent, facter("--no-ruby ruby")) do
+        assert_equal("", stdout.chomp, "Expected Ruby and Ruby fact to be disabled, but got output: #{stdout.chomp}")
+        assert_equal("", stderr.chomp, "Expected no warnings about Ruby on stderr, but got output: #{stderr.chomp}")
+      end
+    end
+
+    step "--no-ruby option should disable custom facts" do
+      step "Agent #{agent}: create custom fact directory and custom fact" do
+        custom_dir = get_user_fact_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+        on(agent, "mkdir -p '#{custom_dir}'")
+        custom_fact = File.join(custom_dir, 'custom_fact.rb')
+        create_remote_file(agent, custom_fact, content)
+
+        teardown do
+          on(agent, "rm -f '#{custom_fact}'")
+        end
+
+        on(agent, facter('--no-ruby custom_fact', :environment => { 'FACTERLIB' => custom_dir })) do
+          assert_equal("", stdout.chomp, "Expected custom fact to be disabled while using --no-ruby option, but it resolved as #{stdout.chomp}")
+        end
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/options/puppet_facts.rb

@@ -0,0 +1,35 @@
+# Verify that -p loads external and custom facts from puppet locations
+test_name "C14783: facter -p loads facts from puppet" do
+  tag 'risk:high'
+
+  agents.each do |agent|
+    external_dir = agent.puppet['pluginfactdest']
+    external_file = File.join(external_dir, "external.txt")
+    custom_dir = File.join(agent.puppet['plugindest'], "facter")
+    custom_file = "#{custom_dir}/custom.rb"
+
+    teardown do
+      on agent, "rm -f '#{external_file}' '#{custom_file}'"
+    end
+
+    step "Agent #{agent}: create external fact" do
+      on agent, "mkdir -p '#{external_dir}'"
+      create_remote_file(agent, external_file, "external=external")
+    end
+
+    step "Agent #{agent}: create custom fact" do
+      on agent, "mkdir -p '#{custom_dir}'"
+      create_remote_file(agent, custom_file, "Facter.add(:custom) { setcode { 'custom' } }")
+    end
+
+    step "Agent #{agent}: verify facts" do
+      on(agent, facter("-p external")) do |facter_output|
+        assert_equal("external", facter_output.stdout.chomp)
+      end
+
+      on(agent, facter("-p custom")) do |facter_output|
+        assert_equal("custom", facter_output.stdout.chomp)
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/options/show_legacy.rb

@@ -0,0 +1,18 @@
+# This test is intended to demonstrate that the `--show-legacy` command line option
+# causes hidden old facts to appear in the fact list.
+test_name "C87580: --show-legacy command-line option results in output with legacy (hidden) facts" do
+
+  agents.each do |agent|
+    step "Agent #{agent}: retrieve legacy output using a hash" do
+      on(agent, facter("--show-legacy")) do
+        assert_match(/^rubyversion => [0-9]+\.[0-9]+\.[0-9]+$/, stdout.chomp, 'hash legacy output does not contain legacy fact rubyversion')
+      end
+    end
+
+    step "Agent #{agent}: retrieve legacy output using the --json option" do
+      on(agent, facter("--show-legacy --json")) do
+        assert_match(/^  "rubyversion": "[0-9]+\.[0-9]+\.[0-9]+",$/, stdout.chomp, 'json legacy output does not contain legacy fact rubyversion')
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/options/strict.rb

@@ -0,0 +1,11 @@
+test_name 'C98098: --strict flag returns errors on non-existent facts' do
+  tag 'risk:high'
+
+  agents.each do |agent|
+    step 'facter should return exit code 1 for querying non-existing-fact with --strict flag' do
+      on(agent, facter('non-existing-fact --strict'), :acceptable_exit_codes => 1) do |facter_output|
+        assert_match(/ERROR\s+.* - fact "non-existing-fact" does not exist/, facter_output.stderr, 'Unexpected error was detected!')
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/options/trace.rb

@@ -0,0 +1,36 @@
+# This test is intended to ensure that the --trace command-line option works
+# properly. This option provides backtraces for erroring custom Ruby facts.
+# To test, we try to resolve an erroneous custom fact and catch the backtrace.
+test_name "C99982: --trace command-line option enables backtraces for custom facts" do
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  content = <<EOM
+Facter.add('custom_fact') do
+  setcode do
+    non_existent_value
+  end
+end
+EOM
+
+  agents.each do |agent|
+    step "Agent #{agent}: create custom fact directory and executable custom fact" do
+      custom_dir = get_user_fact_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+      on(agent, "mkdir -p '#{custom_dir}'")
+      custom_fact = File.join(custom_dir, 'custom_fact.rb')
+      create_remote_file(agent, custom_fact, content)
+      on(agent, "chmod +x '#{custom_fact}'")
+
+      teardown do
+        on(agent, "rm -f '#{custom_fact}'")
+      end
+
+      step "--trace option should provide a backtrace for a custom fact with errors" do
+        on(agent, facter("--custom-dir '#{custom_dir}' --trace custom_fact"), :acceptable_exit_codes => [1]) do
+          assert_match(/backtrace:\s+#{custom_fact}/, stderr, "Expected a backtrace for erroneous custom fact")
+        end
+      end
+    end
+  end
+end

data/ext/facter/facter/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  puppetlabs.facter - executed with command line: --verbose/, stderr, "Expected stderr to contain verbose (INFO) statements")
+      end
+    end
+  end
+end

data/ext/facter/facter/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/ext/facter/facter/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" }}.to_yaml.gsub("---\n", '')
+            assert_equal(expected, stdout, "YAML output does not match expected output")
+          rescue
+            fail_test "Couldn't parse output as YAML"
+          end
+        end
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/ticket_1123_facter_with_invalid_locale.rb

@@ -0,0 +1,22 @@
+test_name 'C89524: facter should not crash with invalid locale setting' do
+  tag 'risk:high'
+
+  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/ext/facter/facter/acceptance/tests/ticket_1238_hostname_fqdn.rb

@@ -0,0 +1,37 @@
+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'
+
+  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
+end