Skip to content

Fix S3459 FP: support classes marked with [AutoConstructor] attribute #9674

Open
@nycdotnet

Description

Description

We use the NuGet package Autoconstructor in many of our solutions. https://www.nuget.org/packages/AutoConstructor With this package, if a class is marked partial and has the [AutoConstructor] attribute, this NuGet package will generate a constructor that accepts an argument for and will assign a value to any readonly non-static fields (with various customizations possible).

In Visual Studio, the Sonar NuGet analyzer is able to interpret the generated constructor, but not in CI where we are wiring in sonarcloud.io. This means we will get S3459 wherever there are fields that are only assigned by the automatically generated constructor. (We don't check in the generated code).

Repro steps

namespace MyNameSpace;

[AutoConstructor]
public partial class SonarFalsePositive
{
    private TimeProvider TimeProvider { get; }

    public DateTimeOffset DoSomething()
    {
        return TimeProvider.GetUtcNow();
    }
}

Expected behavior

No S3459 just like in Visual Studio.

Actual behavior

S3459 is raised in SonarCloud.io: Remove unassigned auto-property 'TimeProvider', or set its value.

Known workarounds

We could disable S3459 in classes that use Autoconstructor or generally.
I wonder if this rule could be disabled maybe for partial classes if it's expected that your CI product can't use the generated code? Possibly only for partial classes that also have the Autoconstructor attribute? I see you already have an override for classes with [Serializable].

Related information

  • Visual Studio 2022 17.11.4
  • .NET 8
  • SonarScanner NuGet 9.10.0.77988 (in Visual Studio) which doesn't have the false positive. The false positive comes from sonar cloud in our CI.
  • Windows 10 latest

Metadata

Assignees

No one assigned

    Labels

    Area: C#C# rules related issues.Type: False PositiveRule IS triggered when it shouldn't be.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions