-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathValidatorRunnerTests.cs
More file actions
303 lines (241 loc) · 10.7 KB
/
ValidatorRunnerTests.cs
File metadata and controls
303 lines (241 loc) · 10.7 KB
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
using AwesomeAssertions;
using JulianVerdurmen.SlnxValidator.Core.FileSystem;
using JulianVerdurmen.SlnxValidator.Core.SarifReporting;
using JulianVerdurmen.SlnxValidator.Core.SonarQubeReporting;
using JulianVerdurmen.SlnxValidator.Core.Validation;
using JulianVerdurmen.SlnxValidator.Core.ValidationResults;
using NSubstitute;
namespace JulianVerdurmen.SlnxValidator.Tests;
public class ValidatorRunnerTests
{
private readonly FakeConsole _console = new();
private ValidatorRunner CreateRunner(IFileSystem fileSystem, IRequiredFilesChecker? checker = null)
{
checker ??= Substitute.For<IRequiredFilesChecker>();
var resolver = Substitute.For<ISlnxFileResolver>();
var collector = new SlnxCollector(fileSystem, resolver, Substitute.For<ISlnxValidator>(), checker);
var sonarReporter = new SonarReporter(fileSystem);
var sarifReporter = new SarifReporter(fileSystem);
return new ValidatorRunner(collector, sonarReporter, sarifReporter, checker, fileSystem, _console);
}
private static ValidatorRunnerOptions Options(string input = "test.slnx",
bool continueOnError = false, string? requiredFilesPattern = null) =>
new(input, SonarqubeReportPath: null, continueOnError, requiredFilesPattern, WorkingDirectory: ".");
private ValidatorRunner CreateRunnerWithSlnx(
string slnxPath, string slnxContent, IRequiredFilesChecker? checker = null)
{
checker ??= Substitute.For<IRequiredFilesChecker>();
var fileSystem = new MockFileSystem(new Dictionary<string, string>
{
[slnxPath] = slnxContent
});
var validator = Substitute.For<ISlnxValidator>();
validator.ValidateAsync(Arg.Any<SlnxFile>(), Arg.Any<CancellationToken>())
.Returns(new ValidationResult());
var resolver = Substitute.For<ISlnxFileResolver>();
resolver.Resolve(Arg.Any<string>()).Returns([slnxPath]);
var collector = new SlnxCollector(fileSystem, resolver, validator, checker);
var sonarReporter = new SonarReporter(fileSystem);
var sarifReporter = new SarifReporter(fileSystem);
return new ValidatorRunner(collector, sonarReporter, sarifReporter, checker, fileSystem, _console);
}
#region RunAsync – file resolution
[Test]
public async Task RunAsync_FileNotFound_ContinueOnErrorFalse_ReturnsOne()
{
// Arrange
var runner = CreateRunner(new MockFileSystem());
// Act
var exitCode = await runner.RunAsync(Options("nonexistent.slnx"), CancellationToken.None);
// Assert
exitCode.Should().Be(1);
}
[Test]
public async Task RunAsync_FileNotFound_ContinueOnErrorTrue_ReturnsZero()
{
// Arrange
var runner = CreateRunner(new MockFileSystem());
// Act
var exitCode = await runner.RunAsync(Options("nonexistent.slnx", continueOnError: true), CancellationToken.None);
// Assert
exitCode.Should().Be(0);
}
[Test]
public async Task RunAsync_NoFilesFound_ContinueOnErrorFalse_ReturnsOne()
{
// Arrange
var runner = CreateRunner(new MockFileSystem());
// Act
var exitCode = await runner.RunAsync(Options("src/*.slnx"), CancellationToken.None);
// Assert
exitCode.Should().Be(1);
}
[Test]
public async Task RunAsync_NoFilesFound_ContinueOnErrorTrue_ReturnsZero()
{
// Arrange
var runner = CreateRunner(new MockFileSystem());
// Act
var exitCode = await runner.RunAsync(Options("src/*.slnx", continueOnError: true), CancellationToken.None);
// Assert
exitCode.Should().Be(0);
}
#endregion
#region RunAsync – --required-files
[Test]
public async Task RunAsync_RequiredFiles_AllMatchedAndReferenced_ReturnsZero()
{
// Arrange
var slnxPath = Path.GetFullPath("test.slnx");
var slnxDir = Path.GetDirectoryName(slnxPath)!;
var requiredFile = Path.GetFullPath(Path.Combine(slnxDir, "doc", "readme.md"));
var checker = Substitute.For<IRequiredFilesChecker>();
checker.ResolveMatchedPaths(Arg.Any<string>(), Arg.Any<string>())
.Returns([requiredFile]);
checker.CheckInSlnx(Arg.Any<IReadOnlyList<string>>(), Arg.Any<SlnxFile>())
.Returns([]);
var runner = CreateRunnerWithSlnx(slnxPath, "<Solution />", checker);
// Act
var exitCode = await runner.RunAsync(
Options(slnxPath, requiredFilesPattern: "doc/*.md"), CancellationToken.None);
// Assert
exitCode.Should().Be(0);
}
[Test]
public async Task RunAsync_RequiredFiles_NoMatchOnDisk_ReturnsOne()
{
// Arrange
var slnxPath = Path.GetFullPath("test.slnx");
var checker = Substitute.For<IRequiredFilesChecker>();
checker.ResolveMatchedPaths(Arg.Any<string>(), Arg.Any<string>())
.Returns([]); // nothing matched on disk
var runner = CreateRunnerWithSlnx(slnxPath, "<Solution />", checker);
// Act
var exitCode = await runner.RunAsync(
Options(slnxPath, requiredFilesPattern: "nonexistent/**/*.md"), CancellationToken.None);
// Assert
exitCode.Should().Be(1);
}
#endregion
#region RunAsync – severity overrides
// All severity override tests use a .xml file (not .slnx) to generate SLNX002 (InvalidExtension) errors,
// which allows testing severity override behavior with predictable validation output.
[Test]
public async Task RunAsync_IgnoreAllCodes_WithErrors_ReturnsZero()
{
// Arrange: file with wrong extension generates SLNX002; --ignore * suppresses all codes
var runner = CreateRunnerWithSlnx("test.xml", "<Solution />");
var overrides = SeverityOverridesParser.Parse(null, null, null, null, null, ignore: "*");
// Act
var exitCode = await runner.RunAsync(
new ValidatorRunnerOptions("test.xml", null, false, null, ".", overrides),
CancellationToken.None);
// Assert
exitCode.Should().Be(0);
}
[Test]
public async Task RunAsync_IgnoreSpecificCode_ThatCodeDoesNotCauseExitOne()
{
// Arrange: --ignore SLNX002 suppresses the InvalidExtension error
var runner = CreateRunnerWithSlnx("test.xml", "<Solution />");
var overrides = SeverityOverridesParser.Parse(null, null, null, null, null, ignore: "SLNX002");
// Act
var exitCode = await runner.RunAsync(
new ValidatorRunnerOptions("test.xml", null, false, null, ".", overrides),
CancellationToken.None);
// Assert
exitCode.Should().Be(0);
}
[Test]
public async Task RunAsync_MinorOverrideForErrorCode_ReturnsZero()
{
// Arrange: --minor SLNX002 downgrades InvalidExtension to non-failing severity
var runner = CreateRunnerWithSlnx("test.xml", "<Solution />");
var overrides = SeverityOverridesParser.Parse(null, null, null, minor: "SLNX002", null, null);
// Act
var exitCode = await runner.RunAsync(
new ValidatorRunnerOptions("test.xml", null, false, null, ".", overrides),
CancellationToken.None);
// Assert
exitCode.Should().Be(0);
}
[Test]
public async Task RunAsync_InfoAllCodes_ReturnsZero()
{
// Arrange: --info * downgrades all codes to INFO (non-failing)
var runner = CreateRunnerWithSlnx("test.xml", "<Solution />");
var overrides = SeverityOverridesParser.Parse(null, null, null, null, info: "*", null);
// Act
var exitCode = await runner.RunAsync(
new ValidatorRunnerOptions("test.xml", null, false, null, ".", overrides),
CancellationToken.None);
// Assert
exitCode.Should().Be(0);
}
[Test]
public async Task RunAsync_InfoAllCodesMajorSpecificCode_SpecificCodeCausesExitOne()
{
// Arrange: --info * --major SLNX002 → SLNX002 stays MAJOR (specific overrides wildcard)
var runner = CreateRunnerWithSlnx("test.xml", "<Solution />");
var overrides = SeverityOverridesParser.Parse(null, null, major: "SLNX002", null, info: "*", null);
// Act
var exitCode = await runner.RunAsync(
new ValidatorRunnerOptions("test.xml", null, false, null, ".", overrides),
CancellationToken.None);
// Assert
exitCode.Should().Be(1);
}
[Test]
public async Task RunAsync_IgnoreAllCodesMajorSpecificCode_SpecificCodeCausesExitOne()
{
// Arrange: --ignore * --major SLNX002 → SLNX002 is MAJOR (specific wins over wildcard ignore)
var runner = CreateRunnerWithSlnx("test.xml", "<Solution />");
var overrides = SeverityOverridesParser.Parse(null, null, major: "SLNX002", null, null, ignore: "*");
// Act
var exitCode = await runner.RunAsync(
new ValidatorRunnerOptions("test.xml", null, false, null, ".", overrides),
CancellationToken.None);
// Assert
exitCode.Should().Be(1);
}
#endregion
#region RunAsync – console output
[Test]
public async Task RunAsync_NoFilesFound_WritesErrorToConsole()
{
// Arrange
var runner = CreateRunner(new MockFileSystem());
// Act
await runner.RunAsync(Options("nonexistent.slnx"), CancellationToken.None);
// Assert
_console.ErrorLines.Should().ContainMatch("*No .slnx files found for input: nonexistent.slnx*");
}
[Test]
public async Task RunAsync_SonarqubeReportPath_WritesConfirmationToConsole()
{
// Arrange
var slnxPath = Path.GetFullPath("test.slnx");
var runner = CreateRunnerWithSlnx(slnxPath, "<Solution />");
var options = new ValidatorRunnerOptions(slnxPath, SonarqubeReportPath: "report.xml",
ContinueOnError: false, RequiredFilesPattern: null, WorkingDirectory: ".");
// Act
await runner.RunAsync(options, CancellationToken.None);
// Assert
_console.OutputLines.Should().ContainMatch("*SonarQube report written to: report.xml*");
}
[Test]
public async Task RunAsync_SarifReportPath_WritesConfirmationToConsole()
{
// Arrange
var slnxPath = Path.GetFullPath("test.slnx");
var runner = CreateRunnerWithSlnx(slnxPath, "<Solution />");
var options = new ValidatorRunnerOptions(slnxPath, SonarqubeReportPath: null,
ContinueOnError: false, RequiredFilesPattern: null, WorkingDirectory: ".",
SarifReportPath: "report.sarif");
// Act
await runner.RunAsync(options, CancellationToken.None);
// Assert
_console.OutputLines.Should().ContainMatch("*SARIF report written to: report.sarif*");
}
#endregion
}