/
SA1651UnitTests.cs
300 lines (264 loc) · 8.54 KB
/
SA1651UnitTests.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
// 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.Verifiers;
using TestHelper;
using Xunit;
using static StyleCop.Analyzers.Test.Verifiers.CustomDiagnosticVerifier<StyleCop.Analyzers.DocumentationRules.SA1651DoNotUsePlaceholderElements>;
/// <summary>
/// This class contains unit tests for <see cref="SA1651DoNotUsePlaceholderElements"/>.
/// </summary>
public class SA1651UnitTests
{
[Fact]
public async Task TestEmptyDocumentationAsync()
{
var testCode = @"namespace FooNamespace
{
///
///
///
public class ClassName
{
}
}";
await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}
[Fact]
public async Task TestDocumentationWithoutPlaceholdersAsync()
{
var testCode = @"namespace FooNamespace
{
/// <summary>
/// Content.
/// </summary>
public class ClassName
{
}
}";
await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}
[Fact]
public async Task TestTopLevelPlaceholderAsync()
{
var testCode = @"namespace FooNamespace
{
/// <placeholder><summary>
/// Content.
/// </summary></placeholder>
public class ClassName
{
}
}";
var fixedCode = @"namespace FooNamespace
{
/// <summary>
/// Content.
/// </summary>
public class ClassName
{
}
}";
DiagnosticResult expected = Diagnostic().WithLocation(3, 9);
await VerifyCSharpFixAsync(testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
}
[Fact]
public async Task TestTopLevelEmptyPlaceholderAsync()
{
var testCode = @"namespace FooNamespace
{
/// <placeholder/>
public class ClassName
{
}
}";
// Empty placeholders are not altered by the current code fix.
var fixedCode = testCode;
DiagnosticResult expected = Diagnostic().WithLocation(3, 9);
await VerifyCSharpFixAsync(testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
}
[Fact]
public async Task TestEmbeddedPlaceholderAsync()
{
var testCode = @"namespace FooNamespace
{
/// <summary>
/// <placeholder>Content.</placeholder>
/// </summary>
public class ClassName
{
}
}";
var fixedCode = @"namespace FooNamespace
{
/// <summary>
/// Content.
/// </summary>
public class ClassName
{
}
}";
DiagnosticResult expected = Diagnostic().WithLocation(4, 9);
await VerifyCSharpFixAsync(testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
}
[Fact]
public async Task TestEmbeddedEmptyPlaceholderAsync()
{
var testCode = @"namespace FooNamespace
{
/// <summary>
/// Content.<placeholder/>
/// </summary>
public class ClassName
{
}
}";
// Empty placeholders are not altered by the current code fix.
var fixedCode = testCode;
DiagnosticResult expected = Diagnostic().WithLocation(4, 17);
await VerifyCSharpFixAsync(testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
}
[Fact]
public async Task TestDeeplyEmbeddedPlaceholderAsync()
{
var testCode = @"namespace FooNamespace
{
/// <summary>
/// Content.
/// </summary>
/// <remarks>
/// <list type=""bullet"">
/// <item><placeholder>Nested content.</placeholder></item>
/// </list>
/// </remarks>
public class ClassName
{
}
}";
var fixedCode = @"namespace FooNamespace
{
/// <summary>
/// Content.
/// </summary>
/// <remarks>
/// <list type=""bullet"">
/// <item>Nested content.</item>
/// </list>
/// </remarks>
public class ClassName
{
}
}";
DiagnosticResult expected = Diagnostic().WithLocation(8, 15);
await VerifyCSharpFixAsync(testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
}
[Fact]
public async Task TestFormattingPreservedAsync()
{
var testCode = @"namespace FooNamespace
{
/// <placeholder> <summary>
/// Content <placeholder
/// >.</placeholder>
///</summary> </placeholder
///> <remarks/>
public class ClassName
{
}
}";
var fixedCode = @"namespace FooNamespace
{
/// <summary>
/// Content .
///</summary> <remarks/>
public class ClassName
{
}
}";
DiagnosticResult[] expected =
{
Diagnostic().WithLocation(3, 9),
Diagnostic().WithLocation(4, 18),
};
await VerifyCSharpFixAsync(testCode, expected, fixedCode, CancellationToken.None).ConfigureAwait(false);
}
/// <summary>
/// Verifies that included documentation without place holders will not produce diagnostics.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestNoPlaceHolderInIncludedDocumentationAsync()
{
var testCode = @"
/// <include file='SummaryWithoutPlaceHolder.xml' path='/TestClass/*'/>
public class TestClass
{
}
";
await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}
/// <summary>
/// Verifies that included documentation with place holders will not produce the expected diagnostics.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestPlaceHolderInIncludedDocumentationAsync()
{
var testCode = @"
/// <include file='SummaryWithPlaceHolder.xml' path='/TestClass/*'/>
public class TestClass
{
}
";
var expected = Diagnostic().WithLocation(2, 5);
await VerifyCSharpFixAsync(testCode, expected, testCode, 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<SA1651DoNotUsePlaceholderElements, SA1651CodeFixProvider>.CSharpTest CreateTest(DiagnosticResult[] expected)
{
string contentSummaryWithoutPlaceHolder = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<summary>
This is a test class.
</summary>
</TestClass>
";
string contentSummaryWithPlaceHolder = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
<TestClass>
<summary>
<placeholder>This is a test class.</placeholder>
</summary>
</TestClass>
";
var test = new StyleCopCodeFixVerifier<SA1651DoNotUsePlaceholderElements, SA1651CodeFixProvider>.CSharpTest
{
XmlReferences =
{
{ "SummaryWithoutPlaceHolder.xml", contentSummaryWithoutPlaceHolder },
{ "SummaryWithPlaceHolder.xml", contentSummaryWithPlaceHolder },
},
};
test.ExpectedDiagnostics.AddRange(expected);
return test;
}
}
}