Add better error handling for the case when first PR analysis is run …

…before the base branch analysis (#1559)
SonarSource · Apr 4, 2023 · 6fceba5 · 6fceba5
1 parent 64a0c4c
commit 6fceba5
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 4 deletions.
diff --git a/Tests/SonarScanner.MSBuild.PreProcessor.Test/SonarCloudWebServerTest.cs b/Tests/SonarScanner.MSBuild.PreProcessor.Test/SonarCloudWebServerTest.cs
@@ -346,7 +346,8 @@ public async Task DownloadCache_ThrowException()
             var result = await sut.DownloadCache(localSettings);
 
             result.Should().BeEmpty();
-            logger.AssertSingleDebugMessageExists("Incremental PR analysis: an error occurred while retrieving the cache entries! Found invalid data while decoding.");
+            logger.AssertSingleWarningExists("Incremental PR analysis: an error occurred while retrieving the cache entries! Found invalid data while decoding.");
+            logger.AssertNoErrorsLogged();
             handler.VerifyAll();
         }
 

diff --git a/Tests/SonarScanner.MSBuild.PreProcessor.Test/SonarQubeWebServerTest.cs b/Tests/SonarScanner.MSBuild.PreProcessor.Test/SonarQubeWebServerTest.cs
@@ -495,15 +495,16 @@ public async Task DownloadCache_DeserializesMessage()
         }
 
         [TestMethod]
-        public async Task DownloadCache_WhenDownloadStreamReturnsNull_ReturnsEmptyAndLogsException()
+        public async Task DownloadCache_WhenDownloadStreamReturnsNull_ReturnsEmpty()
         {
             sut = new SonarQubeWebServer(MockIDownloader(null), version, logger, null);
 
             var localSettings = CreateLocalSettings(ProjectKey, ProjectBranch);
             var result = await sut.DownloadCache(localSettings);
 
             result.Should().BeEmpty();
-            logger.AssertSingleWarningExists("Incremental PR analysis: an error occurred while retrieving the cache entries! Object reference not set to an instance of an object.");
+            logger.AssertNoWarningsLogged();
+            logger.AssertNoErrorsLogged(); // There are no errors or warnings logs but we will display an info message in the caller: "Cache data is empty. A full analysis will be performed."
         }
 
         [TestMethod]

diff --git a/src/SonarScanner.MSBuild.PreProcessor/WebServer/SonarCloudWebServer.cs b/src/SonarScanner.MSBuild.PreProcessor/WebServer/SonarCloudWebServer.cs
@@ -99,7 +99,8 @@ public override async Task<IList<SensorCacheEntry>> DownloadCache(ProcessedArgs
             }
             catch (Exception e)
             {
-                logger.LogDebug(Resources.WARN_IncrementalPRCacheEntryRetrieval_Error, e.Message);
+                logger.LogWarning(Resources.WARN_IncrementalPRCacheEntryRetrieval_Error, e.Message);
+                logger.LogDebug(e.ToString());
                 return empty;
             }
         }

diff --git a/src/SonarScanner.MSBuild.PreProcessor/WebServer/SonarQubeWebServer.cs b/src/SonarScanner.MSBuild.PreProcessor/WebServer/SonarQubeWebServer.cs
@@ -109,6 +109,7 @@ public override async Task<IList<SensorCacheEntry>> DownloadCache(ProcessedArgs
             catch (Exception e)
             {
                 logger.LogWarning(Resources.WARN_IncrementalPRCacheEntryRetrieval_Error, e.Message);
+                logger.LogDebug(e.ToString());
                 return empty;
             }
         }

diff --git a/src/SonarScanner.MSBuild.PreProcessor/WebServer/SonarWebServer.cs b/src/SonarScanner.MSBuild.PreProcessor/WebServer/SonarWebServer.cs
@@ -232,6 +232,10 @@ protected bool TryGetBaseBranch(ProcessedArgs localSettings, out string branch)
 
         protected static IList<SensorCacheEntry> ParseCacheEntries(Stream dataStream)
         {
+            if (dataStream == null)
+            {
+                return Array.Empty<SensorCacheEntry>();
+            }
             var cacheEntries = new List<SensorCacheEntry>();
             while (dataStream.Position < dataStream.Length)
             {