NET-1042 Extract semantic Helper extensions from SonarAnalyzer.Core

Author: pavel-mikula-sonarsource

analyzers/src/SonarAnalyzer.CSharp.Core/Syntax/Extensions/BaseMethodDeclarationSyntaxExtensions.cs

@@ -48,7 +48,7 @@ public static bool ContainsMethodInvocation(this BaseMethodDeclarationSyntax met
         return childNodes
             .OfType<InvocationExpressionSyntax>()
             .Where(syntaxPredicate)
-            .Select(x => x.Expression.SyntaxTree.GetSemanticModelOrDefault(semanticModel)?.GetSymbolInfo(x.Expression).Symbol)
+            .Select(x => x.Expression.SyntaxTree.SemanticModelOrDefault(semanticModel)?.GetSymbolInfo(x.Expression).Symbol)
             .OfType<IMethodSymbol>()
             .Any(symbolPredicate);
     }

analyzers/src/SonarAnalyzer.CSharp/Rules/ExpectedExceptionAttributeShouldNotBeUsed.cs

@@ -48,19 +48,8 @@ private sealed class CatchFinallyAssertion : SafeCSharpSyntaxWalker
         {
             public bool HasAssertion { get; set; }
 
-            public override void VisitInvocationExpression(InvocationExpressionSyntax node)
-            {
-                if (HasAssertion)
-                {
-                    return;
-                }
-
-                HasAssertion = node.Expression
-                    .ToString()
-                    .SplitCamelCaseToWords()
-                    .Intersect(UnitTestHelper.KnownAssertionMethodParts)
-                    .Any();
-            }
+            public override void VisitInvocationExpression(InvocationExpressionSyntax node) =>
+                HasAssertion = HasAssertion || node.Expression.ToString().SplitCamelCaseToWords().Intersect(KnownMethods.AssertionMethodParts).Any();
         }
     }
 }

analyzers/src/SonarAnalyzer.CSharp/Rules/ImplementIDisposableCorrectly.cs

@@ -198,7 +198,7 @@ private void VerifyDispose(MethodDeclarationSyntax disposeMethod, bool isSealedC
 
                 // Because of partial classes we cannot always rely on the current semantic model.
                 // See issue: https://github.com/SonarSource/sonar-dotnet/issues/690
-                var disposeMethodSymbol = disposeMethod.SyntaxTree.GetSemanticModelOrDefault(semanticModel)?.GetDeclaredSymbol(disposeMethod);
+                var disposeMethodSymbol = disposeMethod.SyntaxTree.SemanticModelOrDefault(semanticModel)?.GetDeclaredSymbol(disposeMethod);
                 if (disposeMethodSymbol == null)
                 {
                     return;

analyzers/src/SonarAnalyzer.CSharp/Rules/TestMethodShouldContainAssertion.cs

@@ -79,7 +79,7 @@ private static bool IsTestMethod(IMethodSymbol symbol, bool isLocalFunction) =>
         isLocalFunction ? IsXunitTestMethod(symbol) : symbol.IsTestMethod();
 
     private static bool IsXunitTestMethod(IMethodSymbol methodSymbol) =>
-        methodSymbol.AnyAttributeDerivesFromAny(UnitTestHelper.KnownTestMethodAttributesOfxUnit);
+        methodSymbol.AnyAttributeDerivesFromAny(KnownType.TestMethodAttributesOfxUnit);
 
     private static bool ContainsAssertion(SyntaxNode methodDeclaration, SemanticModel model, ISet<IMethodSymbol> visitedSymbols, int level)
     {
@@ -139,7 +139,7 @@ private static bool IsAssertion(InvocationExpressionSyntax invocation) =>
         invocation.Expression
             .ToString()
             .SplitCamelCaseToWords()
-            .Intersect(UnitTestHelper.KnownAssertionMethodParts)
+            .Intersect(KnownMethods.AssertionMethodParts)
             .Any();
 
     private static bool IsKnownAssertion(ISymbol methodSymbol) =>

analyzers/src/SonarAnalyzer.CSharp/Rules/TestMethodShouldNotBeIgnored.cs

@@ -23,16 +23,16 @@ public sealed class TestMethodShouldNotBeIgnored : SonarDiagnosticAnalyzer
         private const string MessageFormat = "Either remove this 'Ignore' attribute or add an explanation about why this test is ignored.";
 
         private static readonly DiagnosticDescriptor Rule = DescriptorFactory.Create(DiagnosticId, MessageFormat);
-        public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(Rule);
 
         private static readonly ImmutableArray<KnownType> TrackedTestIdentifierAttributes =
-            // xUnit has it's own "ignore" mechanism (by providing a (Skip = "reason") string in
-            // the attribute, so there is always an explanation for the test being skipped).
-            UnitTestHelper.KnownTestMethodAttributesOfMSTest
-            .Concat(new[] { KnownType.Microsoft_VisualStudio_TestTools_UnitTesting_TestClassAttribute })
-            .Concat(UnitTestHelper.KnownTestMethodAttributesOfNUnit)
+            // xUnit has it's own "ignore" mechanism (by providing a (Skip = "reason") string in the attribute, so there is always an explanation for the test being skipped).
+            KnownType.TestMethodAttributesOfMSTest
+            .Concat(KnownType.TestMethodAttributesOfNUnit)
+            .Append(KnownType.Microsoft_VisualStudio_TestTools_UnitTesting_TestClassAttribute)
             .ToImmutableArray();
 
+        public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(Rule);
+
         protected override void Initialize(SonarAnalysisContext context) =>
             context.RegisterNodeAction(
                 c =>
@@ -78,7 +78,7 @@ private static bool IsKnownIgnoreAttribute(AttributeSyntax attributeSyntax, Sema
 
             var attributeConstructor = symbolInfo.Symbol ?? symbolInfo.CandidateSymbols.FirstOrDefault();
 
-            return attributeConstructor != null && attributeConstructor.ContainingType.DerivesFromAny(UnitTestHelper.KnownIgnoreAttributes);
+            return attributeConstructor is not null && attributeConstructor.ContainingType.DerivesFromAny(KnownType.IgnoreAttributes);
         }
 
         private static bool IsTestOrTestClassAttribute(AttributeData a) =>

analyzers/src/SonarAnalyzer.Core/Extensions/CompilationExtensions.cs

@@ -53,4 +53,11 @@ public static bool IsMemberAvailable<TMemberType>(this Compilation compilation,
             ? memberSymbols.Any()
             : memberSymbols.Any(memberCheck);
     }
+
+    public static bool ReferencesNetCoreControllers(this Compilation compilation) =>
+        compilation.GetTypeByMetadataName(KnownType.Microsoft_AspNetCore_Mvc_Controller) is not null
+        || compilation.GetTypeByMetadataName(KnownType.Microsoft_AspNetCore_Mvc_ControllerBase) is not null;
+
+    public static bool ReferencesNetFrameworkControllers(this Compilation compilation) =>
+        compilation.GetTypeByMetadataName(KnownType.System_Web_Mvc_Controller) is not null;
 }