-
-
Notifications
You must be signed in to change notification settings - Fork 987
/
Copy pathConfigParserTests.cs
692 lines (581 loc) · 32.6 KB
/
ConfigParserTests.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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
using System;
using System.Globalization;
using System.IO;
using System.Linq;
using BenchmarkDotNet.Columns;
using BenchmarkDotNet.Configs;
using BenchmarkDotNet.ConsoleArguments;
using BenchmarkDotNet.Diagnosers;
using BenchmarkDotNet.Engines;
using BenchmarkDotNet.Environments;
using BenchmarkDotNet.Jobs;
using BenchmarkDotNet.Exporters;
using BenchmarkDotNet.Exporters.Csv;
using BenchmarkDotNet.Tests.Loggers;
using BenchmarkDotNet.Tests.Mocks;
using BenchmarkDotNet.Tests.XUnit;
using BenchmarkDotNet.Toolchains;
using BenchmarkDotNet.Toolchains.NativeAot;
using BenchmarkDotNet.Toolchains.CoreRun;
using BenchmarkDotNet.Toolchains.CsProj;
using BenchmarkDotNet.Toolchains.DotNetCli;
using Xunit;
using Xunit.Abstractions;
using BenchmarkDotNet.Portability;
using Perfolizer.Horology;
using Perfolizer.Mathematics.SignificanceTesting;
using Perfolizer.Mathematics.Thresholds;
using BenchmarkDotNet.Exporters.Json;
namespace BenchmarkDotNet.Tests
{
public class CustomExporterTestClass : JsonExporterBase { }
public class ConfigParserTests
{
public ITestOutputHelper Output { get; }
public ConfigParserTests(ITestOutputHelper output) => Output = output;
[Theory]
[InlineData("--customExporter", "BenchmarkDotNet.Tests.CustomExporterTestClass, BenchmarkDotNet.Tests")]
public void CustomExporterConfigParsedCorrectly(params string[] args)
{
var config = ConfigParser.Parse(args, new OutputLogger(Output)).config;
var customExporter = config.GetExporters().ToList();
Assert.Equal("CustomExporterTestClass", customExporter[0].Name);
Assert.Empty(config.GetColumnProviders());
Assert.Empty(config.GetDiagnosers());
Assert.Empty(config.GetAnalysers());
Assert.Empty(config.GetLoggers());
}
[Theory]
[InlineData("--job=dry", "--exporters", "html", "rplot")]
[InlineData("--JOB=dry", "--EXPORTERS", "html", "rplot")] // case insensitive
[InlineData("-j", "dry", "-e", "html", "rplot")] // alias
public void SimpleConfigParsedCorrectly(params string[] args)
{
var config = ConfigParser.Parse(args, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
Assert.Contains(Job.Dry, config.GetJobs());
Assert.Equal(3, config.GetExporters().Count()); // rplot must come together with CsvMeasurementsExporter
Assert.Contains(HtmlExporter.Default, config.GetExporters());
Assert.Contains(RPlotExporter.Default, config.GetExporters());
Assert.Contains(CsvMeasurementsExporter.Default, config.GetExporters());
Assert.Empty(config.GetColumnProviders());
Assert.Empty(config.GetDiagnosers());
Assert.Empty(config.GetAnalysers());
Assert.Empty(config.GetLoggers());
}
[Fact]
public void SimpleConfigAlternativeVersionParsedCorrectly()
{
var config = ConfigParser.Parse(new[] { "--job=Dry" }, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
Assert.Contains(Job.Dry, config.GetJobs());
}
[Fact]
public void UserCanSpecifyHowManyTimesTheBenchmarkShouldBeExecuted()
{
const int launchCount = 4;
const int warmupCount = 1;
const int iterationTime = 250;
const int iterationCount = 20;
var config = ConfigParser.Parse(new[]
{
"--LaunchCount", launchCount.ToString(),
"--warmupCount", warmupCount.ToString(),
"--iterationTime", iterationTime.ToString(),
"--iterationCount", iterationCount.ToString()
}, new OutputLogger(Output)).config;
var job = config.GetJobs().Single();
Assert.Equal(launchCount, job.Run.LaunchCount);
Assert.Equal(warmupCount, job.Run.WarmupCount);
Assert.Equal(TimeInterval.FromMilliseconds(iterationTime), job.Run.IterationTime);
Assert.Equal(iterationCount, job.Run.IterationCount);
}
[Fact]
public void UserCanEasilyRequestToRunTheBenchmarkOncePerIteration()
{
var configEasy = ConfigParser.Parse(new[] { "--runOncePerIteration" }, new OutputLogger(Output)).config;
var easyJob = configEasy.GetJobs().Single();
Assert.Equal(1, easyJob.Run.UnrollFactor);
Assert.Equal(1, easyJob.Run.InvocationCount);
}
[Fact]
public void UserCanChooseStrategy()
{
var configEasy = ConfigParser.Parse(new[] { "--strategy", "ColdStart" }, new OutputLogger(Output)).config;
var job = configEasy.GetJobs().Single();
Assert.Equal(RunStrategy.ColdStart, job.Run.RunStrategy);
}
[FactEnvSpecific(
"When CommandLineParser wants to display help, it tries to get the Title of the Entry Assembly which is an xunit runner, which has no Title and fails..",
EnvRequirement.DotNetCoreOnly)]
public void UnknownConfigMeansFailure()
{
Assert.False(ConfigParser.Parse(new[] { "--unknown" }, new OutputLogger(Output)).isSuccess);
}
[Fact]
public void EmptyArgsMeansConfigWithoutJobs()
{
var config = ConfigParser.Parse(Array.Empty<string>(), new OutputLogger(Output)).config;
Assert.Empty(config.GetJobs());
}
[Fact]
public void NonExistingPathMeansFailure()
{
string nonExistingFile = Path.Combine(Path.GetTempPath(), "veryUniqueFileName.exe");
Assert.False(ConfigParser.Parse(new[] { "--cli", nonExistingFile }, new OutputLogger(Output)).isSuccess);
Assert.False(ConfigParser.Parse(new[] { "--coreRun", nonExistingFile }, new OutputLogger(Output)).isSuccess);
}
[FactEnvSpecific("Detecting current version of .NET Core works only for .NET Core processes", EnvRequirement.DotNetCoreOnly)]
public void CoreRunConfigParsedCorrectlyWhenRuntimeNotSpecified()
{
var fakeDotnetCliPath = typeof(object).Assembly.Location;
var fakeCoreRunPath = typeof(ConfigParserTests).Assembly.Location;
var fakeRestorePackages = Path.GetTempPath();
var config = ConfigParser.Parse(new[] { "--job=Dry", "--coreRun", fakeCoreRunPath, "--cli", fakeDotnetCliPath, "--packages", fakeRestorePackages }, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
CoreRunToolchain toolchain = config.GetJobs().Single().GetToolchain() as CoreRunToolchain;
Assert.NotNull(toolchain);
Assert.Equal(RuntimeInformation.GetCurrentRuntime().MsBuildMoniker, ((DotNetCliGenerator)toolchain.Generator).TargetFrameworkMoniker); // runtime was not specified so the current was used
Assert.Equal(fakeCoreRunPath, toolchain.SourceCoreRun.FullName);
Assert.Equal(fakeDotnetCliPath, toolchain.CustomDotNetCliPath.FullName);
Assert.Equal(fakeRestorePackages, toolchain.RestorePath.FullName);
}
[FactEnvSpecific("It's impossible to determine TFM for CoreRunToolchain if host process is not .NET (Core) process", EnvRequirement.FullFrameworkOnly)]
public void SpecifyingCoreRunWithFullFrameworkTargetsMostRecentTfm()
{
var fakePath = typeof(object).Assembly.Location;
var config = ConfigParser.Parse(new[] { "--corerun", fakePath }, new OutputLogger(Output)).config;
Job coreRunJob = config.GetJobs().Single();
CoreRunToolchain coreRunToolchain = (CoreRunToolchain)coreRunJob.GetToolchain();
DotNetCliGenerator generator = (DotNetCliGenerator)coreRunToolchain.Generator;
Assert.Equal("net8.0", generator.TargetFrameworkMoniker);
}
[FactEnvSpecific("It's impossible to determine TFM for CoreRunToolchain if host process is not .NET (Core) process", EnvRequirement.DotNetCoreOnly)]
public void SpecifyingCoreRunAndRuntimeCreatesTwoJobs()
{
const string runtime = "net7.0";
var fakeDotnetCliPath = typeof(object).Assembly.Location;
var fakeCoreRunPath = typeof(ConfigParserTests).Assembly.Location;
var fakeRestorePackages = Path.GetTempPath();
var config = ConfigParser.Parse(new[] { "--job=Dry", "--coreRun", fakeCoreRunPath, "--cli", fakeDotnetCliPath, "--packages", fakeRestorePackages, "-r", runtime }, new OutputLogger(Output)).config;
Assert.Equal(2, config.GetJobs().Count());
Job coreRunJob = config.GetJobs().Single(job => job.GetToolchain() is CoreRunToolchain);
Job runtimeJob = config.GetJobs().Single(job => job.GetToolchain() is CsProjCoreToolchain);
CoreRunToolchain coreRunToolchain = (CoreRunToolchain)coreRunJob.GetToolchain();
DotNetCliGenerator generator = (DotNetCliGenerator)coreRunToolchain.Generator;
Assert.Equal(RuntimeInformation.GetCurrentRuntime().MsBuildMoniker, generator.TargetFrameworkMoniker);
Assert.Equal(fakeCoreRunPath, coreRunToolchain.SourceCoreRun.FullName);
Assert.Equal(fakeDotnetCliPath, coreRunToolchain.CustomDotNetCliPath.FullName);
Assert.Equal(fakeRestorePackages, coreRunToolchain.RestorePath.FullName);
CsProjCoreToolchain coreToolchain = (CsProjCoreToolchain)runtimeJob.GetToolchain();
generator = (DotNetCliGenerator)coreToolchain.Generator;
Assert.Equal(runtime, ((DotNetCliGenerator)coreToolchain.Generator).TargetFrameworkMoniker);
Assert.Equal(fakeDotnetCliPath, coreToolchain.CustomDotNetCliPath);
Assert.Equal(fakeRestorePackages, generator.PackagesPath);
}
[FactEnvSpecific("It's impossible to determine TFM for CoreRunToolchain if host process is not .NET (Core) process", EnvRequirement.DotNetCoreOnly)]
public void FirstJobIsBaseline_RuntimesCoreRun()
{
const string runtime1 = "net5.0";
const string runtime2 = "net6.0";
string fakePath = typeof(object).Assembly.Location;
var config = ConfigParser.Parse(new[] { "--runtimes", runtime1, runtime2, "--coreRun", fakePath }, new OutputLogger(Output)).config;
Assert.Equal(3, config.GetJobs().Count());
Job baselineJob = config.GetJobs().Single(job => job.Meta.Baseline == true);
Assert.False(baselineJob.GetToolchain() is CoreRunToolchain);
Assert.Equal(runtime1, ((DotNetCliGenerator)baselineJob.GetToolchain().Generator).TargetFrameworkMoniker);
}
[FactEnvSpecific("It's impossible to determine TFM for CoreRunToolchain if host process is not .NET (Core) process", EnvRequirement.DotNetCoreOnly)]
public void FirstJobIsBaseline_CoreRunsRuntimes()
{
const string runtime1 = "net5.0";
const string runtime2 = "net6.0";
string fakePath1 = typeof(object).Assembly.Location;
string fakePath2 = typeof(FactAttribute).Assembly.Location;
var config = ConfigParser.Parse(new[] { "--coreRun", fakePath1, fakePath2, "--runtimes", runtime1, runtime2 }, new OutputLogger(Output)).config;
Assert.Equal(4, config.GetJobs().Count());
Job baselineJob = config.GetJobs().Single(job => job.Meta.Baseline == true);
Assert.Equal(fakePath1, ((CoreRunToolchain)baselineJob.GetToolchain()).SourceCoreRun.FullName);
}
[FactEnvSpecific("It's impossible to determine TFM for CoreRunToolchain if host process is not .NET (Core) process", EnvRequirement.DotNetCoreOnly)]
public void UserCanSpecifyMultipleCoreRunPaths()
{
var fakeCoreRunPath_1 = typeof(object).Assembly.Location;
var fakeCoreRunPath_2 = typeof(ConfigParserTests).Assembly.Location;
var config = ConfigParser.Parse(new[] { "--job=Dry", "--coreRun", fakeCoreRunPath_1, fakeCoreRunPath_2 }, new OutputLogger(Output)).config;
var jobs = config.GetJobs().ToArray();
Assert.Equal(2, jobs.Length);
Assert.Single(jobs.Where(job => job.GetToolchain() is CoreRunToolchain toolchain && toolchain.SourceCoreRun.FullName == fakeCoreRunPath_1));
Assert.Single(jobs.Where(job => job.GetToolchain() is CoreRunToolchain toolchain && toolchain.SourceCoreRun.FullName == fakeCoreRunPath_2));
Assert.Equal(2, jobs.Select(job => job.Id).Distinct().Count()); // each job must have a unique ID
}
[Fact]
public void MonoPathParsedCorrectly()
{
var fakeMonoPath = typeof(object).Assembly.Location;
var config = ConfigParser.Parse(new[] { "-r", "mono", "--monoPath", fakeMonoPath }, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
Assert.Single(config.GetJobs().Where(job => job.Environment.Runtime is MonoRuntime mono && mono.CustomPath == fakeMonoPath));
}
[FactEnvSpecific("Testing local builds of Full .NET Framework is supported only on Windows", EnvRequirement.WindowsOnly)]
public void ClrVersionParsedCorrectly()
{
const string clrVersion = "secret";
var config = ConfigParser.Parse(new[] { "--clrVersion", clrVersion }, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
Assert.Single(config.GetJobs().Where(job => job.Environment.Runtime is ClrRuntime clr && clr.Version == clrVersion));
}
[Fact]
public void IlCompilerPathParsedCorrectly()
{
var fakePath = new FileInfo(typeof(ConfigParserTests).Assembly.Location).Directory;
var config = ConfigParser.Parse(new[] { "-r", "nativeaot60", "--ilcPackages", fakePath.FullName }, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
NativeAotToolchain toolchain = config.GetJobs().Single().GetToolchain() as NativeAotToolchain;
Assert.NotNull(toolchain);
Generator generator = (Generator)toolchain.Generator;
Assert.Equal(fakePath.FullName, generator.Feeds["local"]);
}
[Theory]
[InlineData("netcoreapp2.0", true)]
[InlineData("netcoreapp2.1", true)]
[InlineData("netcoreapp2.2", true)]
[InlineData("netcoreapp3.0", true)]
[InlineData("net462", false)]
[InlineData("net48", false)]
public void DotNetCliParsedCorrectly(string tfm, bool isCore)
{
var fakeDotnetCliPath = typeof(object).Assembly.Location;
var config = ConfigParser.Parse(new[] { "-r", tfm, "--cli", fakeDotnetCliPath }, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
var toolchain = config.GetJobs().Single().GetToolchain();
if (isCore)
{
Assert.True(toolchain is CsProjCoreToolchain);
Assert.Equal(fakeDotnetCliPath, ((CsProjCoreToolchain) toolchain).CustomDotNetCliPath);
}
else
{
Assert.True(toolchain is CsProjClassicNetToolchain);
Assert.Equal(fakeDotnetCliPath, ((CsProjClassicNetToolchain) toolchain).CustomDotNetCliPath);
}
Assert.Equal(tfm, ((DotNetCliGenerator)toolchain.Generator).TargetFrameworkMoniker);
}
[Theory]
[InlineData(ConfigOptions.JoinSummary, "--join")]
[InlineData(ConfigOptions.KeepBenchmarkFiles, "--keepFiles")]
[InlineData(ConfigOptions.DontOverwriteResults, "--noOverwrite")]
[InlineData(ConfigOptions.StopOnFirstError, "--stopOnFirstError")]
[InlineData(ConfigOptions.DisableLogFile, "--disableLogFile" )]
[InlineData(ConfigOptions.LogBuildOutput, "--logBuildOutput")]
[InlineData(ConfigOptions.GenerateMSBuildBinLog | ConfigOptions.KeepBenchmarkFiles, "--generateBinLog")]
[InlineData(
ConfigOptions.JoinSummary |
ConfigOptions.KeepBenchmarkFiles |
ConfigOptions.DontOverwriteResults |
ConfigOptions.StopOnFirstError |
ConfigOptions.DisableLogFile, "--join", "--keepFiles", "--noOverwrite", "--stopOnFirstError", "--disableLogFile")]
[InlineData(
ConfigOptions.JoinSummary |
ConfigOptions.KeepBenchmarkFiles |
ConfigOptions.StopOnFirstError, "--join", "--keepFiles", "--stopOnFirstError")]
public void ConfigOptionsParsedCorrectly(ConfigOptions expectedConfigOption, params string[] configOptionArgs)
{
var config = ConfigParser.Parse(configOptionArgs, new OutputLogger(Output)).config;
Assert.Equal(expectedConfigOption, config.Options);
Assert.NotEqual(ConfigOptions.Default, config.Options);
}
[Fact]
public void WhenConfigOptionsFlagsAreNotSpecifiedTheyAreNotSet()
{
var config = ConfigParser.Parse(Array.Empty<string>(), new OutputLogger(Output)).config;
Assert.Equal(ConfigOptions.Default, config.Options);
}
[Fact]
public void PackagesPathParsedCorrectly()
{
var fakeRestoreDirectory = new FileInfo(typeof(object).Assembly.Location).Directory.FullName;
var config = ConfigParser.Parse(new[] { "-r", "netcoreapp3.0", "--packages", fakeRestoreDirectory }, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
CsProjCoreToolchain toolchain = config.GetJobs().Single().GetToolchain() as CsProjCoreToolchain;
Assert.NotNull(toolchain);
Assert.Equal(fakeRestoreDirectory, ((DotNetCliGenerator)toolchain.Generator).PackagesPath);
}
[Fact]
public void UserCanSpecifyBuildTimeout()
{
const int timeoutInSeconds = 10;
var config = ConfigParser.Parse(new[] { "-r", "netcoreapp3.0", "--buildTimeout", timeoutInSeconds.ToString() }, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
CsProjCoreToolchain toolchain = config.GetJobs().Single().GetToolchain() as CsProjCoreToolchain;
Assert.NotNull(toolchain);
Assert.Equal(timeoutInSeconds, config.BuildTimeout.TotalSeconds);
}
[Fact]
public void WhenUserDoesNotSpecifyTimeoutTheDefaultValueIsUsed()
{
var config = ConfigParser.Parse(new[] { "-r", "netcoreapp3.0" }, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
CsProjCoreToolchain toolchain = config.GetJobs().Single().GetToolchain() as CsProjCoreToolchain;
Assert.NotNull(toolchain);
Assert.Equal(DefaultConfig.Instance.BuildTimeout, config.BuildTimeout);
}
[Theory]
[InlineData("net461")]
[InlineData("net462")]
[InlineData("net47")]
[InlineData("net471")]
[InlineData("net472")]
[InlineData("net48")]
[InlineData("net481")]
public void NetFrameworkMonikerParsedCorrectly(string tfm)
{
var config = ConfigParser.Parse(new[] { "-r", tfm }, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
CsProjClassicNetToolchain toolchain = config.GetJobs().Single().GetToolchain() as CsProjClassicNetToolchain;
Assert.NotNull(toolchain);
Assert.Equal(tfm, ((DotNetCliGenerator)toolchain.Generator).TargetFrameworkMoniker);
}
[Theory]
[InlineData("net50")]
[InlineData("net60")]
[InlineData("net70")]
[InlineData("net80")]
[InlineData("net90")]
public void NetMonikersAreRecognizedAsNetCoreMonikers(string tfm)
{
var config = ConfigParser.Parse(new[] { "-r", tfm }, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
CsProjCoreToolchain toolchain = config.GetJobs().Single().GetToolchain() as CsProjCoreToolchain;
Assert.NotNull(toolchain);
Assert.Equal(tfm, ((DotNetCliGenerator)toolchain.Generator).TargetFrameworkMoniker);
}
[Theory]
[InlineData("net5.0-windows")]
[InlineData("net5.0-ios")]
public void PlatformSpecificMonikersAreSupported(string msBuildMoniker)
{
var config = ConfigParser.Parse(new[] { "-r", msBuildMoniker }, new OutputLogger(Output)).config;
Assert.Single(config.GetJobs());
CsProjCoreToolchain toolchain = config.GetJobs().Single().GetToolchain() as CsProjCoreToolchain;
Assert.NotNull(toolchain);
Assert.Equal(msBuildMoniker, ((DotNetCliGenerator)toolchain.Generator).TargetFrameworkMoniker);
}
[Fact]
public void CanCompareFewDifferentRuntimes()
{
var config = ConfigParser.Parse(new[] { "--runtimes", "net462", "MONO", "netcoreapp3.0", "nativeaot6.0", "nativeAOT7.0", "nativeAOT8.0" }, new OutputLogger(Output)).config;
Assert.True(config.GetJobs().First().Meta.Baseline); // when the user provides multiple runtimes the first one should be marked as baseline
Assert.Single(config.GetJobs().Where(job => job.Environment.Runtime is ClrRuntime clrRuntime && clrRuntime.MsBuildMoniker == "net462"));
Assert.Single(config.GetJobs().Where(job => job.Environment.Runtime is MonoRuntime));
Assert.Single(config.GetJobs().Where(job => job.Environment.Runtime is CoreRuntime coreRuntime && coreRuntime.MsBuildMoniker == "netcoreapp3.0" && coreRuntime.RuntimeMoniker == RuntimeMoniker.NetCoreApp30));
Assert.Single(config.GetJobs().Where(job => job.Environment.Runtime is NativeAotRuntime nativeAot && nativeAot.MsBuildMoniker == "net6.0" && nativeAot.RuntimeMoniker == RuntimeMoniker.NativeAot60));
Assert.Single(config.GetJobs().Where(job => job.Environment.Runtime is NativeAotRuntime nativeAot && nativeAot.MsBuildMoniker == "net7.0" && nativeAot.RuntimeMoniker == RuntimeMoniker.NativeAot70));
Assert.Single(config.GetJobs().Where(job => job.Environment.Runtime is NativeAotRuntime nativeAot && nativeAot.MsBuildMoniker == "net8.0" && nativeAot.RuntimeMoniker == RuntimeMoniker.NativeAot80));
}
[Theory]
[InlineData(ThresholdUnit.Ratio, 5)]
[InlineData(ThresholdUnit.Milliseconds, 10)]
public void CanUseStatisticalTestsToCompareFewDifferentRuntimes(ThresholdUnit thresholdUnit, double thresholdValue)
{
var config = ConfigParser.Parse(new[]
{
"--runtimes", "netcoreapp2.1", "netcoreapp2.2",
"--statisticalTest", $"{thresholdValue.ToString(CultureInfo.InvariantCulture)}{thresholdUnit.ToShortName()}"
}, new OutputLogger(Output)).config;
var mockSummary = MockFactory.CreateSummary(config);
Assert.True(config.GetJobs().First().Meta.Baseline); // when the user provides multiple runtimes the first one should be marked as baseline
Assert.False(config.GetJobs().Last().Meta.Baseline);
var statisticalTestColumn = config.GetColumnProviders().SelectMany(columnProvider => columnProvider.GetColumns(mockSummary)).OfType<StatisticalTestColumn>().Single();
Assert.Equal(StatisticalTestKind.MannWhitney, statisticalTestColumn.Kind);
Assert.Equal(Threshold.Create(thresholdUnit, thresholdUnit == ThresholdUnit.Ratio ? thresholdValue / 100.0 : thresholdValue), statisticalTestColumn.Threshold);
}
[Fact]
public void SpecifyingInvalidStatisticalTestsThresholdMeansFailure()
{
Assert.False(ConfigParser.Parse(new[] {"--statisticalTest", "not a number" }, new OutputLogger(Output)).isSuccess);
Assert.False(ConfigParser.Parse(new[] {"--statisticalTest", "1unknownUnit" }, new OutputLogger(Output)).isSuccess);
Assert.False(ConfigParser.Parse(new[] {"--statisticalTest", "1 unknownUnit" }, new OutputLogger(Output)).isSuccess);
Assert.False(ConfigParser.Parse(new[] {"--statisticalTest", "%1" }, new OutputLogger(Output)).isSuccess); // reverse order - a typo
}
[Fact]
public void CanParseHardwareCounters()
{
var config = ConfigParser.Parse(new[] { "--counters", $"{nameof(HardwareCounter.CacheMisses)}+{nameof(HardwareCounter.InstructionRetired)}"}, new OutputLogger(Output)).config;
Assert.Equal(2, config.GetHardwareCounters().Count());
Assert.Single(config.GetHardwareCounters().Where(counter => counter == HardwareCounter.CacheMisses));
Assert.Single(config.GetHardwareCounters().Where(counter => counter == HardwareCounter.InstructionRetired));
}
[Fact]
public void InvalidHardwareCounterNameMeansFailure()
{
Assert.False(ConfigParser.Parse(new[] { "--counters", "WRONG_NAME" }, new OutputLogger(Output)).isSuccess);
}
[Fact]
public void TooManyHardwareCounterNameMeansFailure()
{
Assert.False(ConfigParser.Parse(new[] { "--counters", "Timer+TotalIssues+BranchInstructions+CacheMisses" }, new OutputLogger(Output)).isSuccess);
}
[Fact]
public void CanParseDisassemblerWithCustomRecursiveDepth()
{
const int depth = 123;
var config = ConfigParser.Parse(new[] { "--disasm", "--disasmDepth", depth.ToString()}, new OutputLogger(Output)).config;
var diagnoser = config.GetDiagnosers().OfType<DisassemblyDiagnoser>().Single();
Assert.Equal(depth, diagnoser.Config.MaxDepth);
}
[Fact]
public void WhenCustomDisassemblerSettingsAreProvidedItsEnabledByDefault()
{
Verify(new[] { "--disasmDepth", "2" });
Verify(new[] { "--disasmFilter", "*" });
void Verify(string[] args)
{
var config = ConfigParser.Parse(args, new OutputLogger(Output)).config;
Assert.Single(config.GetDiagnosers().OfType<DisassemblyDiagnoser>());
}
}
[Fact]
public void CanParseInfo()
{
var config = ConfigParser.Parse(new[] { "--info" }, new OutputLogger(Output)).options;
Assert.True(config.PrintInformation);
}
[Fact]
public void UserCanSpecifyCustomDefaultJobAndOverwriteItsSettingsViaConsoleArgs()
{
var globalConfig = DefaultConfig.Instance
.AddJob(Job.Default
.WithWarmupCount(1)
.AsDefault());
var parsedConfig = ConfigParser.Parse(new[] { "--warmupCount", "2"}, new OutputLogger(Output), globalConfig).config;
Assert.Equal(2, parsedConfig.GetJobs().Single().Run.WarmupCount);
Assert.False(parsedConfig.GetJobs().Single().Meta.IsDefault); // after the merge the job is not "default" anymore
}
[Fact]
public void UserCanSpecifyCustomMaxParameterColumnWidth()
{
const int customValue = 1234;
var globalConfig = DefaultConfig.Instance;
Assert.NotEqual(customValue, globalConfig.SummaryStyle.MaxParameterColumnWidth);
var parsedConfig = ConfigParser.Parse(new[] { "--maxWidth", customValue.ToString() }, new OutputLogger(Output), globalConfig).config;
Assert.Equal(customValue, parsedConfig.SummaryStyle.MaxParameterColumnWidth);
}
[Fact]
public void UserCanSpecifyEnvironmentVariables()
{
const string key = "A_VERY_NICE_ENV_VAR";
const string value = "enabled";
var parsedConfig = ConfigParser.Parse(new[] { "--envVars", $"{key}:{value}" }, new OutputLogger(Output)).config;
var job = parsedConfig.GetJobs().Single();
var envVar = job.Environment.EnvironmentVariables.Single();
Assert.Equal(key, envVar.Key);
Assert.Equal(value, envVar.Value);
}
[Theory]
[InlineData(Platform.AnyCpu)]
[InlineData(Platform.X86)]
[InlineData(Platform.X64)]
[InlineData(Platform.Arm)]
[InlineData(Platform.Arm64)]
[InlineData(Platform.LoongArch64)]
public void UserCanSpecifyProcessPlatform(Platform platform)
{
var parsedConfig = ConfigParser.Parse(new[] { "--platform", platform.ToString() }, new OutputLogger(Output)).config;
var job = parsedConfig.GetJobs().Single();
var parsed = job.Environment.Platform;
Assert.Equal(platform, parsed);
}
[Fact]
public void InvalidEnvVarAreRecognized()
{
Assert.False(ConfigParser.Parse(new[] { "--envVars", "INVALID_NO_SEPARATOR" }, new OutputLogger(Output)).isSuccess);
}
[Fact]
public void UserCanSpecifyNoForceGCs()
{
var parsedConfiguration = ConfigParser.Parse(new[] { "--noForcedGCs" }, new OutputLogger(Output));
Assert.True(parsedConfiguration.isSuccess);
foreach (var job in parsedConfiguration.config.GetJobs())
{
Assert.False(job.Environment.Gc.Force);
}
}
[Fact]
public void UsersCanSpecifyWithoutOverheadEvalution()
{
var parsedConfiguration = ConfigParser.Parse(new[] { "--noOverheadEvaluation" }, new OutputLogger(Output));
Assert.True(parsedConfiguration.isSuccess);
foreach (var job in parsedConfiguration.config.GetJobs())
{
Assert.False(job.Accuracy.EvaluateOverhead);
}
}
[Fact(Skip = "This should be handled somehow at CommandLineParser level. See https://github.com/commandlineparser/commandline/pull/892")]
public void UserCanSpecifyWasmArgs()
{
var parsedConfiguration = ConfigParser.Parse(new[] { "--runtimes", "wasm", "--wasmArgs", "--expose_wasm --module" }, new OutputLogger(Output));
Assert.True(parsedConfiguration.isSuccess);
var jobs = parsedConfiguration.config.GetJobs();
foreach (var job in parsedConfiguration.config.GetJobs())
{
var wasmRuntime = Assert.IsType<WasmRuntime>(job.Environment.Runtime);
Assert.Equal(" --expose_wasm --module", wasmRuntime.JavaScriptEngineArguments);
}
}
[Fact]
public void UserCanSpecifyWasmArgsUsingEquals()
{
var parsedConfiguration = ConfigParser.Parse(new[] { "--runtimes", "wasm", "--wasmArgs=--expose_wasm --module" }, new OutputLogger(Output));
Assert.True(parsedConfiguration.isSuccess);
var jobs = parsedConfiguration.config.GetJobs();
foreach (var job in parsedConfiguration.config.GetJobs())
{
var wasmRuntime = Assert.IsType<WasmRuntime>(job.Environment.Runtime);
Assert.Equal("--expose_wasm --module", wasmRuntime.JavaScriptEngineArguments);
}
}
[Fact]
public void UserCanSpecifyWasmArgsViaResponseFile()
{
var tempResponseFile = Path.GetRandomFileName();
File.WriteAllLines(tempResponseFile, new[]
{
"--runtimes wasm",
"--wasmArgs \"--expose_wasm --module\""
});
var parsedConfiguration = ConfigParser.Parse(new[] { $"@{tempResponseFile}" }, new OutputLogger(Output));
Assert.True(parsedConfiguration.isSuccess);
var jobs = parsedConfiguration.config.GetJobs();
foreach (var job in parsedConfiguration.config.GetJobs())
{
var wasmRuntime = Assert.IsType<WasmRuntime>(job.Environment.Runtime);
// We may need change assertion to just "--expose_wasm --module"
// if https://github.com/commandlineparser/commandline/pull/892 lands
Assert.Equal(" --expose_wasm --module", wasmRuntime.JavaScriptEngineArguments);
}
}
[Theory]
[InlineData("--filter abc", "--filter *")]
[InlineData("-f abc", "--filter *")]
[InlineData("-f *", "--filter *")]
[InlineData("--runtimes net7.0 --join", "--filter * --join --runtimes net7.0")]
[InlineData("--join abc", "--filter * --join")]
public void CheckUpdateValidArgs(string strArgs, string expected)
{
var args = strArgs.Split();
_ = ConfigParser.TryUpdateArgs(args, out var updatedArgs, options => options.Filters = new[] { "*" });
Assert.Equal(expected.Split(), updatedArgs);
}
[Theory]
[InlineData("--filter abc -f abc")]
[InlineData("--runtimes net")]
public void CheckUpdateInvalidArgs(string strArgs)
{
var args = strArgs.Split();
bool isSuccess = ConfigParser.TryUpdateArgs(args, out var updatedArgs, options => options.Filters = new[] { "*" });
Assert.Null(updatedArgs);
Assert.False(isSuccess);
}
}
}