Add Path field to SPDX Detector (#112)

Author: Jiahong Wen

src/Microsoft.ComponentDetection.Contracts/TypedComponent/SpdxComponent.cs

@@ -10,14 +10,15 @@ private SpdxComponent()
         }
 
         public SpdxComponent(string spdxVersion, Uri documentNamespace, string name, string checksum,
-            string rootElementId)
+            string rootElementId, string path)
         {
             SpdxVersion = ValidateRequiredInput(spdxVersion, nameof(SpdxVersion), nameof(ComponentType.Spdx));
             DocumentNamespace =
                 ValidateRequiredInput(documentNamespace, nameof(DocumentNamespace), nameof(ComponentType.Spdx));
             Name = ValidateRequiredInput(name, nameof(Name), nameof(ComponentType.Spdx));
             Checksum = ValidateRequiredInput(checksum, nameof(Checksum), nameof(ComponentType.Spdx));
             RootElementId = ValidateRequiredInput(rootElementId, nameof(RootElementId), nameof(ComponentType.Spdx));
+            Path = ValidateRequiredInput(path, nameof(Path), nameof(ComponentType.Spdx));
         }
 
         public override ComponentType Type => ComponentType.Spdx;
@@ -32,6 +33,8 @@ public SpdxComponent(string spdxVersion, Uri documentNamespace, string name, str
 
         public string Checksum { get; }
 
+        public string Path { get; }
+
         public override string Id => $"{Name}-{SpdxVersion}-{Checksum}";
     }
 }

src/Microsoft.ComponentDetection.Detectors/spdx/Spdx22ComponentDetector.cs

@@ -102,7 +102,8 @@ private SpdxComponent ConvertJObjectToSbomComponent(ProcessRequest processReques
             }
 
             var rootElementId = rootElements?.FirstOrDefault() ?? "SPDXRef-Document";
-            var component = new SpdxComponent(spdxVersion, new Uri(sbomNamespace), name, fileHash, rootElementId);
+            var path = processRequest.ComponentStream.Location;
+            var component = new SpdxComponent(spdxVersion, new Uri(sbomNamespace), name, fileHash, rootElementId, path);
 
             return component;
         }

test/Microsoft.ComponentDetection.Detectors.Tests/SPDX22ComponentDetectorTests.cs

@@ -20,13 +20,14 @@ namespace Microsoft.ComponentDetection.Detectors.Tests
     public class Spdx22ComponentDetectorTests
     {
         private DetectorTestUtility<Spdx22ComponentDetector> detectorTestUtility;
+        private string tempPath = Path.GetTempPath();
 
         [TestInitialize]
         public void TestInitialize()
         {
             var componentRecorder = new ComponentRecorder(enableManualTrackingOfExplicitReferences: false);
             detectorTestUtility = DetectorTestUtilityCreator.Create<Spdx22ComponentDetector>()
-                                    .WithScanRequest(new ScanRequest(new DirectoryInfo(Path.GetTempPath()), null, null, new Dictionary<string, string>(), null, componentRecorder));
+                                    .WithScanRequest(new ScanRequest(new DirectoryInfo(tempPath), null, null, new Dictionary<string, string>(), null, componentRecorder));
         }
 
         [TestMethod]
@@ -96,8 +97,9 @@ public async Task TestSbomDetector_SimpleSbom()
     ]
 }";
 
+            var spdxFileName = "manifest.spdx.json";
             var (scanResult, componentRecorder) = await detectorTestUtility
-                                                    .WithFile("manifest.spdx.json", spdxFile)
+                                                    .WithFile(spdxFileName, spdxFile)
                                                     .ExecuteDetector();
 
             Assert.AreEqual(ProcessingResultCode.Success, scanResult.ResultCode);
@@ -122,6 +124,7 @@ public async Task TestSbomDetector_SimpleSbom()
             Assert.AreEqual(sbomComponent.DocumentNamespace,  new Uri("https://sbom.microsoft/Test/1.0.0/61de1a5-57cc-4732-9af5-edb321b4a7ee"));
             Assert.AreEqual(sbomComponent.SpdxVersion, "SPDX-2.2");
             Assert.AreEqual(sbomComponent.Checksum, checksum);
+            Assert.AreEqual(sbomComponent.Path, Path.Combine(tempPath, spdxFileName));
         }
 
         [TestMethod]