Fixed Go117 detector (#1361)

Author: jcfiorenzano

src/Microsoft.ComponentDetection.Detectors/go/Go117ComponentDetector.cs

@@ -157,21 +157,35 @@ private async Task<bool> ShouldRunGoGraphAsync()
 
     private async Task<Version> GetGoVersionAsync()
     {
-        var processExecution = await this.commandLineInvocationService.ExecuteCommandAsync("go", null, null, cancellationToken: default, new List<string> { "version" }.ToArray());
-        if (processExecution.ExitCode != 0)
+        try
         {
-            return null;
-        }
+            var isGoAvailable = await this.commandLineInvocationService.CanCommandBeLocatedAsync("go", null, null, new List<string> { "version" }.ToArray());
+            if (!isGoAvailable)
+            {
+                this.Logger.LogInformation("Go CLI was not found in the system");
+                return null;
+            }
 
-        // Define the regular expression pattern to match the version number
-        var versionPattern = @"go version go(\d+\.\d+\.\d+)";
-        var match = Regex.Match(processExecution.StdOut, versionPattern);
+            var processExecution = await this.commandLineInvocationService.ExecuteCommandAsync("go", null, null, cancellationToken: default, new List<string> { "version" }.ToArray());
+            if (processExecution.ExitCode != 0)
+            {
+                return null;
+            }
 
-        if (match.Success)
+            // Define the regular expression pattern to match the version number
+            var versionPattern = @"go version go(\d+\.\d+\.\d+)";
+            var match = Regex.Match(processExecution.StdOut, versionPattern);
+
+            if (match.Success)
+            {
+                // Extract the version number from the match
+                var versionStr = match.Groups[1].Value;
+                return new Version(versionStr);
+            }
+        }
+        catch (Exception e)
         {
-            // Extract the version number from the match
-            var versionStr = match.Groups[1].Value;
-            return new Version(versionStr);
+            this.Logger.LogWarning("Failed to get go version: {Exception}", e);
         }
 
         return null;

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

@@ -51,6 +51,9 @@ public async Task Go117ModDetector_GoCliIs1_11OrGreater_GoGraphIsExecutedAsync()
     {
         var goMod = string.Empty;
 
+        this.commandLineMock.Setup(x => x.CanCommandBeLocatedAsync("go", null, null, It.Is<string[]>(p => p.SequenceEqual(new List<string> { "version" }.ToArray()))))
+        .ReturnsAsync(true);
+
         this.commandLineMock.Setup(x => x.ExecuteCommandAsync("go", null, null, default, It.Is<string[]>(p => p.SequenceEqual(new List<string> { "version" }.ToArray()))))
         .ReturnsAsync(new CommandLineExecutionResult
         {
@@ -85,6 +88,9 @@ public async Task Go117ModDetector_GoCliIs111OrLessThan1_11_GoGraphIsNotExecuted
     {
         var goMod = string.Empty;
 
+        this.commandLineMock.Setup(x => x.CanCommandBeLocatedAsync("go", null, null, It.Is<string[]>(p => p.SequenceEqual(new List<string> { "version" }.ToArray()))))
+        .ReturnsAsync(true);
+
         this.commandLineMock.Setup(x => x.ExecuteCommandAsync("go", null, null, default, It.Is<string[]>(p => p.SequenceEqual(new List<string> { "version" }.ToArray()))))
         .ReturnsAsync(new CommandLineExecutionResult
         {
@@ -114,6 +120,9 @@ public async Task Go117ModDetector_GoModFileFound_GoModParserIsExecuted()
         var goModParserMock = new Mock<IGoParser>();
         this.mockParserFactory.Setup(x => x.CreateParser(GoParserType.GoMod, It.IsAny<ILogger>())).Returns(goModParserMock.Object);
 
+        this.commandLineMock.Setup(x => x.CanCommandBeLocatedAsync("go", null, null, It.Is<string[]>(p => p.SequenceEqual(new List<string> { "version" }.ToArray()))))
+        .ReturnsAsync(true);
+
         this.commandLineMock.Setup(x => x.ExecuteCommandAsync("go", null, null, default, It.Is<string[]>(p => p.SequenceEqual(new List<string> { "version" }.ToArray()))))
         .ReturnsAsync(new CommandLineExecutionResult
         {
@@ -136,6 +145,9 @@ public async Task Go117ModDetector_GoSumFileFound_GoSumParserIsExecuted()
         var goSumParserMock = new Mock<IGoParser>();
         this.mockParserFactory.Setup(x => x.CreateParser(GoParserType.GoSum, It.IsAny<ILogger>())).Returns(goSumParserMock.Object);
 
+        this.commandLineMock.Setup(x => x.CanCommandBeLocatedAsync("go", null, null, It.Is<string[]>(p => p.SequenceEqual(new List<string> { "version" }.ToArray()))))
+        .ReturnsAsync(true);
+
         this.commandLineMock.Setup(x => x.ExecuteCommandAsync("go", null, null, default, It.Is<string[]>(p => p.SequenceEqual(new List<string> { "version" }.ToArray()))))
         .ReturnsAsync(new CommandLineExecutionResult
         {
@@ -151,4 +163,25 @@ public async Task Go117ModDetector_GoSumFileFound_GoSumParserIsExecuted()
 
         goSumParserMock.Verify(parser => parser.ParseAsync(It.IsAny<ISingleFileComponentRecorder>(), It.IsAny<IComponentStream>(), It.IsAny<GoGraphTelemetryRecord>()), Times.Once);
     }
+
+    [TestMethod]
+    public async Task Go117ModDetector_ExecutingGoVersionFails_DetectorDoesNotFail()
+    {
+        var goModParserMock = new Mock<IGoParser>();
+        this.mockParserFactory.Setup(x => x.CreateParser(GoParserType.GoMod, It.IsAny<ILogger>())).Returns(goModParserMock.Object);
+
+        this.commandLineMock.Setup(x => x.CanCommandBeLocatedAsync("go", null, null, It.Is<string[]>(p => p.SequenceEqual(new List<string> { "version" }.ToArray()))))
+        .ReturnsAsync(true);
+
+        this.commandLineMock.Setup(x => x.ExecuteCommandAsync("go", null, null, default, It.Is<string[]>(p => p.SequenceEqual(new List<string> { "version" }.ToArray()))))
+        .Throws(new InvalidOperationException("Failed to execute go version"));
+
+        var (scanResult, componentRecorder) = await this.DetectorTestUtility
+            .WithFile("go.mod", string.Empty)
+            .ExecuteDetectorAsync();
+
+        scanResult.ResultCode.Should().Be(ProcessingResultCode.Success);
+
+        goModParserMock.Verify(parser => parser.ParseAsync(It.IsAny<ISingleFileComponentRecorder>(), It.IsAny<IComponentStream>(), It.IsAny<GoGraphTelemetryRecord>()), Times.Once);
+    }
 }