/
SA1643UnitTests.cs
397 lines (347 loc) · 13.7 KB
/
SA1643UnitTests.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
// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
namespace StyleCop.Analyzers.Test.DocumentationRules
{
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.Testing;
using StyleCop.Analyzers.DocumentationRules;
using StyleCop.Analyzers.Test.Helpers;
using StyleCop.Analyzers.Test.Verifiers;
using TestHelper;
using Xunit;
using static StyleCop.Analyzers.Test.Verifiers.CustomDiagnosticVerifier<StyleCop.Analyzers.DocumentationRules.SA1643DestructorSummaryDocumentationMustBeginWithStandardText>;
/// <summary>
/// This class contains unit tests for <see cref="SA1643DestructorSummaryDocumentationMustBeginWithStandardText"/>.
/// </summary>
[UseCulture("en-US")]
public class SA1643UnitTests
{
[Fact]
public async Task TestNoDocumentationAsync()
{
var testCode = @"namespace FooNamespace
{
public class Foo<TFoo, TBar>
{
~Foo()
{
}
}
}";
await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}
[Fact]
public async Task TestDestructorCorrectDocumentationSimpleAsync()
{
await TestDestructorCorrectDocumentationSimpleImplAsync(DocumentationResources.DestructorStandardTextFirstPart, DocumentationResources.DestructorStandardTextSecondPart, false).ConfigureAwait(false);
}
[Fact]
public async Task TestDestructorCorrectDocumentationCustomizedAsync()
{
await TestDestructorCorrectDocumentationCustomizedImplAsync(DocumentationResources.DestructorStandardTextFirstPart, DocumentationResources.DestructorStandardTextSecondPart, false).ConfigureAwait(false);
}
[Fact]
public async Task TestNonPrivateConstructorCorrectDocumentationGenericSimpleAsync()
{
await TestDestructorCorrectDocumentationSimpleImplAsync(DocumentationResources.DestructorStandardTextFirstPart, DocumentationResources.DestructorStandardTextSecondPart, true).ConfigureAwait(false);
}
[Fact]
public async Task TestDestructorCorrectDocumentationGenericCustomizedAsync()
{
await TestDestructorCorrectDocumentationCustomizedImplAsync(DocumentationResources.DestructorStandardTextFirstPart, DocumentationResources.DestructorStandardTextSecondPart, true).ConfigureAwait(false);
}
[Fact]
public async Task TestDestructorMissingDocumentationAsync()
{
await TestDestructorMissingDocumentationImplAsync(DocumentationResources.DestructorStandardTextFirstPart, DocumentationResources.DestructorStandardTextSecondPart, false).ConfigureAwait(false);
}
[Fact]
public async Task TestDestructorMissingDocumentationGenericAsync()
{
await TestDestructorMissingDocumentationImplAsync(DocumentationResources.DestructorStandardTextFirstPart, DocumentationResources.DestructorStandardTextSecondPart, true).ConfigureAwait(false);
}
/// <summary>
/// Verifies that a destructor with the correct summary text from included documentation will not produce any diagnostics.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestDestructorWithValidSummaryInIncludedDocsAsync()
{
var testCode = @"
public class TestClass
{
/// <include file='ValidSummary.xml' path='/TestClass/Destructor/*'/>
~TestClass() { }
}
";
await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}
/// <summary>
/// Verifies that a destructor with the missing summary tag from included documentation will not produce any diagnostics.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestDestructorWithMissingSummaryInIncludedDocsAsync()
{
var testCode = @"
public class TestClass
{
/// <include file='MissingSummary.xml' path='/TestClass/Destructor/*'/>
~TestClass() { }
}
";
await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}
/// <summary>
/// Verifies that a destructor with an empty summary tag from included documentation will produce a diagnostic and offer no codefix.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestDestructorWithEmptySummaryInIncludedDocsAsync()
{
var testCode = @"
public class TestClass
{
/// <include file='EmptySummary.xml' path='/TestClass/Destructor/*'/>
~TestClass() { }
}
";
var expected = Diagnostic().WithLocation(4, 9);
await VerifyCSharpFixAsync(testCode, expected, testCode, CancellationToken.None).ConfigureAwait(false);
}
/// <summary>
/// Verifies that a destructor with an invalid summary tag from included documentation will produce a diagnostic and offer no codefix.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestDestructorWithInvalidSummaryInIncludedDocsAsync()
{
var testCode = @"
public class TestClass
{
/// <include file='InvalidSummary.xml' path='/TestClass/Destructor/*'/>
~TestClass() { }
}
";
var expected = Diagnostic().WithLocation(4, 9);
await VerifyCSharpFixAsync(testCode, expected, testCode, CancellationToken.None).ConfigureAwait(false);
}
/// <summary>
/// Verify that the codefix will work properly with Visual Studio generated documentation headers.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestWithDefaultVisualStudioGenerationDocumentationAsync()
{
var testCode = @"
public class TestClass
{
/// <summary>
///
/// </summary>
~TestClass() { }
}
";
var fixedCode = @"
public class TestClass
{
/// <summary>
/// Finalizes an instance of the <see cref=""TestClass""/> class.
/// </summary>
~TestClass() { }
}
";
var expected = Diagnostic().WithLocation(4, 9);
await VerifyCSharpFixAsync(testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
}
/// <summary>
/// Verify that the codefix will work properly when there are multiple empty lines.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestWithMultipleEmptyLinesAsync()
{
var testCode = @"
public class TestClass
{
/// <summary>
///
/// </summary>
~TestClass() { }
}
";
var fixedCode = @"
public class TestClass
{
/// <summary>
/// Finalizes an instance of the <see cref=""TestClass""/> class.
/// </summary>
~TestClass() { }
}
";
var expected = Diagnostic().WithLocation(4, 9);
await VerifyCSharpFixAsync(testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
}
[Fact]
public async Task TestEmptyDestructorAsync()
{
var testCode = @"namespace FooNamespace
{
public class Foo<TFoo, TBar>
{
///
///
///
~Foo()
{
}
}
}";
await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}
private static async Task TestDestructorCorrectDocumentationAsync(string part1, string part2, string part3, bool generic)
{
// First test it all on one line
var testCode = @"namespace FooNamespace
{{
public class Foo{0}
{{
/// <summary>
/// {2}<see cref=""Foo{1}""/>{3}{4}
/// </summary>
~Foo()
{{
}}
}}
}}";
await VerifyCSharpDiagnosticAsync(string.Format(testCode, generic ? "<T1, T2>" : string.Empty, generic ? "{T1, T2}" : string.Empty, part1, part2, part3), DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
// Then test splitting after the <see> element
testCode = @"namespace FooNamespace
{{
public class Foo{0}
{{
/// <summary>
/// {2}<see cref=""Foo{1}""/>
/// {3}{4}
/// </summary>
~Foo()
{{
}}
}}
}}";
await VerifyCSharpDiagnosticAsync(string.Format(testCode, generic ? "<T1, T2>" : string.Empty, generic ? "{T1, T2}" : string.Empty, part1, part2, part3), DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
// Then test splitting before the <see> element
testCode = @"namespace FooNamespace
{{
public class Foo{0}
{{
/// <summary>
/// {2}
/// <see cref=""Foo{1}""/>{3}{4}
/// </summary>
Foo()
{{
}}
}}
}}";
await VerifyCSharpDiagnosticAsync(string.Format(testCode, generic ? "<T1, T2>" : string.Empty, generic ? "{T1, T2}" : string.Empty, part1, part2, part3), DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}
private static async Task TestDestructorCorrectDocumentationSimpleImplAsync(string part1, string part2, bool generic)
{
await TestDestructorCorrectDocumentationAsync(part1, part2, ".", generic).ConfigureAwait(false);
}
private static async Task TestDestructorCorrectDocumentationCustomizedImplAsync(string part1, string part2, bool generic)
{
await TestDestructorCorrectDocumentationAsync(part1, part2, " with A and B.", generic).ConfigureAwait(false);
}
private static async Task TestDestructorMissingDocumentationImplAsync(string part1, string part2, bool generic)
{
var testCode = @"namespace FooNamespace
{{
public class Foo{0}
{{
/// <summary>
/// </summary>
~Foo()
{{
}}
}}
}}";
testCode = string.Format(testCode, generic ? "<T1, T2>" : string.Empty);
DiagnosticResult expected = Diagnostic().WithLocation(5, 13);
var fixedCode = @"namespace FooNamespace
{{
public class Foo{0}
{{
/// <summary>
/// {2}<see cref=""Foo{1}""/>{3}{4}
/// </summary>
~Foo()
{{
}}
}}
}}";
string part3 = part2.EndsWith(".") ? string.Empty : ".";
fixedCode = string.Format(fixedCode, generic ? "<T1, T2>" : string.Empty, generic ? "{T1, T2}" : string.Empty, part1, part2, part3);
await VerifyCSharpFixAsync(testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
}
private static Task VerifyCSharpDiagnosticAsync(string source, DiagnosticResult[] expected, CancellationToken cancellationToken)
{
var test = CreateTest(expected);
test.TestCode = source;
return test.RunAsync(cancellationToken);
}
private static Task VerifyCSharpFixAsync(string source, DiagnosticResult expected, string fixedSource, CancellationToken cancellationToken)
=> VerifyCSharpFixAsync(source, new[] { expected }, fixedSource, cancellationToken);
private static Task VerifyCSharpFixAsync(string source, DiagnosticResult[] expected, string fixedSource, CancellationToken cancellationToken)
{
var test = CreateTest(expected);
test.TestCode = source;
test.FixedCode = fixedSource;
return test.RunAsync(cancellationToken);
}
private static StyleCopCodeFixVerifier<SA1643DestructorSummaryDocumentationMustBeginWithStandardText, SA1642SA1643CodeFixProvider>.CSharpTest CreateTest(DiagnosticResult[] expected)
{
string contentValidSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Destructor>
<summary>Finalizes an instance of the <see cref=""TestClass""/> class.</summary>
</Destructor>
</TestClass>
";
string contentMissingSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Destructor>
</Destructor>
</TestClass>
";
string contentEmptySummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Destructor>
<summary></summary>
</Destructor>
</TestClass>
";
string contentInvalidSummary = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<Destructor>
<summary>Creates the <see cref=""TestClass""/> class.</summary>
</Destructor>
</TestClass>
";
var test = new StyleCopCodeFixVerifier<SA1643DestructorSummaryDocumentationMustBeginWithStandardText, SA1642SA1643CodeFixProvider>.CSharpTest
{
XmlReferences =
{
{ "ValidSummary.xml", contentValidSummary },
{ "MissingSummary.xml", contentMissingSummary },
{ "EmptySummary.xml", contentEmptySummary },
{ "InvalidSummary.xml", contentInvalidSummary },
},
};
test.ExpectedDiagnostics.AddRange(expected);
return test;
}
}
}