Skip to content

Fix S3963 FP: Static constructor with conditional and no static filed initialization #9512

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

Merged
sebastien-marichal merged 3 commits into from
Jul 11, 2024
Merged

Fix S3963 FP: Static constructor with conditional and no static filed initialization #9512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
25cdb54
CaYC commit
sebastien-marichal Jul 9, 2024
c8b617e
Fix S3963 FP: Static constructor with conditional and no static filed…
sebastien-marichal Jul 9, 2024
789f38c
Address comment
sebastien-marichal Jul 11, 2024
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
10 changes: 0 additions & 10 deletions analyzers/its/expected/akka.net/S3963-Akka.Cluster-netstandard2.0.json
View file
Open in desktop

This file was deleted.

74 changes: 36 additions & 38 deletions analyzers/src/SonarAnalyzer.CSharp/Rules/InitializeStaticFieldsInline.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,49 +18,47 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/

namespace SonarAnalyzer.Rules.CSharp
namespace SonarAnalyzer.Rules.CSharp;

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public sealed class InitializeStaticFieldsInline : SonarDiagnosticAnalyzer
{
[DiagnosticAnalyzer(LanguageNames.CSharp)]
public sealed class InitializeStaticFieldsInline : SonarDiagnosticAnalyzer
{
private const string DiagnosticId = "S3963";
private const string MessageFormat = "Initialize all 'static fields' inline and remove the 'static constructor'.";
private const string DiagnosticId = "S3963";
private const string MessageFormat = "Initialize all 'static fields' inline and remove the 'static constructor'.";

private static readonly DiagnosticDescriptor Rule = DescriptorFactory.Create(DiagnosticId, MessageFormat);
private static readonly DiagnosticDescriptor Rule = DescriptorFactory.Create(DiagnosticId, MessageFormat);

public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(Rule);
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(Rule);

protected override void Initialize(SonarAnalysisContext context) =>
context.RegisterNodeAction(c =>
protected override void Initialize(SonarAnalysisContext context) =>
context.RegisterNodeAction(c =>
{
var constructor = (ConstructorDeclarationSyntax)c.Node;
if (!constructor.Modifiers.Any(SyntaxKind.StaticKeyword)
|| (constructor.Body is null && constructor.ExpressionBody() is null))
{
var constructor = (ConstructorDeclarationSyntax)c.Node;
if (!constructor.Modifiers.Any(SyntaxKind.StaticKeyword)
|| (constructor.Body == null && constructor.ExpressionBody() == null))
{
return;
}
if (c.SemanticModel.GetDeclaredSymbol(constructor).ContainingType is { } currentType)
{
var bodyDescendantNodes = constructor.Body?.DescendantNodes().ToArray()
?? constructor.ExpressionBody()?.DescendantNodes().ToArray()
?? Array.Empty<SyntaxNode>();
return;
}
if (c.SemanticModel.GetDeclaredSymbol(constructor).ContainingType is { } currentType)
{
var bodyDescendantNodes = constructor.Body?.DescendantNodes().ToArray()
?? constructor.ExpressionBody()?.DescendantNodes().ToArray()
?? [];

var assignedFieldCount = bodyDescendantNodes
.OfType<AssignmentExpressionSyntax>()
.Select(x => c.SemanticModel.GetSymbolInfo(x.Left).Symbol)
.OfType<IFieldSymbol>()
.Where(x => x.ContainingType.Equals(currentType))
.Select(x => x.Name)
.Distinct()
.Count();
var hasIfOrSwitch = bodyDescendantNodes.Any(x => x.IsAnyKind(SyntaxKind.IfStatement, SyntaxKind.SwitchStatement));
if ((hasIfOrSwitch && assignedFieldCount <= 1)
|| (!hasIfOrSwitch && assignedFieldCount > 0))
{
c.ReportIssue(Rule, constructor.Identifier);
}
var assignedFieldCount = bodyDescendantNodes
.OfType<AssignmentExpressionSyntax>()
.Select(x => c.SemanticModel.GetSymbolInfo(x.Left).Symbol)
.OfType<IFieldSymbol>()
.Where(x => x.ContainingType.Equals(currentType))
.Select(x => x.Name)
.Distinct()
.Count();
var hasIfOrSwitch = Array.Exists(bodyDescendantNodes, x => x.IsAnyKind(SyntaxKind.IfStatement, SyntaxKind.SwitchStatement));
if ((hasIfOrSwitch && assignedFieldCount == 1) || (!hasIfOrSwitch && assignedFieldCount > 0))
{
c.ReportIssue(Rule, constructor.Identifier);
}
},
SyntaxKind.ConstructorDeclaration);
}
}
},
SyntaxKind.ConstructorDeclaration);
}
15 changes: 7 additions & 8 deletions analyzers/tests/SonarAnalyzer.Test/Rules/InitializeStaticFieldsInlineTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,12 @@

using SonarAnalyzer.Rules.CSharp;

namespace SonarAnalyzer.Test.Rules
namespace SonarAnalyzer.Test.Rules;

[TestClass]
public class InitializeStaticFieldsInlineTest
{
[TestClass]
public class InitializeStaticFieldsInlineTest
{
[TestMethod]
public void InitializeStaticFieldsInline() =>
new VerifierBuilder<InitializeStaticFieldsInline>().AddPaths("InitializeStaticFieldsInline.cs").Verify();
}
[TestMethod]
public void InitializeStaticFieldsInline() =>
new VerifierBuilder<InitializeStaticFieldsInline>().AddPaths("InitializeStaticFieldsInline.cs").Verify();
}
2 changes: 1 addition & 1 deletion analyzers/tests/SonarAnalyzer.Test/TestCases/InitializeStaticFieldsInline.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ static ReproSwitchMulti() // Compliant, because there are multiple variable a
public static class TestUtil
{
// https://github.com/SonarSource/sonar-dotnet/issues/6343
static TestUtil() // Noncompliant - FP, there are no static fields
static TestUtil() // Compliant
{
if (!Directory.Exists(""))
{
Expand Down