Add ValidateNotNullOrWhiteSpace Attribute #17191

wmentha · 2022-04-25T07:34:55Z

PR Summary

Adds ValidateNotNullOrWhiteSpace to System.Management.Automation

PR Context

Currently, users who want to validate a string or collection of strings will add the [ValidateNotNullOrEmpty()] attribute to it and then manually validate the string with [String]::IsNullOrWhiteSpace(my_string).

[ValidateNotNullOrEmpty()]
[String[]]
$string_collection = @("a", "b", " ", "d")

foreach ($str in $string_collection)
{
    if (-not [String]::IsNullOrWhiteSpace($str))
    {
        throw [System.ArgumentNullException] "Element consisted entirely of white-space characters"
    }
}

Alternate implentation @vexx32 suggested could have been a bool argument to ValidateNotNullOrEmpy: ValidateNotNullOrEmpty(WhiteSpace). However I have chosen to implement this as a seperate attribute as users who work with strings know to use a seperate attribute when validating them: ValidateNotNullOrEmpty as opposed to ValidateNotNull. ValidateNotNullOrEmpty adds a further requirement for the validation over ValidateNotNull. Likewise ValidateNotNullOrWhiteSpace adds the further requirement of no strings consisting entirely of white-space over ValidateNotNullOrEmpty.

Also, this is my first commit 😊

Class Diagram Before

classDiagram
    ValidateArgumentsAttribute <|-- NullValidationAttributeBase
    NullValidationAttributeBase <|-- ValidateNotNullAttribute
    NullValidationAttributeBase <|-- ValidateNotNullOrEmptyAttribute
    class ValidateArgumentsAttribute {
        <<abstract>>
        #Validate(object arguments, EngineIntrinsics engineIntrinsics)* void
    }
    class NullValidationAttributeBase {
        <<abstract>>
        #IsArgumentCollection(Type argumentType, out bool isElementValueType) bool
    }
    class ValidateNotNullAttribute{
        #Validate(object arguments, EngineIntrinsics engineIntrinsics) void
    }
    class ValidateNotNullOrEmptyAttribute{
        #Validate(object arguments, EngineIntrinsics engineIntrinsics) void
    }

Class Diagram After

classDiagram
    ValidateArgumentsAttribute <|-- NullValidationAttributeBase
    NullValidationAttributeBase <|-- ValidateNotNullAttribute
    NullValidationAttributeBase <|-- ValidateNotNullOr
    ValidateNotNullOr <|-- ValidateNotNullOrEmptyAttribute
    ValidateNotNullOr <|-- ValidateNotNullOrWhiteSpaceAttribute
    class ValidateArgumentsAttribute {
        <<abstract>>
        #Validate(object arguments, EngineIntrinsics engineIntrinsics)* void
    }
    class NullValidationAttributeBase {
        <<abstract>>
        #IsArgumentCollection(Type argumentType, out bool isElementValueType) bool
    }
    class ValidateNotNullAttribute{
        #Validate(object arguments, EngineIntrinsics engineIntrinsics) void
    }
    class ValidateNotNullOr{
        <<abstract>>
        #bool _whiteSpace
        #ValidateNotNullOr(bool whiteSpace)*
        #Validate(object arguments, EngineIntrinsics engineIntrinsics) void
    }
    class ValidateNotNullOrEmptyAttribute {
        +ValidateNotNullOrEmptyAttribute(bool whiteSpace)
    }
    class ValidateNotNullOrWhiteSpaceAttribute {
        +ValidateNotNullOrWhiteSpaceAttribute(bool whiteSpace)
    }

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
Breaking changes
- None
User-facing changes
- Documentation needed
  - Issue filed:
Testing - New and feature
- Make sure you've added a new test if existing tests do not effectively test the code changed
Tooling
- I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.

microsoft-cla-retired · 2022-04-25T07:35:08Z

All CLA requirements met.

Acts identically to ValidateNotNullOrEmpty, except this attribute will now also check if argument consists entirely of white-space.

daxian-dbw · 2022-04-27T17:36:47Z

@JamesWTruher Can you please take a look and see if this change is something we want to take? My concern is that any commands using this attribute won't work on downlevel PowerShell versions, which may make this attribute less interesting to module authors, until all downlevel versions are out of support.

msftbot · 2022-05-05T02:00:44Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

daxian-dbw · 2022-05-05T16:08:15Z

@JamesWTruher gentle ping :)

msftbot · 2022-05-13T02:00:47Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

JamesWTruher · 2022-05-23T18:55:53Z

I think this is fine. We have plenty of examples of new behaviors which will not be available down level.

JamesWTruher

while I understand that there is some concern about this with regard to forward behavior, i think there's enough value here to take this. We have a number of examples where we've do this. (null coalescing, etc)

wmentha · 2022-07-26T07:51:51Z

@daxian-dbw gentle ping 😊

daxian-dbw

@wmentha Sorry for the long delay of review. The changes look good overall, thanks for that!
My comments are mainly about style changes and comment/error string improvements. Please take a look and let me know if you have any concerns.

src/System.Management.Automation/engine/Attributes.cs

src/System.Management.Automation/resources/Metadata.resx

test/powershell/engine/Basic/ValidateAttributes.Tests.ps1

Added extra ValidateAttributesTests to check for scalar values.

1�7.com/wmentha/PowerShell into ValidateNotNullOrWhiteSpaceAttribute

Added extra ValidateAttributesTests to check for scalar values.

1�7.com/wmentha/PowerShell into ValidateNotNullOrWhiteSpaceAttribute

pull-request-quantifier · 2022-08-09T02:44:28Z

This PR has 76 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Small
Size       : +67 -9
Percentile : 30.4%

Total files changed: 7

Change summary by file extension:
.cs : +32 -4
.resx : +6 -0
.ps1 : +28 -5
.csv : +1 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detected.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 👌 👎 (Email)
Customize PullRequestQuantifier for this repository.

wmentha · 2022-08-09T03:12:14Z

@daxian-dbw Apologies for the mess of commits. I got tripped up on the new $totalAccelerators count since the addition of the ordered type accelerator for OrderedDictionary #17804

daxian-dbw

LGTM. Thanks @wmentha for the contribution!

msftbot · 2022-12-20T22:58:16Z

🎉v7.4.0-preview.1 has been released which incorporates this pull request.🎉

Handy links:

Release Notes

msftbot bot assigned daxian-dbw Apr 25, 2022

pull-request-quantifier bot added the Small label Apr 25, 2022

wmentha requested a review from daxian-dbw as a code owner Apr 25, 2022

Add ValidateNotNullOrWhiteSpaceAttribute Attribute

9423ceb

Acts identically to ValidateNotNullOrEmpty, except this attribute will now also check if argument consists entirely of white-space.

daxian-dbw requested a review from JamesWTruher Apr 27, 2022

msftbot bot added the Review - Needed The PR is being reviewed label May 5, 2022

msftbot bot removed the Review - Needed The PR is being reviewed label May 5, 2022

msftbot bot added the Review - Needed The PR is being reviewed label May 13, 2022

daxian-dbw added the WG-Engine core PowerShell engine, interpreter, and runtime label Jun 6, 2022

JamesWTruher approved these changes Jul 18, 2022

View changes

daxian-dbw requested changes Aug 8, 2022

View changes

wmentha added 6 commits Aug 9, 2022

Apply suggestions from code review

c97ff05

Added extra ValidateAttributesTests to check for scalar values.

Apply suggestions from code review

322939b

Added extra ValidateAttributesTests to check for scalar values.

Merge branch 'ValidateNotNullOrWhiteSpaceAttribute' of https://github 1�7

0d971db

1�7.com/wmentha/PowerShell into ValidateNotNullOrWhiteSpaceAttribute

Apply suggestions from code review

68ab444

Added extra ValidateAttributesTests to check for scalar values.

Merge branch 'ValidateNotNullOrWhiteSpaceAttribute' of https://github 1�7

5f74b38

1�7.com/wmentha/PowerShell into ValidateNotNullOrWhiteSpaceAttribute

Merge branch 'master' into ValidateNotNullOrWhiteSpaceAttribute

4a1ab78

wmentha requested a review from daxian-dbw Aug 9, 2022

daxian-dbw approved these changes Aug 9, 2022

View changes

daxian-dbw merged commit d75d3b6 into PowerShell:master Aug 9, 2022
38 of 39 checks passed

daxian-dbw added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Aug 9, 2022

wmentha deleted the ValidateNotNullOrWhiteSpaceAttribute branch Aug 10, 2022

TravisEz13 mentioned this pull request Sep 30, 2022

Move ApiScan to compliance build #18191

Merged

22 tasks

msftbot bot mentioned this pull request Dec 20, 2022

Validation for strings that have more than just white space. #10010

Closed

Nov	DEC	Jan
	21
2021	2022	2023

Add ValidateNotNullOrWhiteSpace Attribute #17191

Add ValidateNotNullOrWhiteSpace Attribute #17191

wmentha commented Apr 25, 2022 •

edited

microsoft-cla-retired bot commented Apr 25, 2022 •

edited

daxian-dbw commented Apr 27, 2022 •

edited

msftbot bot commented May 5, 2022

daxian-dbw commented May 5, 2022

msftbot bot commented May 13, 2022

JamesWTruher commented May 23, 2022

JamesWTruher left a comment

wmentha commented Jul 26, 2022

daxian-dbw left a comment

pull-request-quantifier bot commented Aug 9, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

wmentha commented Aug 9, 2022

daxian-dbw left a comment

msftbot bot commented Dec 20, 2022

Add ValidateNotNullOrWhiteSpace Attribute #17191

Add ValidateNotNullOrWhiteSpace Attribute #17191

Conversation

wmentha commented Apr 25, 2022 • edited

PR Summary

PR Context

Class Diagram Before

Class Diagram After

PR Checklist

microsoft-cla-retired bot commented Apr 25, 2022 • edited

daxian-dbw commented Apr 27, 2022 • edited

msftbot bot commented May 5, 2022

daxian-dbw commented May 5, 2022

msftbot bot commented May 13, 2022

JamesWTruher commented May 23, 2022

JamesWTruher left a comment

wmentha commented Jul 26, 2022

daxian-dbw left a comment

pull-request-quantifier bot commented Aug 9, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

wmentha commented Aug 9, 2022

daxian-dbw left a comment

msftbot bot commented Dec 20, 2022

wmentha commented Apr 25, 2022 •

edited

microsoft-cla-retired bot commented Apr 25, 2022 •

edited

daxian-dbw commented Apr 27, 2022 •

edited