extension/test/integration: fix timeout flakiness caused by the dlv command

h9jiang · h9jiang · commit fa1bd8a06a0a · 2025-08-08T06:56:11.000-07:00
The flakiness is caused by dlv substitute-path-guess-helper failed to return within 2 seconds. Using beforeEach and afterEach to create sandboxes and cleanup. Instead of executing the dlv command, mock the guess function to make it reliable. Change-Id: Ib73aadc2d04d3d2f0c692def1565715869c6e9cf Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/694096 Reviewed-by: Robert Findley <rfindley@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
diff --git a/extension/src/goDebugConfiguration.ts b/extension/src/goDebugConfiguration.ts
@@ -387,11 +387,9 @@ export class GoDebugConfigurationProvider implements vscode.DebugConfigurationPr
 	/**
 	 * Calls `dlv substitute-path-guess-helper` to get a set of parameters used by Delve to guess the substitutePath configuration after also examining the executable.
 	 *
-	 * Exported for testing.
-	 *
 	 * See https://github.com/go-delve/delve/blob/d5fb3bee427202f0d4b1683bf743bfd2adb41757/service/debugger/debugger.go#L2466
 	 */
-	public async guessSubstitutePath(): Promise<object | null> {
+	async guessSubstitutePath(): Promise<object | null> {
 		return new Promise((resolve) => {
 			const child = spawn(getBinPath('dlv'), ['substitute-path-guess-helper']);
 			let stdoutData = '';
diff --git a/extension/test/integration/goDebugConfiguration.test.ts b/extension/test/integration/goDebugConfiguration.test.ts
@@ -965,6 +965,16 @@ suite('Debug Configuration Auto Mode', () => {
 
 suite('Debug Configuration Default DebugAdapter', () => {
 	const debugConfigProvider = new GoDebugConfigurationProvider();
+	let sandbox: sinon.SinonSandbox;
+
+	setup(() => {
+		sandbox = sinon.createSandbox();
+	});
+
+	teardown(() => {
+		sandbox.restore();
+	});
+
 	test("default debugAdapter should be 'dlv-dap'", async () => {
 		const config = {
 			name: 'Launch',
@@ -979,7 +989,7 @@ suite('Debug Configuration Default DebugAdapter', () => {
 		assert.strictEqual(resolvedConfig['debugAdapter'], 'dlv-dap');
 	});
 
-	test('default debugAdapter for remote mode should be determined by `dlv substitute-path-guess-helper`', async () => {
+	test('remote mode: sets adapter based on the extension preview status when dlv path guessing fails', async () => {
 		const config = {
 			name: 'Attach',
 			type: 'go',
@@ -989,15 +999,33 @@ suite('Debug Configuration Default DebugAdapter', () => {
 			cwd: '/path'
 		};
 
+		const guessStub = sandbox.stub(debugConfigProvider, 'guessSubstitutePath').resolves(null);
+
 		await debugConfigProvider.resolveDebugConfiguration(undefined, config);
 		const resolvedConfig = config as any;
 
-		const substitutePathGuess = await debugConfigProvider.guessSubstitutePath();
-		let want = 'dlv-dap';
-		if (substitutePathGuess === null) {
-			want = 'legacy';
-		}
+		const want = extensionInfo.isPreview ? 'dlv-dap' : 'legacy';
 		assert.strictEqual(resolvedConfig['debugAdapter'], want);
+		assert.ok(guessStub.calledOnce, 'guessSubstitutePath should have been called');
+	});
+
+	test('remote mode: sets debugAdapter to dlv-dap when dlv path guessing succeeds', async () => {
+		const config = {
+			name: 'Attach',
+			type: 'go',
+			request: 'attach',
+			mode: 'remote',
+			program: '/path/to/main_test.go',
+			cwd: '/path'
+		};
+
+		const guessStub = sandbox.stub(debugConfigProvider, 'guessSubstitutePath').resolves({});
+
+		await debugConfigProvider.resolveDebugConfiguration(undefined, config);
+		const resolvedConfig = config as any;
+
+		assert.strictEqual(resolvedConfig['debugAdapter'], 'dlv-dap');
+		assert.ok(guessStub.calledOnce, 'guessSubstitutePath should have been called');
 	});
 
 	test('debugAdapter=dlv-dap is allowed with remote mode', async () => {
