Test for presence of ILogger parameter in the entry point method

SonarSource · May 11, 2022 · 4876dcf · 4876dcf
1 parent 5b6ca73
commit 4876dcf
Showing 1 changed file with 14 additions and 8 deletions.
diff --git a/analyzers/src/SonarAnalyzer.CSharp/Rules/AzureFunctionsLogFailures.cs b/analyzers/src/SonarAnalyzer.CSharp/Rules/AzureFunctionsLogFailures.cs
@@ -37,17 +37,20 @@ public sealed class AzureFunctionsLogFailures : SonarDiagnosticAnalyzer
         private const string MessageFormat = "Log caught exceptions via ILogger with LogLevel Warning, Error, or Critical";
 
         private static readonly DiagnosticDescriptor Rule = DiagnosticDescriptorBuilder.GetDescriptor(DiagnosticId, MessageFormat, RspecStrings.ResourceManager);
+        private static readonly ILanguageFacade LanguageFacade = CSharpFacade.Instance;
 
         public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);
 
         protected override void Initialize(SonarAnalysisContext context) =>
             context.RegisterSyntaxNodeActionInNonGenerated(c =>
                 {
                     var catchClause = (CatchClauseSyntax)c.Node;
-                    if (IsContainingMethodAzureFunction(c.SemanticModel, catchClause, c.CancellationToken))
+                    if (AzureFunctionEntryPoint(c.SemanticModel, catchClause, c.CancellationToken) is { } entryPoint)
                     {
                         var iLogger = c.SemanticModel.Compilation.GetTypeByMetadataName(KnownType.Microsoft_Extensions_Logging_ILogger.TypeName);
-                        if (iLogger is not null && InvalidCallsToILogger(c.SemanticModel, iLogger, catchClause, c.CancellationToken) is ImmutableArray<ExpressionSyntax> secondaryLocations)
+                        if (iLogger is not null
+                            && entryPoint.Parameters.Any(p => p.Type.DerivesOrImplements(iLogger))
+                            && InvalidCallsToILogger(c.SemanticModel, iLogger, catchClause, c.CancellationToken) is ImmutableArray<ExpressionSyntax> secondaryLocations)
                         {
                             c.ReportIssue(Diagnostic.Create(Rule, catchClause.CatchKeyword.GetLocation(), additionalLocations: secondaryLocations.Select(x => x.GetLocation())));
                         }
@@ -57,7 +60,7 @@ protected override void Initialize(SonarAnalysisContext context) =>
 
         private static ImmutableArray<ExpressionSyntax>? InvalidCallsToILogger(SemanticModel semanticModel, ITypeSymbol iLogger, CatchClauseSyntax catchClause, CancellationToken cancellationToken)
         {
-            var walker = new LoggerCallWalker(semanticModel, iLogger, cancellationToken);
+            var walker = new LoggerCallWalker(LanguageFacade, semanticModel, iLogger, cancellationToken);
             if (catchClause.Block is { } block)
             {
                 walker.Visit(block);
@@ -73,13 +76,15 @@ protected override void Initialize(SonarAnalysisContext context) =>
                 : walker.InvalidLoggerInvocations;
         }
 
-        private static bool IsContainingMethodAzureFunction(SemanticModel model, SyntaxNode node, CancellationToken cancellationToken)
+        private static IMethodSymbol AzureFunctionEntryPoint(SemanticModel model, SyntaxNode node, CancellationToken cancellationToken)
         {
             return node.Ancestors().OfType<MethodDeclarationSyntax>().FirstOrDefault() is { } method
                 && method.AttributeLists.Any() // FunctionName has [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)] so there must be an attribute
                 && model.GetDeclaredSymbol(method, cancellationToken) is { } methodSymbol
                 && model.Compilation.GetTypeByMetadataName(KnownType.Microsoft_Azure_WebJobs_FunctionNameAttribute.TypeName) is { } functionNameAttribute
-                && methodSymbol.GetAttributes().Any(a => a.AttributeClass.Equals(functionNameAttribute));
+                && methodSymbol.GetAttributes().Any(a => a.AttributeClass.Equals(functionNameAttribute))
+                ? methodSymbol
+                : null;
         }
 
         private sealed class LoggerCallWalker : SafeCSharpSyntaxWalker
@@ -93,15 +98,17 @@ private sealed class LoggerCallWalker : SafeCSharpSyntaxWalker
 
             private readonly ImmutableHashSet<ExpressionSyntax>.Builder invalidIvocationsBuilder = ImmutableHashSet.CreateBuilder<ExpressionSyntax>();
 
-            public LoggerCallWalker(SemanticModel model, ITypeSymbol iLoggerSymbol, CancellationToken cancellationToken)
+            public LoggerCallWalker(ILanguageFacade languageFacade, SemanticModel model, ITypeSymbol iLoggerSymbol, CancellationToken cancellationToken)
             {
+                Language = languageFacade;
                 Model = model;
                 ILogger = iLoggerSymbol;
                 CancellationToken = cancellationToken;
                 LoggerExtensions = new Lazy<INamedTypeSymbol>(() => Model.Compilation.GetTypeByMetadataName(KnownType.Microsoft_Extensions_Logging_LoggerExtensions.TypeName));
                 ILogger_Log = new Lazy<IMethodSymbol>(() => ILogger.GetMembers().OfType<IMethodSymbol>().FirstOrDefault(x => x.Name == "Log"));
             }
 
+            private ILanguageFacade Language { get; }
             private SemanticModel Model { get; }
             private ITypeSymbol ILogger { get; }
             private CancellationToken CancellationToken { get; }
@@ -159,13 +166,12 @@ private bool IsValidLogCall(InvocationExpressionSyntax invocation)
                         }
                     }
                 }
-
                 return false;
             }
 
             private bool IsPassingValidLogLevel(InvocationExpressionSyntax invocation, IMethodSymbol symbol) =>
                 symbol.Parameters.FirstOrDefault(x => x.Name == "logLevel") is { } logLevelParameter
-                    && CSharpFacade.Instance.MethodParameterLookup(invocation, symbol).TryGetNonParamsSyntax(logLevelParameter, out var argumentSyntax)
+                    && Language.MethodParameterLookup(invocation, symbol).TryGetNonParamsSyntax(logLevelParameter, out var argumentSyntax)
                     && Model.GetConstantValue(argumentSyntax, CancellationToken) is { HasValue: true, Value: int logLevel }
                         ? ValidLogLevel.Contains(logLevel)
                         : true; // Compliant: Some non-constant value is passed as loglevel.