beaker 2.27.0 → 2.28.0

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

@@ -0,0 +1,68 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #create_tmpdir_on" do
+
+  # NOTE: there does not seem to be a reliable way to confine to cygwin hosts.
+  confine_block :to, :platform => /windows/ do
+
+    step "#create_tmpdir_on CURRENTLY fails when attempting to chown the created tempdir to the host user + group, on windows platforms" do
+      # NOTE: would have expected this to work.
+      # TODO: fix via https://tickets.puppetlabs.com/browse/BKR-496
+
+      assert_raises Beaker::Host::CommandFailure do
+        tmpdir = create_tmpdir_on default
+      end
+    end
+  end
+
+  confine_block :to, :platform => /osx/ do
+
+    step "#create_tmpdir_on CURRENTLY fails when attempting to call getent to check the creating user" do
+      # NOTE: would have expected this to work.
+      # TODO: fix via https://tickets.puppetlabs.com/browse/BKR-496
+
+      assert_raises Beaker::Host::CommandFailure do
+        tmpdir = create_tmpdir_on default
+      end
+    end
+  end
+
+  confine_block :except, :platform => /windows|osx/ do
+
+    step "#create_tmpdir_on chowns the created tempdir to the host user + group" do
+      tmpdir = create_tmpdir_on default
+      listing = on(default, "ls -al #{tmpdir}").stdout
+      tmpdir_ls = listing.split("\n").grep %r{\s+\./?\s*$}
+      assert_equal 1, tmpdir_ls.size
+      perms, inodes, owner, group, *rest = tmpdir_ls.first.split(/\s+/)
+      assert_equal default['user'], owner
+      assert_equal default['user'], group
+    end
+
+    step "#create_tmpdir_on returns a temporary directory on the remote system" do
+      tmpdir = create_tmpdir_on default
+      assert_match %r{/}, tmpdir
+      assert_equal 0, on(default, "touch #{tmpdir}/testfile").exit_code
+    end
+
+    step "#create_tmpdir_on uses the specified path prefix when provided" do
+      tmpdir = create_tmpdir_on(default, "mypathprefix")
+      assert_match %r{/mypathprefix}, tmpdir
+      assert_equal 0, on(default, "touch #{tmpdir}/testfile").exit_code
+    end
+
+    step "#create_tmpdir_on fails if a non-existent user is specified" do
+      assert_raises Beaker::Host::CommandFailure do
+        tmpdir = create_tmpdir_on default, '', "fakeuser"
+      end
+    end
+
+    step "#create_tmpdir_on operates on all hosts if given a hosts array" do
+      tmpdirs = create_tmpdir_on hosts
+      hosts.zip(tmpdirs).each do |(host, tmpdir)|
+        assert_match %r{/}, tmpdir
+        assert_equal 0, on(host, "touch #{tmpdir}/testfile").exit_code
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require "helpers/test_helper"
+
+# construct an appropriate local file URL for curl testing
+def host_local_url(host, path)
+  if host.is_cygwin?
+    "file://#{path.gsub('/', '\\\\\\\\')}"
+  else
+    "file://#{path}"
+  end
+end
+
+test_name "dsl::helpers::host_helpers #curl_on" do
+  step "#curl_on fails if the URL in question cannot be reached" do
+    assert Beaker::Host::CommandFailure do
+      curl_on default, "file:///non/existent.html"
+    end
+  end
+
+  step "#curl_on can retrieve the contents of a URL, using standard curl options" do
+    remote_tmpdir = tmpdir_on default
+    remote_filename, contents = create_remote_file_from_fixture("simple_text_file", default, remote_tmpdir, "testfile.txt")
+    remote_targetfilename = File.join remote_tmpdir, "outfile.txt"
+
+    result = curl_on default, "-o #{remote_targetfilename} #{host_local_url default, remote_filename}"
+
+    assert_equal 0, result.exit_code
+    remote_contents = on(default, "cat #{remote_targetfilename}").stdout
+    assert_equal contents, remote_contents
+  end
+
+  step "#curl_on can retrieve the contents of a URL, when given a hosts array" do
+    remote_tmpdir = tmpdir_on default
+    on hosts, "mkdir -p #{remote_tmpdir}"
+
+    remote_filename = contents = nil
+    hosts.each do |host|
+      remote_filename, contents = create_remote_file_from_fixture("simple_text_file", host, remote_tmpdir, "testfile.txt")
+    end
+    remote_targetfilename = File.join remote_tmpdir, "outfile.txt"
+
+    result = curl_on hosts, "-o #{remote_targetfilename} #{host_local_url default, remote_filename}"
+
+    hosts.each do |host|
+      remote_contents = on(host, "cat #{remote_targetfilename}").stdout
+      assert_equal contents, remote_contents
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #curl_with_retries" do
+
+  step "#curl_with_retries CURRENTLY fails with a RuntimeError if retries are exhausted without fetching the specified URL" do
+    # NOTE: would expect that this would raise Beaker::Host::CommandFailure
+
+    assert_raises RuntimeError do
+      curl_with_retries \
+        "description",
+        default,
+        "file:///non/existent.html",
+        desired_exit_codes = [0],
+        max_retries = 2,
+        retry_interval = 0.01
+    end
+  end
+
+  step "#curl_with_retries retrieves the contents of a URL after retrying" do
+    # TODO: testing curl_with_retries relies on having a portable means of
+    # making an unavailable URL available after a period of time.
+  end
+
+  step "#curl_with_retries can retrieve the contents of a URL after retrying, when given a hosts array" do
+    # TODO: testing curl_with_retries relies on having a portable means of
+    # making an unavailable URL available after a period of time.
+  end
+end

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

@@ -0,0 +1,142 @@
+require "helpers/test_helper"
+require "fileutils"
+
+test_name "dsl::helpers::host_helpers #deploy_package_repo" do
+
+  confine_block :to, :platform => /^el-4/ do
+
+    step "#deploy_package_repo CURRENTLY does nothing and throws no error on the #{default['platform']} platform" do
+      # NOTE: would expect this to fail with Beaker::Host::CommandFailure
+
+      Dir.mktmpdir do |local_dir|
+        name = "puppet-server"
+        version = "9.9.9"
+        platform = default['platform']
+
+        local_filename, contents = create_local_file_from_fixture("simple_text_file", local_dir, "pl-#{name}-#{version}-repos-pe-#{platform}.repo")
+
+        assert_nil deploy_package_repo(default, local_dir, name, version)
+      end
+    end
+  end
+
+  confine_block :to, :platform => /fedora|centos|eos|el-[56789]/i do
+
+    step "#deploy_package_repo pushes repo package to /etc/yum.repos.d on the remote host" do
+      Dir.mktmpdir do |local_dir|
+        name = "puppet-server"
+        version = "9.9.9"
+        platform = default['platform']
+
+        FileUtils.mkdir(File.join(local_dir, "rpm"))
+        local_filename, contents = create_local_file_from_fixture("simple_text_file", File.join(local_dir, "rpm"), "pl-#{name}-#{version}-repos-pe-#{platform}.repo")
+
+        deploy_package_repo default, local_dir, name, version
+
+        remote_contents = on(default, "cat /etc/yum.repos.d/#{name}.repo").stdout
+        assert_equal contents, remote_contents
+
+        # teardown
+        on default, "rm /etc/yum.repos.d/#{name}.repo"
+      end
+    end
+
+    step "#deploy_package_repo CURRENTLY fails with NoMethodError when passed a hosts array" do
+      # NOTE: would expect this to handle host arrays, or raise Beaker::Host::CommandFailure
+
+      Dir.mktmpdir do |local_dir|
+        name = "puppet-server"
+        version = "9.9.9"
+        platform = default['platform']
+
+        local_filename, contents = create_local_file_from_fixture("simple_text_file", local_dir, "pl-#{name}-#{version}-repos-pe-#{platform}.repo")
+
+        assert_raises NoMethodError do
+          deploy_package_repo hosts, local_dir, name, version
+        end
+      end
+    end
+  end
+
+  confine_block :to, :platform => /ubuntu|debian|cumulus/i do
+
+    step "#deploy_package_repo pushes repo package to /etc/apt/sources.list.d on the remote host" do
+      Dir.mktmpdir do |local_dir|
+        name = "puppet-server"
+        version = "9.9.9"
+        codename = default['platform'].codename
+
+        FileUtils.mkdir(File.join(local_dir, "deb"))
+        local_filename, contents = create_local_file_from_fixture("simple_text_file", File.join(local_dir, "deb"), "pl-#{name}-#{version}-#{codename}.list")
+
+        deploy_package_repo default, local_dir, name, version
+
+        remote_contents = on(default, "cat /etc/apt/sources.list.d/#{name}.list").stdout
+        assert_equal contents, remote_contents
+
+        # teardown
+        on default, "rm /etc/apt/sources.list.d/#{name}.list"
+      end
+    end
+
+    step "#deploy_package_repo CURRENTLY fails with NoMethodError when passed a hosts array" do
+      # NOTE: would expect this to handle host arrays, or raise Beaker::Host::CommandFailure
+
+      Dir.mktmpdir do |local_dir|
+        name = "puppet-server"
+        version = "9.9.9"
+        codename = default['platform'].codename
+
+        FileUtils.mkdir(File.join(local_dir, "deb"))
+        local_filename, contents = create_local_file_from_fixture("simple_text_file", File.join(local_dir, "deb"), "pl-#{name}-#{version}-#{codename}.list")
+
+        assert_raises NoMethodError do
+          deploy_package_repo hosts, local_dir, name, version
+        end
+      end
+    end
+  end
+
+  confine_block :to, :platform => /sles/i do
+
+    step "#deploy_package_repo updates zypper repository list on the remote host" do
+      Dir.mktmpdir do |local_dir|
+        name = "puppet-server"
+        version = "9.9.9"
+        platform = default['platform']
+
+        FileUtils.mkdir(File.join(local_dir, "rpm"))
+        local_filename, contents = create_local_file_from_fixture("sles-11-x86_64.repo", File.join(local_dir, "rpm"), "pl-#{name}-#{version}-repos-pe-#{platform}.repo")
+
+        deploy_package_repo default, local_dir, name, version
+
+        result = on default, "zypper repos -d"
+        assert_match "PE-3.8-sles-11-x86_64", result.stdout
+
+        # teardown
+        on default, "zypper rr PE-3.8-sles-11-x86_64"
+      end
+    end
+  end
+
+  confine_block :except, :platform => /el-\d|fedora|centos|eos|ubuntu|debian|cumulus|sles/i do
+
+    # OS X, windows (cygwin, powershell), solaris, etc.
+
+    step "#deploy_package_repo CURRENTLY fails with a RuntimeError on on the #{default['platform']} platform" do
+      # NOTE: would expect this to raise Beaker::Host::CommandFailure instead of RuntimeError
+
+      Dir.mktmpdir do |local_dir|
+        name = "puppet-server"
+        version = "9.9.9"
+        platform = default['platform']
+
+        local_filename, contents = create_local_file_from_fixture("simple_text_file", local_dir, "pl-#{name}-#{version}-repos-pe-#{platform}.repo")
+
+        assert_raises RuntimeError do
+          deploy_package_repo default, local_dir, name, version
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #echo_on" do
+  step "#echo_on echoes the supplied string on the remote host" do
+    output = echo_on(default, "contents")
+    assert_equal output, "contents"
+  end
+
+  step "#echo_on echoes the supplied string on all hosts when given a hosts array" do
+    results = echo_on(hosts, "contents")
+    assert_equal ["contents"] * hosts.size, results
+  end
+end

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

@@ -0,0 +1,67 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #install_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: install_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 "#install_package CURRENTLY fails on windows platforms" do
+      assert_raises ArgumentError do
+        install_package default, "rsync"
+      end
+    end
+  end
+
+  confine_block :to, :platform => /solaris/ do
+
+    step "#install_package CURRENTLY fails on solaris platforms" do
+      assert_raises Beaker::Host::CommandFailure do
+        install_package default, "rsync"
+      end
+    end
+  end
+
+  confine_block :to, :platform => /osx/ do
+    # TODO: install_package on OSX installs via a .dmg file -- how to test this?
+  end
+
+  confine_block :except, :platform => /windows|solaris|osx/ do
+
+    step "#install_package fails if package is not known on the OS" do
+      assert_raises Beaker::Host::CommandFailure do
+        install_package default, "non-existent-package-name"
+      end
+    end
+
+    step "#install_package installs a known package successfully" do
+      result = install_package default, "rsync"
+      assert check_for_package(default, "rsync"), "package was not successfully installed"
+    end
+
+    step "#install_package succeeds when installing an already-installed package" do
+      result = install_package default, "rsync"
+      result = install_package default, "rsync"
+      assert check_for_package(default, "rsync"), "package was not successfully installed"
+    end
+
+    step "#install_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
+        install_package hosts, "rsync"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+require "helpers/test_helper"
+
+test_name "dsl::helpers::host_helpers #on" do
+
+  step "#on raises an exception when remote command fails" do
+    assert_raises(Beaker::Host::CommandFailure) do
+      on default, "/bin/nonexistent-command"
+    end
+  end
+
+  step "#on makes command output available via `.stdout` on success" do
+    output = on(default, %Q{echo "echo via on"}).stdout
+    assert_equal "echo via on\n", output
+  end
+
+  step "#on makes command error output available via `.stderr` on success" do
+    output = on(default, "/bin/nonexistent-command", :acceptable_exit_codes => [0, 127]).stderr
+    assert_match /No such file/, output
+  end
+
+  step "#on makes exit status available via `.exit_code`" do
+    status = on(default, %Q{echo "echo via on"}).exit_code
+    assert_equal 0, status
+  end
+
+  step "#on with :acceptable_exit_codes will not fail for named exit codes" do
+    result = on default, "/bin/nonexistent-command", :acceptable_exit_codes => [0, 127]
+    output = result.stderr
+    assert_match /No such file/, output
+    status = result.exit_code
+    assert_equal 127, status
+  end
+
+  step "#on with :acceptable_exit_codes will fail for other exit codes" do
+    assert_raises(Beaker::Host::CommandFailure) do
+      on default, %Q{echo "echo via on"}, :acceptable_exit_codes => [127]
+    end
+  end
+
+  step "#on will pass :environment options to the remote host as ENV settings" do
+    result = on default, "env", { :environment => { 'FOO' => 'bar' } }
+    output = result.stdout
+
+    assert_match /\bFOO=bar\b/, output
+  end
+
+  step "#on runs command on all hosts when given a host array" do
+    # Run a command which is (basically) guaranteed to have distinct output
+    # on every host, and only requires bash to be present to run on any of
+    # our platforms.
+    results = on hosts, %Q{echo "${RANDOM}:${RANDOM}:${RANDOM}"}
+
+    # assert that we got results back for every host
+    assert_equal hosts.size, results.size
+
+    # that they were all successful runs
+    results.each do |result|
+      assert_equal 0, result.exit_code
+    end
+
+    # and that we have |hosts| distinct outputs
+    unique_outputs = results.map(&:output).uniq
+    assert_equal hosts.size, unique_outputs.size
+  end
+
+  step "#on runs command on all hosts matching a role, when given a symbol" do
+    # Run a command which is (basically) guaranteed to have distinct output
+    # on every host, and only requires bash to be present to run on any of
+    # our platforms.
+    results = on :agent, %Q{echo "${RANDOM}:${RANDOM}:${RANDOM}"}
+
+    # assert that we got results back for every host
+    assert_equal hosts.size, results.size
+
+    # that they were all successful runs
+    results.each do |result|
+      assert_equal 0, result.exit_code
+    end
+
+    # and that we have |hosts| distinct outputs
+    unique_outputs = results.map(&:output).uniq
+    assert_equal hosts.size, unique_outputs.size
+  end
+
+  step "#on runs command on all hosts matching a role, when given a string" do
+    # Run a command which is (basically) guaranteed to have distinct output
+    # on every host, and only requires bash to be present to run on any of
+    # our platforms.
+    results = on "agent", %Q{echo "${RANDOM}:${RANDOM}:${RANDOM}"}
+
+    # assert that we got results back for every host
+    assert_equal hosts.size, results.size
+
+    # that they were all successful runs
+    results.each do |result|
+      assert_equal 0, result.exit_code
+    end
+
+    # and that we have |hosts| distinct outputs
+    unique_outputs = results.map(&:output).uniq
+    assert_equal hosts.size, unique_outputs.size
+  end
+
+  step "#on allows assertions to be used in the optional block" do
+    on hosts, %Q{echo "${RANDOM}:${RANDOM}"} do
+      assert_match /\d+:\d+/, stdout
+    end
+  end
+end