SLVS-1669 Handle the case of C/C++ files outside the projects (#5890)

src/SLCore.UnitTests/Analysis/SLCoreAnalyzerTests.cs

@@ -19,6 +19,7 @@
  */
 
 using NSubstitute.ExceptionExtensions;
+using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Analysis;
 using SonarLint.VisualStudio.Core.CFamily;
 using SonarLint.VisualStudio.Core.ConfigurationScope;
@@ -43,6 +44,7 @@ public class SLCoreAnalyzerTests
     private ICurrentTimeProvider currentTimeProvider;
     private IAggregatingCompilationDatabaseProvider compilationDatabaseLocator;
     private IAnalysisStatusNotifier notifier;
+    private ILogger logger;
     private SLCoreAnalyzer testSubject;
 
     [TestInitialize]
@@ -58,11 +60,13 @@ public void TestInitialize()
         SetUpDefaultNotifier();
         currentTimeProvider = Substitute.For<ICurrentTimeProvider>();
         compilationDatabaseLocator = Substitute.For<IAggregatingCompilationDatabaseProvider>();
+        logger = new TestLogger();
         testSubject = new SLCoreAnalyzer(slCoreServiceProvider,
             activeConfigScopeTracker,
             analysisStatusNotifierFactory,
             currentTimeProvider,
-            compilationDatabaseLocator);
+            compilationDatabaseLocator,
+            logger);
 
         void SetUpDefaultNotifier() => analysisStatusNotifierFactory.Create(nameof(SLCoreAnalyzer), FilePath, analysisId).Returns(notifier);
     }
@@ -74,7 +78,8 @@ public void MefCtor_CheckIsExported() =>
             MefTestHelpers.CreateExport<IActiveConfigScopeTracker>(),
             MefTestHelpers.CreateExport<IAnalysisStatusNotifierFactory>(),
             MefTestHelpers.CreateExport<ICurrentTimeProvider>(),
-            MefTestHelpers.CreateExport<IAggregatingCompilationDatabaseProvider>());
+            MefTestHelpers.CreateExport<IAggregatingCompilationDatabaseProvider>(),
+            MefTestHelpers.CreateExport<ILogger>());
 
     [TestMethod]
     public void MefCtor_CheckIsSingleton() => MefTestHelpers.CheckIsSingletonMefComponent<SLCoreAnalyzer>();
@@ -206,7 +211,7 @@ public void ExecuteAnalysis_ForCFamily_AnalysisThrows_CompilationDatabaaseDispos
     }
 
     [TestMethod]
-    public void ExecuteAnalysis_ForCFamily_WithoutCompilationDatabase_DoesNotPassExtraProperty()
+    public void ExecuteAnalysis_ForCFamily_WithoutCompilationDatabase_PassesEmptyStringAsExtraProperty()
     {
         const string filePath = @"C:\file\path\myclass.cpp";
         SetUpCompilationDatabaseLocator(filePath, null);
@@ -216,7 +221,8 @@ public void ExecuteAnalysis_ForCFamily_WithoutCompilationDatabase_DoesNotPassExt
 
         analysisService.Received().AnalyzeFilesAndTrackAsync(Arg.Is<AnalyzeFilesAndTrackParams>(a =>
                 a.extraProperties != null
-                && !a.extraProperties.ContainsKey("sonar.cfamily.compile-commands")),
+                && a.extraProperties.ContainsKey("sonar.cfamily.compile-commands")
+                && a.extraProperties["sonar.cfamily.compile-commands"] == ""),
             Arg.Any<CancellationToken>());
     }
 

src/SLCore/Analysis/SLCoreAnalyzer.cs

@@ -20,6 +20,7 @@
 
 using System.ComponentModel.Composition;
 using Microsoft.VisualStudio.Threading;
+using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Analysis;
 using SonarLint.VisualStudio.Core.CFamily;
 using SonarLint.VisualStudio.Core.ConfigurationScope;
@@ -41,20 +42,23 @@ public class SLCoreAnalyzer : IAnalyzer
     private readonly IAnalysisStatusNotifierFactory analysisStatusNotifierFactory;
     private readonly ICurrentTimeProvider currentTimeProvider;
     private readonly IAggregatingCompilationDatabaseProvider compilationDatabaseLocator;
+    private readonly ILogger logger;
 
     [ImportingConstructor]
     public SLCoreAnalyzer(
         ISLCoreServiceProvider serviceProvider,
         IActiveConfigScopeTracker activeConfigScopeTracker,
         IAnalysisStatusNotifierFactory analysisStatusNotifierFactory,
         ICurrentTimeProvider currentTimeProvider,
-        IAggregatingCompilationDatabaseProvider compilationDatabaseLocator)
+        IAggregatingCompilationDatabaseProvider compilationDatabaseLocator,
+        ILogger logger)
     {
         this.serviceProvider = serviceProvider;
         this.activeConfigScopeTracker = activeConfigScopeTracker;
         this.analysisStatusNotifierFactory = analysisStatusNotifierFactory;
         this.currentTimeProvider = currentTimeProvider;
         this.compilationDatabaseLocator = compilationDatabaseLocator;
+        this.logger = logger;
     }
 
     public bool IsAnalysisSupported(IEnumerable<AnalysisLanguage> languages) => true;
@@ -134,7 +138,13 @@ private IDisposable EnrichPropertiesForCFamily(Dictionary<string, string> proper
         }
 
         var compilationDatabaseHandle = compilationDatabaseLocator.GetOrNull(path);
-        if (compilationDatabaseHandle != null)
+        if (compilationDatabaseHandle == null)
+        {
+            logger.WriteLine(SLCoreStrings.CompilationDatabaseNotFound, path);
+            // Pass empty compilation database path in order to get a more helpful message and not break the analyzer
+            properties[CFamilyCompileCommandsProperty] = "";
+        }
+        else
         {
             properties[CFamilyCompileCommandsProperty] = compilationDatabaseHandle.FilePath;
         }

src/SLCore/SLCoreStrings.resx

@@ -179,5 +179,7 @@
   </data>
   <data name="UnknowProxyType" xml:space="preserve">
     <value>Proxy type can not be determined from scheme '{0}'. Returning HTTP proxy type.</value>
+  <data name="CompilationDatabaseNotFound" xml:space="preserve">
+    <value>[SLCoreAnalyzer] No compilation database found for file: {0}. Check that the file is part of a supported project type in the current solution.</value>
   </data>
 </root>