-
Notifications
You must be signed in to change notification settings - Fork 204
Add analyzer for SupportsDeferredBindingAttribute #1367
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.
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
liliankasem
merged 4 commits into
feature/sdk-type-binding
from
liliankasem/deferredbindinganalyser
Feb 23, 2023
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // Copyright (c) .NET Foundation. All rights reserved. | ||
| // Licensed under the MIT License. See License.txt in the project root for license information. | ||
|
|
||
| using System; | ||
| using System.Collections.Immutable; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.Diagnostics; | ||
|
|
||
| namespace Microsoft.Azure.Functions.Worker.Sdk.Analyzers | ||
| { | ||
| [DiagnosticAnalyzer(LanguageNames.CSharp)] | ||
| public class DeferredBindingAttributeNotSupported : DiagnosticAnalyzer | ||
| { | ||
| public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get { return ImmutableArray.Create(DiagnosticDescriptors.DeferredBindingAttributeNotSupported); } } | ||
|
|
||
| public override void Initialize(AnalysisContext context) | ||
| { | ||
| context.EnableConcurrentExecution(); | ||
| context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); | ||
| context.RegisterSymbolAction(AnalyzeMethod, SymbolKind.NamedType); | ||
| } | ||
|
|
||
| private static void AnalyzeMethod(SymbolAnalysisContext symbolAnalysisContext) | ||
| { | ||
| var symbol = (INamedTypeSymbol)symbolAnalysisContext.Symbol; | ||
|
|
||
| var attributes = symbol.GetAttributes(); | ||
|
|
||
| if (attributes.IsEmpty) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| foreach (var attribute in attributes) | ||
| { | ||
| if (attribute.IsSupportsDeferredBindingAttribute() && !IsInputOrTriggerBinding(symbol)) | ||
| { | ||
| var location = Location.Create(attribute.ApplicationSyntaxReference.SyntaxTree, attribute.ApplicationSyntaxReference.Span); | ||
| var diagnostic = Diagnostic.Create(DiagnosticDescriptors.DeferredBindingAttributeNotSupported, location, attribute.AttributeClass.Name); | ||
| symbolAnalysisContext.ReportDiagnostic(diagnostic); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static bool IsInputOrTriggerBinding(INamedTypeSymbol symbol) | ||
| { | ||
| var baseType = symbol.BaseType?.ToDisplayString(); | ||
|
|
||
| if (string.Equals(baseType,Constants.Types.InputBindingAttribute, StringComparison.Ordinal) | ||
| || string.Equals(baseType,Constants.Types.TriggerBindingAttribute, StringComparison.Ordinal)) | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
134 changes: 134 additions & 0 deletions
134
test/Sdk.Analyzers.Tests/DeferredBindingAttributeNotSupportedTests.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| using Xunit; | ||
| using AnalyzerTest = Microsoft.CodeAnalysis.CSharp.Testing.CSharpAnalyzerTest<Microsoft.Azure.Functions.Worker.Sdk.Analyzers.DeferredBindingAttributeNotSupported, Microsoft.CodeAnalysis.Testing.Verifiers.XUnitVerifier>; | ||
| using Verify = Microsoft.CodeAnalysis.CSharp.Testing.XUnit.AnalyzerVerifier<Microsoft.Azure.Functions.Worker.Sdk.Analyzers.DeferredBindingAttributeNotSupported>; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.CodeAnalysis.Testing; | ||
| using System.Collections.Immutable; | ||
|
|
||
| namespace Sdk.Analyzers.Tests | ||
| { | ||
| public class DeferredBindingAttributeNotSupportedTests | ||
| { | ||
| [Fact] | ||
| public async Task TriggerBindingClass_SupportsDeferredBindingAttribute_Diagnostics_NotExpected() | ||
| { | ||
| string testCode = @" | ||
| using Microsoft.Azure.Functions.Worker.Extensions.Abstractions; | ||
|
|
||
| namespace TestBindings | ||
| { | ||
| [SupportsDeferredBinding] | ||
| public sealed class BlobTriggerAttribute : TriggerBindingAttribute | ||
| { | ||
| } | ||
| }"; | ||
|
|
||
| var test = new AnalyzerTest | ||
| { | ||
| ReferenceAssemblies = ReferenceAssemblies.Net.Net50.WithPackages(ImmutableArray.Create( | ||
| new PackageIdentity("Microsoft.Azure.Functions.Worker", "1.12.1-preview1"), | ||
| new PackageIdentity("Microsoft.Azure.Functions.Worker.Sdk", "1.9.0-preview1"), | ||
| new PackageIdentity("Microsoft.Azure.Functions.Worker.Extensions.Abstractions", "1.2.0-preview1"))), | ||
|
|
||
| TestCode = testCode | ||
| }; | ||
|
|
||
| // test.ExpectedDiagnostics is an empty collection. | ||
|
|
||
| await test.RunAsync(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task InputBindingClass_SupportsDeferredBindingAttribute_Diagnostics_NotExpected() | ||
| { | ||
| string testCode = @" | ||
| using Microsoft.Azure.Functions.Worker.Extensions.Abstractions; | ||
|
|
||
| namespace TestBindings | ||
| { | ||
| [SupportsDeferredBinding] | ||
| public sealed class BlobInputAttribute : InputBindingAttribute | ||
| { | ||
| } | ||
| }"; | ||
|
|
||
| var test = new AnalyzerTest | ||
| { | ||
| ReferenceAssemblies = ReferenceAssemblies.Net.Net50.WithPackages(ImmutableArray.Create( | ||
| new PackageIdentity("Microsoft.Azure.Functions.Worker", "1.12.1-preview1"), | ||
| new PackageIdentity("Microsoft.Azure.Functions.Worker.Sdk", "1.9.0-preview1"), | ||
| new PackageIdentity("Microsoft.Azure.Functions.Worker.Extensions.Abstractions", "1.2.0-preview1"))), | ||
|
|
||
| TestCode = testCode | ||
| }; | ||
|
|
||
| // test.ExpectedDiagnostics is an empty collection. | ||
|
|
||
| await test.RunAsync(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task OutputBindingClass_SupportsDeferredBindingAttribute_Diagnostic_Expected() | ||
| { | ||
| string testCode = @" | ||
| using Microsoft.Azure.Functions.Worker.Extensions.Abstractions; | ||
|
|
||
| namespace TestBindings | ||
| { | ||
| [SupportsDeferredBinding] | ||
| public sealed class BlobOutputAttribute : OutputBindingAttribute | ||
| { | ||
| } | ||
| }"; | ||
|
|
||
| var test = new AnalyzerTest | ||
| { | ||
| ReferenceAssemblies = ReferenceAssemblies.Net.Net50.WithPackages(ImmutableArray.Create( | ||
| new PackageIdentity("Microsoft.Azure.Functions.Worker", "1.12.1-preview1"), | ||
| new PackageIdentity("Microsoft.Azure.Functions.Worker.Sdk", "1.9.0-preview1"), | ||
| new PackageIdentity("Microsoft.Azure.Functions.Worker.Extensions.Abstractions", "1.2.0-preview1"))), | ||
|
|
||
| TestCode = testCode | ||
| }; | ||
|
|
||
| test.ExpectedDiagnostics.Add(Verify.Diagnostic() | ||
| .WithSeverity(Microsoft.CodeAnalysis.DiagnosticSeverity.Error) | ||
| .WithSpan(6, 22, 6, 45) | ||
| .WithArguments("SupportsDeferredBindingAttribute")); | ||
|
|
||
| await test.RunAsync(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task ClassWithoutBase_SupportsDeferredBindingAttribute_Diagnostic_Expected() | ||
| { | ||
| string testCode = @" | ||
| using Microsoft.Azure.Functions.Worker.Extensions.Abstractions; | ||
|
|
||
| namespace TestBindings | ||
| { | ||
| [SupportsDeferredBinding] | ||
| public sealed class JustAnotherClass | ||
| { | ||
| } | ||
| }"; | ||
|
|
||
| var test = new AnalyzerTest | ||
| { | ||
| ReferenceAssemblies = ReferenceAssemblies.Net.Net50.WithPackages(ImmutableArray.Create( | ||
| new PackageIdentity("Microsoft.Azure.Functions.Worker", "1.12.1-preview1"), | ||
| new PackageIdentity("Microsoft.Azure.Functions.Worker.Sdk", "1.9.0-preview1"), | ||
| new PackageIdentity("Microsoft.Azure.Functions.Worker.Extensions.Abstractions", "1.2.0-preview1"))), | ||
|
|
||
| TestCode = testCode | ||
| }; | ||
|
|
||
| test.ExpectedDiagnostics.Add(Verify.Diagnostic() | ||
| .WithSeverity(Microsoft.CodeAnalysis.DiagnosticSeverity.Error) | ||
| .WithSpan(6, 22, 6, 45) | ||
| .WithArguments("SupportsDeferredBindingAttribute")); | ||
|
|
||
| await test.RunAsync(); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.