-
Notifications
You must be signed in to change notification settings - Fork 464
/
AttributeStringLiteralsShouldParseCorrectly.cs
268 lines (231 loc) · 11.3 KB
/
AttributeStringLiteralsShouldParseCorrectly.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
// Copyright (c) Microsoft. All Rights Reserved. Licensed under the MIT license. See License.txt in the project root for license information.
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
using System.Threading;
using Analyzer.Utilities;
using Analyzer.Utilities.Extensions;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Diagnostics;
namespace Microsoft.NetCore.Analyzers.Runtime
{
using static MicrosoftNetCoreAnalyzersResources;
/// <summary>
/// CA2243: <inheritdoc cref="AttributeStringLiteralsShouldParseCorrectlyTitle"/>
/// Unlike FxCop, this rule does not fire diagnostics for ill-formed versions
/// Reason: There is wide usage of semantic versioning which does not follow traditional versioning grammar.
/// </summary>
[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)]
public sealed class AttributeStringLiteralsShouldParseCorrectlyAnalyzer : DiagnosticAnalyzer
{
internal const string RuleId = "CA2243";
private static readonly LocalizableString s_localizableTitle = CreateLocalizableResourceString(nameof(AttributeStringLiteralsShouldParseCorrectlyTitle));
private static readonly LocalizableString s_localizableDescription = CreateLocalizableResourceString(nameof(AttributeStringLiteralsShouldParseCorrectlyDescription));
internal static readonly DiagnosticDescriptor DefaultRule = DiagnosticDescriptorHelper.Create(
RuleId,
s_localizableTitle,
CreateLocalizableResourceString(nameof(AttributeStringLiteralsShouldParseCorrectlyMessageDefault)),
DiagnosticCategory.Usage,
RuleLevel.Disabled, // Heuristic based rule.
description: s_localizableDescription,
isPortedFxCopRule: true,
isDataflowRule: false);
internal static readonly DiagnosticDescriptor EmptyRule = DiagnosticDescriptorHelper.Create(
RuleId,
s_localizableTitle,
CreateLocalizableResourceString(nameof(AttributeStringLiteralsShouldParseCorrectlyMessageEmpty)),
DiagnosticCategory.Usage,
RuleLevel.Disabled, // Heuristic based rule.
description: s_localizableDescription,
isPortedFxCopRule: true,
isDataflowRule: false);
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(DefaultRule, EmptyRule);
private static readonly List<ValueValidator> s_tokensToValueValidator =
new(
new[] { new ValueValidator(ImmutableArray.Create("guid"), "Guid", GuidValueValidator),
new ValueValidator(ImmutableArray.Create("url", "uri", "urn"), "Uri", UrlValueValidator, "UriTemplate", "UrlFormat")});
private static bool GuidValueValidator(string value)
{
try
{
var unused = new Guid(value);
return true;
}
catch (OverflowException)
{
}
catch (FormatException)
{
}
return false;
}
private static bool UrlValueValidator(string value)
{
return Uri.IsWellFormedUriString(value, UriKind.RelativeOrAbsolute);
}
public override void Initialize(AnalysisContext context)
{
context.EnableConcurrentExecution();
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
context.RegisterSymbolAction(saContext =>
{
var symbol = saContext.Symbol;
AnalyzeSymbol(saContext.ReportDiagnostic, symbol, saContext.CancellationToken);
switch (symbol.Kind)
{
case SymbolKind.NamedType:
{
var namedType = (INamedTypeSymbol)symbol;
AnalyzeSymbols(saContext.ReportDiagnostic, namedType.TypeParameters, saContext.CancellationToken);
if (namedType.TypeKind == TypeKind.Delegate && namedType.DelegateInvokeMethod != null)
{
AnalyzeSymbols(saContext.ReportDiagnostic, namedType.DelegateInvokeMethod.Parameters, saContext.CancellationToken);
}
return;
}
case SymbolKind.Method:
{
var methodSymbol = (IMethodSymbol)symbol;
if (!methodSymbol.IsAccessorMethod())
{
AnalyzeSymbols(saContext.ReportDiagnostic, methodSymbol.Parameters, saContext.CancellationToken);
AnalyzeSymbols(saContext.ReportDiagnostic, methodSymbol.TypeParameters, saContext.CancellationToken);
}
return;
}
case SymbolKind.Property:
{
var propertySymbol = (IPropertySymbol)symbol;
AnalyzeSymbols(saContext.ReportDiagnostic, propertySymbol.Parameters, saContext.CancellationToken);
return;
}
}
},
SymbolKind.NamedType,
SymbolKind.Method, SymbolKind.Property, SymbolKind.Field, SymbolKind.Event);
context.RegisterCompilationAction(caContext =>
{
var compilation = caContext.Compilation;
AnalyzeSymbol(caContext.ReportDiagnostic, compilation.Assembly, caContext.CancellationToken);
});
}
private static void AnalyzeSymbols(Action<Diagnostic> reportDiagnostic, IEnumerable<ISymbol> symbols, CancellationToken cancellationToken)
{
foreach (var symbol in symbols)
{
AnalyzeSymbol(reportDiagnostic, symbol, cancellationToken);
}
}
private static void AnalyzeSymbol(Action<Diagnostic> reportDiagnostic, ISymbol symbol, CancellationToken cancellationToken)
{
var attributes = symbol.GetAttributes();
foreach (var attribute in attributes)
{
Analyze(reportDiagnostic, attribute, symbol, cancellationToken);
}
}
private static void Analyze(Action<Diagnostic> reportDiagnostic, AttributeData attributeData, ISymbol symbol, CancellationToken cancellationToken)
{
var attributeConstructor = attributeData.AttributeConstructor;
var constructorArguments = attributeData.ConstructorArguments;
if (attributeData.AttributeClass == null ||
attributeConstructor == null ||
!attributeConstructor.Parameters.HasExactly(constructorArguments.Count()))
{
return;
}
var syntax = attributeData.ApplicationSyntaxReference?.GetSyntax(cancellationToken) ?? symbol.DeclaringSyntaxReferences[0].GetSyntax(cancellationToken);
for (int i = 0; i < attributeConstructor.Parameters.Count(); i++)
{
var parameter = attributeConstructor.Parameters[i];
if (parameter.Type.SpecialType != SpecialType.System_String)
{
continue;
}
// If the name of the parameter is not something which requires the value-passed
// to the parameter to be validated then we don't have to do anything
var valueValidator = GetValueValidator(parameter.Name);
if (valueValidator != null && !valueValidator.IsIgnoredName(parameter.Name))
{
if (constructorArguments[i].Value is string value)
{
string classDisplayString = attributeData.AttributeClass.ToDisplayString(SymbolDisplayFormats.ShortSymbolDisplayFormat);
if (value.Length == 0)
{
reportDiagnostic(syntax.CreateDiagnostic(EmptyRule,
classDisplayString,
parameter.Name,
valueValidator.TypeName));
}
else if (!valueValidator.IsValidValue(value))
{
reportDiagnostic(syntax.CreateDiagnostic(DefaultRule,
classDisplayString,
parameter.Name,
value,
valueValidator.TypeName));
}
}
}
}
foreach (var namedArgument in attributeData.NamedArguments)
{
if (namedArgument.Value.IsNull ||
namedArgument.Value.Type?.SpecialType != SpecialType.System_String)
{
return;
}
var valueValidator = GetValueValidator(namedArgument.Key);
if (valueValidator != null &&
!valueValidator.IsIgnoredName(namedArgument.Key) &&
namedArgument.Value.Value is string value)
{
string classDisplayString = attributeData.AttributeClass.ToDisplayString(SymbolDisplayFormats.ShortSymbolDisplayFormat);
if (value.Length == 0)
{
reportDiagnostic(syntax.CreateDiagnostic(EmptyRule,
classDisplayString,
$"{classDisplayString}.{namedArgument.Key}",
valueValidator.TypeName));
}
else if (!valueValidator.IsValidValue(value))
{
reportDiagnostic(syntax.CreateDiagnostic(DefaultRule,
classDisplayString,
$"{classDisplayString}.{namedArgument.Key}",
value,
valueValidator.TypeName));
}
}
}
}
private static ValueValidator? GetValueValidator(string name)
{
foreach (var valueValidator in s_tokensToValueValidator)
{
if (WordParser.ContainsWord(name, WordParserOptions.SplitCompoundWords, valueValidator.AcceptedTokens))
{
return valueValidator;
}
}
return null;
}
}
internal class ValueValidator
{
private readonly string[] _ignoredNames;
public ImmutableArray<string> AcceptedTokens { get; }
public string TypeName { get; }
public Func<string, bool> IsValidValue { get; }
public bool IsIgnoredName(string name)
=> _ignoredNames.Contains(name, StringComparer.OrdinalIgnoreCase);
public ValueValidator(ImmutableArray<string> acceptedTokens, string typeName, Func<string, bool> isValidValue, params string[] ignoredNames)
{
_ignoredNames = ignoredNames;
AcceptedTokens = acceptedTokens;
TypeName = typeName;
IsValidValue = isValidValue;
}
}
}