Add `Uninstall-ChocolateyPath` function to manage removing entries from PATH #310

mrdima · 2015-06-05T05:53:52Z

There is a useful helper Install-ChocolateyPath which I use to add directories to the PATH variable. I would like to see an Uninstall-ChocolateyPath as well to cleanup those directories from the PATH variable at uninstall time.
I guess this would apply to quite a few other helpers which only have an "Install" part.

ferventcoder · 2015-06-05T07:17:39Z

Yep, we had something logged somewhere for these.

tirolo · 2015-11-25T16:39:10Z

Wanna open it up for grab?

ferventcoder · 2015-11-25T17:20:54Z

@tirolo done.

mrdima · 2015-11-25T18:21:17Z

Just for an idea, wouldn't it be nice if the auto-uninstaller would be able to take care of this as well? Either snapshot the environment before and after the install (or only PATH environment variable) or have Install-Chocolatey log something for the uninstall

ferventcoder · 2015-11-25T18:26:51Z

Sounds nice - keep in mind it should only remove the added values and not
restore the previous version (that would be bad).

tirolo · 2015-11-26T12:30:09Z

Will start working on this one as soon as I get my read around the docs I have to read before start contributing + learn some github 😄 (shouldn't take long)

tirolo · 2015-11-26T12:35:55Z

@ferventcoder Should I target master?

ferventcoder · 2015-11-26T13:00:19Z

@tirolo master is set for 0.9.11.x, and stable is set for 0.9.10.x. I'd target stable if you can.

sindux · 2016-01-01T08:02:18Z

There was a PR for this in the old chocolatey repo chocolatey-archive/chocolatey#542

ferventcoder · 2016-01-07T21:20:51Z

Moving discussion back over to here, @DarwinJS See - #303

DarwinJS · 2016-01-08T02:45:42Z

Not sure if it's still relevant, but here is a link to the code I put together for this today. The code I did also handles removing duplicates (if the path to remove is in more than once), handles the path whether or not there is a trailing slash versus what is specified on the removal string and it handles removing extra ";' that are found. The code is not generalized to handle both user and machine path. https://github.com/DarwinJS/ChocoPackages/blob/master/ec2clitools/tools/chocolateyuninstall.ps1

ferventcoder · 2016-01-29T15:55:24Z

This is related to #303

DarwinJS · 2016-10-13T17:46:59Z

I'll take this one.

DarwinJS · 2016-10-14T22:22:53Z

I am wondering a few things about this code:
*) Does it make sense to remove the requested string from both user and computer path? On one hand if I was requesting a removal I would just want it gone no matter what paths it appeared on if the software was just removed. On the other hand it may make uninstalls reach to things that weren't instended.

Hmmm - what if it could take params "user", "machine" and "all" ? Should it default to "All" if unspecified or just always require the param?

DarwinJS · 2016-10-19T09:18:09Z

PR: #1019

Finally added Uninstall-ChocolateyPath. However, given overall contribution rates to the powershell functions are quite low, the decision has been made to rewrite our helper functions into C# cmdlets. This serves as the initial set of cmdlets, a handful of useful example cases to prove out the viability of this approach, as well as ensuring that we have a better path forward for both OSS commands and any licensed commands we want to use in the future. It also opens up the possibility of more easily overriding the OSS cmdlets with a licensed command, and there are provisions in the `chocolateyInstaller.psm1` module script to ensure that can work seamlessly. Summary of changes: - Added Uninstall-ChocolateyPath helper cmdlet - Rewrote the following associated functions into C# cmdlets: - Get-EnvironmentVariable - Get-EnvironmentVariableNames - Install-ChocolateyPath - Set-EnvironmentVariable - Test-ProcessAdminRights - Update-SessionEnvironment - Tweaked the PowerShell command lookup behaviour when loading the `chocolateyInstaller.psm1` module to ensure that licensed cmdlets can be preferentially used instead of open-source cmdlets or functions, regardless of any name collisions that may occur. - Tweaked the assembly resolver to ensure that if we have the licensed extension depend on the new Chocolatey.PowerShell assembly, it will not cause any issues when trying to load the licensed extension outside the PowerShell module context.

- Added an `update-cmdlet-documentation.ps1` script which will use PlatyPS to read the cmdlet metadata and keep documentation up to date. - Provides a `-NewCommand` switch to allow easier additions of documentation pages for any new cmdlets (PlatyPS does not add newly added commands by default). - This script directly adds or updates documentation in a local copy of the chocolatey/docs repository, and compiles an XML help file from the resulting content.

Finally added Uninstall-ChocolateyPath. However, given overall contribution rates to the powershell functions are quite low, the decision has been made to rewrite our helper functions into C# cmdlets. This serves as the initial set of cmdlets, a handful of useful example cases to prove out the viability of this approach, as well as ensuring that we have a better path forward for both OSS commands and any licensed commands we want to use in the future. It also opens up the possibility of more easily overriding the OSS cmdlets with a licensed command, and there are provisions in the `chocolateyInstaller.psm1` module script to ensure that can work seamlessly. Summary of changes: - Added Uninstall-ChocolateyPath helper cmdlet - Rewrote the following associated functions into C# cmdlets: - Get-EnvironmentVariable - Get-EnvironmentVariableNames - Install-ChocolateyPath - Set-EnvironmentVariable - Test-ProcessAdminRights - Update-SessionEnvironment - Tweaked the PowerShell command lookup behaviour when loading the `chocolateyInstaller.psm1` module to ensure that licensed cmdlets can be preferentially used instead of open-source cmdlets or functions, regardless of any name collisions that may occur. - Tweaked the assembly resolver to ensure that if we have the licensed extension depend on the new Chocolatey.PowerShell assembly, it will not cause any issues when trying to load the licensed extension outside the PowerShell module context.

- Added an `update-cmdlet-documentation.ps1` script which will use PlatyPS to read the cmdlet metadata and keep documentation up to date. - Provides a `-NewCommand` switch to allow easier additions of documentation pages for any new cmdlets (PlatyPS does not add newly added commands by default). - This script directly adds or updates documentation in a local copy of the chocolatey/docs repository, and compiles an XML help file from the resulting content.

(#310, #3318) Add Uninstall-ChocolateyPath cmdlet & rewrite associated functions as cmdlets

- Only return environment variable names that have an associated value from Get-EnvironmentVariableNames - When calling Update-SessionEnvironment, don't call SetVariable if the value at the queried scope is null.

During testing, it was found that the Location property of the Assembly was an entry string, therefore the cmdlets weren't being loaded. This commit attempts to address this by first checking the Location property, and if it is there, use it. Otherwise, fall back to the previous direct Import-Module against the $licensedAssembly. Will schedule a call with Rain to discuss this further once they are back from holiday.

During testing, it was found that the Chocolatey Profile was not being correctly loaded, with neither Update-SessionEnvironment nor refreshenv working as expected. This commit changes the profile loading to explicitly set the alas for refreshenv, and also to load Update-SessionEnvironment as a Cmdlet, rather than a Funcation. This is needed since it is now written in C# rather than PowerShell.

Previous changes for this issue had issues loading in powershell v2, this fixes those to the extent it's possible to do so.

Fix up Set-EnvironmentVariable and Update-SessionEnvironment tests.

We noticed over the last few days that the previous version of this code was *adding* blank values into the registry, which caused some issues with how environment variables are applied to new processes. Specifically, if a Machine-level variable is set, and a User-level variable by the same name is set to a blank value, new processes do not properly inherit the Machine-level value and it remains blank/unset. This change ensures that if someone sets an environment variable to a blank value, it will be properly *deleted* rather than set to a blank value. Additionally, a minor change has been made to Update-SessionEnvironment to ensure that if there are somehow blank values in the registry, it can sidestep those issues if it is called.

Previous changes for this issue had issues loading in powershell v2, this fixes those to the extent it's possible to do so.

Fix up Set-EnvironmentVariable and Update-SessionEnvironment tests.

We noticed over the last few days that the previous version of this code was *adding* blank values into the registry, which caused some issues with how environment variables are applied to new processes. Specifically, if a Machine-level variable is set, and a User-level variable by the same name is set to a blank value, new processes do not properly inherit the Machine-level value and it remains blank/unset. This change ensures that if someone sets an environment variable to a blank value, it will be properly *deleted* rather than set to a blank value. Additionally, a minor change has been made to Update-SessionEnvironment to ensure that if there are somehow blank values in the registry, it can sidestep those issues if it is called.

* release/2.3.0: (153 commits) (#23) Move call to SetRemotePackageNamesIfAllSpecified (#1901) Revert commit to display location (maint) Update Authenticode Signature (tests) Some minor tweaks for test consistency (#310) Set-EnvironmentVariable: delete values properly (tests) Remove v2 import tests (#310) Fix test issues (#310) Fixup v2 compatibility (tests) Working on tests during pairing session (#2050) Add Pester test for --ignore-pinned option (#3381) Add Pester tests for rule command (#1144) Add Pester test to cover hash validation (#72) Add Pester tests to cover new functionality (test) Update assertions for push commands (#1310) Add Pester test to validate output (#23) Add tests to handle install all (#2200) Add test for new enhanced exit code (#1764) Add test for new enhanced exit code (#1760) Add test for new enhanced exit code (#1759) Add test for new enhanced exit code ...

When progressing the release of 2.3.0, it was found that the chocolatey.lib nupkg didn't contain any files. This was due to a change in the folder structure which wasn't caught during testing. This commit fixes this folder structure, pointing directly to the chocolatey.lib folder, so that running nuget pack works as expected. There may be additional changes required to this portion of the build, to make sure that everything is being created in the same way, but that can be picked up post release/

choco-bot · 2024-06-05T13:51:35Z

🎉 This issue has been resolved in version 2.3.0 🎉

The release is available on:

Your GitReleaseManager bot 📦 🚀

* master: (37 commits) (#310) Fix path to chocolatey.lib files (maint) Corrected casing of file (#23) Move call to SetRemotePackageNamesIfAllSpecified (#1901) Revert commit to display location (maint) Update Authenticode Signature (tests) Some minor tweaks for test consistency (#310) Set-EnvironmentVariable: delete values properly (tests) Remove v2 import tests (#310) Fix test issues (#310) Fixup v2 compatibility (tests) Working on tests during pairing session (#2050) Add Pester test for --ignore-pinned option (#3381) Add Pester tests for rule command (#1144) Add Pester test to cover hash validation (#72) Add Pester tests to cover new functionality (test) Update assertions for push commands (#1310) Add Pester test to validate output (#23) Add tests to handle install all (#2200) Add test for new enhanced exit code (#1764) Add test for new enhanced exit code ...

…evelop * 'develop' of https://github.com/josh-cooley/choco: (145 commits) (maint) Add CODEOWNERS files (build) Add templated notifications to all builds (build) Add verification of source scripts (doc) Further tweak docgen for Chocolatey.PowerShell (doc) Tweak docgen for Chocolatey.PowerShell (chocolatey#3446) Update GenerateDocs.ps1 (chocolatey#3307) Do not create Tools directory from MSI (maint) Do not create Chocolatey directory in MSI (chocolatey#310) Fix path to chocolatey.lib files (maint) Corrected casing of file (chocolatey#23) Move call to SetRemotePackageNamesIfAllSpecified (chocolatey#1901) Revert commit to display location (maint) Update Authenticode Signature (tests) Some minor tweaks for test consistency (chocolatey#310) Set-EnvironmentVariable: delete values properly (tests) Remove v2 import tests (chocolatey#310) Fix test issues (chocolatey#310) Fixup v2 compatibility (tests) Working on tests during pairing session (chocolatey#2050) Add Pester test for --ignore-pinned option ...

ferventcoder added Improvement 0 - Backlog labels Jun 5, 2015

ferventcoder added this to the 0.9.10.x milestone Jun 5, 2015

ferventcoder added the Up For Grabs label Nov 25, 2015

ferventcoder mentioned this issue Jan 7, 2016

Uninstall-ChocolateyPath.ps1 chocolatey-archive/chocolatey#542

Open

ferventcoder mentioned this issue Jun 3, 2016

Uninstall-ChocolateyEnvironmentVariable function #772

Closed

petemounce mentioned this issue Sep 15, 2016

InstallScriptWithUndoableActionsNeedsUninstallScript - choco needs uninstall helper functions chocolatey/package-validator#148

Open

ferventcoder added the Hacktoberfest label Oct 2, 2016

DarwinJS mentioned this issue Oct 15, 2016

(#310) Uninstall-ChocolateyPath #1019

Closed

majkinetor mentioned this issue Nov 13, 2016

Core extension chocolatey-community/chocolatey-packages#390

Merged

ferventcoder added 2 - Working and removed 0 - Backlog labels Nov 13, 2016

ferventcoder modified the milestones: 0.10.4, 0.10.x Nov 13, 2016

ferventcoder self-assigned this Nov 13, 2016

gep13 modified the milestones: Future, 2.3.0 May 23, 2024

vexx32 added a commit to vexx32/choco that referenced this issue May 23, 2024

(chocolatey#310) Add tests for some helper commands

2340e77

gep13 pushed a commit to vexx32/choco that referenced this issue May 24, 2024

(chocolatey#310) Add tests for some helper commands

bbe633d

gep13 added a commit that referenced this issue May 24, 2024

Merge pull request #3440 from vexx32/uninstall-chocolateypath-cmdlets

2ab635e

(#310, #3318) Add Uninstall-ChocolateyPath cmdlet & rewrite associated functions as cmdlets

gep13 closed this as completed in #3440 May 24, 2024

gep13 added 4 - Done and removed 3 - Review labels May 24, 2024

vexx32 mentioned this issue May 24, 2024

(#310) Fix issue with environment handling #3453

Closed

10 tasks

pauby changed the title ~~Add PowerShell helper function to manage removing paths from $PATH~~ Add Uninstall-ChocolateyPath function to manage removing entries from PATH May 28, 2024

vexx32 added a commit to gep13/choco that referenced this issue May 30, 2024

(chocolatey#310) Fixup v2 compatibility

d4c71b1

Previous changes for this issue had issues loading in powershell v2, this fixes those to the extent it's possible to do so.

vexx32 added a commit to gep13/choco that referenced this issue May 30, 2024

(chocolatey#310) Fix test issues

8b74276

Fix up Set-EnvironmentVariable and Update-SessionEnvironment tests.

gep13 pushed a commit to gep13/choco that referenced this issue May 30, 2024

(chocolatey#310) Fixup v2 compatibility

71df5cc

Previous changes for this issue had issues loading in powershell v2, this fixes those to the extent it's possible to do so.

gep13 pushed a commit to gep13/choco that referenced this issue May 30, 2024

(chocolatey#310) Fix test issues

dfc2b92

Fix up Set-EnvironmentVariable and Update-SessionEnvironment tests.

gep13 added 5 - Released and removed 4 - Done labels Jun 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `Uninstall-ChocolateyPath` function to manage removing entries from PATH #310

Add `Uninstall-ChocolateyPath` function to manage removing entries from PATH #310

mrdima commented Jun 5, 2015

ferventcoder commented Jun 5, 2015

tirolo commented Nov 25, 2015

ferventcoder commented Nov 25, 2015

mrdima commented Nov 25, 2015

ferventcoder commented Nov 25, 2015 •

edited by pauby

Loading

tirolo commented Nov 26, 2015

tirolo commented Nov 26, 2015

ferventcoder commented Nov 26, 2015

sindux commented Jan 1, 2016

ferventcoder commented Jan 7, 2016

DarwinJS commented Jan 8, 2016

ferventcoder commented Jan 29, 2016

DarwinJS commented Oct 13, 2016

DarwinJS commented Oct 14, 2016

DarwinJS commented Oct 19, 2016

choco-bot commented Jun 5, 2024

Add Uninstall-ChocolateyPath function to manage removing entries from PATH #310

Add Uninstall-ChocolateyPath function to manage removing entries from PATH #310

Comments

mrdima commented Jun 5, 2015

ferventcoder commented Jun 5, 2015

tirolo commented Nov 25, 2015

ferventcoder commented Nov 25, 2015

mrdima commented Nov 25, 2015

ferventcoder commented Nov 25, 2015 • edited by pauby Loading

tirolo commented Nov 26, 2015

tirolo commented Nov 26, 2015

ferventcoder commented Nov 26, 2015

sindux commented Jan 1, 2016

ferventcoder commented Jan 7, 2016

DarwinJS commented Jan 8, 2016

ferventcoder commented Jan 29, 2016

DarwinJS commented Oct 13, 2016

DarwinJS commented Oct 14, 2016

DarwinJS commented Oct 19, 2016

choco-bot commented Jun 5, 2024

Add `Uninstall-ChocolateyPath` function to manage removing entries from PATH #310

Add `Uninstall-ChocolateyPath` function to manage removing entries from PATH #310

ferventcoder commented Nov 25, 2015 •

edited by pauby

Loading