forked from dotnet/format
/
ThirdPartyAnalyzerFormatterTests.cs
217 lines (171 loc) · 6.26 KB
/
ThirdPartyAnalyzerFormatterTests.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
// Copyright (c) Microsoft. All Rights Reserved. Licensed under the MIT license. See License.txt in the project root for license information.
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.Diagnostics;
using Microsoft.CodeAnalysis.Tools.Analyzers;
using Microsoft.CodeAnalysis.Tools.Formatters;
using Microsoft.CodeAnalysis.Tools.Tests.Formatters;
using Microsoft.CodeAnalysis.Tools.Tests.Utilities;
using Microsoft.CodeAnalysis.Tools.Workspaces;
using Xunit;
using Xunit.Abstractions;
namespace Microsoft.CodeAnalysis.Tools.Tests.Analyzers
{
public class ThirdPartyAnalyzerFormatterTests : CSharpFormatterTests, IAsyncLifetime
{
private static readonly string s_analyzerProjectFilePath = Path.Combine("for_analyzer_formatter", "analyzer_project", "analyzer_project.csproj");
private protected override ICodeFormatter Formatter => AnalyzerFormatter.ThirdPartyFormatter;
private Project _analyzerReferencesProject;
public ThirdPartyAnalyzerFormatterTests(ITestOutputHelper output)
{
TestOutputHelper = output;
}
public async Task InitializeAsync()
{
var logger = new TestLogger();
try
{
// Restore the Analyzer packages that have been added to `for_analyzer_formatter/analyzer_project/analyzer_project.csproj`
var exitCode = await NuGetHelper.PerformRestore(s_analyzerProjectFilePath, TestOutputHelper);
Assert.Equal(0, exitCode);
// Load the analyzer_project into a MSBuildWorkspace.
var workspacePath = Path.Combine(TestProjectsPathHelper.GetProjectsDirectory(), s_analyzerProjectFilePath);
MSBuildRegistrar.RegisterInstance();
var analyzerWorkspace = await MSBuildWorkspaceLoader.LockedLoadAsync(workspacePath, WorkspaceType.Project, binaryLogPath: null, logWorkspaceWarnings: true, logger, CancellationToken.None);
TestOutputHelper.WriteLine(logger.GetLog());
// From this project we can get valid AnalyzerReferences to add to our test project.
_analyzerReferencesProject = analyzerWorkspace.CurrentSolution.Projects.Single();
}
catch
{
TestOutputHelper.WriteLine(logger.GetLog());
throw;
}
}
public Task DisposeAsync()
{
_analyzerReferencesProject = null;
return Task.CompletedTask;
}
private IEnumerable<AnalyzerReference> GetAnalyzerReferences(string prefix)
=> _analyzerReferencesProject.AnalyzerReferences.Where(reference => reference.Display.StartsWith(prefix));
[Fact]
public async Task TestStyleCopBlankLineFixer_RemovesUnnecessaryBlankLines()
{
var analyzerReferences = GetAnalyzerReferences("StyleCop");
var testCode = @"
class C
{
void M()
{
object obj = new object();
int count = 5;
}
}
";
var expectedCode = @"
class C
{
void M()
{
object obj = new object();
int count = 5;
}
}
";
var editorConfig = new Dictionary<string, string>()
{
// Turn off all diagnostics analyzers
["dotnet_analyzer_diagnostic.severity"] = "none",
// Two or more consecutive blank lines: Remove down to one blank line. SA1507
["dotnet_diagnostic.SA1507.severity"] = "error",
// Blank line immediately before or after a { line: remove it. SA1505, SA1509
["dotnet_diagnostic.SA1505.severity"] = "error",
["dotnet_diagnostic.SA1509.severity"] = "error",
// Blank line immediately before a } line: remove it. SA1508
["dotnet_diagnostic.SA1508.severity"] = "error",
};
await AssertCodeChangedAsync(testCode, expectedCode, editorConfig, fixCategory: FixCategory.Analyzers, analyzerReferences: analyzerReferences);
}
[Fact]
public async Task TestIDisposableAnalyzer_AddsUsing()
{
var analyzerReferences = GetAnalyzerReferences("IDisposable");
var testCode = @"
using System.IO;
class C
{
void M()
{
var stream = File.OpenRead(string.Empty);
var b = stream.ReadByte();
stream.Dispose();
}
}
";
var expectedCode = @"
using System.IO;
class C
{
void M()
{
using (var stream = File.OpenRead(string.Empty))
{
var b = stream.ReadByte();
}
}
}
";
var editorConfig = new Dictionary<string, string>()
{
// Turn off all diagnostics analyzers
["dotnet_analyzer_diagnostic.severity"] = "none",
// Prefer using. IDISP017
["dotnet_diagnostic.IDISP017.severity"] = "error",
};
await AssertCodeChangedAsync(testCode, expectedCode, editorConfig, fixCategory: FixCategory.Analyzers, analyzerReferences: analyzerReferences);
}
[Fact]
public async Task TestLoadingAllAnalyzers_LoadsDependenciesFromAllSearchPaths()
{
// Loads all analyzer references.
var analyzerReferences = _analyzerReferencesProject.AnalyzerReferences;
var testCode = @"
using System.IO;
class C
{
void M()
{
var stream = File.OpenRead(string.Empty);
var b = stream.ReadByte();
stream.Dispose();
}
}
";
var expectedCode = @"
using System.IO;
class C
{
void M()
{
using (var stream = File.OpenRead(string.Empty))
{
var b = stream.ReadByte();
}
}
}
";
var editorConfig = new Dictionary<string, string>()
{
// Turn off all diagnostics analyzers
["dotnet_analyzer_diagnostic.severity"] = "none",
// Prefer using. IDISP017
["dotnet_diagnostic.IDISP017.severity"] = "error",
};
await AssertCodeChangedAsync(testCode, expectedCode, editorConfig, fixCategory: FixCategory.Analyzers, analyzerReferences: analyzerReferences);
}
}
}