Skip to content

Commit 789e175

Browse files
olsholsh
committed
Improve variables detection
1 parent e5b599b commit 789e175

10 files changed

Lines changed: 174 additions & 13 deletions

‎src/Sql.Analyzer.UnitTests/DapperParametersMatchingAnalyzerTests.cs‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
using Microsoft.VisualStudio.TestTools.UnitTesting;
2+
3+
namespace Sql.Analyzer.UnitTests
4+
{
5+
[TestClass]
6+
public class DapperParametersMatchingAnalyzerTests
7+
{
8+
[TestMethod]
9+
public void FindSqlVariables_DeclareVariable_NotDetected()
10+
{
11+
var sql = @"DECLARE @ids udt_ids_list;
12+
13+
INSERT INTO @ids
14+
SELECT id
15+
FROM dbo.table
16+
WHERE name = @name;";
17+
}
18+
}
19+
}

‎src/Sql.Analyzer.UnitTests/Parsers/SqlParserTests.cs‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
using System.Linq;
2+
3+
using Microsoft.VisualStudio.TestTools.UnitTesting;
4+
5+
using Sql.Analyzer.Parsers;
6+
7+
namespace Sql.Analyzer.UnitTests.Parsers
8+
{
9+
[TestClass]
10+
public class SqlParserTests
11+
{
12+
[TestMethod]
13+
public void FindSqlVariables_DeclareVariable_NotDetected()
14+
{
15+
var sql =
16+
@"DECLARE @ids udt_ids_list;
17+
18+
INSERT INTO @ids
19+
SELECT id
20+
FROM dbo.table
21+
WHERE name = @name;
22+
23+
DECLARE @idsa udt_ids_list;
24+
25+
INSERT INTO @idsa
26+
SELECT id
27+
FROM dbo.table
28+
WHERE name = @name;";
29+
30+
var parameters = SqlParser.FindParameters(sql);
31+
32+
Assert.AreEqual(1, parameters.Count);
33+
Assert.AreEqual("name", parameters.First());
34+
}
35+
36+
[TestMethod]
37+
public void FindSqlVariables_Identity_NotDetected()
38+
{
39+
var sql =
40+
@"SELECT id, @@IDENTITY
41+
FROM dbo.table
42+
WHERE name = @name;";
43+
44+
var parameters = SqlParser.FindParameters(sql);
45+
46+
Assert.AreEqual(1, parameters.Count);
47+
Assert.AreEqual("name", parameters.First());
48+
}
49+
}
50+
}

‎src/Sql.Analyzer.UnitTests/Sql.Analyzer.UnitTests.csproj‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFramework>netcoreapp3.0</TargetFramework>
5+
6+
<IsPackable>false</IsPackable>
7+
</PropertyGroup>
8+
9+
<ItemGroup>
10+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.2.0" />
11+
<PackageReference Include="MSTest.TestAdapter" Version="1.4.0" />
12+
<PackageReference Include="MSTest.TestFramework" Version="1.4.0" />
13+
<PackageReference Include="coverlet.collector" Version="1.0.1" />
14+
</ItemGroup>
15+
16+
<ItemGroup>
17+
<ProjectReference Include="..\Sql.Analyzer\Sql.Analyzer\Sql.Analyzer.csproj" />
18+
</ItemGroup>
19+
20+
</Project>

‎src/Sql.Analyzer.sln‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
1515
..\build.cake = ..\build.cake
1616
EndProjectSection
1717
EndProject
18+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sql.Analyzer.UnitTests", "Sql.Analyzer.UnitTests\Sql.Analyzer.UnitTests.csproj", "{939D09D8-00A8-4917-A9AE-D65FB5252EC0}"
19+
EndProject
1820
Global
1921
GlobalSection(SolutionConfigurationPlatforms) = preSolution
2022
Debug|Any CPU = Debug|Any CPU
@@ -33,6 +35,10 @@ Global
3335
{DE372B5D-B2D2-41B1-A88F-A3D7B651FF29}.Debug|Any CPU.Build.0 = Debug|Any CPU
3436
{DE372B5D-B2D2-41B1-A88F-A3D7B651FF29}.Release|Any CPU.ActiveCfg = Release|Any CPU
3537
{DE372B5D-B2D2-41B1-A88F-A3D7B651FF29}.Release|Any CPU.Build.0 = Release|Any CPU
38+
{939D09D8-00A8-4917-A9AE-D65FB5252EC0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
39+
{939D09D8-00A8-4917-A9AE-D65FB5252EC0}.Debug|Any CPU.Build.0 = Debug|Any CPU
40+
{939D09D8-00A8-4917-A9AE-D65FB5252EC0}.Release|Any CPU.ActiveCfg = Release|Any CPU
41+
{939D09D8-00A8-4917-A9AE-D65FB5252EC0}.Release|Any CPU.Build.0 = Release|Any CPU
3642
EndGlobalSection
3743
GlobalSection(SolutionProperties) = preSolution
3844
HideSolutionNode = FALSE

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,14 @@ public void InlineSqlUnmatchedSqlVariable_AnalyzerTriggered()
6060
VerifyCSharpDiagnostic(code, expected);
6161
}
6262

63+
[TestMethod]
64+
public void InlineSqlDeclaredVariableParameters_NotTriggered()
65+
{
66+
var code = EmbeddedResourceHelper.ReadTestData("InlineSqlDeclaredVariableParameters.cs");
67+
68+
VerifyCSharpDiagnostic(code);
69+
}
70+
6371
protected override DiagnosticAnalyzer GetCSharpDiagnosticAnalyzer()
6472
{
6573
return new DapperParametersMatchingAnalyzer();

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
</PropertyGroup>
66

77
<ItemGroup>
8+
<Compile Remove="TestData\InlineSqlDeclaredVariableParameters.cs" />
89
<Compile Remove="TestData\InlineSqlUnmatchedParameters.cs" />
910
<Compile Remove="TestData\InlineSqlUnmatchedSqlVariable.cs" />
1011
<Compile Remove="TestData\InlineSqlWithConstUnmatchedParameters.cs" />
@@ -14,6 +15,7 @@
1415
</ItemGroup>
1516

1617
<ItemGroup>
18+
<EmbeddedResource Include="TestData\InlineSqlDeclaredVariableParameters.cs" />
1719
<EmbeddedResource Include="TestData\InlineSqlUnmatchedSqlVariable.cs" />
1820
<EmbeddedResource Include="TestData\InlineSqlWithConstUnmatchedParameters.cs" />
1921
<EmbeddedResource Include="TestData\InlineSqlWithDbStringArgumentTestData.cs" />

‎src/Sql.Analyzer/Sql.Analyzer.Test/TestData/InlineSqlDeclaredVariableParameters.cs‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
using System.Data.SqlClient;
2+
using System.Threading.Tasks;
3+
4+
using Dapper;
5+
6+
namespace Sql.Analyzer.Test.TestData
7+
{
8+
public class InlineSqlWithStringParameterTestData
9+
{
10+
private static async Task Main(string[] args)
11+
{
12+
var sql = new SqlConnection();
13+
sql.Execute(@"DECLARE @id VARCHAR(50);
14+
select 1 FROM table WHERE b = @not_found",
15+
new { not_found = new DbString() { IsAnsi = true, Value = "some_string" } });
16+
}
17+
}
18+
}

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
using System;
12
using System.Collections.Generic;
23
using System.Collections.Immutable;
34
using System.Linq;
@@ -9,6 +10,7 @@
910
using Microsoft.CodeAnalysis.Diagnostics;
1011

1112
using Sql.Analyzer.Extensions;
13+
using Sql.Analyzer.Parsers;
1214

1315
namespace Sql.Analyzer
1416
{
@@ -27,8 +29,6 @@ public class DapperParametersMatchingAnalyzer : DiagnosticAnalyzer
2729

2830
private static readonly string Title = "Parameters mismatching";
2931

30-
private static readonly Regex SqlParameterRegex = new Regex(@"@(?<variable>\w+)", RegexOptions.Compiled);
31-
3232
private static readonly DiagnosticDescriptor CsharpArgumentNotFoundRule = new DiagnosticDescriptor(
3333
DiagnosticId,
3434
Title,
@@ -71,8 +71,8 @@ private void ReportDiagnostics(
7171
SyntaxNodeAnalysisContext context,
7272
InvocationExpressionSyntax invocationExpressionSyntax)
7373
{
74-
List<string> sqlVariables = new List<string>();
75-
List<string> sharpParameters = null;
74+
ICollection<string> sqlVariables = null;
75+
ICollection<string> sharpParameters = null;
7676
foreach (var argument in invocationExpressionSyntax.ArgumentList.Arguments)
7777
{
7878
var parameter = argument.DetermineParameter(context.SemanticModel);
@@ -86,11 +86,7 @@ private void ReportDiagnostics(
8686
return;
8787
}
8888

89-
var matches = SqlParameterRegex.Matches(sourceText);
90-
foreach (Match match in matches)
91-
{
92-
sqlVariables.Add(match.Groups["variable"].Value);
93-
}
89+
sqlVariables = SqlParser.FindParameters(sourceText);
9490

9591
continue;
9692
}
@@ -102,12 +98,12 @@ private void ReportDiagnostics(
10298
}
10399
}
104100

105-
if (sharpParameters == null)
101+
if (sharpParameters == null || sqlVariables == null)
106102
{
107103
return;
108104
}
109105

110-
foreach (var notFoundArgument in sqlVariables.Except(sharpParameters))
106+
foreach (var notFoundArgument in sqlVariables.Except(sharpParameters, StringComparer.InvariantCultureIgnoreCase))
111107
{
112108
context.ReportDiagnostic(
113109
Diagnostic.Create(
@@ -116,7 +112,7 @@ private void ReportDiagnostics(
116112
notFoundArgument));
117113
}
118114

119-
foreach (var notFoundVariable in sharpParameters.Except(sqlVariables))
115+
foreach (var notFoundVariable in sharpParameters.Except(sqlVariables, StringComparer.InvariantCultureIgnoreCase))
120116
{
121117
context.ReportDiagnostic(
122118
Diagnostic.Create(

‎src/Sql.Analyzer/Sql.Analyzer/Parsers/SqlParser.cs‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
using System.Collections.Generic;
2+
using System.Text.RegularExpressions;
3+
4+
namespace Sql.Analyzer.Parsers
5+
{
6+
internal static class SqlParser
7+
{
8+
private static readonly Regex SqlParameterRegex = new Regex(@"(?<!@)@(?<variable>\w+)", RegexOptions.Compiled);
9+
private static readonly Regex SqlDeclareRegex = new Regex(@"declare\s(?<declaration>.*?)(select|update|delete|insert|merge)", RegexOptions.Compiled | RegexOptions.IgnoreCase | RegexOptions.Singleline);
10+
11+
public static ICollection<string> FindParameters(string sql)
12+
{
13+
var sqlVariables = new HashSet<string>();
14+
var declaredVariables = new HashSet<string>();
15+
foreach (Match match in SqlDeclareRegex.Matches(sql))
16+
{
17+
foreach (Match declaration in SqlParameterRegex.Matches(match.Groups["declaration"].Value))
18+
{
19+
declaredVariables.Add(declaration.Groups["variable"].Value);
20+
}
21+
}
22+
23+
var matches = SqlParameterRegex.Matches(sql);
24+
foreach (Match match in matches)
25+
{
26+
sqlVariables.Add(match.Groups["variable"].Value);
27+
}
28+
29+
sqlVariables.ExceptWith(declaredVariables);
30+
31+
return sqlVariables;
32+
}
33+
}
34+
}

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
<Copyright>Copyright</Copyright>
1616
<PackageTags>analyzers, sql, dapper</PackageTags>
1717
<NoPackageAnalysis>true</NoPackageAnalysis>
18-
<Version>0.0.1</Version>
18+
<Version>0.0.3</Version>
19+
<AssemblyVersion>0.0.3.0</AssemblyVersion>
20+
<FileVersion>0.0.3.0</FileVersion>
1921
</PropertyGroup>
2022

2123
<ItemGroup>
@@ -29,4 +31,10 @@
2931
<None Include="$(OutputPath)\$(AssemblyName).dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
3032
</ItemGroup>
3133

34+
<ItemGroup>
35+
<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
36+
<_Parameter1>Sql.Analyzer.UnitTests</_Parameter1>
37+
</AssemblyAttribute>
38+
</ItemGroup>
39+
3240
</Project>

0 commit comments

Comments
 (0)