-
Notifications
You must be signed in to change notification settings - Fork 183
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add an analyzer to prevent use of some internal shared source types (#…
…6642) * Initial implementation of AZC0020 * Updates * Update * refactor * whitespace * updates * Allow use of shared source types in Azure.Core * pr fb * pr fb * add back change to file missed in merge * Update tests * pr fb; + WIP for local variables * clean up * missed cleanup * missed file * Address warnings * Updates * refactor
- Loading branch information
1 parent
49201ef
commit 76c21ff
Showing
4 changed files
with
270 additions
and
5 deletions.
There are no files selected for viewing
120 changes: 120 additions & 0 deletions
120
src/dotnet/Azure.ClientSdk.Analyzers/Azure.ClientSdk.Analyzers.Tests/AZC0020Tests.cs
This file contains 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,120 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System.Collections.Generic; | ||
| using System.Threading.Tasks; | ||
| using Xunit; | ||
| using Verifier = Azure.ClientSdk.Analyzers.Tests.AzureAnalyzerVerifier<Azure.ClientSdk.Analyzers.BannedTypesAnalyzer>; | ||
|
|
||
| namespace Azure.ClientSdk.Analyzers.Tests | ||
| { | ||
| public class AZC0020Tests | ||
| { | ||
| private List<(string fileName, string source)> _sharedSourceFiles; | ||
|
|
||
| public AZC0020Tests() | ||
| { | ||
| _sharedSourceFiles = new List<(string fileName, string source)>() { | ||
|
|
||
| ("MutableJsonDocument.cs", @" | ||
| namespace Azure.Core.Json | ||
| { | ||
| internal sealed partial class MutableJsonDocument | ||
| { | ||
| } | ||
| } | ||
| "), | ||
|
|
||
| ("MutableJsonElement.cs", @" | ||
| namespace Azure.Core.Json | ||
| { | ||
| internal partial struct MutableJsonElement | ||
| { | ||
| } | ||
| } | ||
| ") | ||
| }; | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task AZC0020ProducedForMutableJsonDocumentUsage() | ||
| { | ||
| string code = @" | ||
| using System; | ||
| using Azure.Core.Json; | ||
| namespace LibraryNamespace | ||
| { | ||
| public class Model | ||
| { | ||
| private MutableJsonDocument {|AZC0020:_document|}; | ||
| internal MutableJsonDocument {|AZC0020:Document|} => {|AZC0020:_document|}; | ||
| internal event EventHandler<MutableJsonDocument> {|AZC0020:_docEvent|}; | ||
| internal MutableJsonDocument {|AZC0020:GetDocument|}(MutableJsonDocument {|AZC0020:value|}) | ||
| { | ||
| {|AZC0020:MutableJsonDocument mdoc = new MutableJsonDocument();|} | ||
| return mdoc; | ||
| } | ||
| } | ||
| }"; | ||
| await Verifier.VerifyAnalyzerAsync(code, _sharedSourceFiles); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task AZC0020ProducedForMutableJsonElementUsage() | ||
| { | ||
| string code = @" | ||
| using Azure.Core.Json; | ||
| namespace LibraryNamespace | ||
| { | ||
| public class Model | ||
| { | ||
| private MutableJsonElement {|AZC0020:_element|}; | ||
| internal MutableJsonElement {|AZC0020:Element|} => {|AZC0020:_element|}; | ||
| internal MutableJsonElement {|AZC0020:GetDocument|}(MutableJsonElement {|AZC0020:value|}) | ||
| { | ||
| {|AZC0020:MutableJsonElement element = new MutableJsonElement();|} | ||
| return element; | ||
| } | ||
| } | ||
| }"; | ||
| await Verifier.VerifyAnalyzerAsync(code, _sharedSourceFiles); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task AZC0020NotProducedForAllowedTypeUsage() | ||
| { | ||
| string code = @" | ||
| using System.Text.Json; | ||
| namespace LibraryNamespace | ||
| { | ||
| public class Model | ||
| { | ||
| JsonElement _element; | ||
| } | ||
| }"; | ||
| await Verifier.VerifyAnalyzerAsync(code, _sharedSourceFiles); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task AZC0020NotProducedForTypeWithBannedNameInAllowedNamespace() | ||
| { | ||
| string code = @" | ||
| namespace LibraryNamespace | ||
| { | ||
| public class MutableJsonDocument | ||
| { | ||
| } | ||
| public class Model | ||
| { | ||
| MutableJsonDocument _document; | ||
| } | ||
| }"; | ||
| await Verifier.VerifyAnalyzerAsync(code, _sharedSourceFiles); | ||
| } | ||
| } | ||
| } |
This file contains 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
127 changes: 127 additions & 0 deletions
127
src/dotnet/Azure.ClientSdk.Analyzers/Azure.ClientSdk.Analyzers/BannedTypesAnalyzer.cs
This file contains 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,127 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Collections.Immutable; | ||
| using System.Linq; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.CSharp; | ||
| using Microsoft.CodeAnalysis.CSharp.Syntax; | ||
| using Microsoft.CodeAnalysis.Diagnostics; | ||
|
|
||
| namespace Azure.ClientSdk.Analyzers | ||
| { | ||
| [DiagnosticAnalyzer(LanguageNames.CSharp)] | ||
| public sealed class BannedTypesAnalyzer : DiagnosticAnalyzer | ||
| { | ||
| private static HashSet<string> BannedTypes = new HashSet<string>() | ||
| { | ||
| "Azure.Core.Json.MutableJsonDocument", | ||
| "Azure.Core.Json.MutableJsonElement", | ||
| "Azure.Core.Json.MutableJsonChange", | ||
| "Azure.Core.Json.MutableJsonChangeKind", | ||
| }; | ||
|
|
||
| private static readonly string BannedTypesMessageArgs = string.Join(", ", BannedTypes); | ||
|
|
||
| public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(Descriptors.AZC0020); | ||
|
|
||
| public SymbolKind[] SymbolKinds { get; } = new[] | ||
| { | ||
| SymbolKind.Event, | ||
| SymbolKind.Field, | ||
| SymbolKind.Method, | ||
| SymbolKind.NamedType, | ||
| SymbolKind.Parameter, | ||
| SymbolKind.Property, | ||
| }; | ||
|
|
||
| public override void Initialize(AnalysisContext context) | ||
| { | ||
| context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics); | ||
| context.EnableConcurrentExecution(); | ||
| context.RegisterSymbolAction(c => Analyze(c), SymbolKinds); | ||
| context.RegisterSyntaxNodeAction(c => AnalyzeNode(c), SyntaxKind.LocalDeclarationStatement); | ||
| } | ||
|
|
||
| public void Analyze(SymbolAnalysisContext context) | ||
| { | ||
| if (IsAzureCore(context.Symbol.ContainingAssembly)) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| switch (context.Symbol) | ||
| { | ||
| case IParameterSymbol parameterSymbol: | ||
| CheckType(parameterSymbol.Type, parameterSymbol, context.ReportDiagnostic); | ||
| break; | ||
| case IMethodSymbol methodSymbol: | ||
| CheckType(methodSymbol.ReturnType, methodSymbol, context.ReportDiagnostic); | ||
| break; | ||
| case IEventSymbol eventSymbol: | ||
| CheckType(eventSymbol.Type, eventSymbol, context.ReportDiagnostic); | ||
| break; | ||
| case IPropertySymbol propertySymbol: | ||
| CheckType(propertySymbol.Type, propertySymbol, context.ReportDiagnostic); | ||
| break; | ||
| case IFieldSymbol fieldSymbol: | ||
| CheckType(fieldSymbol.Type, fieldSymbol, context.ReportDiagnostic); | ||
| break; | ||
| case INamedTypeSymbol namedTypeSymbol: | ||
| CheckType(namedTypeSymbol.BaseType, namedTypeSymbol, context.ReportDiagnostic); | ||
| foreach (var iface in namedTypeSymbol.Interfaces) | ||
| { | ||
| CheckType(iface, namedTypeSymbol, context.ReportDiagnostic); | ||
| } | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| public void AnalyzeNode(SyntaxNodeAnalysisContext context) | ||
| { | ||
| if (IsAzureCore(context.ContainingSymbol.ContainingAssembly)) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| if (context.Node is LocalDeclarationStatementSyntax declaration) | ||
| { | ||
| ITypeSymbol type = context.SemanticModel.GetTypeInfo(declaration.Declaration.Type).Type; | ||
|
|
||
| CheckType(type, type, context.ReportDiagnostic, context.Node.GetLocation()); | ||
| } | ||
| } | ||
|
|
||
| private static Diagnostic CheckType(ITypeSymbol type, ISymbol symbol, Action<Diagnostic> reportDiagnostic, Location location = default) | ||
| { | ||
| if (type is INamedTypeSymbol namedTypeSymbol) | ||
| { | ||
| if (IsBannedType(namedTypeSymbol)) | ||
| { | ||
| reportDiagnostic(Diagnostic.Create(Descriptors.AZC0020, location ?? symbol.Locations.First(), BannedTypesMessageArgs)); | ||
| } | ||
|
|
||
| if (namedTypeSymbol.IsGenericType) | ||
| { | ||
| foreach (var typeArgument in namedTypeSymbol.TypeArguments) | ||
| { | ||
| CheckType(typeArgument, symbol, reportDiagnostic); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| private static bool IsAzureCore(IAssemblySymbol assembly) | ||
| { | ||
| return | ||
| assembly.Name.Equals("Azure.Core") || | ||
| assembly.Name.Equals("Azure.Core.Experimental"); | ||
| } | ||
|
|
||
| private static bool IsBannedType(INamedTypeSymbol namedTypeSymbol) | ||
| { | ||
| return BannedTypes.Contains($"{namedTypeSymbol.ContainingNamespace}.{namedTypeSymbol.Name}"); | ||
| } | ||
| } | ||
| } |
This file contains 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