(MAINT) add changelog for 4.1.0 release

[skip ci]

(PUP-9212) Allow for alpine platform

(PUP-9136) Preserve host hash from beaker exec run

(BKR-1432) Test if puppet module is directly in source host root

The alpine platform is common for docker containers; allowing for it
gives beaker-docker the context necessary to sideload ssh onto the
container.

(MAINT) handle commandfailures in rsync tests

In my previous work on this:
  https://github.com/puppetlabs/beaker/pull/1546
I took care of the cases where the method returned successfully
but the issue we are seeing in CI is where exceptions are
being thrown by the Host#do_rsync_to method. These changes take
the exceptions into account, allowing them to be other cases that
end similarly to the first, where we just continue backoff
execution

Prior to this change, we were losing state that had been set up when
running our pre-suite. Unfortunately, this oversight wasn't felt because
beaker was loading these defaults automatically for every beaker
invocation. In beaker 4, that functionality was removed, and we found
that state between beaker subcommand invocations was unfortunately not
preserved. This commit adds in an optional flag `--preserve-state` that
users can pass into a `beaker exec` invocation. This will update the
beaker options file to amend the host has to include any new or updated
information. This is particularly relevant for paths like
privatebindir` that are referenced in tests.

(MAINT) fix changelog entry

The changelog entry from this PR is old:
  https://github.com/puppetlabs/beaker/pull/1496
This change pulls the changelog entry from back
then into the now

[skip ci]

* (MAINT) Update RHEL support for GCE

Updated RHEL tests and support as discovered when testing the GCE
patches in beaker-google.

* re-add accidentally removed code

(MAINT) add rsync backoff for testing

Before, we would have a number of tests fail where
it was caused by some connection error that if we
had run it again, it probably would not be a problem.
This change allows these calls to be made with backoffs
so that the tests will be a little slower occasionally,
but much more resilient to network issues

Revert "(PUP-8305) Enable git-based acceptance testing"

This reverts commit 731661b5.

(BKR-1505) update beaker DSL listing doc

[skip ci]

(maint) fix-readme-typo

Correct beaker-* github URLs

* (BKR-1509) Upgrade guidance for Rsync methods

* (BKR-1509) CHNAGELOG entry for `Result.success?`

* (MAINT) Beaker 4.0.0 CHANGELOG

* (BKR-1509) Don't trap hypervisor LoadError

Don't catch LoadError for hypervisors just to re-throw without context. This should improve user experience and debugging for 4.0 hypervisor inclusion mechanisms.

* (BKR-1509) Add hypervisors to 3-4 Upgrade Doc

* (BKR-1509) Update documentation for DSL method locations

Update documentation to reference DSL methods that have been moved to a product-specific DSL extension library.

* (BKR-1509) Fixup hypervisor_spec.rb

Change to spec test for custom hypervisor load error to be more descriptive.

* (BKR-1509) Fix subcommands acceptance test

Subcommands that install Beaker on a SUT using `gem` need to also install an appropriate hypervisor, in this case beaker-vmpooler.

* (BKR-1509) CHANGELOG entry for beaker-puppet and hypervisors removal

* (BKR-1500) Stub upgrade_from_3_to_4.md

* (BKR-1500) Remove beaker-pe require shim

Removes a convenience shim for automagically including `beaker-pe` when available, and documents this change in the upgrade guide.

* (BKR-1500 Move Leftover EZBake stuff to beaker-puppet

* (BKR-1500) Move Windows install_utils to beaker-puppet

* (BKR-1500) Move facter_helpers and puppet/facter wrappers to beaker-puppet

* (BKR-1500) Move leftover heria wrapper method to beaker-heira

* (BKR-1500) Move clone_git_repo_on_test.rb to beaker-puppet

This test covers FOSS install helpers, so must move to beaker-puppet.

* (BKR-1500) Move retroactive module include to DSL#register

No reason this needs to be in the extension libraries and can't be done here.

* (BKR-1500) Remove beaker-puppet dependency

- Remove requires from helpers and install_utils

- Changelog entry

- Upgrade documentation

- Remove gemspec dependency

* (BKR-1500) Remove beaker-hiera

beaker-hiera is deprecated.

* (BKR-1500) Remove install_packages_on from acceptance utils

* (BKR-1500) Remove hypervisor dependencies

Removes as many hypervisor dependencies as possible - those remaining are changed to development dependencies and are kept to ensure CI acceptance jobs continue functioning.

* (BKR-1492) Move pe_defaults to beaker-pe

* (BKR-1492) Remove #configure_type_defaults_on call from #set_env

* (BKR-1492) Add docs and CHANGELOG.md entry

[skip ci]

* (BKR-462) rsync_to fails if rsync is not installed on the remote host

Also adds solaris to the list of hosts on which rsync is not installed by default.

* (BKR-462) Adds #uninstall_package host helper

The #install_package test uses rsync as an example package, but doesn't clean up after itself on hosts that don't have rsync installed by default. This lack of cleanup was contaminating later tests for rsync that expected rsync. This change adds an uninstall_package host helper to match the install_package helper, and calls this helper to clean up after install_package tests. It also is applied to other tests to replace command-line package removal, which didn't work for solaris hosts.

* (BKR-462) Check existence of SSH key files

Host#do_rsync_to unsafely assumed that the first entry in the options hash SSH keys was valid. This change makes it check through the array of configured keys until it finds one that actually exists in the filesystem.

Note: the spec tests somehow mess this up and the lambda returns an Array. It works just fine in acceptance and I cannot reproduce the issue in a standalone test case. Weird.

* (BKR-462) CHANGELOG.md

* (BKR-462) Use safe logic to identify existing SSH keys

Also fixup spec tests so they don't include the same code copy-paste as the method under tests.

* (BKR-462) Fix remaining spec tests

D'oh.

* (BKR-462) *ahem*

* (BKR-462) Remove redundant acceptance test for #install_package host helper

This acceptance test is redundant, since #install_package is just an alias for Host#install_package. The acceptance test as written was causing downstream test issues by installing rsync and not cleaning up after itself. Spec tests are added to cover this behavior.

* (BKR-462) Clean up rsync_to_test.rb

Previously, rsync_to_test.rb assumed certain hosts did or did not have rsync installed by default. However, due to sloppy tests for Host Helpers#install_package (now removed), rsync was being installed on some of those hosts which were believed not to have it. Now, functionality is exercised on all hosts by ensuring rsync is uninstalled or installed as appropriate, and properly cleaned up afterward.

* (BKR-462) Workaround for uninstall_package on Solaris 10

See BKR-1502 to fix.

* (BKR-462) Typo

* (BKR-462) Packages are not supported on OSX

* (BKR-462) Typo :(

* (BKR-462) And don't check_for_package anymore

* (BKR-462) Fix rsync_to_test on OSX and Solaris 10

* (BKR-462) Fix rsync dependency in create_remote_file_test on Windows, OSX, and Solaris

Includes a workaround for BKR-1502

* (BKR-462) Mark Windows rsync issues

* (BKR-462) Missed one during rebase

* (BKR-496) Return from Host::user_get/group_get without block

Matches the behavior of other Host methods that either return or execute a passed block.

* (BKR-496) Fix create_tmpdir_on() for all platforms

This fix directly addresses macOS and Windows, but provides a general solution by using host.user_get() to check if user (or host's default) exists on host. Also validates the group to accept a passed value or fall back to host default (instead of just using username for group). Spec tests and docs are expanded to cover addition of group argument.

* (BKR-496) Fix spec tests for set_env

Spec tests for set_env were failing as a result of fixing create_tmpdir_on. This change refactors those spec tests to be simpler and to actually work (instead of silently failing, and "passing") as intended.

Co-Authored-By: smcelmurry <mcelmurs@gmail.com>

* (BKR-496) Remove tmpdir_on spec testing shim

Since create_tmpdir_on() is fixed, the tmpdir_on() shim is no longer relevant and has been replaced with direct calls in all spec tests.

* (BKR-496) Update acceptance test for create_tmpdir_on

Removes tests/workaround documenting the previous failure behavior on Windows and macOS hosts.

* (BKR-496) Host::Mac::User.user_get() use `id -P <user>`

macOS is now POSIX compliant and includes the `id` utility. For convenience of system administrators, this utility includes option `-P` which prints result line in /etc/passwd format. This change makes output from user_get a Result object, to match other hosts.

* (BKR-469) Update Host::Mac user_get spec tests

dscacheutil parsing conformation tests dropped with shift to using `id -P`.

* (BKR-496) Missed one for 6e5a3751806edacdd9a7f307cba1dd7e9a12200c

* (BKR-496) Make user and group for create_tmpdir_on entirely optional and independent

Most of all, don't try to default to anything clever.

* (BKR-496) Fix handling of multiple hosts

* (BKR-496) Add spec tests for multiple hosts

* (BKR-496) Add acceptance tests for user/group parameters

* (BKR-496) Typo

* (BKR-496) Typo (pt.2)

* (BKR-496) Clean up whitespace in spec tests

* (BKR-496) Use Host.chown and chgrp

This gets around the issue with Cygwin chown not accepting Windows-style paths: we use Host.chown which wraps the Windows call with cygpath. Depends on #1534.

* (BKR-496) Move create_tmpdir_on() to beaker-puppet

Move spec and acceptance tests likewise. Refactor all calls to use `Host.tmpdir()` instead, including spec and acceptance tests.

* (BKR-496) Make name argument optional for Host.tmpdir()

We already generate a unique extension in these calls, might as well let the caller skip providing the human-readable identifying prefix.

(MAINT) Changelog fixes

(PUP-8305) Enable git-based acceptance testing

* (BKR-463) Use appropriate Result mocks for Rsync

Use Rsync::Result mocks for spec testing of Rsync, instead of Beaker::Result.

* (BKR-463) Check if Rsync actually worked

Check if Rsync call was actually successful; if not, raise Beaker::Host::CommandFailed.

* (BKR-463) Update CHANGELOG.md

* (BKR-463) Update failure case for Windows hosts

Some tests appear to have been written with workarounds for remote-dir existence. These should probably be cleaned up.

* (BKR-463) Don't forget to YARD

* (BKR-1499) Adds Beaker::Host#chown and #chgrp

Adds chown and chgrp methods so that hosts can handle per-host peculiarities, e.g. Cygwin hosts must call `cygpath -u` to get UNIX/POSIX style paths to pass to chown, because Cygwin chown does not support Windows-style paths.

* (BKR-1499) Wrap ls calls with cygpath

Implemented via Beaker::Host::File#ls_ld method to call `ls -ld` on hosts, which Windows hosts wrap with a call to cygpath.