facter 4.0.26 → 4.0.28

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

@@ -0,0 +1,42 @@
+# This test verifies that facter can load facts from a single custom-dir specified
+# in the configuration file
+test_name "C98143: config custom-dir allows single custom fact directory" do
+  tag 'risk:low'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  content = <<EOM
+Facter.add('config_fact') do
+  setcode do
+    "config_value"
+  end
+end
+EOM
+
+  agents.each do |agent|
+    step "Agent #{agent}: create custom fact directory and a custom fact and 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}",
+}
+EOM
+      create_remote_file(agent, config_file, config_content)
+
+      teardown do
+        on(agent, "rm -rf '#{custom_dir}' '#{config_dir}'")
+      end
+
+      step "Agent #{agent}: resolve a fact from the configured custom-dir path" do
+        on(agent, facter("--config '#{config_file}' config_fact")) do |facter_output|
+          assert_equal("config_value", facter_output.stdout.chomp, "Incorrect custom fact value")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# This test verifies that facter can load facts from multiple custom-dir's specified
+# in the configuration file
+test_name "C99996: config custom-dir allows multiple custom fact directories" do
+  tag 'risk:medium'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  content_1 = <<EOM
+Facter.add('config_fact_1') do
+  setcode do
+    "config_value_1"
+  end
+end
+EOM
+
+  content_2 = <<EOM
+Facter.add('config_fact_2') do
+  setcode do
+    "config_value_2"
+  end
+end
+EOM
+
+  agents.each do |agent|
+    step "Agent #{agent}: create custom fact directories and a custom fact in each and a config file" do
+      custom_dir_1 = agent.tmpdir('custom_dir_1')
+      custom_dir_2 = agent.tmpdir('custom_dir_2')
+      custom_fact_1 = File.join(custom_dir_1, 'custom_fact.rb')
+      custom_fact_2 = File.join(custom_dir_2, 'custom_fact.rb')
+      create_remote_file(agent, custom_fact_1, content_1)
+      create_remote_file(agent, custom_fact_2, content_2)
+
+      config_dir = agent.tmpdir("config_dir")
+      config_file = File.join(config_dir, "facter.conf")
+      config_content = <<EOM
+global : {
+    custom-dir : [ "#{custom_dir_1}", "#{custom_dir_2}" ],
+}
+EOM
+      create_remote_file(agent, config_file, config_content)
+
+      teardown do
+        on(agent, "rm -rf '#{custom_dir_1}' '#{custom_dir_2}' '#{config_dir}'")
+      end
+
+      step "Agent #{agent}: resolve a fact from each configured custom-dir path" do
+        on(agent, facter("--config '#{config_file}' --json")) do |facter_output|
+          results = JSON.parse(facter_output.stdout)
+          assert_equal("config_value_1", results['config_fact_1'], "Incorrect custom fact value for config_fact_1")
+          assert_equal("config_value_2", results['config_fact_2'], "Incorrect custom fact value for config_fact_2")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# This test is intended to demonstrate that setting the cli.debug field to true
+# causes DEBUG information to be printed to stderr.
+test_name "C99965: setting the debug config field to true prints debug info to stderr" do
+  tag 'risk:high'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  config = <<EOM
+cli : {
+    debug : 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 "debug output should print when config file is loaded" do
+        on(agent, facter("")) do |facter_output|
+          assert_match(/DEBUG/, facter_output.stderr, "Expected DEBUG information in stderr")
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,34 @@
+# This test verified that having debug set to false in the config file can be
+# overridden by the command line option --debug
+test_name "C100044: flags set on the command line override config file settings" do
+  tag 'risk:medium'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  config = <<EOM
+cli : {
+    debug : false
+}
+EOM
+
+  agents.each do |agent|
+    config_dir = get_default_fact_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+    config_file = File.join(config_dir, "facter.conf")
+
+    teardown do
+      on(agent, "rm -rf '#{config_dir}'", :acceptable_exit_codes => [0, 1])
+    end
+
+    step "Agent #{agent}: create config file in default location" do
+      on(agent, "mkdir -p '#{config_dir}'")
+      create_remote_file(agent, config_file, config)
+    end
+
+    step "--debug flag should override debug=false in config file" do
+      on(agent, facter("--debug")) do |facter_output|
+        assert_match(/DEBUG/, facter_output.stderr, "Expected DEBUG information in stderr")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# This test is intended to demonstrate that Facter will load a config file
+# saved at the default location without any special command line flags.
+# On Unix, this location is /etc/puppetlabs/facter/facter.conf.
+# On Windows, it is C:\ProgramData\PuppetLabs\facter\etc\facter.conf
+test_name "C99991: config file is loaded from default location" do
+  tag 'risk:high'
+
+  config = <<EOM
+cli : {
+    debug : true
+}
+EOM
+
+  agents.each do |agent|
+    step "Agent #{agent}: create config file" do
+      if agent['platform'] =~ /windows/
+        config_dir = 'C:\\ProgramData\\PuppetLabs\\facter\\etc'
+     else
+        config_dir = "/etc/puppetlabs/facter"
+      end
+
+      on(agent, "mkdir -p '#{config_dir}'")
+      config_file = File.join(config_dir, "facter.conf")
+      create_remote_file(agent, config_file, config)
+
+      teardown do
+        on(agent, "rm -rf '#{config_dir}'", :acceptable_exit_codes => [0,1])
+      end
+
+      step "config file should be loaded automatically and turn DEBUG output on" do
+        on(agent, facter("")) do |facter_output|
+          assert_match(/DEBUG/, facter_output.stderr, "Expected DEBUG information in stderr")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# This test verifies that a configured external-dir conflicts with the command
+# line option --no-external-facts
+test_name "configured external-dir conflicts with command line --no-external-facts" do
+  tag 'risk:low'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  config = <<EOM
+global : {
+    external-dir : "config/file/dir"
+}
+cli : {
+    debug : false
+}
+EOM
+
+  agents.each do |agent|
+    config_dir = get_default_fact_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+    config_file = File.join(config_dir, "facter.conf")
+
+    teardown do
+      on(agent, "rm -rf '#{config_dir}'", :acceptable_exit_codes => [0, 1])
+    end
+
+    step "Agent #{agent}: create config file in default location" do
+      on(agent, "mkdir -p '#{config_dir}'")
+      create_remote_file(agent, config_file, config)
+    end
+
+    step "conflict logic applies across settings sources" do
+      on(agent, facter("--no-external-facts"), :acceptable_exit_codes => [1]) do |facter_output|
+        assert_match(/no-external-facts and external-dir options conflict/, facter_output.stderr, "Facter should have warned about conflicting settings")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# This test verifies that the external-dir specified in the configuration file can be overridden by using
+# --external-dir on the command line
+test_name "C100016: config external-dir overridden by command line --external-dir" do
+  tag 'risk:medium'
+
+  require 'json'
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  agents.each do |agent|
+    step "Agent #{agent}: create 2 custom fact directories with facts and a config file pointing at 1 directory" do
+      external_config_dir = agent.tmpdir('external_dir')
+      external_cli_dir = agent.tmpdir('cli_external_dir')
+      external_config_fact = File.join(external_config_dir, 'external.txt')
+      external_cli_fact = File.join(external_cli_dir, 'external.txt')
+      create_remote_file(agent, external_config_fact, "config_fact=config_value")
+      create_remote_file(agent, external_cli_fact, "cli_fact=cli_value")
+      config_dir = agent.tmpdir("config_dir")
+      config_file = File.join(config_dir, "facter.conf")
+      config_content = <<EOM
+global : {
+    external-dir : "#{external_config_dir}",
+}
+EOM
+      create_remote_file(agent, config_file, config_content)
+
+      teardown do
+        on(agent, "rm -rf '#{external_config_dir}' '#{external_cli_dir}' '#{config_dir}'")
+      end
+
+      step "Agent #{agent}: resolve a fact from the command line external-dir and not the config file" do
+        on(agent, facter("--config '#{config_file}' --external-dir '#{external_cli_dir}' --json")) do |facter_output|
+          results = JSON.parse(facter_output.stdout)
+          assert_equal("cli_value", results['cli_fact'], "Incorrect custom fact value for cli_fact")
+          assert_nil(results['config_fact'], "Config fact should not resolve and be nil")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# This test verifies that facter can load facts from a single external-dir specified
+# in the configuration file
+test_name "C98142: config external-dir allows single external fact directory" do
+  tag 'risk:low'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  agents.each do |agent|
+    step "Agent #{agent}: create an external fact directory with an 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'], 'single_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 : {
+    external-dir : "#{external_dir}",
+}
+EOM
+      create_remote_file(agent, config_file, config_content)
+
+      teardown do
+        on(agent, "rm -rf '#{external_dir}' '#{config_dir}'")
+      end
+
+      step "Agent #{agent}: resolve a fact in the external-dir in the configuration file" do
+        on(agent, facter("--config '#{config_file}' single_fact")) do |facter_output|
+          assert_equal("external_value", facter_output.stdout.chomp, "Incorrect external fact value")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# facter should be able to load facts from multiple external-dir's specified
+# in the configuration file
+test_name "C99995: config file supports external-dir for multiple fact directories" do
+  tag 'risk:medium'
+
+  require 'json'
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  agents.each do |agent|
+    step "Agent #{agent}: create external fact directories and a external fact in each and a config file" do
+      external_dir_1 = agent.tmpdir('external_dir_1')
+      external_dir_2 = agent.tmpdir('external_dir_2')
+      ext = get_external_fact_script_extension(agent['platform'])
+      external_fact_1 = File.join(external_dir_1, "external_fact#{ext}")
+      external_fact_2 = File.join(external_dir_2, "external_fact#{ext}")
+      create_remote_file(agent, external_fact_1, external_fact_content(agent['platform'], 'external_fact_1', 'external_value_1'))
+      create_remote_file(agent, external_fact_2, external_fact_content(agent['platform'], 'external_fact_2', 'external_value_2'))
+      on(agent, "chmod +x '#{external_fact_1}' '#{external_fact_2}'")
+
+      config_dir = agent.tmpdir("config_dir")
+      config_file = File.join(config_dir, "facter.conf")
+      config_content = <<EOM
+global : {
+    external-dir : [ "#{external_dir_1}", "#{external_dir_2}" ],
+}
+EOM
+      create_remote_file(agent, config_file, config_content)
+
+      teardown do
+        on(agent, "rm -rf '#{external_dir_1}' '#{external_dir_2}' '#{config_dir}'")
+      end
+
+      step "Agent #{agent}: resolve a fact from each configured external-dir path" do
+        on(agent, facter("--config '#{config_file}' --json")) do |facter_output|
+          results = JSON.parse(facter_output.stdout)
+          assert_equal("external_value_1", results['external_fact_1'], "Incorrect external fact value for external_fact_1")
+          assert_equal("external_value_2", results['external_fact_2'], "Incorrect external fact value for external_fact_2")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# This test is intended to demonstrate that Facter's config file will
+# load correctly from the default location when Facter is required from Ruby.
+# On *nix, this location is /etc/puppetlabs/facter/facter.conf.
+# On Windows, it is C:\ProgramData\PuppetLabs\facter\etc\facter.conf
+#
+# The test also verifies that facter will search for external facts and custom facts
+# in the directory paths defined with external-dir and custom-dir in the facter.conf file
+test_name "C98141: config file is loaded when Facter is run from Puppet" do
+  tag 'risk:high'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  agents.each do |agent|
+    # create paths for default facter.conf, external-dir, and custom-dir
+
+    # default facter.conf
+    facter_conf_default_dir = get_default_fact_dir(agent['platform'], on(agent, facter('kernelmajversion')).stdout.chomp.to_f)
+    facter_conf_default_path = File.join(facter_conf_default_dir, "facter.conf")
+
+    # external-dir
+    ext_fact_dir1 = agent.tmpdir('ext_fact_dir1')
+    ext_path1     = File.join(ext_fact_dir1, "test_ext_fact1.yaml")
+    ext_fact_dir2 = agent.tmpdir('ext_fact_dir2')
+    ext_path2     = File.join(ext_fact_dir2, "test_ext_fact2.yaml")
+
+    # custom-dir
+    cust_fact_dir = agent.tmpdir('custom_fact_dir')
+    cust_path     = File.join(cust_fact_dir, "custom_fact.rb")
+
+    teardown do
+      on(agent, "rm -rf '#{facter_conf_default_dir}' '#{ext_fact_dir1}' '#{ext_fact_dir2}' '#{cust_fact_dir}'",
+          :acceptable_exit_codes => [0,1])
+    end
+
+    # create the directories
+    on(agent, "mkdir -p '#{facter_conf_default_dir}' '#{ext_fact_dir1}' '#{ext_fact_dir2}' '#{cust_fact_dir}'")
+
+    step "Agent #{agent}: create facter.conf, external fact, and custom fact files" do
+
+      create_remote_file(agent, facter_conf_default_path, <<-FILE)
+        global : {
+          external-dir : ["#{ext_fact_dir1}", "#{ext_fact_dir2}"],
+          custom-dir : ["#{cust_fact_dir}"]
+      }
+      FILE
+
+      create_remote_file(agent, ext_path1, <<-FILE)
+        externalfact1: 'This is external fact 1 in #{ext_fact_dir1} directory'
+      FILE
+
+      create_remote_file(agent, ext_path2, <<-FILE)
+        externalfact2: 'This is external fact 2 in #{ext_fact_dir2} directory'
+      FILE
+
+      create_remote_file(agent, cust_path, <<-FILE)
+        Facter.add('customfact') do
+          setcode do
+            'This is a custom fact in #{cust_fact_dir} directory'
+          end
+        end
+      FILE
+    end
+
+    step "running `puppet facts` should load the config file automatically and search all external-dir and custom-dir paths" do
+      on(agent, puppet('facts')) do |puppet_facts_output|
+        assert_match(/This is external fact 1 in #{ext_fact_dir1} directory/, puppet_facts_output.stdout, "Expected external fact")
+        assert_match(/This is external fact 2 in #{ext_fact_dir2} directory/, puppet_facts_output.stdout, "Expected external fact")
+        assert_match(/This is a custom fact in #{cust_fact_dir} directory/, puppet_facts_output.stdout, "Expected custom fact")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# This test ensures that the cli.log-level config file setting works
+# properly. The value of the setting should be a string indicating the
+# logging level.
+test_name "C99990: log-level setting can be used to specific logging level" do
+  tag 'risk:high'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  config = <<EOM
+cli : {
+    log-level : debug
+}
+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 "log-level set to debug should print DEBUG output to stderr" do
+        on(agent, facter("")) do |facter_output|
+          assert_match(/DEBUG/, facter_output.stderr, "Expected DEBUG information in stderr")
+        end
+      end
+    end
+  end
+end
+