(#1479) Add ability to use remembered arguments during uninstall

[TheCakeIsNaOH]

Description Of Changes

This adds the ability for remembered arguments to be used during uninstall.

Similarly to using remembered argument for upgrades, a feature has been added, UseRememberedArgumentsForUninstalls, and --ignore-remembered-arguments/--use-remembered-arguments argument have been added to the uninstall command.

The set_package_config_for_upgrade has been renamed and some other changes were made to update it to prepare it to be used for setting the config for both upgrade and uninstall. The implementation of the feature uses the same method the upgrade command does. Remembered install arguments (--install-arguments=) are ignored, so they do not overwrite --uninstall-arguments=, as both use the same internal config value.

To prevent an issue like #1443, a reset config action has also been added to uninstall_run, just like the one added to upgrade_run in #2484.

Motivation and Context

When creating a package that will copy file(s) to a location that is specified via a package parameter, or adding a location to the $env:path, there is not an easy way to save that location, so it can be removed during uninstall. It is possible to save it via a text file or similar, but there is not a standardized way to do so.

Having argument, including package parameters be remembered during uninstall allows for an easy fix to this situation. The uninstall script can get those parameters, and therefore get the location(s) that need to be removed. This also applies to any other behavior set via a parameter that need to be undone during the uninstall script.

Any --install-arguments= are not remembered during uninstall because they can conflict with uninstall arguments, as the available set of install and uninstall arguments are different in most cases.

Testing

Build choco, run the integration tests, and (if required), copy the context directory from the integration test to the directory you are testing from.

1. Check that the feature works:

.\choco.exe feature enable -n UseRememberedArgumentsForUninstalls
.\choco.exe install upgradepackage --version=1.0.0 --source=.\context --package-parameters="/PKGPARAM" --yes
.\choco.exe uninstall upgradepackage --verbose --debug --yes

Validate that during the uninstall output, the chocolateyUninstall.ps1 is called with /PKGPARAM included.

2. Check that the ignore switch works:

.\choco.exe feature enable -n UseRememberedArgumentsForUninstalls
.\choco.exe install upgradepackage --version=1.0.0 --source=.\context --package-parameters="/PKGPARAM" --yes
.\choco.exe uninstall upgradepackage --verbose --debug --ignore-remembered-arguments --yes

Validate that during the uninstall output, the chocolateyUninstall.ps1 is called with /PKGPARAM NOT included.

3. Check that --ia are not used:

.\choco.exe feature enable -n UseRememberedArgumentsForUninstalls
.\choco.exe install upgradepackage --version=1.0.0 --source=.\context --ia="installArg" --yes
.\choco.exe uninstall upgradepackage --verbose --debug --yes

Validate that during the uninstall output, the chocolateyUninstall.ps1 is called with installArg NOT included.

4. Check that the use switch works:

.\choco.exe feature disable -n UseRememberedArgumentsForUninstalls
.\choco.exe install upgradepackage --version=1.0.0 --source=.\context --package-parameters="/PKGPARAM" --yes
.\choco.exe uninstall upgradepackage --verbose --debug --yes --use-remembered-arguments

Validate that during the uninstall output, the chocolateyUninstall.ps1 is called with /PKGPARAM included.

5. Check that arguments are not reused:

.\choco.exe feature enable -n UseRememberedArgumentsForUninstalls
.\choco.exe install installpackage --version=1.0.0 --source=.\context --package-parameters="/PKGPARAM" --yes
.\choco.exe install upgradepackage --version=1.0.0 --source=.\context --yes
.\choco.exe uninstall installpackage upgradepackage --verbose --debug --yes

Validate that the installpackage uninstall script is called with /PKGPARAM but the upgradepackage uninstall script is called without it.

Change Types Made

• Bug fix (non-breaking change)
• Feature / Enhancement (non-breaking change)
• Breaking change (fix or feature that could cause existing functionality to change)

Related Issue

Fixes #1479
Based on/Depends on #3003

Change Checklist

• Requires a change to the documentation
• Documentation has been updated
• Tests to cover my changes, have been added
• All new and existing tests passed.
• N/A PowerShell v2 compatibility checked.

[coveralls]

Coverage increased (+0.008%) to 28.586% when pulling 627bedb on TheCakeIsNaOH:uninstall-remembered-arguments into 6f3fc15 on chocolatey:develop.

[TheCakeIsNaOH]

This is draft until #3003 is merged/closed, as the implementation of this depends on what happens with that PR.

[TheCakeIsNaOH]

Rebased on #3003