facter 4.0.26 → 4.0.28

data/acceptance/tests/facts/ssh_key.rb

@@ -0,0 +1,59 @@
+test_name 'SSH publick key' do
+  confine :except, :platform => 'windows'
+  confine :except, :platform => /solaris/
+
+  agents.each do |agent|
+    ssh_host_rsa_key_file = '/etc/ssh/ssh_host_rsa_key.pub'
+    ssh_tmp_host_rsa_key_file = '/tmp/ssh_host_rsa_key.pub'
+
+    # The 'cp' might fail because the source file doesn't exist
+    on(
+      agent,
+      "cp -fv #{ssh_host_rsa_key_file} #{ssh_tmp_host_rsa_key_file}",
+      acceptable_exit_codes: [0, 1]
+    )
+
+    key = 'AAAAB3NzaC1yc2EAAAADAQABAAABAQDi8n9KzzF4tPIZsohBuyxFrLnkT5YbahpIjHvQZbQ9OwG3pOxTcQJjtS/gGMKJeRE2uaHaWb700rGlfGzhit7198FmjCeYdYLZvTH0q76mN9Ew1a8aesE46JMAmZijfehxzmlbyyQDamB0wSv3CbcpGccQ3cp/jBnnj54q9EJuEN+YU/uWVHK9IgNOAj9n7l7ZKKiDAFYlhg22sWIwX+8EyoAp+ewItLpO1BJe+NcnLzMoh71Qfb2Gm/yDPbKt/3N6CHp6JeHNbbPCL0hPkcbMdc/1+3ZuzM0yqt/Sq+6lz1tQBOeDp7UqZNT0t2I5bu0NNMphpBIAELpb4f6uuZ25'
+    rsa_pub_host_key_without_comment = 'ssh-rsa ' + key
+    rsa_pub_host_key_with_comment = rsa_pub_host_key_without_comment + ' root@ciprian.badescu-pf1s74sr\n'
+
+    teardown do
+      # Is it present?
+      rc = on(
+        agent,
+        "[ -e #{ssh_tmp_host_rsa_key_file} ]",
+        accept_all_exit_codes: true,
+      )
+      if rc.exit_code == 0
+        # It's present, so restore the original
+        on(
+          agent,
+          "mv -fv #{ssh_tmp_host_rsa_key_file} #{ssh_host_rsa_key_file}",
+          accept_all_exit_codes: true,
+        )
+      else
+        # It's missing, which means there wasn't one to backup; just
+        # delete the one we laid down
+        on(
+          agent,
+          "rm -fv #{ssh_host_rsa_key_file}",
+          accept_all_exit_codes: true,
+        )
+      end
+    end
+
+    step 'SSH publick key with comment is printed' do
+      on(agent, "echo '#{rsa_pub_host_key_with_comment}' > #{ssh_host_rsa_key_file}")
+      on(agent, facter('ssh.rsa.key')) do |facter_output|
+        assert_equal(key, facter_output.stdout.chomp, 'Expected debug to contain key only')
+      end
+    end
+
+    step 'SSH publick key without comment is printed' do
+      on(agent, "echo '#{rsa_pub_host_key_without_comment}' > #{ssh_host_rsa_key_file}")
+      on(agent, facter('ssh.rsa.key')) do |facter_output|
+        assert_equal(key, facter_output.stdout.chomp, 'Expected debug to contain key only')
+      end
+    end
+  end
+end

data/acceptance/tests/facts/validate_file_system_size_bytes.rb

@@ -0,0 +1,37 @@
+# This test verifies that the numbers for file systems sizes are positive from "facter" and "puppet facts"
+# This is a regression test for FACT-1578
+test_name "C100110: verify that file system sizes are positive" do
+  tag 'risk:high'
+
+  confine :except, :platform => 'windows' # Windows does not list mount points as facts like Unix
+
+  require 'json'
+
+  agents.each do |agent|
+    step("verify that facter returns positive numbers for the mount points byte fields") do
+
+      on(agent, facter("--json")) do |facter_output|
+        facter_results = JSON.parse(facter_output.stdout)
+        facter_results['mountpoints'].each_key do |mount_key|
+          ['available_bytes', 'size_bytes', 'used_bytes'].each do |sub_key|
+            assert_operator(facter_results['mountpoints'][mount_key][sub_key], :>=, 0,
+                            "Expected the #{sub_key} from facter to be positive for #{mount_key}")
+          end
+        end
+      end
+    end
+
+    step("verify that puppet facts returns positive numbers for the mount points byte fields") do
+
+      on(agent, puppet("facts --render-as json")) do |puppet_facts|
+        puppet_results = JSON.parse(puppet_facts.stdout)
+        puppet_results['values']['mountpoints'].each_key do |mount_key|
+          ['available_bytes', 'size_bytes', 'used_bytes'].each do |sub_key|
+            assert_operator(puppet_results['values']['mountpoints'][mount_key][sub_key], :>=, 0,
+                            "Expected the #{sub_key} from puppet facts to be positive for #{mount_key}")
+          end
+        end
+      end
+    end
+  end
+end

data/acceptance/tests/facts/verify_tmpfs_file_system.rb

@@ -0,0 +1,54 @@
+# This test is intended to demonstrate that mount resource can mount tmpfs file systems
+# and the mount facter mountpoints should show the mount as tmpfs
+test_name 'C98163: mountpoints fact should show mounts on tmpfs' do
+  tag 'risk:high'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+
+  confine :except, :platform => 'windows'
+  confine :except, :platform => /osx/ # See PUP-4823
+  confine :except, :platform => /solaris/ # See PUP-5201
+  confine :except, :platform => /aix/     # See PUP-6845
+  confine :except, :platform => /^eos-/ # Mount provider not supported on Arista EOS switches
+  confine :except, :platform => /^cisco_/ # See PUP-5826
+  confine :except, :platform => /^huawei/ # See PUP-6126
+
+  agents.each do |agent|
+    mount_point = '/tmp/mountdir'
+    manifest_dir = agent.tmpdir('tmpfs')
+    manifest = File.join(manifest_dir, 'mount_manifest.pp')
+    manifest_content = <<-FILE
+      mount {"#{mount_point}":
+        ensure  => mounted,
+        options => 'noexec',
+        fstype  => 'tmpfs',
+        device  => 'tmpfs',
+        atboot  => true,
+      }
+    FILE
+    on(agent, "mkdir -p #{mount_point}")
+    create_remote_file(agent, manifest, manifest_content)
+
+    teardown do
+      on(agent, "umount #{mount_point}")
+      on(agent, "rm -rf #{mount_point} #{manifest_dir}")
+    end
+
+    step "Apply the manifest to mount directory '#{mount_point}'" do
+      on(agent, puppet("apply #{manifest}"), :acceptable_exit_codes => [0,2]) do |puppet_apply|
+        assert_no_match(/Error/, puppet_apply.stdout, 'Unexpected error on stdout was detected!')
+        assert_no_match(/ERROR/, puppet_apply.stderr, 'Unexpected error on stderr was detected!')
+      end
+    end
+
+    step 'verify tmpfs mount point seen by facter' do
+      on(agent, facter("mountpoints.#{mount_point}")) do |facter_output|
+        assert_match(/filesystem\s+=>\s+\"tmpfs\"/, facter_output.stdout, 'filesystem is the wrong type')
+        assert_match(/device\s+=>\s+\"tmpfs\"/, facter_output.stdout, 'device is not a tmpfs')
+        assert_match(/noexec/, facter_output.stdout, 'expected to see noexec option')
+      end
+    end
+  end
+end

data/acceptance/tests/facts/windows_os.rb

@@ -0,0 +1,64 @@
+test_name "Test facter os reports correct os.windows.system32" do
+
+#  disable this test until changes in beaker 
+#  https://tickets.puppetlabs.com/browse/BKR-1627
+#  will allow this test to run in timely manner
+  confine :to, :platform => /no-platform/
+#  confine :to, :platform => /windows/
+#  confine :except, :platform => /2008/
+
+  agents.each do |agent|
+    os_type = on(agent, powershell("facter os.windows.installation_type")).stdout.chomp
+    domain_firewall_state = on(agent, powershell("'(Get-NetFirewallProfile -Profile Domain).Enabled'")).stdout.chomp
+    public_firewall_state = on(agent, powershell("'(Get-NetFirewallProfile -Profile Public).Enabled'")).stdout.chomp
+    private_firewall_state = on(agent, powershell("'(Get-NetFirewallProfile -Profile Private).Enabled'")).stdout.chomp
+    on(agent, powershell("'Set-NetFirewallProfile -Profile Domain,Public,Private -Enabled False'"))
+
+    teardown do
+      if os_type == "Server" && on(agent, powershell("'Import-module servermanager ; (Get-WindowsFeature -name RDS-RD-Server).Installed'")).stdout.chomp == "True"
+        on(agent, powershell("'Import-module servermanager ; Remove-WindowsFeature –Name RDS-RD-Server'"))
+        agent.reboot
+        begin
+          agent.down?
+        rescue
+          #TODO: Handle restart pending
+          puts 'Assuming that restart was not caught'
+        end
+        agent.wait_for_port(3389)
+        agent.wait_for_port(22)
+        on(agent, powershell("Set-NetFirewallProfile -Profile Domain -Enabled #{domain_firewall_state}"))
+        on(agent, powershell("Set-NetFirewallProfile -Profile Public -Enabled #{public_firewall_state}"))
+        on(agent, powershell("Set-NetFirewallProfile -Profile Private -Enabled #{private_firewall_state}"))
+      end
+    end
+
+    step "Install Windows remote desktop feature" do
+      if os_type == "Server"
+        on(agent, powershell("facter os.windows.system32")) do |facter_before_output|
+          assert_equal("C:\\Windows\\system32", facter_before_output.stdout.chomp, 'Before windows feature installation, should be C:\\Windows\\system32')
+        end
+        on(agent, powershell("Add-WindowsFeature –Name RDS-RD-Server –IncludeAllSubFeature"))
+        on(agent, powershell("'Import-module servermanager ; (Get-WindowsFeature -name RDS-RD-Server).Installed'")) do |installed_feature|
+          assert_equal("True", installed_feature.stdout.chomp, 'Result should be true for installed RDS-RD-Server feature')
+        end
+        agent.reboot
+        #assert_equal(true, agent.down?, 'Cound install RDS-RD-Server, failed to bring the host down')
+        begin
+          agent.down?
+        rescue
+          #TODO: Handle restart pending
+          puts 'Assuming that restart was not caught'
+        end
+        agent.wait_for_port(3389)
+        agent.wait_for_port(22)
+      end
+    end
+
+    step "Verify facter os reports correct system32 variable" do
+      on(agent, powershell("facter os.windows.system32")) do |facter_output|
+        assert_equal("C:\\Windows\\system32", facter_output.stdout.chomp, 'Result should be C:\\Windows\\system32')
+      end
+    end
+
+  end
+end

data/acceptance/tests/load_libfacter.rb

@@ -0,0 +1,66 @@
+# Verify that we can load the facter the way that mco does based on the platform
+test_name 'C100161: Ruby can load libfacter without raising an error' do
+  tag 'risk:high'
+
+  require 'puppet/acceptance/common_utils'
+  extend Puppet::Acceptance::CommandUtils
+
+  def puppet_ruby_path_to_puppet_install_dir(puppet_ruby_path)
+    # find the "puppet" directory which should be the root of the install
+    puppet_dir = puppet_ruby_path
+    while File.basename(puppet_dir).downcase != 'puppet'
+      new_puppet_dir = File.dirname(puppet_dir)
+      if new_puppet_dir == puppet_dir
+        break
+      else
+        puppet_dir = new_puppet_dir
+      end
+    end
+    puppet_dir
+  end
+
+  agents.each do |agent|
+    # create a ruby program that will add a fact through Facter
+    fact_content = <<-EOM
+    require 'facter'
+    Facter.add('facter_loaded') do
+      setcode do
+        'FACTER_LOADED'
+      end
+    end
+
+    # print a value so that we know that facter loaded and is working
+    puts Facter.value('facter_loaded')
+    exit 0
+    EOM
+
+    fact_dir = agent.tmpdir('mco_test')
+    fact_program = File.join(fact_dir, 'loading_facter.rb')
+    create_remote_file(agent, fact_program, fact_content)
+
+    teardown do
+      on(agent, "rm -rf '#{fact_dir}'")
+    end
+
+    if agent['platform'] =~ /windows/
+      # on Windows we have to figure out where facter.rb is so we can include the path
+      # figure out the root of the Puppet installation
+      puppet_ruby_path = on(agent, "env PATH=\"#{agent['privatebindir']}:${PATH}\" which ruby").stdout.chomp
+      cygwin_puppet_root = puppet_ruby_path_to_puppet_install_dir(puppet_ruby_path)
+      puppet_root = on(agent, "cygpath -w '#{cygwin_puppet_root}'").stdout.chomp
+      # on Windows mco uses -I to include the path to the facter.rb as its not in the
+      # default $LOAD_PATH for Puppets Ruby
+      include_facter_lib = "-I '#{puppet_root}/facter/lib'"
+    else
+      # On Unix systems facter.rb is already in the $LOAD_PATH for Puppets Ruby for mco
+      include_facter_lib = ''
+    end
+
+    # Run Puppet's ruby and load facter.rb
+    # if we fail to load the .jar or .so, ruby will raise an error for us to detect
+    on(agent, "#{ruby_command(agent)} #{include_facter_lib} #{fact_program}") do |ruby_result|
+      assert_equal('FACTER_LOADED', ruby_result.stdout.chomp, 'Expected the output to be only the value the added fact')
+      assert_empty(ruby_result.stderr, 'Expected libfacter to load without any output on stderr')
+    end
+  end
+end

data/acceptance/tests/no_errors_on_stderr.rb

@@ -0,0 +1,10 @@
+test_name 'C14514: Running facter should not output anything to stderr' do
+  tag 'risk:high'
+
+  agents.each do |agent|
+    on(agent, facter) do |facter_output|
+      assert_match(/hostname\s*=>\s*\S*/, facter_output.stdout, 'Hostname fact is missing')
+      assert_empty(facter_output.stderr, 'Facter should not have written to stderr')
+    end
+  end
+end

data/acceptance/tests/options/color.rb

@@ -0,0 +1,16 @@
+# This test is intended to ensure with --debug and --color, facter sends escape sequences to colorize the output
+test_name "C86545: --debug and --color command-line options should print DEBUG messages with color escape sequences" do
+  tag 'risk:high'
+
+  confine :except, :platform => 'windows' # On windows we don't get an escape sequence to detect to color change
+
+  agents.each do |agent|
+    step "Agent #{agent}: retrieve debug info from stderr using --debug and --color option" do
+      # set the TERM type to be a color xterm to help ensure we emit the escape sequence to change the color
+      on(agent, facter('--debug --color'), :environment => { 'TERM' => 'xterm-256color' }) do |facter_output|
+        assert_match(/DEBUG/, facter_output.stderr, "Expected DEBUG information in stderr")
+        assert_match(/\e\[0;/, facter_output.stderr, "Expected to see an escape sequence in the output")
+      end
+    end
+  end
+end

data/acceptance/tests/options/config.rb

@@ -0,0 +1,27 @@
+# This test is intended to verify that the config file location can be specified
+# via the `--config` flag on the command line.
+test_name "C100014: --config command-line option designates the location of the config file" do
+  tag 'risk:high'
+
+  agents.each do |agent|
+    step "Agent #{agent}: create config file" do
+      config_dir = agent.tmpdir("config_dir")
+      config_file = File.join(config_dir, "facter.conf")
+      create_remote_file(agent, config_file, <<-FILE)
+      cli : {
+          debug : true
+      }
+      FILE
+
+      teardown do
+        on(agent, "rm -rf '#{config_dir}'", :acceptable_exit_codes => [0, 1])
+      end
+
+      step "setting --config should cause the config file to be loaded from the specified location" do
+        on(agent, facter("--config '#{config_file}'")) do |facter_output|
+          assert_match(/DEBUG/, facter_output.stderr, "Expected debug output on stderr")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# This test verifies that when a fact group is blocked in the config file
+# the corresponding facts do not resolve.
+test_name "C99972: facts can be blocked via a blocklist in the config file" do
+  tag 'risk:high'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  agents.each do |agent|
+    step "Agent #{agent}: create config file" do
+      custom_conf_dir = agent.tmpdir("config_dir")
+      config_file = File.join(custom_conf_dir, "facter.conf")
+      create_remote_file(agent, config_file, <<-FILE)
+        cli : { debug : true }
+        facts : { blocklist : [ "file system", "EC2" ] }
+      FILE
+
+      teardown do
+        on(agent, "rm -rf '#{custom_conf_dir}'", :acceptable_exit_codes => [0, 1])
+      end
+
+      step "blocked facts should not be resolved" do
+        on(agent, facter("--config '#{config_file}'")) do |facter_output|
+          # every platform attempts to resolve at least EC2 facts
+          assert_match(/blocking collection of .+ facts/, facter_output.stderr, "Expected stderr to contain statement about blocking fact collection")
+
+          # on some platforms, file system facts are never resolved, so this will also be true in those cases
+          assert_no_match(/filesystems/, facter_output.stdout, "filesystems fact should have been blocked")
+          assert_no_match(/mountpoints/, facter_output.stdout, "mountpoints fact should have been blocked")
+          assert_no_match(/partitions/, facter_output.stdout, "partitions fact should have been blocked")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# This test verifies that when a fact group is blocked in the config file the
+# corresponding facts do not resolve when being run from the puppet facts command.
+test_name "C100036: when run from puppet facts, facts can be blocked via a list in the config file" do
+  tag 'risk:medium'
+
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  agents.each do |agent|
+    step "facts should be blocked when Facter is run from Puppet with a configured blocklist" do
+      # 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")
+
+      teardown do
+        on(agent, "rm -rf '#{facter_conf_default_dir}'", :acceptable_exit_codes => [0, 1])
+      end
+
+      step "Agent #{agent}: create default config file" do
+        # create the directories
+        on(agent, "mkdir -p '#{facter_conf_default_dir}'")
+        create_remote_file(agent, facter_conf_default_path, <<-FILE)
+        facts : { blocklist : [ "file system", "EC2" ] }
+        FILE
+      end
+
+      step "blocked facts should not be resolved" do
+        on(agent, puppet("facts --debug")) do |puppet_facts_output|
+          # every platform attempts to resolve at least EC2 facts
+          assert_match(/blocking collection of .+ facts/, puppet_facts_output.stdout, "Expected stderr to contain statement about blocking fact collection")
+
+          # on some platforms, file system facts are never resolved, so this will also be true in those cases
+          assert_no_match(/filesystems/, puppet_facts_output.stdout, "filesystems fact should have been blocked")
+          assert_no_match(/mountpoints/, puppet_facts_output.stdout, "mountpoints fact should have been blocked")
+          assert_no_match(/partitions/, puppet_facts_output.stdout, "partitions fact should have been blocked")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# This test verifies that the custom-dir specified in the configuration file can be overridden by using
+# --custom-dir on the command line
+test_name "C100015: config custom-dir overridden by command line --custom-dir" do
+  tag 'risk:medium'
+
+  require 'json'
+  require 'facter/acceptance/user_fact_utils'
+  extend Facter::Acceptance::UserFactUtils
+
+  config_fact_content = <<EOM
+Facter.add('config_fact') do
+  setcode do
+    "config_value"
+  end
+end
+EOM
+
+  cli_fact_content = <<EOM
+Facter.add('cli_fact') do
+  setcode do
+    "cli_value"
+  end
+end
+EOM
+
+  agents.each do |agent|
+    step "Agent #{agent}: create 2 custom fact directories with facts and a config file pointing at 1 directory" do
+      custom_config_dir = agent.tmpdir('custom_dir')
+      custom_cli_dir = agent.tmpdir('cli_custom_dir')
+      custom_config_fact = File.join(custom_config_dir, 'custom_fact.rb')
+      custom_cli_fact = File.join(custom_cli_dir, 'custom_fact.rb')
+      create_remote_file(agent, custom_config_fact, config_fact_content)
+      create_remote_file(agent, custom_cli_fact, cli_fact_content)
+      config_dir = agent.tmpdir("config_dir")
+      config_file = File.join(config_dir, "facter.conf")
+      config_content = <<EOM
+global : {
+    custom-dir : "#{custom_config_dir}",
+}
+EOM
+      create_remote_file(agent, config_file, config_content)
+
+      teardown do
+        on(agent, "rm -rf '#{custom_config_dir}' '#{custom_cli_dir}' '#{config_dir}'")
+      end
+
+      step "Agent #{agent}: resolve a fact from the command line custom-dir and not the config file" do
+        on(agent, facter("--config '#{config_file}' --custom-dir '#{custom_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