Skip to content

Add SonarAnalyzer.CSharp and tighten Roslyn analyzer rules #61

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
tillig merged 8 commits into from
May 29, 2026
Merged

Add SonarAnalyzer.CSharp and tighten Roslyn analyzer rules #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
843374f
Add SonarAnalyzer.CSharp and unified analyzer rulesets.
tillig May 28, 2026
121780b
Disable CA1034 in Test.ruleset: nested types are standard in test fix…
tillig May 28, 2026
66bbc9a
Fix S6608: use indexer instead of LINQ First().
tillig May 28, 2026
02cf348
Fix S2699: add assertions to tests that verify no exception is thrown.
tillig May 28, 2026
293c10f
Disable S1133: do not warn on use of obsolete/deprecated members.
tillig May 29, 2026
f6321a6
Enable CA1063, disable S3881, fix ruleset comment ordering.
tillig May 29, 2026
91a0b7e
Disable CA2201 in Test.ruleset: tests use generic exceptions for simu…
tillig May 29, 2026
45151df
Disable CA1711, CA1721, S125 in Test.ruleset.
tillig May 29, 2026
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
6 changes: 6 additions & 0 deletions bench/Autofac.Extras.DynamicProxy.Benchmarks/Autofac.Extras.DynamicProxy.Benchmarks.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
<PackageId>Autofac.Extras.DynamicProxy.Benchmarks</PackageId>
<GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
<CodeAnalysisRuleSet>../../build/Test.ruleset</CodeAnalysisRuleSet>
<AnalysisMode>AllEnabledByDefault</AnalysisMode>
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
</PropertyGroup>

<ItemGroup>
Expand All @@ -27,6 +29,10 @@
</PackageReference>
<PackageReference Include="xunit" Version="2.4.2" />
<PackageReference Include="BenchmarkDotNet" Version="0.13.5" />
<PackageReference Include="SonarAnalyzer.CSharp" Version="10.27.0.140913">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>

<ItemGroup>
Expand Down
6 changes: 4 additions & 2 deletions bench/Autofac.Extras.DynamicProxy.Benchmarks/Harness.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,15 @@ public class Harness
[Fact]
public void ClassInterception()
{
BenchmarkRunner.Run<ClassInterceptionBenchmark>();
var exception = Record.Exception(() => BenchmarkRunner.Run<ClassInterceptionBenchmark>());
Assert.Null(exception);
}

[Fact]
public void InterfaceInterception()
{
BenchmarkRunner.Run<InterfaceInterceptionBenchmark>();
var exception = Record.Exception(() => BenchmarkRunner.Run<InterfaceInterceptionBenchmark>());
Assert.Null(exception);
}
}
}
48 changes: 36 additions & 12 deletions build/Source.ruleset
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<RuleSet Name="Autofac Analyzer Rules" Description="Analyzer rules for Autofac assemblies." ToolsVersion="16.0">
<?xml version="1.0" encoding="utf-8"?>
<RuleSet Name="Autofac Analyzer Rules" Description="Analyzer rules for Autofac source assemblies." ToolsVersion="16.0">
<IncludeAll Action="Warning" />
<Rules AnalyzerId="Microsoft.Usage" RuleNamespace="Microsoft.Usage">
<!-- Implement standard exception constructors - not all of the exception constructors (e.g., parameterless) are desired in our system. -->
<Rules AnalyzerId="Microsoft.CodeAnalysis.Analyzers" RuleNamespace="Microsoft.CodeAnalysis.Analyzers">
<!-- Implement standard exception constructors - not all of the exception constructors are desired. -->
<Rule Id="CA1032" Action="None" />
<!-- Implement IDisposable correctly (must be explicitly enabled). -->
<Rule Id="CA1063" Action="Warning" />
<!-- Avoid excessive inheritance (must be explicitly enabled). -->
<Rule Id="CA1501" Action="Warning" />
<!-- Avoid excessive complexity (must be explicitly enabled). -->
Expand All @@ -12,23 +14,45 @@
<Rule Id="CA1505" Action="Warning" />
<!-- Avoid excessive class coupling (must be explicitly enabled). -->
<Rule Id="CA1506" Action="Warning" />
<!-- Use ArgumentNullException.ThrowIfNull - this isn't available until we stop targeting netstandard. -->
<!-- Use ArgumentNullException.ThrowIfNull - not available in netstandard. -->
<Rule Id="CA1510" Action="None" />
<!-- Use ArgumentOutOfRangeException.ThrowIfNegative - this isn't available until we stop targeting anything below net8.0. -->
<!-- Use ArgumentOutOfRangeException.ThrowIfNegative - not available below net8.0. -->
<Rule Id="CA1512" Action="None" />
<!-- Use ObjectDisposedException.ThrowIf - this isn't available until we stop targeting anything below net8.0. -->
<!-- Use ObjectDisposedException.ThrowIf - not available below net8.0. -->
<Rule Id="CA1513" Action="None" />
<!-- Change names to avoid reserved word overlaps (e.g., Delegate, GetType, etc.) - too many of these in the public API, we'd break if we fixed it. -->
<!-- Change names to avoid reserved word overlaps - would break public API. -->
<Rule Id="CA1716" Action="None" />
<!-- Cache a CompositeFormat object for use in String.Format - this isn't available until we stop targeting netstandard, and we only String.Format when throwing exceptions so the work/complexity isn't justified to increase perf just for those situations. -->
<!-- Cache a CompositeFormat - not available in netstandard. -->
<Rule Id="CA1863" Action="None" />
<!-- Implement serialization constructors - false positive when building .NET Core. -->
<!-- Implement serialization constructors - false positive in .NET Core. -->
<Rule Id="CA2229" Action="None" />
<!-- Mark ISerializable types with SerializableAttribute - false positive when building .NET Core. -->
<!-- Mark ISerializable types with SerializableAttribute - false positive in .NET Core. -->
<Rule Id="CA2237" Action="None" />
<!-- Prefer generic overloads to using Type parameters - many aren't available in earlier frameworks; and we do a lot of reflection work in Autofac. -->
<!-- Prefer generic overloads - conflicts with reflection work in Autofac. -->
<Rule Id="CA2263" Action="None" />
</Rules>
<Rules AnalyzerId="SonarAnalyzer.CSharp" RuleNamespace="SonarAnalyzer.CSharp">
<!-- "Sonar Way" rules to match SonarQube scans. -->
<Rule Id="S107" Action="Warning" />
<!-- Do not use obsolete members - Autofac maintains deprecated APIs for backward compat. -->
<Rule Id="S1133" Action="None" />
<Rule Id="S1192" Action="Warning" />
<Rule Id="S1313" Action="Warning" />
<Rule Id="S2259" Action="Warning" />
<Rule Id="S2583" Action="Warning" />
<Rule Id="S2589" Action="Warning" />
<!-- Verify reflection accessibility bypass - DI containers do extensive reflection by design. -->
<Rule Id="S3011" Action="None" />
<!-- Loops should use LINQ - DI container hot paths intentionally avoid LINQ allocations. -->
<Rule Id="S3267" Action="None" />
<Rule Id="S3776" Action="Warning" />
<!-- IDisposable pattern - Autofac uses non-standard dispose patterns for container lifecycle. -->
<Rule Id="S3881" Action="None" />
<!-- Split method for params check + iterator - overly prescriptive for our patterns. -->
<Rule Id="S4456" Action="None" />
<Rule Id="S6418" Action="Warning" />
<Rule Id="S6444" Action="Warning" />
</Rules>
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
<!-- Prefix local calls with this. -->
<Rule Id="SA1101" Action="None" />
Expand Down
119 changes: 90 additions & 29 deletions build/Test.ruleset
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
<RuleSet Name="Autofac Analyzer Rules" Description="Analyzer rules for Autofac assemblies." ToolsVersion="16.0">
<?xml version="1.0" encoding="utf-8"?>
<RuleSet Name="Autofac Analyzer Rules" Description="Analyzer rules for Autofac test assemblies." ToolsVersion="16.0">
<IncludeAll Action="Warning" />
<Rules AnalyzerId="Microsoft.Usage" RuleNamespace="Microsoft.Usage">
<!-- Avoid excessive parameters on generic types (must be explicitly enabled). -->
<Rule Id="CA1005" Action="Warning" />
<!-- Don't catch general exceptions - test scenarios sometimes require general exception handling. -->
<Rules AnalyzerId="Microsoft.CodeAnalysis.Analyzers" RuleNamespace="Microsoft.CodeAnalysis.Analyzers">
<!-- Don't catch general exceptions - test scenarios sometimes require it. -->
<Rule Id="CA1031" Action="None" />
<!-- Implement standard exception constructors - not all of the exception constructors (e.g., parameterless) are desired in our system. -->
<Rule Id="CA1032" Action="None" />
<!-- Avoid empty interfaces - in unit tests for service resolution, this happens a lot. -->
<!-- Avoid empty interfaces - happens a lot in unit tests for service resolution. -->
<Rule Id="CA1040" Action="None" />
<!-- Do not pass literals as localized parameters - tests don't need to localize. -->
<!-- Implement IDisposable correctly (must be explicitly enabled). -->
<Rule Id="CA1063" Action="Warning" />
<!-- Do not pass literals as localized parameters - tests don't need to localize. -->
<Rule Id="CA1303" Action="None" />
<!-- Avoid excessive inheritance (must be explicitly enabled). -->
<Rule Id="CA1501" Action="Warning" />
Expand All @@ -20,49 +18,105 @@
<Rule Id="CA1505" Action="Warning" />
<!-- Avoid excessive class coupling (must be explicitly enabled). -->
<Rule Id="CA1506" Action="Warning" />
<!-- Use ArgumentNullException.ThrowIfNull - this isn't available until we stop targeting netstandard. -->
<Rule Id="CA1510" Action="None" />
<!-- Make API types internal - causes problems with tests and test assemblies. -->
<!-- Make API types internal - causes problems with tests. -->
<Rule Id="CA1515" Action="None" />
<!-- Remove the underscores from member name - unit test scenarios may use underscores. -->
<!-- Remove underscores from member name - test naming conventions use underscore. -->
<Rule Id="CA1707" Action="None" />
<!-- Change names to avoid reserved word overlaps (e.g., Delegate, GetType, etc.) - too many of these in the public API, we'd break if we fixed it. -->
<Rule Id="CA1716" Action="None" />
<!-- Internal class that appears to never be instantiated - lots of false positives here because they're test stubs created by Autofac registrations. -->
<!-- Internal class that appears to never be instantiated - false positives from DI. -->
<!-- Identifiers should not have incorrect suffix - test classes use Impl, Handler, etc. -->
<Rule Id="CA1711" Action="None" />
<!-- Property names should not match get methods - aggregate service tests intentionally test both. -->
<Rule Id="CA1721" Action="None" />
<Rule Id="CA1812" Action="None" />
<!-- Change Dispose() to call GC.SuppressFinalize - in tests we don't really care and it can impact readability. -->
<!-- Change Dispose() to call GC.SuppressFinalize - unimportant in tests. -->
<Rule Id="CA1816" Action="None" />
<!-- Mark members static - test methods may not access member data but also can't be static. -->
<!-- Mark members static - test methods may not access member data. -->
<Rule Id="CA1822" Action="None" />
<!-- Seal internal types for performance - in tests we don't really care and it gets painful to enforce. -->
<!-- Use the LoggerMessage delegates - noise in tests, performance irrelevant. -->
<Rule Id="CA1848" Action="None" />
<!-- Seal internal types - unimportant in tests. -->
<Rule Id="CA1852" Action="None" />
<!-- Prefer static readonly fields over constant array arguments - constant array arguments happen a lot in unit tests for assertions and test setup. -->
<!-- Prefer static readonly fields over constant arrays - happens in test setup. -->
<Rule Id="CA1861" Action="None" />
<!-- Cache a CompositeFormat object for use in String.Format - this makes unit tests harder to read, and performance isn't an issue. -->
<!-- Cache a CompositeFormat - makes tests harder to read. -->
<Rule Id="CA1863" Action="None" />
<!-- Call ConfigureAwait on tasks - you shouldn't do this in unit test libraries; XUnit has an opposite analyzer. -->
<!-- Call ConfigureAwait - shouldn't in test libraries; XUnit has opposing analyzer. -->
<Rule Id="CA2007" Action="None" />
<!-- Implement serialization constructors - false positive when building .NET Core. -->
<!-- Implement serialization constructors - false positive in .NET Core. -->
<!-- Do not raise reserved exception types - tests use generic exceptions for simulation. -->
<Rule Id="CA2201" Action="None" />
<Rule Id="CA2229" Action="None" />
<!-- Use Uri instead of string parameters - strings are easier for testing. -->
<Rule Id="CA2234" Action="None" />
<!-- Mark ISerializable types with SerializableAttribute - false positive when building .NET Core. -->
<!-- Mark ISerializable types with SerializableAttribute - false positive in .NET Core. -->
<Rule Id="CA2237" Action="None" />
<!-- Prefer generic overloads to using Type parameters - we do a lot of reflection work in Autofac that needs to be tested. -->
<!-- Nested types should not be visible - test scenario classes use nested types extensively. -->
<Rule Id="CA1034" Action="None" />
<!-- Prefer generic overloads - reflection work in Autofac needs to be tested. -->
<Rule Id="CA2263" Action="None" />
</Rules>
<Rules AnalyzerId="SonarAnalyzer.CSharp" RuleNamespace="SonarAnalyzer.CSharp">
<!-- Don't use hardcoded paths or URIs - needed in several test cases. -->
<Rule Id="S1075" Action="None" />
<!-- Utility class should not be instantiated - test fixture classes with nested tests can't be static. -->
<!-- Sections of code should not be commented out - test files may retain commented examples. -->
<Rule Id="S125" Action="None" />
<Rule Id="S1118" Action="None" />
<!-- Don't call GC.Collect - required for weak reference and disposal tests. -->
<Rule Id="S1215" Action="None" />
<!-- Do not use obsolete members - tests exercise deprecated APIs to verify backward compat. -->
<Rule Id="S1133" Action="None" />
<!-- Remove unused private members - reflection tests need non-public members. -->
<Rule Id="S1144" Action="None" />
<!-- Empty method bodies - test stubs often have no-op implementations. -->
<Rule Id="S1186" Action="None" />
<!-- Remove unused method parameters - reflection tests declare parameters not used in the body. -->
<Rule Id="S1172" Action="None" />
<!-- Remove empty class - test stubs for DI resolution don't need implementation. -->
<Rule Id="S2094" Action="None" />
<!-- Make member static - test fixture members may not access instance data. -->
<Rule Id="S2325" Action="None" />
<!-- Remove unused type parameters - used in reflection testing. -->
<Rule Id="S2326" Action="None" />
<!-- Write-only properties - reflection tests verify property setter behavior. -->
<Rule Id="S2376" Action="None" />
<!-- Classes with only private constructors - reflection tests verify inaccessible constructors. -->
<Rule Id="S3453" Action="None" />
<!-- Remove unassigned auto-property - reflection tests verify non-public property behavior. -->
<Rule Id="S3459" Action="None" />
<!-- Complete the TODO - acceptable in tests for backlog items. -->
<Rule Id="S1135" Action="None" />
<!-- Make instance property static - false positives in data/document types. -->
<Rule Id="S2335" Action="None" />
<!-- Cognitive complexity (must be explicitly enabled). -->
<Rule Id="S3776" Action="Warning" />
<!-- IDisposable pattern - test dispose implementations are intentionally simplified. -->
<Rule Id="S3881" Action="None" />
<!-- Split method for params check + iterator - overly prescriptive for our patterns. -->
<Rule Id="S4456" Action="None" />
<!-- Don't use Thread.Sleep - required for concurrency and timing tests. -->
<Rule Id="S2925" Action="None" />
<!-- NSubstitute mock verification is complete without property access. -->
<Rule Id="S2970" Action="None" />
<!-- Fields only assigned in constructor - needed to prevent optimization in reflection tests. -->
<Rule Id="S4487" Action="None" />
<!-- Set route attributes at top of controller - false positive. -->
<Rule Id="S6934" Action="None" />
<!-- Use async dispose - sync dispose tests are intentional. -->
<Rule Id="S6966" Action="None" />
</Rules>
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
<!-- Prefix local calls with this. -->
<Rule Id="SA1101" Action="None" />
<!-- Use built-in type alias. -->
<Rule Id="SA1121" Action="None" />
<!-- Use String.Empty instead of "". -->
<Rule Id="SA1122" Action="None" />
<!-- Enforce order of class members by member type - sometimes putting test classes/data by the test helps. -->
<!-- Enforce order of class members by member type. -->
<Rule Id="SA1201" Action="None" />
<!-- Enforce order of class members by member visibility - sometimes putting test classes/data by the test helps. -->
<!-- Enforce order of class members by visibility. -->
<Rule Id="SA1202" Action="None" />
<!-- Enforce order of static vs. non-static members - sometimes putting test classes/data by the test helps. -->
<!-- Enforce order of static vs. non-static members. -->
<Rule Id="SA1204" Action="None" />
<!-- Fields can't start with underscore. -->
<Rule Id="SA1309" Action="None" />
Expand All @@ -82,6 +136,13 @@
<Rule Id="SA1618" Action="None" />
<!-- Don't copy/paste documentation. -->
<Rule Id="SA1625" Action="None" />
</Rules>
<Rules AnalyzerId="xUnit" RuleNamespace="xUnit">
<!-- Use Assert.Single when there's only one collection entry. -->
<Rule Id="xUnit2023" Action="Warning" />
</Rules>
<!-- IDE rules for test assemblies. -->
<Rules AnalyzerId="Microsoft.CodeAnalysis.CSharp" RuleNamespace="Microsoft.CodeAnalysis.CSharp">
<!-- Private member is unused - tests for reflection require members that may not get used. -->
<Rule Id="IDE0051" Action="None" />
<!-- Private member assigned value never read - tests for reflection require values that may not get used. -->
Expand Down
4 changes: 4 additions & 0 deletions src/Autofac.Extras.DynamicProxy/Autofac.Extras.DynamicProxy.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@
<PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556">
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="SonarAnalyzer.CSharp" Version="10.27.0.140913">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>

<ItemDefinitionGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/Autofac.Extras.DynamicProxy/RegistrationExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ public static IRegistrationBuilder<TLimit, TActivatorData, TSingleRegistrationSt
return;
}

var theInterface = proxiedInterfaces.First();
var theInterface = proxiedInterfaces[0];
var interfaces = proxiedInterfaces.Skip(1).ToArray();

var interceptors = GetInterceptorServices(ctx.Registration, ctx.Instance.GetType())
Expand Down
5 changes: 5 additions & 0 deletions ...micProxy.Test.SatelliteAssembly/Autofac.Extras.DynamicProxy.Test.SatelliteAssembly.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<PackageId>Autofac.Extras.DynamicProxy.Test.SatelliteAssembly</PackageId>
<GenerateAssemblyTitleAttribute>false</GenerateAssemblyTitleAttribute>
<CodeAnalysisRuleSet>../../build/Test.ruleset</CodeAnalysisRuleSet>
<AnalysisMode>AllEnabledByDefault</AnalysisMode>
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
<ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>
Expand All @@ -18,6 +19,10 @@
<PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556">
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="SonarAnalyzer.CSharp" Version="10.27.0.140913">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>

<ItemGroup>
Expand Down
5 changes: 5 additions & 0 deletions test/Autofac.Extras.DynamicProxy.Test/Autofac.Extras.DynamicProxy.Test.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<SignAssembly>true</SignAssembly>
<GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
<CodeAnalysisRuleSet>../../build/Test.ruleset</CodeAnalysisRuleSet>
<AnalysisMode>AllEnabledByDefault</AnalysisMode>
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
<IsPackable>false</IsPackable>
<LangVersion>latest</LangVersion>
Expand Down Expand Up @@ -42,6 +43,10 @@
<PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556">
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="SonarAnalyzer.CSharp" Version="10.27.0.140913">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="xunit" Version="2.9.3" />
<PackageReference Include="xunit.runner.visualstudio" Version="3.1.0">
<PrivateAssets>all</PrivateAssets>
Expand Down
Loading