Add `-Path` and `-LiteralPath` parameters to `Test-Json` cmdlet #19042

ArmaanMcleod · 2023-01-27T12:39:14Z

PR Summary

Added -Path and -LiteralPath parameter to Test-Json cmdlet.

PR Context

Currently you can only pass a JSON string to Test-Json like so:

PS C:\> Test-Json -Json (Get-Content -Path data.json -Raw)

With this change you can now also pass a path:

PS C:\> Test-Json -Path data.json

Or with literal path:

PS C:\> Test-Json -LiteralPath '[data].json'

Which makes validating JSON from file paths much easier.

Current Syntax

Test-Json [-Json] <string> [<CommonParameters>]

Test-Json [-Json] <string> [[-Schema] <string>] [<CommonParameters>]

Test-Json [-Json] <string> [[-SchemaFile] <string>] [<CommonParameters>]

New Syntax

Test-Json [-Json] <string> [<CommonParameters>]

Test-Json [-Json] <string> [-Schema] <string> [<CommonParameters>]

Test-Json [-Json] <string> [-SchemaFile] <string> [<CommonParameters>]

Test-Json [-Path] <string> [<CommonParameters>]

Test-Json [-Path] <string> [-Schema] <string> [<CommonParameters>]

Test-Json [-Path] <string> [-SchemaFile] <string> [<CommonParameters>]

Test-Json [-LiteralPath] <string> [<CommonParameters>]

Test-Json [-LiteralPath] <string> [-Schema] <string> [<CommonParameters>]

Test-Json [-LiteralPath] <string> [-SchemaFile] <string> [<CommonParameters>]

Which does introduce a Bucket 4 breaking change: https://github.com/PowerShell/PowerShell/blob/master/docs/dev-process/breaking-change-contract.md#bucket-4-clearly-non-public

But given changing parameter sets are not technically public API then it seemed fine to reorganize them to allow the new -Path parameter. If there is an easier way to do the parameter sets please let me know 😄.

PR Checklist

src/Microsoft.PowerShell.Commands.Utility/commands/utility/TestJsonCommand.cs

src/Microsoft.PowerShell.Commands.Utility/resources/TestJsonCmdletStrings.resx

test/powershell/Modules/Microsoft.PowerShell.Utility/assets/invalid_node.json

src/Microsoft.PowerShell.Commands.Utility/commands/utility/TestJsonCommand.cs

ArmaanMcleod · 2023-02-02T14:31:04Z

@iSazonov Thanks for the feedback. I've included a -LiteralPath parameter and made both path parameters use ValueFromPipelineByPropertyName. Also cleaned up the extra whitspace and generate the test json files on the fly using TestDrive:/.

Let me know what you think, I think it looks much better already 😄.

ArmaanMcleod · 2023-02-03T23:10:28Z

One strange thing I've noticed is if you do Get-ChildItem -Path '.markdownlint.json' -File | Test-Json, it will still set the path as a literal path from pipeline parameter binding.

iSazonov · 2023-02-04T09:28:42Z

One strange thing I've noticed is if you do Get-ChildItem -Path '.markdownlint.json' -File | Test-Json, it will still set the path as a literal path from pipeline parameter binding.

ValueFromPipelineByPropertyName and PSPath alias for LiteralPath work. It is expected behavior.

src/Microsoft.PowerShell.Commands.Utility/commands/utility/TestJsonCommand.cs

ArmaanMcleod · 2023-02-07T11:33:33Z

Closed and Reopened to restart CI

pull-request-quantifier · 2023-02-16T12:14:47Z

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

Quantification details

Label      : Medium
Size       : +144 -11
Percentile : 51%

Total files changed: 2

Change summary by file extension:
.cs : +59 -8
.ps1 : +85 -3

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.

daxian-dbw

LGTM. Thanks!

iSazonov · 2023-02-22T17:30:43Z

@ArmaanMcleod Thanks for your contribution!

…rShell#19042)

msftbot · 2023-03-14T22:29:07Z

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

Handy links:

Release Notes

pull-request-quantifier bot added the Medium label Jan 27, 2023

msftbot bot assigned daxian-dbw Jan 27, 2023

ArmaanMcleod marked this pull request as ready for review January 27, 2023 13:46

ArmaanMcleod requested a review from PaulHigin as a code owner January 27, 2023 13:46

ArmaanMcleod force-pushed the test-json-file-parameter branch from 69168a5 to ce486a4 Compare January 28, 2023 02:02

ArmaanMcleod changed the title ~~Add Path parameter to Test-Json~~ Add -Path parameter to Test-Json cmdlet Jan 28, 2023

iSazonov reviewed Jan 31, 2023

View reviewed changes

ArmaanMcleod commented Jan 31, 2023

View reviewed changes

src/Microsoft.PowerShell.Commands.Utility/commands/utility/TestJsonCommand.cs Outdated Show resolved Hide resolved

ArmaanMcleod marked this pull request as draft January 31, 2023 10:55

ArmaanMcleod force-pushed the test-json-file-parameter branch from a47799b to f6b9cf7 Compare January 31, 2023 11:36

ArmaanMcleod mentioned this pull request Jan 31, 2023

Test-Json : Add parameter for JSON data file #15544

Closed

ArmaanMcleod commented Jan 31, 2023

View reviewed changes

src/Microsoft.PowerShell.Commands.Utility/commands/utility/TestJsonCommand.cs Outdated Show resolved Hide resolved

ArmaanMcleod changed the title ~~Add -Path parameter to Test-Json cmdlet~~ Add -Path and -LiteralPath parameters to Test-Json cmdlet Feb 2, 2023

ArmaanMcleod force-pushed the test-json-file-parameter branch from 17bd510 to 992b89f Compare February 2, 2023 13:50

ArmaanMcleod marked this pull request as ready for review February 2, 2023 14:02

iSazonov approved these changes Feb 2, 2023

View reviewed changes

iSazonov requested a review from vexx32 February 2, 2023 17:26

ArmaanMcleod force-pushed the test-json-file-parameter branch from 8a95fb8 to 9a7582b Compare February 3, 2023 22:39

iSazonov reviewed Feb 4, 2023

View reviewed changes

src/Microsoft.PowerShell.Commands.Utility/commands/utility/TestJsonCommand.cs Outdated Show resolved Hide resolved

iSazonov added CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log WG-Cmdlets-Utility cmdlets in the Microsoft.PowerShell.Utility module labels Feb 4, 2023

ArmaanMcleod closed this Feb 7, 2023

ArmaanMcleod reopened this Feb 7, 2023

iSazonov requested a review from SteveL-MSFT February 7, 2023 11:59

ArmaanMcleod force-pushed the test-json-file-parameter branch 2 times, most recently from d2fbe31 to 707c135 Compare February 8, 2023 12:53

ArmaanMcleod added 19 commits February 16, 2023 23:02

Fix schema param in test

0cd4ee6

Remove extra whitespace

e90b3d2

Use TestDrive and remove asset files

73b1187

Remove Aggregate exception read resolved path

a153f68

Use TestDrive variable

fe29158

Adding -LiteralPath parameter

dbb2c76

Update test name and add another alias test

6501253

Setting isLiteralPath to false by default

7ac8cfd

Remove JsonFile alias

1de49ad

Add error checking for resolved path not being found

6709394

Use simpler ItemNotFoundException constructor

1200d68

Remove unnecessary exception handling

9eb1603

Check if file exists before reading

c7348e6

Remove null check since File.Exists can handle null

3189ae6

Add regions to collapse code parts

64d5c56

Updated from feedback

dc0dc9b

Undo Codefactor fix for unrelated change

a1e6d79

Remove blank line from unrelated codefactor fix

cd3c920

Exit early with WriteObject with null or whitespace json

1114dfd

ArmaanMcleod force-pushed the test-json-file-parameter branch from af3f172 to 1114dfd Compare February 16, 2023 12:03

ArmaanMcleod requested a review from daxian-dbw February 16, 2023 12:05

Remove blank line before else if

c94b462

daxian-dbw approved these changes Feb 21, 2023

View reviewed changes

daxian-dbw merged commit 0be3eea into PowerShell:master Feb 21, 2023
40 checks passed

ArmaanMcleod deleted the test-json-file-parameter branch February 21, 2023 19:55

TravisEz13 pushed a commit to TravisEz13/PowerShell that referenced this pull request Feb 22, 2023

Add -Path and -LiteralPath parameters to Test-Json cmdlet (Powe 1�7

51eeb75

…rShell#19042)

msftbot bot mentioned this pull request Mar 14, 2023

Test-Json should have a -JsonFile parameter #12882

Closed

Add `-Path` and `-LiteralPath` parameters to `Test-Json` cmdlet #19042

Add `-Path` and `-LiteralPath` parameters to `Test-Json` cmdlet #19042

ArmaanMcleod commented Jan 27, 2023 •

edited

ArmaanMcleod commented Feb 2, 2023 •

edited

ArmaanMcleod commented Feb 3, 2023

iSazonov commented Feb 4, 2023

ArmaanMcleod commented Feb 7, 2023

pull-request-quantifier bot commented Feb 16, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

daxian-dbw left a comment

iSazonov commented Feb 22, 2023

msftbot bot commented Mar 14, 2023

Add -Path and -LiteralPath parameters to Test-Json cmdlet #19042

Add -Path and -LiteralPath parameters to Test-Json cmdlet #19042

Conversation

ArmaanMcleod commented Jan 27, 2023 • edited

PR Summary

PR Context

Current Syntax

New Syntax

PR Checklist

ArmaanMcleod commented Feb 2, 2023 • edited

ArmaanMcleod commented Feb 3, 2023

iSazonov commented Feb 4, 2023

ArmaanMcleod commented Feb 7, 2023

pull-request-quantifier bot commented Feb 16, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

daxian-dbw left a comment

Choose a reason for hiding this comment

iSazonov commented Feb 22, 2023

msftbot bot commented Mar 14, 2023

Add `-Path` and `-LiteralPath` parameters to `Test-Json` cmdlet #19042

Add `-Path` and `-LiteralPath` parameters to `Test-Json` cmdlet #19042

ArmaanMcleod commented Jan 27, 2023 •

edited

ArmaanMcleod commented Feb 2, 2023 •

edited