Skip to content

Fix PublicAPI enablement checks #6291

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
333fred merged 3 commits into from
Nov 29, 2022
Merged

Fix PublicAPI enablement checks #6291

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
ceccae0
Fix PublicAPI enablement checks
333fred Nov 29, 2022
1a7266a
Add back missing return and assert.
333fred Nov 29, 2022
37b5291
Add test verifying fix.
333fred Nov 29, 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
68 changes: 35 additions & 33 deletions src/PublicApiAnalyzers/Core/Analyzers/DeclarePublicApiAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,47 +102,49 @@ public override void Initialize(AnalysisContext context)

private void OnCompilationStart(CompilationStartAnalysisContext compilationContext)
{
var errors = new List<Diagnostic>();
// Switch to "RegisterAdditionalFileAction" available in Microsoft.CodeAnalysis "3.8.x" to report additional file diagnostics: https://github.com/dotnet/roslyn-analyzers/issues/3918
if (!TryGetAndValidateApiFiles(compilationContext.Options, compilationContext.Compilation, isPublic: true, compilationContext.CancellationToken, errors, out ApiData publicShippedData, out ApiData publicUnshippedData)
|| !TryGetAndValidateApiFiles(compilationContext.Options, compilationContext.Compilation, isPublic: false, compilationContext.CancellationToken, errors, out ApiData internalShippedData, out ApiData internalUnshippedData))
CheckAndRegisterImplementation(isPublic: true);
CheckAndRegisterImplementation(isPublic: false);

void CheckAndRegisterImplementation(bool isPublic)
{
compilationContext.RegisterCompilationEndAction(context =>
var errors = new List<Diagnostic>();
// Switch to "RegisterAdditionalFileAction" available in Microsoft.CodeAnalysis "3.8.x" to report additional file diagnostics: https://github.com/dotnet/roslyn-analyzers/issues/3918
if (!TryGetAndValidateApiFiles(compilationContext.Options, compilationContext.Compilation, isPublic, compilationContext.CancellationToken, errors, out ApiData shippedData, out ApiData unshippedData))
{
foreach (Diagnostic cur in errors)
compilationContext.RegisterCompilationEndAction(context =>
{
context.ReportDiagnostic(cur);
}
});
foreach (Diagnostic cur in errors)
{
context.ReportDiagnostic(cur);
}
});

return;
}
return;
}

Debug.Assert(errors.Count == 0);
Debug.Assert(errors.Count == 0);

var publicImpl = new Impl(compilationContext.Compilation, publicShippedData, publicUnshippedData, isPublic: true, compilationContext.Options);
var internalImpl = new Impl(compilationContext.Compilation, internalShippedData, internalUnshippedData, isPublic: false, compilationContext.Options);
RegisterImplActions(compilationContext, publicImpl);
RegisterImplActions(compilationContext, internalImpl);
RegisterImplActions(compilationContext, new Impl(compilationContext.Compilation, shippedData, unshippedData, isPublic, compilationContext.Options));

static bool TryGetAndValidateApiFiles(AnalyzerOptions options, Compilation compilation, bool isPublic, CancellationToken cancellationToken, List<Diagnostic> errors, out ApiData shippedData, out ApiData unshippedData)
{
return TryGetApiData(options, compilation, isPublic, errors, cancellationToken, out shippedData, out unshippedData)
&& ValidateApiFiles(shippedData, unshippedData, isPublic, errors);
}
static bool TryGetAndValidateApiFiles(AnalyzerOptions options, Compilation compilation, bool isPublic, CancellationToken cancellationToken, List<Diagnostic> errors, out ApiData shippedData, out ApiData unshippedData)
{
return TryGetApiData(options, compilation, isPublic, errors, cancellationToken, out shippedData, out unshippedData)
&& ValidateApiFiles(shippedData, unshippedData, isPublic, errors);
}

static void RegisterImplActions(CompilationStartAnalysisContext compilationContext, Impl impl)
{
compilationContext.RegisterSymbolAction(
impl.OnSymbolAction,
SymbolKind.NamedType,
SymbolKind.Event,
SymbolKind.Field,
SymbolKind.Method);
compilationContext.RegisterSymbolAction(
impl.OnPropertyAction,
SymbolKind.Property);
compilationContext.RegisterCompilationEndAction(impl.OnCompilationEnd);
static void RegisterImplActions(CompilationStartAnalysisContext compilationContext, Impl impl)
{
compilationContext.RegisterSymbolAction(
impl.OnSymbolAction,
SymbolKind.NamedType,
SymbolKind.Event,
SymbolKind.Field,
SymbolKind.Method);
compilationContext.RegisterSymbolAction(
impl.OnPropertyAction,
SymbolKind.Property);
compilationContext.RegisterCompilationEndAction(impl.OnCompilationEnd);
}
}
}

Expand Down
19 changes: 19 additions & 0 deletions src/PublicApiAnalyzers/UnitTests/DeclarePublicAPIAnalyzerTestsBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,25 @@ private C() { }
await VerifyCSharpAsync(source, shippedText, unshippedText, $"[*]\r\n{editorconfigText}", expectedDiagnostics);
}

[Fact]
public async Task AnalyzerFilePresent_MissingNonEnabledText()
{
var source = $$"""

{{EnabledModifierCSharp}} class C
{
private C() { }
}
""";

string? shippedText = "";
string? unshippedText = "";

var expectedDiagnostics = new[] { GetCSharpResultAt(2, 8 + EnabledModifierCSharp.Length, DeclareNewApiRule, "C") };

await VerifyCSharpAsync(source, shippedText, unshippedText, $"[*]\r\ndotnet_public_api_analyzer.require_api_files = true", expectedDiagnostics);
}

[Fact]
public async Task EmptyPublicAPIFilesAsync()
{
Expand Down