facter 4.0.26 → 4.0.28

data/acceptance/tests/options/config_file/no_custom_facts_and_custom_dir.rb

@@ -0,0 +1,43 @@
+# This test verifies that setting both custom-dir and no-custom-facts results in an error
+test_name "C99994: config option no-custom-facts conflicts with custom-dir" 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 and a config file" do
+      custom_dir = agent.tmpdir('custom_dir')
+      custom_fact = File.join(custom_dir, 'custom_fact.rb')
+      create_remote_file(agent, custom_fact, content)
+
+      config_dir = agent.tmpdir("config_dir")
+      config_file = File.join(config_dir, "facter.conf")
+      config_content = <<EOM
+global : {
+    custom-dir : "#{custom_dir}"
+    no-custom-facts : true,
+}
+EOM
+      create_remote_file(agent, config_file, config_content)
+
+      teardown do
+        on(agent, "rm -rf '#{custom_fact}' '#{config_dir}'")
+      end
+
+      step "Agent #{agent}: config option no-custom-facts : true and custom-dir should result in an options conflict error" do
+        on(agent, facter("--config '#{config_file}'"), :acceptable_exit_codes => 1) do |facter_output|
+          assert_match(/options conflict/, facter_output.stderr, "Output does not contain error string")
+        end
+      end
+    end
+  end
+end

data/acceptance/tests/options/config_file/no_custom_facts_and_facterlib.rb

@@ -0,0 +1,43 @@
+# This test verifies that setting no-custom-facts in the config file disables
+# finding facts under the environment variable FACTERLIB
+test_name "C99997: config option no-custom-facts : true does not load facts 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 and a config file" do
+      facterlib_dir = agent.tmpdir('facterlib')
+      custom_fact = File.join(facterlib_dir, 'custom_fact.rb')
+      create_remote_file(agent, custom_fact, content)
+
+      config_dir = agent.tmpdir("config_dir")
+      config_file = File.join(config_dir, "facter.conf")
+      config_content = <<EOM
+global : {
+    no-custom-facts : true,
+}
+EOM
+      create_remote_file(agent, config_file, config_content)
+
+      teardown do
+        on(agent, "rm -rf '#{facterlib_dir}' '#{config_dir}'")
+      end
+
+      step "Agent #{agent}: no-custom-facts should ignore the FACTERLIB environment variable" do
+        on(agent, facter("--config '#{config_file}' 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/acceptance/tests/options/config_file/no_custom_facts_and_load_path.rb

@@ -0,0 +1,49 @@
+# This test verifies that setting no-custom-facts in the config file disables the
+# the loading of custom facts in facter directories under the $LOAD_PATH
+test_name "C100004: config file option no-custom-facts : true 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 and a config file") do
+      ruby_path = on(agent, "#{ruby_command(agent)} -e 'puts $LOAD_PATH[0]'").stdout.chomp
+      load_path_facter_dir = File.join(ruby_path, '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)
+
+      config_dir = agent.tmpdir("config_dir")
+      config_file = File.join(config_dir, "facter.conf")
+      config_content = <<EOM
+global : {
+    no-custom-facts : true,
+}
+EOM
+      create_remote_file(agent, config_file, config_content)
+
+      teardown do
+        on(agent, "rm -rf '#{load_path_facter_dir}' '#{config_dir}'")
+      end
+
+      step("Agent #{agent}: using config no-custom-facts : true should not resolve facts in facter directories on the $LOAD_PATH") do
+        on(agent, facter("--config '#{config_file}' 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/acceptance/tests/options/config_file/no_external_facts.rb

@@ -0,0 +1,38 @@
+# This test verifies that no-external-facts : true set in the configuration file
+# does not load external facts
+test_name "C99962: config no-external-facts : true 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 and a config file" 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}'")
+
+      config_dir = agent.tmpdir("config_dir")
+      config_file = File.join(config_dir, "facter.conf")
+      config_content = <<EOM
+global : {
+    no-external-facts : true,
+}
+EOM
+      create_remote_file(agent, config_file, config_content)
+
+
+      teardown do
+        on(agent, "rm -rf '#{external_dir}' '#{config_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/acceptance/tests/options/config_file/no_external_facts_and_external_dir.rb

@@ -0,0 +1,34 @@
+# This test verifies that setting external-dir and no-external-facts in the config file
+# results in an error
+test_name "C99993: config option no-external-facts conflicts with external-dir" do
+  tag 'risk:low'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  agents.each do |agent|
+    step "Agent #{agent}: create the exernal-dir and a config file" do
+      external_dir = agent.tmpdir('external_dir')
+
+      config_dir = agent.tmpdir("config_dir")
+      config_file = File.join(config_dir, "facter.conf")
+      config_content = <<EOM
+global : {
+    external-dir : "#{external_dir}"
+    no-external-facts : true,
+}
+EOM
+      create_remote_file(agent, config_file, config_content)
+
+      teardown do
+        on(agent, "rm -rf '#{external_dir}' '#{config_dir}'")
+      end
+
+      step "Agent #{agent}: config option no-external-facts : true and external-dir should result in an options conflict error" do
+        on(agent, facter("--config '#{config_file}'"), :acceptable_exit_codes => 1) do |facter_output|
+          assert_match(/options conflict/, facter_output.stderr, "Output does not contain error string")
+        end
+      end
+    end
+  end
+end

data/acceptance/tests/options/config_file/no_ruby_disables_custom_facts.rb

@@ -0,0 +1,52 @@
+# This test is intended to demonstrate that the global.no-ruby config file field
+# disables custom fact lookup.
+test_name "C100045: config no-ruby to true should disable custom facts" do
+  tag 'risk:high'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  config = <<EOM
+global : {
+    no-ruby : true
+}
+EOM
+
+  custom_fact_content = <<EOM
+Facter.add('custom_fact') do
+  setcode do
+    "testvalue"
+  end
+end
+EOM
+
+  agents.each do |agent|
+    step "Agent #{agent}: create config file" do
+      config_dir = get_default_fact_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+      config_file = File.join(config_dir, "facter.conf")
+      on(agent, "mkdir -p '#{config_dir}'")
+      create_remote_file(agent, config_file, config)
+
+      teardown do
+        on(agent, "rm -rf '#{config_dir}'", :acceptable_exit_codes => [0,1])
+      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, custom_fact_content)
+
+          teardown do
+            on(agent, "rm -rf '#{custom_dir}'", :acceptable_exit_codes => [0,1])
+          end
+
+          on(agent, facter("custom_fact", :environment => { 'FACTERLIB' => custom_dir })) do |facter_output|
+            assert_equal("", facter_output.stdout.chomp, "Expected custom fact to be disabled when no-ruby is true")
+          end
+        end
+      end
+    end
+  end
+end

data/acceptance/tests/options/config_file/no_ruby_disables_ruby_facts.rb

@@ -0,0 +1,34 @@
+# This test verifies that the global.no-ruby config file field disables
+# ruby facts
+test_name "C99964: no-ruby config field flag disables requiring Ruby" do
+  tag 'risk:high'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  config = <<EOM
+global : {
+    no-ruby : true
+}
+EOM
+
+  agents.each do |agent|
+    step "Agent #{agent}: create config file" do
+      config_dir = get_default_fact_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+      config_file = File.join(config_dir, "facter.conf")
+      on(agent, "mkdir -p '#{config_dir}'")
+      create_remote_file(agent, config_file, config)
+
+      teardown do
+        on(agent, "rm -rf '#{config_dir}'", :acceptable_exit_codes => [0,1])
+      end
+
+      step "no-ruby option should disable Ruby and facts requiring Ruby" do
+        on(agent, facter("ruby")) do |facter_output|
+          assert_equal("", facter_output.stdout.chomp, "Expected Ruby and Ruby fact to be disabled")
+          assert_equal("", facter_output.stderr.chomp, "Expected no warnings about Ruby on stderr")
+        end
+      end
+    end
+  end
+end

data/acceptance/tests/options/config_file/trace.rb

@@ -0,0 +1,48 @@
+# This test is intended to demonstrate that setting the cli.trace field to true
+# enables backtrace reporting for errors in custom facts.
+test_name "C99988: trace config field enables backtraces for custom facts" do
+  tag 'risk:high'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  erroring_custom_fact = <<EOM
+Facter.add('custom_fact') do
+  setcode do
+    non_existent_value
+  end
+end
+EOM
+
+  config = <<EOM
+cli : {
+    trace : true
+}
+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, erroring_custom_fact)
+      on(agent, "chmod +x '#{custom_fact}'")
+
+      config_dir = get_default_fact_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+      config_file = File.join(config_dir, "facter.conf")
+      on(agent, "mkdir -p '#{config_dir}'")
+      create_remote_file(agent, config_file, config)
+
+      teardown do
+        on(agent, "rm -rf '#{custom_dir}' '#{config_dir}'", :acceptable_exit_codes => [0, 1])
+      end
+
+      step "trace setting should provide a backtrace for a custom fact with errors" do
+        on(agent, facter("--custom-dir '#{custom_dir}' custom_fact"), :acceptable_exit_codes => [1]) do |facter_output|
+          assert_match(/backtrace:\s+#{custom_fact}/, facter_output.stderr, "Expected a backtrace for erroneous custom fact")
+        end
+      end
+    end
+  end
+end
+

data/acceptance/tests/options/config_file/ttls_cached_external_execution_resolver_with_json_output.rb

@@ -0,0 +1,92 @@
+# This test verifies that a ttls configured cached facts when initially called
+# create a json cache file
+test_name "ttls configured cached external execution resolver with json output creates and read json cache files" do
+  tag 'risk:medium'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  # This fact must be resolvable on ALL platforms
+  # Do NOT use the 'kernel' fact as it is used to configure the tests
+  external_cachegroup = 'external_fact'
+  cached_fact_name = 'single_fact'
+  initial_fact_value = 'external_value'
+  cached_fact_value = 'cached_external_value'
+
+  agents.each do |agent|
+    step "Agent #{agent}: create config file" do
+      external_dir = agent.tmpdir('external_dir')
+      ext = get_external_fact_script_extension(agent['platform'])
+      external_fact = File.join(external_dir, "#{external_cachegroup}#{ext}")
+      if agent['platform'] =~ /windows/
+        external_fact_content = <<EOM
+cat << EOF
+{
+  "#{cached_fact_name}": "#{initial_fact_value}"
+}
+EOF
+EOM
+      else
+        external_fact_content = <<EOM
+#!/bin/sh
+cat << EOF
+{
+  "#{cached_fact_name}": "#{initial_fact_value}"
+}
+EOF
+EOM
+      end
+      create_remote_file(agent, external_fact, external_fact_content)
+      on(agent, "chmod +x '#{external_fact}'")
+
+      config_dir = get_default_fact_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+      config_file = File.join(config_dir, "facter.conf")
+      cached_facts_dir = get_cached_facts_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+
+      cached_fact_file = File.join(cached_facts_dir, "#{external_cachegroup}#{ext}")
+
+      # Setup facter conf
+      on(agent, "mkdir -p '#{config_dir}'")
+      cached_fact_content = <<EOM
+{
+  "#{cached_fact_name}": "#{cached_fact_value}"
+}
+EOM
+
+      config = <<EOM
+facts : {
+    ttls : [
+        { "#{external_cachegroup}#{ext}" : 30 days }
+    ]
+}
+EOM
+      create_remote_file(agent, config_file, config)
+
+      teardown do
+        on(agent, "rm -rf '#{config_dir}' '#{cached_facts_dir}' '#{external_dir}'")
+      end
+
+      step "should create a JSON file for a fact that is to be cached" do
+        on(agent, "rm -rf '#{cached_facts_dir}'")
+        on(agent, facter("--external-dir '#{external_dir}' --debug #{cached_fact_name}")) do |facter_output|
+          assert_match(/caching values for .+ facts/, facter_output.stderr, "Expected debug message to state that values will be cached")
+        end
+        on(agent, "cat #{cached_fact_file}", :acceptable_exit_codes => [0]) do |cat_output|
+          assert_match(/#{cached_fact_name}/, cat_output.stdout, "Expected cached fact file to contain fact information")
+        end
+      end
+
+      step "should read from a cached JSON file for a fact that has been cached" do
+        on(agent, "rm -rf '#{cached_facts_dir}'")
+        on(agent, facter("--external-dir '#{external_dir}' --debug #{cached_fact_name}"))
+
+        create_remote_file(agent, cached_fact_file, cached_fact_content)
+
+        on(agent, facter("--external-dir '#{external_dir}' --debug #{cached_fact_name}")) do |facter_output|
+          assert_match(/loading cached values for .+ facts/, stderr, "Expected debug message to state that values are read from cache")
+          assert_match(/#{cached_fact_value}/, stdout, "Expected fact to match the cached fact file")
+        end
+      end
+    end
+  end
+end

data/acceptance/tests/options/config_file/ttls_cached_external_execution_resolver_with_text_output.rb

@@ -0,0 +1,74 @@
+# This test verifies that a ttls configured cached facts when initially called
+# create a json cache file
+test_name "ttls configured cached external execution resolver with text output creates and read json cache files" do
+  tag 'risk:medium'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  # This fact must be resolvable on ALL platforms
+  # Do NOT use the 'kernel' fact as it is used to configure the tests
+  external_cachegroup = 'external_fact'
+  cached_fact_name = 'single_fact'
+  initial_fact_value = 'external_value'
+  cached_fact_value = 'cached_external_value'
+
+  agents.each do |agent|
+    step "Agent #{agent}: create config file" do
+      external_dir = agent.tmpdir('external_dir')
+      ext = get_external_fact_script_extension(agent['platform'])
+      external_fact = File.join(external_dir, "#{external_cachegroup}#{ext}")
+      create_remote_file(agent, external_fact, external_fact_content(agent['platform'], cached_fact_name, initial_fact_value))
+      on(agent, "chmod +x '#{external_fact}'")
+
+      config_dir = get_default_fact_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+      config_file = File.join(config_dir, "facter.conf")
+      cached_facts_dir = get_cached_facts_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+
+      cached_fact_file = File.join(cached_facts_dir, "#{external_cachegroup}#{ext}")
+
+      # Setup facter conf
+      on(agent, "mkdir -p '#{config_dir}'")
+      cached_fact_content = <<EOM
+{
+  "#{cached_fact_name}": "#{cached_fact_value}"
+}
+EOM
+
+      config = <<EOM
+facts : {
+    ttls : [
+        { "#{external_cachegroup}#{ext}" : 30 days }
+    ]
+}
+EOM
+      create_remote_file(agent, config_file, config)
+
+      teardown do
+        on(agent, "rm -rf '#{config_dir}' '#{cached_facts_dir}' '#{external_dir}'")
+      end
+
+      step "should create a JSON file for a fact that is to be cached" do
+        on(agent, "rm -rf '#{cached_facts_dir}'")
+        on(agent, facter("--external-dir '#{external_dir}' --debug #{cached_fact_name}")) do |facter_output|
+          assert_match(/caching values for .+ facts/, facter_output.stderr, "Expected debug message to state that values will be cached")
+        end
+        on(agent, "cat #{cached_fact_file}", :acceptable_exit_codes => [0]) do |cat_output|
+          assert_match(/#{cached_fact_name}/, cat_output.stdout, "Expected cached fact file to contain fact information")
+        end
+      end
+
+      step "should read from a cached JSON file for a fact that has been cached" do
+        on(agent, "rm -rf '#{cached_facts_dir}'")
+        on(agent, facter("--external-dir '#{external_dir}' --debug #{cached_fact_name}"))
+
+        create_remote_file(agent, cached_fact_file, cached_fact_content)
+
+        on(agent, facter("--external-dir '#{external_dir}' --debug #{cached_fact_name}")) do |facter_output|
+          assert_match(/loading cached values for .+ facts/, stderr, "Expected debug message to state that values are read from cache")
+          assert_match(/#{cached_fact_value}/, stdout, "Expected fact to match the cached fact file")
+        end
+      end
+    end
+  end
+end