Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rule S2077: support for additional database libraries: NHibernate #6193

Merged
merged 12 commits into from
Oct 13, 2022
Merged

Rule S2077: support for additional database libraries: NHibernate #6193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
eeeafb6
Add test for NHibernate
martin-strecker-sonarsource Oct 11, 2022
bb8796a
Formattings
martin-strecker-sonarsource Oct 11, 2022
3d29e43
Fix after rebase
martin-strecker-sonarsource Oct 12, 2022
abed0c4
Add support for CreateQuery
martin-strecker-sonarsource Oct 12, 2022
2f58bbb
Add support for ramining ISession methods
martin-strecker-sonarsource Oct 12, 2022
0c4cd13
Add support and tests for SessionImpl
martin-strecker-sonarsource Oct 12, 2022
347ac6f
Add support and tests for AbstractSessionImplMethods
martin-strecker-sonarsource Oct 12, 2022
ee49c84
Add CreateFilterAsync tests
martin-strecker-sonarsource Oct 12, 2022
64ad51a
Remove namespace
martin-strecker-sonarsource Oct 12, 2022
8eb7be9
Fix code smell
martin-strecker-sonarsource Oct 12, 2022
7bfe52c
Remove commas
martin-strecker-sonarsource Oct 13, 2022
62f34d8
Update analyzers/src/SonarAnalyzer.Common/Helpers/KnownType.cs
martin-strecker-sonarsource Oct 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions analyzers/src/SonarAnalyzer.Common/Helpers/KnownType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,8 @@ internal sealed partial class KnownType
internal static readonly KnownType NFluent_Check = new("NFluent.Check");
internal static readonly KnownType NFluent_FluentCheckException = new("NFluent.FluentCheckException");
internal static readonly KnownType NFluent_Kernel_FluentCheckException = new("NFluent.Kernel.FluentCheckException");
internal static readonly KnownType NHibernate_ISession = new("NHibernate.ISession");
internal static readonly KnownType NHibernate_Impl_AbstractSessionImpl = new("NHibernate.Impl.AbstractSessionImpl");
internal static readonly KnownType NLog_LogManager = new("NLog.LogManager");
internal static readonly KnownType NUnit_Framework_Assert = new("NUnit.Framework.Assert");
internal static readonly KnownType NUnit_Framework_AssertionException = new("NUnit.Framework.AssertionException");
Expand Down
19 changes: 15 additions & 4 deletions analyzers/src/SonarAnalyzer.Common/Rules/Hotspots/ExecutingSqlQueriesBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,14 +121,23 @@ public abstract class ExecutingSqlQueriesBase<TSyntaxKind, TExpressionSyntax, TI
new(KnownType.ServiceStack_OrmLite_OrmLiteReadApiAsync, "SqlListAsync"),
new(KnownType.ServiceStack_OrmLite_OrmLiteReadApiAsync, "SqlColumnAsync"),
new(KnownType.ServiceStack_OrmLite_OrmLiteReadApiAsync, "SqlScalarAsync"),
new(KnownType.ServiceStack_OrmLite_OrmLiteReadApiAsync, "ExecuteNonQueryAsync"),
new(KnownType.ServiceStack_OrmLite_OrmLiteReadApiAsync, "ExecuteNonQueryAsync")
};

private readonly MemberDescriptor[] invocationsForFirstArgument =
{
new(KnownType.System_Data_Sqlite_SqliteCommand, "Execute"),
new(KnownType.System_Data_Entity_DbSet, "SqlQuery"),
new(KnownType.System_Data_Entity_DbSet_TEntity, "SqlQuery")
new(KnownType.System_Data_Entity_DbSet_TEntity, "SqlQuery"),
new(KnownType.NHibernate_ISession, "CreateQuery"),
new(KnownType.NHibernate_ISession, "CreateSQLQuery"),
new(KnownType.NHibernate_ISession, "Delete"),
new(KnownType.NHibernate_ISession, "DeleteAsync"),
new(KnownType.NHibernate_ISession, "GetNamedQuery"),
new(KnownType.NHibernate_Impl_AbstractSessionImpl, "CreateQuery"),
new(KnownType.NHibernate_Impl_AbstractSessionImpl, "CreateSQLQuery"),
new(KnownType.NHibernate_Impl_AbstractSessionImpl, "GetNamedQuery"),
pavel-mikula-sonarsource marked this conversation as resolved.
Show resolved Hide resolved
new(KnownType.NHibernate_Impl_AbstractSessionImpl, "GetNamedSQLQuery")
};

private readonly MemberDescriptor[] invocationsForSecondArgument =
Expand All @@ -144,12 +153,14 @@ public abstract class ExecutingSqlQueriesBase<TSyntaxKind, TExpressionSyntax, TI
new(KnownType.MySql_Data_MySqlClient_MySqlHelper, "ExecuteScalar"),
new(KnownType.MySql_Data_MySqlClient_MySqlHelper, "ExecuteScalarAsync"),
new(KnownType.MySql_Data_MySqlClient_MySqlHelper, "UpdateDataSet"),
new(KnownType.MySql_Data_MySqlClient_MySqlHelper, "UpdateDataSetAsync")
new(KnownType.MySql_Data_MySqlClient_MySqlHelper, "UpdateDataSetAsync"),
new(KnownType.NHibernate_ISession, "CreateFilter"),
new(KnownType.NHibernate_ISession, "CreateFilterAsync")
};

private readonly MemberDescriptor[] properties =
{
new(KnownType.System_Data_IDbCommand, "CommandText"),
new(KnownType.System_Data_IDbCommand, "CommandText")
};

protected abstract TExpressionSyntax GetArgumentAtIndex(InvocationContext context, int index);
Expand Down
7 changes: 7 additions & 0 deletions analyzers/tests/SonarAnalyzer.UnitTest/Rules/Hotspots/ExecutingSqlQueriesTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,5 +135,12 @@ public class ExecutingSqlQueriesTest
.AddReferences(MetadataReferenceFacade.SystemData)
.AddReferences(NuGetMetadataReference.ServiceStackOrmLite(Constants.NuGetLatestVersion))
.Verify();

[TestMethod]
public void ExecutingSqlQueries_NHibernate_CS() =>
builderCS
.AddPaths("ExecutingSqlQueries.NHibernate.cs")
.AddReferences(NuGetMetadataReference.NHibernate(Constants.NuGetLatestVersion))
.Verify();
}
}
74 changes: 74 additions & 0 deletions analyzers/tests/SonarAnalyzer.UnitTest/TestCases/Hotspots/ExecutingSqlQueries.NHibernate.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
using System;
using System.Linq;
using System.Threading.Tasks;
using NHibernate;
using NHibernate.Impl;

class Program
{
public async Task ISessionMethods(ISession session, string query, string param)
{
session.CreateFilter(null, query); // Compliant
session.CreateFilter(null, query + param); // Noncompliant

await session.CreateFilterAsync(null, query); // Compliant
await session.CreateFilterAsync(null, query + param); // Noncompliant

session.CreateQuery(query); // Compliant
session.CreateQuery(query + param); // Noncompliant

session.CreateSQLQuery(query); // Compliant
session.CreateSQLQuery(query + param); // Noncompliant

session.Delete(query); // Compliant
session.Delete(query + param); // Noncompliant

await session.DeleteAsync(query); // Compliant
await session.DeleteAsync(query + param); // Noncompliant

session.GetNamedQuery(query); // Compliant
session.GetNamedQuery(query + param); // Noncompliant
}

public async Task SessionImplMethods(SessionImpl session, string query, string param)
{
session.CreateFilter(null, query); // Compliant
session.CreateFilter(null, query + param); // Noncompliant

await session.CreateFilterAsync(null, query); // Compliant
await session.CreateFilterAsync(null, query + param); // Noncompliant

session.CreateQuery(query); // Compliant
session.CreateQuery(query + param); // Noncompliant

session.CreateSQLQuery(query); // Compliant
session.CreateSQLQuery(query + param); // Noncompliant

session.Delete(query); // Compliant
session.Delete(query + param); // Noncompliant

await session.DeleteAsync(query); // Compliant
await session.DeleteAsync(query + param); // Noncompliant

session.GetNamedQuery(query); // Compliant
session.GetNamedQuery(query + param); // Noncompliant

session.GetNamedSQLQuery(query); // Compliant
session.GetNamedSQLQuery(query + param); // Noncompliant
}

public async Task AbstractSessionImplMethods(AbstractSessionImpl session, string query, string param)
{
session.CreateQuery(query); // Compliant
session.CreateQuery(query + param); // Noncompliant

session.CreateSQLQuery(query); // Compliant
session.CreateSQLQuery(query + param); // Noncompliant

session.GetNamedQuery(query); // Compliant
session.GetNamedQuery(query + param); // Noncompliant

session.GetNamedSQLQuery(query); // Compliant
session.GetNamedSQLQuery(query + param); // Noncompliant
}
}