beaker 3.37.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65affe7f42763474ab6859ece3eecd8804e8e313
-  data.tar.gz: 72fcac34ef28fc6c15dffa7d71e42a83a65d0676
+  metadata.gz: 7d46e3ea54f2a217a78497681c57a24921de8719
+  data.tar.gz: 175ef59e2be00d70d0238f49e8f3d49e95257e2f
 SHA512:
-  metadata.gz: 2f160ec4f6589e6cf8e5e5eb737ebb896be7123317141ea34d406332c45734916aadd15a7eaa81a4ce7ffa5ffc206c653b0a9fa20421b0dd466b42bfba7b7faa
-  data.tar.gz: 83a4209a5c18acec0c56ef9d951311972115dc08bffe1da60aac97725b4385517ae94d280d34cbd75d9005179edc590cc62dd8ef6c510047b3c4bbcdeece4395
+  metadata.gz: abc5a220b83dd595577f90140ce3b60b1daf282d77e27279f110732cc643e20d46652046be5bec9beb55aa51dec38b82928c15814a34ce78efa8460335654295
+  data.tar.gz: ce529642242f5408f0ea4a8bc515f00f496c977854737f21f4787a04769ef02d003d1694bd818b9ae2478af5382329e4f0019f433a09bb2983b2fb4f0acfdbe8

data/CHANGELOG.md

@@ -11,7 +11,33 @@ Tracking in this Changelog began for this project in version 3.25.0.
 If you're looking for changes from before this, refer to the project's
 git logs & PR history.
 
-# [Unreleased](https://github.com/puppetlabs/beaker/compare/3.37.0...master)
+# [Unreleased](https://github.com/puppetlabs/beaker/compare/4.0.0...master)
+
+# [4.0.0](https://github.com/puppetlabs/beaker/compare/3.37.0...4.0.0) - 2018-08-06
+
+### Fixed
+
+- `host.rsync_to` throws `Beaker::Host::CommandFailure` if rsync call fails (BKR-463)
+- `host.rsync_to` throws `Beaker::Host::CommandFailure` if rsync does not exist on remote system (BKR-462)
+- `host.rsync_to` now check through configured SSH keys to use the first valid one
+- Updated some `Beaker::Host` methods to always return a `Result` object
+
+### Added
+
+- Adds `Beaker::Host#chown`, `#chgrp`, and `#ls_ld` methods (BKR-1499)
+- `#uninstall_package` host helper, to match `#install_package`
+- `Host.uninstall_package` for FreeBSD
+- Now easily check a command's exit status by calling `Result.success?()` for a simple, truthy result. No need to validate the exit code manually.
+
+### Changed
+
+- `#set_env` no longer calls `#configure_type_defaults_on`
+- `beaker-puppet` DSL Extension Library has been formally split into a standard DSL Extension Library and removed as a dependency from Beaker. Please see our [upgrade guidelines](docs/how_to/upgrade_from_3_to_4.md).
+- Beaker's Hypervisor Libraries have been removed as dependencies. Please see our [upgrade guidelines](docs/how_to/upgrade_from_3_to_4.md).
+
+### Removed
+
+- `PEDefaults` has been moved to `beaker-pe`
 
 # [3.37.0](https://github.com/puppetlabs/beaker/compare/3.36.0...3.37.0) - 2018-07-11
 
@@ -23,6 +49,11 @@ git logs & PR history.
 
 - `Beaker::Shared::FogCredentials.get_fog_credentials()` to parse .fog credential files
 
+### Changed
+
+- `beaker-pe` is no longer automagically included. See [the upgrade guide](/docs/how_to/upgrade_from_3_to_4.md}) for more info
+- `beaker-puppet` is no longer required as a dependency
+
 # [3.36.0](https://github.com/puppetlabs/beaker/compare/3.35.0...3.36.0) - 2018-06-18
 
 ### Fixed

data/acceptance/lib/helpers/test_helper.rb

@@ -8,34 +8,6 @@ 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 ||=

data/acceptance/pre_suite/subcommands/08_install_beaker.rb

@@ -17,6 +17,6 @@ test_name 'Install beaker and checkout branch if necessary' do
   step 'Build the gem and install it on the local system' do
     build_output = on(default, 'cd /opt/beaker/;gem build beaker.gemspec').stdout
     version = build_output.match(/^  File: (.+)$/)[1]
-    on(default, "cd /opt/beaker/;gem install #{version} --no-rdoc --no-ri")
+    on(default, "cd /opt/beaker/;gem install #{version} --no-rdoc --no-ri; gem install beaker-vmpooler")
   end
 end

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

@@ -3,14 +3,14 @@ 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
+    remote_source = default.tmpdir()
+    remote_destination = default.tmpdir()
     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 = default.tmpdir()
     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")
 
@@ -20,11 +20,11 @@ test_name "dsl::helpers::host_helpers #backup_the_file" do
   end
 
   step "#backup_the_file copies `puppet.conf` from the source to the destination directory" do
-    remote_source = tmpdir_on default
+    remote_source = default.tmpdir()
     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 = default.tmpdir()
     remote_destination_filename = File.join(remote_destination, "puppet.conf.bak")
 
     result = backup_the_file default, remote_source, remote_destination
@@ -35,11 +35,11 @@ test_name "dsl::helpers::host_helpers #backup_the_file" do
   end
 
   step "#backup_the_file copies a named file from the source to the destination directory" do
-    remote_source = tmpdir_on default
+    remote_source = default.tmpdir()
     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 = default.tmpdir()
     remote_destination_filename = File.join(remote_destination, "testfile.txt.bak")
 
     result = backup_the_file default, remote_source, remote_destination, "testfile.txt"
@@ -50,10 +50,10 @@ test_name "dsl::helpers::host_helpers #backup_the_file" do
   end
 
   step "#backup_the_file CURRENTLY will fail if given a hosts array" do
-    remote_source = tmpdir_on default
+    remote_source = default.tmpdir()
     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 = default.tmpdir()
 
     remote_destination_filename = File.join(remote_destination, "testfile.txt.bak")
 

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

@@ -2,14 +2,6 @@ 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
@@ -24,18 +16,8 @@ test_name "dsl::helpers::host_helpers #create_remote_file" do
     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_tmpdir = default.tmpdir("beaker")
     remote_filename = File.join(remote_tmpdir, "testfile.txt")
     contents = fixture_contents("simple_text_file")
 
@@ -46,7 +28,7 @@ test_name "dsl::helpers::host_helpers #create_remote_file" do
   end
 
   step "#create_remote_file creates a remote file with the specified contents, using scp" do
-    remote_tmpdir = tmpdir_on default
+    remote_tmpdir = default.tmpdir("beaker")
     remote_filename = File.join(remote_tmpdir, "testfile.txt")
     contents = fixture_contents("simple_text_file")
 
@@ -56,62 +38,15 @@ test_name "dsl::helpers::host_helpers #create_remote_file" do
     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/ do
-
-    # NOTE: rsync methods are not working currently on windows 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/ 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
+  step "#create_remote_file creates remote files on all remote hosts, when given an array" do
+    remote_dir = "/tmp/beaker_remote_file_test"
+    # ensure remote dir exists on all hosts
+    hosts.each do |host|
+      # we can't use tmpdir here, because some hosts may have different tmpdir behavior.
+      host.mkdir_p(remote_dir)
     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")
+    remote_filename = File.join(remote_dir, "testfile.txt")
     contents = fixture_contents("simple_text_file")
 
     create_remote_file hosts, remote_filename, contents
@@ -123,9 +58,14 @@ test_name "dsl::helpers::host_helpers #create_remote_file" do
   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")
+    remote_dir = "/tmp/beaker_remote_file_test"
+    # ensure remote dir exists on all hosts
+    hosts.each do |host|
+      # we can't use tmpdir here, because some hosts may have different tmpdir behavior.
+      host.mkdir_p(remote_dir)
+    end
+
+    remote_filename = File.join(remote_dir, "testfile.txt")
     contents = fixture_contents("simple_text_file")
 
     create_remote_file hosts, remote_filename, contents, { :protocol => 'scp' }
@@ -136,35 +76,63 @@ test_name "dsl::helpers::host_helpers #create_remote_file" do
     end
   end
 
-  # NOTE: there does not appear to be a way to confine just 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.
+  confine_block :except, :platform => /windows/ do
+    # these tests exercise the rsync backend
+    # NOTE: rsync works fine on Windows as long as you use POSIX-style paths.
+    # However, these tests use Host#tmpdir which outputs mixed-style paths
+    # e.g. C:/cygwin64/tmp/beaker.Rp9G6L - Fix me with BKR-1503
+
+    confine_block :except, :platform => /osx/ do
+      # packages are unsupported on OSX
+      step "installing rsync on hosts if needed" do
+        hosts.each do |host|
+          if host.check_for_package('rsync')
+            host[:rsync_installed] = true
+          else
+            host[:rsync_installed] = false
+            host.install_package "rsync"
+          end
+        end
+      end
+    end
 
-    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}"
+    step "#create_remote_file fails and does not create a remote file when the remote path does not exist, using rsync" do
+      assert_raises Beaker::Host::CommandFailure do
+        create_remote_file default, "/non/existent/testfile.txt", "contents\n", { :protocol => 'rsync' }
+      end
+
+      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, using rsync" do
+      remote_tmpdir = default.tmpdir("beaker")
       remote_filename = File.join(remote_tmpdir, "testfile.txt")
       contents = fixture_contents("simple_text_file")
 
-      create_remote_file hosts, remote_filename, contents, { :protocol => 'rsync' }
+      result = create_remote_file default, remote_filename, contents, { :protocol => "rsync" }
 
-      hosts.each do |host|
-        assert_raises Beaker::Host::CommandFailure do
-          remote_contents = on(host, "cat #{remote_filename}").stdout
-        end
+      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
-
-  confine_block :except, :platform => /windows|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_tmpdir = "/tmp/beaker_remote_file_test"
+      # ensure remote dir exists on all hosts
+      hosts.each do |host|
+        # we can't use tmpdir here, because some hosts may have different tmpdir behavior.
+        host.mkdir_p(remote_tmpdir)
+      end
 
       remote_filename = File.join(remote_tmpdir, "testfile.txt")
       contents = fixture_contents("simple_text_file")
@@ -184,17 +152,52 @@ test_name "dsl::helpers::host_helpers #create_remote_file" do
         end
       end
     end
+
+    confine_block :except, :platform => /osx/ do
+      # packages are unsupported on OSX
+      step "uninstalling rsync on hosts if needed" do
+        hosts.each do |host|
+          if !host[:rsync_installed]
+            # rsync wasn't installed on #{host} when we started, so we should clean up after ourselves
+            rsync_package = "rsync"
+            # solaris-10 uses OpenCSW pkgutil, which prepends "CSW" to its provided packages
+            # TODO: fix this with BKR-1502
+            rsync_package = "CSWrsync" if host['platform'] =~ /solaris-10/
+            host.uninstall_package rsync_package
+          end
+          host.delete(:rsync_installed)
+        end
+      end
+    end
   end
 
-  confine_block :to, :platform => /centos|el-\d|fedora/ do
+  step "#create_remote_file' does not create a remote file when an unknown protocol is specified" do
+    remote_tmpdir = default.tmpdir("beaker")
+    remote_filename = File.join(remote_tmpdir, "testfile.txt")
+    contents = fixture_contents("simple_text_file")
 
-    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?
+    create_remote_file default, remote_filename, contents, { :protocol => 'unknown' }
 
-      hosts.each do |host|
-        on host, "yum -y remove rsync"
+    assert_raises Beaker::Host::CommandFailure do
+      on(default, "cat #{remote_filename}").exit_code
+    end
+  end
+
+  # NOTE: there does not appear to be a way to confine just to cygwin hosts
+  confine_block :to, :platform => /windows/ do
+    # NOTE: rsync works fine on Windows as long as you use POSIX-style paths.
+    # Fix me with BKR-1503
+    step "#create_remote_file CURRENTLY fails on #{default['platform']}, using rsync" do
+      remote_tmpdir = default.tmpdir("beaker")
+      remote_filename = File.join(remote_tmpdir, "testfile.txt")
+      contents = fixture_contents("simple_text_file")
+
+      assert_raises Beaker::Host::CommandFailure do
+        create_remote_file default, remote_filename, contents, { :protocol => "rsync" }
+      end
+
+      assert_raises Beaker::Host::CommandFailure do
+        remote_contents = on(default, "cat #{remote_filename}").stdout
       end
     end
   end

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

@@ -17,7 +17,7 @@ test_name "dsl::helpers::host_helpers #curl_on" do
   end
 
   step "#curl_on can retrieve the contents of a URL, using standard curl options" do
-    remote_tmpdir = tmpdir_on default
+    remote_tmpdir = default.tmpdir()
     remote_filename, contents = create_remote_file_from_fixture("simple_text_file", default, remote_tmpdir, "testfile.txt")
     remote_targetfilename = File.join remote_tmpdir, "outfile.txt"
 
@@ -29,7 +29,7 @@ test_name "dsl::helpers::host_helpers #curl_on" do
   end
 
   step "#curl_on can retrieve the contents of a URL, when given a hosts array" do
-    remote_tmpdir = tmpdir_on default
+    remote_tmpdir = default.tmpdir()
     on hosts, "mkdir -p #{remote_tmpdir}"
 
     remote_filename = contents = nil