-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Port single-file analyzer (dotnet/linker#1665)
* Add single-file analyzer * Add tests * Use str constant * Update Resources * Update tests * PR feedback * Remove mysterious filename from comments * Add helper method for single-file diagnostic verification * Refactor MSBuild properties * Add test with PublishSingleFile not set Commit migrated from dotnet/linker@a86658f
- Loading branch information
Showing
24 changed files
with
650 additions
and
28 deletions.
There are no files selected for viewing
31 changes: 31 additions & 0 deletions
31
src/tools/illink/src/ILLink.RoslynAnalyzer/AnalyzerOptionsExtensions.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,31 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System.Linq; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.Diagnostics; | ||
|
|
||
| namespace ILLink.RoslynAnalyzer | ||
| { | ||
| internal static class AnalyzerOptionsExtensions | ||
| { | ||
| public static string? GetMSBuildPropertyValue ( | ||
| this AnalyzerOptions options, | ||
| string optionName, | ||
| Compilation compilation) | ||
| { | ||
| // MSBuild property values should be set at compilation level, and cannot have different values per-tree. | ||
| // So, we default to first syntax tree. | ||
| var tree = compilation.SyntaxTrees.FirstOrDefault (); | ||
| if (tree is null) { | ||
| return null; | ||
| } | ||
|
|
||
| return options.AnalyzerConfigOptionsProvider.GlobalOptions.TryGetValue ( | ||
| $"build_property.{optionName}", out var value) | ||
| ? value | ||
| : null; | ||
| } | ||
| } | ||
| } |
12 changes: 12 additions & 0 deletions
12
src/tools/illink/src/ILLink.RoslynAnalyzer/DiagnosticCategory.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,12 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| namespace ILLink.RoslynAnalyzer | ||
| { | ||
| internal static class DiagnosticCategory | ||
| { | ||
| public const string SingleFile = nameof (SingleFile); | ||
| public const string Trimming = nameof (Trimming); | ||
| } | ||
| } |
13 changes: 13 additions & 0 deletions
13
src/tools/illink/src/ILLink.RoslynAnalyzer/MSBuildPropertyOptionNames.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,13 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| namespace ILLink.RoslynAnalyzer | ||
| { | ||
| public static class MSBuildPropertyOptionNames | ||
| { | ||
| public const string PublishSingleFile = nameof (PublishSingleFile); | ||
| public const string IncludeAllContentForSelfExtract = nameof (IncludeAllContentForSelfExtract); | ||
| public const string PublishTrimmed = nameof (PublishTrimmed); | ||
| } | ||
| } |
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
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
141 changes: 141 additions & 0 deletions
141
src/tools/illink/src/ILLink.RoslynAnalyzer/SingleFileAnalyzer.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,141 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Collections.Immutable; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.Diagnostics; | ||
| using Microsoft.CodeAnalysis.Operations; | ||
|
|
||
| namespace ILLink.RoslynAnalyzer | ||
| { | ||
| /// <summary> | ||
| /// IL3000, IL3001: Do not use Assembly file path in single-file publish | ||
| /// </summary> | ||
| [DiagnosticAnalyzer (LanguageNames.CSharp, LanguageNames.VisualBasic)] | ||
| public sealed class AvoidAssemblyLocationInSingleFile : DiagnosticAnalyzer | ||
| { | ||
| public const string IL3000 = nameof (IL3000); | ||
| public const string IL3001 = nameof (IL3001); | ||
|
|
||
| private static readonly DiagnosticDescriptor LocationRule = new DiagnosticDescriptor ( | ||
| IL3000, | ||
| new LocalizableResourceString (nameof (Resources.AvoidAssemblyLocationInSingleFileTitle), | ||
| Resources.ResourceManager, typeof (Resources)), | ||
| new LocalizableResourceString (nameof (Resources.AvoidAssemblyLocationInSingleFileMessage), | ||
| Resources.ResourceManager, typeof (Resources)), | ||
| DiagnosticCategory.SingleFile, | ||
| DiagnosticSeverity.Warning, | ||
| isEnabledByDefault: true); | ||
|
|
||
| private static readonly DiagnosticDescriptor GetFilesRule = new DiagnosticDescriptor ( | ||
| IL3001, | ||
| new LocalizableResourceString (nameof (Resources.AvoidAssemblyGetFilesInSingleFileTitle), | ||
| Resources.ResourceManager, typeof (Resources)), | ||
| new LocalizableResourceString (nameof (Resources.AvoidAssemblyGetFilesInSingleFileMessage), | ||
| Resources.ResourceManager, typeof (Resources)), | ||
| DiagnosticCategory.SingleFile, | ||
| DiagnosticSeverity.Warning, | ||
| isEnabledByDefault: true); | ||
|
|
||
| public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create (LocationRule, GetFilesRule); | ||
|
|
||
| public override void Initialize (AnalysisContext context) | ||
| { | ||
| context.EnableConcurrentExecution (); | ||
| context.ConfigureGeneratedCodeAnalysis (GeneratedCodeAnalysisFlags.ReportDiagnostics); | ||
|
|
||
| context.RegisterCompilationStartAction (context => { | ||
| var compilation = context.Compilation; | ||
| var isSingleFilePublish = context.Options.GetMSBuildPropertyValue (MSBuildPropertyOptionNames.PublishSingleFile, compilation); | ||
| if (!string.Equals (isSingleFilePublish?.Trim (), "true", StringComparison.OrdinalIgnoreCase)) { | ||
| return; | ||
| } | ||
| var includesAllContent = context.Options.GetMSBuildPropertyValue (MSBuildPropertyOptionNames.IncludeAllContentForSelfExtract, compilation); | ||
| if (string.Equals (includesAllContent?.Trim (), "true", StringComparison.OrdinalIgnoreCase)) { | ||
| return; | ||
| } | ||
| var propertiesBuilder = ImmutableArray.CreateBuilder<IPropertySymbol> (); | ||
| var methodsBuilder = ImmutableArray.CreateBuilder<IMethodSymbol> (); | ||
| var assemblyType = compilation.GetTypeByMetadataName ("System.Reflection.Assembly"); | ||
| if (assemblyType != null) { | ||
| // properties | ||
| AddIfNotNull (propertiesBuilder, TryGetSingleSymbol<IPropertySymbol> (assemblyType.GetMembers ("Location"))); | ||
| // methods | ||
| methodsBuilder.AddRange (assemblyType.GetMembers ("GetFile").OfType<IMethodSymbol> ()); | ||
| methodsBuilder.AddRange (assemblyType.GetMembers ("GetFiles").OfType<IMethodSymbol> ()); | ||
| } | ||
| var assemblyNameType = compilation.GetTypeByMetadataName ("System.Reflection.AssemblyName"); | ||
| if (assemblyNameType != null) { | ||
| AddIfNotNull (propertiesBuilder, TryGetSingleSymbol<IPropertySymbol> (assemblyNameType.GetMembers ("CodeBase"))); | ||
| AddIfNotNull (propertiesBuilder, TryGetSingleSymbol<IPropertySymbol> (assemblyNameType.GetMembers ("EscapedCodeBase"))); | ||
| } | ||
| var properties = propertiesBuilder.ToImmutable (); | ||
| var methods = methodsBuilder.ToImmutable (); | ||
| context.RegisterOperationAction (operationContext => { | ||
| var access = (IPropertyReferenceOperation) operationContext.Operation; | ||
| var property = access.Property; | ||
| if (!Contains (properties, property, SymbolEqualityComparer.Default)) { | ||
| return; | ||
| } | ||
| operationContext.ReportDiagnostic (Diagnostic.Create (LocationRule, access.Syntax.GetLocation (), property)); | ||
| }, OperationKind.PropertyReference); | ||
| context.RegisterOperationAction (operationContext => { | ||
| var invocation = (IInvocationOperation) operationContext.Operation; | ||
| var targetMethod = invocation.TargetMethod; | ||
| if (!Contains (methods, targetMethod, SymbolEqualityComparer.Default)) { | ||
| return; | ||
| } | ||
| operationContext.ReportDiagnostic (Diagnostic.Create (GetFilesRule, invocation.Syntax.GetLocation (), targetMethod)); | ||
| }, OperationKind.Invocation); | ||
| return; | ||
| static bool Contains<T, TComp> (ImmutableArray<T> list, T elem, TComp comparer) | ||
| where TComp : IEqualityComparer<T> | ||
| { | ||
| foreach (var e in list) { | ||
| if (comparer.Equals (e, elem)) { | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
| static TSymbol? TryGetSingleSymbol<TSymbol> (ImmutableArray<ISymbol> members) where TSymbol : class, ISymbol | ||
| { | ||
| TSymbol? candidate = null; | ||
| foreach (var m in members) { | ||
| if (m is TSymbol tsym) { | ||
| if (candidate is null) { | ||
| candidate = tsym; | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
| } | ||
| return candidate; | ||
| } | ||
| static void AddIfNotNull<TSymbol> (ImmutableArray<TSymbol>.Builder properties, TSymbol? p) where TSymbol : class, ISymbol | ||
| { | ||
| if (p != null) { | ||
| properties.Add (p); | ||
| } | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| } |
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
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
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
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
Oops, something went wrong.