Allow empty string for Should-BeString -Expected#2863
Open
nohwnd wants to merge 1 commit into
Open
Conversation
The -Expected parameter was declared Mandatory with a [String] type, which implicitly rejects empty strings during parameter binding. There is no assertion-level reason to reject an empty expected value: Test-StringEqual and Get-StringDifferenceMessage already handle empty strings, and Should-NotBeString already accepts them. Add [AllowEmptyString()] so the parameter stays required but may be empty. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
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.
Fix #2857
Problem
Should-BeStringrejects an empty string for-Expected:This forces users porting v5
-ForEachtests to branch betweenShould-BeStringandShould-BeEmptyStringdepending on whether the expected value is empty.Root cause
The rejection is not a deliberate assertion rule — there's no validation in the function body checking for empty. It's an implicit side effect of declaring the parameter as
[Parameter(Mandatory)][String]$Expected: a mandatory, typed[String]parameter automatically refuses""during parameter binding.Everything downstream already handles empty strings:
Test-StringEqualcompares empty strings correctly.Get-StringDifferenceMessagealready declares[AllowEmptyString()]on$Expected/$Actual.Should-NotBeStringdoesn't markExpectedasMandatory, so it already accepts empty strings —Should-BeStringwas the inconsistent one.Change
[AllowEmptyString()]to$Expected(keepingMandatory, so the argument is still required — it may just be empty).""but actual is non-empty.All 42 tests in
Should-BeString.Tests.ps1pass.