beaker 2.27.0 → 2.28.0

data/acceptance/fixtures/files/shell_script_with_output.txt

@@ -0,0 +1,3 @@
+
+# this shell script always succeeds, and produces output
+echo "output"

data/acceptance/fixtures/files/simple_text_file.txt

@@ -0,0 +1,3 @@
+This is a simple text file.
+
+It has three lines.

data/acceptance/fixtures/files/sles-11-x86_64.repo

@@ -0,0 +1,5 @@
+[PE-3.8-sles-11-x86_64]
+name=PE-3.8-sles-11-x86_64
+baseurl=http://enterprise.delivery.puppetlabs.net/3.8/repos/sles-11-x86_64
+enabled=1
+gpgcheck=0

data/acceptance/lib/helpers/test_helper.rb

@@ -0,0 +1,111 @@
+# NOTE: Currently scp failures throw a Net::SCP::Error exception in SSH connection
+# close, which ends up not being caught properly, and which ultimately results
+# in a RuntimeError. The SSH Connection is left in an unusable state and all
+# later remote commands will hang indefinitely.
+#
+# TODO: fix via: https://tickets.puppetlabs.com/browse/BKR-464
+def test_scp_error_on_close?
+  !!ENV["BEAKER_TEST_SCP_ERROR_ON_CLOSE"]
+end
+
+# NOTE: currently there is an issue with the tmpdir_on helper on cygwin and OS X
+# platforms:  the `chown` command always fails with an error about not
+# recognizing the Administrator:Administrator user/group.  Also, the call to
+# check user presence via `getent` also fails. Until this is fixed, we add this
+# shim that delegates to a non-`chown`/non-`getent`-executing version for the
+# purposes of our test setup.
+#
+# TODO: fix via: https://tickets.puppetlabs.com/browse/BKR-496
+def tmpdir_on(hosts, path_prefix = '', user=nil)
+  first_host = Array(hosts).first
+
+  return create_tmpdir_on(hosts, path_prefix, user) unless \
+    first_host.is_cygwin? or first_host.platform =~ /osx/
+
+  block_on hosts do | host |
+    # use default user logged into this host
+    if not user
+      user = host['user']
+    end
+
+    if defined? host.tmpdir
+      host.tmpdir(path_prefix)
+    else
+      raise "Host platform not supported by `tmpdir_on`."
+    end
+  end
+end
+
+# Returns the absolute path where file fixtures are located.
+def fixture_path
+  @fixture_path ||=
+    File.expand_path(File.join(__FILE__, '..', '..', '..', 'fixtures', 'files'))
+end
+
+# Returns the contents of a named fixture file, to be found in `fixture_path`.
+def fixture_contents(fixture)
+  fixture_file = File.join(fixture_path, "#{fixture}.txt")
+  File.read(fixture_file)
+end
+
+# Create a file on `host` in the `remote_path` with file name `filename`,
+# containing the contents of the fixture file named `fixture`.  Returns
+# the full remote path to the created file, and the file contents.
+def create_remote_file_from_fixture(fixture, host, remote_path, filename)
+  full_filename = File.join(remote_path, filename)
+  contents = fixture_contents fixture
+  create_remote_file host, full_filename, contents
+  [ full_filename, contents ]
+end
+
+# Create a file locally, in the `local_path`, with file name `filename`,
+# containing the contents of the fixture file named `fixture`; optionally
+# setting the file permissions to `perms`. Returns the full path to the created
+# file, and the file contents.
+def create_local_file_from_fixture(fixture, local_path, filename, perms = nil)
+  full_filename = File.join(local_path, filename)
+  contents = fixture_contents fixture
+
+  File.open(full_filename, "w") do |local_file|
+    local_file.puts contents
+  end
+  FileUtils.chmod perms, full_filename if perms
+
+  [ full_filename, contents ]
+end
+
+# Provide debugging information for tests which are known to fail intermittently
+#
+# issue_link - url of Jira issue documenting this intermittent test failure
+# args       - Hash of debugging information (names => values) to output on a failure
+# block      - block which intermittently fails
+#
+# Example
+#
+#    fails_intermittently('https://tickets.puppetlabs.com/browse/QENG-2958',
+#      '@host' => @host, 'user' => user, 'expected' => expected) do
+#      assert_equal expected, user
+#    end
+#
+# Absorbs any MiniTest::Assertion from a failing test assertion in the block.
+# This implies that the intermittent failure is caught and the suite will not
+# go red for this failure. Intended to be used with the Jenkins Build Failure
+# Analyzer (or similar), to detect these failures without failing the build.
+#
+# Returns the value of the yielded block.
+def fails_intermittently(issue_link, args = {}, &block)
+  raise ArgumentError, "provide a Jira ticket link" unless issue_link
+  raise ArgumentError, "a block is required" unless block_given?
+  yield
+rescue MiniTest::Assertion, StandardError, SignalException => boom # we have a test failure!
+  STDERR.puts "\n\nIntermittent test failure! See: #{issue_link}"
+
+  if args.empty?
+    STDERR.puts "No further debugging information available."
+  else
+    STDERR.puts "Debugging information:\n"
+    args.keys.sort.each do |key|
+      STDERR.puts "#{key} => #{args[key].inspect}"
+    end
+  end
+end

data/acceptance/tests/base/dsl/helpers/configuration_test.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'lib'))
+
+require 'helpers/test_helper'
+
+test_name "dsl::helpers::host_helpers test configuration validation" do
+  step "Validate hosts configuration" do
+    assert (hosts.size > 1),
+      "dsl::helpers::host_helpers acceptance tests require at least two hosts"
+
+    agents = select_hosts(:roles => "agent")
+    assert (agents.size > 1),
+      "dsl::helpers::host_helpers acceptance tests require at least two hosts with the :agent role"
+
+    assert default,
+      "dsl::helpers::host_helpers acceptance tests require a default host"
+  end
+end

data/acceptance/tests/base/dsl/helpers/host_helpers/add_system32_hosts_entry_test.rb

@@ -0,0 +1,50 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #add_system32_hosts_entry" do
+
+  confine_block :to, :platform => /windows/ do
+
+    step "#add_system32_hosts_entry fails when run on a non-powershell platform" do
+      # NOTE: would expect this to be better documented.
+      if default.is_powershell?
+        logger.info "Skipping failure test on powershell platforms..."
+      else
+        assert_raises RuntimeError do
+          add_system32_hosts_entry default, { :ip => '123.45.67.89', :name => 'beaker.puppetlabs.com' }
+        end
+      end
+    end
+
+    step "#add_system32_hosts_entry, when run on a powershell platform, adds a host entry to system32 etc\\hosts" do
+      if default.is_powershell?
+        add_system32_hosts_entry default, { :ip => '123.45.67.89', :name => 'beaker.puppetlabs.com' }
+
+        # TODO: how do we assert, via powershell, that the entry was added?
+        # NOTE: see: https://github.com/puppetlabs/beaker/commit/685628f4babebe9cb4663418da6a8ff528dd32da#commitcomment-12957573
+
+      else
+        logger.info "Skipping test on non-powershell platforms..."
+      end
+    end
+
+    step "#add_system32_hosts_entry CURRENTLY fails with a TypeError when given a hosts array" do
+      # NOTE: would expect this to fail with Beaker::Host::CommandFailure
+      assert_raises NoMethodError do
+        add_system32_hosts_entry hosts, { :ip => '123.45.67.89', :name => 'beaker.puppetlabs.com' }
+      end
+    end
+  end
+
+  confine_block :except, :platform => /windows/ do
+
+    step "#add_system32_hosts_entry CURRENTLY fails with RuntimeError when run on a non-windows platform" do
+      # NOTE: would expect this to behave the same way it does on a windows
+      #       non-powershell platform (raises Beaker::Host::CommandFailure), or
+      #       as requested in the original PR:
+      #       https://github.com/puppetlabs/beaker/pull/420/files#r17990622
+      assert_raises RuntimeError do
+        add_system32_hosts_entry default, { :ip => '123.45.67.89', :name => 'beaker.puppetlabs.com' }
+      end
+    end
+  end
+end

data/acceptance/tests/base/dsl/helpers/host_helpers/backup_the_file_test.rb

@@ -0,0 +1,64 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #backup_the_file" do
+  step "#backup_the_file CURRENTLY will return nil if the file does not exist in the source directory" do
+    # NOTE: would expect this to fail with Beaker::Host::CommandFailure
+    remote_source = tmpdir_on default
+    remote_destination = tmpdir_on default
+    result = backup_the_file default, remote_source, remote_destination
+    assert_nil result
+  end
+
+  step "#backup_the_file will fail if the destination directory does not exist" do
+    remote_source = tmpdir_on default
+    remote_source_filename = File.join(remote_source, "puppet.conf")
+    remote_filename, contents = create_remote_file_from_fixture("simple_text_file", default, remote_source, "puppet.conf")
+
+    assert_raises Beaker::Host::CommandFailure do
+      result = backup_the_file default, remote_source, "/non/existent/"
+    end
+  end
+
+  step "#backup_the_file copies `puppet.conf` from the source to the destination directory" do
+    remote_source = tmpdir_on default
+    remote_source_filename = File.join(remote_source, "puppet.conf")
+    remote_filename, contents = create_remote_file_from_fixture("simple_text_file", default, remote_source, "puppet.conf")
+
+    remote_destination = tmpdir_on default
+    remote_destination_filename = File.join(remote_destination, "puppet.conf.bak")
+
+    result = backup_the_file default, remote_source, remote_destination
+
+    assert_equal remote_destination_filename, result
+    remote_contents = on(default, "cat #{remote_destination_filename}").stdout
+    assert_equal contents, remote_contents
+  end
+
+  step "#backup_the_file copies a named file from the source to the destination directory" do
+    remote_source = tmpdir_on default
+    remote_source_filename = File.join(remote_source, "testfile.txt")
+    remote_filename, contents = create_remote_file_from_fixture("simple_text_file", default, remote_source, "testfile.txt")
+
+    remote_destination = tmpdir_on default
+    remote_destination_filename = File.join(remote_destination, "testfile.txt.bak")
+
+    result = backup_the_file default, remote_source, remote_destination, "testfile.txt"
+
+    assert_equal remote_destination_filename, result
+    remote_contents = on(default, "cat #{remote_destination_filename}").stdout
+    assert_equal contents, remote_contents
+  end
+
+  step "#backup_the_file CURRENTLY will fail if given a hosts array" do
+    remote_source = tmpdir_on default
+    remote_source_filename = File.join(remote_source, "testfile.txt")
+    remote_filename, contents = create_remote_file_from_fixture("simple_text_file", default, remote_source, "testfile.txt")
+    remote_destination = tmpdir_on default
+
+    remote_destination_filename = File.join(remote_destination, "testfile.txt.bak")
+
+    assert_raises NoMethodError do
+      result = backup_the_file hosts, remote_source, remote_destination
+    end
+  end
+end

data/acceptance/tests/base/dsl/helpers/host_helpers/check_for_package_test.rb

@@ -0,0 +1,100 @@
+require "helpers/test_helper"
+
+# Return the name of a platform-specific package known to be installed on a system
+def known_installed_package
+  case default['platform']
+  when /solaris.*11/
+    "shell/bash"
+  when /solaris.*10/
+    "SUNWbash"
+  when /windows/
+    "bash"
+  else
+    "rsync"
+  end
+end
+
+test_name "dsl::helpers::host_helpers #check_for_package" do
+
+  # NOTE: vivid packages are not ready on nightlies.puppetlabs.com,
+  #       see:  https://tickets.puppetlabs.com/browse/CPR-173
+  #       also: https://tickets.puppetlabs.com/browse/BKR-513
+  confine :except, :platform => /ubuntu.*15/
+
+  # NOTE: there does not appear to be a way to confine just to cygwin hosts
+  confine_block :to, :platform => /windows/ do
+
+    # NOTE: check_for_package on windows currently fails as follows:
+    #
+    #       ArgumentError: wrong number of arguments (3 for 1..2)
+    #
+    #       Would expect this to be documented better, and to fail with Beaker::Host::CommandFailure
+
+    step "#check_for_package will return false if the specified package is not installed on the remote host" do
+      result = check_for_package default, "non-existent-package-name"
+      assert !result
+    end
+
+    step "#check_for_package will return true if the specified package is installed on the remote host" do
+      result = check_for_package default, known_installed_package
+      assert result
+    end
+
+    step "#check_for_package CURRENTLY fails if given a host array" do
+      assert_raises NoMethodError do
+        check_for_package hosts, known_installed_package
+      end
+    end
+  end
+
+  confine_block :to, :platform => /solaris/ do
+
+    step "#check_for_package will return false if the specified package is not installed on the remote host" do
+      result = check_for_package default, "non-existent-package-name"
+      assert !result
+    end
+
+    step "#check_for_package will return true if the specified package is installed on the remote host" do
+      result = check_for_package default, known_installed_package
+      assert result
+    end
+
+    step "#check_for_package CURRENTLY fails if given a host array" do
+      assert_raises NoMethodError do
+        check_for_package hosts, known_installed_package
+      end
+    end
+  end
+
+  confine_block :to, :platform => /osx/ do
+    step "#check_for_package CURRENTLY fails with a RuntimeError on OS X" do
+      assert_raises RuntimeError do
+        check_for_package default, known_installed_package
+      end
+    end
+  end
+
+  confine_block :except, :platform => /windows|solaris|osx/ do
+
+    step "#check_for_package will return false if the specified package is not installed on the remote host" do
+      result = check_for_package default, "non-existent-package-name"
+      assert !result
+    end
+
+    step "#check_for_package will return true if the specified package is installed on the remote host" do
+      install_package default, known_installed_package
+      result = check_for_package default, known_installed_package
+      assert result
+    end
+
+    step "#check_for_package CURRENTLY fails if given a host array" do
+      # NOTE: would expect this to work across hosts, or to be better
+      #       documented. If not supported, should raise
+      #       Beaker::Host::CommandFailure
+
+      assert_raises NoMethodError do
+        check_for_package hosts, known_installed_package
+      end
+    end
+  end
+end

data/acceptance/tests/base/dsl/helpers/host_helpers/create_remote_file_test.rb

@@ -0,0 +1,201 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #create_remote_file" do
+
+  confine_block :to, :platform => /^centos|el-\d|fedora/ do
+    step "installing `rsync` on #{default['platform']} for all later test steps" do
+      hosts.each do |host|
+        install_package host, "rsync"
+      end
+    end
+  end
+
+  if test_scp_error_on_close?
+    step "#create_remote_file fails when the remote path does not exist" do
+      assert_raises Beaker::Host::CommandFailure do
+        create_remote_file default, "/non/existent/testfile.txt", "contents\n"
+      end
+    end
+
+    step "#create_remote_file fails when the remote path does not exist, using scp" do
+      assert_raises Beaker::Host::CommandFailure do
+        create_remote_file default, "/non/existent/testfile.txt", "contents\n", { :protocol => 'scp' }
+      end
+    end
+  end
+
+  step "#create_remote_file CURRENTLY does not fail and does not create a remote file when the remote path does not exist, using rsync" do
+    # NOTE: would expect this to fail with Beaker::Host::CommandFailure
+
+    create_remote_file default, "/non/existent/testfile.txt", "contents\n", { :protocol => 'rsync' }
+
+    assert_raises Beaker::Host::CommandFailure do
+      on(default, "cat /non/existent/testfile.txt").exit_code
+    end
+  end
+
+  step "#create_remote_file creates a remote file with the specified contents" do
+    remote_tmpdir = tmpdir_on default
+    remote_filename = File.join(remote_tmpdir, "testfile.txt")
+    contents = fixture_contents("simple_text_file")
+
+    create_remote_file default, remote_filename, contents
+
+    remote_contents = on(default, "cat #{remote_filename}").stdout
+    assert_equal contents, remote_contents
+  end
+
+  step "#create_remote_file creates a remote file with the specified contents, using scp" do
+    remote_tmpdir = tmpdir_on default
+    remote_filename = File.join(remote_tmpdir, "testfile.txt")
+    contents = fixture_contents("simple_text_file")
+
+    create_remote_file default, remote_filename, contents, { :protocol => "scp" }
+
+    remote_contents = on(default, "cat #{remote_filename}").stdout
+    assert_equal contents, remote_contents
+  end
+
+  # NOTE: there does not seem to be a reliable way to confine to cygwin hosts.
+  confine_block :to, :platform => /windows|solaris.*10/ do
+
+    # NOTE: rsync methods are not working currently on windows and solaris 10 platforms
+
+    step "#create_remote_file CURRENTLY fails on #{default['platform']}, using rsync" do
+      remote_tmpdir = tmpdir_on default
+      remote_filename = File.join(remote_tmpdir, "testfile.txt")
+      contents = fixture_contents("simple_text_file")
+
+      create_remote_file default, remote_filename, contents, { :protocol => "rsync" }
+
+      assert_raises Beaker::Host::CommandFailure do
+        remote_contents = on(default, "cat #{remote_filename}").stdout
+      end
+    end
+  end
+
+  confine_block :except, :platform => /windows|solaris.*10/ do
+
+    step "#create_remote_file creates a remote file with the specified contents, using rsync" do
+      remote_tmpdir = tmpdir_on default
+      remote_filename = File.join(remote_tmpdir, "testfile.txt")
+      contents = fixture_contents("simple_text_file")
+
+      result = create_remote_file default, remote_filename, contents, { :protocol => "rsync" }
+
+      fails_intermittently("https://tickets.puppetlabs.com/browse/BKR-612",
+        "default" => default,
+        "remote_tmpdir" => remote_tmpdir,
+        "remote_filename" => remote_filename,
+        "contents" => contents,
+        "result" => result
+        ) do
+          remote_contents = on(default, "cat #{remote_filename}").stdout
+          assert_equal contents, remote_contents
+      end
+    end
+  end
+
+  step "#create_remote_file' does not create a remote file when an unknown protocol is specified" do
+    remote_tmpdir = tmpdir_on default
+    remote_filename = File.join(remote_tmpdir, "testfile.txt")
+    contents = fixture_contents("simple_text_file")
+
+    create_remote_file default, remote_filename, contents, { :protocol => 'unknown' }
+
+    assert_raises Beaker::Host::CommandFailure do
+      on(default, "cat #{remote_filename}").exit_code
+    end
+  end
+
+  step "#create_remote_file creates remote files on all remote hosts, when given an array" do
+    remote_tmpdir = tmpdir_on default
+    on hosts, "mkdir -p #{remote_tmpdir}"
+    remote_filename = File.join(remote_tmpdir, "testfile.txt")
+    contents = fixture_contents("simple_text_file")
+
+    create_remote_file hosts, remote_filename, contents
+
+    hosts.each do |host|
+      remote_contents = on(host, "cat #{remote_filename}").stdout
+      assert_equal contents, remote_contents
+    end
+  end
+
+  step "#create_remote_file creates remote files on all remote hosts, when given an array, using scp" do
+    remote_tmpdir = tmpdir_on default
+    on hosts, "mkdir -p #{remote_tmpdir}"
+    remote_filename = File.join(remote_tmpdir, "testfile.txt")
+    contents = fixture_contents("simple_text_file")
+
+    create_remote_file hosts, remote_filename, contents, { :protocol => 'scp' }
+
+    hosts.each do |host|
+      remote_contents = on(host, "cat #{remote_filename}").stdout
+      assert_equal contents, remote_contents
+    end
+  end
+
+  # NOTE: there does not appear to be a way to confine just to cygwin hosts
+  confine_block :to, :platform => /windows|solaris.*10/ do
+
+    # NOTE: rsync methods are not working currently on windows and solaris 10
+    #       platforms. Would expect this to be documented better.
+
+    step "#create_remote_file creates remote files on all remote hosts, when given an array, using rsync" do
+      remote_tmpdir = tmpdir_on default
+      on hosts, "mkdir -p #{remote_tmpdir}"
+      remote_filename = File.join(remote_tmpdir, "testfile.txt")
+      contents = fixture_contents("simple_text_file")
+
+      create_remote_file hosts, remote_filename, contents, { :protocol => 'rsync' }
+
+      hosts.each do |host|
+        assert_raises Beaker::Host::CommandFailure do
+          remote_contents = on(host, "cat #{remote_filename}").stdout
+        end
+      end
+    end
+  end
+
+  confine_block :except, :platform => /windows|solaris.*10|fedora/ do
+
+    step "#create_remote_file creates remote files on all remote hosts, when given an array, using rsync" do
+      remote_tmpdir = tmpdir_on default
+
+      # NOTE: we do not do this step in the non-hosts-array version of the test, not sure why
+      on hosts, "mkdir -p #{remote_tmpdir}"
+
+      remote_filename = File.join(remote_tmpdir, "testfile.txt")
+      contents = fixture_contents("simple_text_file")
+
+      result = create_remote_file hosts, remote_filename, contents, { :protocol => 'rsync' }
+
+      hosts.each do |host|
+        fails_intermittently("https://tickets.puppetlabs.com/browse/BKR-612",
+          "host" => host,
+          "remote_tmpdir" => remote_tmpdir,
+          "remote_filename" => remote_filename,
+          "contents" => contents,
+          "result" => result
+          ) do
+          remote_contents = on(host, "cat #{remote_filename}").stdout
+          assert_equal contents, remote_contents
+        end
+      end
+    end
+  end
+
+  confine_block :to, :platform => /centos|el-\d|fedora/ do
+
+    step "uninstall rsync package on #{default['platform']} for later test runs" do
+      # NOTE: this is basically a #teardown section for test isolation
+      #       Could we reorganize tests into different files to make this
+      #       clearer?
+
+      hosts.each do |host|
+        on host, "yum -y remove rsync"
+      end
+    end
+  end
+end