Handle comments gracefully by the go fallback detector (#1027)

microsoft · Mar 14, 2024 · fb464ca · fb464ca
1 parent 0bbeeee
commit fb464ca
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 1 deletion.
diff --git a/src/Microsoft.ComponentDetection.Detectors/go/GoComponentDetector.cs b/src/Microsoft.ComponentDetection.Detectors/go/GoComponentDetector.cs
@@ -1,4 +1,4 @@
-namespace Microsoft.ComponentDetection.Detectors.Go;
+namespace Microsoft.ComponentDetection.Detectors.Go;
 
 using System;
 using System.Collections.Generic;
@@ -257,6 +257,12 @@ private async Task<bool> UseGoCliToScanAsync(string location, ISingleFileCompone
 
     private void TryRegisterDependencyFromModLine(string line, ISingleFileComponentRecorder singleFileComponentRecorder)
     {
+        if (line.Trim().StartsWith("//"))
+        {
+            // this is a comment line, ignore it
+            return;
+        }
+
         if (this.TryToCreateGoComponentFromModLine(line, out var goComponent))
         {
             singleFileComponentRecorder.RegisterUsage(new DetectedComponent(goComponent));

diff --git a/test/Microsoft.ComponentDetection.Detectors.Tests/GoComponentDetectorTests.cs b/test/Microsoft.ComponentDetection.Detectors.Tests/GoComponentDetectorTests.cs
@@ -60,6 +60,29 @@ public async Task TestGoModDetectorWithValidFile_ReturnsSuccessfullyAsync()
         discoveredComponents.Where(component => component.Component.Id == "github.com/kr/pretty v0.1.0 - Go").Should().ContainSingle();
     }
 
+    [TestMethod]
+    public async Task TestGoModDetector_CommentsOnFile_CommentsAreIgnoredAsync()
+    {
+        var goMod =
+            @"module github.com/Azure/azure-storage-blob-go
+
+require (
+    // comment
+    github.com/kr/pretty v0.1.0 // indirect
+)";
+        var (scanResult, componentRecorder) = await this.DetectorTestUtility
+            .WithFile("go.mod", goMod)
+            .ExecuteDetectorAsync();
+
+        scanResult.ResultCode.Should().Be(ProcessingResultCode.Success);
+
+        var detectedComponents = componentRecorder.GetDetectedComponents();
+        detectedComponents.Should().ContainSingle("there is only one component definition on the file");
+
+        var discoveredComponents = detectedComponents.ToArray();
+        discoveredComponents.Where(component => component.Component.Id == "github.com/kr/pretty v0.1.0 - Go").Should().ContainSingle();
+    }
+
     [TestMethod]
     public async Task TestGoSumDetectorWithValidFile_ReturnsSuccessfullyAsync()
     {