search

dotnet / roslyn-analyzers

MIT License
1.55k stars 460 forks source link

Do not warn when invoking APIs that has SupportedOSPlatformGuard attribute #7326

Closed buyaa-n closed 3 weeks ago

buyaa-n commented 3 weeks ago

Do not warn when invoking Guard APIs that has SupportedOSPlatformGuard attribute

Fixes issue @ManickaP encountered on https://github.com/dotnet/runtime/compare/main...ManickaP:runtime:quic-platform-guard?expand=1

Added unit test that reproes the issue

Repro:

[assembly: System.Runtime.Versioning.SupportedOSPlatform(""windows"")]
[assembly: System.Runtime.Versioning.SupportedOSPlatform(""linux"")]
[assembly: System.Runtime.Versioning.SupportedOSPlatform(""osx"")]

namespace System.Net.Quic;
public sealed partial class QuicConnection
{
    [SupportedOSPlatformGuard("windows")]
    [SupportedOSPlatformGuard("linux")]
    [SupportedOSPlatformGuard("osx")]
    public static bool IsSupported => false;
    ...
}

The Guard API used from another assembly, should not warn on QuicConnection.IsSupported invocation

namespace System.Net.Http;
internal sealed partial class HttpConnectionPool : IDisposable
{
    private async ValueTask<QuicConnection> ConnectAsync(CancellationToken cancellationToken) ()
    {
        if (QuicConnection.IsSupported) // Currently warning here, fixing this
        {
            await QuicConnection.ConnectAsync(new QuicClientConnectionOptions(), cancellationToken).ConfigureAwait(false);
        }
    }
}
buyaa-n commented 3 weeks ago

@sharwell there is something broke in the repo, normal build succeeds but dotnet build /t:pack fails with MSBuild error: How can I fix this? cc @mavasani 

Microsoft.CodeAnalysis.PublicApiAnalyzers.Package failed with 1 error(s) (1.0s)
    D:\dotnet\roslyn-analyzers\eng\GenerateAnalyzerNuspec.targets(113,5): error MSB3073: The command ""D:\dotnet\roslyn-analyzers\.dotnet\dotnet.exe" --roll-forward major "D:\dotnet\roslyn-analyzers\artifacts\bin\GenerateDocumentationAndConfigFiles\Debug\net9.0\GenerateDocumentationAndConfigFiles.dll" "-validateOnly:false" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.PublicApiAnalyzers.Package\Debug\netstandard2.0\Rulesets" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.PublicApiAnalyzers.Package\Debug\netstandard2.0\Editorconfig" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.PublicApiAnalyzers.Package\Debug\netstandard2.0\GlobalAnalyzerConfigs" "D:\dotnet\roslyn-analyzers\artifacts\bin\\" "Debug" "netstandard2.0" "Microsoft.CodeAnalysis.PublicApiAnalyzers.dll;Microsoft.CodeAnalysis.PublicApiAnalyzers.CodeFixes.dll" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.PublicApiAnalyzers.Package\Debug\netstandard2.0\Build" "Microsoft.CodeAnalysis.PublicApiAnalyzers.props" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.PublicApiAnalyzers.Package\Debug\netstandard2.0\Build" "Microsoft.CodeAnalysis.PublicApiAnalyzers.targets" "" "D:\dotnet\roslyn-analyzers\src\PublicApiAnalyzers" "Microsoft.CodeAnalysis.PublicApiAnalyzers.md" "D:\dotnet\roslyn-analyzers\src\PublicApiAnalyzers" "Microsoft.CodeAnalysis.PublicApiAnalyzers.sarif" "3.11.0" Microsoft.CodeAnalysis.PublicApiAnalyzers false true "" false" exited with code -2147450730.
  Roslyn.Diagnostics.Analyzers.Package failed with 1 error(s) (3.2s)
    D:\dotnet\roslyn-analyzers\eng\GenerateAnalyzerNuspec.targets(113,5): error MSB3073: The command ""D:\dotnet\roslyn-analyzers\.dotnet\dotnet.exe" --roll-forward major "D:\dotnet\roslyn-analyzers\artifacts\bin\GenerateDocumentationAndConfigFiles\Debug\net9.0\GenerateDocumentationAndConfigFiles.dll" "-validateOnly:false" "D:\dotnet\roslyn-analyzers\artifacts\obj\Roslyn.Diagnostics.Analyzers.Package\Debug\netstandard2.0\Rulesets" "D:\dotnet\roslyn-analyzers\artifacts\obj\Roslyn.Diagnostics.Analyzers.Package\Debug\netstandard2.0\Editorconfig" "D:\dotnet\roslyn-analyzers\artifacts\obj\Roslyn.Diagnostics.Analyzers.Package\Debug\netstandard2.0\GlobalAnalyzerConfigs" "D:\dotnet\roslyn-analyzers\artifacts\bin\\" "Debug" "netstandard2.0" "Roslyn.Diagnostics.Analyzers.dll;Roslyn.Diagnostics.CSharp.Analyzers.dll;Roslyn.Diagnostics.VisualBasic.Analyzers.dll" "D:\dotnet\roslyn-analyzers\artifacts\obj\Roslyn.Diagnostics.Analyzers.Package\Debug\netstandard2.0\Build" "Roslyn.Diagnostics.Analyzers.props" "D:\dotnet\roslyn-analyzers\artifacts\obj\Roslyn.Diagnostics.Analyzers.Package\Debug\netstandard2.0\Build" "Roslyn.Diagnostics.Analyzers.targets" "" "D:\dotnet\roslyn-analyzers\src\Roslyn.Diagnostics.Analyzers" "Roslyn.Diagnostics.Analyzers.md" "D:\dotnet\roslyn-analyzers\src\Roslyn.Diagnostics.Analyzers" "Roslyn.Diagnostics.Analyzers.sarif" "3.11.0" Roslyn.Diagnostics.Analyzers false true "" false" exited with code -2147450730.
  Microsoft.CodeAnalysis.ResxSourceGenerator.Package failed with 1 error(s) (1.3s)
    D:\dotnet\roslyn-analyzers\eng\GenerateAnalyzerNuspec.targets(113,5): error MSB3073: The command ""D:\dotnet\roslyn-analyzers\.dotnet\dotnet.exe" --roll-forward major "D:\dotnet\roslyn-analyzers\artifacts\bin\GenerateDocumentationAndConfigFiles\Debug\net9.0\GenerateDocumentationAndConfigFiles.dll" "-validateOnly:false" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.ResxSourceGenerator.Package\Debug\netstandard2.0\Rulesets" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.ResxSourceGenerator.Package\Debug\netstandard2.0\Editorconfig" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.ResxSourceGenerator.Package\Debug\netstandard2.0\GlobalAnalyzerConfigs" "D:\dotnet\roslyn-analyzers\artifacts\bin\\" "Debug" "netstandard2.0" "Microsoft.CodeAnalysis.ResxSourceGenerator.dll;Microsoft.CodeAnalysis.ResxSourceGenerator.CSharp.dll;Microsoft.CodeAnalysis.ResxSourceGenerator.VisualBasic.dll" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.ResxSourceGenerator.Package\Debug\netstandard2.0\Build" "Microsoft.CodeAnalysis.ResxSourceGenerator.props" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.ResxSourceGenerator.Package\Debug\netstandard2.0\Build" "Microsoft.CodeAnalysis.ResxSourceGenerator.targets" "" "D:\dotnet\roslyn-analyzers\src\Microsoft.CodeAnalysis.ResxSourceGenerator" "Microsoft.CodeAnalysis.ResxSourceGenerator.md" "D:\dotnet\roslyn-analyzers\src\Microsoft.CodeAnalysis.ResxSourceGenerator" "Microsoft.CodeAnalysis.ResxSourceGenerator.sarif" "3.11.0" Microsoft.CodeAnalysis.ResxSourceGenerator false true "true" false" exited with code -2147450730.
  Microsoft.CodeAnalysis.NetAnalyzers.Package failed with 1 error(s) (1.5s)
    D:\dotnet\roslyn-analyzers\eng\GenerateAnalyzerNuspec.targets(113,5): error MSB3073: The command ""D:\dotnet\roslyn-analyzers\.dotnet\dotnet.exe" --roll-forward major "D:\dotnet\roslyn-analyzers\artifacts\bin\GenerateDocumentationAndConfigFiles\Debug\net9.0\GenerateDocumentationAndConfigFiles.dll" "-validateOnly:false" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.NetAnalyzers.Package\Debug\netstandard2.0\Rulesets" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.NetAnalyzers.Package\Debug\netstandard2.0\Editorconfig" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.NetAnalyzers.Package\Debug\netstandard2.0\GlobalAnalyzerConfigs" "D:\dotnet\roslyn-analyzers\artifacts\bin\\" "Debug" "netstandard2.0" "Microsoft.CodeAnalysis.NetAnalyzers.dll;Microsoft.CodeAnalysis.CSharp.NetAnalyzers.dll;Microsoft.CodeAnalysis.VisualBasic.NetAnalyzers.dll" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.NetAnalyzers.Package\Debug\netstandard2.0\Build" "Microsoft.CodeAnalysis.NetAnalyzers.props" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.NetAnalyzers.Package\Debug\netstandard2.0\Build" "Microsoft.CodeAnalysis.NetAnalyzers.targets" "DisableNETAnalyzersForNuGetPackage.props" "D:\dotnet\roslyn-analyzers\src\NetAnalyzers" "Microsoft.CodeAnalysis.NetAnalyzers.md" "D:\dotnet\roslyn-analyzers\src\NetAnalyzers" "Microsoft.CodeAnalysis.NetAnalyzers.sarif" "9.0.0" Microsoft.CodeAnalysis.NetAnalyzers true true "" false" exited with code -2147450730.
  Microsoft.CodeAnalysis.Analyzers.Package failed with 1 error(s) (0.8s)
    D:\dotnet\roslyn-analyzers\eng\GenerateAnalyzerNuspec.targets(113,5): error MSB3073: The command ""D:\dotnet\roslyn-analyzers\.dotnet\dotnet.exe" --roll-forward major "D:\dotnet\roslyn-analyzers\artifacts\bin\GenerateDocumentationAndConfigFiles\Debug\net9.0\GenerateDocumentationAndConfigFiles.dll" "-validateOnly:false" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.Analyzers.Package\Debug\netstandard2.0\Rulesets" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.Analyzers.Package\Debug\netstandard2.0\Editorconfig" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.Analyzers.Package\Debug\netstandard2.0\GlobalAnalyzerConfigs" "D:\dotnet\roslyn-analyzers\artifacts\bin\\" "Debug" "netstandard2.0" "Microsoft.CodeAnalysis.Analyzers.dll;Microsoft.CodeAnalysis.CSharp.Analyzers.dll;Microsoft.CodeAnalysis.VisualBasic.Analyzers.dll" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.Analyzers.Package\Debug\netstandard2.0\Build" "Microsoft.CodeAnalysis.Analyzers.props" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.Analyzers.Package\Debug\netstandard2.0\Build" "Microsoft.CodeAnalysis.Analyzers.targets" "" "D:\dotnet\roslyn-analyzers\src\Microsoft.CodeAnalysis.Analyzers" "Microsoft.CodeAnalysis.Analyzers.md" "D:\dotnet\roslyn-analyzers\src\Microsoft.CodeAnalysis.Analyzers" "Microsoft.CodeAnalysis.Analyzers.sarif" "3.11.0" Microsoft.CodeAnalysis.Analyzers false true "" false" exited with code -2147450730.
  Microsoft.CodeAnalysis.PerformanceSensitiveAnalyzers.Package failed with 1 error(s) (0.6s)
    D:\dotnet\roslyn-analyzers\eng\GenerateAnalyzerNuspec.targets(113,5): error MSB3073: The command ""D:\dotnet\roslyn-analyzers\.dotnet\dotnet.exe" --roll-forward major "D:\dotnet\roslyn-analyzers\artifacts\bin\GenerateDocumentationAndConfigFiles\Debug\net9.0\GenerateDocumentationAndConfigFiles.dll" "-validateOnly:false" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.PerformanceSensitiveAnalyzers.Package\Debug\netstandard2.0\Rulesets" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.PerformanceSensitiveAnalyzers.Package\Debug\netstandard2.0\Editorconfig" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.PerformanceSensitiveAnalyzers.Package\Debug\netstandard2.0\GlobalAnalyzerConfigs" "D:\dotnet\roslyn-analyzers\artifacts\bin\\" "Debug" "netstandard2.0" "Microsoft.CodeAnalysis.PerformanceSensitiveAnalyzers.dll;Microsoft.CodeAnalysis.CSharp.PerformanceSensitiveAnalyzers.dll;Microsoft.CodeAnalysis.CSharp.PerformanceSensitiveAnalyzers.CodeFixes.dll" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.PerformanceSensitiveAnalyzers.Package\Debug\netstandard2.0\Build" "Microsoft.CodeAnalysis.PerformanceSensitiveAnalyzers.props" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.PerformanceSensitiveAnalyzers.Package\Debug\netstandard2.0\Build" "Microsoft.CodeAnalysis.PerformanceSensitiveAnalyzers.targets" "" "D:\dotnet\roslyn-analyzers\src\PerformanceSensitiveAnalyzers" "Microsoft.CodeAnalysis.PerformanceSensitiveAnalyzers.md" "D:\dotnet\roslyn-analyzers\src\PerformanceSensitiveAnalyzers" "Microsoft.CodeAnalysis.PerformanceSensitiveAnalyzers.sarif" "3.11.0" Microsoft.CodeAnalysis.PerformanceSensitiveAnalyzers false true "" false" exited with code -2147450730.
  Microsoft.CodeAnalysis.BannedApiAnalyzers.Package failed with 1 error(s) (0.2s)
    D:\dotnet\roslyn-analyzers\eng\GenerateAnalyzerNuspec.targets(113,5): error MSB3073: The command ""D:\dotnet\roslyn-analyzers\.dotnet\dotnet.exe" --roll-forward major "D:\dotnet\roslyn-analyzers\artifacts\bin\GenerateDocumentationAndConfigFiles\Debug\net9.0\GenerateDocumentationAndConfigFiles.dll" "-validateOnly:false" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.BannedApiAnalyzers.Package\Debug\netstandard2.0\Rulesets" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.BannedApiAnalyzers.Package\Debug\netstandard2.0\Editorconfig" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.BannedApiAnalyzers.Package\Debug\netstandard2.0\GlobalAnalyzerConfigs" "D:\dotnet\roslyn-analyzers\artifacts\bin\\" "Debug" "netstandard2.0" "Microsoft.CodeAnalysis.BannedApiAnalyzers.dll;Microsoft.CodeAnalysis.CSharp.BannedApiAnalyzers.dll;Microsoft.CodeAnalysis.VisualBasic.BannedApiAnalyzers.dll" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.BannedApiAnalyzers.Package\Debug\netstandard2.0\Build" "Microsoft.CodeAnalysis.BannedApiAnalyzers.props" "D:\dotnet\roslyn-analyzers\artifacts\obj\Microsoft.CodeAnalysis.BannedApiAnalyzers.Package\Debug\netstandard2.0\Build" "Microsoft.CodeAnalysis.BannedApiAnalyzers.targets" "" "D:\dotnet\roslyn-analyzers\src\Microsoft.CodeAnalysis.BannedApiAnalyzers" "Microsoft.CodeAnalysis.BannedApiAnalyzers.md" "D:\dotnet\roslyn-analyzers\src\Microsoft.CodeAnalysis.BannedApiAnalyzers" "Microsoft.CodeAnalysis.BannedApiAnalyzers.sarif" "3.11.0" Microsoft.CodeAnalysis.BannedApiAnalyzers false true "" false" exited with code -2147450730.
  Text.Analyzers.Package failed with 1 error(s) (0.6s)
    D:\dotnet\roslyn-analyzers\eng\GenerateAnalyzerNuspec.targets(113,5): error MSB3073: The command ""D:\dotnet\roslyn-analyzers\.dotnet\dotnet.exe" --roll-forward major "D:\dotnet\roslyn-analyzers\artifacts\bin\GenerateDocumentationAndConfigFiles\Debug\net9.0\GenerateDocumentationAndConfigFiles.dll" "-validateOnly:false" "D:\dotnet\roslyn-analyzers\artifacts\obj\Text.Analyzers.Package\Debug\netstandard2.0\Rulesets" "D:\dotnet\roslyn-analyzers\artifacts\obj\Text.Analyzers.Package\Debug\netstandard2.0\Editorconfig" "D:\dotnet\roslyn-analyzers\artifacts\obj\Text.Analyzers.Package\Debug\netstandard2.0\GlobalAnalyzerConfigs" "D:\dotnet\roslyn-analyzers\artifacts\bin\\" "Debug" "netstandard2.0" "Text.Analyzers.dll;Text.CSharp.Analyzers.dll;Text.VisualBasic.Analyzers.dll;C:\Users\bunamnan\.nuget\packages\humanizer.core\2.14.1\lib\netstandard1.0\Humanizer.dll" "D:\dotnet\roslyn-analyzers\artifacts\obj\Text.Analyzers.Package\Debug\netstandard2.0\Build" "Text.Analyzers.props" "D:\dotnet\roslyn-analyzers\artifacts\obj\Text.Analyzers.Package\Debug\netstandard2.0\Build" "Text.Analyzers.targets" "DisableNETAnalyzersForNuGetPackage.props" "D:\dotnet\roslyn-analyzers\src\Text.Analyzers" "Text.Analyzers.md" "D:\dotnet\roslyn-analyzers\src\Text.Analyzers" "Text.Analyzers.sarif" "3.11.0" Text.Analyzers true true "" false" exited with code -2147450730.

Build failed with 8 error(s) in 77.0s
buyaa-n commented 3 weeks ago

@sharwell there is something broke in the repo, normal build succeeds but dotnet build /t:pack fails with MSBuild error: How can I fix this? cc @mavasani

Turns out .NET version I was using was higher than the repo version, after the versions sync dotnet build /t:pack succeeded and produced the missing update

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.49%. Comparing base (4d5fd9d) to head (a532d1c).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #7326 +/- ## ========================================== - Coverage 96.49% 96.49% -0.01% ========================================== Files 1443 1443 Lines 345592 345670 +78 Branches 11370 11370 ========================================== + Hits 333484 333550 +66 - Misses 9230 9241 +11 - Partials 2878 2879 +1 ```
buyaa-n commented 3 weeks ago

The source changes look good, but I wonder if we should have additional test cases.

Added additional tests, thanks!

ManickaP commented 3 weeks ago

@buyaa-n do you know when this will be available in runtime repo? Or could you let me know when the time comes?

buyaa-n commented 3 weeks ago

Must be it https://github.com/dotnet/runtime/pull/103473

ManickaP commented 2 weeks ago

Works like charm, thank you!