-
Notifications
You must be signed in to change notification settings - Fork 7
/
AbstractSubstituteAnalyzer.cs
346 lines (283 loc) · 16.6 KB
/
AbstractSubstituteAnalyzer.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
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Diagnostics;
using NSubstitute.Analyzers.Shared.Extensions;
namespace NSubstitute.Analyzers.Shared.DiagnosticAnalyzers
{
internal abstract class AbstractSubstituteAnalyzer<TSyntaxKind, TInvocationExpressionSyntax, TExpressionSyntax, TArgumentSyntax> : AbstractDiagnosticAnalyzer
where TSyntaxKind : struct
where TInvocationExpressionSyntax : SyntaxNode
where TExpressionSyntax : SyntaxNode
where TArgumentSyntax : SyntaxNode
{
private readonly Lazy<AbstractSubstituteProxyAnalysis<TInvocationExpressionSyntax, TExpressionSyntax>> _substituteProxyAnalysis;
private readonly Lazy<AbstractSubstituteConstructorAnalysis<TInvocationExpressionSyntax, TArgumentSyntax>> _substituteConstructorAnalysis;
private readonly Lazy<AbstractSubstituteConstructorMatcher> _substituteConstructorMatcher;
private AbstractSubstituteProxyAnalysis<TInvocationExpressionSyntax, TExpressionSyntax> SubstituteProxyAnalysis => _substituteProxyAnalysis.Value;
private AbstractSubstituteConstructorAnalysis<TInvocationExpressionSyntax, TArgumentSyntax> SubstituteConstructorAnalysis => _substituteConstructorAnalysis.Value;
private AbstractSubstituteConstructorMatcher SubstituteConstructorMatcher => _substituteConstructorMatcher.Value;
private static readonly ImmutableDictionary<string, string> MethodNamesMap =
new Dictionary<string, string>
{
[MetadataNames.NSubstituteForMethod] = MetadataNames.NSubstituteSubstituteFullTypeName,
[MetadataNames.NSubstituteForPartsOfMethod] = MetadataNames.NSubstituteSubstituteFullTypeName,
[MetadataNames.SubstituteFactoryCreate] = MetadataNames.NSubstituteFactoryFullTypeName,
[MetadataNames.SubstituteFactoryCreatePartial] = MetadataNames.NSubstituteFactoryFullTypeName
}.ToImmutableDictionary();
protected AbstractSubstituteAnalyzer(IDiagnosticDescriptorsProvider diagnosticDescriptorsProvider)
: base(diagnosticDescriptorsProvider)
{
_substituteProxyAnalysis = new Lazy<AbstractSubstituteProxyAnalysis<TInvocationExpressionSyntax, TExpressionSyntax>>(GetSubstituteProxyAnalysis);
_substituteConstructorAnalysis = new Lazy<AbstractSubstituteConstructorAnalysis<TInvocationExpressionSyntax, TArgumentSyntax>>(GetSubstituteConstructorAnalysis);
_substituteConstructorMatcher = new Lazy<AbstractSubstituteConstructorMatcher>(GetSubstituteConstructorMatcher);
}
protected abstract AbstractSubstituteProxyAnalysis<TInvocationExpressionSyntax, TExpressionSyntax> GetSubstituteProxyAnalysis();
protected abstract AbstractSubstituteConstructorAnalysis<TInvocationExpressionSyntax, TArgumentSyntax> GetSubstituteConstructorAnalysis();
protected abstract AbstractSubstituteConstructorMatcher GetSubstituteConstructorMatcher();
protected abstract TInvocationExpressionSyntax GetCorrespondingSubstituteInvocationExpressionSyntax(TInvocationExpressionSyntax invocationExpressionSyntax, string substituteName);
protected abstract TInvocationExpressionSyntax GetSubstituteInvocationExpressionSyntaxWithoutConstructorArguments(TInvocationExpressionSyntax invocationExpressionSyntax, IMethodSymbol methodSymbol);
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(
DiagnosticDescriptorsProvider.PartialSubstituteForUnsupportedType,
DiagnosticDescriptorsProvider.SubstituteForWithoutAccessibleConstructor,
DiagnosticDescriptorsProvider.SubstituteForConstructorParametersMismatch,
DiagnosticDescriptorsProvider.SubstituteForInternalMember,
DiagnosticDescriptorsProvider.SubstituteConstructorMismatch,
DiagnosticDescriptorsProvider.SubstituteMultipleClasses,
DiagnosticDescriptorsProvider.SubstituteConstructorArgumentsForInterface,
DiagnosticDescriptorsProvider.SubstituteConstructorArgumentsForDelegate);
protected abstract TSyntaxKind InvocationExpressionKind { get; }
public override void Initialize(AnalysisContext context)
{
context.RegisterSyntaxNodeAction(AnalyzeInvocation, InvocationExpressionKind);
}
private void AnalyzeInvocation(SyntaxNodeAnalysisContext syntaxNodeContext)
{
var invocationExpression = (TInvocationExpressionSyntax)syntaxNodeContext.Node;
var methodSymbolInfo = syntaxNodeContext.SemanticModel.GetSymbolInfo(invocationExpression);
if (methodSymbolInfo.Symbol?.Kind != SymbolKind.Method)
{
return;
}
var methodSymbol = (IMethodSymbol)methodSymbolInfo.Symbol;
if (methodSymbol == null || methodSymbol.MethodKind != MethodKind.Ordinary)
{
return;
}
if (IsSubstituteMethod(syntaxNodeContext, invocationExpression, methodSymbol.Name) == false)
{
return;
}
var substituteContext = new SubstituteContext<TInvocationExpressionSyntax>(syntaxNodeContext, invocationExpression, methodSymbol);
if (methodSymbol.Name.Equals(MetadataNames.NSubstituteForMethod, StringComparison.Ordinal) ||
methodSymbol.Name.Equals(MetadataNames.SubstituteFactoryCreate, StringComparison.Ordinal))
{
AnalyzeSubstitute(substituteContext);
return;
}
if (methodSymbol.Name.Equals(MetadataNames.NSubstituteForPartsOfMethod, StringComparison.Ordinal) ||
methodSymbol.Name.Equals(MetadataNames.SubstituteFactoryCreatePartial, StringComparison.Ordinal))
{
AnalyzePartialSubstitute(substituteContext);
}
}
private void AnalyzeSubstitute(SubstituteContext<TInvocationExpressionSyntax> substituteContext)
{
if (AnalyzeProxies(substituteContext))
{
return;
}
var proxyType = SubstituteProxyAnalysis.GetActualProxyTypeSymbol(substituteContext);
if (proxyType == null)
{
return;
}
if (AnalyzeTypeAccessability(substituteContext, proxyType))
{
return;
}
var constructorContext = SubstituteConstructorAnalysis.CollectConstructorContext(substituteContext, proxyType);
AnalyzeConstructor(substituteContext, constructorContext);
}
private void AnalyzePartialSubstitute(SubstituteContext<TInvocationExpressionSyntax> substituteContext)
{
if (AnalyzeProxies(substituteContext))
{
return;
}
var proxyType = SubstituteProxyAnalysis.GetActualProxyTypeSymbol(substituteContext);
if (proxyType == null)
{
return;
}
if (AnalyzeTypeKind(substituteContext, proxyType))
{
return;
}
if (AnalyzeTypeAccessability(substituteContext, proxyType))
{
return;
}
if (proxyType.TypeKind != TypeKind.Class)
{
return;
}
var constructorContext = SubstituteConstructorAnalysis.CollectConstructorContext(substituteContext, proxyType);
AnalyzeConstructor(substituteContext, constructorContext);
}
private void AnalyzeConstructor(SubstituteContext<TInvocationExpressionSyntax> substituteContext, ConstructorContext constructorContext)
{
if (AnalyzeConstructorAccessibility(substituteContext, constructorContext))
{
return;
}
if (AnalyzeConstructorParametersCount(substituteContext, constructorContext))
{
return;
}
if (AnalyzeConstructorInvocation(substituteContext, constructorContext))
{
return;
}
}
private bool AnalyzeProxies(SubstituteContext<TInvocationExpressionSyntax> substituteContext)
{
var proxies = SubstituteProxyAnalysis.GetProxySymbols(substituteContext).ToList();
var classProxies = proxies.Where(proxy => proxy.TypeKind == TypeKind.Class).Distinct();
if (classProxies.Count() > 1)
{
var diagnostic = Diagnostic.Create(
DiagnosticDescriptorsProvider.SubstituteMultipleClasses,
substituteContext.InvocationExpression.GetLocation());
substituteContext.SyntaxNodeAnalysisContext.ReportDiagnostic(diagnostic);
return true;
}
return false;
}
private bool AnalyzeConstructorParametersCount(SubstituteContext<TInvocationExpressionSyntax> substituteContext, ConstructorContext constructorContext)
{
var invocationArgumentTypes = constructorContext.InvocationParameters?.Count;
switch (constructorContext.ConstructorType.TypeKind)
{
case TypeKind.Interface when invocationArgumentTypes > 0:
var diagnostic = Diagnostic.Create(
DiagnosticDescriptorsProvider.SubstituteConstructorArgumentsForInterface,
substituteContext.InvocationExpression.GetLocation(),
GetSubstituteMethodWithoutConstructorArguments(substituteContext.InvocationExpression, substituteContext.MethodSymbol));
substituteContext.SyntaxNodeAnalysisContext.ReportDiagnostic(diagnostic);
return true;
case TypeKind.Interface:
return false;
case TypeKind.Delegate when invocationArgumentTypes > 0:
var delegateDiagnostic = Diagnostic.Create(
DiagnosticDescriptorsProvider.SubstituteConstructorArgumentsForDelegate,
substituteContext.InvocationExpression.GetLocation(),
GetSubstituteMethodWithoutConstructorArguments(substituteContext.InvocationExpression, substituteContext.MethodSymbol));
substituteContext.SyntaxNodeAnalysisContext.ReportDiagnostic(delegateDiagnostic);
return true;
case TypeKind.Delegate:
return false;
}
if (constructorContext.PossibleConstructors != null && constructorContext.PossibleConstructors.Any() == false)
{
var symbol = substituteContext.SyntaxNodeAnalysisContext.SemanticModel.GetSymbolInfo(substituteContext.InvocationExpression);
var diagnostic = Diagnostic.Create(
DiagnosticDescriptorsProvider.SubstituteForConstructorParametersMismatch,
substituteContext.InvocationExpression.GetLocation(),
symbol.Symbol.ToMinimalMethodString(substituteContext.SyntaxNodeAnalysisContext.SemanticModel),
constructorContext.ConstructorType);
substituteContext.SyntaxNodeAnalysisContext.ReportDiagnostic(diagnostic);
return true;
}
return false;
}
private bool AnalyzeTypeKind(SubstituteContext<TInvocationExpressionSyntax> substituteContext, ITypeSymbol proxyType)
{
if (proxyType.TypeKind == TypeKind.Interface || proxyType.TypeKind == TypeKind.Delegate)
{
var diagnostic = Diagnostic.Create(
DiagnosticDescriptorsProvider.PartialSubstituteForUnsupportedType,
substituteContext.InvocationExpression.GetLocation(),
GetCorrespondingSubstituteMethod(substituteContext.InvocationExpression, substituteContext.MethodSymbol),
substituteContext.InvocationExpression.ToString());
substituteContext.SyntaxNodeAnalysisContext.ReportDiagnostic(diagnostic);
return true;
}
return false;
}
private bool AnalyzeTypeAccessability(SubstituteContext<TInvocationExpressionSyntax> substituteContext, ITypeSymbol proxyType)
{
if (proxyType.DeclaredAccessibility == Accessibility.Internal && proxyType.InternalsVisibleToProxyGenerator() == false)
{
var diagnostic = Diagnostic.Create(
DiagnosticDescriptorsProvider.SubstituteForInternalMember,
substituteContext.InvocationExpression.GetLocation());
substituteContext.SyntaxNodeAnalysisContext.ReportDiagnostic(diagnostic);
return true;
}
return false;
}
private bool AnalyzeConstructorInvocation(SubstituteContext<TInvocationExpressionSyntax> substituteContext, ConstructorContext constructorContext)
{
if (constructorContext.ConstructorType.TypeKind != TypeKind.Class || constructorContext.InvocationParameters == null || constructorContext.PossibleConstructors == null)
{
return false;
}
if (constructorContext.PossibleConstructors.All(ctor =>
SubstituteConstructorMatcher.MatchesInvocation(
substituteContext.SyntaxNodeAnalysisContext.SemanticModel.Compilation, ctor, constructorContext.InvocationParameters) ==
false))
{
var diagnostic = Diagnostic.Create(
DiagnosticDescriptorsProvider.SubstituteConstructorMismatch,
substituteContext.InvocationExpression.GetLocation(),
substituteContext.MethodSymbol.ToMinimalMethodString(substituteContext.SyntaxNodeAnalysisContext.SemanticModel),
constructorContext.ConstructorType.ToString());
substituteContext.SyntaxNodeAnalysisContext.ReportDiagnostic(diagnostic);
return true;
}
return false;
}
private bool AnalyzeConstructorAccessibility(SubstituteContext<TInvocationExpressionSyntax> substituteContext, ConstructorContext constructorContext)
{
if (constructorContext.ConstructorType.TypeKind == TypeKind.Class && constructorContext.AccessibleConstructors != null && constructorContext.AccessibleConstructors.Any() == false)
{
var diagnostic = Diagnostic.Create(
DiagnosticDescriptorsProvider.SubstituteForWithoutAccessibleConstructor,
substituteContext.InvocationExpression.GetLocation(),
constructorContext.ConstructorType.ToString());
substituteContext.SyntaxNodeAnalysisContext.ReportDiagnostic(diagnostic);
return true;
}
return false;
}
private static bool IsSubstituteMethod(SyntaxNodeAnalysisContext syntaxNodeContext, SyntaxNode syntax, string memberName)
{
if (MethodNamesMap.TryGetValue(memberName, out var containingType) == false)
{
return false;
}
var symbol = syntaxNodeContext.SemanticModel.GetSymbolInfo(syntax);
return symbol.Symbol?.ContainingAssembly?.Name.Equals(MetadataNames.NSubstituteAssemblyName, StringComparison.Ordinal) == true &&
symbol.Symbol?.ContainingType?.ToString().Equals(containingType, StringComparison.Ordinal) == true;
}
private string GetCorrespondingSubstituteMethod(TInvocationExpressionSyntax invocationExpressionSyntax, IMethodSymbol methodSymbol)
{
switch (methodSymbol.Name)
{
case MetadataNames.SubstituteFactoryCreatePartial:
return GetCorrespondingSubstituteInvocationExpressionSyntax(invocationExpressionSyntax, MetadataNames.SubstituteFactoryCreate).ToString();
case MetadataNames.NSubstituteForPartsOfMethod:
return GetCorrespondingSubstituteInvocationExpressionSyntax(invocationExpressionSyntax, MetadataNames.NSubstituteForMethod).ToString();
default:
return string.Empty;
}
}
private string GetSubstituteMethodWithoutConstructorArguments(TInvocationExpressionSyntax invocationExpressionSyntax, IMethodSymbol methodSymbol)
{
return GetSubstituteInvocationExpressionSyntaxWithoutConstructorArguments(invocationExpressionSyntax, methodSymbol).ToString();
}
}
}