beaker 2.27.0 → 2.28.0

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

@@ -0,0 +1,42 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #retry_on" do
+  step "#retry_on CURRENTLY fails with a RuntimeError if command does not pass after all retries" do
+    # NOTE: would have expected this to fail with Beaker::Hosts::CommandFailure
+
+    remote_tmpdir = tmpdir_on default
+    remote_script_file = File.join(remote_tmpdir, "test.sh")
+    remote_filename, contents = create_remote_file_from_fixture("retry_script", default, remote_tmpdir, "test.sh")
+
+    assert_raises RuntimeError do
+      retry_on default, "bash #{remote_script_file} #{remote_tmpdir} 10", { :max_retries => 2, :retry_interval => 0.1 }
+    end
+  end
+
+  step "#retry_on succeeds if command passes before retries are exhausted" do
+    remote_tmpdir = tmpdir_on default
+    remote_script_file = File.join(remote_tmpdir, "test.sh")
+    remote_filename, contents = create_remote_file_from_fixture("retry_script", default, remote_tmpdir, "test.sh")
+
+    result = retry_on default, "bash #{remote_script_file} #{remote_tmpdir} 2", { :max_retries => 4, :retry_interval => 0.1 }
+    assert_equal 0, result.exit_code
+    assert_equal "", result.stdout
+  end
+
+  step "#retry_on CURRENTLY fails when provided a host array" do
+    # NOTE: would expect this to work across hosts, or be better documented and
+    #       to raise Beaker::Host::CommandFailure
+
+    remote_tmpdir = tmpdir_on default
+    remote_script_file = File.join(remote_tmpdir, "test.sh")
+
+    hosts.each do |host|
+      on host, "mkdir -p #{remote_tmpdir}"
+      remote_filename, contents = create_remote_file_from_fixture("retry_script", host, remote_tmpdir, "test.sh")
+    end
+
+    assert_raises NoMethodError do
+      result = retry_on hosts, "bash #{remote_script_file} #{remote_tmpdir} 2", { :max_retries => 4, :retry_interval => 0.1 }
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #rsync_to" do
+
+  confine_block :to, :platform => /^solaris.*10/ do
+
+    step "#rsync_to CURRENTLY will fail without error, but not copy the requested file, on #{default['platform']} due to lack of installed rsync" do
+
+      # NOTE: this should be documented
+      # FIXME: This is also true for CentOS/EL-*, but package removal appears
+      #        to not be working properly, so we cannot get test isolation
+      #        to test this as if the system is pristine.
+      Dir.mktmpdir do |local_dir|
+        local_filename, contents = create_local_file_from_fixture("simple_text_file", local_dir, "testfile.txt")
+        remote_tmpdir = tmpdir_on default
+
+        rsync_to default, local_filename, remote_tmpdir
+
+        remote_filename = File.join(remote_tmpdir, "testfile.txt")
+
+        assert_raises Beaker::Host::CommandFailure do
+          remote_contents = on(default, "cat #{remote_filename}").stdout
+        end
+      end
+    end
+  end
+
+  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
+
+  # NOTE: there does not seem to be a reliable way to confine to cygwin hosts.
+  confine_block :to, :platform => /windows/ do
+
+    # NOTE: rsync methods are not working currently on windows platforms. Would
+    #       expect this to be documented better.
+
+    step "#rsync_to CURRENTLY fails on windows systems" do
+      Dir.mktmpdir do |local_dir|
+        local_filename, contents = create_local_file_from_fixture("simple_text_file", local_dir, "testfile.txt")
+        remote_tmpdir = tmpdir_on default
+
+        rsync_to default, local_filename, remote_tmpdir
+
+        remote_filename = File.join(remote_tmpdir, "testfile.txt")
+        assert_raises Beaker::Host::CommandFailure do
+          remote_contents = on(default, "cat #{remote_filename}").stdout
+        end
+      end
+    end
+  end
+
+  confine_block :except, :platform => /windows|solaris.*10/ do
+
+    step "#rsync_to fails if the local file cannot be found" do
+      remote_tmpdir = tmpdir_on default
+      assert_raises IOError do
+        rsync_to default, "/non/existent/file.txt", remote_tmpdir
+      end
+    end
+
+    step "#rsync_to CURRENTLY does not fail, but does not copy the file if the remote path cannot be found" do
+      # NOTE: would expect this to fail with Beaker::Host::CommandFailure
+
+      Dir.mktmpdir do |local_dir|
+        local_filename, contents = create_local_file_from_fixture("simple_text_file", local_dir, "testfile.txt")
+
+        rsync_to default, local_filename, "/non/existent/testfile.txt"
+        assert_raises Beaker::Host::CommandFailure do
+          on(default, "cat /non/existent/testfile.txt").exit_code
+        end
+      end
+    end
+
+    step "#rsync_to creates the file on the remote system" do
+      Dir.mktmpdir do |local_dir|
+        local_filename, contents = create_local_file_from_fixture("simple_text_file", local_dir, "testfile.txt")
+        remote_tmpdir = tmpdir_on default
+        remote_filename = File.join(remote_tmpdir, "testfile.txt")
+
+        result = rsync_to default, local_filename, remote_tmpdir
+
+        fails_intermittently("https://tickets.puppetlabs.com/browse/QENG-3053",
+          "result"          => result,
+          "default"         => default,
+          "contents"        => contents,
+          "local_filename"  => local_filename,
+          "local_dir"       => local_dir,
+          "remote_filename" => remote_filename,
+          "remote_tmdir"    => remote_tmpdir,
+          "result"          => result.inspect,
+        ) do
+          remote_contents = on(default, "cat #{remote_filename}").stdout
+          assert_equal contents, remote_contents
+        end
+      end
+    end
+
+    step "#rsync_to creates the file on all remote systems when a host array is provided" do
+      Dir.mktmpdir do |local_dir|
+        local_filename, contents = create_local_file_from_fixture("simple_text_file", local_dir, "testfile.txt")
+        remote_tmpdir = tmpdir_on default
+        on hosts, "mkdir -p #{remote_tmpdir}"
+        remote_filename = File.join(remote_tmpdir, "testfile.txt")
+
+        result = rsync_to hosts, local_filename, remote_tmpdir
+
+        hosts.each do |host|
+          fails_intermittently("https://tickets.puppetlabs.com/browse/QENG-3053",
+            "result"          => result,
+            "host"            => host,
+            "contents"        => contents,
+            "local_filename"  => local_filename,
+            "local_dir"       => local_dir,
+            "remote_filename" => remote_filename,
+            "remote_tmdir"    => remote_tmpdir,
+            "result"          => result.inspect,
+          ) do
+            remote_contents = on(host, "cat #{remote_filename}").stdout
+            assert_equal contents, remote_contents
+          end
+        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

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

@@ -0,0 +1,242 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #run_cron_on" do
+
+  confine_block :to, :platform => /windows/ do
+
+    step "#run_cron_on fails on windows platforms when listing cron jobs for a user on a host" do
+      assert_raises Beaker::Host::CommandFailure do
+        run_cron_on default, :list, default['user']
+      end
+    end
+  end
+
+  confine_block :to, :platform => /solaris/ do
+
+    step "#run_cron_on CURRENTLY does nothing and returns `nil` when an unknown command is provided" do
+      # NOTE: would have expected this to raise Beaker::Host::CommandFailure instead
+
+      assert_nil run_cron_on default, :nonexistent_action, default['user']
+    end
+
+    step "#run_cron_on CURRENTLY does not fail when listing cron jobs for an unknown user" do
+      assert_raises Beaker::Host::CommandFailure do
+        run_cron_on default, :list, "nonexistentuser"
+      end
+    end
+
+    step "#run_cron_on CURRENTLY does not fail when listing cron jobs for a user with no cron entries" do
+      result = run_cron_on default, :list, default['user']
+      assert_equal 0, result.exit_code
+    end
+
+    step "#run_cron_on returns a list of cron jobs for a user with cron entries" do
+      # this basically requires us to add a cron entry to make this work
+      run_cron_on default, :add, default['user'], "* * * * * /bin/ls >/dev/null"
+      result = run_cron_on default, :list, default['user']
+      assert_equal 0, result.exit_code
+      assert_match %r{/bin/ls}, result.stdout
+    end
+
+    step "#run_cron_on CURRENTLY does not fail, but returns nil, when adding cron jobs for an unknown user" do
+      result = run_cron_on default, :add, "nonexistentuser", %Q{* * * * * /bin/echo "hello" >/dev/null}
+      assert_nil result
+    end
+
+    step "#run_cron_on CURRENTLY does not fail, but returns nil, when attempting to add a bad cron entry" do
+      result = run_cron_on default, :add, default['user'], "* * * * /bin/ls >/dev/null"
+      assert_nil result
+    end
+
+    step "#run_cron_on can add a cron job for a user on a host" do
+      run_cron_on default, :add, default['user'], %Q{* * * * * /bin/echo "hello" >/dev/null}
+      result = run_cron_on default, :list, default['user']
+      assert_equal 0, result.exit_code
+      assert_match %r{/bin/echo}, result.stdout
+    end
+
+    step "#run_cron_on CURRENTLY replaces all of user's cron jobs with any newly added jobs" do
+      # NOTE: would have expected this to append new entries, or manage them as puppet manages
+      #       cron entries.  See also: https://github.com/puppetlabs/beaker/pull/937#discussion_r38338494
+
+      1.upto(3) do |job_number|
+        run_cron_on default, :add, default['user'], %Q{* * * * * /bin/echo "job :#{job_number}:" >/dev/null}
+      end
+
+      result = run_cron_on default, :list, default['user']
+
+      assert_no_match %r{job :1:}, result.stdout
+      assert_no_match %r{job :2:}, result.stdout
+      assert_match %r{job :3:}, result.stdout
+    end
+
+    step "#run_cron_on :remove CURRENTLY removes all cron jobs for a user on a host" do
+      # NOTE: would have expected a more granular approach to removing cron jobs
+      #       for a user on a host.  This should otherwise be better documented.
+
+      run_cron_on default, :add, default['user'], %Q{* * * * * /bin/echo "quality: job 1" >/dev/null}
+      result = run_cron_on default, :list, default['user']
+      assert_match %r{quality: job 1}, result.stdout
+
+      run_cron_on default, :remove, default['user']
+
+      assert_raises Beaker::Host::CommandFailure do
+        run_cron_on default, :list, default['user']
+      end
+    end
+
+    step "#run_cron_on fails when removing cron jobs for an unknown user" do
+      assert_raises Beaker::Host::CommandFailure do
+        run_cron_on default, :remove, "nonexistentuser"
+      end
+    end
+
+    step "#run_cron_on can list cron jobs for a user on all hosts when given a host array" do
+      hosts.each do |host|
+        # this basically requires us to add a cron entry to make this work
+        run_cron_on host, :add, host['user'], "* * * * * /bin/ls >/dev/null"
+      end
+
+      results = run_cron_on hosts, :list, default['user']
+      results.each do |result|
+        assert_match %r{/bin/ls}, result.stdout
+      end
+    end
+
+    step "#run_cron_on can add cron jobs for a user on all hosts when given a host array" do
+      run_cron_on hosts, :add, default['user'], "* * * * * /bin/ls >/dev/null"
+
+      results = run_cron_on hosts, :list, default['user']
+      results.each do |result|
+        assert_match %r{/bin/ls}, result.stdout
+      end
+    end
+
+    step "#run_cron_on can remove cron jobs for a user on all hosts when given a host array" do
+      run_cron_on hosts, :add, default['user'], "* * * * * /bin/ls >/dev/null"
+      run_cron_on hosts, :remove, default['user']
+
+      hosts.each do |host|
+        assert_raises Beaker::Host::CommandFailure do
+          results = run_cron_on host, :list, host['user']
+        end
+      end
+    end
+  end
+
+  confine_block :except, :platform => /windows|solaris/ do
+
+    step "#run_cron_on CURRENTLY does nothing and returns `nil` when an unknown command is provided" do
+      # NOTE: would have expected this to raise Beaker::Host::CommandFailure instead
+
+      assert_nil run_cron_on default, :nonexistent_action, default['user']
+    end
+
+    step "#run_cron_on fails when listing cron jobs for an unknown user" do
+      assert_raises Beaker::Host::CommandFailure do
+        run_cron_on default, :list, "nonexistentuser"
+      end
+    end
+
+    step "#run_cron_on fails when listing cron jobs for a user with no cron entries" do
+      assert_raises Beaker::Host::CommandFailure do
+        run_cron_on default, :list, default['user']
+      end
+    end
+
+    step "#run_cron_on returns a list of cron jobs for a user with cron entries" do
+      # this basically requires us to add a cron entry to make this work
+      run_cron_on default, :add, default['user'], "* * * * * /bin/ls >/dev/null"
+      result = run_cron_on default, :list, default['user']
+      assert_equal 0, result.exit_code
+      assert_match %r{/bin/ls}, result.stdout
+    end
+
+    step "#run_cron_on fails when adding cron jobs for an unknown user" do
+      assert_raises Beaker::Host::CommandFailure do
+        run_cron_on default, :add, "nonexistentuser", %Q{* * * * * /bin/echo "hello" >/dev/null}
+      end
+    end
+
+    step "#run_cron_on fails when attempting to add a bad cron entry" do
+      assert_raises Beaker::Host::CommandFailure do
+        run_cron_on default, :add, default['user'], "* * * * /bin/ls >/dev/null"
+      end
+    end
+
+    step "#run_cron_on can add a cron job for a user on a host" do
+      run_cron_on default, :add, default['user'], %Q{* * * * * /bin/echo "hello" >/dev/null}
+      result = run_cron_on default, :list, default['user']
+      assert_equal 0, result.exit_code
+      assert_match %r{/bin/echo}, result.stdout
+    end
+
+    step "#run_cron_on CURRENTLY replaces all of user's cron jobs with any newly added jobs" do
+      # NOTE: would have expected this to append new entries, or manage them as puppet manages
+      #       cron entries.  See also: https://github.com/puppetlabs/beaker/pull/937#discussion_r38338494
+
+      1.upto(3) do |job_number|
+        run_cron_on default, :add, default['user'], %Q{* * * * * /bin/echo "job :#{job_number}:" >/dev/null}
+      end
+
+      result = run_cron_on default, :list, default['user']
+
+      assert_no_match %r{job :1:}, result.stdout
+      assert_no_match %r{job :2:}, result.stdout
+      assert_match %r{job :3:}, result.stdout
+    end
+
+    step "#run_cron_on :remove CURRENTLY removes all cron jobs for a user on a host" do
+      # NOTE: would have expected a more granular approach to removing cron jobs
+      #       for a user on a host.  This should otherwise be better documented.
+
+      run_cron_on default, :add, default['user'], %Q{* * * * * /bin/echo "quality: job 1" >/dev/null}
+      result = run_cron_on default, :list, default['user']
+      assert_match %r{quality: job 1}, result.stdout
+
+      run_cron_on default, :remove, default['user']
+
+      assert_raises Beaker::Host::CommandFailure do
+        run_cron_on default, :list, default['user']
+      end
+    end
+
+    step "#run_cron_on fails when removing cron jobs for an unknown user" do
+      assert_raises Beaker::Host::CommandFailure do
+        run_cron_on default, :remove, "nonexistentuser"
+      end
+    end
+
+    step "#run_cron_on can list cron jobs for a user on all hosts when given a host array" do
+      hosts.each do |host|
+        # this basically requires us to add a cron entry to make this work
+        run_cron_on host, :add, host['user'], "* * * * * /bin/ls >/dev/null"
+      end
+
+      results = run_cron_on hosts, :list, default['user']
+      results.each do |result|
+        assert_match %r{/bin/ls}, result.stdout
+      end
+    end
+
+    step "#run_cron_on can add cron jobs for a user on all hosts when given a host array" do
+      run_cron_on hosts, :add, default['user'], "* * * * * /bin/ls >/dev/null"
+
+      results = run_cron_on hosts, :list, default['user']
+      results.each do |result|
+        assert_match %r{/bin/ls}, result.stdout
+      end
+    end
+
+    step "#run_cron_on can remove cron jobs for a user on all hosts when given a host array" do
+      run_cron_on hosts, :add, default['user'], "* * * * * /bin/ls >/dev/null"
+      run_cron_on hosts, :remove, default['user']
+
+      hosts.each do |host|
+        assert_raises Beaker::Host::CommandFailure do
+          results = run_cron_on host, :list, host['user']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #run_script_on" do
+
+  step "#run_script_on fails when the local script cannot be found" do
+    assert_raises IOError do
+      run_script_on default, "/non/existent/testfile.sh"
+    end
+  end
+
+  step "#run_script_on fails when there is an error running the remote script" do
+    Dir.mktmpdir do |local_dir|
+      local_filename = File.join(local_dir, "testfile.sh")
+      local_filename, contents = create_local_file_from_fixture("failing_shell_script", local_dir, "testfile.sh", "a+x")
+
+      assert_raises Beaker::Host::CommandFailure do
+        run_script_on default, local_filename
+      end
+    end
+  end
+
+  step "#run_script_on passes along options when running the remote command" do
+    Dir.mktmpdir do |local_dir|
+      local_filename = File.join(local_dir, "testfile.sh")
+      local_filename, contents = create_local_file_from_fixture("failing_shell_script", local_dir, "testfile.sh", "a+x")
+
+      result = run_script_on default, local_filename, { :accept_all_exit_codes => true }
+      assert_equal 1, result.exit_code
+    end
+  end
+
+  step "#run_script_on runs the script on the remote host" do
+    Dir.mktmpdir do |local_dir|
+      local_filename = File.join(local_dir, "testfile.sh")
+      local_filename, contents = create_local_file_from_fixture("shell_script_with_output", local_dir, "testfile.sh", "a+x")
+
+      results = run_script_on default, local_filename
+      assert_equal 0, results.exit_code
+      assert_equal "output\n", results.stdout
+    end
+  end
+
+  step "#run_script_on allows assertions in an optional block" do
+    Dir.mktmpdir do |local_dir|
+      local_filename = File.join(local_dir, "testfile.sh")
+      local_filename, contents = create_local_file_from_fixture("shell_script_with_output", local_dir, "testfile.sh", "a+x")
+
+      results = run_script_on default, local_filename do
+        assert_equal 0, exit_code
+        assert_equal "output\n", stdout
+      end
+    end
+  end
+
+  step "#run_script_on runs the script on all remote hosts when a host array is provided" do
+    Dir.mktmpdir do |local_dir|
+      local_filename = File.join(local_dir, "testfile.sh")
+      local_filename, contents = create_local_file_from_fixture("shell_script_with_output", local_dir, "testfile.sh", "a+x")
+
+      results = run_script_on hosts, local_filename
+
+      assert_equal hosts.size, results.size
+      results.each do |result|
+        assert_equal 0, result.exit_code
+        assert_equal "output\n", result.stdout
+      end
+    end
+  end
+end