Skip to content

Commit 5fe37e2

Browse files
olsholsh
committed
Add misuse Query analyzer
1 parent c62ad0c commit 5fe37e2

11 files changed

Lines changed: 225 additions & 4 deletions

‎README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# SQL Analyzer
22

3+
[![Build status](https://ci.appveyor.com/api/projects/status/vdgcjc30q62c2rnx?svg=true)](https://ci.appveyor.com/project/olsh/sql-analyzer)
4+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=sql-analyzer&metric=alert_status)](https://sonarcloud.io/dashboard?id=sql-analyzer)
5+
6+
37
A highly experimental Roslyn-based analyzer for SQL related stuff in .NET
48

59

@@ -31,3 +35,17 @@ Compliant Solution:
3135
```csharp
3236
var dog = connection.Query<Dog>("select Age = @Age, Id = @Id", new { Age = (int?)null, Id = guid });
3337
```
38+
39+
### SQL003: Using 'Query' method is not optimal here
40+
41+
Noncompliant Code Example:
42+
```csharp
43+
var dog = connection.Query<Dog>("select * from dogs").Single();
44+
```
45+
46+
Compliant Solution:
47+
```csharp
48+
var dog = connection.QuerySingle<Dog>("select * from dogs");
49+
```
50+
51+
https://github.com/StackExchange/Dapper#performance

‎src/Sql.Analyzer/Sql.Analyzer.Test/DapperQueryMisuseAnalyzerTests.cs‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
using Microsoft.CodeAnalysis;
2+
using Microsoft.CodeAnalysis.Diagnostics;
3+
using Microsoft.VisualStudio.TestTools.UnitTesting;
4+
5+
using TestHelper;
6+
7+
namespace Sql.Analyzer.Test
8+
{
9+
[TestClass]
10+
public class DapperQueryMisuseAnalyzerTests : DiagnosticVerifier
11+
{
12+
protected override string TestDataFolder => "DapperQueryMisuseAnalyzer";
13+
14+
[TestMethod]
15+
public void QueryWithFirstOrDefault_AnalyzerTriggered()
16+
{
17+
var code = ReadTestData("QueryWithFirstOrDefault.cs");
18+
19+
var expected = new DiagnosticResult
20+
{
21+
Id = DapperQueryMisuseAnalyzer.DiagnosticId,
22+
Message = string.Format(
23+
DapperQueryMisuseAnalyzer.MessageFormat,
24+
"QueryFirstOrDefault"),
25+
Severity = DiagnosticSeverity.Warning,
26+
Locations = new[] { new DiagnosticResultLocation("Test0.cs", 14, 26) }
27+
};
28+
29+
VerifyCSharpDiagnostic(code, expected);
30+
}
31+
32+
[TestMethod]
33+
public void QueryWithSingleAsync_AnalyzerTriggered()
34+
{
35+
var code = ReadTestData("QueryWithSingleAsync.cs");
36+
37+
var expected = new DiagnosticResult
38+
{
39+
Id = DapperQueryMisuseAnalyzer.DiagnosticId,
40+
Message = string.Format(
41+
DapperQueryMisuseAnalyzer.MessageFormat,
42+
"QuerySingleAsync"),
43+
Severity = DiagnosticSeverity.Warning,
44+
Locations = new[] { new DiagnosticResultLocation("Test0.cs", 14, 33) }
45+
};
46+
47+
VerifyCSharpDiagnostic(code, expected);
48+
}
49+
50+
protected override DiagnosticAnalyzer GetCSharpDiagnosticAnalyzer()
51+
{
52+
return new DapperQueryMisuseAnalyzer();
53+
}
54+
}
55+
}

‎src/Sql.Analyzer/Sql.Analyzer.Test/Sql.Analyzer.Test.csproj‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
<Compile Remove="TestData\DapperParametersMatchingAnalyzer\InlineSqlUnmatchedParameters.cs" />
1010
<Compile Remove="TestData\DapperParametersMatchingAnalyzer\InlineSqlUnmatchedSqlVariable.cs" />
1111
<Compile Remove="TestData\DapperParametersMatchingAnalyzer\InlineSqlWithConstUnmatchedParameters.cs" />
12+
<Compile Remove="TestData\DapperQueryMisuseAnalyzer\QueryWithFirstOrDefault.cs" />
13+
<Compile Remove="TestData\DapperQueryMisuseAnalyzer\QueryWithSingleAsync.cs" />
1214
<Compile Remove="TestData\DapperStringParameterAnalyzer\InlineSqlWithDbStringArgument.cs" />
1315
<Compile Remove="TestData\DapperStringParameterAnalyzer\InlineSqlWithStringArgument.cs" />
1416
<Compile Remove="TestData\DapperStringParameterAnalyzer\StoredProcedureWithStringArgument.cs" />
@@ -25,6 +27,8 @@
2527
<EmbeddedResource Include="TestData\DapperParametersMatchingAnalyzer\InlineSqlDeclaredVariableParameters.cs" />
2628
<EmbeddedResource Include="TestData\DapperParametersMatchingAnalyzer\InlineSqlUnmatchedSqlVariable.cs" />
2729
<EmbeddedResource Include="TestData\DapperParametersMatchingAnalyzer\InlineSqlWithConstUnmatchedParameters.cs" />
30+
<EmbeddedResource Include="TestData\DapperQueryMisuseAnalyzer\QueryWithSingleAsync.cs" />
31+
<EmbeddedResource Include="TestData\DapperQueryMisuseAnalyzer\QueryWithFirstOrDefault.cs" />
2832
<EmbeddedResource Include="TestData\DapperStringParameterAnalyzer\InlineSqlWithDbStringArgument.cs" />
2933
<EmbeddedResource Include="TestData\DapperParametersMatchingAnalyzer\InlineSqlUnmatchedParameters.cs" />
3034
<EmbeddedResource Include="TestData\DapperStringParameterAnalyzer\InlineSqlWithStringArgument.cs" />

‎src/Sql.Analyzer/Sql.Analyzer.Test/TestData/DapperQueryMisuseAnalyzer/QueryWithFirstOrDefault.cs‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
using System.Data.SqlClient;
2+
using System.Linq;
3+
using System.Threading.Tasks;
4+
5+
using Dapper;
6+
7+
namespace Sql.Analyzer.Test.TestData
8+
{
9+
public class QueryWithFirstOrDefault
10+
{
11+
private static async Task Main(string[] args)
12+
{
13+
var sql = new SqlConnection();
14+
var entity = sql.Query<dynamic>("some sql").FirstOrDefault();
15+
}
16+
}
17+
}

‎src/Sql.Analyzer/Sql.Analyzer.Test/TestData/DapperQueryMisuseAnalyzer/QueryWithSingleAsync.cs‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
using System.Data.SqlClient;
2+
using System.Linq;
3+
using System.Threading.Tasks;
4+
5+
using Dapper;
6+
7+
namespace Sql.Analyzer.Test.TestData
8+
{
9+
public class QueryWithFirstOrDefault
10+
{
11+
private static async Task Main(string[] args)
12+
{
13+
var sql = new SqlConnection();
14+
var entity = (await sql.QueryAsync<dynamic>("some sql")).Single();
15+
}
16+
}
17+
}

‎src/Sql.Analyzer/Sql.Analyzer/DapperParametersMatchingAnalyzer.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ public class DapperParametersMatchingAnalyzer : DiagnosticAnalyzer
3333
Category,
3434
DiagnosticSeverity.Warning,
3535
true,
36-
Title);
36+
Title,
37+
"https://github.com/olsh/sql-analyzer#sql002-sql-parameters-mismatch");
3738

3839
private static readonly DiagnosticDescriptor SqlParameterNotFoundRule = new DiagnosticDescriptor(
3940
DiagnosticId,

‎src/Sql.Analyzer/Sql.Analyzer/DapperQueryMisuseAnalyzer.cs‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
using System.Collections.Immutable;
2+
using System.Linq;
3+
4+
using Microsoft.CodeAnalysis;
5+
using Microsoft.CodeAnalysis.CSharp;
6+
using Microsoft.CodeAnalysis.CSharp.Syntax;
7+
using Microsoft.CodeAnalysis.Diagnostics;
8+
9+
using Sql.Analyzer.Extensions;
10+
11+
namespace Sql.Analyzer
12+
{
13+
[DiagnosticAnalyzer(LanguageNames.CSharp)]
14+
public class DapperQueryMisuseAnalyzer : DiagnosticAnalyzer
15+
{
16+
public const string DiagnosticId = "SQL003";
17+
18+
public const string MessageFormat = "Consider using '{0}' method here";
19+
20+
private const string Category = "API Guidance";
21+
22+
private static readonly string Description = "The 'Query' method is designed to select a collection. For a single entity, there are most efficient alternatives like 'QueryFirst' or 'QuerySingle'.";
23+
24+
private static readonly string Title = "Using 'Query' method is not optimal here";
25+
26+
private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor(
27+
DiagnosticId,
28+
Title,
29+
MessageFormat,
30+
Category,
31+
DiagnosticSeverity.Warning,
32+
true,
33+
Description,
34+
"https://github.com/StackExchange/Dapper#performance");
35+
36+
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);
37+
38+
public override void Initialize(AnalysisContext context)
39+
{
40+
context.RegisterSyntaxNodeAction(AnalyzeInvocationExpression, SyntaxKind.InvocationExpression);
41+
}
42+
43+
private void AnalyzeInvocationExpression(SyntaxNodeAnalysisContext context)
44+
{
45+
var invocationExpressionSyntax = (InvocationExpressionSyntax)context.Node;
46+
47+
var methodSymbol = context.SemanticModel.GetSymbolInfo(invocationExpressionSyntax).Symbol as IMethodSymbol;
48+
if (methodSymbol == null)
49+
{
50+
return;
51+
}
52+
53+
var dapperClass = context.SemanticModel.GetDapperSqlMapperSymbol();
54+
const string QueryPrefix = "Query";
55+
if (methodSymbol.ContainingType != dapperClass || !methodSymbol.Name.StartsWith(QueryPrefix))
56+
{
57+
return;
58+
}
59+
60+
var firstInvocationExpression = invocationExpressionSyntax
61+
.Ancestors()
62+
.TakeWhile(n => !(n is StatementSyntax))
63+
.OfType<InvocationExpressionSyntax>()
64+
.FirstOrDefault();
65+
66+
if (firstInvocationExpression == null || firstInvocationExpression.ArgumentList.Arguments.Count != 0)
67+
{
68+
return;
69+
}
70+
71+
var linqExtensionMethodSymbol = context.SemanticModel.GetSymbolInfo(firstInvocationExpression).Symbol as IMethodSymbol;
72+
var linqEnumerableSymbol = context.SemanticModel.GetLinqEnumerableSymbol();
73+
if (linqExtensionMethodSymbol == null || linqExtensionMethodSymbol.ContainingType != linqEnumerableSymbol)
74+
{
75+
return;
76+
}
77+
78+
var alternativeMethod = QueryPrefix + linqExtensionMethodSymbol.Name;
79+
const string AsyncPostfix = "Async";
80+
if (methodSymbol.Name.EndsWith(AsyncPostfix))
81+
{
82+
alternativeMethod += AsyncPostfix;
83+
}
84+
85+
var queryMethod = methodSymbol.ContainingType.GetMembers(alternativeMethod);
86+
if (queryMethod.Any())
87+
{
88+
context.ReportDiagnostic(Diagnostic.Create(Rule, invocationExpressionSyntax.Expression.GetLocation(), alternativeMethod));
89+
}
90+
}
91+
}
92+
}

‎src/Sql.Analyzer/Sql.Analyzer/DapperStringParameterAnalyzer.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public class DapperStringParameterAnalyzer : DiagnosticAnalyzer
3030
DiagnosticSeverity.Warning,
3131
true,
3232
Description,
33-
"https://github.com/StackExchange/Dapper/blob/master/Readme.md#ansi-strings-and-varchar");
33+
"https://github.com/olsh/sql-analyzer#sql001-sql-type-is-not-specified");
3434

3535
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);
3636

‎src/Sql.Analyzer/Sql.Analyzer/Extensions/InvocationExpressionExtensions.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ public static bool IsDapperInlineSqlMethod(this InvocationExpressionSyntax invoc
1313
return false;
1414
}
1515

16-
var dapperClass = semanticModel.Compilation.GetTypeByMetadataName("Dapper.SqlMapper");
16+
var dapperClass = semanticModel.GetDapperSqlMapperSymbol();
1717
if (methodSymbol.ContainingType != dapperClass)
1818
{
1919
return false;

‎src/Sql.Analyzer/Sql.Analyzer/Extensions/SemanticModelExtensions.cs‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
using Microsoft.CodeAnalysis;
2+
3+
namespace Sql.Analyzer.Extensions
4+
{
5+
internal static class SemanticModelExtensions
6+
{
7+
public static INamedTypeSymbol GetDapperSqlMapperSymbol(this SemanticModel semanticModel)
8+
{
9+
return semanticModel.Compilation.GetTypeByMetadataName("Dapper.SqlMapper");
10+
}
11+
12+
public static INamedTypeSymbol GetLinqEnumerableSymbol(this SemanticModel semanticModel)
13+
{
14+
return semanticModel.Compilation.GetTypeByMetadataName("System.Linq.Enumerable");
15+
}
16+
}
17+
}

0 commit comments

Comments
 (0)