facter 2.5.7 → 3.9.6.cfacter.20180606

data/ext/facter/facter/acceptance/lib/facter/acceptance/user_fact_utils.rb

@@ -0,0 +1,132 @@
+module Facter
+  module Acceptance
+    module UserFactUtils
+
+      # Determine paths for testing custom and external facts.
+      # Paths vary by platform.
+
+      # Retrieve the path of a non-standard directory for custom or external facts.
+      #
+      def get_user_fact_dir(platform, version)
+        if platform =~ /windows/
+          if version < 6.0
+            File.join('C:', 'Documents and Settings', 'All Users', 'Application Data', 'PuppetLabs', 'facter', 'custom')
+          else
+            File.join('C:', 'ProgramData', 'PuppetLabs', 'facter', 'custom')
+          end
+        else
+          File.join('/', 'opt', 'puppetlabs', 'facter', 'custom')
+        end
+      end
+
+      # Retrieve the path of the standard facts.d directory.
+      #
+      def get_factsd_dir(platform, version)
+        if platform =~ /windows/
+          if version < 6.0
+            File.join('C:', 'Documents and Settings', 'All Users', 'Application Data', 'PuppetLabs', 'facter', 'facts.d')
+          else
+            File.join('C:', 'ProgramData', 'PuppetLabs', 'facter', 'facts.d')
+          end
+        else
+          File.join('/', 'opt', 'puppetlabs', 'facter', 'facts.d')
+        end
+      end
+
+      # Retrieve the path of the standard cached facts directory.
+      #
+      def get_cached_facts_dir(platform, version)
+        if platform =~ /windows/
+          if version < 6.0
+            File.join('C:', 'Documents and Settings', 'All Users', 'Application Data', 'PuppetLabs', 'facter', 'cache', 'cached_facts')
+          else
+            File.join('C:', 'ProgramData', 'PuppetLabs', 'facter', 'cache', 'cached_facts')
+          end
+        else
+          File.join('/', 'opt', 'puppetlabs', 'facter', 'cache', 'cached_facts')
+        end
+      end
+
+      # Retrieve the path of the facts.d directory in /etc/facter on Unix systems
+      #
+      def get_etc_factsd_dir(platform)
+        if platform =~ /windows/
+          raise "get_etc_factsd_dir: not a supported directory on Windows"
+        else
+          File.join('/', 'etc', 'facter', 'facts.d')
+        end
+      end
+
+      # Retrieve the path of the facts.d diretory in /etc/puppetlabs/facter on Unix systems
+      #
+      def get_etc_puppetlabs_factsd_dir(platform)
+        if platform =~ /windows/
+          raise "get_etc_puppetlabs_factsd_dir: not a supported directory on Windows"
+        else
+          File.join('/', 'etc', 'puppetlabs', 'facter', 'facts.d')
+        end
+      end
+
+      # Retrieve the extension to use for an external fact script.
+      # Windows uses '.bat' and everything else uses '.sh'
+      def get_external_fact_script_extension(platform)
+        if platform =~ /windows/
+          '.bat'
+        else
+          '.sh'
+        end
+      end
+
+      # Retrieve the path to default location of facter.conf file.
+      #
+      def get_default_fact_dir(platform, version)
+        if platform =~ /windows/
+          File.join('C:', 'ProgramData', 'PuppetLabs', 'facter', 'etc')
+        else
+          File.join('/', 'etc', 'puppetlabs', 'facter')
+        end
+      end
+
+      # Return the content for an external fact based on the platform supplied
+      #
+      def external_fact_content(platform, key='external_fact', value='test_value')
+        unix_content = <<EOM
+#!/bin/sh
+echo "#{key}=#{value}"
+EOM
+
+        win_content = <<EOM
+@echo off
+echo #{key}=#{value}
+EOM
+
+        if platform =~ /windows/
+          win_content
+        else
+          unix_content
+        end
+      end
+
+      # Return the content for a custom fact
+      #
+      def custom_fact_content(key='custom_fact', value='custom_value', *args)
+        <<-EOM
+  Facter.add('#{key}') do
+    setcode {'#{value}'}
+    #{args.empty? ? '' : args.join('\n')}
+  end
+        EOM
+      end
+
+      # Return the correct shell path for Unix system under test
+      #
+      def user_shell(agent)
+        if agent['platform'] =~ /aix/
+          '/usr/bin/bash'
+        else
+          '/bin/bash'
+        end
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/lib/helper.rb

@@ -0,0 +1 @@
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__))

data/ext/facter/facter/acceptance/lib/puppet/acceptance/common_utils.rb

@@ -0,0 +1,10 @@
+module Puppet
+  module Acceptance
+    module CommandUtils
+      def ruby_command(host)
+        "env PATH=\"#{host['privatebindir']}:${PATH}\" ruby"
+      end
+      module_function :ruby_command
+    end
+  end
+end

data/ext/facter/facter/acceptance/lib/puppet/acceptance/git_utils.rb

@@ -0,0 +1,19 @@
+module Puppet
+  module Acceptance
+    module GitUtils
+      def lookup_in_env(env_variable_name, project_name, default)
+        project_specific_name = "#{project_name.upcase.gsub("-","_")}_#{env_variable_name}"
+        ENV[project_specific_name] || ENV[env_variable_name] || default
+      end
+
+      def build_giturl(project_name, git_fork = nil, git_server = nil)
+        git_fork ||= lookup_in_env('FORK', project_name, 'puppetlabs')
+        git_server ||= lookup_in_env('GIT_SERVER', project_name, 'github.com')
+        repo = (git_server == 'github.com') ?
+          "#{git_fork}/#{project_name}.git" :
+          "#{git_fork}-#{project_name}.git"
+        "git://#{git_server}/#{repo}"
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/lib/puppet/acceptance/install_utils.rb

@@ -0,0 +1,58 @@
+require 'open-uri'
+require 'open3'
+require 'uri'
+require 'puppet/acceptance/common_utils'
+
+module Puppet
+  module Acceptance
+    module InstallUtils
+      PLATFORM_PATTERNS = {
+        :redhat        => /fedora|el-|centos/,
+        :debian        => /debian|ubuntu/,
+        :debian_ruby18 => /debian|ubuntu-lucid|ubuntu-precise/,
+        :solaris       => /solaris/,
+        :windows       => /windows/,
+      }.freeze
+
+      # Installs packages on the hosts.
+      #
+      # @param hosts [Array<Host>] Array of hosts to install packages to.
+      # @param package_hash [Hash{Symbol=>Array<String,Array<String,String>>}]
+      #   Keys should be a symbol for a platform in PLATFORM_PATTERNS.  Values
+      #   should be an array of package names to install, or of two element
+      #   arrays where a[0] is the command we expect to find on the platform
+      #   and a[1] is the package name (when they are different).
+      # @param options [Hash{Symbol=>Boolean}]
+      # @option options [Boolean] :check_if_exists First check to see if
+      #   command is present before installing package.  (Default false)
+      # @return true
+      def install_packages_on(hosts, package_hash, options = {})
+        check_if_exists = options[:check_if_exists]
+        hosts = [hosts] unless hosts.kind_of?(Array)
+        hosts.each do |host|
+          package_hash.each do |platform_key,package_list|
+            if pattern = PLATFORM_PATTERNS[platform_key]
+              if pattern.match(host['platform'])
+                package_list.each do |cmd_pkg|
+                  if cmd_pkg.kind_of?(Array)
+                    command, package = cmd_pkg
+                  else
+                    command = package = cmd_pkg
+                  end
+                  if !check_if_exists || !host.check_for_package(command)
+                    host.logger.notify("Installing #{package}")
+                    additional_switches = '--allow-unauthenticated' if platform_key == :debian
+                    host.install_package(package, additional_switches)
+                  end
+                end
+              end
+            else
+              raise("Unknown platform '#{platform_key}' in package_hash")
+            end
+          end
+        end
+        return true
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/custom_facts/custom_fact_with_10001_weight_overrides_external_fact.rb

@@ -0,0 +1,30 @@
+test_name "C100153: custom fact with weight of >= 10001 overrides an external fact" do
+  tag 'risk:high'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  fact_name = 'test'
+  # Use a static external fact
+  ext_fact = "#{fact_name}: 'EXTERNAL'"
+
+  agents.each do |agent|
+    facts_dir = agent.tmpdir('facts.d')
+    ext_fact_path = "#{facts_dir}/test.yaml"
+    cust_fact_path = "#{facts_dir}/test.rb"
+    create_remote_file(agent, ext_fact_path, ext_fact)
+    create_remote_file(agent, cust_fact_path, custom_fact_content(fact_name, 'CUSTOM', "has_weight 10001"))
+
+    teardown do
+      on(agent, "rm -rf '#{facts_dir}'")
+    end
+
+    # Custom fact with weight >= 10001 should override an external fact
+    step "Agent #{agent}: resolve a custom fact with weight of 10001 overriding the external fact" do
+      on(agent, facter("--external-dir=#{facts_dir} --custom-dir=#{facts_dir} test")) do |facter_output|
+        assert_equal("CUSTOM", facter_output.stdout.chomp)
+      end
+    end
+  end
+end
+

data/ext/facter/facter/acceptance/tests/custom_facts/having_multiple_facts_in_one_file.rb

@@ -0,0 +1,40 @@
+test_name 'C14893: Facter should handle multiple facts in a single file' do
+  tag 'risk:high'
+
+  fact_content = <<-EOM
+    Facter.add(:test_fact1) do
+      setcode do
+        "test fact 1"
+      end
+    end
+
+    Facter.add(:test_fact2) do
+      setcode do
+        "test fact 2"
+      end
+    end
+  EOM
+
+  agents.each do |agent|
+    fact_dir = agent.tmpdir('facter')
+    fact_file = File.join(fact_dir, 'test_facts.rb')
+    create_remote_file(agent, fact_file, fact_content)
+    env = {'FACTERLIB' => fact_dir}
+
+    teardown do
+      on(agent, "rm -rf '#{fact_dir}'")
+    end
+
+    step "Agent: Verify test_fact1 from #{fact_file}" do
+      on(agent, facter('test_fact1', :environment => env)) do |facter_result|
+        assert_equal('test fact 1', facter_result.stdout.chomp, 'test_fact1 is not the correct value')
+      end
+    end
+
+    step "Agent: Verify test_fact2 from #{fact_file}" do
+      on(agent, facter('test_fact2', :environment => env)) do |facter_result|
+        assert_equal('test fact 2', facter_result.stdout.chomp, 'test_fact2 is not the correct value')
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/custom_facts/using_win32ole_should_not_hang.rb

@@ -0,0 +1,33 @@
+test_name 'C92060: Custom facts should not hang Facter when using win32ole' do
+  tag 'risk:high'
+
+  confine :to, :platform => /windows/
+  require 'timeout'
+
+  content = <<-EOM
+    Facter.add('custom_fact') do
+      setcode do
+        require 'win32ole'
+        locator = WIN32OLE.new('WbemScripting.SWbemLocator')
+        locator.ConnectServer('', "root/CIMV2", '', '', nil, nil, nil, nil).to_s
+      end
+    end
+  EOM
+
+  agents.each do |agent|
+    custom_dir  = agent.tmpdir('arbitrary_dir')
+    custom_fact = File.join(custom_dir, 'custom_fact.rb')
+    create_remote_file(agent, custom_fact, content)
+
+    teardown do
+      on(agent, "rm -rf '#{custom_dir}'")
+    end
+
+    # Test is assumed to have hung if it takes longer than 5 seconds.
+    Timeout::timeout(5) do
+      on agent, facter('--custom-dir', custom_dir, 'custom_fact') do |facter_result|
+        assert_match(/#<WIN32OLE:0x[0-9a-f]+>/, facter_result.stdout.chomp, 'Custom fact output does not match expected output')
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/external_facts/env_var_overrides_external_fact.rb

@@ -0,0 +1,46 @@
+test_name 'C100537: FACTER_ env var should override external fact' do
+  tag 'risk:medium'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  agents.each do |agent|
+    fact_name      = 'external_fact'
+    fact_value     = 'from_script'
+    override_value = 'override_fact'
+    external_dir   = agent.tmpdir('facts.d')
+    fact_file      = File.join(external_dir,
+                               "#{fact_name}#{get_external_fact_script_extension(agent['platform'])}")
+
+    teardown do
+      on(agent, "rm -rf '#{external_dir}'")
+    end
+
+    step "Agent #{agent}: setup external fact" do
+      on(agent, "mkdir -p '#{external_dir}'")
+      create_remote_file(agent,
+                         fact_file,
+                         external_fact_content(agent['platform'], fact_name, fact_value))
+      on(agent, "chmod +x '#{fact_file}'")
+    end
+
+    step "Agent: #{agent}: ensure external fact resolves correctly" do
+      on(agent, facter("--external-dir '#{external_dir}' #{fact_name}")) do |facter_output|
+        assert_equal(fact_value,
+                     facter_output.stdout.chomp,
+                     'Expected external fact to resolve as defined in script')
+      end
+    end
+
+    step "Agent #{agent}: the fact value from FACTER_ env var should override the external fact value" do
+      on(agent, facter("--external-dir '#{external_dir}' #{fact_name}",
+                       :environment => { "FACTER_#{fact_name}" => override_value })) do |facter_output|
+        assert_equal(override_value,
+                     facter_output.stdout.chomp,
+                     'Expected `FACTER_` fact value to override external fact')
+      end
+    end
+
+  end
+
+end

data/ext/facter/facter/acceptance/tests/external_facts/external_dir_overrides_default_external_fact.rb

@@ -0,0 +1,34 @@
+test_name "C100154: --external-dir fact overrides fact in default facts.d directory" do
+  tag 'risk:high'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  agents.each do |agent|
+    os_version = on(agent, facter('kernelmajversion')).stdout.chomp.to_f
+    ext = get_external_fact_script_extension(agent['platform'])
+    factsd = get_factsd_dir(agent['platform'], os_version)
+    external_dir = agent.tmpdir('facts.d')
+    fact_file = File.join(factsd, "external_fact#{ext}")
+    content = external_fact_content(agent['platform'], 'external_fact', 'value')
+    override_fact_file = File.join(external_dir, "external_fact#{ext}")
+    override_content = external_fact_content(agent['platform'], 'external_fact', 'OVERRIDE_value')
+
+    teardown do
+      on(agent, "rm -f '#{fact_file}' '#{override_fact_file}'")
+    end
+
+    step "Agent #{agent}: setup default external facts directories and the test facts" do
+      on(agent, "mkdir -p '#{factsd}'")
+      create_remote_file(agent, fact_file, content)
+      create_remote_file(agent, override_fact_file, override_content)
+      on(agent, "chmod +x '#{fact_file}' '#{override_fact_file}'")
+    end
+
+    step "Agent #{agent}: the fact value from the custom external dir should override that of facts.d" do
+      on(agent, facter("--external-dir '#{external_dir}' external_fact")) do |facter_output|
+        assert_equal('OVERRIDE_value', facter_output.stdout.chomp, 'Expected to resolve override version of the external_fact')
+      end
+    end
+  end
+end

data/ext/facter/facter/acceptance/tests/external_facts/external_fact_overrides_custom_fact.rb

@@ -0,0 +1,29 @@
+test_name "C100150: external fact overrides custom fact without a weight" do
+  tag 'risk:high'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  fact_name = 'test'
+  # Use a static external fact
+  ext_fact = "#{fact_name}: 'EXTERNAL'"
+
+  agents.each do |agent|
+    facts_dir = agent.tmpdir('facts.d')
+    ext_fact_path = "#{facts_dir}/test.yaml"
+    cust_fact_path = "#{facts_dir}/test.rb"
+    create_remote_file(agent, cust_fact_path, custom_fact_content(fact_name, 'CUSTOM'))
+    create_remote_file(agent, ext_fact_path, ext_fact)
+
+    teardown do
+      on(agent, "rm -rf '#{facts_dir}'")
+    end
+
+    step "Agent #{agent}: resolve an external fact over a custom fact" do
+      on(agent, facter("--external-dir=#{facts_dir} --custom-dir=#{facts_dir} #{fact_name}")) do |facter_output|
+        assert_equal("EXTERNAL", facter_output.stdout.chomp)
+      end
+    end
+  end
+end
+