(#3477) Add ShouldProcess support to rewritten helper cmdlets #3532
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 tasks
gep13
requested changes
Oct 25, 2024
| It 'skips removing the value if it is not present' { | ||
| $targetPathEntry = [Environment]::GetEnvironmentVariable('PATH', $Scope) -split ';' | Select-Object -First 1 | ||
| $Command = [scriptblock]::Create("Uninstall-ChocolateyPath -Path 'C:\ThisShouldNotBePresent' -Scope $Scope -WhatIf") | ||
| Get-WhatIfResult -Preamble $Preamble -Command $Command | Should -BeNullOrEmpty -Because 'we should skip adding values that already exist' |
There was a problem hiding this comment.
Should the Because here not be something like we should skip uninstalling a value that doesn't exist?
Some cmdlets should support ShouldProcess, this change ensures that they do correctly support it, along with adding checks to the underlying methods to make it work as users will expect. As Chocolatey CLI already supports --dry-run itself, this is primarily going to be useful for effectively unit testing the commands.
Update-SessionEnvironment, Set-EnvironmentVariable, and (Un)Install-ChocolateyPath implement ShouldProcess, so we can use -WhatIf to verify their behaviour with unit tests.
vexx32
force-pushed
the
ShouldProcess-cmdlets
branch
from
061a60e
to
707db73
Compare
|
@gep13 I think I've addressed both of those, thanks! Also rebased on develop. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description Of Changes
Set-EnvironmentVariable,Install-ChocolateyPath,Uninstall-ChocolateyPath, andUpdate-SessionEnvironmentVMOnlyso they do not run by default in typical dev environmentsMotivation and Context
In discussion with @gep13 we realised there is value in having the ability to non-destructively verify the logic paths taken in the code here. As such, I have augmented the existing commands and associated helper classes with ShouldProcess semantics to make this workable.
Testing
build.ps1./Invoke-Tests.ps1 -Tags WhatIfOperating Systems Testing
WIn10
Change Types Made
Change Checklist
Related Issue
Part of #3477
Docs PR: chocolatey/docs#1086