(#2410) Update arguments utility to handle package parameters starting with dashes #3705
Conversation
This file contains hidden or 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
9 tasks
AdmiringWorm
force-pushed
the
improve-argument-parsing-fix-quotes
branch
2 times, most recently
from
81d4af1 to
b92bacf
Compare
gep13
requested changes
Jun 17, 2025
…d tests Update EscapePowerShellArguments to also replace single quotes with two single quotes to properly handle parameters containing single quotes. Add Pester tests for 'choco install' and 'choco info' commands to verify correct handling and output of package parameters with single quotes. These changes improve robustness when passing parameters with single quotes to PowerShell scripts and ensure expected behavior is tested. Based on code in PR: chocolatey#2804
…sh syntax Refactor argument splitting logic to correctly handle package arguments that use double-dash prefixes (--). The new SplitOnArguments method handles quoted strings, escaped characters, and nested quotes to ensure accurate parsing of complex argument strings. Add a Pester test to verify upgrading a package with double-dash package parameters works as expected, including environment variable setting and successful upgrade reporting. These changes fix issues with parsing package parameters during upgrades and improve reliability when using advanced argument formats.
…upgrades Add detection of unbalanced single or double quotes in package arguments during install, upgrade, and uninstall commands. Emit warnings to alert users that failures may be related to these potentially problematic arguments. For upgrades and uninstalls, include troubleshooting advice to run `choco info` with local-only flag. Add a test verifying upgrade behavior when package parameters contain single quotes and remembered arguments are enabled, ensuring warnings and diagnostic messages appear as expected. NOTE: Install and uninstall warnings and diagnostics are for future implementations, and will not be shown during normal execution today.
AdmiringWorm
force-pushed
the
improve-argument-parsing-fix-quotes
branch
from
b92bacf to
f5bf086
Compare
|
@AdmiringWorm thanks for getting this fixed! |
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
Motivation and Context
Packages should be possible to install and upgrade even with single quotes being used, and not having an exception about "unterminated single quotes" being thrown.
Testing
useRememberedArgumentsForUpgradesusingchoco feature enable -n useRememberedArgumentsForUpgrades.choco install test-params --package-parameters="/Comment:It's great! /SubmittedBy:Someone"."WARNING: - Comment = It's great!.choco info test-params --local-only.choco install test-environment --package-parameters="'--quiet --norestart --wait --includeRecommended --includeOptional'" --verbose --version 0.9.choco info test-environment --local-only(to partial package-parameter lines)choco upgrade test-environment.chocolateyPackageParameters=--quiet --norestart --wait --includeRecommended --includeOptionalOperating Systems Testing
Change Types Made
Change Checklist
Related Issue
choco upgradecommand fails with error messageThe string is missing the terminator: '.whenuseRememberedArgumentsForUpgradesfeature is enabled #2410