forked from DonJayamanne/pythonVSCode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtestingAdapter.test.ts
More file actions
1076 lines (1021 loc) · 46.5 KB
/
testingAdapter.test.ts
File metadata and controls
1076 lines (1021 loc) · 46.5 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
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
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* eslint-disable @typescript-eslint/no-explicit-any */
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
import { TestController, TestRun, Uri } from 'vscode';
import * as typeMoq from 'typemoq';
import * as path from 'path';
import * as assert from 'assert';
import * as fs from 'fs';
import * as os from 'os';
import { PytestTestDiscoveryAdapter } from '../../../client/testing/testController/pytest/pytestDiscoveryAdapter';
import { ITestController, ITestResultResolver } from '../../../client/testing/testController/common/types';
import { IPythonExecutionFactory } from '../../../client/common/process/types';
import { IConfigurationService, ITestOutputChannel } from '../../../client/common/types';
import { IServiceContainer } from '../../../client/ioc/types';
import { EXTENSION_ROOT_DIR_FOR_TESTS, initialize } from '../../initialize';
import { traceError, traceLog } from '../../../client/logging';
import { PytestTestExecutionAdapter } from '../../../client/testing/testController/pytest/pytestExecutionAdapter';
import { UnittestTestDiscoveryAdapter } from '../../../client/testing/testController/unittest/testDiscoveryAdapter';
import { UnittestTestExecutionAdapter } from '../../../client/testing/testController/unittest/testExecutionAdapter';
import { PythonResultResolver } from '../../../client/testing/testController/common/resultResolver';
import { TestProvider } from '../../../client/testing/types';
import { PYTEST_PROVIDER, UNITTEST_PROVIDER } from '../../../client/testing/common/constants';
import { IEnvironmentVariablesProvider } from '../../../client/common/variables/types';
suite('End to End Tests: test adapters', () => {
let resultResolver: ITestResultResolver;
let pythonExecFactory: IPythonExecutionFactory;
let configService: IConfigurationService;
let serviceContainer: IServiceContainer;
let envVarsService: IEnvironmentVariablesProvider;
let workspaceUri: Uri;
let testOutputChannel: typeMoq.IMock<ITestOutputChannel>;
let testController: TestController;
const unittestProvider: TestProvider = UNITTEST_PROVIDER;
const pytestProvider: TestProvider = PYTEST_PROVIDER;
const rootPathSmallWorkspace = path.join(
EXTENSION_ROOT_DIR_FOR_TESTS,
'src',
'testTestingRootWkspc',
'smallWorkspace',
);
const rootPathLargeWorkspace = path.join(
EXTENSION_ROOT_DIR_FOR_TESTS,
'src',
'testTestingRootWkspc',
'largeWorkspace',
);
const rootPathErrorWorkspace = path.join(
EXTENSION_ROOT_DIR_FOR_TESTS,
'src',
'testTestingRootWkspc',
'errorWorkspace',
);
const rootPathDiscoveryErrorWorkspace = path.join(
EXTENSION_ROOT_DIR_FOR_TESTS,
'src',
'testTestingRootWkspc',
'discoveryErrorWorkspace',
);
const rootPathDiscoverySymlink = path.join(
EXTENSION_ROOT_DIR_FOR_TESTS,
'src',
'testTestingRootWkspc',
'symlinkWorkspace',
);
const nestedTarget = path.join(EXTENSION_ROOT_DIR_FOR_TESTS, 'src', 'testTestingRootWkspc', 'target workspace');
const nestedSymlink = path.join(
EXTENSION_ROOT_DIR_FOR_TESTS,
'src',
'testTestingRootWkspc',
'symlink_parent-folder',
);
suiteSetup(async () => {
serviceContainer = (await initialize()).serviceContainer;
// create symlink for specific symlink test
const target = rootPathSmallWorkspace;
const dest = rootPathDiscoverySymlink;
try {
fs.symlink(target, dest, 'dir', (err) => {
if (err) {
traceError(err);
} else {
traceLog('Symlink created successfully for regular symlink end to end tests.');
}
});
fs.symlink(nestedTarget, nestedSymlink, 'dir', (err) => {
if (err) {
traceError(err);
} else {
traceLog('Symlink created successfully for nested symlink end to end tests.');
}
});
} catch (err) {
traceError(err);
}
});
setup(async () => {
// create objects that were injected
configService = serviceContainer.get<IConfigurationService>(IConfigurationService);
pythonExecFactory = serviceContainer.get<IPythonExecutionFactory>(IPythonExecutionFactory);
testController = serviceContainer.get<TestController>(ITestController);
envVarsService = serviceContainer.get<IEnvironmentVariablesProvider>(IEnvironmentVariablesProvider);
// create objects that were not injected
testOutputChannel = typeMoq.Mock.ofType<ITestOutputChannel>();
testOutputChannel
.setup((x) => x.append(typeMoq.It.isAny()))
.callback((appendVal: any) => {
traceLog('output channel - ', appendVal.toString());
})
.returns(() => {
// Whatever you need to return
});
testOutputChannel
.setup((x) => x.appendLine(typeMoq.It.isAny()))
.callback((appendVal: any) => {
traceLog('output channel ', appendVal.toString());
})
.returns(() => {
// Whatever you need to return
});
});
suiteTeardown(async () => {
// remove symlink
const dest = rootPathDiscoverySymlink;
if (fs.existsSync(dest)) {
fs.unlink(dest, (err) => {
if (err) {
traceError(err);
} else {
traceLog('Symlink removed successfully after tests, rootPathDiscoverySymlink.');
}
});
} else {
traceLog('Symlink was not found to remove after tests, exiting successfully, rootPathDiscoverySymlink.');
}
if (fs.existsSync(nestedSymlink)) {
fs.unlink(nestedSymlink, (err) => {
if (err) {
traceError(err);
} else {
traceLog('Symlink removed successfully after tests, nestedSymlink.');
}
});
} else {
traceLog('Symlink was not found to remove after tests, exiting successfully, nestedSymlink.');
}
});
test('unittest discovery adapter small workspace', async () => {
// result resolver and saved data for assertions
let actualData: {
cwd: string;
tests?: unknown;
status: 'success' | 'error';
error?: string[];
};
workspaceUri = Uri.parse(rootPathSmallWorkspace);
resultResolver = new PythonResultResolver(testController, unittestProvider, workspaceUri);
let callCount = 0;
// const deferredTillEOT = createTestingDeferred();
resultResolver._resolveDiscovery = async (payload, _token?) => {
traceLog(`resolveDiscovery ${payload}`);
callCount = callCount + 1;
actualData = payload;
return Promise.resolve();
};
// set workspace to test workspace folder and set up settings
configService.getSettings(workspaceUri).testing.unittestArgs = ['-s', '.', '-p', '*test*.py'];
// run unittest discovery
const discoveryAdapter = new UnittestTestDiscoveryAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);
await discoveryAdapter.discoverTests(workspaceUri, pythonExecFactory).finally(() => {
// verification after discovery is complete
// 1. Check the status is "success"
assert.strictEqual(
actualData.status,
'success',
`Expected status to be 'success' instead status is ${actualData.status}`,
);
// 2. Confirm no errors
assert.strictEqual(actualData.error, undefined, "Expected no errors in 'error' field");
// 3. Confirm tests are found
assert.ok(actualData.tests, 'Expected tests to be present');
assert.strictEqual(callCount, 1, 'Expected _resolveDiscovery to be called once');
});
});
test('unittest discovery adapter large workspace', async () => {
// result resolver and saved data for assertions
let actualData: {
cwd: string;
tests?: unknown;
status: 'success' | 'error';
error?: string[];
};
resultResolver = new PythonResultResolver(testController, unittestProvider, workspaceUri);
let callCount = 0;
resultResolver._resolveDiscovery = async (payload, _token?) => {
traceLog(`resolveDiscovery ${payload}`);
callCount = callCount + 1;
actualData = payload;
return Promise.resolve();
};
// set settings to work for the given workspace
workspaceUri = Uri.parse(rootPathLargeWorkspace);
configService.getSettings(workspaceUri).testing.unittestArgs = ['-s', '.', '-p', '*test*.py'];
// run discovery
const discoveryAdapter = new UnittestTestDiscoveryAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);
await discoveryAdapter.discoverTests(workspaceUri, pythonExecFactory).finally(() => {
// 1. Check the status is "success"
assert.strictEqual(
actualData.status,
'success',
`Expected status to be 'success' instead status is ${actualData.status}`,
);
// 2. Confirm no errors
assert.strictEqual(actualData.error, undefined, "Expected no errors in 'error' field");
// 3. Confirm tests are found
assert.ok(actualData.tests, 'Expected tests to be present');
assert.strictEqual(callCount, 1, 'Expected _resolveDiscovery to be called once');
});
});
test('pytest discovery adapter small workspace', async () => {
// result resolver and saved data for assertions
let actualData: {
cwd: string;
tests?: unknown;
status: 'success' | 'error';
error?: string[];
};
// set workspace to test workspace folder
workspaceUri = Uri.parse(rootPathSmallWorkspace);
resultResolver = new PythonResultResolver(testController, pytestProvider, workspaceUri);
let callCount = 0;
resultResolver._resolveDiscovery = async (payload, _token?) => {
callCount = callCount + 1;
actualData = payload;
return Promise.resolve();
};
// run pytest discovery
const discoveryAdapter = new PytestTestDiscoveryAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);
await discoveryAdapter.discoverTests(workspaceUri, pythonExecFactory).finally(() => {
// verification after discovery is complete
// 1. Check the status is "success"
assert.strictEqual(
actualData.status,
'success',
`Expected status to be 'success' instead status is ${actualData.status}`,
); // 2. Confirm no errors
assert.strictEqual(actualData.error?.length, 0, "Expected no errors in 'error' field");
// 3. Confirm tests are found
assert.ok(actualData.tests, 'Expected tests to be present');
assert.strictEqual(callCount, 1, 'Expected _resolveDiscovery to be called once');
});
});
test('pytest discovery adapter nested symlink', async () => {
if (os.platform() === 'win32') {
console.log('Skipping test for windows');
return;
}
// result resolver and saved data for assertions
let actualData: {
cwd: string;
tests?: unknown;
status: 'success' | 'error';
error?: string[];
};
// set workspace to test workspace folder
const workspacePath = path.join(nestedSymlink, 'custom_sub_folder');
const workspacePathParent = nestedSymlink;
workspaceUri = Uri.parse(workspacePath);
const filePath = path.join(workspacePath, 'test_simple.py');
const stats = fs.lstatSync(workspacePathParent);
// confirm that the path is a symbolic link
assert.ok(stats.isSymbolicLink(), 'The PARENT path is not a symbolic link but must be for this test.');
resultResolver = new PythonResultResolver(testController, pytestProvider, workspaceUri);
let callCount = 0;
resultResolver._resolveDiscovery = async (payload, _token?) => {
traceLog(`resolveDiscovery ${payload}`);
callCount = callCount + 1;
actualData = payload;
return Promise.resolve();
};
// run pytest discovery
const discoveryAdapter = new PytestTestDiscoveryAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);
configService.getSettings(workspaceUri).testing.pytestArgs = [];
await discoveryAdapter.discoverTests(workspaceUri, pythonExecFactory).finally(() => {
// verification after discovery is complete
// 1. Check the status is "success"
assert.strictEqual(
actualData.status,
'success',
`Expected status to be 'success' instead status is ${actualData.status}`,
); // 2. Confirm no errors
assert.strictEqual(actualData.error?.length, 0, "Expected no errors in 'error' field");
// 3. Confirm tests are found
assert.ok(actualData.tests, 'Expected tests to be present');
// 4. Confirm that the cwd returned is the symlink path and the test's path is also using the symlink as the root
if (process.platform === 'win32') {
// covert string to lowercase for windows as the path is case insensitive
traceLog('windows machine detected, converting path to lowercase for comparison');
const a = actualData.cwd.toLowerCase();
const b = filePath.toLowerCase();
const testSimpleActual = (actualData.tests as {
children: {
path: string;
}[];
}).children[0].path.toLowerCase();
const testSimpleExpected = filePath.toLowerCase();
assert.strictEqual(a, b, `Expected cwd to be the symlink path actual: ${a} expected: ${b}`);
assert.strictEqual(
testSimpleActual,
testSimpleExpected,
`Expected test path to be the symlink path actual: ${testSimpleActual} expected: ${testSimpleExpected}`,
);
} else {
assert.strictEqual(
path.join(actualData.cwd),
path.join(workspacePath),
'Expected cwd to be the symlink path, check for non-windows machines',
);
assert.strictEqual(
(actualData.tests as {
children: {
path: string;
}[];
}).children[0].path,
filePath,
'Expected test path to be the symlink path, check for non windows machines',
);
}
// 5. Confirm that resolveDiscovery was called once
assert.strictEqual(callCount, 1, 'Expected _resolveDiscovery to be called once');
});
});
test('pytest discovery adapter small workspace with symlink', async () => {
if (os.platform() === 'win32') {
console.log('Skipping test for windows');
return;
}
// result resolver and saved data for assertions
let actualData: {
cwd: string;
tests?: unknown;
status: 'success' | 'error';
error?: string[];
};
// set workspace to test workspace folder
const testSimpleSymlinkPath = path.join(rootPathDiscoverySymlink, 'test_simple.py');
workspaceUri = Uri.parse(rootPathDiscoverySymlink);
const stats = fs.lstatSync(rootPathDiscoverySymlink);
// confirm that the path is a symbolic link
assert.ok(stats.isSymbolicLink(), 'The path is not a symbolic link but must be for this test.');
resultResolver = new PythonResultResolver(testController, pytestProvider, workspaceUri);
let callCount = 0;
resultResolver._resolveDiscovery = async (payload, _token?) => {
traceLog(`resolveDiscovery ${payload}`);
callCount = callCount + 1;
actualData = payload;
return Promise.resolve();
};
// run pytest discovery
const discoveryAdapter = new PytestTestDiscoveryAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);
configService.getSettings(workspaceUri).testing.pytestArgs = [];
await discoveryAdapter.discoverTests(workspaceUri, pythonExecFactory).finally(() => {
// verification after discovery is complete
// 1. Check the status is "success"
assert.strictEqual(
actualData.status,
'success',
`Expected status to be 'success' instead status is ${actualData.status}`,
); // 2. Confirm no errors
assert.strictEqual(actualData.error?.length, 0, "Expected no errors in 'error' field");
// 3. Confirm tests are found
assert.ok(actualData.tests, 'Expected tests to be present');
// 4. Confirm that the cwd returned is the symlink path and the test's path is also using the symlink as the root
if (process.platform === 'win32') {
// covert string to lowercase for windows as the path is case insensitive
traceLog('windows machine detected, converting path to lowercase for comparison');
const a = actualData.cwd.toLowerCase();
const b = rootPathDiscoverySymlink.toLowerCase();
const testSimpleActual = (actualData.tests as {
children: {
path: string;
}[];
}).children[0].path.toLowerCase();
const testSimpleExpected = testSimpleSymlinkPath.toLowerCase();
assert.strictEqual(a, b, `Expected cwd to be the symlink path actual: ${a} expected: ${b}`);
assert.strictEqual(
testSimpleActual,
testSimpleExpected,
`Expected test path to be the symlink path actual: ${testSimpleActual} expected: ${testSimpleExpected}`,
);
} else {
assert.strictEqual(
path.join(actualData.cwd),
path.join(rootPathDiscoverySymlink),
'Expected cwd to be the symlink path, check for non-windows machines',
);
assert.strictEqual(
(actualData.tests as {
children: {
path: string;
}[];
}).children[0].path,
testSimpleSymlinkPath,
'Expected test path to be the symlink path, check for non windows machines',
);
}
// 5. Confirm that resolveDiscovery was called once
assert.strictEqual(callCount, 1, 'Expected _resolveDiscovery to be called once');
});
});
test('pytest discovery adapter large workspace', async () => {
// result resolver and saved data for assertions
let actualData: {
cwd: string;
tests?: unknown;
status: 'success' | 'error';
error?: string[];
};
resultResolver = new PythonResultResolver(testController, pytestProvider, workspaceUri);
let callCount = 0;
resultResolver._resolveDiscovery = async (payload, _token?) => {
traceLog(`resolveDiscovery ${payload}`);
callCount = callCount + 1;
actualData = payload;
return Promise.resolve();
};
// run pytest discovery
const discoveryAdapter = new PytestTestDiscoveryAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);
// set workspace to test workspace folder
workspaceUri = Uri.parse(rootPathLargeWorkspace);
configService.getSettings(workspaceUri).testing.pytestArgs = [];
await discoveryAdapter.discoverTests(workspaceUri, pythonExecFactory).finally(() => {
// verification after discovery is complete
// 1. Check the status is "success"
assert.strictEqual(
actualData.status,
'success',
`Expected status to be 'success' instead status is ${actualData.status}`,
); // 2. Confirm no errors
assert.strictEqual(actualData.error?.length, 0, "Expected no errors in 'error' field");
// 3. Confirm tests are found
assert.ok(actualData.tests, 'Expected tests to be present');
assert.strictEqual(callCount, 1, 'Expected _resolveDiscovery to be called once');
});
});
test('unittest execution adapter small workspace with correct output', async () => {
// result resolver and saved data for assertions
resultResolver = new PythonResultResolver(testController, unittestProvider, workspaceUri);
let callCount = 0;
let failureOccurred = false;
let failureMsg = '';
resultResolver._resolveExecution = async (payload, _token?) => {
traceLog(`resolveDiscovery ${payload}`);
callCount = callCount + 1;
// the payloads that get to the _resolveExecution are all data and should be successful.
try {
assert.strictEqual(
payload.status,
'success',
`Expected status to be 'success', instead status is ${payload.status}`,
);
assert.ok(payload.result, 'Expected results to be present');
} catch (err) {
failureMsg = err ? (err as Error).toString() : '';
failureOccurred = true;
}
return Promise.resolve();
};
// set workspace to test workspace folder
workspaceUri = Uri.parse(rootPathSmallWorkspace);
configService.getSettings(workspaceUri).testing.unittestArgs = ['-s', '.', '-p', '*test*.py'];
// run execution
const executionAdapter = new UnittestTestExecutionAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);
const testRun = typeMoq.Mock.ofType<TestRun>();
testRun
.setup((t) => t.token)
.returns(
() =>
({
onCancellationRequested: () => undefined,
} as any),
);
let collectedOutput = '';
testRun
.setup((t) => t.appendOutput(typeMoq.It.isAny()))
.callback((output: string) => {
collectedOutput += output;
traceLog('appendOutput was called with:', output);
})
.returns(() => false);
await executionAdapter
.runTests(
workspaceUri,
['test_simple.SimpleClass.test_simple_unit'],
false,
testRun.object,
pythonExecFactory,
)
.finally(() => {
// verify that the _resolveExecution was called once per test
assert.strictEqual(callCount, 1, 'Expected _resolveExecution to be called once');
assert.strictEqual(failureOccurred, false, failureMsg);
// verify output works for stdout and stderr as well as unittest output
assert.ok(
collectedOutput.includes('expected printed output, stdout'),
'The test string does not contain the expected stdout output.',
);
assert.ok(
collectedOutput.includes('expected printed output, stderr'),
'The test string does not contain the expected stderr output.',
);
assert.ok(
collectedOutput.includes('Ran 1 test in'),
'The test string does not contain the expected unittest output.',
);
});
});
test('unittest execution adapter large workspace', async () => {
// result resolver and saved data for assertions
resultResolver = new PythonResultResolver(testController, unittestProvider, workspaceUri);
let callCount = 0;
let failureOccurred = false;
let failureMsg = '';
resultResolver._resolveExecution = async (payload, _token?) => {
traceLog(`resolveDiscovery ${payload}`);
callCount = callCount + 1;
// the payloads that get to the _resolveExecution are all data and should be successful.
try {
const validStatuses = ['subtest-success', 'subtest-failure'];
assert.ok(
validStatuses.includes(payload.status),
`Expected status to be one of ${validStatuses.join(', ')}, but instead status is ${payload.status}`,
);
assert.ok(payload.result, 'Expected results to be present');
} catch (err) {
failureMsg = err ? (err as Error).toString() : '';
failureOccurred = true;
}
return Promise.resolve();
};
// set workspace to test workspace folder
workspaceUri = Uri.parse(rootPathLargeWorkspace);
configService.getSettings(workspaceUri).testing.unittestArgs = ['-s', '.', '-p', '*test*.py'];
// run unittest execution
const executionAdapter = new UnittestTestExecutionAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);
const testRun = typeMoq.Mock.ofType<TestRun>();
testRun
.setup((t) => t.token)
.returns(
() =>
({
onCancellationRequested: () => undefined,
} as any),
);
let collectedOutput = '';
testRun
.setup((t) => t.appendOutput(typeMoq.It.isAny()))
.callback((output: string) => {
collectedOutput += output;
traceLog('appendOutput was called with:', output);
})
.returns(() => false);
await executionAdapter
.runTests(
workspaceUri,
['test_parameterized_subtest.NumbersTest.test_even'],
false,
testRun.object,
pythonExecFactory,
)
.then(() => {
// verify that the _resolveExecution was called once per test
assert.strictEqual(callCount, 2000, 'Expected _resolveExecution to be called once');
assert.strictEqual(failureOccurred, false, failureMsg);
// verify output
assert.ok(
collectedOutput.includes('test_parameterized_subtest.py'),
'The test string does not contain the correct test name which should be printed',
);
assert.ok(
collectedOutput.includes('FAILED (failures=1000)'),
'The test string does not contain the last of the unittest output',
);
});
});
test('pytest execution adapter small workspace with correct output', async () => {
// result resolver and saved data for assertions
resultResolver = new PythonResultResolver(testController, unittestProvider, workspaceUri);
let callCount = 0;
let failureOccurred = false;
let failureMsg = '';
resultResolver._resolveExecution = async (payload, _token?) => {
traceLog(`resolveDiscovery ${payload}`);
callCount = callCount + 1;
// the payloads that get to the _resolveExecution are all data and should be successful.
try {
assert.strictEqual(
payload.status,
'success',
`Expected status to be 'success', instead status is ${payload.status}`,
);
assert.ok(payload.result, 'Expected results to be present');
} catch (err) {
failureMsg = err ? (err as Error).toString() : '';
failureOccurred = true;
}
return Promise.resolve();
};
// set workspace to test workspace folder
workspaceUri = Uri.parse(rootPathSmallWorkspace);
configService.getSettings(workspaceUri).testing.pytestArgs = [];
// run pytest execution
const executionAdapter = new PytestTestExecutionAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);
const testRun = typeMoq.Mock.ofType<TestRun>();
testRun
.setup((t) => t.token)
.returns(
() =>
({
onCancellationRequested: () => undefined,
} as any),
);
let collectedOutput = '';
testRun
.setup((t) => t.appendOutput(typeMoq.It.isAny()))
.callback((output: string) => {
collectedOutput += output;
traceLog('appendOutput was called with:', output);
})
.returns(() => false);
await executionAdapter
.runTests(
workspaceUri,
[`${rootPathSmallWorkspace}/test_simple.py::test_a`],
false,
testRun.object,
pythonExecFactory,
)
.then(() => {
// verify that the _resolveExecution was called once per test
assert.strictEqual(callCount, 1, 'Expected _resolveExecution to be called once');
assert.strictEqual(failureOccurred, false, failureMsg);
// verify output works for stdout and stderr as well as pytest output
assert.ok(
collectedOutput.includes('test session starts'),
'The test string does not contain the expected stdout output.',
);
assert.ok(
collectedOutput.includes('Captured log call'),
'The test string does not contain the expected log section.',
);
const searchStrings = [
'This is a warning message.',
'This is an error message.',
'This is a critical message.',
];
let searchString: string;
for (searchString of searchStrings) {
const count: number = (collectedOutput.match(new RegExp(searchString, 'g')) || []).length;
assert.strictEqual(
count,
2,
`The test string does not contain two instances of ${searchString}. Should appear twice from logging output and stack trace`,
);
}
});
});
test('pytest execution adapter large workspace', async () => {
// result resolver and saved data for assertions
resultResolver = new PythonResultResolver(testController, unittestProvider, workspaceUri);
let callCount = 0;
let failureOccurred = false;
let failureMsg = '';
resultResolver._resolveExecution = async (payload, _token?) => {
traceLog(`resolveDiscovery ${payload}`);
callCount = callCount + 1;
// the payloads that get to the _resolveExecution are all data and should be successful.
try {
assert.strictEqual(
payload.status,
'success',
`Expected status to be 'success', instead status is ${payload.status}`,
);
assert.ok(payload.result, 'Expected results to be present');
} catch (err) {
failureMsg = err ? (err as Error).toString() : '';
failureOccurred = true;
}
return Promise.resolve();
};
// set workspace to test workspace folder
workspaceUri = Uri.parse(rootPathLargeWorkspace);
configService.getSettings(workspaceUri).testing.pytestArgs = [];
// generate list of test_ids
const testIds: string[] = [];
for (let i = 0; i < 2000; i = i + 1) {
const testId = `${rootPathLargeWorkspace}/test_parameterized_subtest.py::test_odd_even[${i}]`;
testIds.push(testId);
}
// run pytest execution
const executionAdapter = new PytestTestExecutionAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);
const testRun = typeMoq.Mock.ofType<TestRun>();
testRun
.setup((t) => t.token)
.returns(
() =>
({
onCancellationRequested: () => undefined,
} as any),
);
let collectedOutput = '';
testRun
.setup((t) => t.appendOutput(typeMoq.It.isAny()))
.callback((output: string) => {
collectedOutput += output;
traceLog('appendOutput was called with:', output);
})
.returns(() => false);
await executionAdapter.runTests(workspaceUri, testIds, false, testRun.object, pythonExecFactory).then(() => {
// verify that the _resolveExecution was called once per test
assert.strictEqual(callCount, 2000, 'Expected _resolveExecution to be called once');
assert.strictEqual(failureOccurred, false, failureMsg);
// verify output works for large repo
assert.ok(
collectedOutput.includes('test session starts'),
'The test string does not contain the expected stdout output from pytest.',
);
});
});
test('unittest discovery adapter seg fault error handling', async () => {
resultResolver = new PythonResultResolver(testController, unittestProvider, workspaceUri);
let callCount = 0;
let failureOccurred = false;
let failureMsg = '';
resultResolver._resolveDiscovery = async (data, _token?) => {
// do the following asserts for each time resolveExecution is called, should be called once per test.
callCount = callCount + 1;
traceLog(`unittest discovery adapter seg fault error handling \n ${JSON.stringify(data)}`);
try {
if (data.status === 'error') {
if (data.error === undefined) {
// Dereference a NULL pointer
const indexOfTest = JSON.stringify(data).search('Dereference a NULL pointer');
assert.notDeepEqual(indexOfTest, -1, 'Expected test to have a null pointer');
} else {
assert.ok(data.error, "Expected errors in 'error' field");
}
} else {
const indexOfTest = JSON.stringify(data.tests).search('error');
assert.notDeepEqual(
indexOfTest,
-1,
'If payload status is not error then the individual tests should be marked as errors. This should occur on windows machines.',
);
}
} catch (err) {
failureMsg = err ? (err as Error).toString() : '';
failureOccurred = true;
}
return Promise.resolve();
};
// set workspace to test workspace folder
workspaceUri = Uri.parse(rootPathDiscoveryErrorWorkspace);
configService.getSettings(workspaceUri).testing.unittestArgs = ['-s', '.', '-p', '*test*.py'];
const discoveryAdapter = new UnittestTestDiscoveryAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);
const testRun = typeMoq.Mock.ofType<TestRun>();
testRun
.setup((t) => t.token)
.returns(
() =>
({
onCancellationRequested: () => undefined,
} as any),
);
await discoveryAdapter.discoverTests(workspaceUri, pythonExecFactory).finally(() => {
assert.strictEqual(callCount, 1, 'Expected _resolveDiscovery to be called once');
assert.strictEqual(failureOccurred, false, failureMsg);
});
});
test('pytest discovery seg fault error handling', async () => {
// result resolver and saved data for assertions
resultResolver = new PythonResultResolver(testController, pytestProvider, workspaceUri);
let callCount = 0;
let failureOccurred = false;
let failureMsg = '';
resultResolver._resolveDiscovery = async (data, _token?) => {
// do the following asserts for each time resolveExecution is called, should be called once per test.
callCount = callCount + 1;
traceLog(`add one to call count, is now ${callCount}`);
traceLog(`pytest discovery adapter seg fault error handling \n ${JSON.stringify(data)}`);
try {
if (data.status === 'error') {
if (data.error === undefined) {
// Dereference a NULL pointer
const indexOfTest = JSON.stringify(data).search('Dereference a NULL pointer');
if (indexOfTest === -1) {
failureOccurred = true;
failureMsg = 'Expected test to have a null pointer';
}
} else if (data.error.length === 0) {
failureOccurred = true;
failureMsg = "Expected errors in 'error' field";
}
} else {
const indexOfTest = JSON.stringify(data.tests).search('error');
if (indexOfTest === -1) {
failureOccurred = true;
failureMsg =
'If payload status is not error then the individual tests should be marked as errors. This should occur on windows machines.';
}
}
} catch (err) {
failureMsg = err ? (err as Error).toString() : '';
failureOccurred = true;
}
return Promise.resolve();
};
// run pytest discovery
const discoveryAdapter = new PytestTestDiscoveryAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);
// set workspace to test workspace folder
workspaceUri = Uri.parse(rootPathDiscoveryErrorWorkspace);
configService.getSettings(workspaceUri).testing.pytestArgs = [];
await discoveryAdapter.discoverTests(workspaceUri, pythonExecFactory).finally(() => {
// verification after discovery is complete
assert.ok(
callCount >= 1,
`Expected _resolveDiscovery to be called at least once, call count was instead ${callCount}`,
);
assert.strictEqual(failureOccurred, false, failureMsg);
});
});
test('unittest execution adapter seg fault error handling', async () => {
resultResolver = new PythonResultResolver(testController, unittestProvider, workspaceUri);
let callCount = 0;
let failureOccurred = false;
let failureMsg = '';
resultResolver._resolveExecution = async (data, _token?) => {
// do the following asserts for each time resolveExecution is called, should be called once per test.
callCount = callCount + 1;
traceLog(`unittest execution adapter seg fault error handling \n ${JSON.stringify(data)}`);
try {
if (data.status === 'error') {
if (data.error === undefined) {
// Dereference a NULL pointer
const indexOfTest = JSON.stringify(data).search('Dereference a NULL pointer');
if (indexOfTest === -1) {
failureOccurred = true;
failureMsg = 'Expected test to have a null pointer';
}
} else if (data.error.length === 0) {
failureOccurred = true;
failureMsg = "Expected errors in 'error' field";
}
} else {
const indexOfTest = JSON.stringify(data.result).search('error');
if (indexOfTest === -1) {
failureOccurred = true;
failureMsg =
'If payload status is not error then the individual tests should be marked as errors. This should occur on windows machines.';
}
}
if (data.result === undefined) {
failureOccurred = true;
failureMsg = 'Expected results to be present';
}
// make sure the testID is found in the results
const indexOfTest = JSON.stringify(data).search('test_seg_fault.TestSegmentationFault.test_segfault');
if (indexOfTest === -1) {
failureOccurred = true;
failureMsg = 'Expected testId to be present';
}
} catch (err) {
failureMsg = err ? (err as Error).toString() : '';
failureOccurred = true;
}
return Promise.resolve();
};
const testId = `test_seg_fault.TestSegmentationFault.test_segfault`;
const testIds: string[] = [testId];
// set workspace to test workspace folder
workspaceUri = Uri.parse(rootPathErrorWorkspace);
configService.getSettings(workspaceUri).testing.unittestArgs = ['-s', '.', '-p', '*test*.py'];
// run pytest execution
const executionAdapter = new UnittestTestExecutionAdapter(
configService,
testOutputChannel.object,
resultResolver,
envVarsService,
);