(#1443) Reset config via action after every package upgrade

[TheCakeIsNaOH]

Description Of Changes

This adds a parameter to the upgrade_run method, which
is used to pass an action which resets the configuration in the
function that calls upgrade_run.

Motivation and Context

This fixes a bug when useRememberedArguments is enabled that causes
arguments to be reused in the chocolateyInstall.ps1 when multiple
packages are upgraded. It happens because OptionSet.parse() sets the
configuration via the actions specified in the UpgradeCommand optionSet
setup (and likewise in configuration builder as well). It only sets
options that are saved, so if a later package does not have an option,
it is not set, and the previous option is reused.

This fixes the bug because it resets the configuration at the
ChocolateyPackageService level, which is enough to reset the
configuration for action that runs the PowerShell as well.

Testing

1. Build choco
2. Run these setup steps:

.\choco.exe feature enable -n useRememberedArgumentsForUpgrades --allow-unofficial -y
.\choco.exe feature enable -n allowGlobalConfirmation --allow-unofficial -y
.\choco.exe install curl --package-parameters="'/CurlOnlyParam'" --version=7.77.0 --allow-unofficial -y -f --ia="'/CurlIAParam'" --forcex86
.\choco.exe install wget --version=1.21.1 --allow-unofficial -y -f

Note that curl has package parameters, install arguments and forcex86 set, while wget does not have any of those.

3. Run this: .\choco.exe upgrade all --allow-unofficial -y --debug

The curl install script should be run with the package parameters, install arguments and forcex86 similar to this:

& '.\helpers\chocolateyScriptRunner.ps1' -packageScript '.\lib\curl\tools\chocolateyInstall.ps1' -installArguments '/CurlIAParam' -packageParameters '/CurlOnlyParam' -forceX86']

And the wget install script should be run without those arguments:

& '.\helpers\chocolateyScriptRunner.ps1' -packageScript '.\lib\Wget\tools\chocolateyinstall.ps1' -installArguments '' -packageParameters ''']

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)s

Related Issue

Fixes #1443

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 decreased (-0.06%) to 27.583% when pulling 8f15337 on TheCakeIsNaOH:reset-config into 097b52f on chocolatey:develop.

[TheCakeIsNaOH]

It seems like this only remembers bool switches (like --forcex86) for the first package that uses them.

.\choco.exe feature enable -n useRememberedArgumentsForUpgrades --allow-unofficial -y
.\choco.exe feature enable -n allowGlobalConfirmation --allow-unofficial -y
.\choco.exe install curl --package-parameters="'/CurlOnlyParam'" --version=7.77.0 --allow-unofficial -y -f --ia="'/CurlIAParam'" --forcex86
.\choco.exe install wget --version=1.21.1 --allow-unofficial -y -f --forcex86
.\choco.exe upgrade all --allow-unofficial -y --debug

And during that upgrade all, the curl package will extract it's 32 bit archive, but the wget package will extract it's 64 bit archive. The wget package should have the --forcex86 argument set, but it appears like that it was not set.

[AdmiringWorm]

It seems like this only remembers bool switches (like --forcex86) for the first package that uses them.

.\choco.exe feature enable -n useRememberedArgumentsForUpgrades --allow-unofficial -y
.\choco.exe feature enable -n allowGlobalConfirmation --allow-unofficial -y
.\choco.exe install curl --package-parameters="'/CurlOnlyParam'" --version=7.77.0 --allow-unofficial -y -f --ia="'/CurlIAParam'" --forcex86
.\choco.exe install wget --version=1.21.1 --allow-unofficial -y -f --forcex86
.\choco.exe upgrade all --allow-unofficial -y --debug

And during that upgrade all, the curl package will extract it's 32 bit archive, but the wget package will extract it's 64 bit archive. The wget package should have the --forcex86 argument set, but it appears like that it was not set.

Hmm, that sounds like we would maybe want to wait to pull this PR into the repository.

I'll bring it up internally tomorrow to see where we want to go.

EDIT: I have a nagging feeling it is not just boolean switches, but rather everything once it goes to the second package.

[AdmiringWorm]

I have had a chat internally about this, and we have come up with a solution that I will be trying out.

Expect this PR to be updated with the new code that I have in mind that should allow us to have a clean copy of the Configuration class, while still being able to retain the references that are required to be in place (the references are the identified cause of the issue that makes Chocolatey CLI forget about the needed arguments for further package executions).

[AdmiringWorm]

I have moved this PR into draft, while the code and tests are being worked on to prevent any merges happening

[corbob]

Just a few spelling points in the comments.

Also a question: Does this need to be updated in chocolatey licensed extension as well?

[AdmiringWorm]

Also a question: Does this need to be updated in chocolatey licensed extension as well?

No, there is no need to update anything in the Licensed codebase.

[corbob]

LGTM!

[corbob]

Thanks for getting this added @AdmiringWorm. I'll let the GitHub Actions finish, then kick the one that failed and once that's all green I'll get this merged 😁