Skip to content

Fix ValidateRange Max Depth Allowed #16197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daxian-dbw merged 5 commits into from
Oct 28, 2021
Merged

Fix ValidateRange Max Depth Allowed #16197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
aba6b2e
Fix ValidateRange Max Depth Allowed
KevRitchie Oct 5, 2021
2216222
Set ValidateRange MaxDepth
KevRitchie Oct 5, 2021
e173865
Add Parameter Argument Validation Test
KevRitchie Oct 5, 2021
aaf8656
Remove Prerequisite Check
KevRitchie Oct 5, 2021
4ab6790
Remove maxDepthAllowed and MaximumAllowedDepthReached resource
KevRitchie Oct 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 2 additions & 20 deletions src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/ConvertToJsonCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,13 @@ public class ConvertToJsonCommand : PSCmdlet, IDisposable

private int _depth = 2;

private const int maxDepthAllowed = 100;

private readonly CancellationTokenSource _cancellationSource = new();

/// <summary>
/// Gets or sets the Depth property.
/// </summary>
[Parameter]
[ValidateRange(0, int.MaxValue)]
[ValidateRange(0, 100)]
public int Depth
{
get { return _depth; }
Expand Down Expand Up @@ -99,23 +97,7 @@ protected virtual void Dispose(bool disposing)
_cancellationSource.Dispose();
}
}

/// <summary>
/// Prerequisite checks.
/// </summary>
protected override void BeginProcessing()
{
if (_depth > maxDepthAllowed)
Comment thread
KevRitchie marked this conversation as resolved.
{
string errorMessage = StringUtil.Format(WebCmdletStrings.ReachedMaximumDepthAllowed, maxDepthAllowed);
Comment thread
KevRitchie marked this conversation as resolved.
ThrowTerminatingError(new ErrorRecord(
new InvalidOperationException(errorMessage),
"ReachedMaximumDepthAllowed",
ErrorCategory.InvalidOperation,
null));
}
}


private readonly List<object> _inputObjects = new();

/// <summary>
Expand Down
3 changes: 0 additions & 3 deletions src/Microsoft.PowerShell.Commands.Utility/resources/WebCmdletStrings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,9 +237,6 @@
<data name="JsonNetModuleFilesRequired" xml:space="preserve">
<value>Ensure 'Json.Net.psd1' and 'Newtonsoft.Json.dll' are available in a versioned subdirectory of '{0}'.</value>
</data>
<data name="ReachedMaximumDepthAllowed" xml:space="preserve">
<value>The maximum depth allowed for serialization is {0}.</value>
</data>
<data name="JsonDeserializationFailed" xml:space="preserve">
<value>Conversion from JSON failed with error: {0}</value>
</data>
Expand Down
4 changes: 2 additions & 2 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/Json.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1670,10 +1670,10 @@ Describe "Json Bug fixes" -Tags "Feature" {

$testCases = @(
@{
Name = "ConvertTo-Json -Depth 101 throws MaximumAllowedDepthReached when the user specifies a depth greater than 100."
Name = "ConvertTo-Json -Depth 101 throws ParameterArgumentValidationError when the user specifies a depth greater than 100."
NumberOfElements = 10
MaxDepth = 101
FullyQualifiedErrorId = "ReachedMaximumDepthAllowed,Microsoft.PowerShell.Commands.ConvertToJsonCommand"
FullyQualifiedErrorId = "ParameterArgumentValidationError,Microsoft.PowerShell.Commands.ConvertToJsonCommand"
ShouldThrow = $true
}
@{
Expand Down