-
Notifications
You must be signed in to change notification settings - Fork 457
/
CodeMetricsAnalyzer.cs
482 lines (421 loc) · 28.3 KB
/
CodeMetricsAnalyzer.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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
// Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.IO;
using System.Linq;
using System.Threading;
using Analyzer.Utilities;
using Analyzer.Utilities.Extensions;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CodeMetrics;
using Microsoft.CodeAnalysis.Diagnostics;
using Microsoft.CodeAnalysis.Text;
namespace Microsoft.CodeQuality.Analyzers.Maintainability.CodeMetrics
{
/// <summary>
/// CA1501: Avoid excessive inheritance
/// CA1502: Avoid excessive complexity
/// CA1505: Avoid unmaintainable code
/// CA1506: Avoid excessive class coupling
/// CA1509: Invalid entry in code metrics rule specification file
/// </summary>
[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)]
public sealed class CodeMetricsAnalyzer : DiagnosticAnalyzer
{
internal const string CA1501RuleId = "CA1501";
internal const string CA1502RuleId = "CA1502";
internal const string CA1505RuleId = "CA1505";
internal const string CA1506RuleId = "CA1506";
/// <summary>
/// Configuration file to configure custom threshold values for supported code metrics.
/// For example, the below entry changes the maximum allowed inheritance depth from the default value of 5 to 10:
///
/// # FORMAT:
/// # 'RuleId'(Optional 'SymbolKind'): 'Threshold'
///
/// CA1501: 10
/// See CA1509 unit tests for more examples.
/// </summary>
private const string CodeMetricsConfigurationFile = "CodeMetricsConfig.txt";
// New rule for invalid entries in CodeMetricsConfigurationFile.
internal const string CA1509RuleId = "CA1509";
private static readonly LocalizableString s_localizableTitleCA1501 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidExcessiveInheritanceTitle), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableMessageCA1501 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidExcessiveInheritanceMessage), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableDescriptionCA1501 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidExcessiveInheritanceDescription), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableTitleCA1502 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidExcessiveComplexityTitle), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableMessageCA1502 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidExcessiveComplexityMessage), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableDescriptionCA1502 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidExcessiveComplexityDescription), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableTitleCA1505 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidUnmantainableCodeTitle), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableMessageCA1505 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidUnmantainableCodeMessage), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableDescriptionCA1505 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidUnmantainableCodeDescription), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableTitleCA1506 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidExcessiveClassCouplingTitle), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableMessageCA1506 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidExcessiveClassCouplingMessage), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableDescriptionCA1506 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidExcessiveClassCouplingDescription), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableTitleCA1509 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.InvalidEntryInCodeMetricsConfigFileTitle), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableMessageCA1509 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.InvalidEntryInCodeMetricsConfigFileMessage), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
private static readonly LocalizableString s_localizableDescriptionCA1509 = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.InvalidEntryInCodeMetricsConfigFileDescription), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
internal static DiagnosticDescriptor CA1501Rule = new DiagnosticDescriptor(CA1501RuleId,
s_localizableTitleCA1501,
s_localizableMessageCA1501,
DiagnosticCategory.Maintainability,
DiagnosticHelpers.DefaultDiagnosticSeverity,
isEnabledByDefault: false,
description: s_localizableDescriptionCA1501,
helpLinkUri: "https://docs.microsoft.com/visualstudio/code-quality/ca1501-avoid-excessive-inheritance",
customTags: FxCopWellKnownDiagnosticTags.PortedFxCopRule);
internal static DiagnosticDescriptor CA1502Rule = new DiagnosticDescriptor(CA1502RuleId,
s_localizableTitleCA1502,
s_localizableMessageCA1502,
DiagnosticCategory.Maintainability,
DiagnosticHelpers.DefaultDiagnosticSeverity,
isEnabledByDefault: false,
description: s_localizableDescriptionCA1502,
helpLinkUri: "https://docs.microsoft.com/visualstudio/code-quality/ca1502-avoid-excessive-complexity",
customTags: FxCopWellKnownDiagnosticTags.PortedFxCopRule);
internal static DiagnosticDescriptor CA1505Rule = new DiagnosticDescriptor(CA1505RuleId,
s_localizableTitleCA1505,
s_localizableMessageCA1505,
DiagnosticCategory.Maintainability,
DiagnosticHelpers.DefaultDiagnosticSeverity,
isEnabledByDefault: false,
description: s_localizableDescriptionCA1505,
helpLinkUri: "https://docs.microsoft.com/visualstudio/code-quality/ca1505-avoid-unmaintainable-code",
customTags: FxCopWellKnownDiagnosticTags.PortedFxCopRule);
internal static DiagnosticDescriptor CA1506Rule = new DiagnosticDescriptor(CA1506RuleId,
s_localizableTitleCA1506,
s_localizableMessageCA1506,
DiagnosticCategory.Maintainability,
DiagnosticHelpers.DefaultDiagnosticSeverity,
isEnabledByDefault: false,
description: s_localizableDescriptionCA1506,
helpLinkUri: "https://docs.microsoft.com/visualstudio/code-quality/ca1506-avoid-excessive-class-coupling",
customTags: FxCopWellKnownDiagnosticTags.PortedFxCopRule);
internal static DiagnosticDescriptor InvalidEntryInCodeMetricsConfigFileRule = new DiagnosticDescriptor(CA1509RuleId,
s_localizableTitleCA1509,
s_localizableMessageCA1509,
DiagnosticCategory.Maintainability,
DiagnosticHelpers.DefaultDiagnosticSeverity,
isEnabledByDefault: false,
description: s_localizableDescriptionCA1509,
helpLinkUri: null, // TODO: Add help link
customTags: WellKnownDiagnosticTags.Telemetry);
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(CA1501Rule, CA1502Rule, CA1505Rule, CA1506Rule, InvalidEntryInCodeMetricsConfigFileRule);
public override void Initialize(AnalysisContext analysisContext)
{
analysisContext.EnableConcurrentExecution();
analysisContext.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
analysisContext.RegisterCompilationAction(compilationContext =>
{
// Try read the additional file containing the code metrics configuration.
if (!TryGetRuleIdToThresholdMap(
compilationContext.Options.AdditionalFiles,
compilationContext.CancellationToken,
out AdditionalText additionalTextOpt,
out ImmutableDictionary<string, IReadOnlyList<(SymbolKind?, uint)>> ruleIdToThresholdMap,
out List<Diagnostic> invalidFileDiagnostics) &&
invalidFileDiagnostics != null)
{
// Report any invalid additional file diagnostics.
foreach (var diagnostic in invalidFileDiagnostics)
{
compilationContext.ReportDiagnostic(diagnostic);
}
return;
}
// Compute code metrics.
var computeTask = CodeAnalysisMetricData.ComputeAsync(compilationContext.Compilation, compilationContext.CancellationToken);
computeTask.Wait(compilationContext.CancellationToken);
// Analyze code metrics tree and report diagnostics.
analyzeMetricsData(computeTask.Result);
void analyzeMetricsData(CodeAnalysisMetricData codeAnalysisMetricData)
{
var symbol = codeAnalysisMetricData.Symbol;
// CA1501: Avoid excessive inheritance
if (symbol.Kind == SymbolKind.NamedType && codeAnalysisMetricData.DepthOfInheritance.HasValue)
{
uint? inheritanceThreshold = getThreshold(CA1501RuleId, symbol.Kind);
if (inheritanceThreshold.HasValue && codeAnalysisMetricData.DepthOfInheritance.Value > inheritanceThreshold.Value)
{
// '{0}' has an object hierarchy '{1}' levels deep within the defining module. If possible, eliminate base classes within the hierarchy to decrease its hierarchy level below '{2}': '{3}'
var arg1 = symbol.Name;
var arg2 = codeAnalysisMetricData.DepthOfInheritance;
var arg3 = inheritanceThreshold + 1;
var arg4 = string.Join(", ", ((INamedTypeSymbol)symbol).GetBaseTypes().Select(t => t.Name));
var diagnostic = symbol.CreateDiagnostic(CA1501Rule, arg1, arg2, arg3, arg4);
compilationContext.ReportDiagnostic(diagnostic);
}
}
// CA1502: Avoid excessive complexity
uint? complexityThreshold = getThreshold(CA1502RuleId, symbol.Kind);
if (complexityThreshold.HasValue && codeAnalysisMetricData.CyclomaticComplexity > complexityThreshold.Value)
{
// '{0}' has a cyclomatic complexity of '{1}'. Rewrite or refactor the code to decrease its complexity below '{2}'.
var arg1 = symbol.Name;
var arg2 = codeAnalysisMetricData.CyclomaticComplexity;
var arg3 = complexityThreshold.Value + 1;
var diagnostic = symbol.CreateDiagnostic(CA1502Rule, arg1, arg2, arg3);
compilationContext.ReportDiagnostic(diagnostic);
}
// CA1505: Avoid unmaintainable code
uint? maintainabilityIndexThreshold = getThreshold(CA1505RuleId, symbol.Kind);
if (maintainabilityIndexThreshold.HasValue && maintainabilityIndexThreshold.Value > codeAnalysisMetricData.MaintainabilityIndex)
{
// '{0}' has a maintainability index of '{1}'. Rewrite or refactor the code to increase its maintainability index (MI) above '{2}'.
var arg1 = symbol.Name;
var arg2 = codeAnalysisMetricData.MaintainabilityIndex;
var arg3 = maintainabilityIndexThreshold.Value - 1;
var diagnostic = symbol.CreateDiagnostic(CA1505Rule, arg1, arg2, arg3);
compilationContext.ReportDiagnostic(diagnostic);
}
// CA1506: Avoid excessive class coupling
uint? classCouplingThreshold = getThreshold(CA1506RuleId, symbol.Kind);
if (classCouplingThreshold.HasValue && codeAnalysisMetricData.CoupledNamedTypes.Count > classCouplingThreshold.Value)
{
// '{0}' is coupled with '{1}' different types from '{2}' different namespaces. Rewrite or refactor the code to decrease its class coupling below '{3}'.
var arg1 = symbol.Name;
var arg2 = codeAnalysisMetricData.CoupledNamedTypes.Count;
var arg3 = GetDistinctContainingNamespacesCount(codeAnalysisMetricData.CoupledNamedTypes);
var arg4 = classCouplingThreshold.Value + 1;
var diagnostic = symbol.CreateDiagnostic(CA1506Rule, arg1, arg2, arg3, arg4);
compilationContext.ReportDiagnostic(diagnostic);
}
foreach (var child in codeAnalysisMetricData.Children)
{
analyzeMetricsData(child);
}
}
uint? getThreshold(string ruleId, SymbolKind symbolKind)
{
// Check if we have custom threshold value for the given ruleId and symbolKind.
if (ruleIdToThresholdMap != null &&
ruleIdToThresholdMap.TryGetValue(ruleId, out IReadOnlyList<(SymbolKind? symbolKindOpt, uint threshold)> values))
{
foreach ((SymbolKind? symbolKindOpt, uint threshold) in values)
{
if (symbolKindOpt.HasValue && symbolKindOpt.Value == symbolKind)
{
return threshold;
}
}
if (values.Count == 1 &&
values[0].symbolKindOpt == null &&
isApplicableByDefault(ruleId, symbolKind))
{
return values[0].threshold;
}
}
return getDefaultThreshold(ruleId, symbolKind);
}
static bool isApplicableByDefault(string ruleId, SymbolKind symbolKind)
{
switch (ruleId)
{
case CA1501RuleId:
return symbolKind == SymbolKind.NamedType;
case CA1502RuleId:
return symbolKind == SymbolKind.Method;
case CA1505RuleId:
switch (symbolKind)
{
case SymbolKind.NamedType:
case SymbolKind.Method:
case SymbolKind.Field:
case SymbolKind.Property:
case SymbolKind.Event:
return true;
default:
return false;
}
case CA1506RuleId:
switch (symbolKind)
{
case SymbolKind.NamedType:
case SymbolKind.Method:
case SymbolKind.Field:
case SymbolKind.Property:
case SymbolKind.Event:
return true;
default:
return false;
}
default:
throw new NotImplementedException();
}
}
static uint? getDefaultThreshold(string ruleId, SymbolKind symbolKind)
{
if (!isApplicableByDefault(ruleId, symbolKind))
{
return null;
}
// Compat: we match the default threshold values for old FxCop implementation.
return ruleId switch
{
CA1501RuleId => 5,
CA1502RuleId => 25,
CA1505RuleId => 10,
CA1506RuleId => symbolKind == SymbolKind.NamedType ? 95 : (uint)40,
_ => throw new NotImplementedException(),
};
}
});
}
private static bool TryGetRuleIdToThresholdMap(
ImmutableArray<AdditionalText> additionalFiles,
CancellationToken cancellationToken,
out AdditionalText additionalText,
out ImmutableDictionary<string, IReadOnlyList<(SymbolKind?, uint)>> ruleIdToThresholdMap,
out List<Diagnostic> invalidFileDiagnostics)
{
invalidFileDiagnostics = null;
ruleIdToThresholdMap = null;
// Parse the additional file for code metrics configuration.
// Return false if there is no such additional file or it contains at least one invalid entry.
additionalText = TryGetCodeMetricsConfigurationFile(additionalFiles, cancellationToken);
return additionalText != null &&
TryParseCodeMetricsConfigurationFile(additionalText, cancellationToken, out ruleIdToThresholdMap, out invalidFileDiagnostics);
}
private static AdditionalText TryGetCodeMetricsConfigurationFile(ImmutableArray<AdditionalText> additionalFiles, CancellationToken cancellationToken)
{
StringComparer comparer = StringComparer.Ordinal;
foreach (AdditionalText textFile in additionalFiles)
{
cancellationToken.ThrowIfCancellationRequested();
string fileName = Path.GetFileName(textFile.Path);
if (comparer.Equals(fileName, CodeMetricsConfigurationFile))
{
return textFile;
}
}
return null;
}
private static bool TryParseCodeMetricsConfigurationFile(
AdditionalText additionalText,
CancellationToken cancellationToken,
out ImmutableDictionary<string, IReadOnlyList<(SymbolKind?, uint)>> ruleIdToThresholdMap,
out List<Diagnostic> invalidFileDiagnostics)
{
// Parse the additional file with Metric rule ID (which may contain an optional parenthesized SymbolKind suffix) and custom threshold.
// # FORMAT:
// # 'RuleId'(Optional 'SymbolKind'): 'Threshold'
ruleIdToThresholdMap = null;
invalidFileDiagnostics = null;
var builder = ImmutableDictionary.CreateBuilder<string, IReadOnlyList<(SymbolKind?, uint)>>(StringComparer.OrdinalIgnoreCase);
var lines = additionalText.GetText(cancellationToken).Lines;
foreach (var line in lines)
{
var contents = line.ToString().Trim();
if (contents.Length == 0 || contents.StartsWith("#", StringComparison.Ordinal))
{
// Ignore empty lines and comments.
continue;
}
var parts = contents.Split(':');
for (int i = 0; i < parts.Length; i++)
{
parts[i] = parts[i].Trim();
}
var isInvalidLine = false;
string key = parts[0];
if (parts.Length != 2 || // We require exactly one ':' separator in the line.
key.Any(char.IsWhiteSpace) || // We do not allow white spaces in rule name.
!uint.TryParse(parts[1], out uint threshold)) // Value must be a non-negative integral threshold.
{
isInvalidLine = true;
}
else
{
SymbolKind? symbolKindOpt = null;
string[] keyParts = key.Split('(');
switch (keyParts[0])
{
case CA1501RuleId:
case CA1502RuleId:
case CA1505RuleId:
case CA1506RuleId:
break;
default:
isInvalidLine = true;
break;
}
if (!isInvalidLine && keyParts.Length > 1)
{
if (keyParts.Length > 2 ||
keyParts[1].Length == 0 ||
keyParts[1].Last() != ')')
{
isInvalidLine = true;
}
else
{
// Remove the trailing ')'
var symbolKindStr = keyParts[1].Substring(0, keyParts[1].Length - 1);
switch (symbolKindStr)
{
case "Assembly":
symbolKindOpt = SymbolKind.Assembly;
break;
case "Namespace":
symbolKindOpt = SymbolKind.Namespace;
break;
case "Type":
symbolKindOpt = SymbolKind.NamedType;
break;
case "Method":
symbolKindOpt = SymbolKind.Method;
break;
case "Field":
symbolKindOpt = SymbolKind.Field;
break;
case "Event":
symbolKindOpt = SymbolKind.Event;
break;
case "Property":
symbolKindOpt = SymbolKind.Property;
break;
default:
isInvalidLine = true;
break;
}
}
}
if (!isInvalidLine)
{
if (!builder.TryGetValue(keyParts[0], out var values))
{
values = new List<(SymbolKind?, uint)>();
builder.Add(keyParts[0], values);
}
((List<(SymbolKind?, uint)>)values).Add((symbolKindOpt, threshold));
}
}
if (isInvalidLine)
{
// Invalid entry '{0}' in code metrics rule specification file '{1}'.
string arg1 = contents;
string arg2 = Path.GetFileName(additionalText.Path);
LinePositionSpan linePositionSpan = lines.GetLinePositionSpan(line.Span);
Location location = Location.Create(additionalText.Path, line.Span, linePositionSpan);
invalidFileDiagnostics ??= new List<Diagnostic>();
var diagnostic = Diagnostic.Create(InvalidEntryInCodeMetricsConfigFileRule, location, arg1, arg2);
invalidFileDiagnostics.Add(diagnostic);
}
}
ruleIdToThresholdMap = builder.ToImmutable();
return invalidFileDiagnostics == null;
}
private static int GetDistinctContainingNamespacesCount(IEnumerable<INamedTypeSymbol> namedTypes)
{
var distinctNamespaces = new HashSet<INamespaceSymbol>();
foreach (var namedType in namedTypes)
{
if (namedType.ContainingNamespace != null)
{
distinctNamespaces.Add(namedType.ContainingNamespace);
}
}
return distinctNamespaces.Count;
}
}
}