(doc) Document key purging in the description of the ssh_authorized_key type

This commit puts an explanation of key purging over where people will likely be
looking for it. It also tightens up the description of the user type's
purge_ssh_keys attribute, and adds an example key to the ssh_authorized_key type
(since the way that type breaks up key lines is somewhat unintuitive).

The example public key is a dud, to prevent accidental access grants.
(PUP-2311) OpenBSD uninstall broken when multiple uninstall_options given
(PUP-2458) Tests for providers inheriting from providers of another type

It's sometimes desirable to create new providers that inherit from providers
of a different type to create more specialised types/providers from a common
base.  This adds tests around this already-present functionality.
(PUP-2508) Ensure env & trn-uuid are sent when configurer failures occur

Any failure in the configurer #run code might cause the ensure block to
evaluate early, and a report might be sent missing the details of what
the environment and transaction_uuid should be.

This patch moves where the report fields 'environment' and
'transaction_uuid' are set in the configurer code to ensure they are
populated early.

It also ensures the report environment is modified if the catalog or
server specifies it is different to the launched environment. This is
because we change this mid-flight, so our code simplies updates the
report environment when this happens.

Signed-off-by: Ken Barber <ken@bob.sh>
(PUP-2214) Change doc application to use current environment
(PUP-2214) Change parser application to use current_environment

This changes the parser face to use the current_environment instead
of looking up the "configured environment" from settings and then
using that environment.

This also adjust the documentation for the command wrt. use
with --parser future.
(PUP-2214) Change node/clean face to use configured environment
(PUP-2214) Fix failing doc tests

Doc tests with mocking did not work, needed to use a real configured
env.
(PUP-2214) Add comment that node.environment is source of environment

This note is to ensure the lookup of :environment is not changed
to a lookup of :current_environment, since the node's environment
is what is used to determine what the current_environment should be.
(PUP-2014) Make module use current_environment

Module now uses current environment instead of configured
environment when being asked for a module and not supplying
an explicit environment name. It used to lookup to configured
environment giving invoking logic no chance to modify the
default without modifying the setting.
(PUP-2214) Make util rdoc and related parser use :current_environment
(PUP-2214) Add comment about looking up environment for requests.
(PUP-2214) Change autoloader to use current_environment for changed?

This changes the autoloader to use the current_environment as the
environment when performing a changed? operation. (It used to check
if the configured environment was changed).

The complicated bootstrap support still uses lookup of configured
environment as that is the fallback when booting.
(PUP-2214) Add comment what command_line "current_environment" means
(PUP-2214) Add comment about application's use of configured env
(PUP-2214) Add comment about module_tool's lookup of requested env
(PUP-2182) Add virtual_packages feature to package type.

In 3.5.x, the yum package provider changed to accept virtual package
names (packages that provide other package names).

That change in behavior caused some undesirable side-effects. As we did
not give users fair warning that this behavior was changing, we have
decided to change the yum provider back to only accepting "real" package
names by default.

To keep the support for virtual package names, a "virtual_packages"
feature has been implemented on the package type and supported on the
yum package provider.  The feature adds the "allow_virtual" parameter
that controls whether or not virtual package names will be allowed for
install/uninstall.

For now, the default value for this parameter will be false to restore
the previous behavior.  However, a deprecation warning will be issued to
let users know that the default will eventually be changed to true.
Users can prevent the deprecation warning by explicitly setting the
parameter to either true or false.
(PUP-2214) Remove dead environment method from rest indirector

Removing a private method for looking up the environment from the Rest
indirector becaues it does not seem to be called anymore.
(PUP-2214) Fix spec failures under 1.8.7

Fixes some rdoc1 spec issues by providing explicit envs in the specs.
Merge pull request #2631 from hlindberg/pup-2214_change-env-lookup-to-current-env

(PUP-2214) change env lookup to current env