-
Notifications
You must be signed in to change notification settings - Fork 543
Expand file tree
/
Copy pathDebugSession.test.ts
More file actions
817 lines (726 loc) · 31.6 KB
/
DebugSession.test.ts
File metadata and controls
817 lines (726 loc) · 31.6 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
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
import structuredClone from "@ungap/structured-clone"; //Polyfill for structuredClone which will be present in Node 17.
import * as assert from "assert";
import Sinon from "sinon";
import {
DebugAdapterNamedPipeServer,
type DebugConfiguration,
type DebugSession,
type Extension,
type ExtensionContext,
Range,
SourceBreakpoint,
type TextDocument,
type TextEditor,
Uri,
commands,
debug,
extensions,
window,
workspace,
} from "vscode";
import { Disposable } from "vscode-languageserver-protocol";
import {
DebugConfig,
DebugConfigurations,
DebugSessionFeature,
} from "../../src/features/DebugSession";
import type { IPowerShellExtensionClient } from "../../src/features/ExternalApi";
import type { IPlatformDetails } from "../../src/platform";
import * as platform from "../../src/platform";
import {
type IEditorServicesSessionDetails,
type IPowerShellVersionDetails,
SessionManager,
} from "../../src/session";
import * as utils from "../../src/utils";
import {
BuildBinaryModuleMock,
WaitEvent,
ensureEditorServicesIsConnected,
stubInterface,
testLogger,
} from "../utils";
const TEST_NUMBER = 7357; // 7357 = TEST. Get it? :)
let defaultDebugConfig: DebugConfiguration;
beforeEach(() => {
// This prevents state from creeping into the template between test runs
defaultDebugConfig = structuredClone(
DebugConfigurations[DebugConfig.LaunchCurrentFile],
);
});
describe("DebugSessionFeature", () => {
// These constructor stubs are required for all tests so we don't interfere with the E2E vscode instance
let registerProviderStub: Sinon.SinonStub;
let registerFactoryStub: Sinon.SinonStub;
/**
* Convenience function for creating a DebugSessionFeature with stubbed dependencies. We want the actual methods and Sinon.stubInstance is awkward because it stubs all methods and the constructor, and we just want to stub the constructor basically.
*/
function createDebugSessionFeatureStub({
context = stubInterface<ExtensionContext>({
subscriptions: Array<Disposable>(), //Needed for constructor
}),
sessionManager = Sinon.createStubInstance(SessionManager),
logger = testLogger,
}): DebugSessionFeature {
return new DebugSessionFeature(context, sessionManager, logger);
}
/** Representation of an untitled powershell document window in the Editor */
const untitledEditor = stubInterface<TextEditor>({
document: stubInterface<TextDocument>({
uri: Uri.parse("file:///fakeUntitled.ps1"),
languageId: "powershell",
isUntitled: true,
}),
});
beforeEach(() => {
// Because we recreate DebugSessionFeature constantly, we need to avoid registering the same commands over and over.
Sinon.stub(commands, "registerCommand").returns(
Disposable.create(() => {
"Stubbed";
}),
);
registerProviderStub = Sinon.stub(
debug,
"registerDebugConfigurationProvider",
).returns(
Disposable.create(() => {
"Stubbed";
}),
);
registerFactoryStub = Sinon.stub(
debug,
"registerDebugAdapterDescriptorFactory",
).returns(
Disposable.create(() => {
"Stubbed";
}),
);
});
afterEach(() => {
Sinon.restore();
});
describe("Constructor", () => {
it("Registers debug configuration provider and factory", () => {
const context = stubInterface<ExtensionContext>({
subscriptions: Array<Disposable>(),
});
createDebugSessionFeatureStub({ context: context });
assert.ok(
registerFactoryStub.calledOnce,
"Debug adapter factory method called",
);
assert.ok(
registerProviderStub.calledTwice,
"Debug config provider registered for both Initial and Dynamic",
);
assert.equal(
context.subscriptions.length,
4,
"DebugSessionFeature disposables populated",
);
// TODO: Validate the registration content, such as the language name
});
});
describe("resolveDebugConfiguration", () => {
it("Defaults to LaunchCurrentFile if no request type was specified", async () => {
const noRequestConfig: DebugConfiguration = defaultDebugConfig;
noRequestConfig.request = "";
// Need to have an editor window "open" for this not to error out
Sinon.stub(window, "activeTextEditor").value(untitledEditor);
const actual = await createDebugSessionFeatureStub(
{},
).resolveDebugConfiguration(undefined, noRequestConfig);
assert.equal(actual!.current_document, true);
assert.equal(
actual!.request,
DebugConfigurations[DebugConfig.LaunchCurrentFile].request,
);
});
it("Errors if current file config was specified but no file is open in the editor", async () => {
Sinon.stub(window, "activeTextEditor").value(undefined);
const logger = Sinon.stub(testLogger);
const actual = await createDebugSessionFeatureStub(
{},
).resolveDebugConfiguration(undefined, defaultDebugConfig);
assert.equal(actual!, undefined);
assert.match(
logger.writeAndShowError.firstCall.args[0],
/you must first open a PowerShell script file/,
);
});
it("Detects an untitled document", async () => {
Sinon.stub(window, "activeTextEditor").value(untitledEditor);
const actual = await createDebugSessionFeatureStub(
{},
).resolveDebugConfiguration(undefined, defaultDebugConfig);
assert.equal(actual!.untitled_document, true);
assert.equal(actual!.script, "file:///fakeUntitled.ps1");
});
});
describe("resolveDebugConfigurationWithSubstitutedVariables", () => {
it("Sets internalConsoleOptions to neverOpen", async () => {
Sinon.stub(window, "activeTextEditor").value(untitledEditor);
const actual = await createDebugSessionFeatureStub(
{},
).resolveDebugConfigurationWithSubstitutedVariables(
undefined,
defaultDebugConfig,
);
assert.equal(actual!.internalConsoleOptions, "neverOpen");
});
it("Rejects invalid request type", async () => {
const invalidRequestConfig: DebugConfiguration = defaultDebugConfig;
invalidRequestConfig.request = "notAttachOrLaunch";
const logger = Sinon.stub(testLogger);
const actual = await createDebugSessionFeatureStub(
{},
).resolveDebugConfigurationWithSubstitutedVariables(
undefined,
invalidRequestConfig,
);
assert.equal(actual, null);
assert.match(
logger.writeAndShowError.firstCall.args[0],
/request type was invalid/,
);
});
it("Uses createTemporaryIntegratedConsole config setting if not explicitly specified", async () => {
Sinon.stub(window, "activeTextEditor").value(untitledEditor);
assert.equal(
defaultDebugConfig.createTemporaryIntegratedConsole,
undefined,
"Default config should have no temp integrated console setting",
);
const actual = await createDebugSessionFeatureStub(
{},
).resolveDebugConfigurationWithSubstitutedVariables(
undefined,
defaultDebugConfig,
);
assert.notEqual(
actual!.createTemporaryIntegratedConsole,
undefined,
"createTemporaryIntegratedConsole should have received a value from the settings and no longer be undefined",
);
});
it("LaunchCurrentFile: Rejects non-Powershell language active editor", async () => {
const nonPSEditor = stubInterface<TextEditor>({
document: stubInterface<TextDocument>({
uri: Uri.parse("file:///fakeUntitled.ps1"),
languageId: "NotPowerShell",
isUntitled: true,
}),
});
const currentDocConfig: DebugConfiguration = defaultDebugConfig;
currentDocConfig.current_document = true;
Sinon.stub(window, "activeTextEditor").value(nonPSEditor);
const logger = Sinon.stub(testLogger);
const actual = await createDebugSessionFeatureStub(
{},
).resolveDebugConfigurationWithSubstitutedVariables(
undefined,
currentDocConfig,
);
assert.equal(actual, undefined, "Debug session should end");
assert.match(
logger.writeAndShowError.firstCall.args[0],
/debugging this language mode/,
);
});
// Skipped until we can fix the stub
it.skip("LaunchScript: Rejects scripts without a powershell script extension", async () => {
const currentDocConfig: DebugConfiguration = defaultDebugConfig;
currentDocConfig.current_document = true;
currentDocConfig.script = "file:///notPowerShell.txt";
// This check is currently dependent on the languageID check which is why this is needed still
Sinon.stub(window, "activeTextEditor").value(untitledEditor);
Sinon.stub(utils, "checkIfFileExists").resolves(true);
const logger = Sinon.stub(testLogger);
const actual = await createDebugSessionFeatureStub(
{},
).resolveDebugConfigurationWithSubstitutedVariables(
undefined,
currentDocConfig,
);
assert.equal(actual, undefined);
assert.match(
logger.writeAndShowError.firstCall.args[0],
/debugging this file type/,
);
Sinon.restore();
});
it("Prevents debugging untitled files in a temp console", async () => {
const currentDocConfig: DebugConfiguration = defaultDebugConfig;
currentDocConfig.untitled_document = true;
currentDocConfig.createTemporaryIntegratedConsole = true;
Sinon.stub(window, "activeTextEditor").value(untitledEditor);
const logger = Sinon.stub(testLogger);
const actual = await createDebugSessionFeatureStub(
{},
).resolveDebugConfigurationWithSubstitutedVariables(
undefined,
currentDocConfig,
);
assert.equal(actual, undefined);
assert.match(
logger.writeAndShowError.firstCall.args[0],
/debugging untitled/,
);
});
it("Attach: Exits if session version details cannot be retrieved", async () => {
const attachConfig: DebugConfiguration = defaultDebugConfig;
attachConfig.request = "attach";
const logger = Sinon.stub(testLogger);
const sessionManager = Sinon.createStubInstance(SessionManager, {});
sessionManager.getPowerShellVersionDetails.returns(undefined);
const actual = await createDebugSessionFeatureStub({
sessionManager: sessionManager,
}).resolveDebugConfigurationWithSubstitutedVariables(
undefined,
attachConfig,
);
assert.equal(actual, undefined);
assert.match(
logger.writeAndShowError.firstCall.args[0],
/session version details were not found/,
);
assert.ok(sessionManager.getPowerShellVersionDetails.calledOnce);
});
// Skipped until we can fix the stub
it.skip("Attach: Prevents attach on non-windows if not PS7.0 or higher", async () => {
const attachConfig: DebugConfiguration = defaultDebugConfig;
attachConfig.request = "attach";
const logger = Sinon.stub(testLogger);
const sessionManager = Sinon.createStubInstance(SessionManager, {});
Sinon.stub(platform, "getPlatformDetails").returns(
stubInterface<IPlatformDetails>({
operatingSystem: platform.OperatingSystem.MacOS,
}),
);
sessionManager.getPowerShellVersionDetails.returns(
stubInterface<IPowerShellVersionDetails>({
version: "6.2.3",
}),
);
const actual = await createDebugSessionFeatureStub({
sessionManager: sessionManager,
}).resolveDebugConfigurationWithSubstitutedVariables(
undefined,
attachConfig,
);
assert.equal(actual, undefined);
assert.match(
logger.writeAndShowError.firstCall.args[0],
/requires PowerShell 7/,
);
assert.ok(sessionManager.getPowerShellVersionDetails.calledOnce);
});
it("Attach: Prompts for PS Process if not specified", async () => {
const attachConfig: DebugConfiguration = defaultDebugConfig;
attachConfig.request = "attach";
// This effectively skips this check
attachConfig.runspaceId = TEST_NUMBER;
attachConfig.runspaceName = "TEST";
const sessionManager = Sinon.createStubInstance(SessionManager, {});
sessionManager.getPowerShellVersionDetails.returns(
stubInterface<IPowerShellVersionDetails>({
version: "7.2.3",
}),
);
const debugSessionFeatureStub = createDebugSessionFeatureStub({
sessionManager: sessionManager,
});
const pickPSHostProcessStub = Sinon.stub(
debugSessionFeatureStub,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
"pickPSHostProcess" as any,
).resolves(7357);
const actual =
await debugSessionFeatureStub.resolveDebugConfigurationWithSubstitutedVariables(
undefined,
attachConfig,
);
assert.equal(actual!.processId, TEST_NUMBER);
assert.ok(pickPSHostProcessStub.calledOnce);
});
it("Attach: Exits if process was not selected from the picker", async () => {
const attachConfig: DebugConfiguration = defaultDebugConfig;
attachConfig.request = "attach";
// This effectively skips this check
attachConfig.runspaceId = TEST_NUMBER;
attachConfig.runspaceName = "TEST";
const sessionManager = Sinon.createStubInstance(SessionManager, {});
sessionManager.getPowerShellVersionDetails.returns(
stubInterface<IPowerShellVersionDetails>({
version: "7.2.3",
}),
);
const debugSessionFeatureStub = createDebugSessionFeatureStub({
sessionManager: sessionManager,
});
const pickPSHostProcessStub = Sinon.stub(
debugSessionFeatureStub,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
"pickPSHostProcess" as any,
).resolves(undefined);
const actual =
await debugSessionFeatureStub.resolveDebugConfigurationWithSubstitutedVariables(
undefined,
attachConfig,
);
assert.equal(actual, undefined);
assert.ok(pickPSHostProcessStub.calledOnce);
});
it("Attach: Prompts for Runspace if not specified", async () => {
const attachConfig: DebugConfiguration = defaultDebugConfig;
attachConfig.request = "attach";
// This effectively skips this check
attachConfig.processId = TEST_NUMBER;
const sessionManager = Sinon.createStubInstance(SessionManager, {});
sessionManager.getPowerShellVersionDetails.returns(
stubInterface<IPowerShellVersionDetails>({
version: "7.2.3",
}),
);
const debugSessionFeatureStub = createDebugSessionFeatureStub({
sessionManager: sessionManager,
});
const pickRunspaceStub = Sinon.stub(
debugSessionFeatureStub,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
"pickRunspace" as any,
).resolves(TEST_NUMBER);
const actual =
await debugSessionFeatureStub.resolveDebugConfigurationWithSubstitutedVariables(
undefined,
attachConfig,
);
assert.equal(actual!.runspaceId, TEST_NUMBER);
assert.ok(pickRunspaceStub.calledOnceWith(TEST_NUMBER));
});
it("Attach: Exits if runspace was not selected from the picker", async () => {
const attachConfig: DebugConfiguration = defaultDebugConfig;
attachConfig.request = "attach";
// This effectively skips this check
attachConfig.processId = TEST_NUMBER;
const sessionManager = Sinon.createStubInstance(SessionManager, {});
sessionManager.getPowerShellVersionDetails.returns(
stubInterface<IPowerShellVersionDetails>({
version: "7.2.3",
}),
);
const debugSessionFeatureStub = createDebugSessionFeatureStub({
sessionManager: sessionManager,
});
const pickRunspaceStub = Sinon.stub(
debugSessionFeatureStub,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
"pickRunspace" as any,
).resolves(undefined);
const actual =
await debugSessionFeatureStub.resolveDebugConfigurationWithSubstitutedVariables(
undefined,
attachConfig,
);
assert.equal(actual, undefined);
assert.ok(pickRunspaceStub.calledOnceWith(TEST_NUMBER));
});
it("Starts dotnet attach debug session with default config", async () => {
const attachConfig: DebugConfiguration = defaultDebugConfig;
attachConfig.script = "test.ps1"; // This bypasses the ${file} logic
attachConfig.createTemporaryIntegratedConsole = true;
attachConfig.attachDotnetDebugger = true;
Sinon.stub(extensions, "getExtension").returns(
stubInterface<Extension<IPowerShellExtensionClient>>(),
);
const actual = await createDebugSessionFeatureStub(
{},
).resolveDebugConfigurationWithSubstitutedVariables(
undefined,
attachConfig,
);
const dotnetAttachConfig = actual!.dotnetAttachConfig;
assert.equal(
dotnetAttachConfig.name,
"Dotnet Debugger: Temporary Extension Terminal",
);
assert.equal(dotnetAttachConfig.request, "attach");
assert.equal(dotnetAttachConfig.type, "coreclr");
assert.equal(dotnetAttachConfig.processId, undefined);
assert.equal(dotnetAttachConfig.logging.moduleLoad, false);
});
it("Prevents dotnet attach session if terminal is not temporary", async () => {
const attachConfig: DebugConfiguration = defaultDebugConfig;
attachConfig.script = "test.ps1"; // This bypasses the ${file} logic
attachConfig.attachDotnetDebugger = true;
const logger = Sinon.stub(testLogger);
const actual = await createDebugSessionFeatureStub(
{},
).resolveDebugConfigurationWithSubstitutedVariables(
undefined,
attachConfig,
);
assert.equal(actual!, null);
assert.match(
logger.writeAndShowError.firstCall.args[0],
/dotnet debugging without using a temporary console/,
);
});
it("Errors if dotnetDebuggerConfigName was provided but the config was not found", async () => {
const attachConfig: DebugConfiguration = defaultDebugConfig;
attachConfig.script = "test.ps1"; // This bypasses the ${file} logic
attachConfig.createTemporaryIntegratedConsole = true;
attachConfig.attachDotnetDebugger = true;
attachConfig.dotnetDebuggerConfigName = "not a real config";
const logger = Sinon.stub(testLogger);
Sinon.stub(extensions, "getExtension").returns(
stubInterface<Extension<IPowerShellExtensionClient>>(),
);
const actual = await createDebugSessionFeatureStub(
{},
).resolveDebugConfigurationWithSubstitutedVariables(
undefined,
attachConfig,
);
assert.equal(actual!, null);
assert.match(
logger.writeAndShowError.firstCall.args[0],
/matching launch config was not found/,
);
});
it("Finds the correct dotnetDebuggerConfigName", async () => {
const foundDotnetConfig: DebugConfiguration = {
name: "TestDotnetAttachConfig",
request: "attach",
type: "coreclr",
};
const candidateDotnetConfigs: DebugConfiguration[] = [
{
name: "BadCandidate1",
type: "powershell",
request: "attach",
},
{
name: "BadCandidate2",
type: "coreclr",
request: "attach",
},
{
// This one has launch instead of attach and even tho it has same name, should not be matched
name: foundDotnetConfig.name,
type: "coreclr",
request: "launch",
},
foundDotnetConfig, //This is the one we want to match
{
name: foundDotnetConfig.name,
type: "notcoreclrExactly",
request: "attach",
},
{
name: `${foundDotnetConfig.name}notexactlythisname`,
type: "coreclr",
request: "attach",
},
];
const attachConfig = defaultDebugConfig;
attachConfig.script = "test.ps1"; // This bypasses the ${file} logic
attachConfig.createTemporaryIntegratedConsole = true;
attachConfig.attachDotnetDebugger = true;
attachConfig.dotnetDebuggerConfigName = foundDotnetConfig.name;
const debugSessionFeature = createDebugSessionFeatureStub({});
Sinon.stub(
debugSessionFeature,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
"getLaunchConfigurations" as any,
).returns(candidateDotnetConfigs);
const config =
await debugSessionFeature.resolveDebugConfigurationWithSubstitutedVariables(
undefined,
attachConfig,
);
// This config will only be present if the C# extension is installed.
if (extensions.getExtension("ms-dotnettools.csharp")) {
assert.ok(config);
assert.deepStrictEqual(
config.dotnetAttachConfig,
foundDotnetConfig,
);
} else {
assert.ok(!config);
}
});
});
describe("createDebugAdapterDescriptor", () => {
it("Creates a named pipe server for the debug adapter", async () => {
const debugSessionFeature = createDebugSessionFeatureStub({
sessionManager: Sinon.createStubInstance(SessionManager, {
getSessionDetails:
stubInterface<IEditorServicesSessionDetails>({
debugServicePipeName: "testPipeName",
}),
}),
});
const debugSession = stubInterface<DebugSession>({
configuration: stubInterface<DebugConfiguration>({
createTemporaryIntegratedConsole: false,
}),
});
const debugAdapterDescriptor =
await debugSessionFeature.createDebugAdapterDescriptor(
debugSession,
undefined,
);
// Confirm debugAdapterDescriptor is of type debugadapternamedpipeserver
assert.ok(
debugAdapterDescriptor instanceof DebugAdapterNamedPipeServer,
);
assert.equal(debugAdapterDescriptor.path, "testPipeName");
});
});
});
describe("DebugSessionFeature E2E", function () {
before(async () => {
// Registers and warms up the debug adapter and the PowerShell Extension Terminal
await ensureEditorServicesIsConnected();
});
it("Starts and stops a debugging session", async () => {
// Inspect the debug session via the started events to ensure it is correct
const startDebugSession = new Promise<DebugSession>((resolve) => {
const event = debug.onDidStartDebugSession((session) => {
resolve(session);
event.dispose();
});
});
const stopDebugSession = new Promise<DebugSession>((resolve) => {
const event = debug.onDidTerminateDebugSession((session) => {
resolve(session);
event.dispose();
});
});
const config = DebugConfigurations[DebugConfig.InteractiveSession];
assert.ok(
await debug.startDebugging(undefined, config),
"Debug session should start",
);
assert.equal(
(await startDebugSession).name,
config.name,
"Debug session name should match when started",
);
await debug.stopDebugging(await startDebugSession);
assert.ok(await stopDebugSession, "Debug session should stop");
assert.equal(
(await stopDebugSession).name,
config.name,
"Debug session name should match when stopped",
);
assert.equal(
(await stopDebugSession).configuration.internalConsoleOptions,
"neverOpen",
"Debug session should always have neverOpen internalConsoleOptions",
);
});
describe("Binary Modules", () => {
let binaryModulePath: Uri;
before(async function binarySetup() {
if (!extensions.getExtension("ms-dotnettools.csharp")) {
// These tests require that extension to be installed in the test environment.
this.skip();
}
binaryModulePath = Uri.joinPath(
workspace.workspaceFolders![0].uri,
"BinaryModule",
);
BuildBinaryModuleMock();
await ensureEditorServicesIsConnected();
});
afterEach(async () => {
// Cleanup E2E testing state
await debug.stopDebugging(undefined);
// Close all editors
await commands.executeCommand("workbench.action.closeAllEditors");
});
it("Debugs a binary module script", async () => {
const launchScriptConfig = structuredClone(
DebugConfigurations[DebugConfig.LaunchScript],
);
launchScriptConfig.script = Uri.joinPath(
binaryModulePath,
"BinaryModuleTest.ps1",
).fsPath;
launchScriptConfig.attachDotnetDebugger = true;
launchScriptConfig.createTemporaryIntegratedConsole = true;
const startDebugging = Sinon.spy(debug, "startDebugging");
const debugStarted = await debug.startDebugging(
undefined,
launchScriptConfig,
);
assert.ok(debugStarted);
await debug.stopDebugging(undefined);
assert.ok(startDebugging.calledTwice);
assert.ok(startDebugging.calledWith(undefined, launchScriptConfig));
// The C# child process
assert.ok(
startDebugging.calledWithMatch(
undefined,
Sinon.match.has("type", "coreclr"), // The new child debugger
Sinon.match.has("type", "PowerShell"), // The parent session
),
"The C# debugger child process is created with the PowerShell debugger as the parent",
);
});
it("Stops at a binary module breakpoint", async () => {
const launchScriptConfig = structuredClone(
DebugConfigurations[DebugConfig.LaunchCurrentFile],
);
launchScriptConfig.attachDotnetDebugger = true;
launchScriptConfig.createTemporaryIntegratedConsole = true;
const testScriptPath = Uri.joinPath(
binaryModulePath,
"BinaryModuleTest.ps1",
);
const cmdletSourcePath = Uri.joinPath(
binaryModulePath,
"TestSampleCmdletCommand.cs",
);
const testScriptDocument =
await workspace.openTextDocument(testScriptPath);
await window.showTextDocument(testScriptDocument);
// We cant see when a breakpoint is hit because the code we would spy on is in the C# extension or is vscode private, but we can see if the debug session changes which should only happen when the debug session context switches to C#, so that's good enough.
//We wire this up before starting the debug session so the event is registered
const dotnetDebugSessionActive = WaitEvent(
debug.onDidChangeActiveDebugSession,
(session) => {
return !!session?.name.match(/Dotnet Debugger/);
},
);
// Break at beginProcessing of the cmdlet
debug.addBreakpoints([
new SourceBreakpoint(
{
uri: cmdletSourcePath,
range: new Range(26, 0, 26, 0), //BeginProcessing
},
true,
undefined,
undefined,
"TEST-BinaryModuleBreakpoint",
),
]);
const debugStarted = await debug.startDebugging(
undefined,
launchScriptConfig,
);
console.log(debug.breakpoints);
const dotnetDebugSession = await dotnetDebugSessionActive;
console.log(debug.activeDebugSession);
console.log(debug.breakpoints);
await debug.stopDebugging(undefined);
assert.ok(debugStarted);
assert.ok(dotnetDebugSession);
});
});
});