forked from microsoft/vstest
-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
IntegrationTestBase.cs
974 lines (834 loc) · 39.2 KB
/
IntegrationTestBase.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
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Xml;
using FluentAssertions;
using Microsoft.TestPlatform.VsTestConsole.TranslationLayer;
using Microsoft.TestPlatform.VsTestConsole.TranslationLayer.Interfaces;
using Microsoft.VisualStudio.TestPlatform.Common;
using Microsoft.VisualStudio.TestPlatform.CoreUtilities.Extensions;
using Microsoft.VisualStudio.TestPlatform.ObjectModel;
using Microsoft.VisualStudio.TestPlatform.Utilities.Helpers;
using Microsoft.VisualStudio.TestTools.UnitTesting;
namespace Microsoft.TestPlatform.TestUtilities;
/// <summary>
/// Base class for integration tests.
/// </summary>
public class IntegrationTestBase
{
public const string DesktopRunnerFramework = "net462";
public const string CoreRunnerFramework = "netcoreapp3.1";
private const string TotalTestsMessage = "Total tests: {0}";
private const string PassedTestsMessage = " Passed: {0}";
private const string FailedTestsMessage = " Failed: {0}";
private const string SkippedTestsMessage = " Skipped: {0}";
private const string TestSummaryStatusMessageFormat = "Total tests: {0} Passed: {1} Failed: {2} Skipped: {3}";
private string _standardTestOutput = string.Empty;
private string _standardTestError = string.Empty;
private int _runnerExitCode = -1;
private string? _arguments = string.Empty;
protected readonly IntegrationTestEnvironment _testEnvironment;
private readonly string _testAdapterRelativePath = @"mstest.testadapter\{0}\build\_common".Replace('\\', Path.DirectorySeparatorChar);
private readonly string _nUnitTestAdapterRelativePath = @"nunit3testadapter\{0}\build".Replace('\\', Path.DirectorySeparatorChar);
private readonly string _xUnitTestAdapterRelativePath = @"xunit.runner.visualstudio\{0}\build\_common".Replace('\\', Path.DirectorySeparatorChar);
public enum UnitTestFramework
{
NUnit, XUnit, MSTest, CPP, NonDll
}
public IntegrationTestBase()
{
_testEnvironment = new IntegrationTestEnvironment();
BuildConfiguration = IntegrationTestEnvironment.BuildConfiguration;
TempDirectory = new TempDirectory();
var drive = new DriveInfo(Directory.GetDirectoryRoot(TempDirectory.Path));
Console.WriteLine($"Available space for TEMP: {drive.Name} {drive.AvailableFreeSpace / (1024 * 1024)} MB");
IsCI = IntegrationTestEnvironment.IsCI;
}
public string StdOut => _standardTestOutput;
public string StdOutWithWhiteSpace { get; private set; } = string.Empty;
public string StdErr => _standardTestError;
public string StdErrWithWhiteSpace { get; private set; } = string.Empty;
public TempDirectory TempDirectory { get; }
public TestContext? TestContext { get; set; }
public string BuildConfiguration { get; }
public bool IsCI { get; }
[TestCleanup]
public void TempDirectoryCleanup()
{
// In CI always delete the results, because we have limited disk space there.
//
// Locally delete the directory only when the test succeeded, so we can look
// at results and logs of failed tests.
if (IsCI || TestContext?.CurrentTestOutcome == UnitTestOutcome.Passed)
{
TempDirectory.Dispose();
}
}
/// <summary>
/// Prepare arguments for <c>vstest.console.exe</c>.
/// </summary>
/// <param name="testAssemblies">List of test assemblies.</param>
/// <param name="testAdapterPath">Path to test adapter.</param>
/// <param name="runSettings">Text of run settings.</param>
/// <param name="framework"></param>
/// <param name="inIsolation"></param>
/// <returns>Command line arguments string.</returns>
public static string PrepareArguments(string[] testAssemblies, string? testAdapterPath, string? runSettings,
string framework, string? inIsolation = "", string? resultsDirectory = null)
{
var arguments = "";
foreach (var path in testAssemblies)
{
// The incoming testAssembly path is either a single dll path in quotes or without quotes.
// Or multiple assembly paths in a single string each double quoted and joined by space.
// We trim, and add quotes here to get either:
// C:\1.dll -> "C:\1.dll"
// "C:\1.dll" -> "C:\1.dll"
// "C:\1.dll" "C:\2.dll" -> "C:\1.dll" "C:\2.dll"
//
// For unquoted multi path string C:\1.dll C:\2.dll, we will get "C:\1.dll C:\2.dll"
// which is wrong and will fail later, but it's the test's fault for doing it wrong
// rather than providing an array of strings that this overload takes.
arguments += path.Trim('\"').AddDoubleQuote() + " ";
}
arguments = arguments.Trim();
if (!testAdapterPath.IsNullOrWhiteSpace())
{
// Append adapter path
arguments = string.Concat(arguments, " /testadapterpath:", testAdapterPath.AddDoubleQuote());
}
if (!runSettings.IsNullOrWhiteSpace())
{
// Append run settings
arguments = string.Concat(arguments, " /settings:", runSettings.AddDoubleQuote());
}
if (!framework.IsNullOrWhiteSpace())
{
// Append run settings
arguments = string.Concat(arguments, " /framework:", framework.AddDoubleQuote());
}
arguments = string.Concat(arguments, " /logger:", "console;verbosity=normal".AddDoubleQuote());
if (!inIsolation.IsNullOrWhiteSpace())
{
if (inIsolation != "/InIsolation")
{
// TODO: The whole inIsolation should be just a bool, but it is not, and it's changing in other PR.
throw new InvalidOperationException("InIsolation value must be '/InIsolation'");
}
arguments = string.Concat(arguments, " ", inIsolation);
}
if (!resultsDirectory.IsNullOrWhiteSpace())
{
// Append results directory
arguments = string.Concat(arguments, " /ResultsDirectory:", resultsDirectory.AddDoubleQuote());
}
return arguments;
}
/// <summary>
/// Prepare arguments for <c>vstest.console.exe</c>.
/// </summary>
/// <param name="testAssembly">Name of the test assembly.</param>
/// <param name="testAdapterPath">Path to test adapter.</param>
/// <param name="runSettings">Text of run settings.</param>
/// <param name="framework"></param>
/// <param name="inIsolation"></param>
/// <returns>Command line arguments string.</returns>
public static string PrepareArguments(string testAssembly, string? testAdapterPath, string? runSettings,
string framework, string? inIsolation = "", string? resultsDirectory = null)
=> PrepareArguments(new string[] { testAssembly }, testAdapterPath, runSettings, framework, inIsolation, resultsDirectory);
/// <summary>
/// Invokes <c>vstest.console</c> with specified arguments.
/// </summary>
/// <param name="arguments">Arguments provided to <c>vstest.console</c>.exe</param>
public void InvokeVsTest(string? arguments, Dictionary<string, string?>? environmentVariables = null)
{
var debugEnvironmentVariables = AddDebugEnvironmentVariables(environmentVariables);
ExecuteVsTestConsole(arguments, out _standardTestOutput, out _standardTestError, out _runnerExitCode, debugEnvironmentVariables);
FormatStandardOutCome();
}
/// <summary>
/// Invokes our local copy of dotnet that is patched with artifacts from the build with specified arguments.
/// </summary>
/// <param name="arguments">Arguments provided to <c>vstest.console</c>.exe</param>
public void InvokeDotnetTest(string arguments, Dictionary<string, string?>? environmentVariables = null)
{
var debugEnvironmentVariables = AddDebugEnvironmentVariables(environmentVariables);
var vstestConsolePath = GetDotnetRunnerPath();
if (arguments.Contains(".csproj"))
{
arguments += $@" -p:VsTestConsolePath=""{vstestConsolePath}""";
}
// This is used in dotnet/sdk to determine path to vstest.console:
// https://github.com/dotnet/sdk/blob/main/src/Cli/dotnet/commands/dotnet-test/VSTestForwardingApp.cs#L30-L39
debugEnvironmentVariables["VSTEST_CONSOLE_PATH"] = vstestConsolePath;
ExecutePatchedDotnet("test", arguments, out _standardTestOutput, out _standardTestError, out _runnerExitCode, debugEnvironmentVariables);
FormatStandardOutCome();
}
/// <summary>
/// Invokes <c>vstest.console</c> to execute tests in a test assembly.
/// </summary>
/// <param name="testAssembly">A test assembly.</param>
/// <param name="testAdapterPath">Path to test adapters.</param>
/// <param name="framework">Dotnet Framework of test assembly.</param>
/// <param name="runSettings">Run settings for execution.</param>
public void InvokeVsTestForExecution(string testAssembly,
string? testAdapterPath,
string framework,
string? runSettings = "",
Dictionary<string, string?>? environmentVariables = null)
{
var arguments = PrepareArguments(testAssembly, testAdapterPath, runSettings, framework, _testEnvironment.InIsolationValue, resultsDirectory: TempDirectory.Path);
InvokeVsTest(arguments, environmentVariables);
}
private Dictionary<string, string?> AddDebugEnvironmentVariables(Dictionary<string, string?>? environmentVariables)
{
environmentVariables ??= new();
if (_testEnvironment.DebugInfo != null)
{
if (_testEnvironment.DebugInfo.DebugVSTestConsole)
{
environmentVariables["VSTEST_RUNNER_DEBUG_ATTACHVS"] = "1";
}
if (_testEnvironment.DebugInfo.DebugTestHost)
{
environmentVariables["VSTEST_HOST_DEBUG_ATTACHVS"] = "1";
}
if (_testEnvironment.DebugInfo.DebugDataCollector)
{
environmentVariables["VSTEST_DATACOLLECTOR_DEBUG_ATTACHVS"] = "1";
}
if (!_testEnvironment.DebugInfo.DebugStopAtEntrypoint)
{
environmentVariables["VSTEST_DEBUG_NOBP"] = "1";
}
}
return environmentVariables;
}
/// <summary>
/// Invokes <c>vstest.console</c> to discover tests in a test assembly. "/listTests" is appended to the arguments.
/// </summary>
/// <param name="testAssembly">A test assembly.</param>
/// <param name="testAdapterPath">Path to test adapters.</param>
/// <param name="runSettings">Run settings for execution.</param>
public void InvokeVsTestForDiscovery(string testAssembly, string testAdapterPath, string runSettings = "", string targetFramework = "",
Dictionary<string, string?>? environmentVariables = null)
{
var arguments = PrepareArguments(testAssembly, testAdapterPath, runSettings, targetFramework, _testEnvironment.InIsolationValue!, resultsDirectory: TempDirectory.Path);
arguments = string.Concat(arguments, " /listtests");
InvokeVsTest(arguments, environmentVariables);
}
/// <summary>
/// Execute Tests that are not supported with given Runner framework.
/// </summary>
/// <param name="runnerFramework">Runner Framework</param>
/// <param name="framework">Framework for which Tests are not supported</param>
/// <param name="message">Message to be shown</param>
public static void ExecuteNotSupportedRunnerFrameworkTests(string runnerFramework, string framework, string message)
{
if (runnerFramework.StartsWith(framework))
{
Assert.Inconclusive(message);
}
}
/// <summary>
/// Validate if the overall test count and results are matching.
/// </summary>
/// <param name="passed">Passed test count</param>
/// <param name="failed">Failed test count</param>
/// <param name="skipped">Skipped test count</param>
public void ValidateSummaryStatus(int passed, int failed, int skipped)
{
// TODO: Switch on the actual version of vstest console when we have that set on test environment.
if (_testEnvironment.VSTestConsoleInfo?.Path?.Contains($"{Path.DirectorySeparatorChar}15.") == true)
{
ValidateSummaryStatusv15(passed, failed, skipped);
return;
}
var totalTestCount = passed + failed + skipped;
if (totalTestCount == 0)
{
// No test should be found/run
var summaryStatus = string.Format(
CultureInfo.CurrentCulture,
TestSummaryStatusMessageFormat,
@"\d+",
@"\d+",
@"\d+",
@"\d+");
StringAssert.DoesNotMatch(
_standardTestOutput,
new Regex(summaryStatus),
"Excepted: There should not be test summary{2}Actual: {0}{2}Standard Error: {1}{2}Arguments: {3}{2}",
_standardTestOutput,
_standardTestError,
Environment.NewLine,
_arguments);
}
else
{
var summaryStatus = string.Format(CultureInfo.CurrentCulture, TotalTestsMessage, totalTestCount);
if (passed != 0)
{
summaryStatus += string.Format(CultureInfo.CurrentCulture, PassedTestsMessage, passed);
}
if (failed != 0)
{
summaryStatus += string.Format(CultureInfo.CurrentCulture, FailedTestsMessage, failed);
}
if (skipped != 0)
{
summaryStatus += string.Format(CultureInfo.CurrentCulture, SkippedTestsMessage, skipped);
}
Assert.IsTrue(
_standardTestOutput.Contains(summaryStatus),
"The Test summary does not match.{3}Expected summary: {1}{3}Test Output: {0}{3}Standard Error: {2}{3}Arguments: {4}{3}",
_standardTestOutput,
summaryStatus,
_standardTestError,
Environment.NewLine,
_arguments);
}
}
/// <summary>
/// Validate if the overall test count and results are matching.
/// </summary>
/// <param name="passed">Passed test count</param>
/// <param name="failed">Failed test count</param>
/// <param name="skipped">Skipped test count</param>
public void ValidateSummaryStatusv15(int passed, int failed, int skipped)
{
// example: Total tests: 6. Passed: 2. Failed: 2. Skipped: 2.
var totalTestCount = passed + failed + skipped;
if (totalTestCount == 0)
{
// No test should be found/run
StringAssert.DoesNotMatch(
_standardTestOutput,
new Regex("Total tests\\:"),
"Excepted: There should not be test summary{2}Actual: {0}{2}Standard Error: {1}{2}Arguments: {3}{2}",
_standardTestOutput,
_standardTestError,
Environment.NewLine,
_arguments);
}
else
{
var summaryStatus = $"Total tests: {totalTestCount}.";
if (passed != 0)
{
summaryStatus += $" Passed: {passed}.";
}
if (failed != 0)
{
summaryStatus += $" Failed: {failed}.";
}
if (skipped != 0)
{
summaryStatus += $" Skipped: {skipped}.";
}
Assert.IsTrue(
_standardTestOutput.Contains(summaryStatus),
"The Test summary does not match.{3}Expected summary: {1}{3}Test Output: {0}{3}Standard Error: {2}{3}Arguments: {4}{3}",
_standardTestOutput,
summaryStatus,
_standardTestError,
Environment.NewLine,
_arguments);
}
}
public void StdErrorContains(string substring)
{
Assert.IsTrue(_standardTestError.Contains(substring), "StdErrorOutput - [{0}] did not contain expected string '{1}'", _standardTestError, substring);
}
public void StdErrorRegexIsMatch(string pattern)
{
Assert.IsTrue(Regex.IsMatch(_standardTestError, pattern), "StdErrorOutput - [{0}] did not contain expected pattern '{1}'", _standardTestError, pattern);
}
public void StdErrorDoesNotContains(string substring)
{
Assert.IsFalse(_standardTestError.Contains(substring), "StdErrorOutput - [{0}] did not contain expected string '{1}'", _standardTestError, substring);
}
public void StdOutputContains(string substring)
{
Assert.IsTrue(_standardTestOutput.Contains(substring), $"StdOutput:{Environment.NewLine} Expected substring: {substring}{Environment.NewLine}Actual string: {_standardTestOutput}");
}
public void StdOutputDoesNotContains(string substring)
{
Assert.IsFalse(_standardTestOutput.Contains(substring), $"StdOutput:{Environment.NewLine} Not expected substring: {substring}{Environment.NewLine}Actual string: {_standardTestOutput}");
}
public void ExitCodeEquals(int exitCode)
{
Assert.AreEqual(exitCode, _runnerExitCode, $"ExitCode - [{_runnerExitCode}] doesn't match expected '{exitCode}'.");
}
/// <summary>
/// Validates if the test results have the specified set of passed tests.
/// </summary>
/// <param name="passedTests">Set of passed tests.</param>
/// <remarks>Provide the full test name similar to this format SampleTest.TestCode.TestMethodPass.</remarks>
public void ValidatePassedTests(params string[] passedTests)
{
// Convert the unicode character to its unicode value for assertion
_standardTestOutput = Regex.Replace(_standardTestOutput, @"[^\x00-\x7F]", c => $@"\u{(int)c.Value[0]:x4}");
foreach (var test in passedTests)
{
// Check for tick or ? both, in some cases as unicode character for tick is not available
// in std out and gets replaced by ?
var flag = _standardTestOutput.Contains("Passed " + test)
|| _standardTestOutput.Contains("Passed " + GetTestMethodName(test))
|| _standardTestOutput.Contains("\\ufffd " + test)
|| _standardTestOutput.Contains("\\ufffd " + GetTestMethodName(test));
Assert.IsTrue(flag, "Test {0} does not appear in passed tests list.", test);
}
}
/// <summary>
/// Validates if the test results have the specified set of failed tests.
/// </summary>
/// <param name="failedTests">Set of failed tests.</param>
/// <remarks>
/// Provide the full test name similar to this format SampleTest.TestCode.TestMethodFailed.
/// Also validates whether these tests have stack trace info.
/// </remarks>
public void ValidateFailedTests(params string[] failedTests)
{
foreach (var test in failedTests)
{
var flag = _standardTestOutput.Contains("Failed " + test)
|| _standardTestOutput.Contains("Failed " + GetTestMethodName(test));
Assert.IsTrue(flag, "Test {0} does not appear in failed tests list.", test);
// Verify stack information as well.
Assert.IsTrue(_standardTestOutput.Contains(GetTestMethodName(test)), "No stack trace for failed test: {0}", test);
}
}
/// <summary>
/// Validates if the test results have the specified set of skipped tests.
/// </summary>
/// <param name="skippedTests">The set of skipped tests.</param>
/// <remarks>Provide the full test name similar to this format SampleTest.TestCode.TestMethodSkipped.</remarks>
public void ValidateSkippedTests(params string[] skippedTests)
{
foreach (var test in skippedTests)
{
var flag = _standardTestOutput.Contains("Skipped " + test)
|| _standardTestOutput.Contains("Skipped " + GetTestMethodName(test));
Assert.IsTrue(flag, "Test {0} does not appear in skipped tests list.", test);
}
}
/// <summary>
/// Validate if the discovered tests list contains provided tests.
/// </summary>
/// <param name="discoveredTestsList">List of tests expected to be discovered.</param>
public void ValidateDiscoveredTests(params string[] discoveredTestsList)
{
foreach (var test in discoveredTestsList)
{
var flag = _standardTestOutput.Contains(test)
|| _standardTestOutput.Contains(GetTestMethodName(test));
Assert.IsTrue(flag, $"Test {test} does not appear in discovered tests list." +
$"{Environment.NewLine}Std Output: {_standardTestOutput}" +
$"{Environment.NewLine}Std Error: {_standardTestError}");
}
}
/// <summary>
/// Validate that the discovered tests list doesn't contain specified tests.
/// </summary>
/// <param name="testsList">List of tests expected not to be discovered.</param>
public void ValidateTestsNotDiscovered(params string[] testsList)
{
foreach (var test in testsList)
{
var flag = _standardTestOutput.Contains(test)
|| _standardTestOutput.Contains(GetTestMethodName(test));
Assert.IsFalse(flag, $"Test {test} should not appear in discovered tests list." +
$"{Environment.NewLine}Std Output: {_standardTestOutput}" +
$"{Environment.NewLine}Std Error: {_standardTestError}");
}
}
public void ValidateFullyQualifiedDiscoveredTests(string filePath, params string[] discoveredTestsList)
{
var fileOutput = File.ReadAllLines(filePath);
Assert.IsTrue(fileOutput.Length == 3);
foreach (var test in discoveredTestsList)
{
var flag = fileOutput.Contains(test)
|| fileOutput.Contains(GetTestMethodName(test));
Assert.IsTrue(flag, $"Test {test} does not appear in discovered tests list." +
$"{Environment.NewLine}Std Output: {_standardTestOutput}" +
$"{Environment.NewLine}Std Error: {_standardTestError}");
}
}
protected string GetSampleTestAssembly()
{
return GetAssetFullPath("SimpleTestProject.dll");
}
protected string GetAssetFullPath(string assetName)
{
return _testEnvironment.GetTestAsset(assetName);
}
protected string GetTestDllForFramework(string assetName, string targetFramework)
{
return _testEnvironment.GetTestAsset(assetName, targetFramework);
}
protected List<string> GetTestDlls(params string[] assetNames)
{
var assets = new List<string>();
foreach (var assetName in assetNames)
{
assets.Add(GetAssetFullPath(assetName));
}
return assets;
}
protected string GetProjectFullPath(string projectName)
{
return _testEnvironment.GetTestProject(projectName);
}
protected string GetProjectAssetFullPath(string projectName, string assetName)
{
var projectPath = _testEnvironment.GetTestProject(projectName);
return Path.Combine(Path.GetDirectoryName(projectPath)!, assetName);
}
protected string GetTestAdapterPath(UnitTestFramework testFramework = UnitTestFramework.MSTest)
{
if (testFramework == UnitTestFramework.NonDll)
{
var dllPath = _testEnvironment.GetTestAsset("NonDll.TestAdapter.dll", "netstandard2.0");
return Path.GetDirectoryName(dllPath)!;
}
string adapterRelativePath = string.Empty;
if (testFramework == UnitTestFramework.MSTest)
{
adapterRelativePath = string.Format(CultureInfo.InvariantCulture, _testAdapterRelativePath, IntegrationTestEnvironment.DependencyVersions["MSTestAdapterVersion"]);
}
else if (testFramework == UnitTestFramework.NUnit)
{
adapterRelativePath = string.Format(CultureInfo.InvariantCulture, _nUnitTestAdapterRelativePath, IntegrationTestEnvironment.DependencyVersions["NUnit3AdapterVersion"]);
}
else if (testFramework == UnitTestFramework.XUnit)
{
adapterRelativePath = string.Format(CultureInfo.InvariantCulture, _xUnitTestAdapterRelativePath, IntegrationTestEnvironment.DependencyVersions["XUnitAdapterVersion"]);
}
return _testEnvironment.GetNugetPackage(adapterRelativePath);
}
protected bool IsDesktopRunner()
{
return _testEnvironment.RunnerFramework == DesktopRunnerFramework;
}
protected bool IsNetCoreRunner()
{
return _testEnvironment.RunnerFramework == CoreRunnerFramework;
}
/// <summary>
/// Gets the path to <c>vstest.console.exe</c> or <c>dotnet.exe</c>.
/// </summary>
/// <returns>
/// Full path to test runner
/// </returns>
public virtual string GetConsoleRunnerPath()
{
string consoleRunnerPath = string.Empty;
if (IsDesktopRunner())
{
consoleRunnerPath = StringUtils.IsNullOrWhiteSpace(_testEnvironment.VSTestConsoleInfo?.Path)
? Path.Combine(_testEnvironment.PublishDirectory, "vstest.console.exe")
: _testEnvironment.VSTestConsoleInfo.Path;
}
else if (IsNetCoreRunner())
{
var executablePath = OSUtils.IsWindows ? @"dotnet\dotnet.exe" : @"dotnet-linux/dotnet";
consoleRunnerPath = Path.Combine(_testEnvironment.ToolsDirectory, executablePath);
}
else
{
Assert.Fail("Unknown Runner framework - [{0}]", _testEnvironment.RunnerFramework);
}
Assert.IsTrue(File.Exists(consoleRunnerPath), "GetConsoleRunnerPath: Path not found: \"{0}\"", consoleRunnerPath);
return consoleRunnerPath;
}
protected virtual string SetVSTestConsoleDLLPathInArgs(string? args)
{
var vstestConsoleDll = GetDotnetRunnerPath();
vstestConsoleDll = vstestConsoleDll.AddDoubleQuote();
args = string.Concat(
vstestConsoleDll,
" ",
args);
return args;
}
/// <summary>
/// Returns the VsTestConsole Wrapper.
/// </summary>
/// <returns></returns>
public IVsTestConsoleWrapper GetVsTestConsoleWrapper(Dictionary<string, string?>? environmentVariables = null, TraceLevel traceLevel = TraceLevel.Verbose)
{
ConsoleParameters consoleParameters = new();
if (traceLevel != TraceLevel.Off)
{
if (!Directory.Exists(TempDirectory.Path))
{
Directory.CreateDirectory(TempDirectory.Path);
}
// Directory is already unique so there is no need to have a unique file name.
var logFilePath = Path.Combine(TempDirectory.Path, "log.txt");
if (!File.Exists(logFilePath))
{
File.Create(logFilePath).Close();
}
Console.WriteLine($"Logging diagnostics in {logFilePath}");
consoleParameters.LogFilePath = logFilePath;
}
var consoleRunnerPath = IsNetCoreRunner()
? GetDotnetRunnerPath()
: GetConsoleRunnerPath();
var executablePath = OSUtils.IsWindows ? @"dotnet\dotnet.exe" : @"dotnet-linux/dotnet";
var dotnetPath = Path.Combine(_testEnvironment.ToolsDirectory, executablePath);
if (!File.Exists(dotnetPath))
{
throw new FileNotFoundException($"File '{dotnetPath}' was not found.");
}
if (!File.Exists(consoleRunnerPath))
{
throw new FileNotFoundException($"File '{consoleRunnerPath}' was not found.");
}
Console.WriteLine($"Console runner path: {consoleRunnerPath}");
VsTestConsoleWrapper vstestConsoleWrapper;
// Providing any environment variable to vstest.console will clear all existing environment variables,
// this works around it by copying all existing variables, and adding debug. But we only want to do that
// when we are setting any debug variables.
// TODO: This is scheduled to be fixed in 17.3, where it will start working normally. We will just add those
// variables, unless we explicitly say to clean them. https://github.com/microsoft/vstest/pull/3433
// Remove this code later, and just pass the variables you want to add.
var debugEnvironmentVariables = AddDebugEnvironmentVariables(new());
environmentVariables ??= new();
if (debugEnvironmentVariables.Count > 0)
{
Environment.GetEnvironmentVariables().OfType<DictionaryEntry>().ToList().ForEach(e => environmentVariables.Add(e.Key.ToString()!, e.Value?.ToString()));
foreach (var pair in debugEnvironmentVariables)
{
environmentVariables[pair.Key] = pair.Value;
}
}
if (environmentVariables.Count > 0)
{
// This clears all variables, so we copy all environment variables, and add the debug ones to them.
consoleParameters.EnvironmentVariables = environmentVariables;
}
vstestConsoleWrapper = new VsTestConsoleWrapper(consoleRunnerPath, dotnetPath, consoleParameters);
vstestConsoleWrapper.StartSession();
return vstestConsoleWrapper;
}
/// <summary>
/// Gets the test method name from full name.
/// </summary>
/// <param name="testFullName">Fully qualified name of the test.</param>
/// <returns>Simple name of the test.</returns>
private static string GetTestMethodName(string testFullName)
{
string testMethodName = string.Empty;
var splits = testFullName.Split('.');
if (splits.Length >= 3)
{
testMethodName = testFullName.Split('.')[2];
}
return testMethodName;
}
protected void ExecuteVsTestConsole(string? args, out string stdOut, out string stdError, out int exitCode, Dictionary<string, string?>? environmentVariables = null)
{
if (IsNetCoreRunner())
{
args = SetVSTestConsoleDLLPathInArgs(args);
}
_arguments = args;
ExecuteApplication(GetConsoleRunnerPath(), args, out stdOut, out stdError, out exitCode, environmentVariables);
}
/// <summary>
/// Executes a local copy of dotnet that has VSTest task installed and possibly other modifications. Do not use this to
/// do your builds or to run general tests, unless you want your changes to be reflected.
/// </summary>
/// <param name="command"></param>
/// <param name="args"></param>
/// <param name="stdOut"></param>
/// <param name="stdError"></param>
/// <param name="exitCode"></param>
private void ExecutePatchedDotnet(string command, string args, out string stdOut, out string stdError, out int exitCode,
Dictionary<string, string?>? environmentVariables = null)
{
environmentVariables ??= new();
environmentVariables["DOTNET_MULTILEVEL_LOOKUP"] = "0";
var executablePath = OSUtils.IsWindows ? @"dotnet\dotnet.exe" : @"dotnet-linux/dotnet";
var patchedDotnetPath = Path.Combine(_testEnvironment.TestArtifactsDirectory, executablePath);
ExecuteApplication(patchedDotnetPath, string.Join(" ", command, args), out stdOut, out stdError, out exitCode, environmentVariables);
}
protected static void ExecuteApplication(string path, string? args, out string stdOut, out string stdError, out int exitCode,
Dictionary<string, string?>? environmentVariables = null, string? workingDirectory = null)
{
if (path.IsNullOrWhiteSpace())
{
throw new ArgumentException("Executable path must not be null or whitespace.", nameof(path));
}
if (!File.Exists(path))
{
throw new ArgumentException($"Executable path '{path}' could not be found.", nameof(path));
}
var executableName = Path.GetFileName(path);
using var process = new Process();
Console.WriteLine($"IntegrationTestBase.Execute: Starting {executableName}");
process.StartInfo.FileName = path;
process.StartInfo.Arguments = args;
process.StartInfo.UseShellExecute = false;
process.StartInfo.RedirectStandardError = true;
process.StartInfo.RedirectStandardOutput = true;
process.StartInfo.CreateNoWindow = true;
process.StartInfo.StandardOutputEncoding = Encoding.UTF8;
process.StartInfo.StandardErrorEncoding = Encoding.UTF8;
if (workingDirectory != null)
{
process.StartInfo.WorkingDirectory = workingDirectory;
}
if (environmentVariables != null)
{
foreach (var variable in environmentVariables)
{
if (process.StartInfo.EnvironmentVariables.ContainsKey(variable.Key))
{
process.StartInfo.EnvironmentVariables[variable.Key] = variable.Value;
}
else
{
process.StartInfo.EnvironmentVariables.Add(variable.Key, variable.Value);
}
}
}
var stdoutBuffer = new StringBuilder();
var stderrBuffer = new StringBuilder();
process.OutputDataReceived += (sender, eventArgs) => stdoutBuffer.AppendLine(eventArgs.Data);
process.ErrorDataReceived += (sender, eventArgs) => stderrBuffer.AppendLine(eventArgs.Data);
Console.WriteLine("IntegrationTestBase.Execute: Path = {0}", process.StartInfo.FileName);
Console.WriteLine("IntegrationTestBase.Execute: Arguments = {0}", process.StartInfo.Arguments);
var stopwatch = new Stopwatch();
stopwatch.Start();
process.Start();
process.BeginOutputReadLine();
process.BeginErrorReadLine();
if (!process.WaitForExit(5 * 60 * 1000)) // 5 minutes
{
Console.WriteLine($"IntegrationTestBase.Execute: Timed out waiting for {executableName}. Terminating the process.");
process.Kill();
}
else
{
// Ensure async buffers are flushed
process.WaitForExit();
}
stopwatch.Stop();
Console.WriteLine($"IntegrationTestBase.Execute: Total execution time: {stopwatch.Elapsed.Duration()}");
stdError = stderrBuffer.ToString();
stdOut = stdoutBuffer.ToString();
exitCode = process.ExitCode;
Console.WriteLine("IntegrationTestBase.Execute: stdError = {0}", stdError);
Console.WriteLine("IntegrationTestBase.Execute: stdOut = {0}", stdOut);
Console.WriteLine($"IntegrationTestBase.Execute: Stopped {executableName}. Exit code = {0}", exitCode);
}
private void FormatStandardOutCome()
{
StdErrWithWhiteSpace = _standardTestError;
_standardTestError = Regex.Replace(_standardTestError, @"\s+", " ");
StdOutWithWhiteSpace = _standardTestOutput;
_standardTestOutput = Regex.Replace(_standardTestOutput, @"\s+", " ");
}
/// <summary>
/// Create runsettings file from runConfigurationDictionary at destinationRunsettingsPath
/// </summary>
/// <param name="destinationRunsettingsPath">
/// Destination runsettings path where resulted file saves
/// </param>
/// <param name="runConfigurationDictionary">
/// Contains run configuration settings
/// </param>
public static void CreateRunSettingsFile(string destinationRunsettingsPath, IDictionary<string, string> runConfigurationDictionary)
{
var doc = new XmlDocument();
var xmlDeclaration = doc.CreateNode(XmlNodeType.XmlDeclaration, string.Empty, string.Empty);
doc.AppendChild(xmlDeclaration);
var runSettingsNode = doc.CreateElement(Constants.RunSettingsName);
doc.AppendChild(runSettingsNode);
var runConfigNode = doc.CreateElement(Constants.RunConfigurationSettingsName);
runSettingsNode.AppendChild(runConfigNode);
foreach (var settingsEntry in runConfigurationDictionary)
{
var childNode = doc.CreateElement(settingsEntry.Key);
childNode.InnerText = settingsEntry.Value;
runConfigNode.AppendChild(childNode);
}
Stream stream = new FileHelper().GetStream(destinationRunsettingsPath, FileMode.Create);
doc.Save(stream);
stream.Dispose();
}
/// <summary>
/// Create runsettings file at destinationRunsettingsPath with the content from xmlString
/// </summary>
/// <param name="destinationRunsettingsPath">
/// Destination runsettings path where resulted file is saved
/// </param>
/// <param name="runSettingsXml">
/// Run settings xml string
/// </param>
public static void CreateRunSettingsFile(string destinationRunsettingsPath, string runSettingsXml)
{
var doc = new XmlDocument();
doc.LoadXml(runSettingsXml);
var stream = new FileHelper().GetStream(destinationRunsettingsPath, FileMode.Create);
doc.Save(stream);
stream.Dispose();
}
protected string BuildMultipleAssemblyPath(params string[] assetNames)
{
// Double quoted sources separated by space.
return string.Join(" ", GetTestDlls(assetNames).Select(a => a.AddDoubleQuote()));
}
protected static string GetDiagArg(string rootDir)
=> " --diag:" + Path.Combine(rootDir, "log.txt");
/// <summary>
/// Counts the number of logs following the '*.host.*' pattern in the given folder.
/// </summary>
protected static int CountTestHostLogs(string diagLogsDir)
=> Directory.GetFiles(diagLogsDir, "*.host.*").Length;
protected static void AssertExpectedNumberOfHostProcesses(int expectedNumOfProcessCreated, string diagLogsDir, IEnumerable<string> testHostProcessNames,
string? arguments = null, string? runnerPath = null)
{
var processCreatedCount = CountTestHostLogs(diagLogsDir);
Assert.AreEqual(
expectedNumOfProcessCreated,
processCreatedCount,
$"Number of {string.Join(", ", testHostProcessNames)} process created, expected: {expectedNumOfProcessCreated} actual: {processCreatedCount} {(arguments == null ? "" : "args: " + arguments)} {(runnerPath == null ? "" : "runner path: " + runnerPath)}");
}
protected static string GetDownloadedDotnetMuxerFromTools(string architecture)
{
if (architecture is not "X86" and not "X64")
{
throw new NotSupportedException(nameof(architecture));
}
string path = Path.Combine(IntegrationTestEnvironment.TestPlatformRootDirectory, "tools",
architecture == "X86" ?
"dotnet_x86" :
$"dotnet",
$"dotnet{(OSUtils.IsWindows ? ".exe" : "")}");
Assert.IsTrue(File.Exists(path));
return path;
}
protected string GetDotnetRunnerPath() => _testEnvironment.VSTestConsoleInfo?.Path ?? Path.Combine(_testEnvironment.PublishDirectory, "vstest.console.dll");
protected void StdOutHasNoWarnings()
{
StdOut.Should().NotContainEquivalentOf("warning");
}
protected void StdErrHasTestRunFailedMessageButNoOtherError()
{
StdErr?.Trim().Should().Be("Test Run Failed.");
}
}