extension/test/runTest.ts: set GOTOOLCHAIN=local

hyangah · hyangah · commit dc6845129502 · 2024-10-11T21:08:56.000Z
This script runs in CI with the go version under testing. Prevent the go toolchain switch from getting influenced by extension/go.mod's choice of go version. Add a go.mod file with go1.12 to extension/test/testdata/envTest to make this not part of the extension module. That prevents go toolchain switch to go1.23 to meet the extension module's requirement during test (which will fail due to GOTOOLCHAIN=local) after we update extension/go.mod to require go1.23.1+ in CL 616677. Adjust goExplorer.test.ts env tree items test that assumed GOTOOLCHAIN is empty. Now the test runs with GOTOOLCHAIN=local. Update .vscode/launch.json to pass GOTOOLCHAIN=local for integration testing. For #3411 Change-Id: I02f1cd6512a0030a729668221b163f6cc3e26b0f Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/619715 Reviewed-by: Robert Findley <rfindley@google.com> kokoro-CI: kokoro <noreply+kokoro@google.com> Commit-Queue: Hyang-Ah Hana Kim <hyangah@gmail.com>
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -46,6 +46,7 @@
 				"999999"
 			],
 			"env": {
+				"GOTOOLCHAIN": "local",  // Avoid toolchain switch caused by extension/go.mod.
 				"VSCODE_GO_IN_TEST": "1",  // Disable code that shouldn't be used in test
 				"MOCHA_TIMEOUT": "999999",
 			},
@@ -72,6 +73,7 @@
 				"--timeout", "999999",
 			],
 			"env": {
+				"GOTOOLCHAIN": "local",  // Avoid toolchain switch caused by extension/go.mod.
 				"VSCODE_GO_IN_TEST": "1"  // Disable code that shouldn't be used in test
 			},
 			"outFiles": [
diff --git a/extension/test/integration/goExplorer.test.ts b/extension/test/integration/goExplorer.test.ts
@@ -29,18 +29,36 @@ suite('GoExplorerProvider', () => {
 		ctx.teardown();
 	});
 
+	// The GoExplorerProvider extends vscode.TreeDataProvider,
+	// and presents tree view consisting of:
+	//   + env (env variable tree)
+	//      + GOENV
+	//      + GOMOD
+	//      + ....
+	//   + tools (tools info tree)
+	//      + various tools
+	//      + ....
+	// The ordering of children is deterministric. Env tree comes
+	// before Tools tree in the current implementation.
+	//
+	// Env tree changes depending on the open file.
+	// Tools tree is the list of tools used for the window and remains static.
 	test('env tree', async () => {
-		const [env] = await explorer.getChildren()!;
+		const [env] = await explorer.getChildren()!; // the first level has two children [env, tool]
 		assert.strictEqual(env.label, 'env');
 		assert.strictEqual(env.contextValue, 'go:explorer:envtree');
 	});
 
 	test('env tree items', async () => {
 		const [env] = await explorer.getChildren()!;
-		const [goenv, gomod] = (await explorer.getChildren(env)) as { key: string; value: string }[];
-		assert.strictEqual(goenv.key, 'GOENV');
-		assert.strictEqual(gomod.key, 'GOMOD');
-		assert.strictEqual(resolveHomeDir(gomod.value), path.join(fixtureDir, 'go.mod'));
+		const items = (await explorer.getChildren(env)) as { key: string; value: string }[];
+		for (const key of ['GOENV', 'GOTOOLCHAIN', 'GOMOD']) {
+			const item = items.find((item) => item.key === key);
+			assert(item, `missing ${key}: ${JSON.stringify(items)}`);
+			if (key === 'GOMOD') {
+				assert.strictEqual(resolveHomeDir(item.value), path.join(fixtureDir, 'go.mod'));
+			}
+		}
 	});
 
 	test('tools tree', async () => {
diff --git a/extension/test/runTest.ts b/extension/test/runTest.ts
@@ -4,6 +4,10 @@ import * as path from 'path';
 import { SilentReporter, runTests } from '@vscode/test-electron';
 
 async function main() {
+	// Use the local toolchain by default
+	// instead of getting affected by the extension/go.mod go or toolchain directives.
+	process.env['GOTOOLCHAIN'] = 'local';
+
 	// We are in test mode.
 	process.env['VSCODE_GO_IN_TEST'] = '1';
 	if (process.argv.length > 2) {
diff --git a/extension/test/testdata/envTest/go.mod b/extension/test/testdata/envTest/go.mod
@@ -0,0 +1,3 @@
+module example.com/envTest
+
+go 1.12

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module example.com/envTest`
	`2`	`+`
	`3`	`+go 1.12`