feature(spdx)!: serialize referenceCategory using hyphens by default so it matches SPDX 2.2.2

wterpstra · wterpstra · commit 5f9214d242b2 · 2023-11-06T14:05:19.000+01:00
Signed-off-by: Wessel Terpstra &lt;wessel@wesselterpstra.com&gt;
diff --git a/src/CycloneDX.Spdx/Models/v2_2/ExternalRef.cs b/src/CycloneDX.Spdx/Models/v2_2/ExternalRef.cs
@@ -16,6 +16,8 @@
 // Copyright (c) OWASP Foundation. All Rights Reserved.
 
 using System;
+using System.Reflection;
+using System.Runtime.Serialization;
 using System.Text.Json.Serialization;
 using System.Xml.Serialization;
 
@@ -39,7 +41,16 @@ public class ExternalRef
         [JsonIgnore]
         public string ReferenceCategoryAsString
         {
-            get => ReferenceCategory.ToString();
+            get
+            {
+                switch (ReferenceCategory)
+                {
+                    case ExternalRefCategory.PACKAGE_MANAGER:
+                        return "PACKAGE-MANAGER";
+                    default:
+                        return ReferenceCategory.ToString();
+                }
+            }
             set
             {
                 switch (value.ToUpperInvariant())
diff --git a/src/CycloneDX.Spdx/Models/v2_2/ExternalRefCategory.cs b/src/CycloneDX.Spdx/Models/v2_2/ExternalRefCategory.cs
@@ -16,13 +16,15 @@
 // Copyright (c) OWASP Foundation. All Rights Reserved.
 
 using System;
+using System.Runtime.Serialization;
 
 namespace CycloneDX.Spdx.Models.v2_2
 {
     public enum ExternalRefCategory
     {
         OTHER,
         SECURITY,
+        [EnumMember(Value = "PACKAGE-MANAGER")]
         PACKAGE_MANAGER,
     }
 }
diff --git a/src/CycloneDX.Spdx/Serialization/Converters/HyphenEnumConverter.cs b/src/CycloneDX.Spdx/Serialization/Converters/HyphenEnumConverter.cs
@@ -23,7 +23,7 @@
 namespace CycloneDX.Spdx.Serialization.Converters
 {
 
-    public class HyphenToUnderscoreEnumConverter<T> : JsonConverter<T> where T: struct
+    public class HyphenEnumConverter<T> : JsonConverter<T> where T: struct
     {
         public override T Read(
             ref Utf8JsonReader reader,
@@ -56,7 +56,7 @@ public override void Write(
             JsonSerializerOptions options)
         {
             Contract.Requires(writer != null);
-            writer.WriteStringValue(value.ToString());
+            writer.WriteStringValue(value.ToString().Replace('_', '-'));
         }
     }
 }
diff --git a/src/CycloneDX.Spdx/Serialization/JsonSerializer.cs b/src/CycloneDX.Spdx/Serialization/JsonSerializer.cs
@@ -40,7 +40,7 @@ public static JsonSerializerOptions GetJsonSerializerOptions_v2_2()
                 PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
                 DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
             };
-            options.Converters.Add(new HyphenToUnderscoreEnumConverter<ExternalRefCategory>());
+            options.Converters.Add(new HyphenEnumConverter<ExternalRefCategory>());
             options.Converters.Add(new JsonStringEnumConverter());
             return options;
         }
diff --git a/tests/CycloneDX.Spdx.Tests/CycloneDX.Spdx.Tests.csproj b/tests/CycloneDX.Spdx.Tests/CycloneDX.Spdx.Tests.csproj
@@ -33,4 +33,8 @@
     <ProjectReference Include="..\..\src\CycloneDX.Spdx\CycloneDX.Spdx.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Folder Include="__snapshots__\" />
+  </ItemGroup>
+
 </Project>
diff --git a/tests/CycloneDX.Spdx.Tests/__snapshots__/JsonSerializerTests.JsonAsyncRoundTripTest_document-with-hyphens-in-external-reference-category.snap b/tests/CycloneDX.Spdx.Tests/__snapshots__/JsonSerializerTests.JsonAsyncRoundTripTest_document-with-hyphens-in-external-reference-category.snap
@@ -171,7 +171,7 @@
       "downloadLocation": "https://search.maven.org/remotecontent?filepath=org/apache/jena/apache-jena/3.12.0/apache-jena-3.12.0.tar.gz",
       "externalRefs": [
         {
-          "referenceCategory": "PACKAGE_MANAGER",
+          "referenceCategory": "PACKAGE-MANAGER",
           "referenceLocator": "pkg:maven/org.apache.jena/apache-jena@3.12.0",
           "referenceType": "purl"
         }
diff --git a/tests/CycloneDX.Spdx.Tests/__snapshots__/JsonSerializerTests.JsonAsyncRoundTripTest_document.snap b/tests/CycloneDX.Spdx.Tests/__snapshots__/JsonSerializerTests.JsonAsyncRoundTripTest_document.snap
@@ -171,7 +171,7 @@
       "downloadLocation": "https://search.maven.org/remotecontent?filepath=org/apache/jena/apache-jena/3.12.0/apache-jena-3.12.0.tar.gz",
       "externalRefs": [
         {
-          "referenceCategory": "PACKAGE_MANAGER",
+          "referenceCategory": "PACKAGE-MANAGER",
           "referenceLocator": "pkg:maven/org.apache.jena/apache-jena@3.12.0",
           "referenceType": "purl"
         }
diff --git a/tests/CycloneDX.Spdx.Tests/__snapshots__/JsonSerializerTests.JsonRoundTripTest_document-with-hyphens-in-external-reference-category.snap b/tests/CycloneDX.Spdx.Tests/__snapshots__/JsonSerializerTests.JsonRoundTripTest_document-with-hyphens-in-external-reference-category.snap
@@ -171,7 +171,7 @@
       "downloadLocation": "https://search.maven.org/remotecontent?filepath=org/apache/jena/apache-jena/3.12.0/apache-jena-3.12.0.tar.gz",
       "externalRefs": [
         {
-          "referenceCategory": "PACKAGE_MANAGER",
+          "referenceCategory": "PACKAGE-MANAGER",
           "referenceLocator": "pkg:maven/org.apache.jena/apache-jena@3.12.0",
           "referenceType": "purl"
         }
diff --git a/tests/CycloneDX.Spdx.Tests/__snapshots__/JsonSerializerTests.JsonRoundTripTest_document.snap b/tests/CycloneDX.Spdx.Tests/__snapshots__/JsonSerializerTests.JsonRoundTripTest_document.snap
@@ -171,7 +171,7 @@
       "downloadLocation": "https://search.maven.org/remotecontent?filepath=org/apache/jena/apache-jena/3.12.0/apache-jena-3.12.0.tar.gz",
       "externalRefs": [
         {
-          "referenceCategory": "PACKAGE_MANAGER",
+          "referenceCategory": "PACKAGE-MANAGER",
           "referenceLocator": "pkg:maven/org.apache.jena/apache-jena@3.12.0",
           "referenceType": "purl"
         }
diff --git a/tests/CycloneDX.Spdx.Tests/__snapshots__/XmlSerializerTests.XmlRoundTripTest_document-with-hyphens-in-external-reference-category.snap b/tests/CycloneDX.Spdx.Tests/__snapshots__/XmlSerializerTests.XmlRoundTripTest_document-with-hyphens-in-external-reference-category.snap
@@ -267,7 +267,7 @@
     <copyrightText>NOASSERTION</copyrightText>
     <downloadLocation>https://search.maven.org/remotecontent?filepath=org/apache/jena/apache-jena/3.12.0/apache-jena-3.12.0.tar.gz</downloadLocation>
     <externalRefs>
-      <referenceCategory>PACKAGE_MANAGER</referenceCategory>
+      <referenceCategory>PACKAGE-MANAGER</referenceCategory>
       <referenceLocator>pkg:maven/org.apache.jena/apache-jena@3.12.0</referenceLocator>
       <referenceType>purl</referenceType>
     </externalRefs>
diff --git a/tests/CycloneDX.Spdx.Tests/__snapshots__/XmlSerializerTests.XmlRoundTripTest_document.snap b/tests/CycloneDX.Spdx.Tests/__snapshots__/XmlSerializerTests.XmlRoundTripTest_document.snap
@@ -267,7 +267,7 @@
     <copyrightText>NOASSERTION</copyrightText>
     <downloadLocation>https://search.maven.org/remotecontent?filepath=org/apache/jena/apache-jena/3.12.0/apache-jena-3.12.0.tar.gz</downloadLocation>
     <externalRefs>
-      <referenceCategory>PACKAGE_MANAGER</referenceCategory>
+      <referenceCategory>PACKAGE-MANAGER</referenceCategory>
       <referenceLocator>pkg:maven/org.apache.jena/apache-jena@3.12.0</referenceLocator>
       <referenceType>purl</referenceType>
     </externalRefs>

Original file line number	Diff line number	Diff line change
`@@ -16,13 +16,15 @@`
`16`	`16`	`// Copyright (c) OWASP Foundation. All Rights Reserved.`
`17`	`17`
`18`	`18`	`using System;`
	`19`	`+using System.Runtime.Serialization;`
`19`	`20`
`20`	`21`	`namespace CycloneDX.Spdx.Models.v2_2`
`21`	`22`	`{`
`22`	`23`	`public enum ExternalRefCategory`
`23`	`24`	`{`
`24`	`25`	`OTHER,`
`25`	`26`	`SECURITY,`
	`27`	`+ [EnumMember(Value = "PACKAGE-MANAGER")]`
`26`	`28`	`PACKAGE_MANAGER,`
`27`	`29`	`}`
`28`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`namespace CycloneDX.Spdx.Serialization.Converters`
`24`	`24`	`{`
`25`	`25`
`26`		`- public class HyphenToUnderscoreEnumConverter<T> : JsonConverter<T> where T: struct`
	`26`	`+ public class HyphenEnumConverter<T> : JsonConverter<T> where T: struct`
`27`	`27`	`{`
`28`	`28`	`public override T Read(`
`29`	`29`	`ref Utf8JsonReader reader,`
`@@ -56,7 +56,7 @@ public override void Write(`
`56`	`56`	`JsonSerializerOptions options)`
`57`	`57`	`{`
`58`	`58`	`Contract.Requires(writer != null);`
`59`		`- writer.WriteStringValue(value.ToString());`
	`59`	`+ writer.WriteStringValue(value.ToString().Replace('_', '-'));`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public static JsonSerializerOptions GetJsonSerializerOptions_v2_2()`
`40`	`40`	`PropertyNamingPolicy = JsonNamingPolicy.CamelCase,`
`41`	`41`	`DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,`
`42`	`42`	`};`
`43`		`- options.Converters.Add(new HyphenToUnderscoreEnumConverter<ExternalRefCategory>());`
	`43`	`+ options.Converters.Add(new HyphenEnumConverter<ExternalRefCategory>());`
`44`	`44`	`options.Converters.Add(new JsonStringEnumConverter());`
`45`	`45`	`return options;`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,7 @@`
`171`	`171`	`"downloadLocation": "https://search.maven.org/remotecontent?filepath=org/apache/jena/apache-jena/3.12.0/apache-jena-3.12.0.tar.gz",`
`172`	`172`	`"externalRefs": [`
`173`	`173`	`{`
`174`		`- "referenceCategory": "PACKAGE_MANAGER",`
	`174`	`+ "referenceCategory": "PACKAGE-MANAGER",`
`175`	`175`	`"referenceLocator": "pkg:maven/org.apache.jena/apache-jena@3.12.0",`
`176`	`176`	`"referenceType": "purl"`
`177`	`177`	`}`