feature(spdx)!: serialize referenceCategory using hyphens by default …

…so it matches SPDX 2.2.2 Signed-off-by: Wessel Terpstra <wessel@wesselterpstra.com>
CycloneDX · Nov 6, 2023 · d6a7c5e · d6a7c5e
1 parent cc41ba6
commit d6a7c5e
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 10 deletions.
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/...erters/HyphenToUnderscoreEnumConverter.cs → ...ization/Converters/HyphenEnumConverter.cs b/...erters/HyphenToUnderscoreEnumConverter.cs → ...ization/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 class HyphenToUnderscoreEnumConverter<T> : JsonConverter<T> where T: stru
             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/...zerTests.JsonAsyncRoundTripTest_document-with-hyphens-in-external-reference-category.snap b/...zerTests.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/...cloneDX.Spdx.Tests/__snapshots__/JsonSerializerTests.JsonAsyncRoundTripTest_document.snap b/...cloneDX.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/...rializerTests.JsonRoundTripTest_document-with-hyphens-in-external-reference-category.snap b/...rializerTests.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/...erializerTests.XmlRoundTripTest_document-with-hyphens-in-external-reference-category.snap b/...erializerTests.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>