facter 4.0.26 → 4.0.28

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

@@ -0,0 +1,88 @@
+# 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 yaml 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_json_resolver.rb

@@ -0,0 +1,79 @@
+# This test verifies that a ttls configured cached facts when initially called
+# create a json cache file
+test_name "ttls configured cached external json resolver 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 = 'initial_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 = '.json'
+      external_fact = File.join(external_dir, "#{external_cachegroup}#{ext}")
+
+      external_fact_content = <<EOM
+{
+  "#{cached_fact_name}": "#{initial_fact_value}"
+}
+EOM
+      create_remote_file(agent, external_fact, external_fact_content)
+
+      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_text_resolver.rb

@@ -0,0 +1,78 @@
+# This test verifies that a ttls configured cached facts when initially called
+# create a json cache file
+test_name "ttls configured cached external text resolver 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 = 'initial_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 = '.txt'
+      external_fact = File.join(external_dir, "#{external_cachegroup}#{ext}")
+
+      external_fact_content = <<EOM
+#{cached_fact_name}=#{initial_fact_value}
+EOM
+
+      create_remote_file(agent, external_fact, external_fact_content)
+
+      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_yaml_resolver.rb

@@ -0,0 +1,78 @@
+# This test verifies that a ttls configured cached facts when initially called
+# create a json cache file
+test_name "ttls configured cached external yaml resolver 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 = 'initial_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 = '.yaml'
+      external_fact = File.join(external_dir, "#{external_cachegroup}#{ext}")
+
+      external_fact_content = <<EOM
+#{cached_fact_name}: "#{initial_fact_value}"
+EOM
+
+      create_remote_file(agent, external_fact, external_fact_content)
+
+      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_facts_clear_by_empty_ttls_cache_list.rb

@@ -0,0 +1,71 @@
+# This test is intended to verify that when the ttls list in the config file is empty
+# that the existing cached facts are removed
+test_name "C100125: ttls config that is empty causes facter to remove existing cached facts" do
+  tag 'risk:high'
+
+  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
+  cached_fact_name = 'uptime'
+  cached_fact_value = "CACHED_FACT_VALUE"
+  cached_fact_content = <<EOM
+{
+ "#{cached_fact_name}": "#{cached_fact_value}"
+}
+EOM
+
+  config = <<EOM
+facts : {
+  ttls : [
+      { "#{cached_fact_name}" : 30 days }
+  ]
+}
+EOM
+
+  config_no_cache = <<EOM
+facts : {
+   ttls : [ ]
+}
+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")
+      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, cached_fact_name)
+
+      # Setup 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])
+        on(agent, "rm -rf '#{cached_facts_dir}'", :acceptable_exit_codes => [0, 1])
+      end
+
+      step "Agent #{agent}: create config file with no cached facts" do
+        # Set up a known cached fact
+        on(agent, "rm -rf '#{cached_facts_dir}'", :acceptable_exit_codes => [0, 1])
+        on(agent, facter(""))
+        create_remote_file(agent, cached_fact_file, cached_fact_content)
+      end
+
+      step "Agent #{agent}: clean out unused cache files on each facter run" do
+        # Create config file with no caching
+        no_cache_config_file = File.join(config_dir, "no-cache.conf")
+        create_remote_file(agent, no_cache_config_file, config_no_cache)
+
+        on(agent, facter("--config '#{no_cache_config_file}'")) do |facter_output|
+          assert_no_match(/#{cached_fact_value}/, facter_output.stdout, "Expected to not see the cached fact value")
+        end
+
+        # Expect cache file to not exist
+        refute(agent.file_exist?("#{cached_fact_file}"), "Expected cache file to be absent")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# This test verifies that a ttls configured cached facts when initially called
+# create a json cache file
+test_name "C99973: ttls configured cached facts create 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
+  cached_factname = 'uptime'
+  config = <<EOM
+facts : {
+    ttls : [
+        { "#{cached_factname}" : 30 days }
+    ]
+}
+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")
+      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, cached_factname)
+
+      # Setup 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])
+        on(agent, "rm -rf '#{cached_facts_dir}'", :acceptable_exit_codes => [0, 1])
+      end
+
+      step "should create a JSON file for a fact that is to be cached" do
+        on(agent, "rm -rf '#{cached_facts_dir}'", :acceptable_exit_codes => [0, 1])
+        on(agent, facter("--debug")) 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_factname}/, cat_output.stdout, "Expected cached fact file to contain fact information")
+        end
+      end
+    end
+  end
+end