Add spdx reference type PERSISTENT_ID Signed-off-by: Carolina Oliveir…

…a <[email protected]> Signed-off-by: Carolina Oliveira <[email protected]>
CycloneDX · Sep 9, 2024 · 4075c25 · 4075c25
1 parent 4ff6d8d
commit 4075c25
Show file tree

Hide file tree

Showing 9 changed files with 228 additions and 70 deletions.
diff --git a/src/CycloneDX.Spdx.Interop/Converters/v2_3/Helpers/Component/ExternalRefs.cs b/src/CycloneDX.Spdx.Interop/Converters/v2_3/Helpers/Component/ExternalRefs.cs
@@ -71,15 +71,14 @@ public static List<ExternalRef> GetSpdxExternalRefs(this Component component)
                             extRef.ReferenceCategory = ExternalRefCategory.PACKAGE_MANAGER;
                             extRef.ReferenceType = "purl";
                             break;
+                        case PropertyTaxonomy.EXTERNAL_REFERENCE_PERSISTENT_ID_SWH:
+                             extRef.ReferenceCategory = ExternalRefCategory.PERSISTENT_ID;
+                             extRef.ReferenceType = "swh";
+                             break;
                         default:
                             break;
                     }
-                    //TODO add this back in once the SPDX JSON schema is fixed https://github.com/spdx/spdx-spec/issues/612
                     //TODO and write corresponding code in AddExternalRefsToCDX
-                    // case PropertyTaxonomy.EXTERNAL_REFERENCE_PERSISTENT_ID_SWH:
-                    //     extRef.ReferenceCategory = ExternalRefCategory.PERSISTENT_ID;
-                    //     extRef.ReferenceType = "swh";
-                    //     break;
                 }
                 if (extRef.ReferenceType != null)
                 {
@@ -131,6 +130,7 @@ public static void AddSpdxExternalRefs(this Component component, List<ExternalRe
                                 break;
                         }
                     }
+                    else if (extRef.ReferenceCategory == ExternalRefCategory.PERSISTENT_ID) { refPropName = PropertyTaxonomy.EXTERNAL_REFERENCE_PERSISTENT_ID_SWH; }
                     else if (extRef.ReferenceCategory == ExternalRefCategory.OTHER)
                     {
                         refPropName = $"{PropertyTaxonomy.EXTERNAL_REFERENCE_OTHER}:{extRef.ReferenceType}";

diff --git a/src/CycloneDX.Spdx/Models/v2_3/ExternalRefCategory.cs b/src/CycloneDX.Spdx/Models/v2_3/ExternalRefCategory.cs
@@ -27,5 +27,7 @@ public enum ExternalRefCategory
         SECURITY,
         [XmlEnum("PACKAGE-MANAGER")]
         PACKAGE_MANAGER,
+        [XmlEnum("PERSISTENT-ID")]
+        PERSISTENT_ID,
     }
 }
diff --git a/tests/CycloneDX.Spdx.Interop.Tests/Resources/Spdx/v2.3/document.json b/tests/CycloneDX.Spdx.Interop.Tests/Resources/Spdx/v2.3/document.json
@@ -122,7 +122,7 @@
         },
         {
           "comment": "This is the external ref for Acme",
-          "referenceCategory": "OTHER",
+          "referenceCategory": "PERSISTENT_ID",
           "referenceLocator": "acmecorp/acmenator/4.1.3-alpha",
           "referenceType": "http://spdx.org/spdxdocs/spdx-example-444504E0-4F89-41D3-9A0C-0305E82C3301#LocationRef-acmeforge"
         }

diff --git a/...CycloneDX.Spdx.Interop.Tests/__snapshots__/ConverterTests.FromSpdxToCDXTest_document.snap b/...CycloneDX.Spdx.Interop.Tests/__snapshots__/ConverterTests.FromSpdxToCDXTest_document.snap
@@ -189,7 +189,7 @@
           "value": "cpe:2.3:a:pivotal_software:spring_framework:4.1.0:*:*:*:*:*:*:*"
         },
         {
-          "name": "spdx:external-reference:other:http://spdx.org/spdxdocs/spdx-example-444504E0-4F89-41D3-9A0C-0305E82C3301#LocationRef-acmeforge",
+          "name": "spdx:external-reference:persistent-id:swh",
           "value": "acmecorp/acmenator/4.1.3-alpha This is the external ref for Acme"
         },
         {

diff --git a/...Interop.Tests/__snapshots__/ConverterTests.FromSpdxToCDXToSpdxRoundTripTest_document.snap b/...Interop.Tests/__snapshots__/ConverterTests.FromSpdxToCDXToSpdxRoundTripTest_document.snap
@@ -99,9 +99,9 @@
         },
         {
           "comment": "This is the external ref for Acme",
-          "referenceCategory": "OTHER",
+          "referenceCategory": "PERSISTENT_ID",
           "referenceLocator": "acmecorp/acmenator/4.1.3-alpha",
-          "referenceType": "http://spdx.org/spdxdocs/spdx-example-444504E0-4F89-41D3-9A0C-0305E82C3301#LocationRef-acmeforge"
+          "referenceType": "swh"
         }
       ],
       "filesAnalyzed": true,

diff --git a/tests/CycloneDX.Spdx.Tests/CycloneDX.Spdx.Tests.csproj b/tests/CycloneDX.Spdx.Tests/CycloneDX.Spdx.Tests.csproj
@@ -27,6 +27,8 @@
 
   <ItemGroup>
     <None Remove="Resources\v2.3\document.xml" />
+    <None Remove="__snapshots__\JsonSerializerTests.JsonAsyncRoundTripTest_document.snap" />
+    <None Remove="__snapshots__\JsonSerializerTests.JsonRoundTripTest_document.snap" />
     <None Remove="__snapshots__\XmlSerializerTests.XmlRoundTripTest_document.snap" />
   </ItemGroup>
 
@@ -44,4 +46,16 @@
     <Folder Include="__snapshots__\__mismatch__\" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Content Update="__snapshots__\JsonSerializerTests.JsonAsyncRoundTripTest_document.snap">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
+
+  <ItemGroup>
+    <Content Update="__snapshots__\JsonSerializerTests.JsonRoundTripTest_document.snap">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
+
 </Project>
diff --git a/tests/CycloneDX.Spdx.Tests/Resources/v2.3/document.json b/tests/CycloneDX.Spdx.Tests/Resources/v2.3/document.json
@@ -112,7 +112,7 @@
         },
         {
           "comment": "This is the external ref for Acme",
-          "referenceCategory": "OTHER",
+          "referenceCategory": "PERSISTENT_ID",
           "referenceLocator": "acmecorp/acmenator/4.1.3-alpha",
           "referenceType": "http://spdx.org/spdxdocs/spdx-example-444504E0-4F89-41D3-9A0C-0305E82C3301#LocationRef-acmeforge"
         }