Merge pull request #2060 from casz/fix/remove-json-output-formatter

asbjornu · web-flow · commit f0e5275d974d · 2020-01-24T15:34:28.000+01:00
add JSON Serializer
diff --git a/src/GitVersionCore.Tests/JsonVersionBuilderTests.cs b/src/GitVersionCore.Tests/JsonVersionBuilderTests.cs
@@ -1,7 +1,6 @@
 using System;
 using NUnit.Framework;
 using Shouldly;
-using GitVersion.OutputFormatters;
 using GitVersion.OutputVariables;
 using GitVersion;
 using GitVersionCore.Tests.Helpers;
@@ -38,7 +37,7 @@ public void Json()
 
             var variableProvider = sp.GetService<IVariableProvider>();
             var variables =  variableProvider.GetVariablesFor(semanticVersion, config, false);
-            var json = JsonOutputFormatter.ToJson(variables);
+            var json = variables.ToString();
             json.ShouldMatchApproved(c => c.SubFolder("Approved"));
         }
     }
diff --git a/src/GitVersionCore.Tests/VariableProviderTests.cs b/src/GitVersionCore.Tests/VariableProviderTests.cs
@@ -1,6 +1,5 @@
 using GitVersion;
 using GitVersion.Logging;
-using GitVersion.OutputFormatters;
 using GitVersion.OutputVariables;
 using GitVersion.VersioningModes;
 using GitVersionCore.Tests.Helpers;
@@ -74,7 +73,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForPreRelease()
 
             var vars = variableProvider.GetVariablesFor(semVer, config, false);
 
-            JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));
+            vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));
         }
 
         [Test]
@@ -101,7 +100,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForPreReleaseWithPadding()
 
             var vars = variableProvider.GetVariablesFor(semVer, config, false);
 
-            JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));
+            vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));
         }
 
         [Test]
@@ -127,7 +126,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForPreRelease()
 
             var vars = variableProvider.GetVariablesFor(semVer, config, false);
 
-            JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));
+            vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));
         }
 
         [Test]
@@ -152,7 +151,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForStable()
 
             var vars = variableProvider.GetVariablesFor(semVer, config, false);
 
-            JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));
+            vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));
         }
 
         [Test]
@@ -177,7 +176,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForStable()
 
             var vars = variableProvider.GetVariablesFor(semVer, config, false);
 
-            JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));
+            vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));
         }
 
         [Test]
@@ -205,7 +204,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForStableWhenCurrentCommi
 
             var vars = variableProvider.GetVariablesFor(semVer, config, true);
 
-            JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));
+            vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));
         }
 
         [Test]
@@ -277,7 +276,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForFeatureBranch()
 
             var vars = variableProvider.GetVariablesFor(semVer, config, false);
 
-            JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));
+            vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));
         }
 
         [Test]
@@ -304,7 +303,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForFeatureBranchWithCustomA
 
             var vars = variableProvider.GetVariablesFor(semVer, config, false);
 
-            JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));
+            vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));
         }
     }
 }
diff --git a/src/GitVersionCore/BuildServers/AppVeyor.cs b/src/GitVersionCore/BuildServers/AppVeyor.cs
@@ -3,6 +3,7 @@
 using GitVersion.OutputVariables;
 using GitVersion.Logging;
 using System.Text;
+using GitVersion.Helpers;
 
 namespace GitVersion.BuildServers
 {
@@ -22,9 +23,12 @@ public override string GenerateSetVersionMessage(VersionVariables variables)
 
             using var httpClient = GetHttpClient();
 
-            var body = $"{{\"version\":\"{variables.FullSemVer}.build.{buildNumber}\"}}";
+            var body = new
+            {
+                version = $"{variables.FullSemVer}.build.{buildNumber}",
+            };
 
-            var stringContent = new StringContent(body, Encoding.UTF8, "application/json");
+            var stringContent = new StringContent(JsonSerializer.Serialize(body), Encoding.UTF8, "application/json");
             var response = httpClient.PutAsync("api/build", stringContent).GetAwaiter().GetResult();
             response.EnsureSuccessStatusCode();
 
@@ -35,9 +39,13 @@ public override string[] GenerateSetParameterMessage(string name, string value)
         {
             var httpClient = GetHttpClient();
 
-            var body = $"{{\"name\": \"GitVersion_{name}\",\"value\": \"{value}\"}}";
+            var body = new
+            {
+                name = $"GitVersion_{name}",
+                value = $"{value}"
+            };
 
-            var stringContent = new StringContent(body, Encoding.UTF8, "application/json");
+            var stringContent = new StringContent(JsonSerializer.Serialize(body), Encoding.UTF8, "application/json");
             var response = httpClient.PostAsync("api/build/variables", stringContent).GetAwaiter().GetResult();
             response.EnsureSuccessStatusCode();
 
diff --git a/src/GitVersionCore/Extensions/ObjectExtensions.cs b/src/GitVersionCore/Extensions/ObjectExtensions.cs
@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace GitVersion.Extensions
+{
+    public static class ObjectExtensions
+    {
+        internal sealed class ReflectionIgnoreAttribute : Attribute
+        {
+        }
+
+        public static void Deconstruct<TKey, TValue>(
+            this KeyValuePair<TKey, TValue> kvp,
+            out TKey key,
+            out TValue value)
+        {
+            key = kvp.Key;
+            value = kvp.Value;
+        }
+
+        public static IEnumerable<KeyValuePair<string, string>> GetProperties(this object obj)
+        {
+            var type = typeof(string);
+            return obj.GetType().GetProperties()
+                .Where(p => p.PropertyType == type && !p.GetIndexParameters().Any() && !p.GetCustomAttributes(typeof(ReflectionIgnoreAttribute), false).Any())
+                .Select(p => new KeyValuePair<string, string>(p.Name, (string) p.GetValue(obj, null)));
+        }
+    }
+}
diff --git a/src/GitVersionCore/Helpers/JsonSerializer.cs b/src/GitVersionCore/Helpers/JsonSerializer.cs
@@ -0,0 +1,33 @@
+using System.Text;
+using GitVersion.Extensions;
+
+namespace GitVersion.Helpers
+{
+    public static class JsonSerializer
+    {
+        public static string Serialize(object obj)
+        {
+            var builder = new StringBuilder();
+            builder.AppendLine("{");
+            var first = true;
+            foreach (var (key, value) in obj.GetProperties())
+            {
+                if (!first) builder.AppendLine(",");
+                else first = false;
+
+                builder.Append($"  \"{key}\":");
+
+                // preserve leading zeros for padding
+                if (NotAPaddedNumber(value) && int.TryParse(value, out var number))
+                    builder.Append(number);
+                else
+                    builder.Append($"\"{value}\"");
+            }
+
+            builder.AppendLine().Append("}");
+            return builder.ToString();
+        }
+
+        private static bool NotAPaddedNumber(string value) => value != null && (value == "0" || !value.StartsWith("0"));
+    }
+}
diff --git a/src/GitVersionCore/OutputFormatters/JsonOutputFormatter.cs b/src/GitVersionCore/OutputFormatters/JsonOutputFormatter.cs
diff --git a/src/GitVersionCore/OutputVariables/VersionVariables.cs b/src/GitVersionCore/OutputVariables/VersionVariables.cs
@@ -3,7 +3,9 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using GitVersion.Helpers;
 using YamlDotNet.Serialization;
+using static GitVersion.Extensions.ObjectExtensions;
 
 namespace GitVersion.OutputVariables
 {
@@ -125,12 +127,7 @@ public static IEnumerable<string> AvailableVariables
 
         public IEnumerator<KeyValuePair<string, string>> GetEnumerator()
         {
-            var type = typeof(string);
-            return typeof(VersionVariables)
-                .GetProperties()
-                .Where(p => p.PropertyType == type && !p.GetIndexParameters().Any() && !p.GetCustomAttributes(typeof(ReflectionIgnoreAttribute), false).Any())
-                .Select(p => new KeyValuePair<string, string>(p.Name, (string)p.GetValue(this, null)))
-                .GetEnumerator();
+            return this.GetProperties().GetEnumerator();
         }
 
         IEnumerator IEnumerable.GetEnumerator()
@@ -178,8 +175,9 @@ public bool ContainsKey(string variable)
             return typeof(VersionVariables).GetProperty(variable) != null;
         }
 
-        private sealed class ReflectionIgnoreAttribute : Attribute
+        public override string ToString()
         {
+            return JsonSerializer.Serialize(this);
         }
     }
 }
diff --git a/src/GitVersionExe/ExecCommand.cs b/src/GitVersionExe/ExecCommand.cs
@@ -54,7 +54,7 @@ public void Execute()
                     switch (arguments.ShowVariable)
                     {
                         case null:
-                            Console.WriteLine(JsonOutputFormatter.ToJson(variables));
+                            Console.WriteLine(variables.ToString());
                             break;
 
                         default:

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`using GitVersion;`
`2`	`2`	`using GitVersion.Logging;`
`3`		`-using GitVersion.OutputFormatters;`
`4`	`3`	`using GitVersion.OutputVariables;`
`5`	`4`	`using GitVersion.VersioningModes;`
`6`	`5`	`using GitVersionCore.Tests.Helpers;`
`@@ -74,7 +73,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForPreRelease()`
`74`	`73`
`75`	`74`	`var vars = variableProvider.GetVariablesFor(semVer, config, false);`
`76`	`75`
`77`		`- JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`76`	`+ vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`78`	`77`	`}`
`79`	`78`
`80`	`79`	`[Test]`
`@@ -101,7 +100,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForPreReleaseWithPadding()`
`101`	`100`
`102`	`101`	`var vars = variableProvider.GetVariablesFor(semVer, config, false);`
`103`	`102`
`104`		`- JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`103`	`+ vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`105`	`104`	`}`
`106`	`105`
`107`	`106`	`[Test]`
`@@ -127,7 +126,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForPreRelease()`
`127`	`126`
`128`	`127`	`var vars = variableProvider.GetVariablesFor(semVer, config, false);`
`129`	`128`
`130`		`- JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`129`	`+ vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`131`	`130`	`}`
`132`	`131`
`133`	`132`	`[Test]`
`@@ -152,7 +151,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForStable()`
`152`	`151`
`153`	`152`	`var vars = variableProvider.GetVariablesFor(semVer, config, false);`
`154`	`153`
`155`		`- JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`154`	`+ vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`156`	`155`	`}`
`157`	`156`
`158`	`157`	`[Test]`
`@@ -177,7 +176,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForStable()`
`177`	`176`
`178`	`177`	`var vars = variableProvider.GetVariablesFor(semVer, config, false);`
`179`	`178`
`180`		`- JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`179`	`+ vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`181`	`180`	`}`
`182`	`181`
`183`	`182`	`[Test]`
`@@ -205,7 +204,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForStableWhenCurrentCommi`
`205`	`204`
`206`	`205`	`var vars = variableProvider.GetVariablesFor(semVer, config, true);`
`207`	`206`
`208`		`- JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`207`	`+ vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`209`	`208`	`}`
`210`	`209`
`211`	`210`	`[Test]`
`@@ -277,7 +276,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForFeatureBranch()`
`277`	`276`
`278`	`277`	`var vars = variableProvider.GetVariablesFor(semVer, config, false);`
`279`	`278`
`280`		`- JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`279`	`+ vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`281`	`280`	`}`
`282`	`281`
`283`	`282`	`[Test]`
`@@ -304,7 +303,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForFeatureBranchWithCustomA`
`304`	`303`
`305`	`304`	`var vars = variableProvider.GetVariablesFor(semVer, config, false);`
`306`	`305`
`307`		`- JsonOutputFormatter.ToJson(vars).ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`306`	`+ vars.ToString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`308`	`307`	`}`
`309`	`308`	`}`
`310`	`309`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,9 @@`
`3`	`3`	`using System.Collections.Generic;`
`4`	`4`	`using System.IO;`
`5`	`5`	`using System.Linq;`
	`6`	`+using GitVersion.Helpers;`
`6`	`7`	`using YamlDotNet.Serialization;`
	`8`	`+using static GitVersion.Extensions.ObjectExtensions;`
`7`	`9`
`8`	`10`	`namespace GitVersion.OutputVariables`
`9`	`11`	`{`
`@@ -125,12 +127,7 @@ public static IEnumerable<string> AvailableVariables`
`125`	`127`
`126`	`128`	`public IEnumerator<KeyValuePair<string, string>> GetEnumerator()`
`127`	`129`	`{`
`128`		`- var type = typeof(string);`
`129`		`- return typeof(VersionVariables)`
`130`		`- .GetProperties()`
`131`		`- .Where(p => p.PropertyType == type && !p.GetIndexParameters().Any() && !p.GetCustomAttributes(typeof(ReflectionIgnoreAttribute), false).Any())`
`132`		`- .Select(p => new KeyValuePair<string, string>(p.Name, (string)p.GetValue(this, null)))`
`133`		`- .GetEnumerator();`
	`130`	`+ return this.GetProperties().GetEnumerator();`
`134`	`131`	`}`
`135`	`132`
`136`	`133`	`IEnumerator IEnumerable.GetEnumerator()`
`@@ -178,8 +175,9 @@ public bool ContainsKey(string variable)`
`178`	`175`	`return typeof(VersionVariables).GetProperty(variable) != null;`
`179`	`176`	`}`
`180`	`177`
`181`		`- private sealed class ReflectionIgnoreAttribute : Attribute`
	`178`	`+ public override string ToString()`
`182`	`179`	`{`
	`180`	`+ return JsonSerializer.Serialize(this);`
`183`	`181`	`}`
`184`	`182`	`}`
`185`	`183`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public void Execute()`
`54`	`54`	`switch (arguments.ShowVariable)`
`55`	`55`	`{`
`56`	`56`	`case null:`
`57`		`- Console.WriteLine(JsonOutputFormatter.ToJson(variables));`
	`57`	`+ Console.WriteLine(variables.ToString());`
`58`	`58`	`break;`
`59`	`59`
`60`	`60`	`default:`