[release] package.json: default 'go.coverMode' to be 'default'

According to `go help testflag`, the actual default of `-covermode`
when it's not explicitly set is affected by the `-race` flag.

        -covermode set,count,atomic
            Set the mode for coverage analysis for the package[s]
            being tested. The default is "set" unless -race is enabled,
            in which case it is "atomic".

Introduce 'default' as the default option for 'go.coverMode' to indicate
the covermode is unspecified.

Fixes #666

Change-Id: I7c7059140947639e3fd0438e1bc6cc50c712ebbb
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/256117
Trust: Hyang-Ah Hana Kim <[email protected]>
Trust: Peter Weinberger <[email protected]>
Run-TryBot: Hyang-Ah Hana Kim <[email protected]>
Reviewed-by: Peter Weinberger <[email protected]>
TryBot-Result: kokoro <[email protected]>
(cherry picked from commit 8d0bafa)
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/257602

Author: hyangah

docs/settings.md

@@ -63,11 +63,11 @@ Default: ``
 
 ### `go.coverMode`
 
-When generating code coverage, the value for -covermode
+When generating code coverage, the value for -covermode. 'default' is the default value chosen by the 'go test' command.
 
-Allowed Values:`[set count atomic]`
+Allowed Values:`[default set count atomic]`
 
-Default: `set`
+Default: `default`
 
 ### `go.coverOnSave`
 

package.json

@@ -1316,12 +1316,13 @@
         "go.coverMode": {
           "type": "string",
           "enum": [
+            "default",
             "set",
             "count",
             "atomic"
           ],
-          "default": "set",
-          "description": "When generating code coverage, the value for -covermode",
+          "default": "default",
+          "description": "When generating code coverage, the value for -covermode. 'default' is the default value chosen by the 'go test' command.",
           "scope": "resource"
         },
         "go.coverShowCounts": {

src/testUtils.ts

@@ -270,17 +270,19 @@ export async function goTest(testconfig: TestConfig): Promise<boolean> {
 		} else {
 			args.push('-timeout', testconfig.goConfig['testTimeout']);
 			if (testconfig.applyCodeCoverage) {
-				let coverMode = testconfig.goConfig['coverMode'];
+				args.push('-coverprofile=' + tmpCoverPath);
+				const coverMode = testconfig.goConfig['coverMode'];
 				switch (coverMode) {
-					case 'set': case 'count': case 'atomic': break;
+					case 'default':
+						break;
+					case 'set': case 'count': case 'atomic':
+						args.push('-covermode', coverMode);
+						break;
 					default:
 						vscode.window.showWarningMessage(
-							`go.coverMode=${coverMode} is illegal. Use 'set', 'count', atomic'`
+							`go.coverMode=${coverMode} is illegal. Use 'set', 'count', 'atomic', or 'default'.`
 						);
-						coverMode = 'set';
 				}
-				args.push('-coverprofile=' + tmpCoverPath);
-				args.push('-covermode', coverMode);
 			}
 		}
 		if (testTags && testconfig.flags.indexOf('-tags') === -1) {

test/integration/test.test.ts

@@ -50,7 +50,7 @@ suite('Test Go Test', function () {
 	}
 
 	async function runTest(
-		input: { isMod: boolean, includeSubDirectories: boolean, testFlags?: string[] },
+		input: { isMod: boolean, includeSubDirectories: boolean, testFlags?: string[], applyCodeCoverage?: boolean},
 		wantFiles: string[]) {
 
 		fs.copySync(sourcePath, repoPath, { recursive: true });
@@ -65,8 +65,12 @@ suite('Test Go Test', function () {
 			flags: input.testFlags ? input.testFlags : getTestFlags(config),
 			isMod: input.isMod,
 			includeSubDirectories: input.includeSubDirectories,
+			applyCodeCoverage: input.applyCodeCoverage
 		};
 		try {
+			// TODO: instead of calling goTest, consider to test
+			// testCurrentPackage, testCurrentWorkspace, testCurrentFile
+			// which are closer to the features exposed to users.
 			const result = await goTest(testConfig);
 			assert.equal(result, false);  // we expect tests to fail.
 		} catch (e) {
@@ -90,6 +94,9 @@ suite('Test Go Test', function () {
 		await runTest(
 			{ isMod: true, includeSubDirectories: true, testFlags: ['-v'] },
 			[path.join(repoPath, 'a_test.go'), path.join(repoPath, 'b', 'b_test.go')]);
+		await runTest(
+			{ isMod: true, includeSubDirectories: true, testFlags: ['-race'], applyCodeCoverage: true },
+			[path.join(repoPath, 'a_test.go'), path.join(repoPath, 'b', 'b_test.go')]);
 		await runTest(
 			{ isMod: true, includeSubDirectories: false, testFlags: ['-v'] },
 			[path.join(repoPath, 'a_test.go')]);
@@ -106,6 +113,9 @@ suite('Test Go Test', function () {
 		await runTest(
 			{ isMod: true, includeSubDirectories: true, testFlags: ['-v'] },
 			[path.join(repoPath, 'a_test.go'), path.join(repoPath, 'b', 'b_test.go')]);
+		await runTest(
+				{ isMod: true, includeSubDirectories: true, testFlags: ['-race'], applyCodeCoverage: true },
+				[path.join(repoPath, 'a_test.go'), path.join(repoPath, 'b', 'b_test.go')]);
 		await runTest(
 			{ isMod: true, includeSubDirectories: false, testFlags: ['-v'] },
 			[path.join(repoPath, 'a_test.go')]);