Skip to content

Added support for converting enums as strings in JSON #4318

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
mirichmo merged 2 commits into from
Aug 16, 2017
Merged

Added support for converting enums as strings in JSON #4318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b13251
converting enums as strings support
KirkMunro Jul 21, 2017
e3d7e1f
removed !CORECLR code per @SteveL-MSFT's request
KirkMunro Aug 1, 2017
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
14 changes: 14 additions & 0 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 @@ -14,6 +14,7 @@
using System.Management.Automation.Internal;
#if CORECLR
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
#else
using System.Collections.Specialized;
using System.Web.Script.Serialization;
Expand Down Expand Up @@ -60,6 +61,15 @@ public class ConvertToJsonCommand : PSCmdlet
[Parameter]
public SwitchParameter Compress { get; set; }

/// <summary>
/// gets or sets the EnumsAsStrings property.
Copy link
Collaborator

@iSazonov iSazonov Aug 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please correct typo gets -> Gets.

/// If the EnumsAsStrings property is set to true, enum values will
/// be converted to their string equivalent. Otherwise, enum values
/// will be converted to their numeric equivalent.
/// </summary>
[Parameter()]
public SwitchParameter EnumsAsStrings { get; set; }

#endregion parameters

#region overrides
Expand Down Expand Up @@ -122,6 +132,10 @@ protected override void EndProcessing()
object preprocessedObject = ProcessValue(objectToProcess, 0);
#if CORECLR
JsonSerializerSettings jsonSettings = new JsonSerializerSettings { TypeNameHandling = TypeNameHandling.None, MaxDepth = 1024 };
if (EnumsAsStrings)
{
jsonSettings.Converters.Add(new StringEnumConverter());
}
if (!Compress)
{
jsonSettings.Formatting = Formatting.Indented;
Expand Down
25 changes: 21 additions & 4 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/Pester.Commands.Cmdlets.Json.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,23 @@ Describe "Json Tests" -Tags "Feature" {
$emptyStringResult = ConvertFrom-Json ""
$emptyStringResult | Should Be $null
}

It "Convert enumerated values to Json" {

$sampleObject = [pscustomobject]@{
PSTypeName = 'Test.EnumSample'
SampleSimpleEnum = [System.Management.Automation.ActionPreference]::Ignore
SampleBitwiseEnum = [System.Management.Automation.CommandTypes]'Alias,Function,Cmdlet'
}

$response4 = ConvertTo-Json -InputObject $sampleObject -Compress
$response4 | Should Be '{"SampleSimpleEnum":4,"SampleBitwiseEnum":11}'

$response4 = ConvertTo-Json -InputObject $sampleObject -Compress -EnumsAsStrings
$response4 | Should Be '{"SampleSimpleEnum":"Ignore","SampleBitwiseEnum":"Alias, Function, Cmdlet"}'

Copy link
Collaborator

@iSazonov iSazonov Aug 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove extra line.

}

Copy link
Collaborator

@iSazonov iSazonov Aug 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove extra line.

}

Context "JsonObject Tests" {
Expand Down Expand Up @@ -1458,9 +1475,9 @@ Describe "Json Bug fixes" -Tags "Feature" {
It "ConvertFrom-Json deserializes an array of PSObjects (in multiple lines) as a single string." {

# Create an array of PSCustomObjects, and serialize it
$array = [pscustomobject]@{ objectName = "object1Name"; objectValue = "object1Value" },
[pscustomobject]@{ objectName = "object2Name"; objectValue = "object2Value" }
$array = [pscustomobject]@{ objectName = "object1Name"; objectValue = "object1Value" },
Copy link
Contributor

@dantraMSFT dantraMSFT Jul 25, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unintended whitespace change?

Copy link
Contributor Author

@KirkMunro KirkMunro Jul 28, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. But I believe this is because the source newlines were inconsistent. I didn't apply any changes here nor in the next one. IMHO better for newlines to be consistent than to have to manually reset them when tooling does the right thing.

[pscustomobject]@{ objectName = "object2Name"; objectValue = "object2Value" }

# Serialize the array to a text file
$filePath = Join-Path $TESTDRIVE test.json
$array | ConvertTo-Json | Out-File $filePath -Encoding utf8
Expand All @@ -1472,7 +1489,7 @@ Describe "Json Bug fixes" -Tags "Feature" {

It "ConvertFrom-Json deserializes an array of strings (in multiple lines) as a single string." {

$result = "[1,","2,","3]" | ConvertFrom-Json
$result = "[1,","2,","3]" | ConvertFrom-Json
Copy link
Contributor

@dantraMSFT dantraMSFT Jul 25, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unintended whitespace change?

Copy link
Contributor Author

@KirkMunro KirkMunro Aug 1, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same reply as above. I did not make these changes, and believe them to be due to inconsistent newlines. My recommendation is to accept the change to make newlines consistent so that future changes in this file don't run into the same issue.

$result.Count | Should be 3
}
}